OpenapiDataroom
List health
Health reports that the data room subsystem is up.
GET /v1/dataroom/health
| Address | https://api.hanzo.ai/v1/dataroom/health |
| Method | GET |
| Operation | get_dataroom_health |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Health reports that the data room subsystem is up.
It answers before the bundle loads, holds no state and touches no store, so it stays true in exactly the situation an operator is probing for. It says nothing about whether a room can be OPENED — that is what the room operations answer — because a liveness probe that fails on a dependency takes a working process out of rotation.
Request
GET /v1/dataroom/health takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | dataroomLiveness | ok |
200 body — 2 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
service | body | string | — | Service names the subsystem answering, so a probe response is attributable when several are collected together. |
status | body | string | — | Status is ok. |
Failure carries the platform error shape — see Errors.
Examples
hanzo dataroom healthimport { Configuration, DataroomApi } from 'hanzoai';
const api = new DataroomApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDataroomHealth();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import DataroomApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DataroomApi(client).get_dataroom_health()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.DataroomAPI.GetDataroomHealth(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, dataroom_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = dataroom_api::get_dataroom_health(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.DataroomApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new DataroomApi(client).getDataroomHealth();curl https://api.hanzo.ai/v1/dataroom/health \
-H "Authorization: Bearer $HANZO_API_KEY"Tool dataroom, op get_dataroom_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": "dataroom",
"arguments": {
"op": "get_dataroom_health",
"input": {}
}
}
}'How is this guide?