Update Call Agent
Update an existing agent
Send only the fields you want to change. Objects such as ttsModel and settings are merged into what is stored; arrays such as gapBetweenEachAttemptForSmartCallback and phoneNumberIds replace the stored array.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
agentIdstringrequiredThe unique identifier of the agent to update.
Request Body
namestringNew name for the agent.
llmModelstringNew language model for the agent. Omit it to leave the current one unchanged.
Pass platform-llm for the managed platform model, or a specific model id such as gpt-4.1 or gemini-2.5-flash. The models on offer change over time, so call List Available Models for the current set rather than hardcoding one.
ttsModelobjectText-to-Speech configuration updates.
smartCallbackbooleandefault: falseEnable smart callback functionality for the agent.
maxAttemptsForSmartCallbacknumberdefault: 5Maximum number of callback attempts when smart callback is enabled.
gapBetweenEachAttemptForSmartCallbackarrayArray of time intervals between each callback attempt. Each item contains days and hours.
phoneNumberIdsarrayReplaces the agent's list of phone number IDs. Every new ID must be a number in this workspace, otherwise the request fails with 400. This only edits the list: it doesn't route calls or set up the number. To put a number on the agent, use Assign Phone Number to Agent and Unassign Phone Number from Agent instead.
settingsobjectAdditional settings for the agent.
variablesobjectCustom variables to store for the agent.
Response Fields
_idstringThe unique identifier of the agent.
workspaceIdstringThe workspace identifier to which the agent belongs.
userIdstringThe user identifier associated with the agent, if applicable.
namestringThe name assigned to the agent.
ttsModelobjectThe configuration of the text-to-speech model used by the agent.
providerstringThe provider of the TTS service.
voiceIdstringThe specific voice ID used in the TTS model.
namestringThe name of the TTS model configuration.
languagestringThe language set for the TTS model.
elevenLabsApiKeystringEncrypted ElevenLabs API key (only present if provider is "11labs_byo").
llmModelstringThe large language model used by the agent.
smartCallbackbooleanWhether smart callback functionality is enabled.
phoneNumberIdsarrayArray of phone number IDs associated with the agent.
activeSessionsarrayA list of active sessions associated with the agent.
roomNamestringThe name of the room for the session.
participantIdstringThe participant identifier in the session.
startTimedateThe start time of the session.
statusstringThe status of the session.
settingsobjectAny custom settings configured for the agent.
statusstringThe current status of the agent, such as "pending", "ready", or "error".
currentNodestringThe current node or state within the agent's flow or logic.
variablesobjectCustom variables stored for the agent.
createdAtstringTimestamp when the agent was created.
updatedAtstringTimestamp when the agent was last updated.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Workspace ID is required"} | No x-workspace-id |
400 | {"message", "code": "LLM_MODEL_INVALID"} | A changed llmModel or fallbackLlmModel isn't an available model, or is the retired trillet-llm |
400 | {"error", "code"} | phoneNumberIds names a number from another workspace |
500 | {"error": "..."} | Unexpected server error |
{
"name": "Updated Customer Support Agent",
"llmModel": "platform-llm",
"ttsModel": {
"provider": "rime",
"voiceId": "mistv3_brook",
"name": "Brook",
"rimeModel": "mistv3"
},
"smartCallback": true,
"gapBetweenEachAttemptForSmartCallback": [
{ "days": 1, "hours": 0 },
{ "days": 1, "hours": 12 },
{ "days": 2, "hours": 0 }
],
"settings": {
"temperature": 0.4
}
}{
"_id": "d5d5d5d5d5d5d5d5d5d5d5d5",
"workspaceId": "d1d1d1d1d1d1d1d1d1d1d1d1",
"userId": "a0a0a0a0a0a0a0a0a0a0a0a0",
"name": "Updated Customer Support Agent",
"ttsModel": {
"provider": "rime",
"voiceId": "mistv3_brook",
"name": "Brook",
"language": "en",
"rimeModel": "mistv3"
},
"llmModel": "platform-llm",
"smartCallback": true,
"maxAttemptsForSmartCallback": 5,
"gapBetweenEachAttemptForSmartCallback": [
{ "days": 1, "hours": 0 },
{ "days": 1, "hours": 12 },
{ "days": 2, "hours": 0 }
],
"type": "voice",
"settings": { "speed": 0, "volume": 1, "temperature": 0.4 },
"status": "ready",
"phoneNumberIds": [],
"activeSessions": [],
"createdAt": "2026-10-29T10:00:00.000Z",
"updatedAt": "2026-10-29T11:30:00.000Z"
}Last updated on