Update voice settings
Update one voice setting per request using key and value.
Read the voice settings schema to find the available keys:
fields[].keyis the exact string to send askey.value_typeandvalidationdescribe the value’s type and constraints.- For a selection field with
options_ref, choose avaluefromoption_sets[options_ref]. Send the option’svalue, not its displaylabel.
Common settings:
| Setting | Key | Value |
|---|---|---|
| Conversation mode | voice_config.model_mode | pipeline or realtime |
| Language model | voice_config.llm | A value from voice_config.llm_models |
| Speech recognition model | voice_config.stt | A value from voice_config.stt_models |
| Speech synthesis model | voice_config.tts | A value from voice_config.tts_models |
| Voice | voice_config.tts_voice | A value from voice_config.tts_voices |
| Response delay | voice_config.response_time_ms | Milliseconds; see the field’s validation |
For example, to select a language model (use a value from the schema):
Model and voice choices depend on the current conversation mode and provider. After changing the
mode or a model, read the schema again before choosing a related setting. Changing one setting can
change related settings; they are listed in effects, and values contains the resulting
configuration.
Muting the caller while the agent speaks is a prompt setting:
Update prompt settings
with prompts.mute_user_while_assistant_speaks.
Autorisierungen
Scoped API token. Required scopes are listed on each operation in x-required-scopes.
Header
The revision from a previous read. If the configuration changed since, nothing is saved and 409 is returned.
Pfadparameter
ID of the voice agent.
Body
Antwort
Updated configuration. effects lists dependent values that changed as well.
Response format for reading and updating a settings group. On 409 and 422 the same format is returned with errors filled and values/revision reflecting the unchanged current state.
The settings group this response belongs to.
voice_config, prompts, knowledge_base Layout hint for clients that render the settings; always blocks.
"blocks"Version of the settings schema, for example voice-config.v1.
"voice-config.v1"
"prompts.v4"
"knowledge_base.v2"
Current revision. Send it as If-Match on voice settings writes to avoid overwriting concurrent changes.
Dotted field key to current value.
Related settings that changed as a consequence of this update.
Problems per field key. Empty on success.
Settings groups whose revision changed.
Reserved; always null.
Reserved; always null. Read the schema from the schema endpoint.
Reserved; always null.
Reserved; always null.
Voice settings updates only. Present when the update regenerated the agent's instructions.