Перейти до основного вмісту
POST
/
v1
/
jobs
Async jobs
curl --request POST \
  --url https://scrape.cleariflow.com/v1/jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "request": {},
  "priority": 123
}
'
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Початок роботи

Базовий URL

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

Створення завдання

Поставте асинхронний скрейпінг у чергу з тим самим payload ScrapeRequest, що використовує синхронний ендпоінт.

Приклад запиту

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

Параметри створення завдання

request
Object
обов'язково
Об’єкт ScrapeRequest з тими самими полями, що й синхронний ендпоінт скрейпінгу (url, render, actions, cookies тощо).
priority
Integer
Пріоритет завдання. Вищі значення обробляються першими. За замовчуванням: 0.

Отримання статусу завдання

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

Базовий URL

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

Приклад запиту

curl 'https://scrape.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,
    "html": "<!DOCTYPE html><html>...</html>",
    "meta": {
      "url": "https://example.com",
      "status_code": 200,
      "duration_ms": 8123
    }
  }
}

Значення статусу завдання

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

Параметри відповіді

job_id
String
Унікальний ідентифікатор асинхронного завдання.
status
String
Поточний статус завдання: queued, running, done або failed.
result
Object
Об’єкт результату скрейпінгу (та сама структура, що й відповідь синхронного ендпоінта). Присутній, коли statusdone.
error
String
Повідомлення про помилку. Присутнє, коли statusfailed.
meta
Object
Додаткові метадані про виконання завдання.