API overview

A full read-write REST surface over chatbots, knowledge, conversations, leads, channels, analytics, team, workspace, webhooks and reseller, on scoped keys.

Requires API access to be enabled for your workspace

The Evoriqa public API lets you drive your workspace from your own systems — read and write. What started as three read-only endpoints is now the complete v1 surface: ten endpoint families covering everything the dashboard does that makes sense over a key.

Base URL

https://app.evoriqa.com/api/v1

What you can do

Family	Surface	Scopes
Chatbots	Create, configure, and delete chatbots; widget settings, hours, actions, action runs	`chatbots:*`
Knowledge	Add URL/FAQ/manual/file sources, crawl sites, recrawl, reindex	`knowledge:*`
Conversations	Read threads, reply as an agent, resolve, assign, notes, bulk status, CSV	`conversations:*`
Leads	Read, update, delete, export leads	`leads:*`
Channels	Connect the seven omnichannel types, toggle, disconnect	`channels:*`
Analytics	The dashboard summary bundle and topic clustering	`analytics:read`
Team	Members, roles, invites	`team:*`
Workspace	Settings snapshot plus every individual setting	`workspace:*`
Webhooks	Configure endpoints per feature group, read and resend deliveries	`workspace:*`
Reseller	Client provisioning + handover invite, pooled-credit allocate and reclaim, limit overrides, white-label. Dashboard-only: client deletion, invite resend, BYO Stripe connect/plans/checkout links, pool top-up checkout, logo upload, single webhook-receipt detail	`reseller:*`

Each endpoint's page in the sidebar documents its parameters, request body, and scope. A few dashboard flows are deliberately not in v1 — anything tied to a human session (workspace create/delete/switch, invite acceptance, Stripe checkout, step-up-protected deletion) and browser-side features like the PDF export.

The six things to know

1
Authentication — a workspace API key of the form blm_…, on either an Authorization: Bearer or an x-api-key header. → Authentication
2
Scopes — every key carries a fixed subset of the scope registry; each endpoint names the scope it needs, and a missing scope is a 403 naming it. → Scopes
3
Access has to be enabled — a valid key still returns 403 until API access is switched on for your workspace. This is the most common reason a first call fails. → Authentication
4
One envelope — every response is { "success": …, "data" | "error" }; the CSV exports are the only exception. Read only documented fields — unlisted ones aren't part of the contract. → Response envelope
5
Cursor pagination on the big lists — limit up to 200, page until nextCursor is null; a few endpoints use skip/take offsets instead. → Pagination
6
Two 120-per-minute limits — one per IP, one per workspace, plus stricter per-endpoint limits on exports, crawls, and topic clustering. → Rate limits

The full code-to-status table is on Errors.

A first request

first-request.sh

curl https://app.evoriqa.com/api/v1/chatbots \
  -H "Authorization: Bearer $EVORIQA_API_KEY"

{
  "success": true,
  "data": {
    "data": [{ "id": "…", "name": "Support bot", "publicId": "cb_…" }],
    "nextCursor": null
  }
}

Writes are attributed to the owner

A key is not a member identity. Key-driven writes — agent replies, notes, assignments, source creation, settings changes — are recorded as the workspace owner in audit trails and attribution, and owner-protecting guards apply (for example, the owner's member row cannot be changed over the API).

What to use alongside the API

Reacting to something happening — use webhooks, not polling. Nine events across four feature groups, configurable over the API itself.
Building your own chat frontend — use the widget's public endpoints, which need no API key.

Where to go next

Last updated 21 September 2026