Skip to navigation

Get Credit Balance

View as Markdown

Read the credits available to this project’s organization and the largest top-up an agent can offer.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

project_idstringRequired

Response

Successful Response
availableUsdstring or null

Credits available for new work now, after amounts held for work in progress; null unless ready.

stateenum

ready: credits fund work; no_card: the organization has no credit account yet, so nothing funds work until an agent top-up or a saved card opens one; complimentary: usage is covered and needs no credits.

Allowed values:
topUpMaxUsdstring or null

Largest top-up offer an agent can create now; null while agent top-ups are off or unavailable.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error