Get Call Agent
Retrieve the details of a single call agent based on its unique identifier.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
agentIdstringrequiredThe unique identifier of the agent.
{
"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"
}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.
activeSessionsarrayA list of active sessions associated with the agent.
createdAtstringThe timestamp when the agent was created.
updatedAtstringThe timestamp when the agent was last updated.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Workspace ID is required"} | No x-workspace-id |
404 | {"error": "Agent not found"} | No agent with this ID in the workspace |
500 | {"error": "..."} | Unexpected server error |
Last updated on