Skip to main content
GET
/
v1
/
account
/
credits
Credit Balance
curl --request GET \
  --url https://api.swarms.world/v1/account/credits \
  --header 'x-api-key: <x-api-key>'
{
  "credit": 123,
  "free_credit": 123,
  "referral_credits": 123,
  "total_credits": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.swarms.ai/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
x-api-key
string
required

Response

Successful Response

​
credit
number
required

Regular credit balance.

​
free_credit
number
required

Free credit balance.

​
referral_credits
number
required

Referral credits balance.

​
total_credits
number
required

Total available credits (sum of all credit types).