Health Check API

Health routes provide service liveness information.

API call order

GET /health can be called any time (no auth/token prerequisite).

Shared request setup is documented once in API index.

Health check

GET /health

Liveness probe endpoint.

Returns:

Name	Type	Description
dict		Static status payload indicating service health.

Usage

resp = requests.get(
    f"{BASE_URL}/health",
    timeout=10,
)
resp.raise_for_status()
print(resp.json())

Explanation

Returns a simple status payload for liveness checks.

Notes

• Commonly used by load balancers and uptime monitors.
• Does not require authentication.

Full API reference

For exhaustive schema details, use Swagger API.