数据 API / Firecrawl / Crawl

Submit an asynchronous crawl job.

Submit an asynchronous website crawl. url, limit and Idempotency-Key are required. HTTP 202 returns a job with its id and status; poll get_firecrawl_crawl_job until completed, failed or cancelled. The Location header identifies the Felo polling resource. Reusing an Idempotency-Key returns the existing job. Set limit to bound the crawl. 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.

请求体

urlstring必填
The HTTPS root URL to crawl. PDF URLs are not supported.
limitinteger必填
Maximum number of pages to crawl.
includePathsstring[]可选
Only crawl URLs whose path matches one of these patterns.
excludePathsstring[]可选
Skip URLs whose path matches one of these patterns.
maxDiscoveryDepthinteger可选
Maximum link-discovery depth from the root URL.
sitemapstring可选
允许值： skip · include · only
How the site's sitemap is used during discovery.
ignoreQueryParametersboolean可选
Treat URLs that differ only by query string as the same page.
crawlEntireDomainboolean可选
Crawl the whole domain rather than only the subtree under the root URL.
allowExternalLinksboolean可选
Follow links to external domains.
allowSubdomainsboolean可选
Follow links into subdomains of the root domain.
delaynumber可选
Delay in seconds between requests (0 to 30).
maxConcurrencyinteger可选
Maximum number of concurrent page fetches (1 to 20).
scrapeOptionsobject可选
Per-page scrape options applied while crawling. On the metered profile output is always markdown.
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/crawl" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Idempotency-Key: <string>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "limit": 0,
  "includePaths": [
    "<string>"
  ],
  "excludePaths": [
    "<string>"
  ],
  "maxDiscoveryDepth": 0,
  "sitemap": "<string>",
  "ignoreQueryParameters": false,
  "crawlEntireDomain": false
}'

响应

响应字段

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.