Skip to main content
POST
Submit feedback for a search job
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

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