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

Parameters

header

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

Request body

urlstringRequired
The HTTPS root URL to crawl. PDF URLs are not supported.
limitintegerRequired
Maximum number of pages to crawl.
includePathsstring[]Optional
Only crawl URLs whose path matches one of these patterns.
excludePathsstring[]Optional
Skip URLs whose path matches one of these patterns.
maxDiscoveryDepthintegerOptional
Maximum link-discovery depth from the root URL.
sitemapstringOptional
Allowed values: skip · include · only
How the site's sitemap is used during discovery.
ignoreQueryParametersbooleanOptional
Treat URLs that differ only by query string as the same page.
crawlEntireDomainbooleanOptional
Crawl the whole domain rather than only the subtree under the root URL.
allowExternalLinksbooleanOptional
Follow links to external domains.
allowSubdomainsbooleanOptional
Follow links into subdomains of the root domain.
delaynumberOptional
Delay in seconds between requests (0 to 30).
maxConcurrencyintegerOptional
Maximum number of concurrent page fetches (1 to 20).
scrapeOptionsobjectOptional
Per-page scrape options applied while crawling. On the metered profile output is always markdown.
onlyMainContentbooleanOptional
Return only the main content of each page.
includeTagsstring[]Optional
HTML tags/selectors to keep.
excludeTagsstring[]Optional
HTML tags/selectors to drop.
maxAgeintegerOptional
Maximum acceptable cache age in milliseconds.
minAgeintegerOptional
Minimum cache age in milliseconds before a page is refetched.
timeoutintegerOptional
Per-page timeout in milliseconds.

Example request

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
}'

Response

Response fields

idstringOptional
Job identifier. Use it with the corresponding Felo polling endpoint.
objectstringOptional
Always "integration_async_job".
endpointstringOptional
Provider operation identifier stored with the job. This metadata is not a Felo polling URL; use the documented Felo job path or Location header.
statusstringOptional
Allowed values: queued · running · completed · failed · cancelled
Customer-facing lifecycle status. queued and running are non-terminal; completed, failed, and cancelled are terminal.
createdAtstringOptional
When the job was accepted.
completedAtOptional
When the job reached a terminal status. Null while the job is still queued or running.
pricingobjectOptional
currencystringOptional
authorizedMicrosUSDintegerOptional
Provider authorization metadata in micro-USD. This is not a Felo credit hold or billing record.
finalMicrosUSDOptional
Provider settlement metadata in micro-USD, nullable before settlement. This is not the Felo charge.
billingModestringOptional
Provider job billing mode. Felo charges follow Felo billing records.
outputOptional
Job result payload. Present only once status is completed. For Agent Runs this is the structured research result.
outputExpiredbooleanOptional
True when the result has been retained past its retention window and is no longer retrievable.
errorOptional
Present when status is failed. Null otherwise.