Highlights

Create a new highlight

Changed on

Create a new text highlight on a bookmark. Highlights are defined by character offsets within the bookmark's content and support color coding.

post/highlights

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/highlights
  • Auth: HTTP bearer

Request body

bookmarkIdstring required
startOffsetnumber required
endOffsetnumber required
color'yellow' | 'red' | 'green' | 'blue'
textstring nullable required
notestring nullable required

Response

The created highlight.

bookmarkIdstring required
startOffsetnumber required
endOffsetnumber required
color'yellow' | 'red' | 'green' | 'blue'
textstring nullable required
notestring nullable required
idstring required
userIdstring required
createdAtstring date-time required

Changes

  • 6210da080616Revision changes
    • info

      api operation id createHighlight was added

    • info

      added the non-success response with the status