Legacy mock API

The earlier in-browser mock API, kept for reference. The live API is in the Guide.

This is not the live API. This page documents an earlier, in-browser mock API (routes like /accounts, /messaging and /brand), kept for reference. The real, read-only API that runs today is described in The API.

Legacy mock API

Every page under Endpoints is generated from openapi.json — itself exported from the mock (pnpm --filter web openapi:export) — so the documented contract cannot drift from the implementation. Each endpoint renders its parameters, request/response schemas, and error responses with a Scalar try-it console.

  • API keys — list, create (secret shown once), revoke.
  • Errors — the human guide to the error vocabulary: what each code means and what to do.
  • API keys & auth — creating keys, bearer auth, revoking.

Try it live

The try-it consoles execute against the mock server, not the docs site:

pnpm --filter web mock:server

The server boots the same mock apps the dashboard uses, with fresh seeds — writes never persist past a restart. Requests go to the spec's servers entry (http://localhost:5174); without the server running, sends fail and the reference still reads fine.