Hanzo
OpenapiVisor

Returns the caller org's bot machines — the kind=bot machines — each joined…

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/visor/compute/bots

Addresshttps://api.hanzo.ai/v1/visor/compute/bots
MethodGET
OperationlistBots
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

GET /v1/visor/compute/bots takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200botListok

200 body — 29 fields.

FieldInTypeAlwaysDescription
botsbodybotView[]Bots is one row per kind=bot machine, each joined with its agent binding when it has one.
bots[].agentbodystringAgent is the cloud Agent this machine runs, lifted out of the binding so a list of bots reads without following one.
bots[].bindingbodyagentBinding
bots[].binding.agentNamebodystringAgentName is the cloud Agent (/v1/agents) this machine runs — the agent a message to the bot is actually run against.
bots[].binding.botVersionbodystringBotVersion pins the @hanzo/bot runtime version the machine runs.
bots[].binding.createdTimebodystringCreatedTime is when the binding was first made.
bots[].binding.machineIdbodystringMachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>").
bots[].binding.messagebodystringMessage is vm's human-readable detail on Status ("machine provisioning; @hanzo/bot runtime not yet confirmed") — the reason behind the state, not a second…
bots[].binding.namebodystringName is the binding's own key, which is the machine's id: a machine hosts at most one agent, so the binding is named for it.
bots[].binding.orgbodystringOrg is the Hanzo tenant the binding belongs to.
bots[].binding.ownerbodystringOwner is the tenant vm filed the binding under, resolved from the ?owner it was called with — which is the caller's validated org and never a body field.
bots[].binding.providerbodystringProvider is the cloud the bound machine runs on, carried here so a bindings list says where each bot lives without a second read per machine.
bots[].binding.publicIpbodystringPublicIp is the bound machine's public address as vm recorded it on the binding.
bots[].binding.statusbodystringStatus is the binding's lifecycle in VM's OWN words — "Pending" while the machine provisions and the runtime is unconfirmed, "running" once vm has confirmed…
bots[].binding.updatedTimebodystringUpdatedTime is when vm last reconciled it — the age of Status.
bots[].createdTimebodystring
bots[].gpubodystring
bots[].idbodystring
bots[].imagebodystring
bots[].membodystring
bots[].namebodystring
bots[].osbodystring
bots[].privateIpbodystring
bots[].providerbodystring
bots[].publicIpbodystring
bots[].regionbodystring
bots[].statusbodystring
bots[].typebodystring
bots[].vcpubodyinteger

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Visor API · All Hanzo APIs · Interactive reference

How is this guide?

On this page