Sign in
Bookmarks

Attach asset to a bookmark

Changed on

Attach a previously uploaded asset to a bookmark. The asset must be uploaded first via the POST /assets endpoint.

post/bookmarks/{bookmarkId}/assets

Request

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

Path parameters

bookmarkIdstring required

The unique identifier of the bookmark.

Example:ieidlxygmwj87oxz5hxttoc8

Request body

idstring required

The ID of the previously uploaded asset.

assetType'linkHtmlContent' | 'screenshot' | 'pdf' | 'assetScreenshot' | 'bannerImage' | 'fullPageArchive' | 'video' | 'bookmarkAsset' | 'precrawledArchive' | 'userUploaded' | 'avatar' | 'unknown' required

The type classification for this asset.

Response

The asset was attached successfully.

idstring required
assetType'linkHtmlContent' | 'screenshot' | 'pdf' | 'assetScreenshot' | 'bannerImage' | 'fullPageArchive' | 'video' | 'bookmarkAsset' | 'precrawledArchive' | 'userUploaded' | 'avatar' | 'unknown' required
fileNamestring nullable

Changes

  • 6210da080616Revision changes
    • info

      api operation id attachAssetToBookmark was added

    • info

      added the non-success response with the status

  • 09f764040988Revision changes
    • warning

      added the new pdf enum value to the response property for the response status

    • info

      added the new pdf enum value to the request property