Bookmarks

Get readable bookmark content

Changed on

Retrieve a bounded chunk of an agent-readable bookmark representation. Link content is rendered from extracted HTML; text and media bookmarks use their stored or extracted text. Continue reading by passing the opaque nextCursor from the previous response.

get/bookmarks/{bookmarkId}/content

Request

  • Base URL: https://try.karakeep.app/api/v1
  • URL: https://try.karakeep.app/api/v1/bookmarks/{bookmarkId}/content
  • Auth: HTTP bearer

Path parameters

bookmarkIdstring required

The unique identifier of the bookmark.

Example:ieidlxygmwj87oxz5hxttoc8

Query parameters

format'markdown' | 'text'

The readable representation. If omitted with a cursor, the cursor's format is used; otherwise defaults to markdown.

maxCharsinteger

Maximum number of Unicode characters to return. The chunk may end earlier at a paragraph or line boundary.

cursorstring

Opaque continuation cursor returned as nextCursor by a previous response.

Response

A bounded chunk of readable bookmark content.

bookmarkIdstring required
bookmarkType'link' | 'text' | 'asset' required
format'markdown' | 'text' required
contentstring required
contentVersionstring required

A hash identifying the rendered content version used by this cursor.

nextCursorstring nullable required

Cursor for the next chunk, or null when all content has been returned.

truncatedboolean required

Whether more readable content remains after this chunk.

Changes