Skip to main content

Web Extract Tool

Extracts structured data from web pages using Firecrawl AI-powered extraction with custom prompts and schemas

Quick Start​

import { WebExtractTool } from '@bubblelab/bubble-core';
import { CredentialType } from '@bubblelab/shared-schemas';
const result = await new WebExtractTool({

  url: 'example', // The URL to extract structured data from
  prompt: 'example', // Detailed prompt describing what data to extract from the web page
  schema: 'example', // JSON schema string defining the structure of the data to extract
  credentials: {
    [CredentialType.FIRECRAWL_API_KEY]: process.env.FIRECRAWL_API_KEY as string,
  },
}).action();

Operation Details​

execute​

url string required
The URL to extract structured data from
prompt string required
Detailed prompt describing what data to extract from the web page
schema string required
JSON schema string defining the structure of the data to extract
timeout number
Timeout in milliseconds for the extraction (default: 30000)
credentials Record<CredentialType,string>
Required credentials including FIRECRAWL_API_KEY