メインコンテンツへスキップ
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

ジョブの作成

同期エンドポイントと同じ 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
  }'
成功したリクエストはジョブ ID を返します:
{
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

ジョブ作成パラメータ

request
Object
必須
同期スクレイピングエンドポイントと同じフィールド(urlrenderactionscookies など)を持つ ScrapeRequest オブジェクト。
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
現在のジョブステータス: queuedrunningdonefailed
result
Object
スクレイピング結果オブジェクト(同期エンドポイントレスポンスと同じ構造)。statusdone の場合に返されます。
error
String
エラーメッセージ。statusfailed の場合に返されます。
meta
Object
ジョブ実行に関する追加メタデータ。