Hanzo
OpenapiVisor

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

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

GET /v1/visor/compute/bots/{id}

Addresshttps://api.hanzo.ai/v1/visor/compute/bots/{id}
MethodGET
OperationgetBot
AuthAuthorization: Bearer $HANZO_API_KEY

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.

Request

1 field.

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

Response

StatusBodyMeaning
200botViewok

200 body — 28 fields.

FieldInTypeAlwaysDescription
agentbodystringAgent is the cloud Agent this machine runs, lifted out of the binding so a list of bots reads without following one.
bindingbodyagentBinding
binding.agentNamebodystringAgentName is the cloud Agent (/v1/agents) this machine runs — the agent a message to the bot is actually run against.
binding.botVersionbodystringBotVersion pins the @hanzo/bot runtime version the machine runs.
binding.createdTimebodystringCreatedTime is when the binding was first made.
binding.machineIdbodystringMachineId is the bound machine as vm addresses it, owner-qualified ("<org>/<machine>").
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…
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.
binding.orgbodystringOrg is the Hanzo tenant the binding belongs to.
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.
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.
binding.publicIpbodystringPublicIp is the bound machine's public address as vm recorded it on the binding.
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…
binding.updatedTimebodystringUpdatedTime is when vm last reconciled it — the age of Status.
createdTimebodystring
gpubodystring
idbodystring
imagebodystring
membodystring
namebodystring
osbodystring
privateIpbodystring
providerbodystring
publicIpbodystring
regionbodystring
statusbodystring
typebodystring
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