Karakeep
ProductivityAPI key
Manage bookmarks, lists, tags, highlights, assets, backups, feeds, users, and administrative jobs on Karakeep.
49 actions
| Action | Effect | Data handled | Scope |
|---|---|---|---|
| karakeep_get_current_userGet the profile of the Karakeep user that owns the connected API key, including name, email and avatar | read | Personal data | |
| karakeep_get_current_user_statsGet usage statistics for the Karakeep user that owns the connected API key, including bookmark, tag, list and asset counts | read | General | |
| karakeep_list_bookmarksList the bookmarks of the connected Karakeep user, optionally filtered by archived or favourited status, sorted by creation date and paged with a cursor | read | General | |
| karakeep_search_bookmarksSearch the bookmarks of the connected Karakeep user with full text, semantic or hybrid search | read | General | |
| karakeep_check_bookmark_urlCheck whether a URL is already bookmarked and return the id of the existing bookmark, or null when it is not | read | General | |
| karakeep_get_bookmarkGet a single bookmark with its tags, content and attached assets | read | General | |
| karakeep_update_bookmarkUpdate a bookmark | destructive | General | |
| karakeep_delete_bookmarkPermanently delete a bookmark together with its tags, highlights and attached assets | destructive | General | |
| karakeep_get_bookmark_contentRead the readable content of a bookmark in chunks as markdown or plain text | read | General | |
| karakeep_summarize_bookmarkGenerate an AI summary for a link bookmark and return it | destructive | General | |
| karakeep_get_bookmark_listsList the Karakeep lists that contain a bookmark | read | General | |
| karakeep_get_bookmark_highlightsList the highlights stored on a bookmark | read | General | |
| karakeep_attach_asset_to_bookmarkAttach an already uploaded asset to a bookmark, for example a screenshot or a PDF | write | General | |
| karakeep_replace_asset_on_bookmarkReplace an asset that is attached to a bookmark with a different, already uploaded asset | destructive | General | |
| karakeep_detach_asset_from_bookmarkDetach an asset from a bookmark | destructive | General | |
| karakeep_list_listsRetrieve all bookmark lists for the authenticated Karakeep user, including both manual and smart lists | read | General | |
| karakeep_create_listCreate a new bookmark list | write | General | |
| karakeep_get_listRetrieve a single Karakeep list by its id | read | General | |
| karakeep_update_listPartially update a Karakeep list | write | General | |
| karakeep_delete_listDelete a Karakeep list | destructive | General | |
| karakeep_get_list_bookmarksRetrieve one page of the bookmarks inside a Karakeep list | read | General | |
| karakeep_add_bookmark_to_listAdd a bookmark to a manual Karakeep list | write | General | |
| karakeep_remove_bookmark_from_listRemove a bookmark from a manual Karakeep list | destructive | General | |
| karakeep_list_tagsRetrieve one page of Karakeep tags | read | General | |
| karakeep_create_tagCreate a new Karakeep tag | write | General | |
| karakeep_get_tagRetrieve a single Karakeep tag by its id, including how many bookmarks carry it and who attached it | read | General | |
| karakeep_update_tagRename a Karakeep tag | write | General | |
| karakeep_delete_tagDelete a Karakeep tag | destructive | General | |
| karakeep_get_tag_bookmarksRetrieve one page of the bookmarks that carry a given Karakeep tag | read | General | |
| karakeep_list_highlightsRetrieve one page of the highlights the authenticated Karakeep user has made across all bookmarks | read | General | |
| karakeep_create_highlightCreate a text highlight on a Karakeep bookmark | write | General | |
| karakeep_get_highlightRetrieve a single Karakeep highlight by its id | read | General | |
| karakeep_update_highlightPartially update a Karakeep highlight | write | General | |
| karakeep_delete_highlightDelete a Karakeep highlight and return the record that was removed | destructive | General | |
| karakeep_get_asset_signed_urlCreate a short lived signed download URL for a Karakeep asset | read | General | |
| karakeep_list_backupsList every account backup recorded for the connected Karakeep user, including the ones that are still pending and the ones that failed | read | Personal data | |
| karakeep_create_backupTrigger a new full account backup for the connected Karakeep user | write | Personal data | |
| karakeep_get_backupGet one Karakeep backup by id, including its current status, archive size, bookmark count and failure message | read | General | |
| karakeep_delete_backupPermanently delete a Karakeep backup record together with the archive file it produced | destructive | General | |
| karakeep_list_feedsRetrieve all RSS feed subscriptions for the authenticated Karakeep user | read | General | |
| karakeep_create_feedCreate a new RSS feed subscription | write | General | |
| karakeep_get_feedRetrieve a single RSS feed subscription by its id | read | General | |
| karakeep_update_feedUpdate an RSS feed subscription | destructive | General | |
| karakeep_delete_feedDelete an RSS feed subscription | destructive | General | |
| karakeep_fetch_feed_nowTrigger an immediate fetch of an RSS feed subscription | write | General | |
| karakeep_admin_update_userUpdate another Karakeep user's role, bookmark quota, storage quota or browser crawling setting | destructive | Personal data | |
| karakeep_admin_trigger_recrawlTrigger a recrawl of link bookmarks across the whole Karakeep instance | write | General | |
| karakeep_admin_trigger_reindexTrigger a reindex of bookmarks in the Karakeep search engine | destructive | General | |
| karakeep_admin_trigger_inferenceTrigger AI inference, either tagging or summarization, on bookmarks across the whole Karakeep instance | write | General |