Перейти к основному содержанию
POST
/
v1
/
jobs
Асинхронные задачи
curl --request POST \
  --url https://screenshot.cleariflow.com/v1/jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {},
  "priority": 123
}
'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Начало работы

​
Базовый URL

https://screenshot.cleariflow.com/v1/jobs

​
Создание задачи

Поставьте асинхронный скриншот в очередь с тем же payload ScreenshotRequest, что использует синхронный эндпоинт.

​
Пример запроса

curl -X POST 'https://screenshot.cleariflow.com/v1/jobs' \
  -H 'Content-Type: application/json' \
  -d '{
    "request": {
      "api_key": "YOUR_UNIQUE_API_KEY",
      "url": "https://cleariflow.com"
    },
    "priority": 10
  }'
Успешный запрос возвращает идентификатор задачи: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

​
Параметры создания задачи

​
request
Object
обязательно
Объект ScreenshotRequest с теми же полями, что и синхронный эндпоинт скриншота (url, render, actions, cookies и т. д.).
​
priority
Integer
Приоритет задачи. Более высокие значения обрабатываются первыми. По умолчанию: 0.

​
Получение статуса задачи

Опрашивайте задачу по ID, чтобы проверить статус и получить результаты после завершения.

​
Базовый URL

https://screenshot.cleariflow.com/v1/jobs/{job_id}

​
Пример запроса

curl 'https://screenshot.cleariflow.com/v1/jobs/550e8400-e29b-41d4-a716-446655440000'
Во время выполнения задачи: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "running"
}
После успешного завершения: 
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "done",
  "result": {
    "ok": true,
    "image_base64": "/9j/4AAQSkZJRg...",
    "content_type": "image/jpeg",
    "meta": {
      "elapsed_ms": 8123
    }
  }
}

​
Значения статуса задачи

СтатусОписание
queuedЗадача ожидает в очереди.
runningСессия браузера активна.
doneСкриншот готов; result содержит результат.
failedСкриншот не удался; error содержит описание ошибки.

​
Параметры ответа

​
job_id
String
Уникальный идентификатор асинхронной задачи.
​
status
String
Текущий статус задачи: queued, running, done или failed.
​
result
Object
Объект результата скриншота (та же структура, что и ответ синхронного эндпоинта). Присутствует, когда status — done.
​
error
String
Сообщение об ошибке. Присутствует, когда status — failed.
​
meta
Object
Дополнительные метаданные о выполнении задачи.