Firecrawl AI SDK Tools

Firecrawl tools for Vercel AI SDK v5. Web scraping, search, crawling, and data extraction for AI applications.

Install

``bash
npm install firecrawl-aisdk ai @ai-sdk/openai
`

Set environment variables:
`bash
FIRECRAWL_API_KEY=fc-your-key
OPENAI_API_KEY=sk-your-key
`

Quick Start

`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { scrapeTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Scrape https://firecrawl.dev and summarize what it does',
tools: { scrape: scrapeTool },
});
`

Available Tools

`typescript
import {
scrapeTool, // Scrape single URL
searchTool, // Search the web
mapTool, // Discover URLs on a site
crawlTool, // Crawl multiple pages
batchScrapeTool, // Scrape multiple URLs
extractTool, // Extract structured data
pollTool, // Poll async jobs
statusTool, // Check job status
cancelTool, // Cancel jobs
} from 'firecrawl-aisdk';
`

Examples

Scrape
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { scrapeTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Scrape https://firecrawl.dev and summarize what it does',
tools: { scrape: scrapeTool },
});

console.log(text);
`

Search
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { searchTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Search for Firecrawl and summarize what you find',
tools: { search: searchTool },
});

console.log(text);
`

Map
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { mapTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Map https://docs.firecrawl.dev and list the main sections',
tools: { map: mapTool },
});

console.log(text);
`

Crawl (async - requires polling)
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { crawlTool, pollTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Crawl https://docs.firecrawl.dev (limit 3 pages) and summarize',
tools: { crawl: crawlTool, poll: pollTool },
});

console.log(text);
`

Batch (async - requires polling)
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { batchScrapeTool, pollTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Scrape https://firecrawl.dev and https://docs.firecrawl.dev, then compare',
tools: { batchScrape: batchScrapeTool, poll: pollTool },
});

console.log(text);
`

Extract (async - requires polling)
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { extractTool, pollTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Extract the main features from https://firecrawl.dev',
tools: { extract: extractTool, poll: pollTool },
});

console.log(text);
`

Search + Scrape
`typescript
import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { searchTool, scrapeTool } from 'firecrawl-aisdk';

const { text } = await generateText({
model: openai('gpt-5-mini'),
prompt: 'Search for Firecrawl, scrape the top result, and explain what it does',
tools: { search: searchTool, scrape: scrapeTool },
});

console.log(text);
`

Stream
`typescript
import { streamText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { scrapeTool } from 'firecrawl-aisdk';

const result = streamText({
model: openai('gpt-5-mini'),
prompt: 'Scrape https://firecrawl.dev and explain what it does',
tools: { scrape: scrapeTool },
});

for await (const chunk of result.textStream) {
process.stdout.write(chunk);
}
`

Development

Run tests:
`bash
pnpm test # Run all tests
pnpm test:watch # Watch mode
``

License

MIT