Skip to main content
PUT
Replace assistant
Saves an assistant with a configuration document you send whole: the stored config is replaced, not merged into. Use it when you hold the complete document, for example one you read, edited in full and are saving back. To change part of an assistant, update it with PATCH instead. agent_name and agent_type are optional here too, and anything you leave out of the body is untouched. Only a config you send replaces the stored one.

Path parameters

string
required
UUID of the assistant.

Body

At least one field is required.
string
New display name, 1–255 characters.
string
New prompt style.
object
The whole configuration document. It replaces the stored one: missing settings are filled in with their defaults, so a key you leave out is reset, not kept. Native tools are not switched on for you, as they are on create: a tool your document leaves out of both nativeTools and toolIds is dropped, end_call included. One exception: a document without kbStoreIds keeps the assistant’s knowledge-base links.
{"config": {"systemPrompt": "…"}} resets everything else in config to its default and drops the assistant’s tools, end_call included, so it can no longer hang up. To change one setting, send the same body with PATCH, or read the assistant, edit its config and send all of it back here.

Request

Response

200 OK with the updated assistant, its configuration completed and its toolIds re-checked.

Native tools

nativeTools entries are three-state here as well. A tool your document does not mention keeps its row and stays switched on or off as it was, as long as its id stays in toolIds. Since the document replaces toolIds too, send the assistant’s own toolIds back with it. To switch one tool on or off without restating the rest, use PATCH.

Errors