Skip to main content
Create a new call with recording, transcript, agents, and customers
Calls POST /v1/call

​
Options

​
string
required
URL of source recording (must be an accessible WAV, MP3, MP4, or OGG file). Can be a signed URL.
​
string
URL of source stereo recording. Must be accessible. Can be a signed URL. Supported formats: WAV, MP3, MP4, OGG.
​
string
required
When the call started (ISO 8601 format).
​
string
required
Interface type of the call (PHONE or WEB). One of PHONE, WEB
​
string
required
Direction of the call (INBOUND or OUTBOUND). One of INBOUND, OUTBOUND
​
string
High-level call end status, indicating how the call terminated. One of PARTICIPANTS_DID_NOT_SPEAK, AGENT_DID_NOT_ANSWER, AGENT_DID_NOT_SPEAK, AGENT_STOPPED_SPEAKING, AGENT_ENDED_CALL, AGENT_SAID_END_CALL_PHRASE, AGENT_TRANSFERRED_CALL, AGENT_BUSY, AGENT_ERROR, CUSTOMER_ENDED_CALL, VOICE_MAIL_REACHED, SILENCE_TIME_OUT, PHONE_CALL_PROVIDER_CONNECTION_ERROR, CUSTOMER_DID_NOT_ANSWER, CUSTOMER_DID_NOT_SPEAK, CUSTOMER_STOPPED_SPEAKING, CUSTOMER_BUSY, DIAL_ERROR, MAX_DURATION_REACHED, UNKNOWN
​
array
List of transcript entries made during the call.
​
array
List of tool invocations made during the call.
​
object
Custom properties to include with the call. These can be used for filtering and will show in the call details page.
​
string
The Vapi call ID (UUID) to link this call with OpenTelemetry trace data from Vapi. Used for matching calls with OTEL traces.
​
string
The LiveKit Cloud room ID to link this call with OpenTelemetry trace data from LiveKit. Used for matching calls with OTEL traces.
​
string
A stable identifier from your own system (e.g. session ID, conversation ID) used to correlate this call with OpenTelemetry traces. Set the same value as a roark.external_id span or resource attribute on your traces and the matching trace will be linked automatically. Must be unique within a project.
​
object
Single agent participating in the call. Use this for simpler API when you have only one agent.
​
string
Endpoint configuration for this agent (optional).
​
object
Agent’s prompt configuration (optional).
​
array
Agents participating in the call. Each agent requires identification and prompt information.
​
object
Single customer participating in the call. Use this for simpler API when you have only one customer.
​
string
Label to identify this customer in the transcript (e.g., “speaker-01”, “speaker-02”).
​
string
required
Customer phone number in E.164 format (e.g., +14155551234).
​
array
Customers participating in the call.

​
Example

Every command also takes the global options and sets one of the exit codes.