Skip to main content
POST
/
v1
/
feedback
Record feedback
curl --request POST \
  --url https://search-api-staging-779189860552.europe-west1.run.app/v1/feedback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "accepted": true,
  "access": {
    "rate_limit": {
      "limit_rps": 123,
      "remaining": 123,
      "reset_at": "<string>"
    },
    "tier": "<string>"
  },
  "feedback_id": "<string>",
  "request_id": "<string>",
  "session_id": "<string>",
  "$schema": "<string>",
  "usage": {
    "approx_tokens": 123,
    "bytes_returned": 123,
    "requests": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Session-ID
string

Optional client session identifier.

Body

application/json
​
event_type
enum<string>
required

What happened: result_helpful / result_not_helpful (the result did or did not advance the task), passage_used (a passage was used or cited), read_abandoned (opened but abandoned), duplicate_result, stale_result (outdated content), spam_or_low_quality, missing_expected_source (a source you expected did not appear), unsafe_or_policy_issue.

Available options:
result_helpful,
result_not_helpful,
passage_used,
read_abandoned,
duplicate_result,
stale_result,
spam_or_low_quality,
missing_expected_source,
unsafe_or_policy_issue
​
agent_context
object

Optional calling-agent context for slicing feedback in evaluation.

​
doc_id
string<uuid>

Document the event concerns, from the result's doc_id.

​
notes
string

Free-text context, recorded for human review and offline evaluation.

​
passage_id
string<uuid>

Specific passage the event concerns, from passages[].passage_id; most useful with passage_used.

​
query
string

Query text the event relates to, useful when no search_id is available.

​
rank
integer<int64>

One-based position the result had in the ranked list.

Required range: x >= 1
​
search_id
string<uuid>

The search_id returned by /v1/search. Ties feedback to the exact ranked list that produced the result, so ranking learns from the right context.

​
session_id
string<uuid>

Session the event belongs to (UUID), matching session_id from earlier responses.

Response

Feedback accepted.

​
accepted
boolean
required
​
access
object
required
​
feedback_id
string
required
​
request_id
string
required
​
session_id
string
required
​
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://search-api-staging-779189860552.europe-west1.run.app/FeedbackResponse.json"

​
usage
object