Update prompt settings
Update one prompt setting per request using key and value. Read the
prompt settings schema
for keys, value types and choices.
Common settings:
| Setting | Key | Value |
|---|---|---|
| Instructions | prompts.user_prompt | A string |
| Greeting | prompts.initial_response | A string, up to 1000 characters |
| Mute the caller while the agent speaks | prompts.mute_user_while_assistant_speaks | JSON true or false |
| Transcription language | prompts.transcription_locale | A value from prompts.transcription_locales |
For example, to mute the caller while the agent speaks:
Send false to disable it. Use JSON booleans, without quotes. Language-model selection is a voice
setting: Update voice settings.
Autorisierungen
Scoped API token. Required scopes are listed on each operation in x-required-scopes.
Pfadparameter
ID of the voice agent.
Body
Antwort
Updated prompt configuration.
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.