Get model run status & results | Thymia

Retrieve the details of an existing Mental Wellness 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

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 - The recording supplied was not in supported file format.
ERR_RECORDING_TOO_SHORT - The recording supplied contained less than the minimum required amount of 10 seconds of speech.
ERR_RECORDING_TOO_LONG - The recording supplied exceeded the maximum allowed length of 3 minutes.
ERR_TRANSCRIPTION_FAILED - Couldn’t determine speech in the recording 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` - The recording supplied was not in supported file format. * `ERR_RECORDING_TOO_SHORT` - The recording supplied contained less than the minimum required amount of 10 seconds of speech. * `ERR_RECORDING_TOO_LONG` - The recording supplied exceeded the maximum allowed length of 3 minutes. * `ERR_TRANSCRIPTION_FAILED` - Couldn't determine speech in the recording supplied. * `ERR_INTERNAL` - An internal error occurred.

Allowed values:

activityTypestring or null

The activity type requested when creating the model run. Only populated if using the Thymia Activity Plugin and specifying an activity type (instead of using the default type).

tagslist of objects or null

Name/Value pairs the model run was tagged with when created.

dataToDeletelist of enums or null

An array of data types to indicate which data inputs should be deleted after the completion of the model run.

Allowed values:

modelstring or null

The version of model used in the model run.

1	import requests
2
3	url = "https://api.example.com/v1/models/mental-wellness/model_run_id"
4
5	payload = {}
6	headers = {
7	"x-api-key": "<apiKey>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.get(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"createdAt": "2024-04-10T11:22:33Z",
4	"status": "COMPLETE_OK",
5	"userLabel": "john.doe@example.com",
6	"deleteData": true,
7	"runAt": "2024-04-10T11:25:00Z",
8	"completedAt": "2024-04-10T11:30:00Z",
9	"warnings": [
10	"Background noise detected, results may be less accurate"
11	],
12	"results": {
13	"sections": [
14	{
15	"startSecs": 0,
16	"finishSecs": 15.2,
17	"transcript": "I have been feeling quite anxious lately, especially at work.",
18	"distress": {
19	"value": 0.65
20	},
21	"stress": {
22	"value": 0.72
23	},
24	"exhaustion": {
25	"value": 0.55
26	},
27	"sleepPropensity": {
28	"value": 0.4
29	},
30	"lowSelfEsteem": {
31	"value": 0.3
32	},
33	"mentalStrain": {
34	"value": 0.68
35	},
36	"uniformDistress": {
37	"value": 0.63
38	},
39	"uniformStress": {
40	"value": 0.7
41	},
42	"uniformExhaustion": {
43	"value": 0.52
44	},
45	"uniformSleepPropensity": {
46	"value": 0.38
47	},
48	"uniformLowSelfEsteem": {
49	"value": 0.28
50	}
51	},
52	{
53	"startSecs": 15.2,
54	"finishSecs": 30,
55	"transcript": "I try to relax by going for walks and meditating in the evenings.",
56	"distress": {
57	"value": 0.45
58	},
59	"stress": {
60	"value": 0.5
61	},
62	"exhaustion": {
63	"value": 0.4
64	},
65	"sleepPropensity": {
66	"value": 0.35
67	},
68	"lowSelfEsteem": {
69	"value": 0.25
70	},
71	"mentalStrain": {
72	"value": 0.48
73	},
74	"uniformDistress": {
75	"value": 0.43
76	},
77	"uniformStress": {
78	"value": 0.47
79	},
80	"uniformExhaustion": {
81	"value": 0.38
82	},
83	"uniformSleepPropensity": {
84	"value": 0.33
85	},
86	"uniformLowSelfEsteem": {
87	"value": 0.22
88	}
89	}
90	]
91	},
92	"activityType": "read-aloud",
93	"tags": [
94	{
95	"name": "session",
96	"value": "morning-assessment"
97	}
98	],
99	"dataToDelete": [
100	"RECORDINGS"
101	],
102	"model": "mental-wellness-v2.1"
103	}

Authentication

Path parameters

Response

Errors