Cancel a crawl job
Cancels an active or queued web crawl job using its id; attempting to cancel completed, failed, or previously canceled jobs will not change their state.
Connect AI Agents to Firecrawl
Enable agents to search and retrieve information from the web using Firecrawl
Actions
Get the status of a crawl job
Retrieves the current status, progress, and details of a web crawl job, using the job id obtained when the crawl was initiated.
Map multiple URLs
Maps a website by discovering URLs from a starting base URL, with options to customize the crawl via search query, subdomain inclusion, sitemap handling, and result limits; search effectiveness is site-dependent.
Start a web crawl
Initiates a Firecrawl web crawl from a given URL, applying various filtering and content extraction rules, and polls until the job is complete; ensure the URL is accessible and any regex patterns for paths are valid.
Extract structured data
Extracts structured data from web pages by initiating an extraction job and polling for completion; requires a natural language prompt or a JSON schema (one must be provided).
Scrape URL
Scrapes a publicly accessible URL, optionally performing pre-scrape browser actions or extracting structured JSON using an LLM, to retrieve content in specified formats.
Search
Performs a web search for a query, scrapes content from the top search results using Firecrawl, and returns details in specified formats.