Skip to main content
PUT
Update Call Agent

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Path Parameters

string
required
The unique identifier of the agent to update.

Request Body

string
New name for the agent.
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.
object
Text-to-Speech configuration updates.
boolean
default:"false"
Enable smart callback functionality for the agent.
number
default:"5"
Maximum number of callback attempts when smart callback is enabled.
array
Array of time intervals between each callback attempt. Each item contains days and hours.
array
Array of phone number IDs to associate with the agent.
object
Additional settings for the agent.
object
Custom variables to store for the agent.

Response Fields

string
The unique identifier of the agent.
string
The workspace identifier to which the agent belongs.
string
The user identifier associated with the agent, if applicable.
string
The name assigned to the agent.
object
The configuration of the text-to-speech model used by the agent.
string
The provider of the TTS service.
string
The specific voice ID used in the TTS model.
string
The name of the TTS model configuration.
string
The language set for the TTS model.
string
Encrypted ElevenLabs API key (only present if provider is “11labs_byo”).
string
The large language model used by the agent.
boolean
Whether smart callback functionality is enabled.
array
Array of phone number IDs associated with the agent.
array
A list of active sessions associated with the agent.
string
The name of the room for the session.
string
The participant identifier in the session.
date
The start time of the session.
string
The status of the session.
object
Any custom settings configured for the agent.
string
The current status of the agent, such as “pending”, “ready”, or “error”.
string
The current node or state within the agent’s flow or logic.
object
Custom variables stored for the agent.
string
Timestamp when the agent was created.
string
Timestamp when the agent was last updated.