Comentarios del endpoint

Enviar comentarios para un trabajo de 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 comentarios para un trabajo de 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>"
}

Usa los comentarios del endpoint para indicar a Firecrawl si el resultado de un trabajo completado fue útil, parcial o malo. Esto sirve para evaluar la calidad de la salida a nivel de endpoint en trabajos como scrape, parse, map y search. El esquema genérico de comentarios también puede incluir campos de tipo search, pero Comentarios de Search es el punto de entrada recomendado para search porque está asociado a un ID de trabajo de search y destaca fuentes valiosas, contenido faltante, sugerencias de consulta y el comportamiento de reembolso.

Solicitud de ejemplo

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

Autorizaciones

Authorization

string

header

requerido

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

Cuerpo

application/json

Enviar comentarios para un trabajo de v2. Incluye al menos una señal relevante, como issues, note, valuableSources, valuableResults para búsqueda, missingContent, querySuggestions, url o pageNumbers.

rating

enum<string>

requerido

Opciones disponibles:

good,

partial,

bad

endpoint

enum<string>

requerido

Opciones disponibles:

search,

scrape,

parse,

map

jobId

string<uuid>

requerido

integration

string | null

missingContent

object[]

Maximum array length: 20

Show child attributes

origin

string

predeterminado:api

querySuggestions

string

Maximum string length: 2000

valuableResults

object[]

Resultados que fueron útiles, cada uno identificado por el grupo de data en el que aparece y su posición dentro de ese grupo, empezando por 1. Los resultados se devuelven agrupados (data.web, data.images, data.news) y cada grupo se numera desde 1 de forma independiente, por lo que source es obligatorio. Incluye todos los resultados útiles; los que no incluyas se consideran no útiles. Se ignoran las posiciones que superen el número de resultados que realmente devolvió el grupo.

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

Objeto pequeño de metadatos específico del endpoint. Debe tener un tamaño máximo de 8 KB; no incluyas los resultados completos del endpoint.

note

string

Maximum string length: 4000

pageNumbers

integer[]

Maximum array length: 100

Rango requerido: x >= 1

Respuesta

Comentarios registrados

creditsRefunded

number

requerido

feedbackId

string<uuid>

requerido

success

boolean

requerido

Ejemplo:

true

alreadySubmitted

boolean

creditsRefundedToday

number

dailyCapReached

boolean

dailyRefundCap

number

warning

string

Uso de la API

Endpoints de búsqueda

Endpoints de scraping

Endpoints de interacción / sandbox del navegador

Endpoints de Research Index

Endpoints de developer index

Puntos de conexión del índice gubernamental

Puntos de conexión de mapeo

Puntos de conexión de procesamiento

Puntos de conexión de rastreo

Puntos de conexión para supervisar

Puntos de conexión de agentes

Puntos de conexión de comentarios

Puntos de conexión de depuración con agentes

Puntos de conexión de la cuenta

Cargas útiles de webhook

Firecrawl for Platforms

Solicitud de ejemplo

Autorizaciones

Cuerpo

Respuesta