Get Apollo model run status & results | Thymia

curl /v1/models/apollo/model_run_id \
     -H "x-api-key: <apiKey>"

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "status": "COMPLETE_OK",
  "userLabel": "string",
  "deleteData": true,
  "runAt": "2024-01-15T09:30:00Z",
  "completedAt": "2019-08-24T14:16:000Z",
  "errorReason": "string",
  "warnings": [
    "string"
  ],
  "results": {
    "disorders": {
      "depression": {
        "probability": 0.4067141389309715,
        "severity": 0.4132388744110295
      },
      "anxiety": {
        "probability": 0.47175616834793105,
        "severity": 0.46294827856683424
      }
    },
    "symptoms": {
      "depression": {
        "anhedonia": {
          "severity": 0.46184084704582423,
          "distribution": {
            "none": 0.24197039159529662,
            "mild": 0.33255350122191146,
            "moderate": 0.2234592816328142,
            "severe": 0.2020168255499776
          }
        },
        "lowmood": {
          "severity": 0.40891653727822747,
          "distribution": {
            "none": 0.35240554066126856,
            "mild": 0.2653016782309672,
            "moderate": 0.18543040971957758,
            "severe": 0.19686237138818666
          }
        },
        "sleepissues": {
          "severity": 0.6094861501812012,
          "distribution": {
            "none": 0.1410383730497576,
            "mild": 0.21450948727434468,
            "moderate": 0.31940745575843443,
            "severe": 0.32504468391746333
          }
        },
        "lowenergy": {
          "severity": 0.4080467716870091,
          "distribution": {
            "none": 0.2465850339598515,
            "mild": 0.4124245852974307,
            "moderate": 0.21125541246455634,
            "severe": 0.1297349682781613
          }
        },
        "appetiteissues": {
          "severity": 0.3116398948698012,
          "distribution": {
            "none": 0.46100935482842137,
            "mild": 0.26781612021409124,
            "moderate": 0.14642001047714992,
            "severe": 0.1247545144803375
          }
        },
        "worthlessnessissues": {
          "severity": 0.2639105079099775,
          "distribution": {
            "none": 0.5283513711504902,
            "mild": 0.25618082569043343,
            "moderate": 0.1108527114377303,
            "severe": 0.10461509172134617
          }
        },
        "concentrationissues": {
          "severity": 0.5055735610043838,
          "distribution": {
            "none": 0.2155407066482807,
            "mild": 0.28576732944757405,
            "moderate": 0.26512253814685866,
            "severe": 0.2335694257572866
          }
        },
        "psychomotorissues": {
          "severity": 0.3364967253118117,
          "distribution": {
            "none": 0.4546550374827019,
            "mild": 0.22981182358117028,
            "moderate": 0.16692106445411847,
            "severe": 0.1486120744820093
          }
        }
      },
      "anxiety": {
        "nervousness": {
          "severity": 0.48281020556845206,
          "distribution": {
            "none": 0.2581415065283512,
            "mild": 0.2806762383950776,
            "moderate": 0.21579238691943517,
            "severe": 0.24538986815713615
          }
        },
        "uncontrollableworry": {
          "severity": 0.37084304502323606,
          "distribution": {
            "none": 0.3749962195524081,
            "mild": 0.29448429664400494,
            "moderate": 0.1735136129850577,
            "severe": 0.15700587081852932
          }
        },
        "excessiveworry": {
          "severity": 0.38841342182687094,
          "distribution": {
            "none": 0.32929279938104206,
            "mild": 0.3356483359758936,
            "moderate": 0.1755846644244737,
            "severe": 0.15947420021859068
          }
        },
        "troublerelaxing": {
          "severity": 0.6678929399237447,
          "distribution": {
            "none": 0.1026108764334131,
            "mild": 0.1720327504635266,
            "moderate": 0.3444230500014736,
            "severe": 0.3809333231015867
          }
        },
        "restlessness": {
          "severity": 0.48338808178548404,
          "distribution": {
            "none": 0.2545397514505825,
            "mild": 0.26975254891838296,
            "moderate": 0.2467114024550342,
            "severe": 0.22899629717600023
          }
        },
        "irritability": {
          "severity": 0.3970791626763033,
          "distribution": {
            "none": 0.3218806625247734,
            "mild": 0.32670323997606787,
            "moderate": 0.18971404444463374,
            "severe": 0.1617020530545248
          }
        },
        "dread": {
          "severity": 0.450211093163748,
          "distribution": {
            "none": 0.30946646688056556,
            "mild": 0.24927688874671267,
            "moderate": 0.22241354237363423,
            "severe": 0.21884310199908763
          }
        }
      }
    }
  },
  "report": {
    "viewUrl": "https://reports.thymia.ai/v1/reports/123e4567-e89b-12d3-a456-426614174000?token=...",
    "pdfUrl": "https://reports.thymia.ai/v1/reports/123e4567-e89b-12d3-a456-426614174000/pdf?token=...",
    "accessExpiresAt": "2024-12-31T23:59:59Z"
  },
  "errorCode": "ERR_RECORDING_INVALID_FORMAT",
  "model": "string"
}

Retrieve the details of an existing Apollo model run, including results if they are available.

Authentication

x-api-keystring

Your API Activation Key

Path parameters

model_run_idstringRequiredformat: "uuid"

Response

Details of model run's current state

idstringformat: "uuid"

The id of the existing model run

createdAtdatetime

When the model run was submitted to the API

statusenum

Current status of the model run. Possible values:

CREATED: Model run created; Waiting for files to be uploaded or thymia activities to be completed
RUNNING: All input to model has been supplied and the model is being executed
COMPLETE_OK: Model execution completed ok and results are available
COMPLETE_ERROR: Model execution completed with error and no results available

Current status of the model run. Possible values: * `CREATED`: Model run created; Waiting for files to be uploaded or thymia activities to be completed * `RUNNING`: All input to model has been supplied and the model is being executed * `COMPLETE_OK`: Model execution completed ok and results are available * `COMPLETE_ERROR`: Model execution completed with error and no results available

Allowed values:

userLabelstring

Label of the user that this model run was submitted for

deleteDataboolean

Boolean flag indicating if user data is to be deleted after the completion of the model run.

runAtdatetime or null

The time the model run started executing and the status changed to RUNNING. This is after all input to the model has been supplied

completedAtdatetime or null

When the model run finished processing and either results or an error reason are available; only populated once the model run completes

errorReasonstring or null

Only populated if the model run ended with COMPLETE_ERROR status

warningslist of strings or null

Contain warnings about potential issues that occurred during the model run.

resultsobject or null

Model results containing mental health indicators. Only populated if the model run ended with COMPLETE_OK status.

Results include:

disorders: Depression and anxiety assessments with probability (0-1) and severity (0-1) scores
symptoms: Detailed symptom breakdowns for each disorder, including:
- Depression symptoms: anhedonia, low mood, sleep issues, low energy, appetite issues, worthlessness, concentration issues, psychomotor issues
- Anxiety symptoms: nervousness, uncontrollable worry, excessive worry, trouble relaxing, restlessness, irritability, dread
- Each symptom includes severity (0-1) and distribution across none/mild/moderate/severe categories

Model results containing mental health indicators. Only populated if the model run ended with `COMPLETE_OK` status. Results include: - **disorders**: Depression and anxiety assessments with probability (0-1) and severity (0-1) scores - **symptoms**: Detailed symptom breakdowns for each disorder, including: - Depression symptoms: anhedonia, low mood, sleep issues, low energy, appetite issues, worthlessness, concentration issues, psychomotor issues - Anxiety symptoms: nervousness, uncontrollable worry, excessive worry, trouble relaxing, restlessness, irritability, dread - Each symptom includes severity (0-1) and distribution across none/mild/moderate/severe categories

reportobject or null

URLs to access the Apollo report. Only populated if the model run ended with COMPLETE_OK status

errorCodeenum or null

Only populated if the model run ended with COMPLETE_ERROR status. Meaning of each error code:

ERR_RECORDING_INVALID_FORMAT - One or more recordings supplied are in an unsupported format.
ERR_RECORDING_TOO_SHORT - One or more recordings supplied contained less than the minimum required amount of speech.
ERR_RECORDING_TOO_LONG - One or more recordings supplied exceeded the maximum allowed length.
ERR_TRANSCRIPTION_FAILED - Couldn’t determine speech in one or more recordings supplied.
ERR_INTERNAL - An internal error occurred.

Only populated if the model run ended with `COMPLETE_ERROR` status. Meaning of each error code: * `ERR_RECORDING_INVALID_FORMAT` - One or more recordings supplied are in an unsupported format. * `ERR_RECORDING_TOO_SHORT` - One or more recordings supplied contained less than the minimum required amount of speech. * `ERR_RECORDING_TOO_LONG` - One or more recordings supplied exceeded the maximum allowed length. * `ERR_TRANSCRIPTION_FAILED` - Couldn't determine speech in one or more recordings supplied. * `ERR_INTERNAL` - An internal error occurred.

Allowed values:

modelstring or null

The version of model used in the model run.

Authentication

Path parameters

Response

Errors