Skip to main content
GET
/
health
{
  "status": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt

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

Your Implementation Required

This endpoint must be implemented on your server
Enginy calls this endpoint to validate the connection during setup and for periodic health checks.

Request

No request body required. Enginy will send the API key in the configured header.
bash GET /health X-API-Key: your-api-key

Response

Return any 2xx status code to indicate your API is healthy.
status
string
Status indicator (e.g., “ok”)
{
  "status": "ok"
}

Error Responses

StatusWhen to Return
200API is healthy
401Invalid or missing API key
500Server error
Return 401 Unauthorized if the API key is invalid or missing.