Get AI Credit Balance
get_credit_balanceRead-only
Get the current Metadata AI credit balance for the account this token belongs to.
USAGE INSTRUCTIONS FOR LLM:
Tool calls against this server consume AI credits. When the balance reaches zero
or goes negative, billable tools may refuse with an
OUT OF CREDITS error. This tool is how you check
the balance before that happens, and how you confirm a top-up has landed.
WHEN TO USE THIS TOOL:
- Another tool just failed with OUT OF CREDITS — check here before retrying
- The account owner says they have paid, and you need to know if it landed yet
- The user asks "how many credits do I have?" or "what's my AI balance?"
- Before starting a long batch of tool calls, to confirm there is headroom
IMPORTANT — AFTER A TOP-UP, POLL, DO NOT SPIN:
Payment settles ASYNCHRONOUSLY. A card can be charged successfully and the
balance still read as exhausted for a minute or two while the payment clears.
Poll this tool every 20-30 seconds, not continuously. Resume the work you were
doing only once `is_exhausted` is false.
EXPECTED RESPONSE FORMAT:
{
"account_id": "1234",
"balance_usd": 42.5, // may be NEGATIVE — that is a real state
"updated_at": "2026-08-07T12:00:00",
"is_exhausted": false // true means other tools will refuse
}
On failure returns {"error": "..."} — treat an unreadable balance as unknown,
not as zero, and do not tell the user they are out of credits because of it.Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||