Introdução

Referência da API do Firecrawl (v2)

A API do Firecrawl oferece acesso programático a dados da web. Todos os endpoints compartilham uma URL base comum, um esquema de autenticação e um formato de resposta descritos nesta página.

​

Recursos

Scrape

Extraia conteúdo de qualquer página da web em formato Markdown ou JSON.

Crawl

Faça o rastreamento de sites inteiros e extraia seu conteúdo e metadados.

Map

Obtenha rapidamente uma lista completa de URLs de qualquer site, de forma confiável.

Search

Pesquise na web e obtenha o conteúdo completo das páginas em qualquer formato.

​

Recursos de agentes

Agent

Navegue de forma autônoma e extraia dados estruturados de sites.

Browser

Crie e controle sessões de navegador para tarefas interativas na web.

​

URL base

Todas as requisições usam a seguinte URL base:

https://api.firecrawl.dev

​

Autenticação

Toda requisição exige um cabeçalho Authorization com sua chave de API:

Authorization: Bearer fc-YOUR-API-KEY

Inclua este cabeçalho em todas as chamadas à API. Você pode encontrar sua chave de API no painel do Firecrawl.

cURL

curl -X POST "https://api.firecrawl.dev/v2/scrape" \
  -H "Authorization: Bearer fc-YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

​

Códigos de resposta

O Firecrawl usa códigos de status HTTP convencionais para indicar o resultado das suas requisições. Códigos na faixa 2xx indicam sucesso, códigos 4xx indicam erros do cliente e códigos 5xx indicam erros do servidor.

Status	Descrição
200	Requisição bem-sucedida.
400	Parâmetros de requisição inválidos.
401	Chave de API ausente ou inválida.
402	Pagamento necessário.
404	O recurso solicitado não foi encontrado.
429	Limite de requisições excedido.
5xx	Erro de servidor no Firecrawl.

Quando ocorre um erro 5xx, o corpo da resposta inclui um código de erro específico para ajudar você a diagnosticar o problema.

​

Limite de taxa de requisições

A API do Firecrawl impõe limites de taxa de requisições em todos os endpoints para garantir a estabilidade do serviço. Esses limites são definidos com base no número de requisições em uma janela de tempo específica.

Quando você ultrapassa o limite de taxa, a API retorna o código de status 429. Aguarde um pouco e tente fazer a requisição novamente após um breve intervalo.