Jelliu API documentation

{
  "data": [
    {
      "id": "5c4b3a29-1807-4f6e-9d5c-4b3a29180716",
      "agent_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "name": "lista-de-precios-septiembre-2026.pdf",
      "size": 482113,
      "status": "processing",
      "rag_index_status": "processing",
      "rag_index_error": null,
      "created_at": "2026-09-14T15:04:05.000Z",
      "updated_at": "2026-09-14T15:04:06.000Z"
    },
    {
      "id": "81d2e6f0-3b7a-4c19-a5e8-2f6d90c4b173",
      "agent_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "name": "preguntas-frecuentes.md",
      "size": 18342,
      "status": "ready",
      "rag_index_status": "succeeded",
      "rag_index_error": null,
      "created_at": "2026-09-10T11:20:31.000Z",
      "updated_at": "2026-09-10T11:20:44.000Z"
    },
    {
      "id": "c3a91f57-0d6e-4b28-9e14-7a5b2c8d6e09",
      "agent_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
      "name": "horario.txt",
      "size": 212,
      "status": "ready",
      "rag_index_status": "failed",
      "rag_index_error": "document_too_small",
      "created_at": "2026-09-02T09:12:00.000Z",
      "updated_at": "2026-09-02T09:12:03.000Z"
    }
  ]
}

Returns the agent’s knowledge documents (deleted ones excluded), newest first by created_at. Use it to show what an agent knows and to poll indexing progress after POST /api/agents/{agentId}/knowledge: a document moves from processing to ready (or failed) without any further call from you.

Offset pagination with limit and offset. The response carries no pagination metadata: request the next page until one comes back with fewer than limit items. See Pagination.

Consistency. Pages are cached for up to 5 minutes, but uploads and deletes clear every cached page of the agent before they respond, and the background indexer clears them when a status changes, so a document you just uploaded is visible on the next read.

Idempotency. Read-only and safe to retry.

Access

Required scope: read (or write). Any workspace role.
Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See Rate limits.
Plan: Available on every plan.

Returns the agent's knowledge documents (deleted ones excluded), newest first by `created_at`. Use it to show what an agent knows and to poll indexing progress after `POST /api/agents/{agentId}/knowledge`: a document moves from `processing` to `ready` (or `failed`) without any further call from you. Offset pagination with `limit` and `offset`. The response carries no pagination metadata: request the next page until one comes back with fewer than `limit` items. See [Pagination](/pagination). **Consistency.** Pages are cached for up to 5 minutes, but uploads and deletes clear every cached page of the agent before they respond, and the background indexer clears them when a status changes, so a document you just uploaded is visible on the next read. **Idempotency.** Read-only and safe to retry. **Access** - **Required scope:** `read` (or `write`). Any workspace role. - **Rate limit:** General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See [Rate limits](/rate-limits). - **Plan:** Available on every plan.

Authentication

AuthorizationBearer

Workspace API key: jl_ followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (Settings → API Keys) and sent as Authorization: Bearer jl_.... The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys.

Scope	GET / HEAD	POST / PUT / PATCH / DELETE	Admin-only routes
`read`	Yes	No	No
`write`	Yes	Yes	No
`full`	Yes	Yes	Yes

Operations restricted to admins or owners reject keys without the full scope with 403, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See Authentication.

Workspace API key: `jl_` followed by 64 lowercase hex characters, created by the workspace owner in the dashboard (**Settings → API Keys**) and sent as `Authorization: Bearer jl_...`. The plaintext is shown once, at creation; Jelliu stores only a SHA-256 hash. A workspace can hold up to 25 active keys. | Scope | GET / HEAD | POST / PUT / PATCH / DELETE | Admin-only routes | | --- | --- | --- | --- | | `read` | Yes | No | No | | `write` | Yes | Yes | No | | `full` | Yes | Yes | Yes | Operations restricted to admins or owners reject keys without the `full` scope with `403`, and say so in their description. No key, whatever its scope, can mint or revoke API keys or rotate a webhook secret — that requires a signed-in owner session. A revoked key stops authenticating within about 10 seconds. See [Authentication](/authentication).

Path parameters

agentIdstringRequiredformat: "uuid"

UUID of the agent. It must belong to the authenticated workspace; an id from another workspace answers 404, exactly like an unknown one. Returned as id by GET /api/agents.

Query parameters

limitintegerOptional1-100Defaults to 50

Maximum number of documents to return (1–100). Non-integer or out-of-range values are rejected with 400; they are not clamped.

offsetintegerOptional0-100000Defaults to 0

Number of documents to skip (0–100000). Out-of-range values are rejected with 400.

Response

The agent's documents, newest first.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Offset pagination with limit and offset. The response carries no pagination metadata: request the next page until one comes back with fewer than limit items. See Pagination.

Idempotency. Read-only and safe to retry.

Access

Required scope: read (or write). Any workspace role.
Rate limit: General API — 120 (Starter), 200 (Growth), 300 (Business) or 600 (Enterprise) requests/min per workspace. See Rate limits.
Plan: Available on every plan.