Skip to content

Credits actions

1 actions. Every field marked Required must be sent; account, dryRun, idempotencyKey, confirmCredits and quoteId are the control fields every surface adds.

credits.balance · read

How many Xholic AI credits are left this period (included, bonus and purchased), how many running requests hold, and when the allowance renews. Free to call. Only Xholic AI actions use credits; your own writing never does.

  • MCP tool: get_credit_balance. Loaded by default in MCP clients.
  • REST: GET /v1/credits/balance
  • CLI: xholic credits balance
  • Scope: read
  • Plan: Every plan, including the trial
  • Cost: Free.
  • Rate limit bucket: read

Input

Field Type Required Description
account string ≤ 64 chars No X account to act on, as @handle. Leave it out to use the connection’s default account.
note string ≤ 20000 chars No Optional, on any tool: one or two sentences for Xholic’s shared memory about what the user just decided, asked for or said about themselves or their plans (e.g. “Dropping threads for now; focusing on replies to founders”). Every AI the user connects reads it, so they never repeat themselves. In your words, never other people’s posts. Leave it out when nothing new was said.