Busca na documentação - Firecrawl Docs

O endpoint /support/docs-search responde a perguntas com base na documentação pública do Firecrawl. Requer sua chave de API do Firecrawl. Retorna uma resposta concisa, baseada na documentação, com citações das páginas relevantes da documentação.

Casos de uso

Agentes de IA que precisam consultar o uso, os parâmetros ou as melhores práticas da API do Firecrawl
Bots de suporte que respondem a perguntas de clientes com base na documentação
Ferramentas para desenvolvedores que exibem documentação relevante de forma integrada

Exemplo

curl -X POST https://api.firecrawl.dev/v2/support/docs-search \
  -H "Authorization: Bearer fc-YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "what header carries the webhook signature, and how do I verify it?"
  }'

Resposta

{
  "requestId": "req_...",
  "answer": "The signature is sent in the X-Firecrawl-Signature header...",
  "evidence": [
    {
      "pathOrUrl": "webhooks/security.mdx#L1-L52",
      "reason": "Documents webhook signature verification"
    }
  ],
  "usage": { "inputTokens": 4356, "outputTokens": 688, "totalTokens": 5044 },
  "durationMs": 11252
}

Campos da resposta

Campo	Tipo	Descrição
`answer`	string	Resposta concisa fundamentada na documentação do Firecrawl
`evidence`	array	Páginas da documentação consultadas, com `pathOrUrl` e `reason`
`usage`	object	Consumo de tokens (`inputTokens`, `outputTokens`, `totalTokens`)
`durationMs`	integer	Tempo total de execução em milissegundos

Para ver o guia completo da funcionalidade, consulte a documentação da funcionalidade Ask.

Você é um agente de IA que precisa de uma chave de API do Firecrawl? Consulte firecrawl.dev/agent-onboarding/SKILL.md para obter instruções de integração automatizada.