Firecrawl

Scrape, crawl, and search web pages with AI-friendly extraction via Firecrawl.

AI and MLAPI key6 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (6)
crawl
scrape
crawlResults
custom_api_call
extract
map
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("firecrawl", "crawl", {
    "url": "<url>",
    "formats": "<formats>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Firecrawl answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "firecrawl-crawl",
  name: "Firecrawl: Crawl",
  description: "Calls Firecrawl when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("firecrawl", {
      "action": "crawl",
      "url": "<url>",
      "formats": "<formats>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/firecrawl/crawl" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"url":"<url>","formats":"<formats>"}}'

Actions

crawlin catalog

Crawl. Crawl multiple pages from a website based on specified rules and patterns.

Input	Type	Description
`url`required	text	The base URL to start crawling from.
`prompt`optional	long text	Describe what information you want to extract.
`limit`optional	number	Maximum number of pages to crawl. Default limit is 10.
`formats`required	id (picked from your account)	Choose what format you want your output in.
`onlyMainContent`optional	boolean	Only return the main content of the page, excluding headers, navs, footers, etc.
`extractMode`optional	object (depends on other props)	Data schema type.
`extractSchema`optional	object (depends on other props)	Data Definition
`timeout`optional	number	Timeout in seconds after which the task will be cancelled
`useWebhook`optional	boolean	Enable to send crawl results to a webhook URL.
`webhookProperties`optional	object (depends on other props)	Properties for webhook configuration.

scrapein catalog

Scrape Website. Scrape a website by performing a series of actions like clicking, typing, taking screenshots, and extracting data.

Input	Type	Description
`url`required	text	The webpage URL to scrape.
`timeout`optional	number	Maximum time to wait for the page to load (in milliseconds).
`useActions`optional	boolean	Enable to perform a sequence of actions on the page before scraping (like clicking buttons, filling forms, etc.). See [Firecrawl Actions Documentation](https://docs.firecrawl.dev/api-reference/endpoi…
`actionProperties`optional	object (depends on other props)	Properties for actions that will be performed on the page.
`formats`required	id (picked from your account)	Choose what format you want your output in.
`extractPrompt`optional	object (depends on other props)	Prompt for extracting data.
`extractMode`optional	object (depends on other props)	Data schema type.
`extractSchema`optional	object (depends on other props)	Data Definition

crawlResults

Crawl Results. Get the results of a crawl job.

Input	Type	Description
`crawlId`required	text	The ID of the crawl job to check.

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

extract

Extract Structured Data. Extract structured data from multiple URLs using AI.

Input	Type	Description
`urls`required	array	Add one or more URLs to extract data from.
`prompt`optional	long text	Describe what information you want to extract.
`enableWebSearch`optional	boolean	Enable web search to find additional context.
`timeout`optional	number	Timeout in seconds after which the task will be cancelled
`mode`required	one of "simple" \| "advanced"	For complex schema, you can use advanced mode.
`schema`required	object (depends on other props)	Data Definition

map

Map Websites. Input a website and get all the urls on the website.

Input	Type	Description
`url`required	text	The webpage URL to start scraping from.
`subdomain`optional	boolean	Include and crawl pages from subdomains of the target website (e.g., blog.example.com, shop.example.com) in addition to the main domain.
`limit`optional	number	Maximum number of links to return (max: 100,000)

Details

Id: firecrawl
Category: AI and ML
Tags: scraping, crawling, web, extraction, ai
Package: @activepieces/piece-firecrawl@0.3.5
Tier: Built in