Breezy Public API
The Breezy Public API is the curated customer-facing subset of the backend/api/v1 surface. It is generated from the typed public API registry, not from
the full internal router.
Start Here
- Authentication
- API Keys
- Principal Types
- Pagination And Filtering
- Errors
- Rate And Safety Expectations
- Workflow Examples
- Use the API Reference section in the navigation for generated endpoint docs.
Contract Source
The generated reference consumes/openapi.public.json, which excludes admin,
staff-only, widget, webhook, dev-auth, and dev/test-harness procedures unless a
procedure is explicitly allowlisted for public documentation.
See: packages/backend/src/orpc/public-api-surface.ts
Public Vs Internal
/openapi.json remains the full app/router contract. Customer docs and external
tooling should use /openapi.public.json.