Skip to main content
PATCH
Actualizar un asistente
Partial update. Only the fields present in the body change; everything else is left alone. Blocks are not editable here. Use PUT /v1/assistants/{id}/blocks to reorder or repin them, and PUT /v1/blocks/{id}/content to change what one says.

Endpoint

Required scope

assistants:write

Headers

Path parameters

Body

Every field is optional.

Example request

Response

200 OK

The full assistant, same shape as GET /v1/assistants/{id}.

400 Bad Request

A field over its length limit, a non-https avatar_url, a malformed ObjectId, an unknown property, or INVALID_MODEL when the new model is not supported.

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the assistants:write scope.

404 Not Found

No assistant with that id in the token’s company and project.

502 Bad Gateway

The assistant service is unreachable.

Operational notes

  • knowledge_node_ids replaces, it does not append. Sending one id leaves the assistant with exactly that one. Read the current list from GET /v1/assistants/{id} and send the union if you mean to add.
  • The model is only validated when it changes. An assistant already configured with a model that has since been retired keeps working through updates that do not touch model, and starts failing validation the moment you send it explicitly.
  • is_active: false is the reversible way to take an assistant out of service. It keeps every block, version and knowledge assignment; deleting does not.
  • Omitting a field and sending null are not the same. Omit it to leave the value alone. null is not accepted for these fields.
  • A change takes effect within about fifteen minutes at worst. The rendered prompt and bound functions are cached per assistant; the cache is dropped on every write, but a request already in flight can still answer with the previous configuration.

Authorizations

Authorization
string
header
required

Personal Access Token con prefijo kbai_pk_. Generar desde el portal con permiso developer.manage_tokens.

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 150
description
string
Maximum string length: 500
avatar_url
string

URL https de la imagen del avatar.

avatar_emoji
string
Maximum string length: 16
Example:

"🤖"

model
string

Identificador del modelo. Se valida solo si cambia respecto del actual.

knowledge_node_ids
string[]
Maximum array length: 200
is_active
boolean

Response

200 - application/json
assistant
object
required