Skip to main content
The account tool gives you a real-time snapshot of two things your agent needs to operate reliably: how many credits you have left, and whether the upstream providers AgentKey routes through are currently healthy. Unlike every other tool in the catalogue, calling account is completely free — it never deducts a single credit from your balance, no matter how many times you run it.
Run account before any bulk or expensive sequence of tool calls. Knowing your balance and provider health upfront lets your agent make informed decisions — such as warning you before a batch that would exhaust your credits, or avoiding a tool category that is currently degraded.

Parameters

None. The account tool takes no input parameters. Call it by passing "agentkey_account" as the tool name to execute_tool.

Returns

credits
object
Your current credit account summary.
credits.remaining
number
Your remaining credit balance at the time of the call. Compare this against the credits_per_call value from describe_tool before running expensive or repeated operations.
health
object
The live health status of each upstream provider category. Keys correspond to tool categories (for example search, scrape, social, crypto, finance). Values are typically "healthy", "degraded", or "unavailable". A "degraded" status means the category is partially available — calls may succeed but with higher latency or reduced reliability. An "unavailable" status means AgentKey cannot currently route calls in that category.

Example

execute_tool("agentkey_account")
{
  "credits": { "remaining": 1240.5 },
  "health": { "search": "healthy", "scrape": "healthy", "social": "degraded" }
}

Pay-as-you-go

Learn how credits work, how per-call costs are calculated, and how to top up your balance.