Health API
GET /health/ready
Use this endpoint for public readiness checks.
Complete executable examples belong in the AvelinLabs API examples repository.
Base URL: https://api.avelinlabs.com
Authentication
Section titled “Authentication”No authentication is required.
Minimal Request
Section titled “Minimal Request”GET /health/readyMinimal Response
Section titled “Minimal Response”Illustrative beta response snippet:
{ "status": "ready"}See the public example response: responses/health-ready.example.json.
Response Field: status
Section titled “Response Field: status”Meaning: Readiness state, for example ready.
Interpretation Notes
Section titled “Interpretation Notes”The readiness response is intentionally minimal. It should be used to determine whether the public service is ready to receive traffic.
Readiness does not replace authenticated product endpoint checks for your own application workflow. For API errors from product endpoints, see standard error responses.