Получить пример вызова программного интерфейса¶

Перед началом¶

Проверьте. Откройте страницу запроса к конкретному сервису. Его точка вызова и контракт должны быть опубликованы.
Подготовьте. Разрешенное место для примера. Оставьте показанные порталом заполнители до настройки разрешенного клиентского контура.

Выполните¶

На странице запроса откройте Примеры вызова.
Выберите вариант curl, Python requests или Node fetch; для совместимого протокола также доступен OpenAI Python.
Оставьте заполнитель <API_KEY> в тексте примера.
Скопируйте пример в разрешенный файл или средство разработки.

Проверьте результат¶

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

Если не получилось¶

Раздела Примеры вызова нет. Пример для этого сервиса не опубликован; адрес и тело не придумывайте.
Адрес пуст. Проверьте готовность развертывания или одобрение доступа.
Пример содержит другой идентификатор решения. Вернитесь на страницу нужного сервиса и сформируйте пример заново.
Тело не соответствует полям вкладки Вызов. Сохраните идентификатор решения и передайте расхождение роли developer.
Ключ оказался в файле или записи экрана. Прекратите использование ключа и отзовите его поддерживаемым действием.

Завершите работу¶

Действие Подставить мой ключ показывает действующий секрет на экране. Не используйте его во время демонстрации или записи. Храните ключ отдельно от примера.