# Firecrawl

Firecrawl automates web crawling and data extraction, enabling organizations to gather content, index sites, and gain insights from online sources at scale

- **Category:** ai web scraping
- **Auth:** API_KEY
- **Tools:** 27
- **Triggers:** 0
- **Slug:** `FIRECRAWL`
- **Version:** 20260217_00

## Tools

### Batch scrape multiple URLs

**Slug:** `FIRECRAWL_BATCH_SCRAPE`

Tool to scrape multiple URLs in batch with concurrent processing. Use when you need to scrape multiple web pages efficiently with customizable formats and content filtering.

### Cancel a batch scrape job

**Slug:** `FIRECRAWL_BATCH_SCRAPE_DELETE`

Tool to cancel a running batch scrape job using its unique identifier. Use when you need to terminate an in-progress batch scrape operation.

### Get batch scrape status

**Slug:** `FIRECRAWL_BATCH_SCRAPE_GET`

Retrieves the current status and results of a batch scrape job using the job ID. Use this to check batch scrape progress and retrieve scraped data.

### Get errors from batch scrape job

**Slug:** `FIRECRAWL_BATCH_SCRAPE_GET_ERRORS`

Tool to retrieve error details from a batch scrape job, including failed URLs and URLs blocked by robots.txt. Use when you need to debug or understand why certain pages failed to scrape in a batch operation.

### Cancel a crawl job

**Slug:** `FIRECRAWL_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.

### Start a web crawl

**Slug:** `FIRECRAWL_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.

### Get all active crawl jobs

**Slug:** `FIRECRAWL_CRAWL_ACTIVE`

Tool to retrieve all active crawl jobs for the authenticated team. Use when you need to see which crawl operations are currently running.

### Cancel a crawl job

**Slug:** `FIRECRAWL_CRAWL_DELETE`

Tool to cancel a running crawl job by its ID. Use when you need to stop an active crawl operation. The API returns a status of 'cancelled' upon successful cancellation.

### Get crawl job status

**Slug:** `FIRECRAWL_CRAWL_GET`

Tool to retrieve the status and results of a Firecrawl crawl job. Use when you need to check the progress or get data from an ongoing or completed crawl operation. Returns crawl status, progress metrics, credits used, and the crawled page data.

### Get errors from a crawl job

**Slug:** `FIRECRAWL_CRAWL_GET_ERRORS`

Tool to retrieve errors from a Firecrawl crawl job. Use when you need to understand why certain pages failed to scrape or which URLs were blocked by robots.txt during a crawl operation.

### Preview crawl parameters

**Slug:** `FIRECRAWL_CRAWL_PARAMS_PREVIEW`

Preview crawl parameters before starting a crawl by generating optimal configuration from natural language instructions. Use this tool to understand what crawl settings will be applied based on your requirements before executing a full crawl operation. The endpoint intelligently interprets natural language prompts to configure crawl parameters like include/exclude paths, depth limits, and domain scope.

### Start a web crawl (v2) [NEW]

**Slug:** `FIRECRAWL_CRAWL_V2`

[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 configuration. Polls until crawl is complete.

### Get team credit usage

**Slug:** `FIRECRAWL_CREDIT_USAGE`

Tool to get current team credit usage information. Use when you need to check remaining credits or billing period details.

### Get historical team credit usage

**Slug:** `FIRECRAWL_CREDIT_USAGE_HISTORICAL`

Tool to retrieve historical team credit usage on a monthly basis. Use when you need to analyze credit consumption patterns over time, optionally segmented by API key.

### Perform deep research

**Slug:** `FIRECRAWL_DEEP_RESEARCH`

Initiates an AI-powered deep research operation that autonomously explores the web to investigate any topic and synthesizes findings from multiple sources. The research process iteratively searches, analyzes, and synthesizes information across multiple web sources, providing comprehensive insights with source citations. Results include a final analysis, detailed activity timeline, and curated source list. Billing: 1 credit per URL analyzed. Control costs with the maxUrls parameter. Note: This API is in Alpha and being deprecated in favor of the Search API after June 30, 2025.

### Extract structured data

**Slug:** `FIRECRAWL_EXTRACT`

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).

### Get extract job status

**Slug:** `FIRECRAWL_EXTRACT_GET`

Tool to retrieve the status and results of a previously submitted extract job. Use when you need to check the progress or get the final results of an extraction operation.

### Generate LLMs.txt for a website

**Slug:** `FIRECRAWL_GENERATE_LLMS_TXT`

Initiates an async job to generate an LLMs.txt file for a website, converting web content into LLM-friendly format. Returns a job ID to check status and retrieve results. Use when you need to create a standardized, machine-readable representation of website content for language models.

### Get deep research status

**Slug:** `FIRECRAWL_GET_DEEP_RESEARCH_STATUS`

Retrieves the status and results of a deep research job by its ID. Use when you need to check the progress or retrieve the final analysis of a deep research operation.

### Get LLMs.txt generation job status

**Slug:** `FIRECRAWL_GET_LLMS_TXT_STATUS`

Tool to get the status and results of an LLMs.txt generation job. Use when you need to check if a job has completed and retrieve the generated content.

### Get the status of a crawl job

**Slug:** `FIRECRAWL_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

**Slug:** `FIRECRAWL_MAP_MULTIPLE_URLS_BASED_ON_OPTIONS`

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.

### Get team queue status

**Slug:** `FIRECRAWL_QUEUE_STATUS`

Tool to retrieve metrics about the team's scrape queue. Use when you need to check queue status, job counts, or concurrency limits.

### Scrape URL

**Slug:** `FIRECRAWL_SCRAPE`

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

**Slug:** `FIRECRAWL_SEARCH`

Performs a web search for a query, scrapes content from the top search results using Firecrawl, and returns details in specified formats.

### Get team token usage

**Slug:** `FIRECRAWL_TOKEN_USAGE`

Tool to retrieve the current team's token usage and balance information for Firecrawl's Extract feature. Use when you need to check remaining token credits, plan allocation, or billing period details.

### Get historical team token usage

**Slug:** `FIRECRAWL_TOKEN_USAGE_HISTORICAL`

Tool to retrieve historical team token usage on a monthly basis. Use when you need to analyze token consumption patterns over time, optionally segmented by API key.
