Miscellaneous

Endpoints without tags (e.g., health checks and operational utilities).

Health check

`GET /health`

Health check endpoint used to verify the API is running and reachable. This is commonly used by load balancers, uptime monitors, and Kubernetes readiness/liveness probes.

Operation ID: healthCheck

Authentication

No authentication requirements are documented for this endpoint.

If your deployment requires authentication globally, see Authentication for how to send the X-API-Key header.

Parameters

This endpoint does not accept path, query, or header parameters.

Name In Type Required Description
— — — — No parameters

Request body

No request body.

Responses

Status Description
200 OK

Example request (curl)

curl -i \
  -X GET "{BASE_URL}/health"

Example response

HTTP/1.1 200 OK
  • Overview (base URL and getting started)
  • Authentication (if your environment enforces API keys)
  • Errors (common error formats and troubleshooting)