Hanzo
API Reference

Hanzo Visor API

Hanzo Cloud COMPUTE surface — the tenant's machines, GPUs, DOKS clusters and

Hanzo Cloud COMPUTE surface — the tenant's machines, GPUs, DOKS clusters and

Base URLhttps://api.hanzo.ai
Version1.0.0
Operations21
GuideHanzo Visor API guide

Authentication

  • bearerAuth — HTTP bearer

All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.

curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai

Endpoints

Bindings

MethodEndpointDescription
POST/v1/machines/{id}/bind-agentBind a cloud Agent to a machine
GET/v1/machines/{id}/agent-bindingGet a machine's agent binding
DELETE/v1/machines/{id}/agent-bindingUnbind the agent from a machine
GET/v1/agent-bindingsList the org's agent bindings

Bots

MethodEndpointDescription
GET/v1/compute/botsList the org's bot machines
POST/v1/compute/bots/launchLaunch a bot (machine + agent binding), or dryRun for a quote
GET/v1/compute/bots/{id}Get one bot machine by id
DELETE/v1/compute/bots/{id}Terminate a bot (unbind agent + delete machine)
POST/v1/compute/bots/{id}/{action}Act on a bot (stop, pause, or message)

Catalog

MethodEndpointDescription
GET/v1/compute/regionsList the global compute region catalog
GET/v1/compute/sizesList the global compute size catalog

Clusters

MethodEndpointDescription
GET/v1/clustersList DOKS clusters (projected from node pools)
POST/v1/clusters/{clusterId}/poolsAdd a node pool to a cluster
POST/v1/clusters/{clusterId}/pools/{poolId}/scaleScale a node pool
DELETE/v1/clusters/{clusterId}/pools/{poolId}Delete a node pool

GPUs

MethodEndpointDescription
GET/v1/gpusList per-accelerator GPU inventory (derived from GPU machines)
GET/v1/gpus/alertsList GPU alerts (honest empty — Visor carries no alert inventory)

Machines

MethodEndpointDescription
GET/v1/machinesList the org's machines
POST/v1/machinesLaunch a machine (or dryRun for a price quote)
GET/v1/machines/{id}Get one machine by org-scoped name
DELETE/v1/machines/{id}Terminate a machine

Hanzo Visor API guide · All Hanzo APIs · OpenAPI spec

How is this guide?

On this page