API overview
The evoriqa v1 API is a small, read-only, cursor-paginated REST API — three GET endpoints, one API key, one workspace, and no write access yet.
The evoriqa public API lets you read your workspace's data — chatbots, conversations, and leads — from your own systems. It is deliberately small: v1 is read-only and consists of exactly three endpoints, each a cursor-paginated GET.
Base URL
https://app.evoriqa.com/api/v1What you can read
| Endpoint | Returns |
|---|---|
GET /chatbots | The workspace's chatbots |
GET /conversations | Conversations across those chatbots |
GET /leads | Captured leads, each with its assigned owner (or null) |
That is the whole surface. There are no POST, PATCH, or DELETE endpoints — write access is not available yet. Anything that changes data happens in the dashboard, on the widget's public endpoints, or not at all.
The five things to know
- 1Authentication — a workspace API key of the form
blm_…, on either anAuthorization: Beareror anx-api-keyheader. → Authentication - 2Access is gated — a valid key still needs three switches on, or you get a
403. This is the most common reason a first call fails. → Authentication - 3One envelope — every response is
{ "success": …, "data" | "error" },and list endpoints nest their rows at
data.data. → Response envelope - 4Cursor pagination —
limitup to 200, and page untilnextCursorisnull. → Pagination - 5Two 120-per-minute limits — one per IP, one per workspace.
The full code-to-status table is on Errors.
A first request
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
}
}What to use instead of the API
- Reacting to something happening — use
webhooks, not polling.
- Building your own chat frontend — use the widget's
public endpoints, which need no API key.
Where to go next
Last updated