Pular para o conteúdo principal
POST
/
support
/
docs-search
Pesquise na documentação do Firecrawl usando IA
curl --request POST \
  --url https://api.firecrawl.dev/v2/support/docs-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>"
}
'
{
  "requestId": "<string>",
  "answer": "<string>",
  "evidence": [
    {
      "pathOrUrl": "<string>",
      "reason": "<string>"
    }
  ],
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123
  },
  "durationMs": 123
}

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 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

CampoTipoDescrição
answerstringResposta concisa fundamentada na documentação do Firecrawl
evidencearrayPáginas da documentação consultadas, com pathOrUrl e reason
usageobjectConsumo de tokens (inputTokens, outputTokens, totalTokens)
durationMsintegerTempo 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.

Autorizações

​
Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corpo

application/json
​
question
string
obrigatório

A pergunta a ser respondida com base na documentação pública do Firecrawl.

Required string length: 1 - 8000

Resposta

Resposta baseada na documentação retornada com sucesso.

​
requestId
string

Identificador único desta solicitação.

​
answer
string

Resposta concisa baseada na documentação pública do Firecrawl.

​
evidence
object[]

Páginas da documentação referenciadas na resposta.

​
usage
object
​
durationMs
integer

Tempo total de execução em milissegundos.