Запрос баланса

Возвращает статус баланса аккаунта, которому принадлежит текущий API-ключ: доступный баланс, накопленные пополнения и накопленные расходы.

Эта точка относится к OfoxAI OpenAPI и не зависит от конкретного протокола (OpenAI / Anthropic / Gemini). Подходит любой действующий ключ OfoxAI; формат ответа совместим с cc-switch и подобными сторонними инструментами.

Endpoint


GET https://api.ofox.ai/v1/user/balance

Та же точка доступна через входы Anthropic / Gemini — удобно для клиентов, уже настроенных на другой Base URL:

URL
`https://api.ofox.ai/v1/user/balance`
`https://api.ofox.ai/anthropic/user/balance`
`https://api.ofox.ai/gemini/user/balance`

Все три URL возвращают идентичную структуру ответа.

Аутентификация

Передавайте любой действующий OfoxAI API-ключ (sk-...) через заголовок Authorization: Bearer:


Authorization: Bearer sk-xxx

Используйте пользовательский API-ключ (создаётся в Dashboard ). Не используйте внутренние ключи Internal / Gateway.

Пример запроса

cURL

Terminal


curl https://api.ofox.ai/v1/user/balance \
  -H "Authorization: Bearer $OFOX_API_KEY"

Python

balance.py


import os
import requests
 
resp = requests.get(
    "https://api.ofox.ai/v1/user/balance",
    headers={"Authorization": f"Bearer {os.environ['OFOX_API_KEY']}"},
)
data = resp.json()
print(f"Доступный баланс: ${data['balance']:.4f} {data['currency']}")

TypeScript

balance.ts


const resp = await fetch('https://api.ofox.ai/v1/user/balance', {
  headers: { Authorization: `Bearer ${process.env.OFOX_API_KEY}` },
})
const data = await resp.json()
console.log(`Доступный баланс: $${data.balance.toFixed(4)} ${data.currency}`)

Формат ответа

Успешный ответ 200 OK:


{
  "is_active": true,
  "balance": 42.1357,
  "total": 100.0000,
  "used": 57.8643,
  "currency": "USD"
}

Поля ответа

Поле	Тип	Описание
`is_active`	boolean	Доступность аккаунта. После успешной аутентификации — `true`; при ошибке — `false`
`balance`	number	Текущий доступный баланс, равен `total - used`
`total`	number	Накопленные пополнения: пополнения + бонусы + подарочные карты
`used`	number	Накопленные расходы: общая сумма всех вызовов
`currency`	string	Валюта, всегда `"USD"`

Все суммы в USD как 64-битные числа с плавающей точкой. Внутренняя точность — NanoDollar (10⁻⁹ USD), что позволяет учитывать суммы меньше цента.

Ошибки

При сбое аутентификации или ошибке сервиса возвращается код, отличный от 200, с телом, совместимым с cc-switch:


{
  "error": "unauthenticated",
  "is_active": false
}

Код	Значение `error`	Описание
`401`	`unauthenticated`	API-ключ недействителен, отключён или просрочен
`500`	`internal error`	Внутренняя ошибка сервиса, повторите позже

Совместимость со сторонними инструментами

Структура ответа совместима с шаблоном запроса баланса cc-switch и подходит как готовый источник баланса для cc-switch:

is_active — проверка статуса
balance соответствует полю remaining cc-switch
total / used — индикатор использования