API Reference

Wallet & Credits

Inspect the remaining credit balance of the key's billing owner via the wallet endpoint.

The /v1/wallet endpoint returns the live credit balance of the wallet your key bills to. Use it to check you have enough credits before queuing large jobs.

Get Wallet Balance
curl -s https://api.transpera.ai/v1/wallet \
  -H "Authorization: Bearer tp_live_YOUR_KEY"

Response Fields

creditsRemainingintegerrequired

Credits available right now: paid plus non-expiring credits.

paidCreditsintegerrequired

Purchased credits included in creditsRemaining. These expire at paidCreditsExpireAt.

nonExpiringCreditsintegerrequired

Credits included in creditsRemaining that never expire (for example grants and bonuses).

paidCreditsExpireAtstring | nullrequired

ISO 8601 UTC time when paidCredits expire, or null.

livemodebooleanrequired

true for tp_live_ keys, false for tp_test_ keys.

spendCapCreditsinteger | nullrequired

Test keys only: the largest estimated cost a single job may have before it is refused with 402. null for live keys.