Update Staged Voice Settings
Update this agent's staged voice pipeline configuration. Reflects unpublished staged state - see GET /agents/{agent_id}/versions/latest for what's actually live.
Authorization
OAuth2AuthorizationCodeBearer In: header
Path Parameters
uuidQuery Parameters
trueRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
The agent's voice configuration as one optional nested object.
pipeline_mode/language/voice_id/silence_end_call_timeout_secs and the three per-modality credential bindings are independently optional, matching the rest of this file's omitted-means-don't-touch fields.
stt_credential_id/tts_credential_id/realtime_credential_id each pick one of the org's credentials for the provider bound to that modality explicitly; null (the default) lets resolution fall through to the org's default and then the platform's metered key. Pass an explicit null to clear an earlier choice. cascade and s2s are each an independently optional sub-object - patching one never requires or disturbs the other, since an agent can carry configuration for a mode it has since switched away from.
extra="forbid" so a mistyped wire key 422s instead of being silently dropped and returning a 200 that changed nothing.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/stage/voice" \ -H "Content-Type: application/json" \ -d '{}'{ "pipeline_mode": "string", "language": "string", "voice_id": "2235c634-e4db-4ad6-aa15-066fb69b1c8f", "stt_credential_id": "eb187100-9387-457a-a988-b0410c4a2c25", "tts_credential_id": "e0d3c1fd-2fa1-4193-a64f-4bf411783f94", "realtime_credential_id": "0abad67d-3a88-469c-b861-de9ea624ac84", "silence_end_call_timeout_secs": 0, "cascade": { "stt_provider": "string", "stt_model": "string", "tts_provider": "string", "tts_model": "string", "enable_interruptions": true, "min_words_before_interruption": 0, "vad_confidence": 0, "vad_start_secs": 0, "vad_stop_secs": 0, "vad_min_volume": 0, "turn_model": "string", "eagerness": "string", "turn_timeout_secs": 0, "asr_keywords": [ "string" ], "filter_background_speech": true, "input_audio_format": "string", "interruption_ignore_terms": [ "string" ], "transcribe_on_disabled_interruptions": true }, "s2s": { "realtime_provider": "string", "realtime_model": "string", "turn_detection_type": "string", "turn_threshold": 0, "prefix_padding_ms": 0, "silence_duration_ms": 0, "eagerness": "string" }}{ "detail": "string", "code": "string"}{ "detail": [ { "loc": [ "string" ], "msg": "string", "type": "string" } ]}