Recherche dans la documentation

Rechercher dans la documentation Firecrawl à l’aide de l’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>"
}
'

import requests

url = "https://api.firecrawl.dev/v2/support/docs-search"

payload = { "question": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({question: '<string>'})
};

fetch('https://api.firecrawl.dev/v2/support/docs-search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/support/docs-search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'question' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/support/docs-search"

	payload := strings.NewReader("{\n  \"question\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/support/docs-search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/support/docs-search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"question\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": "<string>"
}

POST

support

docs-search

Rechercher dans la documentation Firecrawl à l’aide de l’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>"
}
'

import requests

url = "https://api.firecrawl.dev/v2/support/docs-search"

payload = { "question": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({question: '<string>'})
};

fetch('https://api.firecrawl.dev/v2/support/docs-search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firecrawl.dev/v2/support/docs-search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'question' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firecrawl.dev/v2/support/docs-search"

	payload := strings.NewReader("{\n  \"question\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.firecrawl.dev/v2/support/docs-search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/support/docs-search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"question\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "error": "<string>"
}

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

La question à traiter à partir de la documentation publique de Firecrawl.

Required string length: 1 - 8000

Réponse

Réponse fondée sur la documentation renvoyée avec succès.

requestId

string

Identifiant unique de cette requête.

answer

string

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

evidence

object[]

Pages de documentation citées dans la réponse.

Show child attributes

usage

object

Show child attributes

durationMs

integer

Temps d’exécution total en millisecondes.

Utilisation de l’API

Points de terminaison de recherche

Points de terminaison Scrape

Points de terminaison d’Interact

Points de terminaison de cartographie

Points de terminaison Parse

Points de terminaison Crawl

Points de terminaison de débogage des agents

Points de terminaison du compte

Payloads de webhook

Intégration partenaire

Recherche dans la documentation

Cas d’utilisation

Exemple

Réponse

Champs de la réponse

Autorisations

Corps

Réponse

​Cas d’utilisation

​Exemple

​Réponse

​Champs de la réponse

Autorisations

Corps

Réponse

Cas d’utilisation

Exemple

Réponse

Champs de la réponse