Submit feedback on an agent run

POST

https://api.middesk.com/v1/runs/:id/feedback

Records a rating on an agent run artifact. 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 this artifact.

Allowed values:

artifact_idstringRequiredformat: "uuid"

Identifier of the artifact to rate.

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.

artifact_idstringformat: "uuid"

Identifier of the artifact within the run that was rated.

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, artifact) 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

$	curl -X POST https://api.middesk.com/v1/runs/id/feedback \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"rating": "POSITIVE",
>	"artifact_id": "artifact_id"
>	}'

1	{
2	"object": "run_feedback",
3	"id": "id",
4	"run_id": "run_id",
5	"rating": "POSITIVE",
6	"artifact_id": "artifact_id",
7	"comment": "comment",
8	"reviewer": {
9	"type": "User",
10	"id": "id"
11	},
12	"superseded_prior": true,
13	"created_at": "2024-01-15T09:30:00Z"
14	}