Skip to main content
GET
Listar bloques del proyecto
The project’s whole block catalogue. Blocks are not owned by an assistant: they live here and any number of assistants can reference them, so this is where you look for something to reuse. Metadata only, no content — for that, read one block’s content.

Endpoint

Required scope

assistants:read

Headers

Query 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.

502 Bad Gateway

The assistant service is unreachable.

Operational notes

  • There is no total, and that is deliberate. The upstream store exposes no count for blocks, so rather than return the length of the current page as if it were the size of the set — which would make a client stop paginating early — the response carries has_more. Page until it is false.
  • Archived blocks are hidden by default but still active. include_archived=false only affects this listing: an archived block that is still attached to an assistant keeps rendering into its prompt. To take it out of an assistant, detach it.
  • content_writable: false marks the five catalogue typesproduct_info, store_info, reservation_info, tables_info, tags. You can read, rename and archive them here; saving their content returns 409.
  • Scoped to the token’s project. A block created under another project of the same company does not appear and cannot be read by id.
  • A block with current_version_id: null has never been saved. Reading its content returns 404 BLOCK_CONTENT_NOT_FOUND.

Authorizations

Authorization
string
header
required

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

Query Parameters

limit
number
default:50
Required range: 1 <= x <= 200
offset
number
default:0
Required range: x >= 0
type
enum<string>
Available options:
personification,
objective,
response_format,
steps,
cases_possible,
do_not,
product_info,
store_info,
reservation_info,
tables_info,
tags,
response_policy
family
enum<string>
Available options:
identity,
instructions,
information
include_archived
boolean
default:false

Incluye los bloques archivados. Un bloque archivado sigue rindiendo en el prompt de los asistentes que lo tienen adjunto.

Response

200 - application/json
limit
number
required
offset
number
required
has_more
boolean
required

Si hay al menos una pagina mas despues de esta.

data
object[]
required