---
title: "Health check"
method: GET
path: "/health"
tags: ["Health"]
---

# Health check

`GET /health`

## Request

- Base URL: `https://orchestrator.getaxonflow.com`
- URL: `https://orchestrator.getaxonflow.com/health`
- Auth: none declared
- TypeScript: <https://skmtc.dev/getaxonflow/apis/axonflow-orchestrator-api/docs/health/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns service health status including component health:
- Policy Engine
- LLM Router
- Response Processor
- Audit Logger
- Workflow Engine
- Planning Engine (MAP)
- Result Aggregator (MAP)

## Response `200`

Service health status

- HealthResponse: Besides the component booleans, the health body always carries the platform capability list (`capabilities`), the per-language SDK version pins (`sdk_compatibility`) and the per-plugin version pins (`plugin_compatibility`). The pin maps are additionalProperties-style maps keyed by SDK language / canonical plugin id; the exact key sets evolve per release and are not enumerated here.
  - `status` 'healthy' | 'starting' | 'unhealthy'
  - `service` string
  - `version` string: Platform version, preferring the value baked into the binary at build time and falling back to AXONFLOW_VERSION for dev builds
  - `timestamp` string, date-time
  - `capabilities` PlatformCapability[]: List of platform capabilities with the version that introduced them
    - `name` string: Capability identifier
    - `since` string: Platform version that introduced this capability
    - `description` string: Human-readable description
  - `sdk_compatibility` SDKCompatInfo
    - `min_sdk_version` object: Minimum SDK version compatible with this platform, keyed by SDK language (e.g. go, python, typescript, java, rust)
    - `recommended_sdk_version` object: Recommended SDK version for full feature coverage, keyed by SDK language
  - `plugin_compatibility` PluginCompatInfo: Plugin version pins, mirroring SDKCompatInfo. Keys are the canonical plugin ids (openclaw, claude-code, cursor, codex, claude-desktop, n8n, google-adk). Versions below the minimum receive a downgrade-warning header on every governed call.
    - `min_plugin_version` object: Per-plugin minimum version compatible with this platform.
    - `recommended_plugin_version` object: Per-plugin version this platform was tested against.
  - `components` object
    - `policy_engine` boolean
    - `llm_router` boolean
    - `response_processor` boolean
    - `audit_logger` boolean
    - `workflow_engine` boolean
    - `planning_engine` boolean
    - `result_aggregator` boolean
  - `features` object
    - `multi_agent_planning` boolean

---

[API](https://skmtc.dev/getaxonflow/apis/axonflow-orchestrator-api.md) - [All operations](https://skmtc.dev/getaxonflow/apis/axonflow-orchestrator-api/llms.txt) - [OpenAPI document](https://skmtc.dev/getaxonflow/apis/axonflow-orchestrator-api/revisions/f408ef3ec9dd?raw)