Health API Endpoints

The Health API exposes a small set of operational endpoints for checking system status.

Authentication

All health endpoints require admin authentication.

Authorization: Bearer <your-jwt-token>

Endpoints

GET /api/v1/health/basic

Quick infrastructure check.

• database connectivity
• Redis connectivity
• overall status

GET /api/v1/health/pipeline

Detailed pipeline diagnostics.

• pipeline component status
• success rate
• recommendations

GET /api/v1/health/system

Combined overview of basic and pipeline health.

GET /api/v1/health/status

Lightweight status check for quick polling.

Status Values

• healthy
• degraded
• unhealthy
• critical
• error

Error Handling

Typical responses include:

• 200 OK for successful checks
• 401 Unauthorized for missing or invalid auth
• 403 Forbidden for insufficient privileges
• 500 Internal Server Error for health check failures

Related

• API Authentication