Skip to navigation
Atlas APIAgents

Update agent

Updates an agent using merge semantics — only the fields you include in the request body are changed; omitted fields keep their stored values. Voice and language settings are resolved from the voice catalog when AtlasVoiceId or VoiceId is provided.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

campaignIdstringRequired
idstringRequired

Request

This endpoint expects an object.
NamestringRequired
LanguagestringRequired
VoiceIdstringRequired
AgentTypeNamestringOptional
PreScriptstringOptional
PostScriptstringOptional
AtlasVoiceIdstringOptional
ModelstringOptional
ProviderenumOptional
Allowed values:
StabilitydoubleOptional
SimilarityBoostdoubleOptional
BackgroundSoundstringOptional
PitchdoubleOptional

Request-only — accepted on create/update but not returned in GET responses.

SpeeddoubleOptional
RegionstringOptional

Request-only — accepted on create/update but not returned in GET responses.

VolumedoubleOptional

Request-only — accepted on create/update but not returned in GET responses.

LanguageBooststringOptional

Request-only — accepted on create/update but not returned in GET responses.

FillerInjectionEnabledbooleanOptional

Request-only — accepted on create/update but not returned in GET responses.

TextNormalizationEnabledbooleanOptional

Request-only — accepted on create/update but not returned in GET responses.

Response

Agent updated

Errors

404
Not Found Error
500
Internal Server Error