provod.ai / docs
API

Список API-ключей

Обычные API-ключи рабочего пространства, с постраничной загрузкой и фильтром отключённых ключей.

Обновлено

GET /v1/keys

Получите обычные API-ключи рабочего пространства. Управляющие ключи в список не входят.

Авторизация

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

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

Query-параметры

ПолеТипОписание
offsetinteger0–1000000; по умолчанию 0.
limitinteger1–100; по умолчанию 100.
include_disabledstringtrue / false; по умолчанию false. Включить отключённые ключи.
workspace_idstringНеобязательная проверка рабочего пространства, не переключение.

Увеличивайте offset на limit, пока не получите неполную или пустую страницу. Ответ не содержит total или next_cursor.

Ответ · 200

ПолеТипОписание
dataobject[]Массив объектов ключей.

Каждый объект включает поля текущего ключа и следующие поля:

ПолеТипОписание
hashstringХеш SHA-256 для обращения к ключу.
namestringНазвание ключа.
disabledbooleanБлокируются ли новые запросы.
created_atstring (date-time)Время создания.
updated_at, last_used_atstring | nullДаты ISO или null, если отсутствуют.

При нескольких лимитах limit, limit_reset и limit_remaining равны null; читайте spend_limits. is_management_key всегда false.

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

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

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

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

const response = await fetch("https://api.provod.ai/v1/keys?offset=0&limit=100&include_disabled=true", {
  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Неверный тип ключа или недостаточно прав в рабочем пространстве.
400Bad RequestНеверные или неизвестные параметры.

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

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

Далее

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