Справочник API
Перед запуском
Пройдите этот чек-лист перед запуском в продакшен. Он объединяет безопасность ключей, повторы, надёжность асинхронных задач, наблюдаемость и оплату в одну проверку перед запуском.
#Чек-лист для продакшена
Безопасность
- Храните API-ключи на доверенных серверах; никогда не встраивайте постоянный ключ в браузерный код или мобильное приложение.
- Используйте отдельный ключ с ограничениями для каждого проекта и настройте ограничения по моделям, IP, RPM, RPD и квоте.
- Меняйте ключи, не трогая код интеграции с моделями.
Надёжность
- Задавайте тайм-ауты подключения и ответа для каждого запроса.
- Учитывайте Retry-After и используйте экспоненциальную задержку со случайным разбросом.
- Используйте Idempotency-Key для платных асинхронных задач и сохраняйте task_id.
Наблюдаемость
- Логируйте ID запроса, модель, эндпоинт, задержку, HTTP-статус и task_id.
- Не пишите содержимое промптов в логи, если отладка не включена явно.
- Связывайте видимые клиенту ошибки с соответствующей строкой журнала запросов.
Контроль расходов
- Берите цены и поддерживаемые параметры из актуальных метаданных моделей.
- Задайте пределы квоты для проектов и настройте оповещения до того, как кошелёк опустеет.
- Сверяйтесь с итоговым расходом с точностью до шести знаков в журнале запросов.
#Проверка перед запуском
- 1
Проверьте минимальный запрос
Запустите нужную модель и эндпоинт в Workbench, затем скопируйте сгенерированный запрос.
- 2
Проверьте сценарии ошибок
Проверьте обработку 401, 402, 429, тайм-аутов, некорректных медиафайлов и окончательного сбоя задачи.
- 3
Проверьте списания
Сопоставьте успешный запрос с его расходом (шесть знаков после запятой) и ID запроса.
- 4
Включите мониторинг
Настройте оповещения о доле ошибок, задержке, зависших задачах, сбоях вебхуков и низком балансе.
#Быстрые ссылки
Проблема не решена?
Пришлите нам ID запроса или текст ошибки, и мы разберёмся.