Data 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.