Saltar al contenido principal
POST
/
support
/
docs-search
Busca en la documentación de Firecrawl con citas
curl --request POST \
  --url https://api.firecrawl.dev/v2/support/docs-search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "<string>"
}
'
{
  "answer": "<string>",
  "durationMs": 123,
  "evidence": [
    {
      "pathOrUrl": "<string>",
      "reason": "<string>"
    }
  ],
  "requestId": "<string>",
  "usage": {
    "inputTokens": 123,
    "outputTokens": 123,
    "totalTokens": 123
  }
}
El endpoint /support/docs-search responde preguntas con la documentación pública de Firecrawl. Requiere tu clave de API de Firecrawl. Devuelve una respuesta concisa, basada en la documentación, con citas de las páginas relevantes.

​
Casos de uso

  • agentes de IA que necesitan consultar el uso de la API de Firecrawl, sus parámetros o las prácticas recomendadas
  • bots de soporte que responden preguntas de clientes a partir de la documentación
  • herramientas para desarrolladores que muestran documentación relevante en contexto

​
Ejemplo

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?"
  }'

​
Respuesta

{
  "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 de la respuesta

CampoTipoDescripción
answerstringRespuesta concisa fundamentada en la documentación de Firecrawl
evidencearrayPáginas de documentación citadas, con pathOrUrl y reason
usageobjectConsumo de tokens (inputTokens, outputTokens, totalTokens)
durationMsintegerTiempo total de ejecución en milisegundos
Para consultar la guía completa de la funcionalidad, consulta la documentación de la funcionalidad Ask.
¿Eres un agente de IA que necesita una clave de API de Firecrawl? Consulta firecrawl.dev/agent-onboarding/SKILL.md para obtener instrucciones de incorporación automática.

Autorizaciones

​
Authorization
string
header
requerido

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

Cuerpo

application/json
​
question
string
requerido

Pregunta sobre la documentación que debe responderse.

Respuesta

Respuesta fundamentada en la documentación

​
answer
string

Respuesta concisa basada en la documentación de Firecrawl.

​
durationMs
integer

Tiempo total de ejecución de la búsqueda en la documentación en milisegundos.

​
evidence
object[]
​
requestId
string
​
usage
object