Get Talonic Credit Balance
talonic_get_balanceRetrieve your current credit balance, EUR value, 30-day burn rate, and projected runway to make budget-aware decisions before running large batches or re-extractions.
Instructions
STATUS: stable.
Read the user's current Talonic credit balance, EUR value, 30-day burn rate, projected runway, tier, and next-tier-reset timestamp. Use this to make budget- aware decisions before kicking off large batches or re-extractions.
USE WHEN:
The user asks how many credits or how much budget they have left.
You are about to run a large or expensive operation (batch extract, re-extract many documents) and want to confirm budget headroom first.
The user asks how long their balance will last at the current rate.
DO NOT USE WHEN:
The user just wants the per-call cost of a single extraction (that is already on the talonic_extract response under
cost).The user wants to top up credits (route them to the dashboard; auto top-up is guarded by a separate scope).
RESPONSE SHAPE:
balance_credits: current credit balance.
balance_eur: current balance in EUR (rounded to two decimals).
burn_rate_30d_credits: total credits consumed in the trailing 30 days.
projected_runway_days: days of runway at the current 30-day average burn.
-1indicates no consumption in the trailing window (cannot compute runway).tier: API tier of the workspace (
free,pro,enterprise, etc.).tier_resets_at: ISO 8601 timestamp of the next monthly tier reset.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| balance_credits | Yes | Current credit balance. | |
| balance_eur | Yes | Current balance in EUR (two decimals). | |
| burn_rate_30d_credits | Yes | Total credits consumed in the trailing 30 days. | |
| projected_runway_days | Yes | Projected days of runway at the current 30-day average burn. `-1` when burn is zero (cannot compute). | |
| tier | Yes | API tier of the workspace. | |
| tier_resets_at | Yes | ISO 8601 timestamp of the next monthly tier reset. |