Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Query Parameters

run

Only feedback on these run IDs.

key
string[] | null

Only feedback with these keys.

session

Only feedback in these tracing project (session) IDs.

source
enum<string>[] | null

Only feedback from these source types: api, model, app, or auto_eval.

Enum for feedback source types.

Available options:
api,
model,
app,
auto_eval
limit
integer
default:100

The maximum number of feedback to return, 1 to 100.

Required range: 1 <= x <= 100
offset
integer
default:0

The number of feedback to skip, for paging.

Required range: x >= 0
user
string<uuid>[] | null

Only feedback written by these user IDs.

has_comment
boolean | null

true returns only feedback with a non-empty comment; false only feedback without one.

has_score
boolean | null

true returns only feedback with a score; false only feedback without one.

level
enum<string> | null

run returns only feedback on a run; session returns only feedback on a whole tracing project, and requires session. Feedback level: run for feedback on a run, session for feedback on a whole tracing project (session level requires a session filter).

Available options:
run,
session
max_created_at
string<date-time> | null

Only feedback created at or before this ISO 8601 time.

min_created_at
string<date-time> | null

Only feedback created at or after this ISO 8601 time.

feedback_thread_id
string | null

Only feedback on this thread. Requires exactly one session and cannot be combined with run.

include_user_names
boolean | null

Whether to add the author's name to each feedback's source.

comparative_experiment_id
string<uuid> | null

Only feedback written for this comparative (pairwise) experiment.

Response

Successful Response

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