API schema

Cloud publishes its OpenAPI schema without authentication. Import it into an API client or use it to generate bindings. The schema describes the running Cloud version; admin routes and webhooks are excluded.

From the Cloud repository, compile and serve the reference locally:

cargo run -p cloud -- docs

Open the printed localhost URL. The command reads no Cloud configuration and connects to no database. The viewer loads Scalar from jsDelivr. Use --port 0 to select an available port or --server http://localhost:5252 to point request examples at a local API.

To export the checked-out version's schema without serving it:

cargo run -p cloud -- openapi --out openapi.json