API Referenceagents

Get Agent

Get a single agent with its attached numbers.

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Headers

X-Sub-Account-IdstringOptional

Target a sub-account. Pass a sub-account ID to scope this request. Omit to use the master account.

Response

Successful Response
idstring
namestring
descriptionstring or null
voiceModeenum
voicestring
createdAtdatetime
enableMessagingbooleanDefaults to true
modelTierenumDefaults to balanced
systemPromptstring or null
beginMessagestring or null
transferNumberstring or null
customToolslist of objects or null
voicemailMessagestring or null
callScreeningIdentitystring or null
callScreeningPurposestring or null
sttModeenumDefaults to fast

Speech-to-text mode. ‘fast’ optimizes for latency, ‘accurate’ optimizes for transcription accuracy (~200ms additional latency).

ambientSoundenumDefaults to none

Background ambience to mask synthetic silence between turns. ‘none’ disables; ‘office’, ‘coffee-shop’, ‘outdoor’ enable a quiet bed.

denoisingModeenumDefaults 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 ($0.005/min surcharge).

maxSilenceMsintegerDefaults to 600000

Hang up the call after this many milliseconds of caller silence. Range 10000 (10s) to 3600000 (1 hour). Default 600000 (10 min).

voiceSpeeddoubleDefaults to 1
Voice speed multiplier. Range 0.5 to 2.0. Default 1.0.
interruptionSensitivitydoubleDefaults to 0.8
How easily callers can interrupt the agent. Range 0.0 to 1.0. Default 0.8.
enableBackchannelbooleanDefaults to true

When true, the agent interjects short filler words like ‘uh-huh’ or ‘mhmm’ during longer caller utterances. Defaults to true.

languagestringDefaults to en-US

BCP-47 locale that drives the agent’s speech recognition and pronunciation. Defaults to ‘en-US’.

numberslist of objects or null

Errors

422
Unprocessable Entity Error