get_balance
Check the live account-wide Credits balance shared by all API keys for free without reserving or spending Credits.
Instructions
Read the live account-wide available Credits balance shared by all API keys. Free; does not reserve or spend Credits.
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_balance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| response_format | No | Agent-readable presentation. MCP defaults to Markdown; json returns the original JSON text, text returns indented fields. Structured fields remain available. Does not change billing or the stored job. | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Machine-readable error code when the operation fails. | |
| note | No | Balance limitations. | |
| unit | No | ||
| scope | No | ||
| detail | No | Additional problem detail returned by the API. | |
| message | No | Error, delivery, or continuation instructions. | |
| updatedAt | No | Last recorded balance update time, if available. | |
| request_id | No | FlashData request identifier for support and tracing. | |
| http_status | No | Upstream HTTP status, when an upstream request was made. | |
| balanceCredits | No | Live account balance, shared by all API Keys. | |
| availableCredits | No | Nonnegative available balance at read time. |