API reference

#Overview

Base URL https://api.oneli.io. Every endpoint here needs Authorization: Bearer oli_… (an API key or a connected agent’s token), except GET /v1/voices. Request bodies are JSON. Errors follow the error format. Endpoints that need a person to sign in (billing, profile, keys) are not listed.

#Create a call task

POST/v1/call-tasks

Response: 201 with {task, created: true}, or 200 with {task, created: false} when the key was used before. Outside calling hours the task is queued and not_before shows when it will be dialed.

Errors: 400 VALIDATION · 400 INVALID_NUMBER · 403 LEGAL_ACCEPTANCE_REQUIRED · 403 CALLS_PAUSED · 403 NO_PLAN · 403 QUOTA_EXHAUSTED · 403 QUOTA_HELD · 403 DO_NOT_CALL · 429 DAILY_CALL_LIMIT · 429 NUMBER_DAILY_LIMIT

#List tasks

GET/v1/call-tasks

The last 50 tasks, newest first: {tasks: [...]}. Each item has id, goal, to_number, status, outcome, created_at, not_before, attempts, duration_s, cost_minor, currency, billing, summary, status_detail. billing is plan or wallet.

#Get a task

GET/v1/call-tasks/:id

Returns {task, pending_consultation}. The task has every field you sent plus status, outcome, revision (for instructions), attempts, summary, call_end (the payload of the last call.ended event) and status_detail. Call content is deleted after content_expires_at.

{
  "task": {
    "id": "task_44be8f8d43da4748",
    "idempotency_key": "order-1234-call",
    "to_number": "972501234567",
    "goal": "לבדוק אם הזמנה 1234 מוכנה לאיסוף",
    "instructions": "",
    "constraints": { "max_price_ils": 50 },
    "dynamic_variables": {},
    "consult_mode": "manual",
    "max_duration_s": 180,
    "max_cost_minor": 300,
    "status": "completed",
    "outcome": "goal_achieved",
    "revision": 2,
    "not_before": "2026-10-22T09:14:03.120Z",
    "expires_at": "2026-10-23T09:14:03.120Z",
    "created_at": "2026-10-22T09:14:03.120Z",
    "updated_at": "2026-10-22T09:16:40.502Z",
    "content_expires_at": "2026-11-21T09:14:03.120Z",
    "attempts": 1,
    "summary": "ההזמנה מוכנה לאיסוף עד 18:00 היום.",
    "call_end": { "reason": "ended", "outcome": "goal_achieved", "duration_s": 74, "cost_minor": 0, "attempt": 1,
                  "currency": "ILS", "included_seconds": 74, "overage_seconds": 0, "summary": "…" },
    "status_detail": null
  },
  "pending_consultation": null
}

pending_consultation is null, or {id, question, options, context_summary, deadline_at} while a decision is waiting.

Errors: 404 TASK_NOT_FOUND

#Events

GET/v1/call-tasks/:id/events?after=<sequence>&limit=<n>&wait=<seconds>

after: the last sequence number you have read (default 0). limit: up to 200, default 50. Response: {events, next_cursor, pending_consultation}. Each event: sequence, type, payload, source, occurred_at. With no new events, next_cursor equals after.

{
  "events": [
    { "sequence": 1, "type": "task.queued", "payload": { "goal": "…" }, "source": "api", "occurred_at": "…" },
    { "sequence": 2, "type": "call.dispatching", "payload": { "attempt_id": "att_…" }, "source": "scheduler", "occurred_at": "…" },
    { "sequence": 5, "type": "transcript.final", "payload": { "speaker": "agent", "text": "שלום, אני עוזרת דיגיטלית…" }, "source": "voice", "occurred_at": "…" },
    { "sequence": 9, "type": "consultation.requested",
      "payload": { "consultation_id": "con_…", "question": "…", "options": ["approve", "decline", "ask_user"],
                   "context_summary": "…", "deadline_at": "…" }, "source": "voice", "occurred_at": "…" },
    { "sequence": 14, "type": "call.ended",
      "payload": { "reason": "ended", "outcome": "goal_achieved", "duration_s": 74, "cost_minor": 0, "attempt": 1, "summary": "…" },
      "source": "voice", "occurred_at": "…" }
  ],
  "next_cursor": 14,
  "pending_consultation": null
}

#Full transcript

GET/v1/call-tasks/:id/transcript

The whole conversation in one response, in order: who spoke (agent is OneLi’s voice agent, callee the other side) and what was said, without voice-style tags. Also has status, outcome and summary. Works with an API key. After the retention period the transcript is deleted and content_deleted is true.

{
  "task_id": "task_9380c85c2043caf3",
  "status": "completed",
  "outcome": "goal_achieved",
  "summary": "An appointment was booked for Tuesday at 10:30.",
  "content_deleted": false,
  "transcript": [
    { "speaker": "agent",  "text": "Hi, this is Daniel’s digital assistant…", "at": "2026-10-23T08:01:12Z" },
    { "speaker": "callee", "text": "Yes, how can I help?", "at": "2026-10-23T08:01:16Z" }
  ]
}

Errors: 404 TASK_NOT_FOUND

#Send an instruction

POST/v1/call-tasks/:id/instructions

Response: {command_id, revision, status: "pending"}. In an active call the instruction applies from the voice agent’s next turn. For a task still in the queue it is saved and added to the call’s instructions when it dials (and to any redial).

Errors: 409 REVISION_CONFLICT · 409 CALL_NOT_ACTIVE · 404 TASK_NOT_FOUND

#Cancel

POST/v1/call-tasks/:id/cancel

Response: {status: "cancelled"} for a queued task, or {status: "cancel_requested"} for an active call.

Errors: 409 CALL_NOT_ACTIVE · 404 TASK_NOT_FOUND

#Listen live

POST/v1/call-tasks/:id/listen

Returns {url, expires_at}: a WebSocket URL for the live call, valid 60 seconds. Listen-only, both sides mixed, never recorded or stored; the other side is told when someone starts listening. Stream: PCM 16-bit LE mono 8000 Hz. Scope calls:read, up to 10 per call per minute.

Errors: 409 CALL_NOT_ACTIVE · 404 TASK_NOT_FOUND · 429 RATE_LIMITED · 503 LISTEN_NOT_CONFIGURED

#Answer a consultation

POST/v1/consultations/:id/response

Response: {status: "accepted"}; {status: "expired"} if the deadline passed; or {status: "conflict", decision} if another answer came first. The first answer wins.

Errors: 400 BAD_DECISION · 404 CONSULTATION_NOT_FOUND

#Decision webhook

PUT/v1/decision-webhook

Body: {url} (up to 500 characters, public https on port 443). Response: {url, secret}. The whsec_… secret is shown once; setting it again rotates the secret.

GET/v1/decision-webhook

{webhook: {url, created_at, last_status, last_delivery_at} | null}

DELETE/v1/decision-webhook

{deleted: true} · Full guide

Errors: 400 BAD_WEBHOOK_URL

#Account

GET/v1/me

{user, wallet, plan, rate_per_minute_minor, legal, terms_required}. plan has the plan code, available_seconds and period_end, or is null. Useful to check the connection and the quota before creating a task.

GET/v1/wallet

{currency, available, balance, reserved} (in agorot)

#Voices

GET/v1/voices

No auth. {voices: [{id, name, gender, style, preview_url}], default_voice_id}. The voice is chosen in your profile on the site, not per task.

#Event types

Other types may appear (for example internal quality events). Ignore types you do not recognise.

#Statuses and outcomes

status_detail explains in one line what happened after an unanswered dial: {code, he, en, retry_at?}. For example busy_will_retry with the next try time, no_answer_final after the last try, or invalid_number. Otherwise it is null.