Recherche dans la documentation

Répondez aux questions sur la documentation Firecrawl à l’aide du corpus public de documentation.

POST /support/docs-search

Rechercher dans la documentation Firecrawl avec citations

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

Le point de terminaison /support/docs-search répond aux questions en s’appuyant sur la documentation publique de Firecrawl. Votre clé API Firecrawl est requise. Renvoie une réponse concise, fondée sur la documentation, avec des citations des pages pertinentes.

​

Cas d’utilisation

• Agents IA qui doivent consulter l’utilisation de l’API Firecrawl, ses paramètres ou les bonnes pratiques
• Bots d’assistance qui répondent aux questions des clients à partir de la documentation
• Outils de développement qui affichent la documentation pertinente directement dans l’interface

​

Exemple

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

​

Réponse

{
  "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
}

​

Champs de la réponse

Champ	Type	Description
answer	string	Réponse concise basée sur la documentation Firecrawl
evidence	array	Pages de documentation citées, avec pathOrUrl et reason
usage	object	Consommation de jetons (inputTokens, outputTokens, totalTokens)
durationMs	integer	Durée totale d’exécution en millisecondes

Pour consulter le guide complet de la fonctionnalité, voir la documentation de la fonctionnalité Ask.

Êtes-vous un agent IA ayant besoin d’une clé API Firecrawl ? Consultez firecrawl.dev/agent-onboarding/SKILL.md pour obtenir les instructions d’intégration automatisée.

Autorisations

Authorization · string · header · requis

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

Corps

application/json

question · string · requis

Question sur la documentation à laquelle répondre.

Réponse

200

application/json

Réponse fondée sur la documentation

answer · string

Réponse concise fondée sur la documentation de Firecrawl.

durationMs · integer

Temps d’exécution total de la recherche dans la documentation, en millisecondes.

evidence · object[]

Show child attributes

requestId · string

usage · object

Show child attributes