API reference

Eloqra exposes a small REST API for provisioning accounts and managing projects programmatically — handy for AI agents and scripted setups. All endpoints live under the /v1 base and return a JSON envelope.

Base URL#

https://api.eloqra.app/v1

Every successful response is wrapped in an envelope with a message and a data payload:

{
  "message": "Success",
  "data": { }
}

Authentication#

Authenticated endpoints require two headers: your account ID and an API key. You'll find both in the dashboard under Settings → API.

1

2

3

x-eloqra-account-id: YOUR_ACCOUNT_ID
x-api-key: YOUR_API_KEY

Requests missing either header, or with an invalid key, return 401 Unauthorized. The one exception is agent-init below, which is public so an agent can create an account before any key exists.

Regenerating your API key#

An account has one API key at a time. Eloqra stores only a hash of it, so the full key is shown once — when it is created — and after that Settings → API shows just its last four characters, when it was created and when it was last used.

If you lose the key or think it has leaked, press Regenerate API key in Settings → API (it reads Generate API key if you don't have one yet). A new key is issued and shown in full; copy it before leaving the page. The old key stops working immediately, so any script or agent still using it gets 401 Unauthorized until you give it the new one. Your account ID doesn't change.

More on managing keys alongside the rest of your account is in Account & billing.

curl -X POST https://api.eloqra.app/v1/auth/agent-init \
  -H "Content-Type: application/json" \
  -d '{ "email": "you@example.com" }'

{
  "message": "Success",
  "data": {
    "accountId": "...",
    "apiKey": "...",
    "claimRequired": true,
    "expiresInDays": 3
  }
}

{
  "message": "Success",
  "data": {
    "claimRequired": false,
    "accountExists": true,
    "message": "Account already exists. Paste your API key from Settings → API to continue."
  }
}

{
  "message": "Success",
  "data": { "accountId": "...", "email": "you@example.com" }
}

{
  "message": "Success",
  "data": {
    "projectId": "...",
    "widgetUrl": "https://chat.eloqra.app/eloqra-chat.js",
    "script": "<script> ... </script>"
  }
}