Skip to main content
GET
Obtener un asistente
Returns one assistant, including the wiring that the list endpoint leaves out: the ordered blocks array and the knowledge nodes it can search. The blocks array carries references only — a block id, an optional pinned version, and a position. To get each block’s type and name, use GET /v1/assistants/{id}/blocks, which resolves them in one extra call rather than one per block.

Endpoint

Required scope

assistants:read

Headers

Path parameters

Example request

Response

200 OK

401 Unauthorized

Missing, invalid, revoked, or expired token.

403 Forbidden

The token does not have the assistants:read 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

  • A pinned_version_id of null means “follow the block”. The assistant renders whatever version the block currently points at, so editing that block changes this assistant. A non-null value freezes it to one snapshot, and later saves to the block do not reach this assistant until you repin it.
  • order is the position in the composed prompt, not an index into the array. Values need not be contiguous, and the array is returned in whatever order it is stored. GET /v1/assistants/{id}/blocks sorts by order for you.
  • This endpoint returns inactive assistants too, unlike the list. is_active: false means the assistant does not answer, but its configuration is intact.
  • 404 covers the cross-project case. An assistant that belongs to another project of the same company reads as not found, not as forbidden — the project of the token is part of its identity.
  • company, project, metadata and created_by are never returned. The first two are implied by the token, the third has no published schema, and the fourth is an internal user id.

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

Response

200 - application/json
assistant
object
required