Bookmarks

Search bookmarks

Changed on

Search across all bookmarks using full-text, semantic, or hybrid ranking. Full-text search covers bookmark titles, content, descriptions, and notes. Results default to full-text relevance sorting; semantic and hybrid modes support relevance sorting only.

get/bookmarks/search

Request

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

Query parameters

qstring required

The search query string.

searchMode'fts' | 'semantic' | 'hybrid'

Search strategy. 'fts' uses full-text search, 'semantic' uses bookmark embeddings, and 'hybrid' fuses a fixed candidate window from both. Hybrid falls back to full-text search when the query contains no free-text terms or when embedding infrastructure is unavailable. Semantic hits below a minimum similarity are dropped, so semantic search may return fewer results than requested.

sortOrder'asc' | 'desc' | 'relevance'

Sort order for results. Defaults to 'relevance'. Use 'asc' or 'desc' for date-based sorting.

limitnumber

Maximum number of items to return per page.

cursorstring

Cursor from a previous response to fetch the next page.

includeContentboolean

If set to true, the bookmark's full content (HTML, text, etc.) will be included in the response. Set to false for lighter responses when only metadata is needed.

Response

A paginated list of bookmarks matching the search query.

nextCursorstring nullable required

Cursor for the next page, or null if no more results.

Changes

  • b7f6f8890a7dRevision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

  • 26ab7882748dRevision changes
    • info

      added the optional property // to the response with the status