跳转到主要内容
POST
/
search
/
{jobId}
/
feedback
提交搜索任务反馈
curl --request POST \
  --url https://api.firecrawl.dev/v2/search/{jobId}/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "integration": "<string>",
  "missingContent": [
    {
      "topic": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "api",
  "querySuggestions": "<string>",
  "valuableSources": [
    {
      "url": "<string>",
      "reason": "<string>"
    }
  ]
}
'
{
  "creditsRefunded": 123,
  "feedbackId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "success": true,
  "alreadySubmitted": true,
  "creditsRefundedToday": 123,
  "dailyCapReached": true,
  "dailyRefundCap": 123,
  "warning": "<string>"
}
在使用了 search 结果后,或结果未能提供帮助时,可使用搜索反馈。反馈可提升结果质量,并且针对某个搜索任务首次提交反馈时可退还 1 个额度,具体取决于团队限制。

请求示例

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
string
header
必填

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

路径参数

jobId
string<uuid>
必填

由 /search 返回的搜索任务 ID。

请求体

application/json

若为“good”,请包含 valuableSources。若为“partial”,请包含 valuableSources 或 missingContent。若为“bad”,请包含 missingContent 或 querySuggestions。

rating
enum<string>
必填
可用选项:
good,
partial,
bad
integration
string | null
missingContent
object[]
Maximum array length: 20
origin
string
默认值:api
querySuggestions
string
Maximum string length: 2000
valuableSources
object[]
Maximum array length: 50

响应

反馈已记录

creditsRefunded
number
必填
feedbackId
string<uuid>
必填
success
boolean
必填
示例:

true

alreadySubmitted
boolean
creditsRefundedToday
number
dailyCapReached
boolean
dailyRefundCap
number
warning
string