Skip to main content
These four routes need no API key and are not rate-limited.

GET /v1/health

200 whenever the API process is up:

GET /v1/ready

200 when every dependency the API needs is reachable, 503 otherwise. The body lists a status per check:
Each check’s status is ok, degraded or fail. Use /v1/ready for an external monitor; use /v1/health for plain liveness.

GET /v1/openapi.json and GET /v1/docs

The spec is generated from the same schemas the API validates with, so it always matches the deployed API. It includes the webhook payloads under the OpenAPI webhooks section. Both are served with Cache-Control: public, max-age=60, stale-while-revalidate=300.