Endpoint Feedback

Submit feedback for a completed v2 endpoint job.

1 min read

post/feedback

Request example

curl --request POST \
  --url https://api.firecrawl.dev/v2/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>",
  "endpoint": "search",
  "jobId": "<string>",
  "issues": [
    "<string>"
  ],
  "tags": [
    "<string>"
  ],
  "note": "<string>",
  "url": "<string>",
  "pageNumbers": [
    1
  ],
  "metadata": {}
}'

Response

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

post/feedback

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

Authorization

Authorizationstringheaderrequired#

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

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#

endpointenum<string>required#

Options:searchscrapeparsemap

jobIdstringrequired#

issuesstring[]#

Items: max 20

tagsstring[]#

Items: max 20

notestring#

Length: max 4000

urlstring#

pageNumbersinteger[]#

Items: max 100

metadataobject#

Small endpoint-specific metadata object. Must be 8KB or smaller; do not include full endpoint results.

Responses

application/json

Feedback recorded

successbooleanrequired#

feedbackIdstringrequired#

creditsRefundednumberrequired#

alreadySubmittedboolean#

dailyCapReachedboolean#

creditsRefundedTodaynumber#

dailyRefundCapnumber#

warningstring#

Cancel Agent Ask