Hanzo
OpenapiMeet

Health reports whether the office can mint join tokens.

Health reports whether the office can mint join tokens.

GET /v1/meet/health

Addresshttps://api.hanzo.ai/v1/meet/health
MethodGET
Operationget_meet_health
AuthAuthorization: Bearer $HANZO_API_KEY

Health reports whether the office can mint join tokens.

It reports whether this deployment holds the LiveKit key pair it needs: ready:true with 200 when tokens can be minted, the SAME body with ready:false, status "degraded" and 503 when they cannot — so a probe and a dashboard both read the degraded state instead of someone grepping a boot log.

It takes no credential and is reachable on every public host, so it withholds both the reason and the signing key's name on purpose: ready is the whole dashboard fact, and the reason — which names the key file and the Secret — is written to the boot log where an operator already is.

Request

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

Response

StatusBodyMeaning
200meetHealthok
503meetHealthservice unavailable

200 body — 3 fields.

FieldInTypeAlwaysDescription
readybodybooleanReady reports whether this deployment can mint join tokens.
servicebodystringService names the subsystem answering — always "meet".
statusbodystringStatus is "ok" when tokens can be minted and "degraded" when they cannot.

Failure carries the platform error shape — see Errors.

Examples

hanzo meet health

Meet API · All Hanzo APIs · Interactive reference

How is this guide?

On this page