資料 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.