Ключи API

Ключ API даёт приложению доступ к публичному API Gateway. Ключ всегда принадлежит рабочему пространству.

Создание ключа

При создании задайте имя и, если нужно, описание. Сырой ключ показывается только один раз.

Ключ может быть сервисным или личным.

Сервисный ключ нужен приложению, воркеру или production-интеграции. Он не привязан к человеку.

Личный ключ привязан к участнику команды. Он подходит для разработки, отладки и сценариев, где важно видеть использование конкретного человека.

Хорошие имена:

• Production backend;
• Staging jobs;
• Support bot;
• Analytics worker.

Плохие имена: key, test, new, 123. Через них трудно разбирать логи.

Ограничения

Для ключа можно настроить:

• разрешённые модели;
• доступ к Tools API;
• запросы в минуту;
• токены в минуту;
• срок действия;
• расписание доступности.

Если поле «разрешённые модели» пустое, ключ может использовать все модели, доступные организации и тарифу.

Переключатель Tools API управляет только маршрутами /v1/tools/* для этого ключа. Если он выключен, модельные маршруты продолжают работать по остальным правилам ключа, а Tools API вернёт ошибку tool_key_disabled.

Статусы

Активный ключ принимает запросы.

Выключенный ключ сохраняется в Дашборде, но запросы с ним не проходят.

Отозванный или удалённый ключ больше нельзя использовать. Если приложение продолжает отправлять запросы с таким ключом, оно получит ошибку авторизации.

Страница ключа

На странице отдельного ключа видны настройки, графики и запросы, связанные с этим ключом. Для организаций с доступом к Tools API модельные запросы и tool requests показываются отдельно. Это удобно, когда нужно понять, какое приложение создаёт нагрузку или ошибки.

Если ключ личный, в списке и на странице ключа виден владелец. Эта привязка также используется в аналитике команды.

Ротация ключей

Безопасная ротация:

1. Создайте новый ключ.
2. Добавьте его в окружение приложения.
3. Перезапустите приложение.
4. Убедитесь, что запросы идут с нового ключа.
5. Отзовите старый ключ.