List health

Reports whether the e-signature surface is mounted.

GET /v1/esign/health

eSign → · All API references → · Get started →

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

Reports whether the e-signature surface is mounted.

It answers ok whenever the subsystem is mounted, takes no tenant and needs no principal. It is deliberately shallow: it is registered before the document host is built, so it still answers on a deployment that came up WITHOUT object storage and therefore serves nothing else. Read it as reachability, never as a promise that documents can be stored.

Request

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

Response

Status	Body	Meaning
`200`	esign.esignHealth	ok
`default`	problem-details	refused

200 body — 2 fields.

Field	In	Type	Always	Description
`service`	body	string	—	Service names the subsystem that answered, so a probe reading several looks the same on each.
`status`	body	string	—	Status is ok whenever the subsystem is mounted.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo esign health

.ts

.py

.go

.rs

.java

import { Configuration, EsignApi } from 'hanzoai';

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

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EsignApi(client).get_esign_health()

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

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

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

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

let result = esign_api::get_esign_health(&cfg, Default::default()).await?;

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

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

var result = new EsignApi(client).getEsignHealth();

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

Tool esign, op get_esign_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": "esign",
         "arguments": {
           "op": "get_esign_health",
           "input": {}
         }
       }
     }'

eSign API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousList documents NextGet sign