Change an assistant's knowledge or model
Change an assistant’s name, knowledge collections, model, instruction or status. Send the revision you last read, so a concurrent edit is reported, not lost.
PATCH
Every body field is optional. A field you leave out, or send as
null, is left unchanged, except instruction, where null clears it. The request must change at least one field, or it fails with 400.
Send the revision you last read to guard against concurrent edits. If someone else has updated the assistant since, the request fails with 409 and nothing is changed; read the assistant again and retry. If you omit revision, your change is applied over whatever is stored.
An assistant that does not exist, belongs to another organization, or has a malformed ID returns 404. Updating an assistant requires the owner, admin or editor role.
Status values
Only an
active assistant with at least one knowledge base is answerable. There is no delete route; archiving is how you retire an assistant, and you can set it back to active later.
string
required
The assistant’s ID (UUID).
string
New display name. Trimmed; must be 1 to 120 characters on a single line, with no control,
invisible formatting or line-separator characters. Must not match another assistant’s name in your
organization, or the request fails with
409.string[]
Replaces the full list of knowledge bases. At most 20 after duplicates are removed. Each must
exist in your organization, or the request fails with
400. Send [] to remove them all, which
makes the assistant not answerable.string
New model selector,
provider/model or a bare model name. The provider must be one the platform
supports, and a bare model name must match exactly one model in the platform’s catalogue, or the
request fails with 400.string
New instruction, cleaned the same way as on create. Text longer than 8,000 characters is cut and
ends with
[…truncated]. Send "" or null to clear the instruction; leave the field out to
keep it unchanged.string
New description, up to 500 characters on a single line. Send
"" to clear it.string
New lifecycle status:
active, disabled or archived.integer
The
revision you last read, a whole number of at least 1. A stale value returns 409.Response
Returns the updated assistant.revision is one higher than before.
string
required
The assistant’s ID (UUID).
string
required
Display name.
string
required
Description. Empty string when none is set.
string
required
active, disabled or archived.string
required
The model selector.
string[]
required
Knowledge bases the assistant answers from.
string | null
required
The stored instruction, or
null when there is none.boolean
required
true when the assistant is active and has at least one knowledge base.integer
required
The new concurrency revision.
string | null
required
When the assistant was created, ISO 8601 in UTC. Treat a value without an offset as UTC.
string | null
required
When the assistant was last changed, ISO 8601 in UTC.
Last modified on September 26, 2026