List Call Agents
Retrieve a list of all call agents with all their details.
Returns a plain array of every agent in the workspace, newest first, including agents whose call flow is archived. There is no pagination. Each item also carries a summary of the call flow that uses it (flowName, pathway, flowIsLive and so on), so filter on flowIsLive to find agents that can take calls.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
[
{
"ttsModel": {
"language": "en",
"provider": "openai",
"voiceId": "alloy",
"name": "Alloy"
},
"_id": "example-agent-id-1",
"workspaceId": "example-workspace-id-1",
"userId": "example-user-id-1",
"name": "Test-Agent-1",
"llmModel": "gpt-4o-mini",
"type": "voice",
"settings": {
"speed": 0,
"volume": 1,
"temperature": 0.3
},
"status": "ready",
"activeSessions": [],
"createdAt": "2025-01-19T02:57:27.923Z",
"updatedAt": "2025-01-19T02:57:27.923Z"
},
{
"ttsModel": {
"language": "en",
"provider": "cartesia",
"voiceId": "example-voice-id-2",
"name": "Sarah"
},
"_id": "example-agent-id-2",
"workspaceId": "example-workspace-id-2",
"userId": "example-user-id-2",
"name": "New-Agent",
"llmModel": "gpt-4o-mini",
"type": "voice",
"settings": {
"speed": 0,
"volume": 1,
"temperature": 0.7
},
"status": "ready",
"activeSessions": [
{
"roomName": "example-room-1",
"startTime": "2025-01-16T14:46:36.883Z",
"status": "active",
"_id": "example-session-id-1"
},
{
"roomName": "example-room-2",
"startTime": "2025-01-16T21:10:47.518Z",
"status": "active",
"_id": "example-session-id-2"
}
],
"createdAt": "2024-12-27T10:49:04.175Z",
"updatedAt": "2025-01-17T09:09:47.887Z"
}
]Response Fields
ttsModelobjectContains the text-to-speech model details.
ttsModel.languagestringThe language of the voice model (e.g., en).
ttsModel.providerstringThe TTS provider name (e.g., openai, cartesia).
ttsModel.voiceIdstringThe unique identifier for the voice model.
ttsModel.namestringThe name of the voice model.
_idstringUnique identifier for the agent.
workspaceIdstringUnique identifier for the workspace associated with the agent.
userIdstringUnique identifier for the user associated with the agent.
namestringName of the agent.
llmModelstringThe LLM (language model) used by the agent (e.g., gpt-4o-mini).
typestringType of agent (e.g., voice).
settingsobjectThe settings for the agent, including speed, volume, and temperature.
settings.speednumberSpeaking speed. How it is applied depends on the voice provider; 0 means the provider's normal speed.
settings.volumenumberVolume of the voice.
settings.temperaturenumberCreativity of the language model, from 0 to 1.
statusstringThe current status of the agent (e.g., ready).
phoneNumberIdsarrayThe agent's phone numbers as full phone number objects (not IDs).
fallbackTtsModelobject | nullFallback voice, if one is set.
sttProviderobject | nullSpeech-to-text provider (id, name, description), if one is set.
fallbackSttProviderobject | nullFallback speech-to-text provider, if one is set.
fallbackLlmModelstring | nullFallback language model, if one is set.
flowNamestring | nullName of the call flow that uses this agent, or null if none does.
pathwaystring | nullID of that call flow.
flowDirectionstring | nullDirection of that call flow: outbound or bidirectional.
flowIsLivebooleanWhether a number given to this agent would take calls. false when the agent has no call flow, or its flow is archived or inactive.
flowArchivedAtstring | nullWhen the call flow was archived, or null.
hipaaCompliancebooleanWhether the agent's call flow has HIPAA mode on.
activeSessionsarrayA list of active sessions associated with the agent.
createdAtstringThe timestamp when the agent was created.
updatedAtstringThe timestamp when the agent was last updated.
Last updated on