Create Call
Create a new call via the public API. Requires a valid API key.
The simplest way to use Simple AI is to use the create-call
endpoint with just a prompt and an array of tools. If you need more control you shoudl use “agents”.
Authorizations
Body
Request to initiate an AI phone call
The phone number to call in E.164 format
"+12345678900"
The prompt to use for the AI call. Required if agent_id is not provided
"Hello, I'm calling to confirm your appointment"
The UUID of the phone number to use for the outbound call. If not provided, a phone number will be automatically selected.
"123e4567-e89b-12d3-a456-426614174000"
Whether to record the call or not
The language to use for the call - English (en) or Spanish (es)
en
, es
, ar
Keywords to emphasize during the conversation
["appointment", "schedule", "morning"]
ID of the pre-configured agent to handle the call. Required if prompt is not provided. Cannot be used together with analyzers - use the agent's analyzers instead.
"123e4567-e89b-12d3-a456-426614174000"
Additional parameters to pass to the call. These will be subtituted into the prompt for all keys with {{params.key}}
{
"appointment_type": "morning",
"customer_id": "123456"
}
List of analyzers to run after the call. Can only be provided when agent_id is not provided. If using an agent, use the agent's analyzers instead.
Request to initiate an AI phone call
The phone number to call in E.164 format
"+12345678900"
The prompt to use for the AI call. Required if agent_id is not provided
"Hello, I'm calling to confirm your appointment"
The UUID of the phone number to use for the outbound call. If not provided, a phone number will be automatically selected.
"123e4567-e89b-12d3-a456-426614174000"
Whether to record the call or not
The language to use for the call - English (en) or Spanish (es)
en
, es
, ar
Keywords to emphasize during the conversation
["appointment", "schedule", "morning"]
ID of the pre-configured agent to handle the call. Required if prompt is not provided. Cannot be used together with analyzers - use the agent's analyzers instead.
"123e4567-e89b-12d3-a456-426614174000"
Additional parameters to pass to the call. These will be subtituted into the prompt for all keys with {{params.key}}
{
"appointment_type": "morning",
"customer_id": "123456"
}
List of analyzers to run after the call. Can only be provided when agent_id is not provided. If using an agent, use the agent's analyzers instead.
Request to initiate an AI phone call
The phone number to call in E.164 format
"+12345678900"
ID of the pre-configured agent to handle the call. Required if prompt is not provided. Cannot be used together with analyzers - use the agent's analyzers instead.
"123e4567-e89b-12d3-a456-426614174000"
The UUID of the phone number to use for the outbound call. If not provided, a phone number will be automatically selected.
"123e4567-e89b-12d3-a456-426614174000"
Whether to record the call or not
The language to use for the call - English (en) or Spanish (es)
en
, es
, ar
The prompt to use for the AI call. Required if agent_id is not provided
"Hello, I'm calling to confirm your appointment"
Keywords to emphasize during the conversation
["appointment", "schedule", "morning"]
Additional parameters to pass to the call. These will be subtituted into the prompt for all keys with {{params.key}}
{
"appointment_type": "morning",
"customer_id": "123456"
}
List of analyzers to run after the call. Can only be provided when agent_id is not provided. If using an agent, use the agent's analyzers instead.
Response
en
, es
, ar
Indicates how the call was answered - by a human, voicemail, or if there was no answer
voicemail
, human
, no_answer
, unknown
List of analyzers configured for this call
Results from analyzers that have completed
Was this page helpful?