API key used for authenticating requests to the API.
Workspace identifier for the API.
Path Parameters
The unique identifier of the agent to update.
Request Body
llmModel
string
default: "gpt-4o-mini"
required
New 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.
Text-to-Speech configuration updates. The text-to-speech provider. Must be one of: openai, rime, elevenlabs, 11labs_byo, google.
The voice ID used for generating speech. e.g for Trillet Voices,
“mistv2_Wildflower” - Alt Female, Smart
“mistv2_Brook” - Male, Friendly
“mistv2_Violet” - Female, Professional
Language code (e.g., en, fr).
ElevenLabs API key (required only when provider is “11labs_byo”). Will be encrypted and stored securely. Set to null to remove existing key.
Enable smart callback functionality for the agent.
maxAttemptsForSmartCallback
Maximum number of callback attempts when smart callback is enabled.
gapBetweenEachAttemptForSmartCallback
Array of time intervals between each callback attempt. Each item contains days and hours. Show Array Item Properties
Number of days to wait before the next attempt.
Number of hours to wait before the next attempt.
Array of phone number IDs to associate with the agent.
Additional settings for the agent. Value between 0 and 1 that determines how fast the TTS narrates text.
Value between 0 and 1 that adjusts the TTS volume.
Value between 0 and 1 for controlling the creativity of the LLM.
Custom variables to store for the agent.
Response Fields
The unique identifier of the agent.
The workspace identifier to which the agent belongs.
The user identifier associated with the agent, if applicable.
The name assigned to the agent.
The configuration of the text-to-speech model used by the agent. The provider of the TTS service.
The specific voice ID used in the TTS model.
The name of the TTS model configuration.
The language set for the TTS model.
Encrypted ElevenLabs API key (only present if provider is “11labs_byo”).
The large language model used by the agent.
Whether smart callback functionality is enabled.
Array of phone number IDs associated with the agent.
A list of active sessions associated with the agent. The name of the room for the session.
The participant identifier in the session.
The start time of the session.
The status of the session.
Any custom settings configured for the agent.
The current status of the agent, such as “pending”, “ready”, or “error”.
The current node or state within the agent’s flow or logic.
Custom variables stored for the agent.
Timestamp when the agent was created.
Timestamp 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
}
}