Request status
GET /v1/requests/{request_id}/status — check a generation's status.
Check the status of a previously submitted generation by its request_id.
Playground
API-ключ в заголовке Authorization со схемой Bearer:
Authorization: Bearer clipia_live_xxxxxxxxxxxxxxxxxxxxxxПередавайте полную строку, включая префикс схемы Bearer и пробел.
Также принимаются Authorization: Key <ключ> и заголовок
X-Api-Key: <ключ> — выбирайте удобную схему.
Ключ создаётся в личном кабинете (Настройки → API-ключи) и показывается
один раз. Формат: clipia_live_… (боевой), clipia_test_… (песочница).
Sandbox / тестовый режим. Ключ с префиксом clipia_test_… работает в
песочнице: submit не списывает кредиты и не запускает реальную
генерацию — он мгновенно возвращает status: COMPLETED с детерминированным
mock-результатом (фиксированный sample-ассет на media.clipia.ai). Поле
cost показывает расчётную стоимость, но она не списывается. Вебхуки
приходят тем же подписанным механизмом (HMAC-SHA256). Режим предназначен
для отладки интеграции до подключения боевого ключа.
In: header
Path Parameters
Идентификатор запроса генерации, полученный при submit.
uuidResponse Body
curl -X GET "https://api.clipia.ai/v1/requests/764cabcf-b745-4b3e-ae38-1200304cf45b/status"{
"request_id": "764cabcf-b745-4b3e-ae38-1200304cf45b",
"status": "IN_PROGRESS",
"queue_position": null,
"progress": 45,
"logs": []
}{
"error": {
"type": "invalid_request_error",
"code": "invalid_api_key",
"message": "API-ключ отсутствует, неверный или отозван."
}
}{
"error": {
"type": "invalid_request_error",
"code": "not_found",
"message": "Запрос с таким идентификатором не найден."
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Превышен лимит запросов. Повторите позже."
}
}GET /v1/requests/:id/status returns the current generation status, queue position, and execution progress. The endpoint is available to any valid key — no scope required.
/v1/requests/:id/statusRequest
Prop
Type
curl https://api.clipia.ai/v1/requests/764cabcf-b745-4b3e-ae38-1200304cf45b/status \
-H "Authorization: Bearer $CLIPIA_KEY"const status = await clipia.queue.status('764cabcf-b745-4b3e-ae38-1200304cf45b');
console.log(status.status, status.progress);status = client.status("764cabcf-b745-4b3e-ae38-1200304cf45b")
print(status.status, status.progress)Response 200
{
"request_id": "764cabcf-b745-4b3e-ae38-1200304cf45b",
"status": "IN_PROGRESS",
"queue_position": null,
"progress": 45,
"logs": []
}Prop
Type
Fetching the result
The same request without the /status suffix — GET /v1/requests/:id — returns the final result with an output field once the status is terminal, or 202 while the generation is still queued or running.
curl https://api.clipia.ai/v1/requests/764cabcf-b745-4b3e-ae38-1200304cf45b \
-H "Authorization: Bearer $CLIPIA_KEY"Which to use
Use /status for lightweight progress polling. Fetch the actual result with media URLs via GET /v1/requests/:id (see the Result page). If you passed webhook_url at submit, you do not need to poll status at all.