Текущий ключ
Расходы, лимиты и доступный остаток лимита переданного API-ключа.
Обновлено
GET /v1/key
Получите сведения о переданном ключе, его расходах и остатке лимита.
Авторизация
Authorization: Bearer <API_KEY>: обычный или управляющий ключ.
Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.
Параметры
Тело запроса и параметры не требуются.
Ответ · 200
Объект data содержит следующие поля. Суммы usage* учитываются по времени списания и не уменьшаются задним числом при возврате. Окна usage_weekly и usage_monthly не совпадают с календарными периодами сброса лимита.
| Поле | Тип | Описание |
|---|---|---|
label | string | Видимый префикс ключа, без секрета. |
currency | string | Валюта расчётов: RUB. |
checked_at | string (date-time) | Время чтения текущего состояния. |
time_zone | string | Часовой пояс сброса: UTC или Europe/Moscow. Для существующих лимитов кабинета используйте это поле. |
limit | number | null | Сумма лимита для совместимости; null, если единичный лимит не представлен. |
limit_reset | string | null | daily, weekly, monthly; null для лимита за всё время или отсутствующего лимита. |
limit_remaining | number | null | Остаток после расходов и резервов, не меньше нуля; null, если лимит не представлен. |
usage | number | Фактические списания по ключу за всё время. |
usage_daily | number | Списания с 00:00 UTC сегодня. |
usage_weekly | number | Списания с 00:00 UTC шесть дней назад, включая сегодня. |
usage_monthly | number | Списания с 00:00 UTC 29 дней назад, включая сегодня. |
spend_limits | object[] | Точное состояние лимитов; пустой массив, если лимитов нет. Поля ниже. |
creator_user_id | string | Идентификатор создателя ключа. |
workspace_id | string | null | Рабочее пространство, к которому привязан ключ. |
expires_at | string | null | Дата ISO или null, если срок не ограничен. |
is_management_key | boolean | true для управляющего ключа. |
is_provisioning_key, is_free_tier | boolean | Оба поля равны false. |
include_byok_in_limit | boolean | Всегда false; BYOK не поддерживается. |
byok_usage, byok_usage_daily, byok_usage_weekly, byok_usage_monthly | number | Всегда 0. |
organization_id, allowed_data_regions, rate_limit | null | Поля совместимости; сейчас null. |
free_model_daily_requests | object | used, limit и remaining: числа, все равны 0. Квота бесплатных моделей не предоставляется. |
spend_limits[]
| Поле | Тип | Описание |
|---|---|---|
period | string | daily, weekly, monthly или lifetime. |
limit_amount, spend_amount, reserved_amount | string | Точные суммы с 8 знаками после запятой в currency. |
remaining_amount | string | limit_amount − spend_amount − reserved_amount; после окончательного списания может быть отрицательным. |
window_started_at, resets_at | string (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 | Ошибка | Причина |
|---|---|---|
401 | Unauthorized | Отсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется. |
403 | Forbidden | Неверный тип ключа или недостаточно прав в рабочем пространстве. |
Пример ошибки авторизации:
{
"message": "Invalid API key",
"error": "Unauthorized",
"statusCode": 401
}