THthe-swarm-corporation
Account Management
Credits

Credit Balance

Changed on

Retrieves the current API credit balance for the authenticated user.

get/v1/account/credits

Request

  • Base URL
    https://api.swarms.world
  • URL
    https://api.swarms.world/v1/account/credits
  • Auth
    none declared. Required headers: x-api-key

Headers

x-api-keystring required

Response

Successful Response

creditnumber required

Purchased credit balance. The only balance that pays for API usage.

free_creditnumber required

Free credit balance. Shown for reference only; free credits no longer pay for API usage.

referral_creditsnumber required

Referral credits balance. Shown for reference only; referral credits no longer pay for API usage.

total_creditsnumber required

Spendable balance, equal to credit. This is the balance checked against the $1.00 minimum on billable routes.

Changes