Skip to content

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.

Requires API access to be enabled for your workspace

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

What you can read

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

  1. 1
    Authentication — a workspace API key of the form blm_…, on either an

    Authorization: Bearer or an x-api-key header. → Authentication

  2. 2
    Access 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

  3. 3
    One envelope — every response is { "success": …, "data" | "error" },

    and list endpoints nest their rows at data.data. → Response envelope

  4. 4
    Cursor paginationlimit up to 200, and page until nextCursor is

    null. → Pagination

  5. 5
    Two 120-per-minute limits — one per IP, one per workspace.

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

A first request

first-request.sh

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