Skip to main content
GET
/
api
/
v1
/
credits
/
balance
Get the AI credit balance
curl --request GET \
  --url https://api.railmail.app/api/v1/credits/balance \
  --header 'X-API-Key: <api-key>'
{
  "balance": 123,
  "creditsDepleted": true,
  "lastUpdatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

Project-scoped API key, format rm_(live|test)_... . May also be sent as Authorization: Bearer rm_....

Response

Credit balance

balance
number
creditsDepleted
boolean
lastUpdatedAt
string<date-time> | null