List all agents
Query parameters
A limit on the number of objects to be returned. Limit can range between 1 and 1000, and the default is 1000.
The pagination key to continue fetching the next page of agents. Pagination key is represented by a agent id, pagination key and version pair is exclusive (not included in the fetched page). If not set, will start from the beginning.
Specifies the version of the agent associated with the pagination_key. When paginating, both the pagination_key and its version must be provided to ensure consistent ordering and to fetch the next page correctly.
If true, only return the latest version of each agent.
Response
Successfully retrieved all agents.
Example response
[
{
"agent_id": "oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD",
"base_version": 12,
"agent_name": "Jarvis",
"version_description": "Customer support agent for handling product inquiries",
"voice_id": "retell-Cimo",
"fallback_voice_ids": [
"cartesia-Cimo",
"minimax-Cimo"
],
"voice_temperature": 1,
"voice_speed": 1,
"enable_dynamic_voice_speed": true,
"enable_dynamic_responsiveness": true,
"volume": 1,
"voice_emotion": "calm",
"responsiveness": 1,
"interruption_sensitivity": 1,
"enable_backchannel": true,
"backchannel_frequency": 0.9,
"backchannel_words": [
"yeah",
"uh-huh"
],
"reminder_trigger_ms": 10000,
"reminder_max_count": 2,
"ambient_sound_volume": 1,
"language": "en-US",
"webhook_url": "https://webhook-url-here",
"webhook_timeout_ms": 10000,
"boosted_keywords": [
"retell",
"kroger"
],
"data_storage_setting": "everything",
"data_storage_retention_days": 30,
"opt_in_signed_url": true,
"signed_url_expiration_ms": 86400000,
"pronunciation_dictionary": [
{
"word": "actually",
"alphabet": "ipa",
"phoneme": "ˈæktʃuəli"
}
],
"end_call_after_silence_ms": 600000,
"max_call_duration_ms": 3600000,
"voicemail_message": "Hi, please give us a callback.",
"voicemail_detection_timeout_ms": 30000,
"voicemail_option": {
"action": {
"type": "static_text",
"text": "Please give us a callback tomorrow at 10am."
}
},
"ivr_option": {
"action": {
"type": "hangup"
}
},
"call_screening_option": {
"agent_identity": "Acme Health scheduling team",
"call_purpose": "confirming your appointment for tomorrow"
},
"post_call_analysis_data": [
{
"type": "string",
"name": "customer_name",
"description": "The name of the customer.",
"examples": [
"John Doe",
"Jane Smith"
]
}
],
"analysis_successful_prompt": "The agent finished the task and the call was complete without being cutoff.",
"analysis_summary_prompt": "Summarize the outcome of the conversation in two sentences.",
"analysis_user_sentiment_prompt": "Evaluate the user's sentiment based on their tone and satisfaction level.",
"begin_message_delay_ms": 1000,
"ring_duration_ms": 30000,
"stt_mode": "fast",
"vocab_specialization": "general",
"allow_user_dtmf": true,
"user_dtmf_options": {
"termination_key": "#"
},
"denoising_mode": "noise-cancellation",
"timezone": "America/New_York",
"last_modification_timestamp": 1703413636133
}
]Changes
Changed in 18 of the 28 revisions of this API.52893
- ●
removed the optional property
/////from the response with the statusresponse-optional-property-removed
- ●
- ●
added the new
s2.1-proenum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
added the new
sonic-3.5enum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ●
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○
added the optional property
//////to the response with the statusresponse-optional-property-added
- ○
added the optional property
//////to the response with the statusresponse-optional-property-added
- ○
added
subschema #1subschema #3to theresponse propertyallOflist for the response statusresponse-property-all-of-added
- ○
removed
subschema #1subschema #3from theresponse propertyallOflist for the response statusresponse-property-all-of-removed
- ○
removed the
gemini-2.5-flashenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
- ▲
the
//////response's property type changed fromstringto no type for statusresponse-property-type-changed
- ●
added the new
gpt-5.5enum value to the/////response property for the response statusresponse-property-enum-value-added
- ○
added to the
//////response propertyallOflist for the response statusresponse-property-all-of-added
- ○
removed the
azureenum value from the//////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
deepgramenum value from the//////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sonioxenum value from the//////response property for the response statusresponse-property-enum-value-removed
- ▲
- ▲
added
subschema #2to the/////response propertyoneOflist for the response statusresponse-property-one-of-added
- ▲
the
/////response's property type changed fromstringto no type for statusresponse-property-type-changed
- ○
removed the
af-ZAenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ar-SAenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
az-AZenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
bg-BGenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
bs-BAenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ca-ESenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
cs-CZenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
cy-GBenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
da-DKenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
de-DEenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
el-GRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
en-AUenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
en-GBenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
en-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
en-NZenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
en-USenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
es-419enum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
es-ESenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
fa-IRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
fi-FIenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
fil-PHenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
fr-CAenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
fr-FRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
gl-ESenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
he-ILenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
hi-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
hr-HRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
hu-HUenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
hy-AMenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
id-IDenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
is-ISenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
it-ITenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ja-JPenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
kk-KZenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
kn-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ko-KRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
lt-LTenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
lv-LVenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
mk-MKenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
mr-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ms-MYenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
multienum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ne-NPenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
nl-BEenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
nl-NLenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
no-NOenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
pl-PLenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
pt-BRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
pt-PTenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ro-ROenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ru-RUenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sk-SKenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sl-SIenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sr-RSenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sv-SEenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sw-KEenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ta-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
th-THenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
tr-TRenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
uk-UAenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
ur-INenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
vi-VNenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
yue-CNenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
zh-CNenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ▲
- ●
removed the optional property
/////from the response with the statusresponse-optional-property-removed
- ●
added the new
gemini-3.1-flash-liteenum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
added the new
s2-proenum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
added the new
sonioxenum value to the//////response property for the response statusresponse-property-enum-value-added
- ○
added the new optional
queryrequest parameteris_latestnew-optional-request-parameter
- ●
- ▲
added to the
//////response propertyoneOflist for the response statusresponse-property-one-of-added
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○
added the optional property
/////to the response with the statusresponse-optional-property-added
- ○
removed from the
//////response propertyoneOflist for the response statusresponse-property-one-of-removed
- ▲
- ●
added the new
gpt-5.4-minienum value to the/////response property for the response statusresponse-property-enum-value-added
- ●
added the new
gpt-5.4-nanoenum value to the/////response property for the response statusresponse-property-enum-value-added
- ○
removed the
sonic-2enum value from the/////response property for the response statusresponse-property-enum-value-removed
- ○
removed the
sonic-turboenum value from the/////response property for the response statusresponse-property-enum-value-removed
- ●
- ●
removed the optional property
/////from the response with the statusresponse-optional-property-removed
- ●
added the new
gpt-5.4enum value to the/////response property for the response statusresponse-property-enum-value-added
- ●