バッチスクレイプのステータス取得

GET /batch/scrape/{id}

バッチスクレイピングジョブのステータスを取得する

cURL

curl --request GET \
  --url https://api.firecrawl.dev/v2/batch/scrape/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "status": "<string>",
  "total": 123,
  "completed": 123,
  "creditsUsed": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "next": "<string>",
  "data": [
    {
      "markdown": "<string>",
      "html": "<string>",
      "rawHtml": "<string>",
      "links": [
        "<string>"
      ],
      "screenshot": "<string>",
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "language": "<string>",
        "sourceURL": "<string>",
        "url": "<string>",
        "keywords": "<string>",
        "ogLocaleAlternate": [
          "<string>"
        ],
        "<any other metadata> ": "<string>",
        "statusCode": 123,
        "error": "<string>"
      }
    }
  ]
}

承認

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

id · string<uuid> · 必須

バッチスクレイピングジョブのID

レスポンス

200

application/json

成功時のレスポンス

status · string

バッチスクレイプの現在のステータスです。scraping、completed、failed のいずれかです。

total · integer

スクレイピングを試みたページ数の合計。

completed · integer

正常にスクレイピングされたページ数。

creditsUsed · integer

バッチスクレイプに使用されたクレジット数。

expiresAt · string<date-time>

バッチスクレイピングの有効期限が切れる日時。

next · string | null

次の 10MB のデータを取得するための URL。バッチスクレイピングが完了していない場合、または応答が 10MB を超える場合に返されます。

data · object[]

バッチスクレイピングのデータ。

Show child attributes