Спецификация API

Отправьте первый запрос, выберите модель по каталогу и сохраните идентификатор запроса для диагностики.

Передавайте API-ключ в заголовке Bearer и отделяйте ключи серверных сред от ключей разработки.

Используйте разные базовые URL для OpenAI-style и Messages-клиентов: оба обращаются к одной спецификации, но формируют путь по-разному.

Настраивайте клиент с ключом, моделью и базовым URL, соответствующим именно его протоколу; секрет остаётся в окружении.

Короткие ответы на практические вопросы о ключах, базовых URL, моделях, стоимости и диагностике интеграции.

Стройте выбор модели на данных каталога, а не на захардкоженном списке в приложении.

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

Учитывайте лимиты ключа, организации, модели и маршрута как часть пользовательского сценария.

Связывайте метаданные ответа и собственные request logs с реальными действиями пользователя.

Минимизируйте передаваемые данные, отделяйте идентификатор пользователя от содержимого и контролируйте срок хранения в своём продукте.

Создавайте многоходовые диалоги в привычном формате messages и выбирайте модель на каждый запрос.

Используйте формат Messages для диалогов с верхнеуровневой системной инструкцией и явным ограничением ответа.

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

Получайте токены и структурированные дельты через SSE, не дожидаясь полного ответа.

Опишите функции JSON Schema, выполните вызов в своём приложении и верните результат обратно в историю.

Запрашивайте JSON-объект или JSON Schema, когда ответ будет потреблять программа, а не человек.

Настраивайте усилие рассуждения на запросе только для моделей, которые объявляют эту возможность.

Выражайте требования к выполнению в provider preferences и сохраняйте фактический результат для наблюдаемости.

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

Организуйте поиск свежих источников через client-executed функцию `web_search` и сохраняйте ссылки отдельно от сгенерированного текста.

Загружайте файл отдельной операцией, храните его id и передавайте ссылку на него в последующем совместимом запросе.

Создавайте изображения через единый маршрут и выбирайте параметры по возможностям конкретной модели.

Запускайте видео как асинхронную задачу, сохраняйте id задачи и отделяйте создание от чтения результата.

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

Преобразуйте текст или поддерживаемые входы в векторы для поиска, кластеризации и рекомендаций.

Пересортируйте небольшой набор кандидатов относительно запроса, чтобы повысить точность финальной выдачи.

Обрабатывайте независимые операции контролируемыми группами, когда сценарий допускает асинхронную выдачу.

Подключайте AI-клиент к разрешённым инструментам, ресурсам и промптам через URL соединения, выданный настройками аккаунта.

Стройте обработку по HTTP-статусу, структурированному телу ошибки и request id, а не по тексту сообщения.