Skip to navigation
PlatformCredits

API · Get remaining Simplified credit balance

View as Markdown

Returns how many Simplified credits the current workspace has left. Credits are the shared currency spent by AI actions — image generation, video generation, and other AI tools all draw down the same balance.

Call this tool when:

  • the user asks about their credits / balance / quota / “how much is left”;
  • before an AI generation, to confirm there’s enough balance and avoid a mid-run failure;
  • after a generation fails with an out-of-credits / quota error, to report the remaining balance back to the user.

No inputs. The response is a credits object:

  • credits.remaining — credits still available to spend
  • credits.used — credits consumed in the current period
  • credits.total — total credits allotted for the period
  • credits.trial — extra trial allowance (only present when on trial)

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Current credit balance. The toolkit reshapes the raw quota list into a flat summary: credits_remaining, credits_used, credits_total, and trial_credits (only when on trial).