KarakeepInstall

Summary

Create a highlight on a bookmark

Inputs

• bookmarkId (required) — The ID of the bookmark this highlight belongs to
• text (required) — The text content that is being highlighted
• startOffset (required) — The character position where the highlight starts (0-based index)
• endOffset (required) — The character position where the highlight ends (0-based index)
• color — The color of the highlight
• note — Optional note or annotation for the highlight

Output shape

the created highlight object

Contains all fields of the newly created highlight; may include additional metadata such as generated IDs.

Examples

Example 1: Add a yellow highlight to a bookmark

bookmarkId: "123", text: "Important", startOffset: 10, endOffset: 20, color: "yellow"

Example 2: Create a red highlight with a note

bookmarkId: "456", text: "Meeting", startOffset: 5, endOffset: 11, color: "red", note: "Discussed in weekly sync"