Submit an asynchronous crawl job.
post_firecrawl_crawlCrawl a whole site rooted at url and return the content of every page it keeps. url, limit and an Idempotency-Key are required; steer it with includePaths, excludePaths, maxDiscoveryDepth, crawlEntireDomain, allowSubdomains, delay and maxConcurrency. Asynchronous. Submitting returns HTTP 202 and a job envelope — id, object, endpoint, status, createdAt, completedAt, pricing, output, error — with output still null. Poll get_firecrawl_crawl_job until status is completed, failed or cancelled; output is then an array of pages, each with markdown and metadata. A 3-page crawl measured 43 KB and finished in under a minute, and pricing.billingMode is metered_result, so cost scales with what it finds — set limit. Send a fresh Idempotency-Key per distinct crawl; reusing one returns the earlier job instead of starting a new one. For a handful of known URLs post_firecrawl_batch_scrape is cheaper, and for structure alone post_firecrawl_map costs far less.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The HTTPS root URL to crawl. PDF URLs are not supported. | |
| delay | No | Delay in seconds between requests (0 to 30). | |
| limit | Yes | Maximum number of pages to crawl. | |
| sitemap | No | How the site's sitemap is used during discovery. | |
| excludePaths | No | Skip URLs whose path matches one of these patterns. | |
| includePaths | No | Only crawl URLs whose path matches one of these patterns. | |
| scrapeOptions | No | Per-page scrape options applied while crawling. On the metered profile output is always markdown. | |
| maxConcurrency | No | Maximum number of concurrent page fetches (1 to 20). | |
| Idempotency-Key | Yes | Unique key (1 to 191 characters) that makes the submit idempotent. Re-submitting with the same key returns the original job. | |
| allowSubdomains | No | Follow links into subdomains of the root domain. | |
| crawlEntireDomain | No | Crawl the whole domain rather than only the subtree under the root URL. | |
| maxDiscoveryDepth | No | Maximum link-discovery depth from the root URL. | |
| allowExternalLinks | No | Follow links to external domains. | |
| ignoreQueryParameters | No | Treat URLs that differ only by query string as the same page. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||