데이터 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.