Calls

Make a call

Initiates a real-time phone call through the AI agent.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
model_idstringRequired

Agent ID. You can find it on the agent’s page in your dashboard.

phonestringRequired
Call recipient's phone number.
namestringRequired
Call recipient's name.
custom_variableslist of objectsOptional

Key-Value pairs of custom variables that you can dynamically inject into the prompt. Learn more.

lead_emailstringOptional
The customer's email that can be used to book an appointment.
lead_timezonestringOptional

The customer’s time zone that can be used to book an appointment. For a list of all available time zones, see Time zones.

promptstringOptional
The prompt that the agent will use.
greetingstringOptional
The greeting the agent will use.

Response

200
statusstring or null
responseobject or null
etainteger or null
How long it will take to initialize the call, in seconds.

Errors