Vaquill

Get Page Balance

get_page_balance

Read-only

Returns the translation and OCR pages this API key's account can spend now.

Free. Never charged, so you can poll it to drive alerting or a pre-flight check without the check itself costing you anything. Like the credit balance, it is designed to still answer when the answer is "nothing": at a zero balance a metered call 402s and tells you nothing, which is the moment the number matters most.

Authentication: a vq_key_ key holding translate:read.

Pages, not characters

This product bills physical pages. A page of text is 2,000 characters; a page of a document is a page of that document. Nothing here is counted in tokens.

Two pools, and which one this API spends

translation and ocr are separate balances, not two views of one number.

Translating a document, scanned or not, spends translation pages only. Reading a scan is included in that price: this API does not charge you OCR pages for it. Budget from the translation pool.

The ocr pool exists for standalone text extraction, which is a separate operation this API surface does not currently expose. It is reported here so the figure is visible to an account that holds OCR pages, not because a translation call will draw on it.

Your free allowance applies here too

Pages are pooled per ACCOUNT, not per credential, so the monthly free allowance your account holds is spendable through the API as well. A charge draws on free before paid, which means the first pages of a month can cost nothing and leave paid untouched.

Budget from pagesRemaining, which is free plus paid. Budgeting from paid alone understates what you can spend.

Separate from API credits

Translation pages and API credits are different currencies on different ledgers. GET /credits/balance reports credits for the primary-law endpoints and says nothing about pages; this endpoint reports pages and says nothing about credits. Neither pays for the other.

Pages are pooled per organization

If your key belongs to an organization, these figures are the ORGANIZATION's pooled balance, not your personal one. Every member spends from the same pool, so a colleague's large job changes what you see here.

Example

curl https://api.vaquill.ai/api/v1/in/translation/balance \
  -H "Authorization: Bearer $VAQUILL_API_KEY"

{
  "translation": {
    "pagesRemaining": 1480,
    "free": 0,
    "paid": 1480,
    "totalPurchased": 2000,
    "totalConsumed": 520
  },
  "ocr": {
    "pagesRemaining": 310,
    "free": 0,
    "paid": 310,
    "totalPurchased": 500,
    "totalConsumed": 190
  },
  "pagesArePhysical": true,
  "asOf": "2026-11-01T12:34:56Z"
}

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_page_balance"
  }
}

Input Schema

Name	Required	Description	Default
No arguments

Output Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

AddedNov 6, 2026

TDQS

A4.8/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnly/destructive annotations, it discloses the auth requirement (`vq_key_` with `translate:read`), error behavior at zero balance (a metered call 402s), pooling semantics per account and per organization, and the free-before-paid draw order. These are exactly the non-obvious traits that change how an agent should call and interpret the tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The answer is front-loaded in the first sentence and the section headers make the long body scannable. Some material is redundant with structured fields, notably the full JSON example duplicating the output schema and the repeated instruction to budget from pagesRemaining rather than paid.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a no-parameter read tool, everything an agent needs is present: auth scope, cost, error behavior at zero, unit semantics (pages vs characters), pool separation, and org-level pooling. The output schema already covers the response shape, so the extra explanation of fields is surplus rather than a gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There are zero input parameters, so the baseline is 4; there is no parameter meaning for the description to add. It does clarify the semantics of the returned figures (pagesRemaining = free + paid, budget from that not from paid), which is useful, though that is return-value context rather than input semantics and an output schema exists.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource in the first sentence: returns the translation and OCR pages the API key's account can spend. It also explicitly separates itself from the credits endpoint ('GET /credits/balance reports credits ... this endpoint reports pages'), so an agent can distinguish it from get_india_credit_balance without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit when-to-use guidance: 'Free. Never charged, so you can poll it to drive alerting or a pre-flight check.' It also names a when-not/alternative case by stating that credits are a separate ledger and neither pays for the other, which routes the agent to the right endpoint for each currency.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Vaquill tools Inspect

Try in Browser