Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Path Parameters

feedback_id
string<uuid>
required

Query Parameters

include_user_names
boolean | null

Response

Successful Response

Schema for getting feedback.

key
string
required

The feedback key: the metric, tag, or aspect being scored, for example correctness.

id
string<uuid>
required
created_at
string<date-time>

When the feedback was created, as an ISO 8601 timestamp. Defaults to now.

modified_at
string<date-time>

When the feedback was last modified, as an ISO 8601 timestamp. Defaults to now.

score

The numeric or boolean score. Numbers must be between -99999.9999 and 99999.9999 with at most 4 decimal places.

value

A non-numeric value, such as a category label or a JSON object. Dropped if it exceeds the feedback size limit.

comment
string | null

A free-text comment explaining the feedback. Truncated at the feedback size limit.

correction

The corrected output for the run, as a string or a JSON object. Dropped if it exceeds the feedback size limit.

feedback_group_id
string<uuid> | null

Groups feedback written together, such as one comparison in a pairwise experiment.

comparative_experiment_id
string<uuid> | null

The ID of the comparative (pairwise) experiment this feedback was written for.

run_id
string<uuid> | null

The ID of the run the feedback is about. Omit it for feedback on a whole tracing project or a thread.

session_id
string<uuid> | null

The ID of the tracing project (session) the feedback belongs to.

trace_id
string<uuid> | null
start_time
string<date-time> | null
is_root
boolean
default:false
feedback_source
FeedbackSource · object | null

The feedback source loaded from the database.

extra
Extra · object | null
feedback_thread_id
string | null