Jelliu API documentation

Removes a document from the agent. The agent stops consulting it on its next conversation.

The document is first removed from the voice engine and only then marked deleted in Jelliu. If the provider removal fails, nothing is deleted and the error is returned, so the dashboard never shows a document as gone while the agent still uses it. Deleted documents stop counting against the plan’s file and size caps immediately.

Side effects. Deletes the document in the voice engine; when it was the agent’s last document, retrieval is turned off for the agent. Clears the cached document list. Writes an agent.knowledge.delete audit entry.

Idempotency. Safe to retry: a repeat call answers 404 with Document not found.

Webhook events. audit.log_recorded for the audit entry, if you subscribe to it. See Webhooks.

Access

Required scope: write. Any workspace role.
Rate limit: Configuration mutations — 10 requests/min per workspace (shared with other agent configuration changes), in addition to the General API limit (120–600/min by plan). See Rate limits.
Plan: Available on every plan.

Removes a document from the agent. The agent stops consulting it on its next conversation. The document is first removed from the voice engine and only then marked deleted in Jelliu. If the provider removal fails, nothing is deleted and the error is returned, so the dashboard never shows a document as gone while the agent still uses it. Deleted documents stop counting against the plan's file and size caps immediately. **Side effects.** Deletes the document in the voice engine; when it was the agent's last document, retrieval is turned off for the agent. Clears the cached document list. Writes an `agent.knowledge.delete` audit entry. **Idempotency.** Safe to retry: a repeat call answers `404` with `Document not found`. **Webhook events.** `audit.log_recorded` for the audit entry, if you subscribe to it. See [Webhooks](/webhooks). **Access** - **Required scope:** `write`. Any workspace role. - **Rate limit:** Configuration mutations — 10 requests/min per workspace (shared with other agent configuration changes), in addition to the General API limit (120–600/min by plan). 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.

docIdstringRequiredformat: "uuid"

The document id returned by the upload or list endpoints.

Response

Deleted. No body.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

502

Bad Gateway Error

Removes a document from the agent. The agent stops consulting it on its next conversation.

Idempotency. Safe to retry: a repeat call answers 404 with Document not found.

Webhook events. audit.log_recorded for the audit entry, if you subscribe to it. See Webhooks.

Access

Required scope: write. Any workspace role.
Rate limit: Configuration mutations — 10 requests/min per workspace (shared with other agent configuration changes), in addition to the General API limit (120–600/min by plan). See Rate limits.
Plan: Available on every plan.