Evaluation

Score a highlight

Score an individual highlight.

post/evaluate/highlight/{highlight_id}

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/evaluate/highlight/{highlight_id}
  • Auth
    HTTP bearer

Path parameters

highlight_idstring required

Headers

X-As-Userstring nullable

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Request body

scorenumber

Rating of the chunk from -1 (bad) to +1 (good).

commentstring nullable

What was right or wrong with the highlight.

Response

Successful Response

successboolean required

Whether the feedback was successfully saved.

messagestring required

A message describing the result.

Changes

No operation changes recorded.