Skip to content
RelationsAI
Try it uses test keys only. Requests go straight from your browser to https://voice-api.relationsai.com/v1 with a rai_test_ key, which never places a real call. It works once the API is enabled for your workspace (private preview: support@relationsai.com). Your key stays in this tab's memory; live keys are refused.
RelationsAI API
RelationsAI API

Analysis

Download schema

Read the summary, extracted values and goal result of a settled call.

Retrieve a call analysis

GET
https://voice-api.relationsai.com/v1
/calls/{call_id}/analysis
Bearer (rai_test_... or rai_live_...)

Returns the call summary, the fields the agent extracts from the conversation (configured in the console), and whether the call met its goal. Analysis is produced after the call ends, usually within a minute; each part has its own state. Sentiment is not offered.

GET /v1/calls/{call_id}/analysis · Operation ID: getCallAnalysis

Retrieve a call analysis › path Parameters

call_id
​string · pattern: ^call_[A-Za-z0-9_-]{… · required

The call id (call_...).

Retrieve a call analysis › Responses

The analysis, or its state while not ready.

What the call achieved: a summary, the fields the agent was configured to extract, and whether the call's goal was met. Produced after the call ends.
CallAnalysis
object
​string · const · required

Always call_analysis.

Const value: call_analysis
livemode
​boolean · required

Mode of the call.

call_id
​string · required

The call.

state
​string · enum · required

Overall state: pending while any part is still being produced, ready when every part has finished (a part may still be failed), absent when the call produced nothing to analyse. Open enum.

Enum values:
pending
ready
absent
failed
simulated
​boolean · required

True for a test-mode fixture.

​object · required

A short written summary of the conversation.

​ExtractedField[] · required

Fields the agent is configured (in the console) to extract from the conversation.

goal_met
​boolean | null · required

Whether the call met the agent's goal, when the agent is configured to report it. Null otherwise.

RecordingsContacts