Busca na documentação

Responda a perguntas sobre a documentação do Firecrawl usando o corpus público da documentação.

POST /support/docs-search

Pesquisar na documentação do Firecrawl com citações

cURL

curl --request POST \
  --url https://api.firecrawl.dev/v2/support/docs-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>"
}
'

200

{
  "answer": "<string>",
  "durationMs": 123,
  "evidence": [
    {
      "pathOrUrl": "<string>",
      "reason": "<string>"
    }
  ],
  "requestId": "<string>",
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123
  }
}

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.

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

Pergunta sobre a documentação a ser respondida.

Resposta

200

application/json

Resposta fundamentada na documentação

answer · string

Resposta concisa com base na documentação do Firecrawl.

durationMs · integer

Tempo total de execução da busca na documentação, em milissegundos.

evidence · object[]

Show child attributes

requestId · string

usage · object

Show child attributes