AxonFlow · Schema

HealthResponse

CompanyAI GovernanceAI AgentsPolicy EnforcementAudit LoggingComplianceMCPOpen Source

Properties

Name Type Description
status string Service health status (the handler emits only these two)
service string
timestamp string
version string Platform version from AXONFLOW_VERSION env var
tier string License tier of the deployment (e.g. community, evaluation, enterprise)
capabilities array List of platform capabilities with the version that introduced them
sdk_compatibility object
plugin_compatibility object
upstream object Whether the orchestrator has answered this agent since the process started (#4249 row 5681489141): `reached` from its first HTTP response of any status, `unreached` before. Until it is reached, a conn
View JSON Schema on GitHub

JSON Schema

axonflow-health-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/axonflow/json-schema/axonflow-health-response-schema.json",
  "title": "HealthResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/axonflow-health-api-openapi.yml#/components/schemas/HealthResponse",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "healthy",
        "starting"
      ],
      "description": "Service health status (the handler emits only these two)"
    },
    "service": {
      "type": "string"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "version": {
      "type": "string",
      "description": "Platform version from AXONFLOW_VERSION env var"
    },
    "tier": {
      "type": "string",
      "description": "License tier of the deployment (e.g. community, evaluation, enterprise)"
    },
    "capabilities": {
      "type": "array",
      "description": "List of platform capabilities with the version that introduced them",
      "items": {
        "$ref": "#/$defs/PlatformCapability"
      }
    },
    "sdk_compatibility": {
      "$ref": "#/$defs/SDKCompatInfo"
    },
    "plugin_compatibility": {
      "$ref": "#/$defs/PluginCompatInfo"
    },
    "upstream": {
      "type": "object",
      "description": "Whether the orchestrator has answered this agent since the\nprocess started (#4249 row 5681489141): `reached` from its first\nHTTP response of any status, `unreached` before. Until it is\nreached, a connection the orchestrator refuses is not counted\nagainst the client's circuit breaker. Informational only:\n`status` and the HTTP code do not read it.\n",
      "properties": {
        "orchestrator": {
          "type": "string",
          "enum": [
            "reached",
            "unreached"
          ]
        }
      }
    }
  },
  "$defs": {
    "PlatformCapability": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Capability identifier"
        },
        "since": {
          "type": "string",
          "description": "Platform version that introduced this capability"
        },
        "description": {
          "type": "string",
          "description": "Human-readable description"
        }
      }
    },
    "PluginCompatInfo": {
      "type": "object",
      "description": "Plugin version compatibility information. Mirrors `SDKCompatInfo`\nfor the seven AxonFlow clients (`openclaw`, `claude-code`,\n`cursor`, `codex`, `claude-desktop`, `n8n`, `google-adk`). The first\nfour read this from\n`/health` and warn when their runtime version is below\n`min_plugin_version[<their id>]`. Keys match the canonical plugin\nIDs the agent tracks in\n`integration_activation.go::knownIntegrations`.\n\nThe examples below are the values this platform actually serves.\nThey are not illustrative: a regression test compares them against\nplatform/shared/plugincompat, the single source of truth both\n/health planes read, so a stale example fails CI rather than\nmisleading a reader.\n",
      "properties": {
        "min_plugin_version": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Per-plugin minimum version compatible with this platform."
        },
        "recommended_plugin_version": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Per-plugin version this platform was tested against."
        }
      }
    },
    "SDKCompatInfo": {
      "type": "object",
      "description": "SDK version compatibility information. Each key in the maps below\nis one of `python` / `typescript` / `go` / `java` / `rust`. SDKs\nthat find their own runtime version below\n`min_sdk_version[<their lang>]` log a one-time upgrade warning;\nbelow `recommended_sdk_version` is informational only.\n\nThe examples below are the values this platform actually serves.\nThey are not illustrative: a regression test compares them against\nplatform/shared/sdkcompat, the single source of truth both /health\nplanes read, so a stale example fails CI rather than misleading a\nreader.\n",
      "properties": {
        "min_sdk_version": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Per-language minimum SDK version compatible with this\nplatform. Pre-v4.8.0 platforms returned a bare string; SDKs\nv6.0.0+ accept either shape.\n"
        },
        "recommended_sdk_version": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Per-language SDK version this platform was tested against."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/axonflow-health-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.