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

Response

Successful Response
idstring
namestring
descriptionstring or null
voiceModeenum
Allowed values:
voicestring
createdAtdatetime
modelTierenumDefaults to balanced
Allowed values:
systemPromptstring or null
beginMessagestring or null
transferNumberstring or null
voicemailMessagestring or null
sttModeenumDefaults to fast

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

Allowed values:
ambientSoundenumDefaults to none

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

Allowed values:
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).

Allowed values:
numberslist of objects or null

Errors

422
Unprocessable Entity Error