Skip to content

Get the authenticated user's credit balance ​

GEThttps://api-credit.transkribus.org/user/balance

User identity comes from the bearer token (trp_user_id).
BALANCE_SOURCE=legacy (dual-read phase) returns the legacy shape;
on legacy outage it falls back to the local computation with
header X-Balance-Source: new_degraded. Locally computed balances
additionally carry superModelEligibleBalance — the sum of
personal package balances that may pay for super-model (TrHtr)
jobs (welcome-standard credits are excluded). Frontends treat an
absent field as "eligibility gate unavailable".
When ENABLE_WELCOME_GRANT=true this read lazily creates the
one-time welcome grant (20 super-eligible + 30 restricted).

Responses​

{ userId, addOn, scholar, organisation, superModelEligibleBalance? }

Try it out

Playground​

Authorization

Samples​

Transkribus Developer Platform