REST API
Read your workspace's figures over plain HTTP with an API key, on the Scale plan.
The REST API is the read half of the product over HTTP: the same figures the screens show, for wiring into a warehouse, a dashboard or a script. It is on the Scale plan. On every plan, the same key works with the MCP server.
Read-only, by construction
The API serves the procedures the MCP server’s read tools call, and nothing else. Writing, billing, members and keys are not routed at all, so a key that leaks can read one workspace but cannot change it or make another key.
Authenticate
Make a key in Settings → Connect AI → API keys and send it as a bearer
token. x-api-key works too.
curl -X POST https://api.recomma.ai/v1/project/list \
-H "Authorization: Bearer recomma_YOUR_KEY" \
-H "content-type: application/json" \
-d '{}'A key belongs to one workspace and acts as the person who made it. A call
without a valid key gets 401; a workspace below Scale gets 403 with
plan_required.
Endpoints
Every endpoint is a POST with a JSON body, and its path is the procedure’s
name: /v1/overview/summary, /v1/prompt/list, /v1/source/list and so on.
The full list, with every input and output, is the OpenAPI document at
/v1/spec.json, rendered at
/v1/. Neither needs a key.
| Path | What it returns |
|---|---|
project/list | The brands in the workspace, with their ids |
overview/summary | Visibility, share of voice, win rate, position and sentiment for every tracked brand, with sample sizes |
prompt/list | The tracked questions with their figures, kind, intent and priced demand |
chat/list, chat/get, chat/export | The answers themselves, and the CSV the Chats page exports |
source/list | The domains and pages the answers cite |
action/list, action/detail | The work queue and one ticket’s evidence |
impact/series | What finished work moved |
keyword/summary, keyword/list | What the category is worth, and the keywords behind it |
referral/overview | Visits assistants sent, from your Google Analytics |