Error Reference

Apollo error codes and recommended handling.
View as Markdown

When an Apollo model run completes with status COMPLETE_ERROR, the response includes two fields:

FieldDescription
errorCodeMachine-readable error code. Use this to handle errors programmatically.
errorReasonHuman-readable description. Intended for debugging, not for display to patients.
1{
2 "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
3 "status": "COMPLETE_ERROR",
4 "errorCode": "ERR_RECORDING_TOO_SHORT",
5 "errorReason": "One or more recordings supplied contained less
6 than the minimum required amount of speech.",
7 "userLabel": "patient-5678"
8}

Error details must not be surfaced directly to patients. Present a neutral message and prompt the patient to repeat the recording where applicable.

Error codes

ERR_RECORDING_INVALID_FORMAT

One or more recordings were not in a supported file format.

Supported formats: FLAC, MP3, MP4, Ogg, WebM, WAV

Affects: Either or both recordings.

Recommended action: Verify the file format of both recordings and convert if necessary before submitting a new model run.


ERR_RECORDING_TOO_SHORT

One or more recordings contained less than the minimum required amount of speech.

Minimum speech duration: 15 seconds per recording

Affects: Either or both recordings.

Recommended action: Ask the patient to speak continuously for at least 15 seconds per recording and submit a new model run.


ERR_RECORDING_TOO_LONG

One or more recordings exceeded the maximum allowed length.

Maximum recording length: 3 minutes per recording

Affects: Either or both recordings.

Recommended action: Trim the affected recording and submit a new model run.


ERR_TRANSCRIPTION_FAILED

No speech was detected in one or more recordings.

Affects: Either or both recordings.

Recommended action: Check audio quality of both recordings. Ask the patient to record in a quiet environment with a working microphone.


ERR_INTERNAL

An internal error occurred during model processing.

Recommended action: Retry the model run. If the error persists, contact support@thymia.ai with the model run ID. Document the error for audit purposes.


Warnings

1{
2 "status": "COMPLETE_OK",
3 "warnings": ["Audio quality may affect result accuracy."],
4 "results": { ... }
5}

In a clinical context, results returned alongside warnings should be flagged to the reviewing clinician before acting on the results.

HTTP errors

Status codeMeaningCommon cause
401UnauthorizedMissing or invalid API key
404Not foundModel run ID does not exist, data has been deleted, or Apollo access is not enabled
422Unprocessable entityRequest body is malformed or missing required fields

A 404 response may indicate the 12-hour data deletion window has passed. Ensure results and reports are stored before deletion occurs.

Next steps


Crown Commercial ServiceNHS DigitalISO 27001ISO 13485HIPAAGDPRCyber Essentials Certified