Skip to main content
POST
web.search-feedback

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by web.search-options.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
scope
enum<string>
default:request

Apply to this search or its caller-owned session. Default request.

Available options:
request,
session
agentScore

Agent's search usefulness score.

humanScore

Human's search usefulness score.

scores
object[]

Up to 50 labeled usefulness scores.

Maximum array length: 50
comment
string

Feedback comment, up to 10,000 characters.

Maximum string length: 10000
answer
string

Answer delivered, up to 50,000 characters.

Maximum string length: 50000
usedUrls
string[]

Up to 100 source URLs used.

Maximum array length: 100
usedCitations
string[]

Up to 100 citation labels used.

Maximum array length: 100
Maximum string length: 2000
resultScores
object[]

Up to 100 source-specific usefulness assessments.

Maximum array length: 100

Response

The result

accepted
boolean
required

Whether the feedback was accepted.