provod.ai / docs
API

Пополнения и расходы

Общая сумма пополнений и фактических расходов рабочего пространства за всё время.

Обновлено

GET /v1/credits

Получите общую сумму пополнений и расходов рабочего пространства.

Авторизация

Authorization: Bearer <MANAGEMENT_API_KEY>: управляющий ключ выбранного рабочего пространства.

Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.

Параметры

Тело запроса и параметры не требуются.

Ответ · 200

ПолеТипОписание
data.total_creditsnumberОбщая сумма оплаченных и ручных пополнений за всё время.
data.total_usagenumberОбщие расходы на запросы и оплачиваемые проверки guardrail за всё время.

Суммы выражены в RUB. Этот ответ не содержит currency и точных десятичных строк. Для доступного остатка после резервов используйте GET /v1/balance с обычным API-ключом. Разность total_credits и total_usage не учитывает резервы, возвраты и другие операции баланса.

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

Все идентификаторы и суммы в примерах условные.

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

Загрузите ключ в переменную окружения на сервере. TypeScript использует встроенный fetch в Node.js, Python только стандартную библиотеку.

const response = await fetch("https://api.provod.ai/v1/credits", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Ошибки

HTTPОшибкаПричина
401UnauthorizedОтсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется.
403ForbiddenНеверный тип ключа или недостаточно прав в рабочем пространстве.

Пример ошибки авторизации:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}

Далее

На этой странице