Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

The Observability module exposes a single endpoint, GET /health, for you to verify whether the API is healthy. It requires no authentication and bypasses rate limit and CORS, so external monitors can query it without credentials.

​
Endpoint

Health

GET /health, combined probe (process + DB + optional dependencies like S3 when configured).

​
How to use

Point an uptime monitor (UptimeRobot, Better Stack, Pingdom, etc.) at GET /health:
  • 200 → API healthy.
  • 503 → API degraded, fire the alert.

Rate limit & CORS

Global limits and CORS rules, /health is exempt from both.

Error types

How to interpret the HTTP codes returned by the API.