Submit feedback & request refunds

Record quality feedback on an order, and optionally request a credit refund if the result wasn't clinically useful.

Use this endpoint to report a problem or suggestion about an order. You can also request a credit refund when the result was not usable.

Two paths

From the viewer UI, the "Report problem" button in the top bar. Integrators embedding the viewer often keep this visible so end users can report issues directly.
Via the API, POST /feedback/. Useful when you're not using the viewer, or attaching feedback from your own QC process.

Submit feedback (no refund)

POST https://api.automate.relu.ai/feedback/
  ?order_id=<order_id>
  &feedback_text=<description>
  &request_refund=false
  &update_order_status=true

Scope required

This endpoint requires the following scope: create:refunds

feedback_text describes the issue or suggestion. No credits are affected. update_order_status defaults to true, which also sets the order status to Rejected. Set it to false to leave the current approval status unchanged.

Request a refund

Same endpoint, request_refund=true:

POST https://api.automate.relu.ai/feedback/
  ?order_id=<order_id>
  &feedback_text=<why the order wasn't usable>
  &request_refund=true
  &update_order_status=true

Scope required

This endpoint requires the following scope: create:refunds

With the default update_order_status=true, the order status is set to Rejected and the refund request enters review. Relu approves or rejects it under the refund eligibility policy in the End-User License Agreement. An approved refund returns credits to the order owner's organization.

Parameters

Parameter	Type	Required	Default	Description
`order_id`	string	yes		The ID of the order.
`feedback_text`	string	yes		Description of the issue or suggestion.
`request_refund`	bool	no	`false`	`true` to also request a credit refund.
`update_order_status`	bool	no	`true`	`true` to set the order status to `Rejected`.

Reject without feedback

Use the order status route when you only need to reject a completed result:

PUT /orders/{order_id}/status?status=Rejected

This does not create feedback or start a refund request. Resetting the order to Unapproved later does not delete feedback or cancel a refund request created through POST /feedback/.

List feedback & refund history

GET https://api.automate.relu.ai/feedback/
  ?include_option=refunds|feedback
  &include_processed=false

Scope required

This endpoint requires the following scope: read:refunds

Filter by include_option: refunds (refund requests only), feedback (non-refund feedback only). Set include_processed=true to also return items that have already been reviewed.

Feedback & refunds, model overview
Orders, order lifecycle

Submit feedback & request refunds

Two paths

Submit feedback (no refund)

Request a refund

Parameters

Reject without feedback

List feedback & refund history

Related

On this page