Felo API PlatformFelo API Platform

データ API / Firecrawl / Batch Scrape

Submit an asynchronous batch scrape job.

Submit an asynchronous scrape for multiple URLs. urls and Idempotency-Key are required. HTTP 202 returns a job; poll get_firecrawl_batch_scrape_job until completed, failed or cancelled. The Location header identifies the Felo polling resource. Reusing an Idempotency-Key returns the existing job. Job pricing fields are provider metadata, not Felo billing records.

パラメータ

ヘッダー

  • Idempotency-Keystring必須

    Unique key (1 to 191 characters) that makes the submit idempotent. Re-submitting with the same key returns the original job.

リクエストボディ

  • urlsstring[]必須

    1 to 1000 unique HTTPS URLs to scrape. PDF URLs are not supported.

  • maxConcurrencyinteger任意

    Maximum number of concurrent scrapes (1 to 20).

  • onlyMainContentboolean任意

    Return only the main content of each page.

  • includeTagsstring[]任意

    HTML tags/selectors to keep.

  • excludeTagsstring[]任意

    HTML tags/selectors to drop.

  • maxAgeinteger任意

    Maximum acceptable cache age in milliseconds.

  • minAgeinteger任意

    Minimum cache age in milliseconds before a page is refetched.

  • timeoutinteger任意

    Per-page timeout in milliseconds.

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/firecrawl/batch-scrape" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Idempotency-Key: <string>" \
  -H "Content-Type: application/json" \
  -d '{
  "urls": [
    "<string>"
  ],
  "maxConcurrency": 0,
  "onlyMainContent": false,
  "includeTags": [
    "<string>"
  ],
  "excludeTags": [
    "<string>"
  ],
  "maxAge": 0,
  "minAge": 0,
  "timeout": 0
}'

レスポンス

レスポンスのフィールド

  • idstring任意

    Job identifier. Use it with the corresponding Felo polling endpoint.

  • objectstring任意

    Always "integration_async_job".

  • endpointstring任意

    Provider operation identifier stored with the job. This metadata is not a Felo polling URL; use the documented Felo job path or Location header.

  • statusstring任意

    指定できる値: queued · running · completed · failed · cancelled

    Customer-facing lifecycle status. queued and running are non-terminal; completed, failed, and cancelled are terminal.

  • createdAtstring任意

    When the job was accepted.

  • completedAt任意

    When the job reached a terminal status. Null while the job is still queued or running.

  • pricingobject任意
  • currencystring任意
  • authorizedMicrosUSDinteger任意

    Provider authorization metadata in micro-USD. This is not a Felo credit hold or billing record.

  • finalMicrosUSD任意

    Provider settlement metadata in micro-USD, nullable before settlement. This is not the Felo charge.

  • billingModestring任意

    Provider job billing mode. Felo charges follow Felo billing records.

  • output任意

    Job result payload. Present only once status is completed. For Agent Runs this is the structured research result.

  • outputExpiredboolean任意

    True when the result has been retained past its retention window and is no longer retrievable.

  • error任意

    Present when status is failed. Null otherwise.