general

Check the authenticated account’s credit balance (free)

Alias of POST /api/v1/get_balance with {}. Returns spendable credits, plan, limits and payment links. Private, never cached; works at zero credits.

get/api/v1/balance

Request

  • Base URL: https://scholarmuse.ai
  • URL: https://scholarmuse.ai/api/v1/balance
  • Auth: HTTP bearer

Response

Account balance snapshot.

summarystring required
partialboolean
extraobject
credits_usednumber required
call_idstring required

Example response

{
  "billing": {
    "lowBalanceThreshold": 20
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.