Ключи и доступ
Как создать API-ключ, ограничить модели и расход, отозвать ключ.
API-ключ работает от имени организации и тратит её баланс. Лимиты ключа считаются в рублях. Ключи создаются в кабинете, в разделе «API-ключи».
Участник видит, меняет и отзывает только свои ключи. Владелец и администратор организации видят и меняют все ключи.
Создать ключ
- Откройте форму
В разделе «API-ключи» нажмите «Создать ключ».
- Назовите ключ
Поле «Название» обязательное, до 100 символов. Отдельный ключ на каждый инструмент или сервис покажет их расход отдельными строками.
- Задайте срок, модели и лимиты
Все поля ниже необязательны. Если срок пуст, ключ не истекает.
- Сохраните секрет
После создания ключ показан целиком один раз. Потом его не восстановить, можно только выпустить новый. Окно закрывается кнопкой «Я сохранил ключ».
Если форма пишет «Эта функция отключена в вашей организации», функцию «API-ключи» выключили в настройках доступов. Включить её может владелец или администратор.
Использовать ключ
Положите ключ в переменную окружения и передавайте в заголовке:
export MORPHOGEN_API_KEY=mg-...
curl https://api.morphogen.ru/v1/models \
-H "Authorization: Bearer $MORPHOGEN_API_KEY"Заголовок x-api-key: <ключ> принимается так же. Не записывайте ключ в репозиторий и не печатайте его в логах.
Модели и лимиты
Флажок «Полный доступ» включён по умолчанию: ключ работает со всеми моделями организации, кроме запрещённых владельцу ключа. Если снять флажок, отметьте нужные модели в списке. Нужна хотя бы одна модель.
Лимиты ключа:
| Поле | Значение |
|---|---|
| «Лимит в день, ₽» | сумма в рублях, например 500 или 12,5 |
| «Лимит в месяц, ₽» | то же за месяц |
Правила лимитов:
- Пустое поле значит «без лимита». Ноль значит нулевой лимит: любой платный запрос получит 402
key_limit_exceeded. Так ключ замораживают без отзыва. - День и месяц считаются по московскому времени.
- Запрос отклоняется, если вместе с ним расход за день или месяц превысил бы лимит.
- Кроме лимитов ключа действуют лимиты расхода сотрудника, команды и организации.
По умолчанию у ключа 120 запросов и 200 000 токенов в минуту. На странице ключа скорость не меняется. Подробнее: Лимиты.
Изменить ключ
В строке ключа нажмите значок карандаша. Можно поменять название, срок, модели и лимиты. «Проект» и «Команду» после создания менять нельзя. Если у истёкшего ключа поставить новую дату или очистить срок, он снова станет активным. Отозванный ключ изменить нельзя.
Отозвать ключ
Нажмите значок корзины в строке ключа и подтвердите. Запросы с этим ключом перестанут проходить в течение нескольких секунд, действие нельзя отменить. Потерянный или скомпрометированный ключ отзовите и выпустите новый.
Когда сотрудник выходит из организации, все его ключи отзываются автоматически. Если сотруднику позже выключить функцию «API-ключи», его выпущенные ключи тоже перестанут работать: API ответит 401.
Ошибки ключа
| Код | Причина |
|---|---|
| 401 | ключ не передан, неверный, отозван или истёк |
403 model_not_allowed | модели нет в списке ключа или она запрещена владельцу |
402 key_limit_exceeded | исчерпан дневной или месячный лимит ключа |
402 spend_limit_exceeded | исчерпан лимит расхода сотрудника, команды или организации |
Все коды: Ошибки.