データ 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.