[NEW v2 API] Initiates a Firecrawl v2 web crawl with enhanced features over v1: natural language prompts for automatic crawler configuration, crawlEntireDomain for sibling/parent page discovery, better depth control with maxDiscoveryDepth, subdomain support, and full webhook con…
urlRequiredstringThe base URL to start crawling from. This is the initial entry point for the web crawler.
delayintegerDelay in seconds between scrapes to respect website rate limits.
limitintegerMaximum number of pages to crawl. The crawl will stop once this limit is reached. Default is 10.
promptstringA natural language prompt to automatically generate crawler settings. Example: 'Only crawl blog posts and docs, skip marketing pages'. Explicitly set parameters will override the generated equivalents.
sitemapstringSitemap mode when crawling. 'include' (default) uses sitemap and discovers other pages. 'skip' ignores sitemap entirely and only discovers pages from the start URL. 'only' crawls exclusively URLs from the sitemap, ignoring other discovered links.
webhookobjectWebhook configuration for receiving real-time crawl updates.
excludePathsarrayA list of Regular Expression (regex) patterns for URL paths to exclude from the crawl. URLs whose paths match any of these patterns will be ignored. For example, `"blog/archive/.*"` would exclude all paths under `/blog/archive/`.
includePathsarrayA list of Regular Expression (regex) patterns for URL paths to include in the crawl. Only URLs whose paths match one of these patterns will be processed. For example, `"products/featured/.*"` would only include paths under `/products/featured/`.
maxConcurrencyintegerMaximum number of concurrent scrapes. If not specified, uses your team's concurrency limit.
allowSubdomainsbooleanIf true, allows the crawler to follow links to subdomains of the main domain.
crawlEntireDomainbooleanAllows the crawler to follow internal links to sibling or parent URLs, not just child paths. False: Only crawls deeper (child) URLs (e.g., /features/feature-1 → /features/feature-1/tips). True: Crawls any internal links including siblings and parents (e.g., /features/feature-1 →…
maxDiscoveryDepthintegerMaximum depth to crawl based on discovery order. The root site and sitemapped pages have a discovery depth of 0. For example, if you set it to 1 and set sitemap='skip', you will only crawl the entered URL and all URLs linked on that page.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
Aident-managed access. Risk level 2 of 5.
$0.05 / call
No published Skills explicitly reference this Action yet.