Skip to navigation
Middesk APIAgentsRuns

Submit feedback on an agent run

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.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
Agent run ID

Request

This endpoint expects an object.
ratingenumRequired
Rating value to record for the rated subject.
Allowed values:
artifact_idstringRequiredformat: "uuid"

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

subject_typeenumOptionalDefaults to artifact

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

Allowed values:
commentstring or nullOptional<=5000 characters

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
Object type identifier.
idstringformat: "uuid"
Unique identifier for the feedback record.
run_idstringformat: "uuid"
Identifier of the agent run the feedback is attached to.
ratingenum
Rating value submitted by the reviewer.
Allowed values:
artifact_idstringformat: "uuid"

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

subject_typeenum

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

Allowed values:
commentstring or null

Optional free-text comment submitted with the rating.

reviewerobject

The actor that submitted the feedback. Sidepanel/session callers attribute to a User; API-key callers attribute to the Account.

superseded_priorboolean

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_atdatetime
Timestamp when the feedback was created.

Errors

404
Submit Agent Run Feedback Request Not Found Error
422
Submit Agent Run Feedback Request Unprocessable Entity Error