Firecrawl
Search, scrape, map, file parsing and asynchronous crawling.
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.
- 型: stringIdempotency
- Key 最大長:191必須Unique key (1 to 191 characters) that makes the submit idempotent. Re-submitting with the same key returns the original job.
- 型: integerlimit最小値:1最大値:1000必須
Maximum number of pages to crawl.
- 型: string 形式: uriurl必須
The HTTPS root URL to crawl. PDF URLs are not supported.
- 型: booleanallow
External Links Follow links to external domains.
- 型: booleanallow
Subdomains Follow links into subdomains of the root domain.
- 型: booleancrawl
Entire Domain Crawl the whole domain rather than only the subtree under the root URL.
- 型: numberdelay最小値:0最大値:30
Delay in seconds between requests (0 to 30).
- 型: array string[] …20exclude
Paths 最大長:256Skip URLs whose path matches one of these patterns.
- 型: booleanignore
Query Parameters Treat URLs that differ only by query string as the same page.
- 型: array string[] …20include
Paths 最大長:256Only crawl URLs whose path matches one of these patterns.
- 型: integermax
Concurrency 最小値:1最大値:20Maximum number of concurrent page fetches (1 to 20).
- 型: integermax
Discovery Depth 最小値:0最大値:10Maximum link-discovery depth from the root URL.
- 型: objectscrape
Options Per-page scrape options applied while crawling. On the metered profile output is always markdown.
- exclude型: array string[] …50
Tags 最大長:128HTML tags/selectors to drop.
- include型: array string[] …50
Tags 最大長:128HTML tags/selectors to keep.
- max型: integer
Age 最小値:0最大値:31536000000Maximum acceptable cache age in milliseconds.
- min型: integer
Age 最小値:0最大値:31536000000Minimum cache age in milliseconds before a page is refetched.
- only型: boolean
Main Content Return only the main content of each page.
- timeout型: integer最小値:1000最大値:300000
Per-page timeout in milliseconds.
- 型: string 列挙値sitemap
How the site's sitemap is used during discovery.
値- skip
- include
- only
- 型: object · AsyncJob202
Crawl job accepted. The Location header points at the job resource; poll it until terminal.
An asynchronous integration job. Returned by the submit call (HTTP 202) and by the poll/detail call. Poll the job by its id until status is a terminal value (completed, failed, or cancelled).
- 型: string 形式: date-timenull 許容completed
At When the job reached a terminal status. Null while the job is still queued or running.
- 型: string 形式: date-timecreated
At When the job was accepted.
- 型: stringendpoint
Provider operation identifier stored with the job. This metadata is not a Felo polling URL; use the documented Felo job path or Location header.
- 型: object null 許容error
Present when status is failed. Null otherwise.
- code型: string
Machine-readable error code.
- message型: string
Human-readable error message.
- 型: stringid
Job identifier. Use it with the corresponding Felo polling endpoint.
- 型: stringobject
Always "integration_async_job".
- null 許容output
Job result payload. Present only once status is completed. For Agent Runs this is the structured research result.
- 型: booleanoutput
Expired True when the result has been retained past its retention window and is no longer retrievable.
- 型: objectpricing
- authorized型: integer
Micros U S D Provider authorization metadata in micro-USD. This is not a Felo credit hold or billing record.
- billing型: string
Mode Provider job billing mode. Felo charges follow Felo billing records.
- currency型: string
- final型: integer null 許容
Micros U S D Provider settlement metadata in micro-USD, nullable before settlement. This is not the Felo charge.
- 型: string 列挙値status
Customer-facing lifecycle status. queued and running are non-terminal; completed, failed, and cancelled are terminal.
値- queued
- running
- completed
- failed
- cancelled
application/json - 400
The request could not be processed. Check the request parameters.
- 401
A valid Felo API key is required.
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
A request or spending limit has been reached.
- 502
The service could not complete the request.
- 503
The API or billing service is temporarily unavailable.
- 504
The service timed out while processing the request.
- default
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/firecrawl/crawl \
--request POST \
--header 'Idempotency-Key: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '{
"url": "https://docs.firecrawl.dev",
"limit": 50,
"includePaths": [
""
],
"excludePaths": [
""
],
"maxDiscoveryDepth": 0,
"sitemap": "skip",
"ignoreQueryParameters": true,
"crawlEntireDomain": true,
"allowExternalLinks": true,
"allowSubdomains": true,
"delay": 0,
"maxConcurrency": 1,
"scrapeOptions": {
"onlyMainContent": true,
"includeTags": [
""
],
"excludeTags": [
""
],
"maxAge": 0,
"minAge": 0,
"timeout": 1000
}
}'
{
"id": "iaj_01HZY8Q2M4K7N9V3T6W1X0B2C3",
"object": "integration_async_job",
"endpoint": "/apis/v1/exa/agent/runs",
"status": "queued",
"createdAt": "2026-09-30T03:09:45.799Z",
"completedAt": "2026-09-30T03:09:45.799Z",
"pricing": {
"currency": "USD",
"authorizedMicrosUSD": 1,
"finalMicrosUSD": 1,
"billingMode": "flat_per_call"
},
"output": null,
"outputExpired": true,
"error": {
"code": "string",
"message": "string"
}
}