OpenapiAgents
Returns one agent's execution history, newest first — each run's input, its…
Returns one agent's execution history, newest first — each run's input, its output or its error, and how long it took.
GET /v1/agents/{ref}/runs
| Address | https://api.hanzo.ai/v1/agents/{ref}/runs |
| Method | GET |
| Operation | get_agents_by_ref_runs |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one agent's execution history, newest first — each run's input, its output or its error, and how long it took. Every row is a run that actually happened.
Request
2 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
ref | path | string | yes | Ref is the agent's public id or its org-unique name, from the path. |
limit | query | integer | — | Limit caps how many runs come back, newest first. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | runList | ok |
200 body — 15 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
runs | body | agentRunView[] | — | Runs is the agent's executions, newest first. |
runs[].actor | body | string | — | Actor is the "org/sub" identity the run was executed and billed AS. |
runs[].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… |
runs[].completionTokens | body | integer | — | CompletionTokens is the same measurement for what the model produced, on the same final completion. |
runs[].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. |
runs[].durationMs | body | integer | — | DurationMs is wall-clock milliseconds around the completion, including a failover's retries. |
runs[].error | body | string | — | Error is why an "ok"-less run failed, as the failing call reported it. |
runs[].id | body | string | — | ID is the run's handle, minted as "run_" + 32 hex characters. |
runs[].input | body | string | — | Input is the text the run was given, verbatim. |
runs[].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. |
runs[].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… |
runs[].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,… |
runs[].status | body | string | — | Status is the run's outcome, and there are exactly two: "ok" when the model answered, "error" when it did not. |
runs[].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… |
runs[].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… |
Failure carries the platform error shape — see Errors.
Examples
hanzo agents runs <ref>import { Configuration, AgentsApi } from 'hanzoai';
const api = new AgentsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getAgentsByRefRuns({ 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_runs(ref='ref')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AgentsAPI.GetAgentsByRefRuns(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_runs(&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).getAgentsByRefRuns();curl https://api.hanzo.ai/v1/agents/<ref>/runs \
-H "Authorization: Bearer $HANZO_API_KEY"Tool agents, op get_agents_by_ref_runs — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "agents",
"arguments": {
"op": "get_agents_by_ref_runs",
"input": {
"ref": "<ref>"
}
}
}
}'How is this guide?