List health

Reports that the legal subsystem is serving and how many built-in templates its catalog carries.

GET /v1/legal/health

Addresshttps://api.hanzo.ai/v1/legal/health
MethodGET
Operationget_legal_health
AuthAuthorization: Bearer $HANZO_API_KEY

Reports that the legal subsystem is serving and how many built-in templates its catalog carries. It reads no tenant, so a liveness prober that sends no principal is answered rather than refused.

Request

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

Response

StatusBodyMeaning
200legal.legalHealthok
defaultproblem-detailsrefused

200 body — 2 fields.

FieldInTypeAlwaysDescription
statusbodystring—Status is "ok" when the subsystem is serving.
templatesbodyinteger (int64)—Templates is how many built-in templates the catalog carries.

Failure carries the platform error shape — see Errors.

Examples

hanzo legal health
import { Configuration, LegalApi } from 'hanzoai';

const api = new LegalApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getLegalHealth();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import LegalApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = LegalApi(client).get_legal_health()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.LegalAPI.GetLegalHealth(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, legal_api};

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

let result = legal_api::get_legal_health(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.LegalApi;

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

var result = new LegalApi(client).getLegalHealth();
curl https://api.hanzo.ai/v1/legal/health \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool legal, op get_legal_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": "legal",
         "arguments": {
           "op": "get_legal_health",
           "input": {}
         }
       }
     }'

Legal API · All Hanzo APIs · Interactive reference

Was this page useful?