OpenapiAgents
Returns one agent with its system prompt and its 20 most recent runs.
Returns one agent with its system prompt and its 20 most recent runs.
GET /v1/agents/{ref}
| Address | https://api.hanzo.ai/v1/agents/{ref} |
| Method | GET |
| Operation | get_agents_by_ref |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one agent with its system prompt and its 20 most recent runs. The ref is the agent's public id or its org-unique name — a created agent is immediately gettable by whatever create handed back.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
ref | path | string | yes | Ref is the agent's public id (the agent_… handle create and list return) or its org-unique name, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | agentDetail | ok |
200 body — 29 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
computeRef | body | string | — | |
createdAt | body | string | — | |
description | body | string | — | |
executionMode | body | string | — | |
id | body | string | — | |
instructions | body | string | — | Instructions is the agent's system prompt, verbatim, up to 32 KiB. |
model | body | string | — | |
name | body | string | — | |
recentRuns | body | agentRunView[] | — | RecentRuns is the agent's 20 most recent executions, newest first. |
recentRuns[].actor | body | string | — | Actor is the "org/sub" identity the run was executed and billed AS. |
recentRuns[].agent | body | string | — | What an operator needs to answer "what ran, for whom, and what did it do" — and, through traceId, to leave this record for the waterfall of the very same run… |
recentRuns[].completionTokens | body | integer | — | CompletionTokens is the same measurement for what the model produced, on the same final completion. |
recentRuns[].createdAt | body | string | — | CreatedAt is when the run finished, RFC 3339 in UTC to the second — the duration above already says how long it had been going. |
recentRuns[].durationMs | body | integer | — | DurationMs is wall-clock milliseconds around the completion, including a failover's retries. |
recentRuns[].error | body | string | — | Error is why an "ok"-less run failed, as the failing call reported it. |
recentRuns[].id | body | string | — | ID is the run's handle, minted as "run_" + 32 hex characters. |
recentRuns[].input | body | string | — | Input is the text the run was given, verbatim. |
recentRuns[].model | body | string | — | Model is the model that actually SERVED this run, which is not always the one the agent is defined on — a failover records what answered. |
recentRuns[].output | body | string | — | Output is what the model produced. Empty on an error run, and empty is also a legitimate answer from a run that succeeded with nothing to say — Status is what… |
recentRuns[].promptTokens | body | integer | — | PromptTokens is what the gateway reported for the run's FINAL completion, and only that one — a tool loop's earlier rounds are the metering ledger's account,… |
recentRuns[].status | body | string | — | Status is the run's outcome, and there are exactly two: "ok" when the model answered, "error" when it did not. |
recentRuns[].toolCalls | body | integer | — | ToolCalls is how many tool dispatches the run made — a count of ACTIONS, which is a different measurement from the token counts above and from the turns a… |
recentRuns[].traceId | body | string | — | TraceID is the trace this run IS, so the record and its spans are one thing to move between: it opens the waterfall for THIS run rather than a search that… |
runs | body | integer | — | |
schedule | body | string | — | |
serviceAccountId | body | string | — | |
status | body | string | — | |
tools | body | string[] | — | |
updatedAt | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo agents get <ref>import { Configuration, AgentsApi } from 'hanzoai';
const api = new AgentsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAgentsByRef({ ref: 'ref' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AgentsApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AgentsApi(client).get_agents_by_ref(ref='ref')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AgentsAPI.GetAgentsByRef(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, agents_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = agents_api::get_agents_by_ref(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AgentsApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new AgentsApi(client).getAgentsByRef();curl https://api.hanzo.ai/v1/agents/<ref> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches agents through the agents tool, which names its 36 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_agent_conversations"
}
}
}'How is this guide?