API Reference

GET /v1/health

Check the health status of the Rueda Lens API.

Returns the current health status of the API. This endpoint performs lightweight checks to verify the API is operational.

Endpoint

GET https://api.ruedalens.com/v1/health

Authentication

None required. This is a public endpoint.

Request

curl https://api.ruedalens.com/v1/health

Response

Healthy — `200 OK`

{
  "status": "healthy",
  "version": "1.0.0",
  "timestamp": "2026-02-08T12:00:00.000Z"
}

Unhealthy — `503 Service Unavailable`

{
  "status": "unhealthy",
  "version": "1.0.0",
  "timestamp": "2026-02-08T12:00:00.000Z"
}

Response Fields

Field	Type	Description
`status`	`string`	Either `"healthy"` or `"unhealthy"`
`version`	`string`	Current API version
`timestamp`	`string`	ISO 8601 timestamp of the health check

Use Cases

Monitoring

# Check health status every 60 seconds
*/1 * * * * curl -sf https://api.ruedalens.com/v1/health || echo "API is down"

Pre-flight Check

async function isApiAvailable() {
  try {
    const res = await fetch('https://api.ruedalens.com/v1/health');
    const data = await res.json();
    return res.ok && data.status === 'healthy';
  } catch (error) {
    return false;
  }
}

Notes

This endpoint does not consume your API quota
Typical response time: < 500ms
Returns 200 OK when all systems are operational
Returns 503 Service Unavailable when critical dependencies are down