Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload for initiating an outbound call. Provide either an existing agent_id (to use a stored agent) or an inline agent_config with optional agent_prompts (to create a temporary agent for this call). NOTE: the UI previously rendered a separate 'Option' schema because the spec used a oneOf; to avoid showing Option 1/2 in the docs we do not use oneOf here — the server still expects one of these two fields to be present.

sender_phone_number
string
required

Phone number to place the call from (E.164).

recipient_phone_number
string
required

Phone number to call (E.164).

agent_id
string<uuid> | null

Existing agent UUID to use for the call.

agent_config
object | null

Inline agent configuration for a temporary agent used only for this call.

agent_prompts
object | null

Optional inline prompts for a temporary agent.

record
boolean
default:true

Whether the call should be recorded. Compliant agents may force this to false.

template_variables
object

Template variables available to agent prompts.

Response

Call initiated successfully

status
string
required
Example:

"success"

message
string
required
call_details
CallDetails · object
required