List schema

Returns the two JSON Schema documents this surface speaks: entitlements.schema.json, which declares every entitlement key with its type, unit and enum, and plan.schema.json, which a catalog plan record conforms to.

GET /v1/plan/schema

Plan → · All API references → · Get started →

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

Request

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

Response

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

200 body — 2 fields.

Field	In	Type	Always	Description
`entitlements`	body	any	—	Entitlements is entitlements.schema.json — the JSON Schema every entitlement key is declared in, including its type, unit and enum.
`plan`	body	any	—	Plan is plan.schema.json — the JSON Schema a catalog plan record conforms to.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo plan schema

.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.getPlanSchema();

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_schema()

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

resp, _, err := client.PlanAPI.GetPlanSchema(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_schema(&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).getPlanSchema();

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

Tool plan, op get_plan_schema — 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_schema",
           "input": {}
         }
       }
     }'

Plan API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet resolve NextList storage