Make a call

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

Headers

AuthorizationstringRequired

Header authentication of the form Bearer <token>

Request

This endpoint expects an object.
model_idstringRequired

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

phonestringRequired

Phone number that the call goes to

namestringRequired

Name of the person that gets called

team_idstringOptional

The ID of the team can be obtained by opening a team and under the name of the team you should be able to copy it

custom_variableslist of objectsOptional

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

lead_emailstringOptional

Optional email of the lead for appointment booking.

lead_timezonestringOptional

Optional time zone name of the lead for appointment booking. List of possible time zones.

promptstringOptional

A prompt that will be used

greetingstringOptional

The greeting that the assistant will say

Response

200

statusstringOptional
responseobjectOptional
etaintegerOptional

How long it will take to initialise the call, in seconds.

Errors