Skip to main content
POST
Submit feedback for a v2 job
Submit feedback on the quality of a job’s output, including useful results, missing content, or incorrect data. For jobs created with an API key, include your key and use the Authenticated request format. For keyless jobs, omit Authorization and use the Search, Scrape, or Parse request format. Keyless Parse feedback does not automatically retain the document, extracted output, page images, or layout blocks. Submitted observations and corrections are retained.

Authenticated example

Keyless example

Keyless limits and failures

Every eligible keyless Search, Scrape, or Parse response includes a feedback pointer and this documentation link. Use the returned job ID from the same caller IP within 24 hours. The default allowance is one accepted submission per caller IP per UTC day across all three endpoints and clients; the invitation states the deployment allowance. There are 30 submission attempts per minute, including rejected requests. Retrying a recorded submission returns its original feedback ID without using another daily slot. The serialized stored keyless metadata must fit within 8 KiB (8192 UTF-8 bytes), including server defaults and verification flags. Keep observations concise and omit raw outputs. For Search, positions refer to the ordered results in the delivered web, images, or news group. Specify source for multi-source jobs and for images-only or news-only jobs; omission defaults to web. If the saved Search response is unavailable, otherwise valid feedback is accepted with an internal metadata.unverified: true marker because positions could not be checked. Ownership and requested sources are still checked. Invalid positions in available results are rejected. An explicitly failed job can receive a failure observation. Use the reported error, without diagnosing an unobserved cause. For example, replace the observation in your submission with:
A failure observation has no position, source, format, location, or page. Parse still requires a top-level docClass, which may be unknown. The API accepts this observation only for a saved failed job. Requests rejected before execution, such as invalid input or exhausted operation quota, are not feedback jobs.

Authorizations

Authorization
string
header
required

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

Body

application/json

Submit feedback for a v2 job. Include at least one substantive signal such as issues, note, valuableSources, missingContent, querySuggestions, url, or pageNumbers.

rating
enum<string>
required
Available options:
good,
partial,
bad
endpoint
enum<string>
required
Available options:
search,
scrape,
parse,
map
jobId
string<uuid>
required
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
issues
string[]
Maximum array length: 20
Maximum string length: 80
Pattern: ^[a-z0-9][a-z0-9_-]*$
tags
string[]
Maximum array length: 20
Maximum string length: 80
Pattern: ^[a-z0-9][a-z0-9_-]*$
note
string
Maximum string length: 4000
url
string<uri>
pageNumbers
integer[]
Maximum array length: 100
Required range: x >= 1
metadata
object

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

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