Retour sur la recherche

Envoyer un retour sur une tâche de recherche

curl --request POST \
  --url https://api.firecrawl.dev/v2/search/{jobId}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

payload = {
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<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({
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}]
  })
};

fetch('https://api.firecrawl.dev/v2/search/{jobId}/feedback', 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/search/{jobId}/feedback",
  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([
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<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/search/{jobId}/feedback"

	payload := strings.NewReader("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\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/search/{jobId}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/search/{jobId}/feedback")

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  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}"

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

{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

POST

{jobId}

feedback

Envoyer un retour sur une tâche de recherche

curl --request POST \
  --url https://api.firecrawl.dev/v2/search/{jobId}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'

import requests

url = "https://api.firecrawl.dev/v2/search/{jobId}/feedback"

payload = {
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<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({
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}]
  })
};

fetch('https://api.firecrawl.dev/v2/search/{jobId}/feedback', 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/search/{jobId}/feedback",
  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([
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<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/search/{jobId}/feedback"

	payload := strings.NewReader("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\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/search/{jobId}/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/search/{jobId}/feedback")

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  \"integration\": \"<string>\",\n  \"missingContent\": [\n    {\n      \"topic\": \"<string>\",\n      \"description\": \"<string>\"\n    }\n  ],\n  \"origin\": \"api\",\n  \"querySuggestions\": \"<string>\",\n  \"valuableResults\": [\n    {\n      \"position\": 50,\n      \"reason\": \"<string>\"\n    }\n  ],\n  \"valuableSources\": [\n    {\n      \"url\": \"<string>\",\n      \"reason\": \"<string>\"\n    }\n  ]\n}"

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

{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

{
  "error": "<string>",
  "success": false,
  "details": [
    {}
  ],
  "feedbackErrorCode": "<string>"
}

Utilisez le retour sur la recherche après avoir utilisé un résultat search ou lorsqu’il ne s’avère pas utile. Le retour améliore la qualité des résultats et peut donner lieu au remboursement d’1 crédit pour le premier envoi de retour sur une tâche de recherche, sous réserve des limites de l’équipe. Utilisez valuableResults pour signaler les résultats utiles selon leur emplacement dans la réponse. Chaque entrée indique le groupe source (web, images ou news) et la position du résultat dans ce groupe, en commençant à 1, car chaque groupe est numéroté indépendamment à partir de 1. Indiquez tous les résultats utiles : les résultats non mentionnés sont considérés comme inutiles, et les positions qui dépassent le nombre de résultats renvoyés pour un groupe sont ignorées. Cette méthode fonctionne aussi pour les résultats d’actualités et d’images dépourvus d’url. Utilisez valuableSources pour les URL utiles, y compris celles qui ne figuraient pas parmi les résultats renvoyés.

Exemple de requête

curl -X POST "https://api.firecrawl.dev/v2/search/550e8400-e29b-41d4-a716-446655440000/feedback" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "rating": "good",
    "valuableSources": [
      {
        "url": "https://docs.firecrawl.dev/features/search",
        "reason": "Most up-to-date description of /search."
      }
    ],
    "valuableResults": [
      {
        "source": "web",
        "position": 1,
        "reason": "Answered the question directly."
      },
      {
        "source": "news",
        "position": 2
      }
    ],
    "missingContent": [
      {
        "topic": "Pricing for the search endpoint",
        "description": "No pricing tier table for /search specifically."
      }
    ],
    "querySuggestions": "Boost docs.firecrawl.dev for queries that mention Firecrawl"
  }'

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

jobId

string<uuid>

requis

ID de tâche de recherche renvoyé par /search.

Corps

application/json

Pour « good », incluez valuableSources ou valuableResults. Pour « partial », incluez valuableSources, valuableResults ou missingContent. Pour « bad », incluez missingContent ou querySuggestions.

rating

enum<string>

requis

Options disponibles:

good,

partial,

bad

integration

string | null

missingContent

object[]

Maximum array length: 20

Show child attributes

origin

string

défaut:api

querySuggestions

string

Maximum string length: 2000

valuableResults

object[]

Résultats utiles, chacun identifié par le groupe data dans lequel il apparaît et sa position dans ce groupe, numérotée à partir de 1. Les résultats sont renvoyés par groupe (data.web, data.images, data.news), chaque groupe ayant sa propre numérotation à partir de 1. Le champ source est donc obligatoire. Indiquez tous les résultats utiles ; les résultats non répertoriés sont considérés comme non utiles. Les positions dépassant le nombre de résultats effectivement renvoyés par le groupe sont ignorées.

Maximum array length: 50

Show child attributes

valuableSources

object[]

Maximum array length: 50

Show child attributes

Réponse

Retour enregistré

creditsRefunded

number

requis

feedbackId

string<uuid>

requis

success

boolean

requis

Exemple:

true

alreadySubmitted

boolean

creditsRefundedToday

number

dailyCapReached

boolean

dailyRefundCap

number

warning

string

Utilisation de l’API

Points de terminaison de recherche

Points de terminaison de scraping

Points de terminaison Interact / Browser Sandbox

Points de terminaison de Research Index

Points de terminaison de l’index développeur

Points de terminaison de l’index gouvernemental

Points de terminaison de cartographie

Points de terminaison d’analyse

Points de terminaison de crawl

Points de terminaison de surveillance

Points de terminaison Agent

Points de terminaison de retour

Points de terminaison de débogage agentique

Points de terminaison du compte

Charges utiles de webhook

Firecrawl for Platforms

Exemple de requête

Autorisations

Paramètres de chemin

Corps

Réponse

​Exemple de requête

Autorisations

Paramètres de chemin

Corps

Réponse

Exemple de requête