provod.ai / docs
API

Авторизация API-запросов

Используйте ключ API provod.ai в заголовке Bearer.

Обновлено

Создайте и сохраните ключ

Откройте раздел API-ключей в кабинете, проверьте активное рабочее пространство и создайте ключ с названием сервера или проекта. Полный ключ показывается один раз. Позже в кабинете останутся только название и маскированный префикс: по нему можно безопасно указать ключ при обращении в поддержку.

Сразу сохраните полный ключ в переменной окружения сервера или менеджере секретов:

Terminal
export PROVOD_API_KEY="sk_..."

Не передавайте ключ в браузер

Не помещайте ключ API в клиентский код, публичную сборку для браузера, репозиторий, скриншоты или сообщения поддержке. Браузер должен обращаться к вашему авторизованному серверу, а уже сервер — к provod.ai.

Ключ provod.ai добавляется к запросу до его отправки в API.

Bearer-авторизация для публичных форматов API.

Передавайте ключ через Bearer-авторизацию

API читает ключ из заголовка Authorization. До настройки SDK или инструмента для разработки проверьте ключ запросом списка моделей:

Terminal
curl --fail-with-body --silent --show-error https://api.provod.ai/v1/models \
  -H "Authorization: Bearer $PROVOD_API_KEY"

Успешный ответ содержит object: "list" и массив data. Выберите доступную модель и скопируйте её точный id; не сохраняйте список моделей из старой инструкции. В каталоге также может быть указана причина, по которой модель недоступна активному рабочему пространству.

Разделяйте проекты и безопасно меняйте ключи

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

Если ключ потерян, раскрыт или больше не нужен, отзовите его в кабинете. Чтобы заменить ключ без простоя, сначала создайте новый, обновите секрет на сервере, повторите с ним GET /v1/models и только после этого отзовите старый. Восстановить отозванный ключ нельзя.

Подготовьте безопасные данные для диагностики

Публичный код ошибки — это предназначенное для клиента значение, например error.code в ответе API. Сохраните этот код, HTTP-статус, адрес, идентификатор модели, примерное время с часовым поясом и маскированный префикс ключа. Не прикладывайте полный ключ или чувствительное содержимое запроса.

Решение проблем

На этой странице