List health

Reports that the plans subsystem is mounted and serving.

GET /v1/plan/health

Plan → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/plan/health`
Method	`GET`
Operation	`get_plan_health`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Reports that the plans subsystem is mounted and serving. It answers from the process itself and consults neither the catalog bundle nor the goja host, so it stays "ok" while either is degraded.

Request

GET /v1/plan/health takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	plan.planHealth	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`service`	body	string	—	Service names the subsystem that answered.
`status`	body	string	—	Status is "ok" whenever this subsystem is mounted.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo plan health

.ts

.py

.go

.rs

.java

import { Configuration, PlanApi } from 'hanzoai';

const api = new PlanApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPlanHealth();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PlanApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PlanApi(client).get_plan_health()

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PlanAPI.GetPlanHealth(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, plan_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = plan_api::get_plan_health(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PlanApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PlanApi(client).getPlanHealth();

curl https://api.hanzo.ai/v1/plan/health \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool plan, op get_plan_health — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "plan",
         "arguments": {
           "op": "get_plan_health",
           "input": {}
         }
       }
     }'

Plan API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList gpu NextList policy