Update AI Agent
Update an existing AI agent.
Path Parameters
Body
The display name for the AI agent that will be used in logs, analytics and user interfaces
Type of background ambient sound to play during calls to create a more immersive and natural environment
office
, cafe
, restaurant
, park
, street
, home
, library
, airport
, train_station
, beach
, none
Volume level for the ambient background sound, ranging from 0 (muted) to 2 (maximum volume)
0 < x < 2
Configuration for external data sources that the agent can query in real-time during calls to provide up-to-date information
Number of seconds of continuous silence after which the call will automatically end to prevent hanging calls
10 < x < 30
ID reference to a knowledge base containing domain-specific information the agent can use to enhance responses
BCP-47 language code (e.g., 'en-US', 'es-ES') that specifies the primary language for the agent's speech and understanding
Updated configuration for the Language Learning Model (LLM) that powers the agent's conversational abilities
Maximum allowed duration for a single call in seconds (between 30 seconds and 1 hour) to prevent indefinite calls
30 < x < 3600
Minimum duration in seconds that a user must speak before the agent can be interrupted, helps prevent premature interruptions
0 < x < 15
Minimum number of words that must be spoken before allowing interruption, provides more natural conversation flow
0 < x < 5
Configuration for automated analysis tasks to be performed after each call, such as sentiment analysis or call summarization
Updated configuration for the Speech-to-Text service that converts user speech to text for processing
Updated configuration for the Text-to-Speech service that converts the agent's responses to natural speech
Maximum time in seconds to wait while attempting to detect if the call was answered by a voicemail system
x > 0
Time in seconds to wait for additional speech before concluding the user has finished speaking
0 < x < 15
HTTPS URL endpoint where real-time call events and updates will be sent via webhook notifications
Custom greeting message that the agent will speak at the beginning of each call
Response
Name of the AI agent
Unique identifier for the AI agent
ID of the user who created this AI agent
Language model configuration for the AI agent
Speech-to-text configuration for the AI agent
Text-to-speech configuration for the AI agent
Type of ambient background sound to use during calls
office
, cafe
, restaurant
, park
, street
, home
, library
, airport
, train_station
, beach
, none
Volume level for ambient sound, from 0 (muted) to 2 (loud)
0 < x < 2
Configuration for dynamic data sources that can be used during calls
Whether to allow users to interrupt the AI agent while speaking
Number of seconds of silence before automatically ending the call
10 < x < 30
ID of the associated knowledge base, if any
Language code for the AI agent in BCP-47 format
Maximum duration of a call in seconds
30 < x < 3600
Minimum duration of speech in seconds before interruptions are allowed
0 < x < 15
Minimum number of words that must be spoken before interruption is allowed
0 < x < 5
Configuration for analysis items to be processed after calls
Time in seconds to wait for voicemail detection
x > 0
Time in seconds to wait before considering speech has ended
0 < x < 15
URL to send webhook notifications about call events
Custom welcome message to play at the start of calls