Skip to main content
POST
/
search
/
{jobId}
/
feedback
Submit feedback for a search job
curl --request POST \
  --url https://api.firecrawl.dev/v2/search/{jobId}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ],
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "querySuggestions": "<string>",
  "origin": "api",
  "integration": "<string>"
}
'
{
  "success": true,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "creditsRefunded": 123,
  "alreadySubmitted": true,
  "dailyCapReached": true,
  "creditsRefundedToday": 123,
  "dailyRefundCap": 123,
  "warning": "<string>"
}
Use search feedback after a search result is used or fails to help. Feedback improves result quality and can refund 1 credit for the first feedback submission on a search job, subject to team limits.

​
Example Request

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."
      }
    ],
    "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"
  }'

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
jobId
string<uuid>
required

Search job id returned by /search.

Body

application/json

For 'good', include valuableSources. For 'partial', include valuableSources or missingContent. For 'bad', include missingContent or querySuggestions.

​
rating
enum<string>
required
Available options:
good,
partial,
bad
​
valuableSources
object[]
Maximum array length: 50
​
missingContent
object[]
Maximum array length: 20
​
querySuggestions
string
Maximum string length: 2000
​
origin
string
default:api
​
integration
string | null

Response

Feedback recorded

​
success
boolean
required
Example:

true

​
feedbackId
string<uuid>
required
​
creditsRefunded
number
required
​
alreadySubmitted
boolean
​
dailyCapReached
boolean
​
creditsRefundedToday
number
​
dailyRefundCap
number
​
warning
string