Skip to main content
GET
Get Agent

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

Response

Successful Response

Agent response model.

created_at
string<date-time>
required
name
string
required
Required string length: 1 - 255
default_user_lang
string
required
Required string length: 2 - 10
thinking_lang
string
required
Required string length: 2 - 10
id
string<uuid>
required
owner_id
string<uuid>
required
status
enum<string>
required

Agent status enumeration.

Available options:
draft,
active,
paused
updated_at
string<date-time> | null
description
string | null
default_voice_id
string | null
interruptions_enabled
boolean
default:true
escalation_policy
Escalation Policy · object | null
model_provider
string
default:openai
Pattern: ^(openai|azure_openai|anthropic|google|groq|cerebras|deepseek|xai|perplexity|together|amazon_bedrock|anyscale|openrouter|deepinfra)$
model_name
string
default:gpt-4o-mini
Required string length: 1 - 100
temperature
number
default:0.7
Required range: 0 <= x <= 1
max_tokens
integer
default:150
Required range: 50 <= x <= 1000
system_prompt
string | null

Full system prompt defining the agent's role, behavior, and instructions. Falls back to description if not set.

Maximum string length: 8000
persona
string | null

Short character/personality descriptor (e.g. 'Friendly British accountant'). Renders as 'Personality: ...' in the system prompt.

Maximum string length: 2000
first_message_mode
string
default:assistant-speaks-first
Pattern: ^(assistant-speaks-first|wait-for-user|assistant-speaks-first-with-model-generated-message)$
first_message_script
string | null
Maximum string length: 500
voice_provider
string
default:elevenlabs
Pattern: ^(elevenlabs|cartesia|openai|deepgram|google|azure|rime|lmnt)$
voice_id
string | null
background_sound_url
string | null
Maximum string length: 500
input_min_characters
integer
default:30
Required range: 10 <= x <= 100
transcriber_provider
string
default:deepgram
Pattern: ^(deepgram|openai|assemblyai|google|azure)$
transcriber_model
string
default:nova-3
Required string length: 1 - 100
background_denoising
boolean
default:true
confidence_threshold
number
default:0.4
Required range: 0 <= x <= 1
multilingual_enabled
boolean
default:false

Enable automatic language detection for multilingual conversations

supported_languages
string[] | null

List of language codes the agent supports (e.g., ['en', 'es', 'fr']). If multilingual_enabled=true and this is empty, all languages are supported.

language_detection_provider
string
default:auto

Provider for language detection: 'auto' uses STT provider's built-in detection

Pattern: ^(auto|deepgram|whisper)$
respond_in_user_language
boolean
default:true

When true, agent responds in the detected user language. When false, always responds in default_user_lang.

wait_seconds
number
default:0.4
Required range: 0.1 <= x <= 1
smart_endpointing
boolean
default:true
interruption_words
integer
default:3
Required range: 0 <= x <= 10
punctuation_boundary_ms
integer
default:100
Required range: 50 <= x <= 500
no_punctuation_boundary_ms
integer
default:1500
Required range: 800 <= x <= 3000
silence_timeout_seconds
integer
default:30
Required range: 10 <= x <= 120
max_duration_seconds
integer
default:600
Required range: 180 <= x <= 1800
idle_messages_enabled
boolean
default:true
max_idle_messages
integer
default:3
Required range: 1 <= x <= 10
idle_timeout_seconds
number
default:7.5
Required range: 5 <= x <= 60
analysis_prompt
string | null
Maximum string length: 2000
analysis_timeout_sec
integer
default:10
Required range: 1 <= x <= 60
min_messages_for_analysis
integer
default:2
Required range: 0 <= x <= 10
voicemail_detection_enabled
boolean
default:true
voicemail_message
string | null
Maximum string length: 500
end_call_message
string | null
Maximum string length: 500
keypad_input_enabled
boolean
default:false
keypad_timeout_seconds
integer
default:2
Required range: 1 <= x <= 6
keypad_delimiters
string
default:#
Pattern: ^[#*]+$
sip_enabled
boolean
default:false

Enable SIP/phone calling for this agent

recording_enabled
boolean
default:true

Enable call recording for this agent

analytics_enabled
boolean
default:true

Enable analytics tracking for this agent

meta_data
Meta Data · object | null
workflow_id
string<uuid> | null