API reference

These pages are generated from the API's OpenAPI document by npm run docs:sync, so they match the code. Each page shows:

• the method and path;
• the parameters and the request body;
• example requests in several languages;
• the responses with example bodies.

Each page also states what an API key needs to call it:

• a scope;
• any key, whatever its scopes;
• no key at all (the route has its own authentication);
• or "not available to API keys": only a signed-in person can call the route.

Calling the API

curl "$ZEROREACH_URL/api/v1/leads" \
  -H "Authorization: Bearer $ZEROREACH_API_KEY"

• Base URL: your ZeroReach host; http://localhost:8000 locally.
• Auth: Authorization: Bearer ro_pat_.... See Authentication.
• X-Workspace-Id: listed as a header on most routes. API keys imply their workspace, so you can leave it out; the web app's session tokens send it.
• Errors: {"detail": ...}. See Errors and limits.
• Pagination: limit and cursor → next_cursor. See API basics.

The machine-readable schema is served at GET /api/v1/openapi.json on your host.