Create budget
Sets, raises, or removes a session's cap. - a replacement must be strictly greater than what the session has consumed - removal is one-way: a session…
POST /v1/agent/sessions/{id}/budget
| Address | https://api.hanzo.ai/v1/agent/sessions/{id}/budget |
| Method | POST |
| Operation | post_agent_sessions_by_id_budget |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Sets, raises, or removes a session's cap.
- a replacement must be strictly greater than what the session has consumed
- removal is one-way: a session whose cap was removed cannot take one again, and a session created without one cannot be given one
- raising or removing the cap resumes work that paused at it
Request
3 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the session, from the path. |
budget_micro_usd | body | integer (int64) | — | BudgetMicroUSD is the new cap, or null to remove the cap for good. |
id | body | string | — | ID is the session, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | agent.sessionBudgetView | ok |
default | problem-details | refused |
200 body — 5 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
budget_micro_usd | body | integer (int64) | — | BudgetMicroUSD is this session's own ceiling in micro-USD, beyond the agent's. |
budget_removed | body | boolean | — | BudgetRemoved says the session's own cap was taken off. |
consumed_micro_usd | body | integer (int64) | — | ConsumedMicroUSD is what has been spent in the current period, in micro-USD. |
id | body | string | — | ID names the session. |
status | body | string | — | Status is the session's state: running, paused at its cap, or done. |
Failure carries the platform error shape — see Errors.
Examples
hanzo agent sessions budget <id>import { Configuration, AgentApi } from 'hanzoai';
const api = new AgentApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postAgentSessionsByIdBudget({ id: 'id', budget_micro_usd: 0, id: "<id>" });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import AgentApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = AgentApi(client).post_agent_sessions_by_id_budget(id='id', budget_micro_usd=0, id="<id>")cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.AgentAPI.PostAgentSessionsByIdBudget(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, agent_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = agent_api::post_agent_sessions_by_id_budget(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.AgentApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new AgentApi(client).postAgentSessionsByIdBudget();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/agent/sessions/<id>/budget \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"budget_micro_usd": 0,
"id": "<id>"
}'MCP reaches agent through the agents tool, which names its 36 operations with its own verbs — this one among them, under a name only MCP 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?