The account's credit balance
What the calling key's account has to spend on sessions, from the account's direct wallet (the only one API usage draws on). Every amount is in microcredits (100 microcredits = 1 credit).
spendableMicrocredits is the amount a session is admitted on: every
positive bucket for a reserve-mode key or a signed-in user; the plan
and top-up buckets only for a metered key, which never spends coupon
credits (couponSpendable: false). Live sessions' reservations are
already taken out of the buckets and are reported on their own as
heldByLiveSessionsMicrocredits. unlimited is true when sessions
are not charged (an unlimited plan, or billing switched off), whatever
the buckets say. nextExpiry lists the credits that will expire,
soonest first. An avatar's sponsor pool is not part of this balance
(GET /v1/avatars/{avatarId}/sponsor).
Any key with the sessions or avatars:read scope may read it, an
avatar-scoped key included, and so may a signed-in user acting for the
account.
X-Api-Key<token>Secret embed API key (sk_atmee_...; keys minted before 2026-09
carry sk_live_...), held by the customer's own backend and never
sent to a browser. Format: X-Api-Key: sk_atmee_....
The balance.
application/json- response
wallet*"direct"The wallet API usage spends; always direct.
"direct"spendableMicrocredits*integerWhat a session is admitted on for this caller (see the operation).
int64planMicrocredits*integerCredits of the plan's cycle grant left. Negative when the bucket is in debt.
int64topupMicrocredits*integerPurchased credits left.
int64couponMicrocredits*integerCoupon credits left.
int64couponSpendable*booleanFalse for a metered key, which never spends coupon credits.
heldByLiveSessionsMicrocredits*integerReserved by sessions running now (already taken out of the buckets); what they do not use comes back when they end.
int64unlimited*booleanSessions are not charged (an unlimited plan, or billing switched off).
nextExpiry*array<>Credits that will expire, soonest first.
curl -X GET 'https://api.atmanity.us/v1/account/balance'{ "wallet": "direct", "spendableMicrocredits": 0, "planMicrocredits": 0, "topupMicrocredits": 0, "couponMicrocredits": 0, "couponSpendable": true, "heldByLiveSessionsMicrocredits": 0, "unlimited": true, "nextExpiry": [ { "bucket": "string", "amountMicrocredits": 0, "expiresAt": "2019-08-24T14:15:22Z" } ]}End a speech session POST
Ends the session (completed, endReason: ended_by_api).
The account's creator wallet and earnings GET
What the account's monetized avatars earned, what was paid out, and the wallet balance between the two, in microcredits (100 microcredits = 1 credit), as Studio's billing page shows them.