System APIs

Account and system-related API endpoints

Endpoints for account management and system information.

Current Balance

Check the remaining balance for your API key.

Endpoint

GET https://api.apixo.ai/api/v1/apikeys/current-balance

Headers

Authorization · string · required

Bearer token for API authentication. Format: Bearer YOUR_API_KEY

Response

{
  "code": 200,
  "message": "success",
  "data": 74.8700
}

code · integer

HTTP status code.

message · string

Human-readable status message.

data · number

Remaining balance (in USD) for the current API key.

Check your balance programmatically before submitting large batches to avoid mid-run failures due to insufficient funds.

Examples

cURL

curl -X GET https://api.apixo.ai/api/v1/apikeys/current-balance \
  -H "Authorization: Bearer YOUR_API_KEY"

JavaScript

const response = await fetch('https://api.apixo.ai/api/v1/apikeys/current-balance', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
  },
});

const data = await response.json();
console.log('Balance:', data.data);

Python

import requests

response = requests.get(
    'https://api.apixo.ai/api/v1/apikeys/current-balance',
    headers={'Authorization': 'Bearer YOUR_API_KEY'},
)

data = response.json()
print(f"Balance: {data['data']}")

Error Responses

See Errors for possible 401, 403, or 429 responses.