Submit feedback for a v2 job
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",
"valuableSources": [
{
"url": "<string>",
"reason": "<string>"
}
],
"valuableResults": [
{
"position": 50,
"reason": "<string>"
}
],
"missingContent": [
{
"topic": "<string>",
"description": "<string>"
}
],
"querySuggestions": "<string>",
"origin": "api",
"integration": "<string>",
"issues": [
"<string>"
],
"tags": [
"<string>"
],
"note": "<string>",
"url": "<string>",
"pageNumbers": [
2
],
"metadata": {}
}
'import requests
url = "https://api.firecrawl.dev/v2/feedback"
payload = {
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"valuableSources": [
{
"url": "<string>",
"reason": "<string>"
}
],
"valuableResults": [
{
"position": 50,
"reason": "<string>"
}
],
"missingContent": [
{
"topic": "<string>",
"description": "<string>"
}
],
"querySuggestions": "<string>",
"origin": "api",
"integration": "<string>",
"issues": ["<string>"],
"tags": ["<string>"],
"note": "<string>",
"url": "<string>",
"pageNumbers": [2],
"metadata": {}
}
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',
valuableSources: [{url: '<string>', reason: '<string>'}],
valuableResults: [{position: 50, reason: '<string>'}],
missingContent: [{topic: '<string>', description: '<string>'}],
querySuggestions: '<string>',
origin: 'api',
integration: '<string>',
issues: ['<string>'],
tags: ['<string>'],
note: '<string>',
url: '<string>',
pageNumbers: [2],
metadata: {}
})
};
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',
'valuableSources' => [
[
'url' => '<string>',
'reason' => '<string>'
]
],
'valuableResults' => [
[
'position' => 50,
'reason' => '<string>'
]
],
'missingContent' => [
[
'topic' => '<string>',
'description' => '<string>'
]
],
'querySuggestions' => '<string>',
'origin' => 'api',
'integration' => '<string>',
'issues' => [
'<string>'
],
'tags' => [
'<string>'
],
'note' => '<string>',
'url' => '<string>',
'pageNumbers' => [
2
],
'metadata' => [
]
]),
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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creditsRefunded": 123,
"alreadySubmitted": true,
"dailyCapReached": true,
"creditsRefundedToday": 123,
"dailyRefundCap": 123,
"warning": "<string>"
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}Feedback Endpoints
Endpoint Feedback
Submit feedback for a completed v2 endpoint job.
POST
/
feedback
Submit feedback for a v2 job
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",
"valuableSources": [
{
"url": "<string>",
"reason": "<string>"
}
],
"valuableResults": [
{
"position": 50,
"reason": "<string>"
}
],
"missingContent": [
{
"topic": "<string>",
"description": "<string>"
}
],
"querySuggestions": "<string>",
"origin": "api",
"integration": "<string>",
"issues": [
"<string>"
],
"tags": [
"<string>"
],
"note": "<string>",
"url": "<string>",
"pageNumbers": [
2
],
"metadata": {}
}
'import requests
url = "https://api.firecrawl.dev/v2/feedback"
payload = {
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"valuableSources": [
{
"url": "<string>",
"reason": "<string>"
}
],
"valuableResults": [
{
"position": 50,
"reason": "<string>"
}
],
"missingContent": [
{
"topic": "<string>",
"description": "<string>"
}
],
"querySuggestions": "<string>",
"origin": "api",
"integration": "<string>",
"issues": ["<string>"],
"tags": ["<string>"],
"note": "<string>",
"url": "<string>",
"pageNumbers": [2],
"metadata": {}
}
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',
valuableSources: [{url: '<string>', reason: '<string>'}],
valuableResults: [{position: 50, reason: '<string>'}],
missingContent: [{topic: '<string>', description: '<string>'}],
querySuggestions: '<string>',
origin: 'api',
integration: '<string>',
issues: ['<string>'],
tags: ['<string>'],
note: '<string>',
url: '<string>',
pageNumbers: [2],
metadata: {}
})
};
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',
'valuableSources' => [
[
'url' => '<string>',
'reason' => '<string>'
]
],
'valuableResults' => [
[
'position' => 50,
'reason' => '<string>'
]
],
'missingContent' => [
[
'topic' => '<string>',
'description' => '<string>'
]
],
'querySuggestions' => '<string>',
'origin' => 'api',
'integration' => '<string>',
'issues' => [
'<string>'
],
'tags' => [
'<string>'
],
'note' => '<string>',
'url' => '<string>',
'pageNumbers' => [
2
],
'metadata' => [
]
]),
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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\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 \"valuableSources\": [\n {\n \"url\": \"<string>\",\n \"reason\": \"<string>\"\n }\n ],\n \"valuableResults\": [\n {\n \"position\": 50,\n \"reason\": \"<string>\"\n }\n ],\n \"missingContent\": [\n {\n \"topic\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"querySuggestions\": \"<string>\",\n \"origin\": \"api\",\n \"integration\": \"<string>\",\n \"issues\": [\n \"<string>\"\n ],\n \"tags\": [\n \"<string>\"\n ],\n \"note\": \"<string>\",\n \"url\": \"<string>\",\n \"pageNumbers\": [\n 2\n ],\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"creditsRefunded": 123,
"alreadySubmitted": true,
"dailyCapReached": true,
"creditsRefundedToday": 123,
"dailyRefundCap": 123,
"warning": "<string>"
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}{
"success": false,
"error": "<string>",
"feedbackErrorCode": "<string>",
"details": [
{}
]
}Use endpoint feedback to tell Firecrawl whether a completed job result was useful, partial, or bad. This is for endpoint-level output quality on jobs such as
scrape, parse, map, and search.
The generic feedback schema can carry search-style fields too, but Search Feedback is the preferred search-specific entry point because it is scoped to a search job ID and highlights valuable sources, missing content, query suggestions, and refund behavior.
Example Request
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"
}'
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Submit feedback for a v2 job. Include at least one substantive signal such as issues, note, valuableSources, valuableResults for search, missingContent, querySuggestions, url, or pageNumbers.
Available options:
good, partial, bad Available options:
search, scrape, parse, map Maximum array length:
50Show child attributes
Show child attributes
Results that were useful, each addressed by the data group it appears in and its 1-indexed position within that group. Results are returned grouped (data.web, data.images, data.news) and each group is numbered from 1 independently, so source is required. List every useful result; unlisted results are treated as not useful. Positions beyond what the group actually returned are ignored.
Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
2000Maximum array length:
20Maximum string length:
80Pattern:
^[a-z0-9][a-z0-9_-]*$Maximum array length:
20Maximum string length:
80Pattern:
^[a-z0-9][a-z0-9_-]*$Maximum string length:
4000Maximum array length:
100Required range:
x >= 1Small endpoint-specific metadata object. Must be 8KB or smaller; do not include full endpoint results.