Синхронные запросы

Описание

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

Параметр is_sync

Для выполнения синхронной генерации в запросе необходимо указать параметр is_sync со значением true.

Если параметр не указан или установлен в false, запрос будет обработан асинхронно.

Принцип работы

  1. Клиент отправляет запрос с параметром is_sync = true
  2. Сервер начинает обработку запроса немедленно
  3. Соединение остается открытым до завершения генерации
  4. После завершения обработки результат возвращается в теле ответа

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

Ответ API

При успешной синхронной генерации API сразу возвращает результат и статус success.

Пример ответа:

В случае ошибки ответ будет возвращён со статусом error.

Рекомендации

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