GET /v1/health/deep · API Reference

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope. data contains DeepHealthCheckOut.

Envelope

dataDeepHealthCheckOut

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

DeepHealthCheckOut

statusstring

Overall service status: 'ok' or 'degraded'.

checksobject

Individual subsystem statuses (e.g. {'database': 'ok', 'cache': 'ok'}).

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.

RequestcURL

curl "https://api.axiora.dev/v1/health/deep" \
  -H "Authorization: Bearer ax_live_…"

Response · 200

200 OK

{
  "data": {
    "status": "…",
    "checks": "…"
  },
  "meta": {
    "request_id": "req_abc123",
    "data_as_of": "2026-05-12T03:25:11Z",
    "ontology_version": "2.1.0",
    "as_of": "frz_01HRX9KQ2T8N7P4M"
  }
}

Response · 401

401 UNAUTHORIZED

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid API key. Pass it as `Authorization: Bearer ax_live_…`."
  }
}