Get call status & results

GET

///v1/calls/:call_id

GET

/v1/calls/:call_id

1 import requests
2 
3 url = "https://api.example.com/v1/calls/call_id"
4 
5 headers = {"x-api-key": "<apiKey>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

1 {
2   "id": "string",
3   "user": {
4     "userLabel": "42baba59-fa4a-4a22-ba1c-2e4a88a3badb"
5   },
6   "status": "CREATED",
7   "agent": {
8     "id": "patient-intake"
9   },
10   "extractedFields": {
11     "urgency": "low"
12   },
13   "modelRun": {
14     "mentalWellness": {
15       "id": "string",
16       "createdAt": "2019-08-24T14:15:22Z",
17       "status": "COMPLETE_OK",
18       "userLabel": "string",
19       "deleteData": true,
20       "runAt": "2024-01-15T09:30:00Z",
21       "completedAt": "2019-08-24T14:16:000Z",
22       "errorReason": "string",
23       "warnings": [
24         "string"
25       ],
26       "results": {
27         "sections": [
28           {
29             "startSecs": 0,
30             "finishSecs": 8.6,
31             "transcript": "The North Wind and the Sun had a quarrel about which of them was the stronger.",
32             "distress": {
33               "value": 0.333
34             },
35             "stress": {
36               "value": 0.333
37             },
38             "exhaustion": {
39               "value": 0.333
40             },
41             "sleepPropensity": {
42               "value": 0.333
43             },
44             "lowSelfEsteem": {
45               "value": 0.333
46             },
47             "mentalStrain": {
48               "value": 0.333
49             },
50             "uniformDistress": {
51               "value": 0.333
52             },
53             "uniformStress": {
54               "value": 0.333
55             },
56             "uniformExhaustion": {
57               "value": 0.333
58             },
59             "uniformSleepPropensity": {
60               "value": 0.333
61             },
62             "uniformLowSelfEsteem": {
63               "value": 0.333
64             }
65           }
66         ]
67       },
68       "errorCode": "ERR_RECORDING_INVALID_FORMAT",
69       "activityType": "read-aloud",
70       "tags": [
71         {
72           "name": "string",
73           "value": "string"
74         }
75       ],
76       "dataToDelete": [
77         "RECORDINGS"
78       ],
79       "model": "string"
80     },
81     "apollo": {
82       "id": "string",
83       "createdAt": "2019-08-24T14:15:22Z",
84       "status": "COMPLETE_OK",
85       "userLabel": "string",
86       "deleteData": true,
87       "runAt": "2024-01-15T09:30:00Z",
88       "completedAt": "2019-08-24T14:16:000Z",
89       "errorReason": "string",
90       "warnings": [
91         "string"
92       ],
93       "results": {
94         "disorders": {
95           "depression": {
96             "probability": 0.4067141389309715,
97             "severity": 0.4132388744110295
98           },
99           "anxiety": {
100             "probability": 0.47175616834793105,
101             "severity": 0.46294827856683424
102           }
103         },
104         "symptoms": {
105           "depression": {
106             "anhedonia": {
107               "severity": 0.46184084704582423,
108               "distribution": {
109                 "none": 0.24197039159529662,
110                 "mild": 0.33255350122191146,
111                 "moderate": 0.2234592816328142,
112                 "severe": 0.2020168255499776
113               }
114             },
115             "lowmood": {
116               "severity": 0.40891653727822747,
117               "distribution": {
118                 "none": 0.35240554066126856,
119                 "mild": 0.2653016782309672,
120                 "moderate": 0.18543040971957758,
121                 "severe": 0.19686237138818666
122               }
123             },
124             "sleepissues": {
125               "severity": 0.6094861501812012,
126               "distribution": {
127                 "none": 0.1410383730497576,
128                 "mild": 0.21450948727434468,
129                 "moderate": 0.31940745575843443,
130                 "severe": 0.32504468391746333
131               }
132             },
133             "lowenergy": {
134               "severity": 0.4080467716870091,
135               "distribution": {
136                 "none": 0.2465850339598515,
137                 "mild": 0.4124245852974307,
138                 "moderate": 0.21125541246455634,
139                 "severe": 0.1297349682781613
140               }
141             },
142             "appetiteissues": {
143               "severity": 0.3116398948698012,
144               "distribution": {
145                 "none": 0.46100935482842137,
146                 "mild": 0.26781612021409124,
147                 "moderate": 0.14642001047714992,
148                 "severe": 0.1247545144803375
149               }
150             },
151             "worthlessnessissues": {
152               "severity": 0.2639105079099775,
153               "distribution": {
154                 "none": 0.5283513711504902,
155                 "mild": 0.25618082569043343,
156                 "moderate": 0.1108527114377303,
157                 "severe": 0.10461509172134617
158               }
159             },
160             "concentrationissues": {
161               "severity": 0.5055735610043838,
162               "distribution": {
163                 "none": 0.2155407066482807,
164                 "mild": 0.28576732944757405,
165                 "moderate": 0.26512253814685866,
166                 "severe": 0.2335694257572866
167               }
168             },
169             "psychomotorissues": {
170               "severity": 0.3364967253118117,
171               "distribution": {
172                 "none": 0.4546550374827019,
173                 "mild": 0.22981182358117028,
174                 "moderate": 0.16692106445411847,
175                 "severe": 0.1486120744820093
176               }
177             }
178           },
179           "anxiety": {
180             "nervousness": {
181               "severity": 0.48281020556845206,
182               "distribution": {
183                 "none": 0.2581415065283512,
184                 "mild": 0.2806762383950776,
185                 "moderate": 0.21579238691943517,
186                 "severe": 0.24538986815713615
187               }
188             },
189             "uncontrollableworry": {
190               "severity": 0.37084304502323606,
191               "distribution": {
192                 "none": 0.3749962195524081,
193                 "mild": 0.29448429664400494,
194                 "moderate": 0.1735136129850577,
195                 "severe": 0.15700587081852932
196               }
197             },
198             "excessiveworry": {
199               "severity": 0.38841342182687094,
200               "distribution": {
201                 "none": 0.32929279938104206,
202                 "mild": 0.3356483359758936,
203                 "moderate": 0.1755846644244737,
204                 "severe": 0.15947420021859068
205               }
206             },
207             "troublerelaxing": {
208               "severity": 0.6678929399237447,
209               "distribution": {
210                 "none": 0.1026108764334131,
211                 "mild": 0.1720327504635266,
212                 "moderate": 0.3444230500014736,
213                 "severe": 0.3809333231015867
214               }
215             },
216             "restlessness": {
217               "severity": 0.48338808178548404,
218               "distribution": {
219                 "none": 0.2545397514505825,
220                 "mild": 0.26975254891838296,
221                 "moderate": 0.2467114024550342,
222                 "severe": 0.22899629717600023
223               }
224             },
225             "irritability": {
226               "severity": 0.3970791626763033,
227               "distribution": {
228                 "none": 0.3218806625247734,
229                 "mild": 0.32670323997606787,
230                 "moderate": 0.18971404444463374,
231                 "severe": 0.1617020530545248
232               }
233             },
234             "dread": {
235               "severity": 0.450211093163748,
236               "distribution": {
237                 "none": 0.30946646688056556,
238                 "mild": 0.24927688874671267,
239                 "moderate": 0.22241354237363423,
240                 "severe": 0.21884310199908763
241               }
242             }
243           }
244         }
245       },
246       "report": {
247         "viewUrl": "https://reports.thymia.ai/v1/reports/123e4567-e89b-12d3-a456-426614174000?token=...",
248         "pdfUrl": "https://reports.thymia.ai/v1/reports/123e4567-e89b-12d3-a456-426614174000/pdf?token=...",
249         "accessExpiresAt": "2024-12-31T23:59:59Z"
250       },
251       "errorCode": "ERR_RECORDING_INVALID_FORMAT",
252       "model": "string"
253     },
254     "emotions": {
255       "id": "string",
256       "createdAt": "2019-08-24T14:15:22Z",
257       "status": "COMPLETE_OK",
258       "runAt": "2024-01-15T09:30:00Z",
259       "completedAt": "2019-08-24T14:16:000Z",
260       "errorReason": "string",
261       "warnings": [
262         "string"
263       ],
264       "results": {},
265       "errorCode": "ERR_RECORDING_TOO_SHORT"
266     }
267   }
268 }

Retrieve the details of a call, including model run results if they are available.

Authentication

x-api-keystring

Your API Activation Key

Path parameters

call_idstringRequiredformat: "uuid"

Response

Details of a call's current state

idstringformat: "uuid"

The id of the requested call

userobject

statusstring

Current status of the call

agentobject

Configuration for the AI voice agent used in the call

extractedFieldsobject

Fields that was extracted by the agent in the call

modelRunobject

Model run results if available

Errors

404

Not Found Error

422

Unprocessable Entity Error