Queue

Результат запроса

Возвращает результат генерации (200) когда статус терминальный (COMPLETED / FAILED), либо 202 пока запрос ещё в очереди или выполняется. Доступно любому валидному ключу (scope не требуется).

Все медиа-URL ведут на CDN media.clipia.ai.

Если при исполнении сервер отступил от параметров запроса, ответ (и 200 для COMPLETED, и 202) содержит массив warnings. Сейчас причина одна — audio_dropped: звук был включён, но звуковая дорожка не прошла проверку безопасности модели, и ролик создан без звука. Стоимость запроса при этом не меняется.

get/v1/requests/{request_id}

Request

  • Base URL: https://api.clipia.ai
  • URL: https://api.clipia.ai/v1/requests/{request_id}
  • Auth: API key in header Authorization

Path parameters

request_idstring uuid required
Example:764cabcf-b745-4b3e-ae38-1200304cf45b

Идентификатор запроса генерации, полученный при submit.

Response

Терминальный результат. Для COMPLETED содержит output; для FAILED — санитизированный error.

request_idstring uuid required

Идентификатор запроса генерации.

status'IN_QUEUE' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'CANCELED' required

Статус генерации в очереди. CANCELED — терминальный: генерацию можно отменить вне публичного API (например, из веб-интерфейса Clipia); cancel-эндпоинта в публичном API нет, но status может вернуть CANCELED, поэтому клиент обязан считать его финальным.

modelstring required

Slug модели, выполнившей генерацию.

outputobject required

Результат генерации. Для изображений — images: [{ url, original_url? }] (url — оптимизированный WebP для показа; original_url — полноразмерный оригинал PNG/JPG для скачивания, когда доступен); для видео — video: { url, original_url?, thumbnail_url? } (thumbnail_url — статичный кадр-обложка от провайдера, доступен не для всех моделей); для аудио (TTS, музыка) — audio: { url, format? } и audios: [{ url, format? }]. Музыкальные модели отдают несколько вариантов трека за один запрос: audios содержит их все, audio — первый из них (первый элемент audios совпадает с audio). Все медиа-URL ведут на CDN media.clipia.ai.

Полей width, height и duration в ответе нет: размеры и длительность читайте из самого файла. original_url и thumbnail_url заполняются не всегда — считайте их опциональными.

costnumber required

Стоимость генерации в кредитах. Пока запрос в работе — резерв; после завершения — фактически списанное. При FAILED и CANCELED резерв возвращается, поле равно 0.

created_atstring date-time required

Время создания запроса (ISO 8601).

completed_atstring date-time

Время завершения генерации (ISO 8601).

Example response

{
  "model": "nano-banana-2",
  "error": {
    "code": "generation_failed",
    "message": "Generation failed. Please retry or contact support."
  },
  "warnings": [
    {
      "code": "unsupported_parameter",
      "parameter": "duration",
      "message": "Parameter \"duration\" is not supported by model \"nano-banana-2\" and was ignored. Parameters declared by this model: aspect_ratio, prompt, resolution. Full schema: GET /v1/models/nano-banana-2."
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.