Jelliu API documentation

{
  "data": [
    {
      "id": "84b5aa0e-f6d6-4d88-b3ad-cd7a5a2aeb9e",
      "tenant_id": "58ffb2a3-7704-4790-bf60-a7235e42d0e4",
      "agent_id": "efac2e32-c698-4018-974d-bbf4500916b5",
      "name": "Sitio web principal",
      "allowed_origins": [
        "https://www.clinicasonrisa.co"
      ],
      "branding": {
        "primary_color": "#1C1D2B",
        "position": "bottom-right",
        "title": "Habla con nosotros",
        "subtitle": "Respondemos en minutos",
        "quick_replies": [
          "Agendar una cita",
          "Ver precios"
        ]
      },
      "voice_enabled": true,
      "greeting_message": "¡Hola! ¿En qué te puedo ayudar hoy?",
      "rate_limit_rpm": 30,
      "api_key": "1dbac0de07f71908b42f2b1fb25f87f37073d231959ec319cb79296f14425645",
      "is_active": true,
      "created_at": "2026-09-10T14:22:05.418Z",
      "updated_at": "2026-09-12T09:03:41.207Z",
      "deleted_at": null
    },
    {
      "id": "2f7a9c1e-3b4d-4e6f-8a0b-1c2d3e4f5a6b",
      "tenant_id": "58ffb2a3-7704-4790-bf60-a7235e42d0e4",
      "agent_id": "efac2e32-c698-4018-974d-bbf4500916b5",
      "name": "Tienda Shopify",
      "allowed_origins": [
        "https://tienda.clinicasonrisa.co"
      ],
      "branding": {
        "primary_color": "#0E7C66"
      },
      "voice_enabled": false,
      "greeting_message": null,
      "rate_limit_rpm": 30,
      "api_key": "7c3e0b9a51d24f86a0e1b7c2d9f34a5b6c7d8e9f0a1b2c3d4e5f60718293a4b5",
      "is_active": true,
      "created_at": "2026-08-28T18:40:12.001Z",
      "updated_at": "2026-08-28T18:40:12.001Z",
      "deleted_at": null
    }
  ]
}

Lists the widgets of your workspace, newest first (created_at descending). Deleted widgets are never included. Use GET /api/widgets/{id} to read one and POST /api/widgets to add one.

Offset pagination: the response is a bare data array with no total and no cursor. Request the next page with offset increased by limit until fewer than limit items come back. See Pagination.

api_key in each item is the stored HMAC digest, not a usable key.

Consistency. Pages are cached per limit/offset for up to 120 seconds. Creating, updating or deleting a widget clears that cache, so your own writes show up on the next read.

Idempotency. Read-only; safe to retry.

Access

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

Lists the widgets of your workspace, newest first (`created_at` descending). Deleted widgets are never included. Use `GET /api/widgets/{id}` to read one and `POST /api/widgets` to add one. Offset pagination: the response is a bare `data` array with no total and no cursor. Request the next page with `offset` increased by `limit` until fewer than `limit` items come back. See [Pagination](/pagination). `api_key` in each item is the stored HMAC digest, not a usable key. **Consistency.** Pages are cached per `limit`/`offset` for up to 120 seconds. Creating, updating or deleting a widget clears that cache, so your own writes show up on the next read. **Idempotency.** Read-only; safe to retry. **Access** - **Required scope:** `read` (or `write`). - **Rate limit:** General API — 120 requests/min per workspace (200 on Growth, 300 on Business, 600 on Enterprise). 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).

Query parameters

limitintegerOptional1-100Defaults to 50

Page size, 1 to 100. Default 50. A value outside the range or not a number returns 400 Request validation failed; it is not clamped.

offsetintegerOptional0-100000Defaults to 0

Number of widgets to skip, 0 to 100000. Default 0. Out-of-range values return 400 Request validation failed.

Response

A page of widgets. May be empty.

datalist of objects

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error