Skip to main content
PATCH
Update knowledge base settings

Autorisierungen

Authorization
string
header
erforderlich

Scoped API token. Required scopes are listed on each operation in x-required-scopes.

Pfadparameter

id
integer
erforderlich

ID of the voice agent.

Body

application/json

Update one setting.

key
string
erforderlich

Field key from this concern's schema.

value
any
erforderlich

New value for the selected setting. Send a value of the type the field's value_type expects.

Antwort

Updated knowledge-base selection.

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.

concern
enum<string>
erforderlich

The settings group this response belongs to.

Verfügbare Optionen:
voice_config,
prompts,
knowledge_base
shape
string
erforderlich

Layout hint for clients that render the settings; always blocks.

Allowed value: "blocks"
schema_version
string
erforderlich

Version of the settings schema, for example voice-config.v1.

Beispiele:

"voice-config.v1"

"prompts.v4"

"knowledge_base.v2"

revision
string
erforderlich

Current revision. Send it as If-Match on voice settings writes to avoid overwriting concurrent changes.

values
object
erforderlich

Dotted field key to current value.

effects
object[]
erforderlich

Related settings that changed as a consequence of this update.

errors
object
erforderlich

Problems per field key. Empty on success.

affected_concerns
object[]
erforderlich

Settings groups whose revision changed.

save_mode
null

Reserved; always null.

schema
null

Reserved; always null. Read the schema from the schema endpoint.

schema_revision
null

Reserved; always null.

draft
null

Reserved; always null.

system_prompt
string

Voice settings updates only. Present when the update regenerated the agent's instructions.