provod.ai / docs
API

Текущий ключ

Расходы, лимиты и доступный остаток лимита переданного API-ключа.

Обновлено

GET /v1/key

Получите сведения о переданном ключе, его расходах и остатке лимита.

Авторизация

Authorization: Bearer <API_KEY>: обычный или управляющий ключ.

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

Параметры

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

Ответ · 200

Объект data содержит следующие поля. Суммы usage* учитываются по времени списания и не уменьшаются задним числом при возврате. Окна usage_weekly и usage_monthly не совпадают с календарными периодами сброса лимита.

ПолеТипОписание
labelstringВидимый префикс ключа, без секрета.
currencystringВалюта расчётов: RUB.
checked_atstring (date-time)Время чтения текущего состояния.
time_zonestringЧасовой пояс сброса: UTC или Europe/Moscow. Для существующих лимитов кабинета используйте это поле.
limitnumber | nullСумма лимита для совместимости; null, если единичный лимит не представлен.
limit_resetstring | nulldaily, weekly, monthly; null для лимита за всё время или отсутствующего лимита.
limit_remainingnumber | nullОстаток после расходов и резервов, не меньше нуля; null, если лимит не представлен.
usagenumberФактические списания по ключу за всё время.
usage_dailynumberСписания с 00:00 UTC сегодня.
usage_weeklynumberСписания с 00:00 UTC шесть дней назад, включая сегодня.
usage_monthlynumberСписания с 00:00 UTC 29 дней назад, включая сегодня.
spend_limitsobject[]Точное состояние лимитов; пустой массив, если лимитов нет. Поля ниже.
creator_user_idstringИдентификатор создателя ключа.
workspace_idstring | nullРабочее пространство, к которому привязан ключ.
expires_atstring | nullДата ISO или null, если срок не ограничен.
is_management_keybooleantrue для управляющего ключа.
is_provisioning_key, is_free_tierbooleanОба поля равны false.
include_byok_in_limitbooleanВсегда false; BYOK не поддерживается.
byok_usage, byok_usage_daily, byok_usage_weekly, byok_usage_monthlynumberВсегда 0.
organization_id, allowed_data_regions, rate_limitnullПоля совместимости; сейчас null.
free_model_daily_requestsobjectused, limit и remaining: числа, все равны 0. Квота бесплатных моделей не предоставляется.

spend_limits[]

ПолеТипОписание
periodstringdaily, weekly, monthly или lifetime.
limit_amount, spend_amount, reserved_amountstringТочные суммы с 8 знаками после запятой в currency.
remaining_amountstringlimit_amount − spend_amount − reserved_amount; после окончательного списания может быть отрицательным.
window_started_at, resets_atstring (date-time)Границы периода. Лимит за всё время не сбрасывается периодически.

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

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

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

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

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

Ошибки

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

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

{
  "message": "Invalid API key",
  "error": "Unauthorized",
  "statusCode": 401
}

Далее

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