credits

Get the credit balance summary

The global credit meter: available balance, period allowance, refill date, and the low/blocked flags. Cheap to poll; lazily creates the balance with the plan's initial grant on first access.

get/credits/summary/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/credits/summary/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

Successful Response

availablenumber required

Credits left to spend: the balance, floored at zero, in decimal credits. A running table's hold does not lower it.

balancenumber required

Settled credit balance, in decimal credits.

heldnumber required

Credits in-flight runs set aside for their highest possible cost, in decimal credits. Still part of the balance until charged, so it does not lower the credits left.

is_blockedboolean required

The balance is empty; credit-consuming work is refused.

is_lowboolean required

The balance is at or below the low-balance threshold.

period_allowancenumber required

Credits granted each period by the plan, in decimal credits.

period_endstring date-time required

When the allowance next refills.

period_startstring date-time required

Start of the current grant period.

Changes

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