firecrawl-aisdk weekly downloads statistics

Firecrawl AI SDK Tools

Firecrawl tools for Vercel AI SDK. Web scraping, search, interact, and crawling for AI applications.

Full documentation →

Install

Supports AI SDK ai v7 (latest) and v6. Examples below use the v7 option names (isStepCount, instructions, onStepEnd, onToolExecutionEnd); on v6 use stepCountIs, system, onStepFinish, and experimental_onToolCallFinish — the stepLogger helper works with both. Note that ai@7 itself requires Node.js 22+.

Quick Start

Model strings like 'anthropic/claude-sonnet-4-5' use AI Gateway. You can also use provider imports like anthropic('claude-sonnet-4-5-20250514') from @ai-sdk/anthropic.

With logging:

FirecrawlTools

FirecrawlTools() bundles search, scrape, and interact by default.

When scraping to answer a question about a page, prefer query format:

Use formats: ['markdown'] only when you need the full page content.

Bash (context-efficient research)

Scrape a page, then query it with rg, grep, sed, awk — the full markdown stays in a WASM sandbox (just-bash), never in the LLM context. The agent pulls back only the lines it needs.

scrapeBash is one tool with two modes — pass url to scrape, pass command to query. No system prompt needed — the tool description guides the agent.

Token efficiency:

| | scrape → dump in context | scrape + bash |

| Tokens in context | 114,000 | ~3,000 | | Model required | Long-context (Opus/Sonnet) | Haiku works fine | | Cost per question | ~$1.71 | ~$0.05 | | Multi-hop | No | Yes — agent drills into what it finds |

Warm bash calls run in 1-5ms. Pages persist across calls with a 50MB LRU cap.

loadPage(url, markdown) loads content from any source — not just Firecrawl:

Individual Tools

Every tool can be used directly or called with options:

Interact

The interact tool creates a scrape-backed interactive session. Call start(url) to bootstrap a session and get the live view URL, then let the model reuse that session through the interact tool.

If you want the explicit interactive URL after startup, use interactTool.interactiveLiveViewUrl.

Reuse browser state across interact sessions with profiles:

browser() is now deprecated. Prefer interact().

Async Tools

Crawl, batch scrape, and agent return a job ID. Pair them with poll:

Logging

Exports

Development

License

MIT

Description from the npm listing.