Skip to main content
GET
Get agent

Authorizations

Authorization
string
header
required

Send your organization API key as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

Agent id

Response

Agent

Voice agent configuration for your organization. llm is the primary model; fallback_llm is used when the primary cannot serve.

id
string<uuid>

Stable agent id.

phone_number_id
string

Assigned Twilio number id for this agent, if any. Empty when unassigned.

name
string

Display name.

llm
string

Language model id in provider/model form. Use GET /v1/llms for values accepted on create and update.

fallback_llm
string

Language model id in provider/model form. Use GET /v1/llms for values accepted on create and update.

status
enum<string>

Whether the agent accepts traffic.

Available options:
active,
inactive
prompt
string

System or base instructions for the model.

first_message
string

Opening line the agent speaks when a call starts.

first_message_interruption_time
number

Window (seconds) where the first message can be interrupted.

default_language
string

Primary speech language: multi, en, es, fr, de, it, pt, ru, zh, ja, ko, ar, or hi (same set as the builder UI). multi is only appropriate for multilingual STT (e.g. Deepgram Nova).

summarize_calls
boolean

Whether to generate summaries after calls.

created_at
string<date-time>
updated_at
string<date-time>
noise_cancel_settings
object

Inbound noise suppression profile.

vad_settings
object

Voice-activity detection timing for turn-taking. On PATCH, send only the fields to change; omitted properties keep their stored values.

enable_first_message_outbound
boolean

Play first_message on outbound calls when true.

voice_settings
object

Voice and TTS provider for the agent. On create or update, include id and provider; optional tuning fields (when sent and non-zero) must be between 0 and 2.

timeout_settings
object

Limits and escalation rules for user silence and overall call duration.

keyterms
string[]

Hints for transcription or keyword boosting, up to server limits.