Completes a claimed run: it delivers the terminal result to the run's durable…
Completes a claimed run: it delivers the terminal result to the run's durable owner, which is what lets that workflow finish.
POST /v1/agents/targets/{id}/runs/{runId}/report
| Address | https://api.hanzo.ai/v1/agents/targets/{id}/runs/{runId}/report |
| Method | POST |
| Operation | post_agents_targets_by_id_runs_by_runid_report |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Completes a claimed run: it delivers the terminal result to the run's durable owner, which is what lets that workflow finish. Scoped to (org, target, run) and claim-key authenticated, so a machine can only ever report a run it legitimately holds. Idempotent — a report for an unknown or already-finished run answers delivered:false rather than failing, because the session's terminal state was already set by the machine's own stream.
Request
10 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the machine reporting, from the path. |
runId | path | string | yes | RunID is the routed run being completed, from the path. |
branch | body | string | — | Branch, CommitSha and Diffstat describe what the run produced; Error is the failure when OK is false. |
changed | body | boolean | — | Changed says whether the run produced any commit. |
commitSha | body | string | — | CommitSha is the tip the run pushed, clamped to 128 characters. |
diffstat | body | string | — | Diffstat is the run's own summary of what it changed, as text, clamped to 64 KiB. |
error | body | string | — | Error is why the run failed, clamped to 64 KiB. |
id | body | string | — | ID is the machine reporting, from the path. |
ok | body | boolean | — | OK is whether the run succeeded; Changed whether it produced any commit. |
runId | body | string | — | RunID is the routed run being completed, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | reportOut | ok |
200 body — 1 field.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
delivered | body | boolean | — | Delivered is true when a waiting durable owner received this result. |
Failure carries the platform error shape — see Errors.
Examples
hanzo agents targets runs report <id> <runId>import { Configuration, AgentsApi } from 'hanzoai';
const api = new AgentsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAgentsTargetsByIdRunsByRunidReport({ id: 'id', runId: 'runId', branch: "<branch>", changed: false });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).post_agents_targets_by_id_runs_by_runid_report(id='id', run_id='runId', branch="<branch>", changed=False)cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.AgentsAPI.PostAgentsTargetsByIdRunsByRunidReport(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::post_agents_targets_by_id_runs_by_runid_report(&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).postAgentsTargetsByIdRunsByRunidReport();curl -X POST https://api.hanzo.ai/v1/agents/targets/<id>/runs/<runId>/report \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"branch": "<branch>",
"changed": false
}'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?