Skip to main content
POST
Send worksheet feedback
Use step_name to point feedback at one part of the worksheet: metadata, question_configuration, question_generation, or explanation. Leave it out for feedback on the whole worksheet. A successful call returns 201. The id in the response is the new feedback’s ID, not the worksheet ID.

Authorizations

Authorization
string
header
required

Access token from Get an access token.

Path Parameters

work_sheet_id
string<uuid>
required

The worksheet id returned by Start a worksheet.

Example:

"152764ca-1685-427c-aba7-4b92dcc0d60f"

Body

application/json
comment
string
required

The feedback text.

feedback_type
enum<string>
required
Available options:
general,
content,
quality,
suggestion
rating
integer
Required range: 1 <= x <= 5
step_name
string

The step the feedback is about, such as question_configuration, question_generation, or explanation.

component_name
string

A specific part of the step, if relevant.

feedback_data
object

Any structured data you want to store with the feedback.

Response

Feedback saved. id is the feedback ID.

detail
object[]