Update Agent

Update an agent’s configuration.

Use this to change voice mode, system prompt, greeting, or voice. Switching voiceMode to “hosted” re-provisions the voice agent with built-in LLM.

Authentication

AuthorizationBearer

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

Path parameters

agent_idstringRequired

Request

This endpoint expects an object.
namestring or nullOptional
descriptionstring or nullOptional
voiceModeenumOptional
Allowed values:
enableMessagingboolean or nullOptional

When true, hosted-mode agents can send and read SMS/iMessage during calls.

modelTierenumOptional
Allowed values:
systemPromptstring or nullOptional
beginMessagestring or nullOptional
voicestring or nullOptional
transferNumberstring or nullOptional
voicemailMessagestring or nullOptional
sttModeenumOptional

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

Allowed values:
ambientSoundenumOptional

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

Allowed values:
denoisingModeenumOptional

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:
maxSilenceMsinteger or nullOptional10000-3600000

Hang up the call after this many milliseconds of caller silence. Default 600000 (10 min). Raise for IVR/hold-music workflows; lower to fail fast on dead lines. Range 10000 (10s) to 3600000 (1 hour).

Response

Successful Response
idstring
namestring
descriptionstring or null
voiceModeenum
Allowed values:
voicestring
createdAtdatetime
enableMessagingbooleanDefaults to true
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:
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).

numberslist of objects or null

Errors

422
Unprocessable Entity Error