System Reference

Health and service metadata.

Base URL

OpenAPI Specification

The whole API as one OpenAPI 3.0.3 document. Import it into Postman or Insomnia, or generate a client from it.

Response Envelope

All API responses use a consistent envelope structure:

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "..."
  }
}