Skip to content
Stratum

OpenAPI specification

The complete REST API surface is described by an OpenAPI 3 specification. The source of truth lives in the repository at docs/api/openapi.yml and is published with this site:

Point any OpenAPI tooling at it — Swagger UI, Redoc, Postman/Insomnia imports, or client generators such as openapi-generator and openapi-typescript.

Terminal window
# Generate TypeScript types for the API
npx openapi-typescript https://docs.usestratum.dev/openapi.yml -o stratum-api.d.ts