API-ключ даёт приложению программный доступ к моделям через Nevel. Ключ создаётся в выбранном рабочем пространстве и должен использоваться с адресом API этой установки. Эта инструкция описывает выдачу и управление ключом в интерфейсе; формат запроса, выбор модели и настройка клиента приведены в первом запросе к API.#
Подготовьте назначение ключа#
Создавайте отдельный ключ для каждого приложения и среды, если ими нужно независимо управлять. Например, «CRM — тест» и «CRM — рабочая среда» позволяют различать расход и отключить тестовый клиент, не затрагивая рабочий. Один ключ на весь отдел делает анализ и замену сложнее.#
До создания определите, кто отвечает за приложение, где хранится секрет и какой расход допустим. Название в Nevel должно помогать найти владельца и назначение, но не содержать сам секрет. Для первого подключения полезен небольшой согласованный лимит, который можно изменить после проверки запросов.#
Откройте раздел ключей#
Выберите нужное рабочее пространство и откройте его «Настройки». Перейдите в «API Ключи». Раздел доступен пользователям с разрешением управления ключами; его отсутствие у обычного участника не означает, что API не существует. В таком случае ключ выдаёт администратор с соответствующим доступом.#
В таблице есть название, сокращённый ключ, создатель, дата создания, сведения об использовании, лимит расходов и статус. Поле «Поиск по ключу, названию или создателю» помогает найти запись. Ввод полного секрета для поиска не нужен: используйте название или отображаемый префикс.#
Создайте ключ и сохраните секрет#
- Нажмите «Добавить ключ».
- В окне «Создать API ключ» заполните «Название ключа».
- При необходимости задайте «Кредитный лимит, USD».
- Если лимит указан, выберите «Сброс лимита».
- Нажмите «Добавить ключ» и дождитесь сообщения «Ключ успешно создан».
- Скопируйте показанный секрет и поместите его в хранилище секретов приложения.
- Только после сохранения нажмите «Готово» и закройте окно.
Полный ключ показывается один раз. При повторном открытии списка вы увидите сведения о ключе, но не сможете восстановить секрет из его сокращённого значения. Если закрыли окно, не сохранив ключ, создайте новый и удалите или отключите неиспользуемый.#
Не вставляйте ключ в публичный репозиторий, браузерный код, пример документации или сообщение обычного чата. Для серверного приложения используйте переменную окружения или секрет, доступный процессу выполнения. В примерах документации переменная называется NEVEL_API_KEY; её значение подставляет ваша среда, а не текст страницы.#
Настройте лимит расходов#
Поле принимает положительную сумму в USD с точностью до шести знаков после десятичной точки. Пустое поле означает «Без лимита» для этого ключа. Это не отменяет других ограничений рабочего пространства и доступности моделей.#
| Сброс | Как работает период |
|---|---|
| «Ежедневно в 00:00 UTC» | Доступный бюджет ключа обновляется по суточной границе UTC |
| «Еженедельно в понедельник, 00:00 UTC» | Сброс привязан к началу недели UTC |
| «Ежемесячно первого числа, 00:00 UTC» | Сброс привязан к календарному месяцу UTC |
| «Никогда» | Лимит не получает автоматического периодического сброса |
Например, тестовый бюджет 10 USD с вариантом «Никогда» задаёт суммарное ограничение ключа, а не ежедневный бюджет. Это пример настройки, а не стоимость тарифа и не обещанное число запросов. Сумма, расходуемая на запрос, зависит от модели и объёма работы.#
В таблице могут отображаться остаток, «Лимит исчерпан», дата будущего сброса и зарезервированная сумма. Резерв связан с ещё не завершённым учётом запросов; не сравнивайте его с финальным расходом как с отдельной оплаченной услугой. Подробные ограничения описаны в аутентификации и лимитах API.#
В таблице также предусмотрена колонка «Истекает». При этом текущая форма создания ключа не содержит отдельного выбора срока действия. Не планируйте автоматическое истечение по полю, которого нет в форме: для управляемой замены используйте отключение и создание нового ключа.#
Проверьте подключение#
Используйте выданный вашей установке NEVEL_BASE_URL, сохранённый NEVEL_API_KEY и доступный NEVEL_MODEL в примере API. Адрес страницы браузерной платформы и адрес API могут отличаться; копирование URL открытого чата не настраивает клиента.#
Отправьте короткий запрос без рабочих данных. Убедитесь, что получен ожидаемый ответ, затем посмотрите колонку «Использован» и аналитику. Наличие строки ключа подтверждает создание, а успешный запрос — работоспособность адреса, секрета и выбранной модели вместе.#
Если запрос не проходит, не выдавайте сразу несколько новых ключей. Сначала отличите неверную авторизацию, недоступную модель, исчерпанный лимит и сетевую ошибку. Для диагностики сохраняйте код ответа и ID запроса; передавать полный секрет в обращении не нужно.#
Измените, отключите или замените ключ#
В меню строки выберите «Редактировать». Можно изменить название, сумму и период сброса, затем нажать «Сохранить». Переименование не меняет сам секрет и не требует изменения конфигурации приложения.#
«Отключить» прекращает использование ключа для новых обращений; «Включить» возвращает его в работу. Это удобно, когда нужно остановить конкретную интеграцию и сохранить запись для дальнейшего разбора. При подозрении на раскрытие секрета используйте отключение и замену, а не только смену названия.#
Чтобы заменить ключ без лишнего перерыва, создайте новый, сохраните его в приложении, выполните проверочный запрос и затем отключите прежний. Если старый секрет уже раскрыт, сначала отключите его, даже если восстановление работы потребует времени. «Удалить» применяйте к ключу, который окончательно выведен из использования; убедитесь, что в приложениях не осталось его конфигурации.#
Размещение платформы и маршруты обработки#
В облаке ключ используется с облачным API и доступными вашей организации моделями. Пользовательский интерфейс помогает управлять его расходом; финансовые условия приведены в тарифах.#
При установке Platform/API в контуре ключ выдаётся этой установкой и используется с её адресом API. Облачный ключ нельзя считать действующим в локальной установке, а локальный — в облачной. Хранилище секретов, сетевой доступ и замена ключей организуются для соответствующей инфраструктуры.#
Адрес API определяет точку входа, но не место выполнения модели. За ним могут быть разрешённые модели заказчика, российские провайдеры или глобальные модели; в облачном Nevel доступна также self-hosted DeepSeek на серверах в РФ. Убедитесь, какой маршрут соответствует выбранному NEVEL_MODEL. Только изолированный профиль ограничивает выполнение внутренними ресурсами. Сам ключ не выдаёт разрешение на внешний маршрут.#