Перейти до основного вмісту
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
Додаткові метадані про виконання задачі.