Get this key’s budget
get_agent_budgetCheck how much send budget remains for the current API key, when it resets, and the per-minute ceiling before a batch or after a budget-exceeded refusal.
Instructions
Purpose: see how much of this key's send budget is left, when it refills, and its per-minute ceiling. Read it before a batch, and after an agent_budget_exceeded refusal. NOT for: changing any of it. Raising is the account owner's. Returns: budget, consumed, remaining, the period and when it resets, and the per-minute ceiling with its current window.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_agent_budget"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Present instead of the fields above when the call was refused: code, message, fix, docs_url, retryable and, when waiting helps, retry_after_seconds. | |
| period | No | ||
| remaining | No | ||
| api_key_id | No | Identifier. | |
| api_key_name | No | ||
| period_resets_at | No | ISO 8601 time. | |
| budget_per_period | No | Null: metered but unlimited. | |
| period_started_at | No | ISO 8601 time. | |
| consumed_in_period | No | ||
| consumed_in_window | No | ||
| rate_ceiling_per_minute | No |