Documentation

The API reference isn’t published yet.

It exists — two OpenAPI documents and a set of guides covering authentication, scopes, errors and limits — but it is a separate site that has not been deployed. Rather than show you a link that goes nowhere, here is exactly where it is.

Run it locally

The docs live in apps/docs. Install the Mintlify CLI and start it:

npm i -g mint
cd apps/docs && mint dev

Or read the spec directly

Both OpenAPI 3.1 documents are in the repository and describe every endpoint, scope and error code:

  • apps/docs/api-reference/openapi-developer.json
  • apps/docs/api-reference/openapi-application.json

Once the site is live, set NEXT_PUBLIC_DOCS_URL and every documentation link on the site points at it.

Back