This new feature provides the ability to take full advantage of our on-platform reporting and training features for off-platform projects by allowing feedback to be programmatically added through an API.

Introduces ability to use an Endpoint to: Add shape and field feedback Get shape and field feedback at the task level and feedback level Delete shape and field feedback

Release Stage

Overview

Previously, there was no way to programmatically add feedback when reviews occurred outside the platform. This made it difficult to centralize quality data and take full advantage of our analytics and training tools.

With this update, we’re introducing an API for adding external feedback programmatically. This enhancement ensures that off-platform insights are captured in our system, enabling more complete data coverage and unlocking deeper reporting and training capabilities.

How to use it?

Before using the new endpoints, make sure you have the required authentication credentials and project/task identifiers. You can get your client access key following this tutorial. 

How to Access the API Documentation?

You can access the API documentation to explore full request/response structures and usage details.

Step-by-Step

Step 1: Go to the Feedback Retrieval API documentation
▸ Get Task Feedback by Round
This endpoint retrieves all feedback entries associated with a specific task (bsonId) within a given review round. It's typically used to access comments, annotations, or quality issues provided during that round.

Step 2: Go to the Feedback Submission API documentation
▸ Post Feedback for a Task and Round
Use this endpoint to add feedback to a task during a specific review round.

• Feedback is saved in draft mode by default (readonly: true) and can be edited.
• To finalize feedback (making it uneditable), pass the finalize: true flag.
• You can also finalize all existing feedback by calling the endpoint with finalize: true and omitting the feedback list.

Step 3: Go to the Feedback Deletion API documentation
▸ Delete Feedback for a Task and Round
This endpoint deletes feedback entries associated with a task and round.

• Returns the IDs of successfully deleted feedback items.
• If some feedback IDs are not found, those will also be reported.

Use case

Off-platform projects such as WRT, JSU, AUF, and AVRide can use this to incorporate feedback so that we can manage and improve our quality!

How can you enable this feature?

There is no setup required - you can just use the API using the instructions listed above in the How to use it? section.