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.

Параметры

заголовок

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.