Firecrawl Integration

Field	Description	Required	Format
Firecrawl API Key	Your Firecrawl API key for authentication	Yes	`fc-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`

scrape — Scrape content from a single URL with advanced options. Best for single page content extraction when you know exactly which page contains the information.

Parameters

string

required

The URL to scrape

array

Content formats: markdown, html, rawHtml, screenshot, links, summary (Default: ["markdown"])

boolean

Extract only the main content, filtering out navigation/footers (Default: true)

array

HTML tags to specifically include in extraction

array

HTML tags to exclude from extraction

integer

Time in milliseconds to wait for dynamic content

boolean

Use mobile viewport

boolean

Remove base64-encoded images from output

integer

Maximum age in milliseconds for cached content. Enables faster scrapes for cached pages.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "ScrapeOutput",
  "type": "object"
}

map_website — Map a website to discover all indexed URLs. Best for discovering URLs before deciding what to scrape.

Parameters

string

required

Starting URL for URL discovery

string

Optional search term to filter URLs

string

Sitemap handling: ‘include’, ‘skip’, or ‘only’

boolean

Include URLs from subdomains in results

integer

Maximum number of URLs to return

boolean

Do not return URLs with query parameters (Default: true)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "MapWebsiteOutput",
  "type": "object"
}

search — Search the web and optionally extract content from search results. Supports operators: site:, inurl:, intitle:, and exact match with quotes.

Parameters

string

required

Search query string (supports operators)

integer

Maximum number of results to return (Default: 5)

string

Time-based search filter

string

Location parameter for search results

object

Options for scraping search results

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchOutput",
  "type": "object"
}

crawl — Start a crawl job on a website. Returns a job ID — use check_crawl_status to monitor.

Parameters

string

required

Starting URL for the crawl

array

URL paths to exclude from crawling

array

Only crawl these URL paths

integer

Maximum depth to crawl relative to the entered URL

integer

Maximum number of pages to crawl (Default: 100)

boolean

Allow crawling links to external domains (Default: false)

boolean

Allow crawling links to parent paths (Default: false)

boolean

Ignore the website sitemap when crawling (Default: false)

object

Options for scraping each page

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CrawlOutput",
  "type": "object"
}

check_crawl_status — Check the status of a crawl job and retrieve results once complete.

Parameters

string

required

Crawl job ID returned from the crawl action

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "CheckCrawlStatusOutput",
  "type": "object"
}

extract — Extract structured information from web pages using LLM capabilities. Best for extracting specific structured data.

Parameters

array

required

Array of URLs to extract information from

string

Custom prompt for the LLM extraction

object

JSON schema for structured data extraction

boolean

Allow extraction from external links (Default: false)

boolean

Enable web search for additional context (Default: false)

boolean

Include subdomains in extraction (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "ExtractOutput",
  "type": "object"
}

batch_scrape — Batch scrape multiple URLs efficiently. More efficient than calling scrape multiple times.

Parameters

array

required

Array of URLs to scrape

array

Content formats to extract (Default: ["markdown"])

boolean

Extract only the main content (Default: true)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "data": {
      "anyOf": [
        {
          "additionalProperties": true,
          "type": "object"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Data"
    }
  },
  "required": [
    "success"
  ],
  "title": "BatchScrapeOutput",
  "type": "object"
}

Using

Providers

Building

Tools

Firecrawl Integration for AI Agents & Workflows

Overview

Authentication

API Key Authentication

Required Credentials

ModuleX Managed Key

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Exa Search

Linkup

Serper

Links

​Overview

​Authentication

​API Key Authentication

​Required Credentials

​ModuleX Managed Key

​Available Actions

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Parameters

​Response

​Limits & Quotas

​Related integrations

Exa Search

Linkup

Serper

​Links

Overview

Authentication

API Key Authentication

Required Credentials

ModuleX Managed Key

Available Actions

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Limits & Quotas

Related integrations

Links