For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
agent_idstringRequired
Headers
X-Sub-Account-IdstringOptional
Response
Successful Response
idstring
namestring
descriptionstring or null
voiceModeenum
Allowed values:
voicestring
createdAtdatetime
enableMessagingbooleanOptionalDefaults to true
modelTierenumOptionalDefaults to balanced
Allowed values:
systemPromptstring or nullOptional
voicePromptstring or nullOptional
beginMessagestring or nullOptional
transferNumberstring or nullOptional
customToolslist of objects or nullOptional
voicemailMessagestring or nullOptional
callScreeningIdentitystring or nullOptional
callScreeningPurposestring or nullOptional
sttModeenumOptionalDefaults to fast
Speech-to-text mode. ‘fast’ optimizes for latency, ‘accurate’ optimizes for transcription accuracy (~200ms additional latency).
Allowed values:
ambientSoundenumOptionalDefaults to none
Background ambience to mask synthetic silence between turns. ‘none’ disables; ‘office’, ‘coffee-shop’, ‘outdoor’ enable a quiet bed.
Allowed values:
denoisingModeenumOptionalDefaults to noise-cancellation
Audio denoising. ‘noise-cancellation’ (default) handles general noise. ‘noise-and-background-speech-cancellation’ is more aggressive for callers in cars, cafes, or near TVs.
Allowed values:
maxSilenceMsintegerOptionalDefaults to 600000
Hang up the call after this many milliseconds of caller silence. Range 10000 (10s) to 3600000 (1 hour). Default 600000 (10 min).
voiceSpeeddoubleOptionalDefaults to 1
Voice speed multiplier. Range 0.5 to 2.0. Default 1.0.
interruptionSensitivitydoubleOptionalDefaults to 0.8
How easily callers can interrupt the agent. Range 0.0 to 1.0. Default 0.8.
enableBackchannelbooleanOptionalDefaults to true
When true, the agent interjects short filler words like ‘uh-huh’ or ‘mhmm’ during longer caller utterances. Defaults to true.
languagestringOptionalDefaults to en-US
BCP-47 locale that drives the agent’s speech recognition and pronunciation. Defaults to ‘en-US’.
