Health API
The public operational surface contains two intentionally minimal endpoints:
GET /health/liveconfirms process liveness.GET /health/readyconfirms that the service is ready to receive customer traffic.
Complete executable examples belong in the AvelinLabs API examples repository.
Base URL: https://api.avelinlabs.com
Authentication
Section titled “Authentication”No authentication is required.
Liveness
Section titled “Liveness”Minimal Request
Section titled “Minimal Request”GET /health/liveMinimal Response
Section titled “Minimal Response”{ "status": "ok"}Use liveness when an external traffic manager only needs to know that the public process can answer. A successful liveness response does not assert that customer-critical dependencies are ready.
Run the Python, cURL, PowerShell, or Command Prompt example.
Readiness
Section titled “Readiness”Minimal Request
Section titled “Minimal Request”GET /health/readyMinimal Response
Section titled “Minimal Response”{ "status": "ready"}See the public example response: responses/health-ready.example.json.
Use readiness to decide whether the public API should receive governed
customer traffic. It returns 200 with status: "ready" when usable; a
customer-critical dependency failure can instead produce 503 with
status: "degraded".
Interpretation Notes
Section titled “Interpretation Notes”Liveness answers whether the public process is running. Readiness answers whether it can receive traffic. Neither endpoint replaces an authenticated product check for your own workflow or exposes dependency topology, environment names, provider identifiers, filesystem paths, calibration internals, or stack traces.