Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cloudwaddie/lmarenabridge/llms.txt

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

The /api/v1/health endpoint reports whether the bridge is ready to serve requests. It checks three internal conditions and rolls them up into a single status string. Use this endpoint for uptime monitoring, load-balancer health probes, or quick diagnostics.

​
GET /api/v1/health

Authentication: None required. The endpoint is always accessible.

​
Example request

cURL
curl http://localhost:8000/api/v1/health

​
Example responses

{
  "status": "healthy",
  "timestamp": "2026-05-10T12:00:00.000000+00:00",
  "checks": {
    "cf_clearance": true,
    "models_loaded": true,
    "model_count": 42,
    "api_keys_configured": true
  }
}

​
Response fields

​
status
string
Overall bridge status. One of:
  • "healthy" — Cloudflare clearance cookie is present and at least one model has been loaded.
  • "degraded" — One of the above conditions is not met, but the bridge is still running.
  • "unhealthy" — An exception occurred while reading the config or model list.
​
timestamp
string
ISO 8601 UTC timestamp of when the health check ran.
​
checks
object
Present when status is "healthy" or "degraded".
​
error
string
Present only when status is "unhealthy". Contains the exception message.

​
HTTP status codes

StatusMeaning
200The endpoint responded. Inspect status in the body to determine actual health — 200 is returned for "healthy", "degraded", and "unhealthy" alike.
The endpoint always returns HTTP 200. Your monitoring tool should check the status field in the response body rather than relying on the HTTP status code alone.

Build docs developers (and LLMs) love

Get started for freeTalk to us