Download OpenAPI specification:
Generate realistic speech and clone voices. AI voice agents with retrieval augmented generation (RAG) and model context protocol (MCP) included.
Generate speech using an existing voice
|
text
required
|
string
The text you would like to generate speech for |
|
voice
required
|
string
The voice ID to use for generation |
|
audio_format
required
|
string
The desired audio format: mp3, wav, or pcm |
|
streaming
required
|
boolean
Whether or not to return streaming audio or a complete file |
| temperature |
number
Model temperature, supported ranges are between 0.8 and 1.2 |
| top_p |
number
Model top_p, supported ranges are between 0.4 and 0.9 |
{
-
"text":
"string",
-
"voice":
"string",
-
"audio_format":
"string",
-
"streaming":
true,
-
"temperature": 0,
-
"top_p": 0
}
Upload a new voice
|
name
required
|
string
The name of the voice |
| description |
string
A description of the voice |
|
type
required
|
string
Whether the voice is public or private |
| voiceTags |
Array of strings
Relevant tags for the voice e.g. Male, Female, Calm, Funny |
|
audio
required
|
string
A base64 encoded audio sample |
{
-
"name":
"string",
-
"description":
"string",
-
"type":
"string",
-
"voiceTags":
[
-
"string"
],
-
"audio":
"string"
}
{
-
"voiceId":
"string"
}
Update one of your uploaded voices
|
name
required
|
string
The name of the voice |
| description |
string
A description of the voice |
| type |
string
Whether the voice is public or private |
{
-
"name":
"string",
-
"description":
"string",
-
"type":
"string"
}
{
-
"voiceId":
"string"
}
Retrieve dashboard statistics such as call durations and credit spend for your agents from the last 90 days.
{
-
"number_of_calls": 0,
-
"average_duration": 0,
-
"total_credits_used": 0,
-
"avg_credits_per_call": 0,
-
"daily_stats":
[
-
{
-
"date":
"string",
-
"total_calls":
0,
-
"total_credits":
0
}
]
}
Retrieve detailed call logs.
| page |
integer
(Page)
>= 1
Default:
1
|
| limit |
integer
(Limit)
[ 1 .. 100 ]
Default:
10
|
| start_date |
string
(Start Date)
Filter calls after this date (ISO format UTC, e.g., 2024-01-01T00:00:00+00:00) |
| end_date |
string
(End Date)
Filter calls before this date (ISO format UTC, e.g., 2024-12-31T23:59:59+00:00) |
| agent_id |
string
(Agent Id)
Filter calls by specific agent ID |
{
-
"items":
[
-
{
-
"id":
0,
-
"agent_id":
"string",
-
"agent_name":
"string",
-
"call_timestamp":
"2019-08-24T14:15:22Z",
-
"call_duration_seconds":
0,
-
"credits_used":
0,
-
"has_transcript":
true,
-
"call_type":
"string",
-
"from_number":
"string",
-
"to_number":
"string",
-
"transcription_summary":
"string",
-
"transcription_stats":
{ }
}
],
-
"pagination":
{
-
"current_page":
0,
-
"total_pages":
0,
-
"total_items":
0,
-
"limit":
0,
-
"has_next":
true,
-
"has_previous":
true
}
}
Retrieve detailed agents information.
| page |
integer
(Page)
>= 1
Page number (1-based) |
| limit |
integer
(Limit)
[ 1 .. 100 ]
Items per page |
| show_statuses |
Array of strings
(Show Statuses)
List of statuses to show. By default shows deployed and paused agents. |
{
-
"items":
[
-
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code":
1,
-
"kb_id":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
}
],
-
"pagination":
{
-
"current_page":
0,
-
"total_pages":
0,
-
"total_items":
0,
-
"limit":
0,
-
"has_next":
true,
-
"has_previous":
true
}
}
Create a new agent.
|
name
required
|
string
(Name)
non-empty
Agent name cannot be empty |
|
required
|
object
(PublicAgentConfig)
|
| kb_id |
integer or null
(Kb Id)
|
|
Array of objects or null
(Documents)
|
{
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"kb_id": 0,
-
"documents":
[
-
{ }
]
}
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code": 1,
-
"kb_id": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
}
Create an agent from a saved template.
| agent_template |
string or null
(Agent Template)
|
| name |
string or null
(Name)
|
{
-
"agent_template":
"string",
-
"name":
"string"
}
{
-
"agent_template":
{ },
-
"available_types":
[
-
"string"
],
-
"description":
"Pre-configured agent template
based on selected type"
}
Retrieve owned phone numbers that aren't currently assigned to an agent.
| page |
integer
(Page)
>= 1
Page number (1-based) |
| limit |
integer
(Limit)
[ 1 .. 100 ]
Items per page |
{
-
"items":
[
-
{
-
"phone_number":
"string",
-
"locality":
"string",
-
"region":
"string",
-
"country_code":
"string"
}
],
-
"pagination":
{
-
"current_page":
0,
-
"total_pages":
0,
-
"total_items":
0,
-
"limit":
0,
-
"has_next":
true,
-
"has_previous":
true
}
}
Search available phone numbers for purchase.
| country_code |
string
(Country Code)
Default:
"US"
Country code (e.g., 'US', 'CA') |
| area_code |
string or null
(Area Code) ^\d{3}$
3-digit area code (e.g., '415') |
| provider |
string
(Provider)
Default:
"twilio"
Provider: 'twilio' or 'telnyx' |
{
-
"country_code":
"US",
-
"area_code":
"string",
-
"provider":
"twilio"
}
{
-
"results":
[
-
{
-
"phone_number":
"string",
-
"locality":
"string",
-
"region":
"string",
-
"country_code":
"string"
}
],
-
"total_results": 0
}
Get detailed information on owned phone numbers.
| page |
integer
(Page)
>= 1
Page number (1-based) |
| limit |
integer
(Limit)
[ 1 .. 100 ]
Items per page |
{
-
"items":
[
-
{
-
"phone_number":
"string",
-
"status":
"string",
-
"assigned_to_agent_id":
"string",
-
"assigned_to_agent_name":
"string"
}
],
-
"pagination":
{
-
"current_page":
0,
-
"total_pages":
0,
-
"total_items":
0,
-
"limit":
0,
-
"has_next":
true,
-
"has_previous":
true
}
}
Attempt to purchase a phone number.
|
phone_number
required
|
string
(Phone Number)
Exact phone number to purchase (e.g., '+15551234567') |
| provider |
string
(Provider)
Default:
"twilio"
Provider: 'twilio' or 'telnyx' |
{
-
"phone_number":
"string",
-
"provider":
"twilio"
}
{
-
"phone_number":
"string",
-
"status":
"string"
}
Release an owned phone number. Phone numbers attached to deployed agents cannot be released. You must first pause your agent.
|
phone_number
required
|
string
(Phone Number)
Exact phone number to purchase (e.g., '+15551234567') |
| provider |
string
(Provider)
Default:
"twilio"
Provider: 'twilio' or 'telnyx' |
{
-
"phone_number":
"string",
-
"provider":
"twilio"
}
{
-
"phone_number":
"string",
-
"status":
"string"
}
Get detailed information on a single agent.
|
agent_id
required
|
string
(Agent Id)
|
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code": 1,
-
"kb_id": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
}
Update an existing agent.
|
agent_id
required
|
string
(Agent Id)
|
| name |
string or null
(Name)
|
|
object or null
(PublicAgentConfig)
|
|
| status |
string or null
(Status)
|
| kb_id |
integer or null
(Kb Id)
|
|
Array of objects or null
(Documents)
|
{
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"string",
-
"kb_id": 0,
-
"documents":
[
-
{ }
]
}
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code": 1,
-
"kb_id": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
}
Deploy an agent and prepare for phone calls.
|
agent_id
required
|
string
(Agent Id)
|
{
-
"agent":
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code":
1,
-
"kb_id":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
},
-
"message":
"string",
-
"sip_status":
"string",
-
"sip_details":
{ }
}
Pause an agent and free the phone number attached to it. This endpoint is idempotent.
|
agent_id
required
|
string
(Agent Id)
|
{
-
"agent":
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code":
1,
-
"kb_id":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
}
}
Disable an agent. An agent must be paused before being disabled.
|
agent_id
required
|
string
(Agent Id)
|
{
-
"agent":
{
-
"agent_id":
"string",
-
"user_id":
"string",
-
"name":
"string",
-
"config":
{
-
"prompt":
"string",
-
"greeting":
"string",
-
"llm_temperature":
0.7,
-
"llm_model":
"gemini-2.5-flash-lite",
-
"tts_min_sentence_len":
20,
-
"tts_params":
{
-
"speaker":
0,
-
"voice_id":
"string",
-
"temperature":
1,
-
"response_format":
"mp3",
-
"stream":
true,
-
"top_p":
0.8
},
-
"min_silence_duration":
0.55,
-
"min_speech_duration":
0.1,
-
"user_silence_timeout":
10,
-
"max_call_duration_seconds":
900,
-
"allow_interruptions":
true,
-
"min_interruption_words":
1,
-
"auto_noise_reduction":
true,
-
"allow_agent_to_end_call":
false,
-
"allow_agent_to_skip_turn":
false,
-
"allow_outbound_calling":
false,
-
"outbound_contacts":
{ },
-
"min_endpointing_delay":
0.5,
-
"max_endpointing_delay":
3,
-
"vad_activation_threshold":
0.6,
-
"phone_number":
"string",
-
"mcp_servers":
[
-
{ }
],
-
"available_voices":
{
-
"property1":
{ },
-
"property2":
{ }
}
},
-
"status":
"paused",
-
"status_code":
1,
-
"kb_id":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z"
},
-
"message":
"string"
}
Create a knowledge base that your agent can use for retrieval augmented generation (RAG).
| name |
string or null
(Name)
|
| description |
string or null
(Description)
|
|
required
|
Array of objects
(Documents)
|
{
-
"name":
"string",
-
"description":
"string",
-
"documents":
[
-
{ }
]
}
{
-
"kb_id": 0,
-
"user_id":
"string",
-
"name":
"string",
-
"description":
"string",
-
"document_count": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z",
-
"message":
"string"
}
Retrieve knowledge base details.
| page |
integer
(Page)
>= 1
Page number (1-based) |
| limit |
integer
(Limit)
[ 1 .. 100 ]
Items per page |
{
-
"items":
[
-
{
-
"kb_id":
0,
-
"user_id":
"string",
-
"name":
"string",
-
"description":
"string",
-
"document_count":
0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z",
-
"message":
"string"
}
],
-
"pagination":
{
-
"current_page":
0,
-
"total_pages":
0,
-
"total_items":
0,
-
"limit":
0,
-
"has_next":
true,
-
"has_previous":
true
}
}
Retrieve knowledge base and its documents.
|
kb_id
required
|
integer
(Kb Id)
|
{
-
"kb_id": 0,
-
"user_id":
"string",
-
"name":
"string",
-
"description":
"string",
-
"document_count": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z",
-
"message":
"string",
-
"documents":
[
-
{ }
]
}
Update an existing knowledge base.
|
kb_id
required
|
integer
(Kb Id)
|
| name |
string or null
(Name)
|
| description |
string or null
(Description)
|
|
Array of objects or null
(Documents)
|
{
-
"name":
"string",
-
"description":
"string",
-
"documents":
[
-
{ }
]
}
{
-
"kb_id": 0,
-
"user_id":
"string",
-
"name":
"string",
-
"description":
"string",
-
"document_count": 0,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"updated_at":
"2019-08-24T14:15:22Z",
-
"message":
"string",
-
"documents":
[
-
{ }
]
}
Assign an existing knowledge base to an agent for retrieval augmented generation (RAG).
|
agent_id
required
|
string
(Agent Id)
|
|
kb_id
required
|
integer
(Kb Id)
|
{
-
"kb_id": 0
}
null
{
-
"api_keys":
[
-
{
-
"id":
0,
-
"name":
"string",
-
"description":
"string",
-
"is_active":
true,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"last_used_at":
"2019-08-24T14:15:22Z",
-
"expires_at":
"2019-08-24T14:15:22Z"
}
],
-
"total_keys": 0
}
Create a new API key.
|
name
required
|
string
(Name)
[ 1 .. 100 ] characters
Human-readable name for the API key |
| description |
string or null
(Description)
<= 500 characters
Optional description of the key's purpose |
| expires_at |
string or null
<date-time>
(Expires At)
Optional expiration date for the key |
{
-
"name":
"string",
-
"description":
"string",
-
"expires_at":
"2019-08-24T14:15:22Z"
}
{
-
"api_key":
"string",
-
"key_info":
{
-
"id":
0,
-
"name":
"string",
-
"description":
"string",
-
"is_active":
true,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"last_used_at":
"2019-08-24T14:15:22Z",
-
"expires_at":
"2019-08-24T14:15:22Z"
}
}
Retrieve details for a given API key.
|
key_id
required
|
integer
(Key Id)
|
{
-
"id": 0,
-
"name":
"string",
-
"description":
"string",
-
"is_active":
true,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"last_used_at":
"2019-08-24T14:15:22Z",
-
"expires_at":
"2019-08-24T14:15:22Z"
}
Update an API key.
|
key_id
required
|
integer
(Key Id)
|
| name |
string or null
(Name)
[ 1 .. 100 ] characters
|
| description |
string or null
(Description)
<= 500 characters
|
| is_active |
boolean or null
(Is Active)
|
| expires_at |
string or null
<date-time>
(Expires At)
|
{
-
"name":
"string",
-
"description":
"string",
-
"is_active":
true,
-
"expires_at":
"2019-08-24T14:15:22Z"
}
{
-
"id": 0,
-
"name":
"string",
-
"description":
"string",
-
"is_active":
true,
-
"created_at":
"2019-08-24T14:15:22Z",
-
"last_used_at":
"2019-08-24T14:15:22Z",
-
"expires_at":
"2019-08-24T14:15:22Z"
}
Get connection details for use with the Voice.AI SDK.
| agent_id |
string or null
(Agent Id)
|
| metadata |
string or null
(Metadata)
|
| environment |
string or null
(Environment)
|
{
-
"agent_id":
"string",
-
"metadata":
"string",
-
"environment":
"string"
}
{
-
"server_url":
"string",
-
"participant_token":
"string",
-
"call_id":
"string"
}
Check if an agent is currently available to be connected to.
|
agent_id
required
|
string
(Agent Id)
|
{
-
"agent_id":
"string",
-
"name":
"string",
-
"creator_user_id":
"string",
-
"voice_id":
"string",
-
"status":
"string",
-
"status_code": 0,
-
"call_allowed":
true,
-
"call_validation_details":
{ }
}
Marks a call as ended, this should be called as best-effort from front end clients at the end of a call.
|
call_id
required
|
string
(Call Id)
|
| actual_duration_seconds |
number
(Actual Duration Seconds)
Actual duration of the call in seconds |
{
-
"call_id":
"string",
-
"status":
"string",
-
"ended_at":
"2019-08-24T14:15:22Z",
-
"actual_duration_seconds": 0,
-
"credits_used": 0
}