API reference UI (password-protected)
Scalar API reference for the running instance, gated by HTTP Basic Auth (DOCS_USER/DOCS_PASSWORD) — not linked from any product surface. The route is only registered at all when both env vars are set; an unconfigured deployment 404s here instead of serving it open. Served at the root, never under BASE_PATH, so the URL is the same however the service is routed.
View as MarkdownAuthorization
docsBasic Gates /docs and /docs/openapi.yaml only. Credentials come from the DOCS_USER/DOCS_PASSWORD env vars; if either is unset the routes are not registered at all (404), never served open.
In: header
Response Body
text/html
curl -X GET "https://example.com/docs""string"Liveness probe
Unauthenticated liveness check used by the platform and monitors.
This contract, served by the running instance (password-protected)
The embedded copy of this OpenAPI document — backs the reference UI above and is handy for local codegen against a running instance. Same Basic Auth gate as /docs.