Get the balance

GET/v1/balanceNeeds an API key

Read your account's balance.

While a call runs, the balance reserves the most it may cost; what is left to start new calls with is available_balance_usd. A call the available balance cannot cover is refused.

Response

Your account's balance. Your account's balance, as decimal strings in USD. Every workspace on the account draws on it.

balance_usdstring

Everything the balance holds, including what calls in flight have reserved.

available_balance_usdstring

What new calls can draw on: the balance minus what calls in flight have reserved.

400Refused request body

The request was refused.

401INVALID_AUTH_TOKENRefused request body

The API key is missing, wrong or revoked.

422VALIDATIONInvalid request body

The request is not valid.

429RATE_LIMITEDRefused request body

Too many requests with this API key.

Retry-After: Seconds until the limit resets.

curl https://api.voxoria.ai/v1/balance \
  -H "Authorization: Bearer $VOXORIA_API_KEY"

import os

import httpx

response = httpx.get(
    "https://api.voxoria.ai/v1/balance",
    headers={"Authorization": f"Bearer {os.environ['VOXORIA_API_KEY']}"},
)
print(response.json())

const response = await fetch("https://api.voxoria.ai/v1/balance", {
  headers: {
    Authorization: `Bearer ${process.env.VOXORIA_API_KEY}`,
  },
});
console.log(await response.json());

{
  "name": "get_balance",
  "arguments": {}
}

200 OKResponseapplication/json

{
  "balance_usd": "25.0000",
  "available_balance_usd": "24.9786"
}