MImiddesk
runs

Submit feedback on an agent run

Changed on

Records a rating on something an agent run produced: an artifact or, with subject_type message, an Assistant reply. The rating can be POSITIVE or NEGATIVE. Attribution defaults to the authenticated user; API-key callers are attributed to their account instead.

post/v1/runs/{id}/feedback

Request

Path parameters

idstring required

Agent run ID

Request body

rating'POSITIVE' | 'NEGATIVE' required

Rating value to record for the rated subject.

artifact_idstring uuid required

Identifier of the rated subject. Its meaning is given by subject_type.

subject_type'artifact' | 'message'

What artifact_id refers to. artifact is an op Artifact (for example a litigation or lien finding); message is an Assistant reply message.

commentstring nullable

Optional free-text comment explaining the rating. Whitespace is stripped server-side; empty or whitespace-only strings are normalized to null.

Response

feedback recorded successfully

objectstring required

Object type identifier.

idstring uuid required

Unique identifier for the feedback record.

run_idstring uuid required

Identifier of the agent run the feedback is attached to.

rating'POSITIVE' | 'NEGATIVE' required

Rating value submitted by the reviewer.

artifact_idstring uuid required

Identifier of the rated subject within the run. Its meaning is given by subject_type.

subject_type'artifact' | 'message' required

What artifact_id refers to. artifact is an op Artifact (for example a litigation or lien finding); message is an Assistant reply message.

commentstring nullable required

Optional free-text comment submitted with the rating.

superseded_priorboolean required

True if a prior active rating from the same reviewer for the same (run, subject_type, artifact_id) tuple was superseded by this new rating.

created_atstring date-time required

Timestamp when the feedback was created.

Changes

  • a32370f9357eRevision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status

  • 4c9cd4e834baRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API