Skip to main content
PUT
Update Agent Configuration

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agent_id
string<uuid>
required

Body

application/json

Comprehensive agent configuration update model.

name
string | null
Required string length: 1 - 255
description
string | null
status
enum<string> | null

Agent status enumeration.

Available options:
draft,
active,
paused
model_provider
string | null
Pattern: ^(openai|azure_openai|anthropic|google|groq|cerebras|deepseek|xai|mistral|perplexity|together|fireworks|cohere|amazon_bedrock|alibaba_qwen|ibm_watsonx|meta_llama|anyscale|openrouter|deepinfra|custom_llm)$
model_name
string | null
temperature
number | null
Required range: 0 <= x <= 1
max_tokens
integer | null
Required range: 50 <= x <= 1000
first_message_mode
boolean | null
first_message_script
string | null
voice_provider
string | null
Pattern: ^(elevenlabs|cartesia|azure|livekit_inference)$
voice_id
string | null
background_sound_url
string | null
input_min_characters
integer | null
Required range: 10 <= x <= 100
transcriber_provider
string | null
Pattern: ^(deepgram|google|azure|assemblyai|livekit_inference)$
transcriber_model
string | null
background_denoising
boolean | null
confidence_threshold
number | null
Required range: 0 <= x <= 1
wait_seconds
number | null
Required range: 0.1 <= x <= 1
smart_endpointing
boolean | null
interruption_words
integer | null
Required range: 0 <= x <= 10
punctuation_boundary_ms
integer | null
Required range: 50 <= x <= 500
no_punctuation_boundary_ms
integer | null
Required range: 800 <= x <= 3000
silence_timeout_seconds
integer | null
Required range: 10 <= x <= 120
max_duration_seconds
integer | null
Required range: 180 <= x <= 1800
idle_messages_enabled
boolean | null
max_idle_messages
integer | null
Required range: 1 <= x <= 10
idle_timeout_seconds
number | null
Required range: 5 <= x <= 60
analysis_prompt
string | null
analysis_timeout_sec
integer | null
Required range: 1 <= x <= 60
min_messages_for_analysis
integer | null
Required range: 0 <= x <= 10
voicemail_detection_enabled
boolean | null
voicemail_message
string | null
end_call_message
string | null
keypad_input_enabled
boolean | null
keypad_timeout_seconds
integer | null
Required range: 1 <= x <= 6
keypad_delimiters
string | null
Pattern: ^[#*]+$
workflow_id
string<uuid> | null
tools
Tools · object[] | null
default_user_lang
string | null
Required string length: 2 - 10
thinking_lang
string | null
Required string length: 2 - 10
interruptions_enabled
boolean | null
escalation_policy
Escalation Policy · object | null

Response

Successful Response

Comprehensive agent configuration response.

agent_id
string<uuid>
required
name
string
required
description
string | null
required
status
string
required
model_settings
Model Settings · object
required
voice_config
Voice Config · object
required
transcriber_config
Transcriber Config · object
required
conversation_control
Conversation Control · object
required
call_timeout
Call Timeout · object
required
analysis_config
Analysis Config · object
required
voicemail_config
Voicemail Config · object
required
keypad_config
Keypad Config · object
required
tools
Tools · object[]
required
language_config
Language Config · object
required
advanced_config
Advanced Config · object
required
external_integration
External Integration · object
required
created_at
string
required
updated_at
string
required
workflow
Workflow · object | null