Hanzo
OpenapiLegal

Reports that the legal subsystem is serving and how many built-in templates its…

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
200legalHealthok

200 body — 2 fields.

FieldInTypeAlwaysDescription
statusbodystringStatus is "ok" when the subsystem is serving.
templatesbodyintegerTemplates is how many built-in templates the catalog carries.

Failure carries the platform error shape — see Errors.

Examples

hanzo legal health

Legal API · All Hanzo APIs · Interactive reference

How is this guide?

On this page