Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.firecrawl.dev/llms.txt

Use this file to discover all available pages before exploring further.

O Firecrawl está disponível como uma integração nativa no Marketplace da Vercel. Ao instalá-lo, o Firecrawl é provisionado para o seu projeto na Vercel, e a variável FIRECRAWL_API_KEY é adicionada automaticamente às variáveis de ambiente do projeto. Use este guia quando quiser que a cobrança do Firecrawl, a configuração da chave de API e a configuração do projeto sejam feitas pela Vercel.

​
O que a integração faz

Quando você instala o Firecrawl pelo Marketplace da Vercel, a Vercel conecta o Firecrawl ao projeto selecionado e disponibiliza a chave de API como variável de ambiente.
  • Cria uma conta do Firecrawl e uma chave de API pelo fluxo do Marketplace
  • Adiciona FIRECRAWL_API_KEY às variáveis de ambiente do seu projeto na Vercel
  • Mantém a cobrança do Firecrawl na sua fatura da Vercel
  • Permite abrir o Firecrawl na Vercel depois que a integração é conectada
Se você já tiver uma chave de API do Firecrawl e quiser configurar a Vercel manualmente, use o guia de início rápido do Vercel Functions.

​
Instalar pela Vercel

  1. Abra a página do Firecrawl no Marketplace da Vercel.
  2. Clique em Connect Account.
  3. Escolha o plano do Firecrawl que deseja usar.
  4. Selecione o projeto da Vercel que deve receber a variável de ambiente.
  5. Conclua o processo de instalação.
Após a instalação, faça um novo deploy do seu projeto para que as Vercel Functions e o código de servidor do framework possam ler a nova variável de ambiente.

​
Instale o SDK

No seu projeto da Vercel, instale o SDK de Node da Firecrawl: 
npm install @mendable/firecrawl-js
Você não precisa colar uma chave de API no seu código. Leia process.env.FIRECRAWL_API_KEY do lado do servidor.

​
Fazer scraping de uma página

Crie um route handler em app/api/scrape/route.ts: 
import { NextResponse } from "next/server";
import Firecrawl from "@mendable/firecrawl-js";

const firecrawl = new Firecrawl({
  apiKey: process.env.FIRECRAWL_API_KEY,
});

export async function POST(request: Request) {
  const { url } = await request.json();
  const result = await firecrawl.scrape(url, {
    formats: ["markdown"],
  });

  return NextResponse.json(result);
}
Teste a rota após o deploy: 
curl -X POST https://your-project.vercel.app/api/scrape \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.firecrawl.dev"}'

​
Faça uma busca na web

Use search quando seu app precisar de resultados atualizados da web e do conteúdo das páginas: 
import { NextResponse } from "next/server";
import Firecrawl from "@mendable/firecrawl-js";

const firecrawl = new Firecrawl({
  apiKey: process.env.FIRECRAWL_API_KEY,
});

export async function POST(request: Request) {
  const { query } = await request.json();
  const results = await firecrawl.search(query, {
    limit: 5,
    scrapeOptions: {
      formats: ["markdown"],
    },
  });

  return NextResponse.json(results);
}

​
Interaja com páginas dinâmicas

Use interact quando seu app precisar clicar, rolar a página ou preencher formulários antes de extrair conteúdo. 
import { NextResponse } from "next/server";
import Firecrawl from "@mendable/firecrawl-js";

const firecrawl = new Firecrawl({
  apiKey: process.env.FIRECRAWL_API_KEY,
});

export async function POST() {
  const result = await firecrawl.scrape("https://news.ycombinator.com", {
    formats: ["markdown"],
  });
  const scrapeId = result.metadata?.scrapeId;

  if (!scrapeId) {
    return NextResponse.json(
      { error: "No interactive scrape session was created" },
      { status: 500 }
    );
  }

  const response = await firecrawl.interact(scrapeId, {
    prompt: "Open the first story and summarize the page.",
  });

  await firecrawl.stopInteraction(scrapeId);

  return NextResponse.json({ output: response.output });
}
Interações mais longas podem exceder os tempos limite curtos em ambientes serverless. Para fluxos de trabalho de produção que possam levar mais tempo, execute a tarefa em um job em segundo plano ou use as APIs assíncronas do Firecrawl com webhooks.

​
Use o Firecrawl com o Vercel AI SDK

Se você estiver criando um agente com o Vercel AI SDK, instale as ferramentas do Firecrawl AI SDK: 
npm install firecrawl-aisdk ai
Em seguida, passe as ferramentas do Firecrawl para o seu modelo. A FIRECRAWL_API_KEY instalada pelo Marketplace é obtida do ambiente.
O exemplo abaixo usa o formato de string de modelo do Vercel AI Gateway. Configure separadamente o provedor de modelo do AI SDK ou as credenciais do AI Gateway.
import { generateText, stepCountIs } from "ai";
import { FirecrawlTools } from "firecrawl-aisdk";

const { text } = await generateText({
  model: "anthropic/claude-sonnet-4-5",
  tools: FirecrawlTools(),
  stopWhen: stepCountIs(20),
  prompt: "Search for recent Vercel AI SDK examples, scrape the best sources, and summarize them.",
});

console.log(text);

​
Próximos passos

Guia de início rápido do Vercel Functions

Use o Firecrawl no Vercel Functions com configuração manual de ambiente

Guia do Vercel AI SDK

Adicione ferramentas do Firecrawl aos agentes do Vercel AI SDK

Documentação de scraping

Converta páginas da web em Markdown, JSON, capturas de tela e muito mais

Documentação de busca

Faça uma busca na web e obtenha o conteúdo das páginas a partir dos resultados