general

Check credit balance

Check the signed-in account’s remaining credits, plan, call limits and links to add credits. Always free, including at zero credits. Call when the user asks about balance or before a large batch or figure. Estimates are alternatives, not a combined budget. Show low-credit notices briefly once; after insufficient_credits or paid_plan_required, show the supplied payment link and wait for the user instead of repeatedly retrying. Never make a purchase for the user.

Discipline pack: general. Cost: Free.

post/api/v1/get_balance

Request

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

Request body

object required

Response

The tool result.

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.