profile

Get current BeReach credit balance

Changed on

Returns the current credit balance for the workspace. Includes credits used, total limit, remaining credits, usage percentage, and whether credits are unlimited. When isUnlimited is true, limit and remaining are null: skip credit budgeting.

get/me/credits

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/me/credits
  • Auth: HTTP bearer

Response

Credit balance for the workspace

successtrue required
creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

  • bdaed6984b20Revision changes
    • warning

      removed the optional property from the response with the status

  • 62bf7284843dRevision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      removed the optional property / from the response with the status