Jelliu API documentation

{
  "data": {
    "id": "7c1e4b2a-9d3f-4e8a-b5c6-2f1a0d9e8b7c",
    "tenant_id": "2d9f6c1e-3b4a-4c5d-9e8f-7a6b5c4d3e2f",
    "name": "Sofía — Ventas",
    "voice_id": "21m00Tcm4TlvDq8ikWAM",
    "language": "es-CO",
    "category": "sales",
    "template_id": null,
    "system_prompt": "Eres Sofía, asesora comercial de Cafés del Huila. Ayudas a los clientes a elegir el plan de suscripción de café que mejor se ajusta a su consumo.",
    "first_message": "Hola, le habla Sofía de Cafés del Huila. ¿Cómo está?",
    "chat_system_prompt": null,
    "dynamic_variables": {},
    "objection_handlers": {},
    "escalation_rules": [],
    "transfer_rules": [
      {
        "targetAgentId": "4b8d2f6a-1c3e-4a5b-9d7f-6e2c8a0b1d3f",
        "condition": "El cliente pide hablar de un pedido ya realizado o de una factura."
      }
    ],
    "transfer_phone_number": "+573001234567",
    "max_call_duration_seconds": 240,
    "response_delay_seconds": 0,
    "human_pacing_enabled": true,
    "enable_voicemail_detection": true,
    "disclose_ai": null,
    "expressive_mode": false,
    "tool_call_sound_enabled": false,
    "text_normalisation_type": "elevenlabs",
    "turn_timeout": 1.5,
    "turn_eagerness": "normal",
    "tts_speed": 0.96,
    "tts_stability": 0.5,
    "tts_similarity_boost": 0.75,
    "department": "Ventas",
    "skills": [
      "suscripciones",
      "facturación"
    ],
    "allowed_toolkits": [
      "hubspot",
      "gmail"
    ],
    "disabled_tools": {
      "hubspot": [
        "HUBSPOT_DELETE_DEAL"
      ]
    },
    "toolkit_access": {
      "hubspot": "read"
    },
    "mcp_enabled": true,
    "tool_surface_status": "synced",
    "tool_surface_error": null,
    "tool_surface_updated_at": "2026-09-10T18:22:55.000Z",
    "paused_at": null,
    "created_at": "2026-09-01T15:04:05.000Z",
    "updated_at": "2026-09-10T18:22:41.000Z",
    "tool_profile": null,
    "base_prompt_version": "9f2c4e7a1b3d5f6e8a0c2b4d6f8e0a1c3b5d7f9e1a2c4b6d8f0e2a4c6b8d0f1e",
    "workflow": null,
    "tool_surface_version": 3,
    "high_risk": false,
    "paused_by": null,
    "paused_reason": null,
    "action_limits": {
      "maxSpendPerDayCents": 5000,
      "perHour": 60
    },
    "deleted_at": null,
    "channels": [
      "voice",
      "whatsapp"
    ],
    "objective": "sales",
    "analysis": {
      "successEvaluation": [
        {
          "id": "venta_concretada",
          "description": "El cliente aceptó contratar un plan de suscripción durante la llamada."
        }
      ],
      "dataCollection": [
        {
          "id": "plan_elegido",
          "dataType": "string",
          "description": "Plan que eligió el cliente.",
          "enum": [
            "mensual",
            "trimestral",
            "anual"
          ]
        }
      ]
    },
    "safety": {
      "blockedOutputTopics": [
        "política",
        "competidores"
      ]
    },
    "privacy": {
      "redactPiiAudio": true,
      "deleteAudioAfterProcessing": true,
      "retentionDays": 90
    },
    "mcpEnabled": true,
    "toolkitAccessEnforced": true,
    "total_calls": 0,
    "conversion_rate": 0,
    "calls_today": 0,
    "avg_sentiment": null
  }
}

Returns one agent of the workspace with every stored column (except the provider’s internal voice agent id) plus the fields the API derives (channels, objective, analysis, safety, privacy, mcpEnabled, toolkitAccessEnforced and the counters). This is the only endpoint that returns workflow, high_risk, pause details and action_limits.

Consistency. The agent is cached for up to 120 seconds. PATCH and DELETE through this API clear it immediately; background changes (provisioning finishing, a tool-surface sync, a pause) can take up to 120 seconds to appear.

Access

Required scope: read. Any workspace role can call it.
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 one agent of the workspace with every stored column (except the provider's internal voice agent id) plus the fields the API derives (`channels`, `objective`, `analysis`, `safety`, `privacy`, `mcpEnabled`, `toolkitAccessEnforced` and the counters). This is the only endpoint that returns `workflow`, `high_risk`, pause details and `action_limits`. **Consistency.** The agent is cached for up to 120 seconds. `PATCH` and `DELETE` through this API clear it immediately; background changes (provisioning finishing, a tool-surface sync, a pause) can take up to 120 seconds to appear. **Access** - **Required scope:** `read`. Any workspace role can call it. - **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 (id from GET /api/agents). An id from another workspace answers 404, like an unknown one; a value that is not a UUID answers 400.

Response

The agent.

dataobject

An agent as returned by GET /api/agents, GET /api/agents/{agentId} and POST /api/agents. Stored columns are snake_case (see AgentRowBase); the fields the API adds on top of them (channels, objective, analysis, safety, privacy, mcpEnabled, toolkitAccessEnforced, total_calls, conversion_rate, calls_today, avg_sentiment) are listed below, and the raw JSON columns they come from (supported_channels, analysis_config, safety_config, privacy_config) are not returned. analysis, safety and privacy are omitted when nothing is stored. GET /api/agents returns a projection (see that operation). The provider’s internal voice agent id is never returned.

A newly created agent is provisioned with the voice provider in the background for about 30-45 seconds; operations that need it answer 409 AGENT_PROVISIONING meanwhile.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Access

Required scope: read. Any workspace role can call it.
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.