Feedback do endpoint

Enviar feedback para um job da v2

curl --request POST \
  --url https://api.firecrawl.dev/v2/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ],
  "issues": [
    "<string>"
  ],
  "metadata": {},
  "note": "<string>",
  "pageNumbers": [
    2
  ],
  "tags": [
    "<string>"
  ],
  "url": "<string>"
}
'

import requests

url = "https://api.firecrawl.dev/v2/feedback"

payload = {
    "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<string>"
        }
    ],
    "issues": ["<string>"],
    "metadata": {},
    "note": "<string>",
    "pageNumbers": [2],
    "tags": ["<string>"],
    "url": "<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({
    jobId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}],
    issues: ['<string>'],
    metadata: {},
    note: '<string>',
    pageNumbers: [2],
    tags: ['<string>'],
    url: '<string>'
  })
};

fetch('https://api.firecrawl.dev/v2/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/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([
    'jobId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<string>'
        ]
    ],
    'issues' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'note' => '<string>',
    'pageNumbers' => [
        2
    ],
    'tags' => [
        '<string>'
    ],
    'url' => '<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/feedback"

	payload := strings.NewReader("{\n  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<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/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/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  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\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

feedback

Enviar feedback para um job da v2

curl --request POST \
  --url https://api.firecrawl.dev/v2/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableResults": [
    {
      "position": 50,
      "reason": "<string>"
    }
  ],
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ],
  "issues": [
    "<string>"
  ],
  "metadata": {},
  "note": "<string>",
  "pageNumbers": [
    2
  ],
  "tags": [
    "<string>"
  ],
  "url": "<string>"
}
'

import requests

url = "https://api.firecrawl.dev/v2/feedback"

payload = {
    "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "integration": "<string>",
    "missingContent": [
        {
            "topic": "<string>",
            "description": "<string>"
        }
    ],
    "origin": "api",
    "querySuggestions": "<string>",
    "valuableResults": [
        {
            "position": 50,
            "reason": "<string>"
        }
    ],
    "valuableSources": [
        {
            "url": "<string>",
            "reason": "<string>"
        }
    ],
    "issues": ["<string>"],
    "metadata": {},
    "note": "<string>",
    "pageNumbers": [2],
    "tags": ["<string>"],
    "url": "<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({
    jobId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    integration: '<string>',
    missingContent: [{topic: '<string>', description: '<string>'}],
    origin: 'api',
    querySuggestions: '<string>',
    valuableResults: [{position: 50, reason: '<string>'}],
    valuableSources: [{url: '<string>', reason: '<string>'}],
    issues: ['<string>'],
    metadata: {},
    note: '<string>',
    pageNumbers: [2],
    tags: ['<string>'],
    url: '<string>'
  })
};

fetch('https://api.firecrawl.dev/v2/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/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([
    'jobId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'integration' => '<string>',
    'missingContent' => [
        [
                'topic' => '<string>',
                'description' => '<string>'
        ]
    ],
    'origin' => 'api',
    'querySuggestions' => '<string>',
    'valuableResults' => [
        [
                'position' => 50,
                'reason' => '<string>'
        ]
    ],
    'valuableSources' => [
        [
                'url' => '<string>',
                'reason' => '<string>'
        ]
    ],
    'issues' => [
        '<string>'
    ],
    'metadata' => [
        
    ],
    'note' => '<string>',
    'pageNumbers' => [
        2
    ],
    'tags' => [
        '<string>'
    ],
    'url' => '<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/feedback"

	payload := strings.NewReader("{\n  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<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/feedback")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.firecrawl.dev/v2/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  \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\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  \"issues\": [\n    \"<string>\"\n  ],\n  \"metadata\": {},\n  \"note\": \"<string>\",\n  \"pageNumbers\": [\n    2\n  ],\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"url\": \"<string>\"\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>"
}

Use o feedback do endpoint para informar ao Firecrawl se o resultado de um job concluído foi útil, parcial ou ruim. Isso serve para avaliar a qualidade do resultado no nível do endpoint em jobs como scrape, parse, map e search. O esquema genérico de feedback também pode incluir campos específicos de busca, mas Feedback de busca é o ponto de entrada preferido para busca, porque está vinculado ao ID de um job de busca e destaca fontes valiosas, conteúdo ausente, sugestões de query e comportamento de reembolso.

Exemplo de requisição

curl -X POST "https://api.firecrawl.dev/v2/feedback" \
  -H "Authorization: Bearer $FIRECRAWL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint": "scrape",
    "jobId": "550e8400-e29b-41d4-a716-446655440000",
    "rating": "partial",
    "issues": ["missing_markdown"],
    "note": "The pricing table was missing from the markdown output.",
    "url": "https://example.com/pricing"
  }'

Autorizações

Authorization

string

header

obrigatório

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

Corpo

application/json

Enviar feedback para um job da v2. Inclua pelo menos um sinal relevante, como issues, note, valuableSources, valuableResults para busca, missingContent, querySuggestions, url ou pageNumbers.

rating

enum<string>

obrigatório

Opções disponíveis:

good,

partial,

bad

endpoint

enum<string>

obrigatório

Opções disponíveis:

search,

scrape,

parse,

map

jobId

string<uuid>

obrigatório

integration

string | null

missingContent

object[]

Maximum array length: 20

Show child attributes

origin

string

padrão:api

querySuggestions

string

Maximum string length: 2000

valuableResults

object[]

Resultados úteis, cada um identificado pelo grupo data em que aparece e por sua posição nesse grupo, contada a partir de 1. Os resultados são retornados em grupos (data.web, data.images, data.news), cada um com numeração independente a partir de 1, portanto source é obrigatório. Liste todos os resultados úteis; os resultados não listados são considerados não úteis. Posições que excedam o número de resultados efetivamente retornados pelo grupo são ignoradas.

Maximum array length: 50

Show child attributes

valuableSources

object[]

Maximum array length: 50

Show child attributes

issues

string[]

Maximum array length: 20

Maximum string length: 80

Pattern: ^[a-z0-9][a-z0-9_-]*$

metadata

object

Pequeno objeto de metadados específico do endpoint. Deve ter 8 KB ou menos; não inclua os resultados completos do endpoint.

note

string

Maximum string length: 4000

pageNumbers

integer[]

Maximum array length: 100

Intervalo obrigatório: x >= 1

Resposta

Feedback registrado

creditsRefunded

number

obrigatório

feedbackId

string<uuid>

obrigatório

success

boolean

obrigatório

Exemplo:

true

alreadySubmitted

boolean

creditsRefundedToday

number

dailyCapReached

boolean

dailyRefundCap

number

warning

string

Usando a API

Endpoints de busca

Endpoints /scrape

Endpoints para interagir / Browser Sandbox

Endpoints do Research Index

Endpoints do índice para desenvolvedores

Endpoints do índice governamental

Endpoints de mapeamento

Endpoints de Parse

Endpoints de rastreamento

Endpoints de monitoramento

Endpoints de agente

Endpoints de feedback

Endpoints de depuração agêntica

Endpoints da conta

Payloads de webhook

Firecrawl for Platforms

Exemplo de requisição

Autorizações

Corpo

Resposta

​Exemplo de requisição

Autorizações

Corpo

Resposta

Exemplo de requisição