ИнференсНачало работы

Ключ API

Как создать ключ API в кабинете, как передавать его в запросах и что делать, если он попал в чужие руки.

Ключ API — это пароль вашей программы. По нему API Yenisei узнаёт, чей это запрос, с какого аккаунта списать кредиты и какие модели доступны. Ключ нужен для каждого запроса к моделям.

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

Ключи создаются в кабинете: откройте console.yenisei.ru, перейдите в раздел «Ключи» и нажмите «Создать ключ». Ключ показывается только один раз, поэтому сразу скопируйте его в надёжное место.

Ключ начинается с sk-yn-.

Передача ключа в запросе

Ключ передаётся в заголовке Authorization после слова Bearer:

curl https://api.yenisei.ru/v1/models \
  -H "Authorization: Bearer $YENISEI_KEY"

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

Что делать, если ключ утёк

Удалите ключ в кабинете и создайте новый. Старый ключ перестанет работать сразу после удаления.

Что доступно по ключу

Ключ работает от имени вашего аккаунта: ему доступны те же модели и те же лимиты расхода, что и вашему тарифу. Если запросить модель, которой нет в тарифе, API ответит ошибкой model_not_allowed. Подробнее на странице Коды ошибок.