Skip to main content
GET
Get Call Analysis

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Path Parameters

id
string
required

The call's id as Place Call or List Calls gave it: out_… or sch_… for a call you placed, the call reference for any other.

Example:

"out_9f2c1a44-6b0e-4c1d-8a7f-2e5b3c9d1f60"

Response

The call's analysis.

id
string
required

The call's id.

callRef
string | null
required

The attempt that rang.

status
enum<string>
required

Where the call is.

Available options:
scheduled,
ringing,
connected,
completed,
missed,
failed,
cancelled
outcome
object | null
required

How it ended. Null until it has.

summary
string | null
required

Two or three sentences, when the call was summarised.

fields
object
required

The collected details — the agent's fields, or the call's own extract.

insights
object | null
required

What the call came to: how it ended, the customer's objections, why a no was a no, problems on the customer's side, and the next step agreed. Written once the call is read, before call.analysed is sent. Null when the agent's Call insights is off (Agents → the agent → Voice), for a web call, a call nobody spoke on, or a call whose content was deleted. Only what the customer actually said is noted.

analysedAt
string<date-time> | null
required

When the post-call work finished. Null means the summary and fields may still change.