Получить баланс API-ключа

GET

/api/v1/api-keys/{api_key_id}/balance

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Поведение

Читает снимок оставшейся квоты указанного ключа — проверить, сколько ещё можно потратить. Отключённые, истёкшие, исчерпавшие и мягко удалённые ключи читаются; чужие или несуществующие возвращают 404.

Возвращается сохранённый в базе снимок баланса, а не вычисленный на лету показатель: у безлимитного ключа остаток null, израсходованное возвращается как обычно. Живые счётчики использованных дневных/месячных лимитов этот эндпоинт не читает.

Списания за вызовы пишутся в базу пакетами, поэтому до их записи значение может слегка отставать от реального расхода.

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

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. Ключ модели не подходит, X-User-Id не нужен. См. правила доступа.

Параметры запроса

api_key_idstringпутьобязательно

Десятичный строковый ID собственного обычного ключа, не секрет sk-.

Тело и query-параметры не принимаются.

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

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

curl --request GET \
  --url 'https://api.toapis.com/api/v1/api-keys/43/balance' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.get(
    "https://api.toapis.com/api/v1/api-keys/43/balance",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.toapis.com/api/v1/api-keys/43/balance", {
  method: "GET",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Примеры содержат вымышленные данные. Метаданные описаны в деталях ключа, общий контракт и ошибки в подключении.

data.api_key_idstring

ID ключа.

data.statusstring

Текущий статус, включая deleted.

data.unlimitedboolean

Безлимитная ли квота.

data.remaining_creditsstring | null

Оставшиеся credits, null без лимита.

data.remaining_usdstring | null

Остаток в USD, null без лимита.

data.used_creditsstring

Накопленные потраченные credits.

data.used_usdstring

Накопленные расходы в USD.

data.daily_limit_creditsstring | null

Дневной лимит credits, null без лимита.

data.monthly_limit_creditsstring | null

Месячный лимит credits, null без лимита.

data.credits_per_usdstring

Количество credits за 1 USD.

Примеры ответов

Пример ответа

{
  "code": 0,
  "message": "",
  "data": {
    "api_key_id": "43",
    "status": "enabled",
    "unlimited": false,
    "remaining_credits": "500",
    "remaining_usd": "5",
    "used_credits": "100",
    "used_usd": "1",
    "daily_limit_credits": null,
    "monthly_limit_credits": null,
    "credits_per_usd": "100"
  }
}