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
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
| Method | Endpoint | Description |
|---|
POST | /v1/machines/{id}/bind-agent | Bind a cloud Agent to a machine |
GET | /v1/machines/{id}/agent-binding | Get a machine's agent binding |
DELETE | /v1/machines/{id}/agent-binding | Unbind the agent from a machine |
GET | /v1/agent-bindings | List the org's agent bindings |
| Method | Endpoint | Description |
|---|
GET | /v1/compute/bots | List the org's bot machines |
POST | /v1/compute/bots/launch | Launch 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) |
| Method | Endpoint | Description |
|---|
GET | /v1/compute/regions | List the global compute region catalog |
GET | /v1/compute/sizes | List the global compute size catalog |
| Method | Endpoint | Description |
|---|
GET | /v1/clusters | List DOKS clusters (projected from node pools) |
POST | /v1/clusters/{clusterId}/pools | Add a node pool to a cluster |
POST | /v1/clusters/{clusterId}/pools/{poolId}/scale | Scale a node pool |
DELETE | /v1/clusters/{clusterId}/pools/{poolId} | Delete a node pool |
| Method | Endpoint | Description |
|---|
GET | /v1/gpus | List per-accelerator GPU inventory (derived from GPU machines) |
GET | /v1/gpus/alerts | List GPU alerts (honest empty — Visor carries no alert inventory) |
| Method | Endpoint | Description |
|---|
GET | /v1/machines | List the org's machines |
POST | /v1/machines | Launch 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?