Создать API Key

POST /api/open/v1/keys

Параметры запроса

Тело запроса — JSON с Content-Type: application/json. Правила валидации совпадают с созданием Key в консоли.

Поле	Тип	Обязательное	По умолчанию	Описание
`name`	string	Да	—	Имя, до 50 символов (символов, не байт); не может быть пустым
`remain_amount`	number	Нет	`0`	Доступная сумма в валюте сайта, два знака после запятой; действует, когда `unlimited` равно `false`; не может быть отрицательной или превышать максимум
`unlimited`	boolean	Нет	`false`	Безлимитный ли Key
`expired_time`	integer	Нет	`-1`	Срок действия, unix-секунды; отсутствие поля, `0` и `-1` означают бессрочно; иначе значение должно быть в будущем и не позже 9999-12-31
`model_limits_enabled`	boolean	Нет	`false`	Включить ли белый список моделей
`model_limits`	string	Нет	`""`	Разрешённые модели через запятую
`allow_ips`	string	Нет	—	Разрешённые IP, по одному на строку; отсутствие поля или пустая строка означают отсутствие ограничений

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

curl -X POST https://www.routeapi.ai/api/open/v1/keys \
  -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "bot",
    "remain_amount": 5.00,
    "unlimited": false,
    "expired_time": -1,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o"
  }'

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

{
  "success": true,
  "message": "",
  "data": {
    "id": 13,
    "name": "bot",
    "key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": 1,
    "created_time": 1729000000,
    "accessed_time": 1729000000,
    "expired_time": -1,
    "remain_amount": 5.00,
    "unlimited": false,
    "used_amount": 0.00,
    "model_limits_enabled": true,
    "model_limits": "gpt-4o",
    "allow_ips": ""
  }
}

Описание полей см. в Объект Key.

Ошибки

HTTP	code	Сценарий
400	`invalid_request`	Тело запроса не является корректным JSON либо пустое / `null`
400	`invalid_request`	`name` отсутствует, состоит из пробелов или длиннее 50 символов
400	`invalid_request`	`expired_time` не в будущем (и не равно `0` / `-1`) или позже 9999-12-31 (например, миллисекундный timestamp)
400	`invalid_request`	Достигнут лимит количества Key на пользователя
400	`invalid_request`	При `unlimited`, равном `false`, `remain_amount` отрицательна или превышает максимум

Прочие общие коды ошибок см. в Ошибки и лимиты.

Примечания

remain_amount игнорируется, когда unlimited равно true.
Создание Key через API платформы записывается в журнал аудита.