Разделы документации

Документация / Начало

API-ключ

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

Получить ключ

  1. Зарегистрируйтесь и подтвердите почту.
  2. Откройте раздел API-ключи в кабинете и создайте ключ.
  3. Скопируйте ключ сразу: полностью он показывается один раз. Потерянный ключ отзовите и создайте новый.
  4. Пополните баланс: каждый платный запрос резервирует свою наибольшую стоимость до отправки модели.

Передать ключ

Ключ передаётся заголовком Authorization: Bearer <ключ>. Адрес сервиса — https://api.aireplica.ru/v1.

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

Хранить ключ

  • Только на сервере, в переменной окружения или хранилище секретов — не в коде, не в браузере и не в мобильном приложении.
  • Отдельный ключ на каждое приложение: отзыв одного не остановит остальные.
  • Запросы без ключа и с отозванным ключом получают 401.