POST
/
observability
/
v1
/
observe
curl --request POST \
  --url https://new-prod.vocera.ai/observability/v1/observe/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "call_id": "<string>",
  "agent": 123,
  "assistant_id": "<string>",
  "voice_recording_url": "<string>",
  "transcript_type": "vocera",
  "transcript_json": {},
  "call_ended_reason": "<string>",
  "customer_number": "<string>",
  "metadata": {},
  "dynamic_variables": {}
}'
{
  "id": 123,
  "duration": "<string>",
  "success": true,
  "is_reviewed": true,
  "status": "success",
  "feedback": "<string>",
  "call_ended_reason": "<string>",
  "customer_number": "<string>",
  "agent": 123,
  "call_id": "<string>",
  "metrics": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Body

​
call_id
string
required
Maximum length: 100
​
agent
integer

The agent ID as shown on your dashboard. Either agent or assistant_id must be provided

​
assistant_id
string

The assistant ID associated with agent. Either agent or assistant_id must be provided.

​
voice_recording
file

The voice recording of the call

​
voice_recording_url
string

URL to the call recording audio file. Either voice_recording or voice_recording_url must be provided for detailed analysis. We do support transcript only evaluation if you don't have/want to share a recording.

​
transcript_type
enum<string>
  • vocera - vocera
  • vapi - vapi
  • retell - retell
  • deepgram - deepgram
Available options:
vocera,
vapi,
retell,
deepgram
​
transcript_json
object

Transcript of the call

​
call_ended_reason
string
Maximum length: 100
​
customer_number
string
Maximum length: 15
​
metadata
object

An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the call. Not used for processing. You can later get this field from the call object.

​
dynamic_variables
object

Dictionary of dynamic variables and values. These values will replace variables in double curly braces in the agent description.

Response

201
application/json
​
id
integer
required
​
duration
string
required
​
call_id
string
required
Maximum length: 100
​
metrics
string
required
​
created_at
string
required
​
updated_at
string
required
​
success
boolean | null
​
is_reviewed
boolean
​
status
enum<string>
  • success - Success
  • failure - Failure
  • reviewed_success - Reviewed Success
  • reviewed_failure - Reviewed Failure
Available options:
success,
failure,
reviewed_success,
reviewed_failure
​
feedback
string
​
call_ended_reason
string
Maximum length: 100
​
customer_number
string
Maximum length: 15
​
agent
integer | null
​
timestamp
string