Docs
BlogHomeStart building

Account

Check your current credit balance and account information.


The Totalum API is a REST API for programmatically building, deploying, and managing projects.

  • Base URL: https://api-accounts.totalum.app
  • Authentication: every request must include the header api-key: <your-api-key> (keys are prefixed tlm_sk_).
  • Response envelope: every response is shaped as { "errors": null | { "errorCode": "...", "errorMessage": "..." }, "data": ... }.
Tip

Keep your API key secret — it must never leave your backend server. Never call the Totalum API directly from frontend code.

#Get Account Info

GET/api/v1/vcaas/accountFree

Retrieve your current credit balance and account details.

Response fields

FieldTypeDescription
data.creditsnumberCurrent credit balance

Example request

bash
curl -H "api-key: tlm_sk_your_key" \
  https://api-accounts.totalum.app/api/v1/vcaas/account
Success · 200 OK
json
{
  "errors": null,
  "data": {
    "credits": 425
  }
}
Error · 400
json
{
  "errors": {
    "errorCode": "GET_ACCOUNT_ERROR",
    "errorMessage": "Internal error fetching account info"
  },
  "data": null
}

Error codes

CodeHTTPMeaning
GET_ACCOUNT_ERROR400Internal error fetching account info