Skip to content
Try for free
On this page

Integrations

Firecrawl

Scrape, search, crawl, map, and extract web data

Use Firecrawl to scrape pages, search the web, crawl or map sites, and extract structured content. Configure a Firecrawl API key and the inputs for the selected operation. Status actions let a workflow follow asynchronous scrape, crawl, or extraction jobs.

Use the block

Scrape pages, search the web, crawl entire sites, map URL structures, and extract structured data with AI.

Actions

Firecrawl Website Scraper

Convert web pages to Markdown or HTML, including SEO metadata, Open Graph tags, and page information.

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlstringYesThe URL to scrape content from (e.g., "https://example.com/page")
formatsjsonNoOutput formats supplied by existing Firecrawl block configurations
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
markdownstringPage content in markdown format
htmlstringRaw HTML content of the page
metadataobjectPage metadata including SEO and Open Graph information
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ languagestringPage language code (e.g., "en")
↳ sourceURLstringOriginal source URL that was scraped
↳ statusCodenumberHTTP status code of the response
↳ keywordsstringPage meta keywords
↳ robotsstringRobots meta directive (e.g., "follow, index")
↳ ogTitlestringOpen Graph title
↳ ogDescriptionstringOpen Graph description
↳ ogUrlstringOpen Graph URL
↳ ogImagestringOpen Graph image URL
↳ ogLocaleAlternatearrayAlternate locale versions for Open Graph
↳ ogSiteNamestringOpen Graph site name
↳ errorstringError message if scrape failed

Firecrawl Batch Scrape

Scrape multiple URLs in a single batch job and retrieve structured content from each page.

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlsjsonYesArray of URLs to scrape (e.g., ["https://example.com/page1", "https://example.com/page2"])
formatsjsonNoOutput formats for scraped content (e.g., ["markdown"], ["markdown", "html"])
onlyMainContentbooleanNoExtract only main content from pages
maxConcurrencynumberNoMaximum number of concurrent scrapes
ignoreInvalidURLsbooleanNoSkip invalid URLs instead of failing the batch (default: true)
zeroDataRetentionbooleanNoEnable zero data retention
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
pagesarrayArray of scraped pages with their content and metadata
↳ markdownstringPage content in markdown format
↳ htmlstringProcessed HTML content of the page
↳ rawHtmlstringUnprocessed raw HTML content
↳ linksarrayArray of links found on the page
↳ screenshotstringScreenshot URL (expires after 24 hours)
↳ metadataobjectPage metadata from crawl operation
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ languagestringPage language code
↳ sourceURLstringOriginal source URL
↳ statusCodenumberHTTP status code
↳ ogLocaleAlternatearrayAlternate locale versions
totalnumberTotal number of pages attempted
completednumberNumber of pages successfully scraped
invalidURLsarrayURLs that were skipped because they were invalid

Firecrawl Batch Scrape Status

Check the status and retrieve results of a previously started Firecrawl batch scrape job by its job ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
jobIdstringYesThe ID of the batch scrape job to check
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
statusstringCurrent batch scrape status (scraping, completed, or failed)
totalnumberTotal number of pages attempted
completednumberNumber of pages successfully scraped
creditsUsednumberCredits consumed by the batch scrape
expiresAtstringISO timestamp when the batch scrape results expire
nextstringURL to retrieve the next page of results when present
pagesarrayArray of scraped pages with their content and metadata
↳ markdownstringPage content in markdown format
↳ htmlstringProcessed HTML content of the page
↳ rawHtmlstringUnprocessed raw HTML content
↳ linksarrayArray of links found on the page
↳ screenshotstringScreenshot URL (expires after 24 hours)
↳ metadataobjectPage metadata from crawl operation
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ languagestringPage language code
↳ sourceURLstringOriginal source URL
↳ statusCodenumberHTTP status code
↳ ogLocaleAlternatearrayAlternate locale versions

Firecrawl Search

Search for information on the web using Firecrawl

Inputs and outputs

Input

ParameterTypeRequiredDescription
querystringYesThe search query to use
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
dataarraySearch results data with scraped content and metadata
↳ titlestringSearch result title from search engine
↳ descriptionstringSearch result description/snippet from search engine
↳ urlstringURL of the search result
↳ markdownstringPage content in markdown; returned only when scraping was requested via the hidden scrapeOptions input
↳ htmlstringProcessed HTML content; returned only when "html" is among the scrape formats requested via the hidden scrapeOptions input
↳ rawHtmlstringUnprocessed raw HTML; returned only when "rawHtml" is among the scrape formats requested via the hidden scrapeOptions input
↳ linksarrayLinks found on the page; returned only when "links" is among the scrape formats requested via the hidden scrapeOptions input
↳ screenshotstringScreenshot URL (expires after 24 hours); returned only when "screenshot" is among the scrape formats requested via the hidden scrapeOptions input
↳ metadataobjectMetadata about the search result page
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ sourceURLstringOriginal source URL
↳ statusCodenumberHTTP status code
↳ errorstringError message if scrape failed

Firecrawl Crawl

Crawl entire websites and extract structured content from all accessible pages

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlstringYesThe website URL to crawl (e.g., "https://example.com" or "https://docs.example.com/guide")
limitnumberNoMaximum number of pages to crawl (e.g., 50, 100, 500). Default: 100
maxDepthnumberNoMaximum depth to crawl from the starting URL (e.g., 1, 2, 3). Controls how many levels deep to follow links
formatsjsonNoOutput formats for scraped content (e.g., ["markdown"], ["markdown", "html"], ["markdown", "links"])
promptstringNoNatural-language crawl guidance supplied by existing configurations
excludePathsjsonNoURL paths to exclude from crawling (e.g., ["/blog/", "/admin/", "/*.pdf"])
includePathsjsonNoURL paths to include in crawling (e.g., ["/docs/", "/api/"]). Only these paths will be crawled
onlyMainContentbooleanNoExtract only main content from pages
apiKeystringYesFirecrawl API Key

Output

ParameterTypeDescription
pagesarrayArray of crawled pages with their content and metadata
↳ markdownstringPage content in markdown format
↳ htmlstringProcessed HTML content of the page
↳ rawHtmlstringUnprocessed raw HTML content
↳ linksarrayArray of links found on the page
↳ screenshotstringScreenshot URL (expires after 24 hours)
↳ metadataobjectPage metadata from crawl operation
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ languagestringPage language code
↳ sourceURLstringOriginal source URL
↳ statusCodenumberHTTP status code
↳ ogLocaleAlternatearrayAlternate locale versions
totalnumberTotal number of pages found during crawl

Firecrawl Crawl Status

Check the status and retrieve results of a previously started Firecrawl crawl job by its job ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
jobIdstringYesThe ID of the crawl job to check
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
statusstringCurrent crawl status (scraping, completed, or failed)
totalnumberTotal number of pages attempted
completednumberNumber of pages successfully crawled
creditsUsednumberCredits consumed by the crawl
expiresAtstringISO timestamp when the crawl results expire
nextstringURL to retrieve the next page of results when present
pagesarrayArray of crawled pages with their content and metadata
↳ markdownstringPage content in markdown format
↳ htmlstringProcessed HTML content of the page
↳ rawHtmlstringUnprocessed raw HTML content
↳ linksarrayArray of links found on the page
↳ screenshotstringScreenshot URL (expires after 24 hours)
↳ metadataobjectPage metadata from crawl operation
↳ titlestringPage title
↳ descriptionstringPage meta description
↳ languagestringPage language code
↳ sourceURLstringOriginal source URL
↳ statusCodenumberHTTP status code
↳ ogLocaleAlternatearrayAlternate locale versions

Firecrawl Cancel Crawl

Cancel an in-progress Firecrawl crawl job by its job ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
jobIdstringYesThe ID of the crawl job to cancel
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
statusstringStatus of the cancelled crawl job (e.g., "cancelled")

Firecrawl Map

Get a complete list of URLs from any website quickly and reliably. Useful for discovering all pages on a site without crawling them.

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlstringYesThe base URL to map and discover links from (e.g., "https://example.com")
searchstringNoFilter results by relevance to a search term (e.g., "blog")
sitemapstringNoControls sitemap usage: "skip", "include" (default), or "only"
includeSubdomainsbooleanNoWhether to include URLs from subdomains (default: true)
ignoreQueryParametersbooleanNoExclude URLs containing query strings (default: true)
limitnumberNoMaximum number of links to return (e.g., 100, 1000, 5000). Max: 100,000, default: 5,000
timeoutnumberNoRequest timeout in milliseconds
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
successbooleanWhether the mapping operation was successful
linksarrayArray of discovered URLs from the website

Firecrawl Extract

Extract structured data from web pages using natural language prompts and JSON Schema.

Inputs and outputs

Input

ParameterTypeRequiredDescription
urlsjsonYesArray of URLs to extract data from (e.g., ["https://example.com/page1", "https://example.com/page2"] or ["https://example.com/*"])
promptstringNoNatural language guidance for the extraction process
schemajsonNoJSON Schema defining the structure of data to extract
enableWebSearchbooleanNoEnable web search to find supplementary information (default: false)
ignoreSitemapbooleanNoIgnore sitemap.xml files during scanning (default: false)
includeSubdomainsbooleanNoExtend scanning to subdomains (default: true)
showSourcesbooleanNoReturn data sources in the response (default: false)
ignoreInvalidURLsbooleanNoSkip invalid URLs in the array (default: true)
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
successbooleanWhether the extraction operation was successful
dataobjectExtracted structured data according to the schema or prompt

Firecrawl Extract Status

Check the status and retrieve results of a previously started Firecrawl extract job by its job ID.

Inputs and outputs

Input

ParameterTypeRequiredDescription
jobIdstringYesThe ID of the extract job to check
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
statusstringCurrent extract status (processing, completed, failed, or cancelled)
datajsonExtracted structured data according to the schema or prompt
expiresAtstringISO timestamp when the extract results expire
creditsUsednumberNumber of credits used by the extract job
tokensUsednumberNumber of tokens used by the extract job

Firecrawl Agent

Autonomous web data extraction agent. Searches and gathers information based on natural language prompts without requiring specific URLs.

Inputs and outputs

Input

ParameterTypeRequiredDescription
promptstringYesNatural language description of the data to extract (max 10,000 characters)
urlsjsonNoOptional array of URLs to focus the agent on (e.g., ["https://example.com", "https://docs.example.com"])
schemajsonNoJSON Schema defining the structure of data to extract
maxCreditsnumberNoMaximum credits to spend on this agent task
strictConstrainToURLsbooleanNoIf true, agent will only visit URLs provided in the urls array
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
successbooleanWhether the agent operation was successful
statusstringCurrent status of the agent job (processing, completed, failed)
dataobjectExtracted data from the agent
expiresAtstringTimestamp when the results expire (24 hours)
sourcesobjectArray of source URLs used by the agent

Firecrawl Document Parser

Parse uploaded documents (PDF, DOCX, HTML, etc.) into clean markdown using Firecrawl. Supports .html, .htm, .pdf, .docx, .doc, .odt, .rtf, .xlsx, .xls.

Inputs and outputs

Input

ParameterTypeRequiredDescription
filefileYesDocument file to be parsed
formatsarrayNoOutput formats to return (e.g., ["markdown"]). Defaults to markdown.
onlyMainContentbooleanNoExclude headers, navs, footers. Defaults to true.
includeTagsarrayNoHTML tags to include
excludeTagsarrayNoHTML tags to exclude
timeoutnumberNoTimeout in milliseconds (max 300000). Defaults to 30000.
parsersarrayNoParser configuration (e.g., [{ "type": "pdf" }])
removeBase64ImagesbooleanNoRemove base64 images, keep alt text. Defaults to true.
blockAdsbooleanNoBlock ads and popups. Defaults to true.
proxystringNoProxy mode: "basic" or "auto"
zeroDataRetentionbooleanNoEnable zero data retention. Defaults to false.
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
markdownstringParsed document content in markdown format
summarystringGenerated summary of the document
htmlstringProcessed HTML content
rawHtmlstringUnprocessed raw HTML content
screenshotstringScreenshot URL or base64 (when requested)
linksarrayURLs discovered in the document
metadataobjectDocument metadata
↳ titlestringDocument title
↳ descriptionstringDocument description
↳ languagestringDocument language code
↳ sourceURLstringSource URL
↳ urlstringFinal URL
↳ keywordsstringDocument keywords
↳ statusCodenumberHTTP status code
↳ contentTypestringDocument content type
↳ errorstringError message if parse failed
warningstringWarning message from the parse operation

Firecrawl Credit Usage

Retrieve the remaining and allocated Firecrawl credits for the team.

Inputs and outputs

Input

ParameterTypeRequiredDescription
apiKeystringYesFirecrawl API key

Output

ParameterTypeDescription
remainingCreditsnumberNumber of credits remaining for the team
planCreditsnumberCredits allocated in the current plan
billingPeriodStartstringStart of the current billing period
billingPeriodEndstringEnd of the current billing period
Was this helpful?
Suggest an edit