Search Feedback

Submit quality feedback for a search job and help improve Firecrawl search results.

1 min read

post/search/{jobId}/feedback

Request example

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

Response

{
  "success": true,
  "feedbackId": "<string>",
  "creditsRefunded": 1,
  "alreadySubmitted": true,
  "dailyCapReached": true,
  "creditsRefundedToday": 1,
  "dailyRefundCap": 1,
  "warning": "<string>"
}

post/search/{jobId}/feedback

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

Authorization

Authorizationstringheaderrequired#

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

Path parameters

jobIdstringrequired#

Search job id returned by /search.

Body

application/json

ratingenum<string>required#

Options:goodpartialbad

valuableSourcesobject[]#

Items: max 50

Show child attributes

urlstringrequired#

reasonstring#

Length: max 1000

missingContentobject[]#

Items: max 20

Show child attributes

topicstringrequired#

Length: 1–200

descriptionstring#

Length: max 2000

querySuggestionsstring#

Length: max 2000

originstring#

Default: "api"

integrationstring#

Responses

application/json

Feedback recorded

successbooleanrequired#

feedbackIdstringrequired#

creditsRefundednumberrequired#

alreadySubmittedboolean#

dailyCapReachedboolean#

creditsRefundedTodaynumber#

dailyRefundCapnumber#

warningstring#

Search Scrape