Update Call Agent
Update an existing agent
Headers
x-api-keystringrequiredAPI key used for authenticating requests to the API.
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
agentIdstringrequiredThe unique identifier of the agent to update.
Request Body
namestringNew name for the agent.
llmModelstringrequireddefault: gpt-4o-miniNew language model to be used by the agent to generate responses. Must be one of: gpt-4o-mini, gpt-4o-enterprise, gpt-4.1, gpt-4.1-mini, gemini-2.5-flash-preview-native-audio-dialog, gemini-2.5-flash, gemini-live-2.5-flash-preview, geminiaudiopipeline:gemini-2.5-flash-preview-native-audio-dialog, gemini-2.0-flash-live-001, gpt-5.
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.
phoneNumberIdsarrayArray of phone number IDs to associate with the agent.
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.
{
"name": "Updated Customer Support Agent",
"llmModel": "claude-3-5-sonnet-latest",
"ttsModel": {
"provider": "11labs_byo",
"voiceId": "21m00Tcm4TlvDq8ikWAM",
"name": "Premium Voice",
"language": "en",
"elevenLabsApiKey": "your-new-elevenlabs-api-key"
},
"smartCallback": true,
"maxAttemptsForSmartCallback": 5,
"gapBetweenEachAttemptForSmartCallback": [
{ "days": 1, "hours": 0 },
{ "days": 1, "hours": 12 },
{ "days": 2, "hours": 0 },
{ "days": 3, "hours": 0 },
{ "days": 7, "hours": 0 }
],
"settings": {
"speed": 0.9,
"volume": 0.8,
"temperature": 0.6
}
}