Hanzo
OpenapiAgents

Returns every agent defined in the caller's org, each with the number of runs…

Returns every agent defined in the caller's org, each with the number of runs recorded against it.

GET /v1/agents

Addresshttps://api.hanzo.ai/v1/agents
MethodGET
Operationget_agents
AuthAuthorization: Bearer $HANZO_API_KEY

Returns every agent defined in the caller's org, each with the number of runs recorded against it.

Request

GET /v1/agents takes no parameters and no body — the credential is the whole request.

Response

StatusBodyMeaning
200agentListok

200 body — 14 fields.

FieldInTypeAlwaysDescription
agentsbodyagentView[]Agents is the org's agents, each carrying its recorded run count.
agents[].computeRefbodystringComputeRef is the visor machine this bot is bound to, opaque here: this package stores and echoes it, and the binding's lifecycle belongs elsewhere.
agents[].createdAtbodystringCreatedAt is when the agent was defined, RFC 3339 in UTC to the second.
agents[].descriptionbodystringDescription is the one line another agent reads when deciding whether to call this one: the tool catalogue publishes it as the description of agent_<name>,…
agents[].executionModebodystringExecutionMode is one-shot or long-running, and it decides who may start this agent.
agents[].idbodystringID is the agent's stable handle, minted here as "agent_" + 32 hex characters of crypto/rand.
agents[].modelbodystringModel is the Zen model this agent runs on, and it is always OUR name for it: writes normalize through cloud.ZenModel and the read normalizes again, so an…
agents[].namebodystringName is the agent's org-unique handle, matching ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$.
agents[].runsbodyintegerRuns is how many executions the org has recorded against this agent, counted at read time.
agents[].schedulebodystringSchedule is the 5-field cron the scheduler fires a long-running agent on, evaluated once a minute.
agents[].serviceAccountIdbodystringServiceAccountID is the IAM agent service account (<org>-<agent>) a scheduled run is billed AS.
agents[].statusbodystringStatus is the agent's readiness, and today it is "ready" on every row: an agent is a definition rather than a provisioned thing, so nothing transitions it.
agents[].toolsbodystring[]Tools are the tool names this agent may call, and the list IS the authority: an agent that declares none gets none.
agents[].updatedAtbodystringUpdatedAt is the last time any field above was written, same format.

Failure carries the platform error shape — see Errors.

Examples

hanzo agents list

Agents API · All Hanzo APIs · Interactive reference

How is this guide?

On this page