API-ключи (справочник)
Создание ключей для приложений на уровне организации.
Кому подходит
- Администраторам — выпуск и учёт ключей.
- Автоматизации — provisioning через CI/CD.
API платформы — только owner / admin.
POST /api/organizations/{orgId}/api-keys
Создать API-ключ.
Тело:
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
alias | string | да | Уникальное имя ключа |
ownerEmail | string | нет | Владелец; default — email сессии |
systemId | string | нет | Привязка к информационной системе или агенту |
Доступ к моделям и бюджеты задаются через Policy Rules, а не полями ключа.
curl -s -X POST https://api.example.com/api/organizations/org_abc/api-keys \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"alias": "production-bot",
"systemId": "sys_001"
}'Ответ 201:
{
"id": "key_xyz",
"organizationId": "org_abc",
"alias": "production-bot",
"ownerEmail": "owner@example.com",
"systemId": "sys_001",
"status": "active",
"secret": "sk-…"
}Поле secret — секретная строка для API моделей. Показывается только в этом ответе; в GET /api/overview и последующих запросах секрет не возвращается.
Ошибки 400: alias is required, organization not found, система не найдена; ошибка выпуска ключа в API моделей.
Аудит: api_key.created.
POST /api/organizations/{orgId}/api-keys/{keyId}/revoke
Отозвать API-ключ. Доступно ролям owner / admin.
curl -s -X POST https://api.example.com/api/organizations/org_abc/api-keys/key_xyz/revoke \
-H "Authorization: Bearer <token>"Ответ 200: объект ключа со "status": "revoked".
Ошибки 400: api key not found, api key already revoked, organization not found; ошибка отзыва в API моделей.
Аудит: api_key.revoked.
Список ключей
Отдельного GET для ключей нет — используйте GET /api/overview → apiKeys.
Статусы
| status | Описание |
|---|---|
active | Ключ действует |
revoked | Отозван |