# Создать API-ключ

`POST https://api.souz.ai/v1/keys`

Возвращает сырой ключ; он же сохраняется в зашифрованном виде, и автор может получить его снова через GET /v1/keys/{id}/secret. Ключ создаёт участник, который вызывает метод (через ключ управления — его держатель), и он же держатель: траты ключа идут в его лимит, при его удалении ключ отзывается. Необязательно: spend_limit_micro и spend_limit_reset (none | daily | monthly) — потолок трат ключа сразу при создании. Разработчик и выше. kind: management — ключ управления: создают владелец и администратор и только в кабинете (ключом управления — 403 cabinet_only); потолка трат у него нет — он не тратит.

## Авторизация

- `ManagementKey`: Ключ управления из кабинета souz.ai (выдают владелец и администратор аккаунта — себе или участнику). Даёт ровно то, что его держатель видит и может в кабинете: баланс, историю операций и запросов, расходы, обычные ключи, настройки аккаунта — с той же ролью, лимитами и цифрами. Модели не запускает. Обычный API-ключ здесь не подходит: `403 forbidden` с `detail[].reason: requires_management_key`.
- `ClientSession`: Сессия кабинета souz.ai в браузере — те же ручки, что у ключа управления.

## Тело запроса (`application/json`)

Схема `CreateAPIKeyRequest`.

| Поле | Обязательно | Тип | Описание |
|---|---|---|---|
| `kind` | нет | `string`; значения: `user`, `management`; по умолчанию `"user"` | `user` — обычный ключ, запускает модели; `management` — ключ управления: создают владелец и администратор и только в кабинете, трат и потолка у него нет. |
| `name` | нет | `string` |  |
| `spend_limit_micro` | нет | `integer` | Потолок трат ключа в микроединицах валюты; без поля — без потолка. У ключа управления потолка нет: с полем — 400. |
| `spend_limit_reset` | нет | `string`; значения: `none`, `daily`, `monthly` | Как часто обновляется потолок: `none` (по умолчанию, на весь срок), `daily`, `monthly` — по UTC. |

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

```bash
curl -X POST 'https://api.souz.ai/v1/keys' \
  -H "Authorization: Bearer $SOUZ_MANAGEMENT_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "name": "production"
}'
```

```python
import os
import requests

response = requests.post(
    "https://api.souz.ai/v1/keys",
    headers={"Authorization": f"Bearer {os.environ['SOUZ_MANAGEMENT_KEY']}"},
    json={
        "name": "production",
    },
)
print(response.json())
```

```ts
const response = await fetch("https://api.souz.ai/v1/keys", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.SOUZ_MANAGEMENT_KEY}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "production"
  }),
});
console.log(await response.json());
```

## Ответы

### 201

Created

- `application/json`, схема `CreateAPIKeyResponse`

### 400

Запрос отклонён; `error.detail[]` называет поля и допустимые значения.

- `application/json`, схема `Error`

```json
{
  "error": {
    "code": "capability_mismatch",
    "detail": [
      {
        "allowed": [
          "1:1",
          "16:9",
          "9:16"
        ],
        "path": "aspect_ratio",
        "reason": "unsupported_value"
      }
    ],
    "message": "the model does not support this value",
    "type": "invalid_request_error"
  }
}
```

### 401

Нет ключа или ключ недействителен.

- `application/json`, схема `Error`

### 403

Нельзя: у ключа не тот вид (модели запускает API-ключ, аккаунт — ключ управления), у роли участника нет права или подпись ссылки на файл не сходится. `detail[].reason` говорит, что именно: `requires_api_key`, `requires_management_key`, `cabinet_only` (только в кабинете), `insufficient_role` (в `allowed` — роли, которым можно), `not_key_author` (секрет ключа открывает только тот, кто его создал).

- `application/json`, схема `Error`

```json
{
  "error": {
    "code": "forbidden",
    "detail": [
      {
        "reason": "requires_api_key"
      }
    ],
    "message": "this endpoint takes an API key; a management key manages the account only",
    "type": "permission_error"
  }
}
```

### 415

Тип тела не тот, что принимает метод: `Content-Type: application/json` (у загрузки файла и транскрибации — `multipart/form-data`). В `detail[]` — `{"path": "body", "reason": "unsupported_format"}` и принимаемые типы.

- `application/json`, схема `Error`

### 429

Слишком часто — повторите через `Retry-After` секунд. Запуск моделей, задачи и файлы результатов частотой не ограничены (их ограничивают баланс и лимиты трат); здесь 429 — на поток запросов с ключом, который сервер не знает, с одного адреса, и на потоки сверх 1000 одновременных на аккаунт (события задачи, чат с `stream: true`). Пределы — раздел «Лимиты» руководства.

- `application/json`, схема `Error`

### 503

Плановые работы (`maintenance`): новые запросы приостановлены до `error.ends_at`, причина — в `error.reason`. Повторите после этого времени (или через `Retry-After` секунд, чтобы узнать, не закончились ли работы раньше); принятые задачи доделываются, переключаться никуда не нужно. Состояние — `GET /v1/status`.

- `application/json`, схема `Error`

```json
{
  "error": {
    "code": "maintenance",
    "ends_at": "2026-10-04T14:15:00+03:00",
    "message": "scheduled maintenance: new requests are paused until ends_at; retry after it, accepted jobs finish afterwards and nothing needs to change on your side",
    "reason": "Обновление сервиса",
    "type": "model_error"
  }
}
```

---

Оглавление документации: https://souz.ai/llms.txt. Всё руководство одним файлом: https://souz.ai/llms-full.txt. Справочник методов: https://souz.ai/docs/api-reference.md.