The dashboard is a client of this API; anything it shows, you can fetch. Base path /api. Authenticate
with an API key: Authorization: Bearer ca_…. All responses are JSON.
| Method |
Path |
Notes |
POST |
/estimate |
{ url?, kind?, pages, render?, llm? } → the allowance the run consumes and what is left, requests, crawl minutes, plan page limit |
POST |
/workflows |
{ url, maxPages?, render?, llm?, kind? } → starts a run; 402 when the plan’s site or run allowance is used up; 403 when the domain is not verified |
GET |
/workflows |
Runs in this workspace, newest first |
GET |
/workflows/:id |
Status, steps with progress, headline numbers |
GET |
/usage |
Plan, per-site allowance used this month, runs this month |
GET |
/workflows/:id/events |
Server-sent events: state while running, done at the end |
POST |
/workflows/:id/resume |
{ from?, only? } — resume, or re-run from a named step |
GET |
/workflows/:id/report |
The standalone HTML report; ?download=1 for a file |
| Path |
Returns |
/workflows/:id/findings |
Findings, most severe first, including review verdicts |
/workflows/:id/perspectives |
Template × identity matrix: served, blocked, challenged, other |
/workflows/:id/templates |
Templates with word counts, JS ratio, timings, structured-data coverage |
/workflows/:id/intents |
Intents with coverage verdicts and retrieved pages |
/workflows/:id/simulations/:intentId |
One simulation: answer, verdict, retrieved passages |
/workflows/:id/entities · /claims |
The knowledge graph |
/workflows/:id/pages · /pages/:pageId |
Page inventory and per-page detail |
/workflows/:id/analyses |
Synthesis, site profile, review summary |
| Path |
Returns |
/portfolio |
One row per site: latest run, critical/high counts, AI-blocked pages, coverage, new and resolved findings |
/findings |
Inbox across the latest run of every site; filter with severity, category, status, siteId |
/sites/:id/history |
Runs for one site with per-run finding deltas |
| Method |
Path |
Notes |
GET / PATCH |
/org |
Name, branding, settings (admin to change) |
GET |
/org/members · POST /org/invites |
Members and invites (admin) |
GET / POST / DELETE |
/org/api-keys |
API keys (admin) |
POST |
/sites · POST /sites/:id/verify |
Add a domain; run the ownership check |
PATCH |
/findings/:id |
{ status } — the finding lifecycle |
GET |
/usage · /quote |
Metered usage this month; subscription quote at the current site count |
GET |
/kb |
The knowledge base |
Errors are { "error": "…" } with a conventional status code. Rate limiting and pagination are not yet
applied; large result sets are capped at 500 rows.