Hanzo

Compute

Compute — 7 operations on https://api.hanzo.ai.

The REST reference for Compute — 7 operations, generated from the OpenAPI document.

Base URLhttps://api.hanzo.ai
Operations7
AuthAuthorization: Bearer $HANZO_API_KEY

compute

post_v1_compute_bots_by_id_by_action

POST /v1/compute/bots/{id}/{action}

ParameterInTypeRequiredDescription
idpathstringyes
actionpathstringyes

Returns one of the caller org's bot machines with its agent binding.

GET /v1/compute/bots/{id}

Returns one of the caller org's bot machines with its agent binding.

A machine counts as a Bot if it carries the hanzo-kind:bot tag OR has an agent binding — either signal is authoritative, so a bot resolves even before its cloud-init has stamped every tag. A machine that is neither is 404: this route answers for bots, not for machines.

ParameterInTypeRequiredDescription
idpathstringyesID is the bot machine's id — the same id the machines surface addresses it by.

Tears down both halves of a bot: it unbinds the agent (best-effort — a bot with no binding still deletes), then terminates the machine.

DELETE /v1/compute/bots/{id}

Tears down both halves of a bot: it unbinds the agent (best-effort — a bot with no binding still deletes), then terminates the machine. Answers 204.

ParameterInTypeRequiredDescription
idpathstringyesID is the bot machine's id — the same id the machines surface addresses it by.

post_v1_compute_bots_launch

POST /v1/compute/bots/launch

Returns the caller org's bot machines — the kind=bot machines — each joined with the agent binding that says which cloud Agent it runs.

GET /v1/compute/bots

Returns the caller org's bot machines — the kind=bot machines — each joined with the agent binding that says which cloud Agent it runs.

The bindings are read ONCE and joined by machine id, so the list is O(1) upstream calls, not N+1. A bindings read that fails only costs the reconciled status: a bot still lists without it.

List the global compute region catalog

GET /v1/compute/regions

List the global compute size catalog

GET /v1/compute/sizes


All Hanzo APIs · Interactive reference

How is this guide?

On this page