https://docs.karakeep.app/assets/js/55221d7d.1c661600.js

1"use strict";(globalThis.webpackChunk_karakeep_docs||=[]).push([[23851],{58332(e,t,s){s.r(t),s.d(t,{assets:()=>k,contentTitle:()=>g,default:()=>v,frontMatter:()=>m,metadata:()=>r,toc:()=>h});const r=JSON.parse('{"id":"api/create-bookmark","title":"Create a new bookmark","description":"Create a new bookmark. The bookmark type (link, text, or asset) is determined by the `type` field in the request body. For link bookmarks, if the URL already exists, the existing bookmark is returned with a 200 status.","source":"@site/versioned_docs/version-v0.31.0/api/create-bookmark.api.mdx","sourceDirName":"api","slug":"/api/create-bookmark","permalink":"/v0.31.0/api/create-bookmark","draft":false,"unlisted":false,"editUrl":null,"tags":[],"version":"v0.31.0","frontMatter":{"id":"create-bookmark","title":"Create a new bookmark","description":"Create a new bookmark. The bookmark type (link, text, or asset) is determined by the `type` field in the request body. For link bookmarks, if the URL already exists, the existing bookmark is returned with a 200 status.","sidebar_label":"Create a new bookmark","hide_title":true,"hide_table_of_contents":true,"api":"eJztWuFuI7kNfhVC9+cumDjeRX/5xwHO9hbd3rYXXBIURdaA6Rnao7NGmpM0SbyGgT5En/Ce5EBpPDNOxln7Nijawlhg4UikRJHUR3LEtTAlWfTS6A+ZGInUEnq6NGZZoF2KRGTkUitLJhAj8S5MA4KmB5jVVAO4yan5C/yqJPhWSb1MwNOjT8BYQOfIfwfSQUaebCE1ZTBbgc8JpswxhbkklYHUYczSrxU5DzOTrQbw3ljgBZtNXAJyHghvf/4IqCxhtgJ6lM67JIyH31IvWrmkA0u+srzzg/Q5ILwdDsF59JUbiER4XDgxuhPb0zsxSYSjtLLSr8Tobi1mhJbsuPK5GN1NNpNE1HJemmwlRusn2tpVi4GoXN4qNdqT9syCZalkGixw8YtjvrVwaU4FhlmlfpqHvVlJYiTM7BdKvUhEadlyXpJjOi+9ovAjkjlvpV6IROhKKZzxnLcVJaLAx4+kF3yCN8PhcJMItGku7ynrcM+MUYRabBIxx3vDCtg3r43v2XeTCFcVBdpV71xURDb2X5Y4UOODurLSRDs85yBdFWw4ZR6Y39gClZhsEiGL0lh/Tc7V/t0np6ls2qu67bJYSpGIB5qx4RT/LsxMKmKSR0+aFxeJcFIvFM3jhHVObPcXk81mk6yF0XSYLcPsC8eUehmOV1nVRzdnBXgxEpWVfMLSUlAhZeNo6l5NbKIzS8uWvouzcYsJC/91IjMOBJHDj/1muO070R7Rtmt+rWwBmoJw4dfNF8hlgQvevszmLdMe32Jn+DsWey7I0Sdu5Wu3nWz43yZyuNJoF0/9djh8DkjjFo4CAvpcuh4EjYD+IoIeBWIv20f26+4FjNjwDczkXB4MIQfC41ejocfFQurFdYgph8Dx1qtclaYUMGOOUlU2eBjpjLkmDZrKz0HFr798P4r3qGcvqvfR7kXWfWK+AtImonJk99zHGOGbCbQWV8zsqXB/2FH1vguO3mOaU3b5YtBCPmZeFag5Tuzee5mJev2d1QJd5/b9ZwLLUddoB3cOoA+o2ouF+4jH+3C3zxNTS6RdbvwxXGU2P4Z8Xil1xYJFBDlqp6cR+hjme5mROUpQvJfpgXbJfaHetZ725Vwt0h4jzvbkRySDrw+AWPnc2MOMVc2UdDkdRp2hp6ua4zB9MMff6vB2AMN/b952oKj/03nc3rB3KJY5+bm7rK6KGdkXbtYfVnN/8vjVWq/0UpuHntgVGDg3rbd7/cB7kJk5pv2lA2LdYFBbv17pujs+Q63Jfqh95Am0ixp0ma7OjQPgiR4kFzEhuS2VwYw4nuM9emQTt6o7ysP6coRWFZNNL0GbTe/kzp18dye5fZrJ9iegTa5VZ1atkzY2nzRJQ/NZRcRq5e3wzRe+mDygqz+ZZFDjNxtidao9TrXHqfY41R6n2uNUe5xqj1Ptcao9TrXHqfY41R6H1x5/6nscucSseXb+7V//BqnvUUl+kS4rDxl6fMXCIzVZr76fvtcUmOZS0zk/z7AdgKw1Fph9EGoRco795IClQp73dKGaf/DsySkI2K7f

10eUPzNgosqeIu9UxosnPlAVN8nv8ZXg6B2+WpPkhqZCOU+lkq+bQJUCPJe//RM8M0helQtmv4fbaPWJRBhG7EgRJg6Z8brjFoTQu2AP5DVxcNC0F7Ghk78m6kM6GPFSsMcssObe5wFJe3L/h64dWsgaDHevpqIQ5VorfXXPvSze6uPB2NViixSVROcCyfGYULnfrFcDEfoYfa3qIsrD0nS6Eaz583Lnbi9DogncOMMNkXB4GIsaK8OP99mX4r/+4CRZnt/25bWH4YavBpqGg1W5bnMbspluOxpFYyLUcTb3WDnUK6+7gzvt+/Yz/7O2+s3Bd3NU1W332UEHU9UNL2/v43QFyqeeGz8t2j0Z5MxgOhqL198Yi46sPzyzYTEoHCI7U/Dw3zocbtvUsfkNFzeCC2bn05wo92WBfmRK/tUrHawMqZR4crEzFzSIFalxQt+NF1d0tuHAJ5HKRK7nIeSTiXRI2mWG6rEoHpTULi0WBXqbIH00+6U/6m2+AHYa0r3GLB8dKAemsNFJ7BzUGAO7e2JL3aLpzpuP6eoVFppATZmQH8E9TQYoaFqS5qYgAdTjZklYwt6bY9fAHmsHtB6h0RhbOzq7J83Ozg+8Dz4+0cmdnW7GvcCF1I/JH6XxHZleV7CuQVtYZez5DFrVsOOBeIkzj5DQoaapkIf0Ufq3IrqBEiwV3JdUP39t3dJA6VVVGbNmppkf/rl4idioxsrFaQHpAF/Wy3aRZki05J5/mYZ4XYcFoAGOYcmydwj2qimBu7O4eUmdsIwoLsz0sgTZQGBsErJR3W91sgxtwEHY82HQwBWvMCIymCDCWKDRoudEnfQ5nZ3xpzs7CWcahE2C3QcAEP0cF9R2CgjyGUBjZGZob9gDRoeULGApqkuCcWxoNVZ2MAGcd8G3IhBn6r/78/rsQ0Rie+YPEaF1/3ehvOnt6E9dtxPg/71KLaNcJiu1HkxjT7sSs28HGeMSD6zVfjFurNhseDr7PbWxtRAtNbYmItzkEwSUxINf563mdwQePDej7JP/hjD5yjNOUSv8i7aQTkq9+ur4JCW3soitCciQschzg/0dCJCL6Yoh9YWwtFOpFFbIfEdfc1NV09wPpbgTsfqlCvepIuF5HihvGu81GJPVRAv6J0GPzO29NTqA=","sidebar_class_name":"post api-method","info_path":"api/karakeep-api","custom_edit_url":null},"sidebar":"sidebar","previous":{"title":"Get all bookmarks","permalink":"/v0.31.0/api/list-bookmarks"},"next":{"title":"Search bookmarks","permalink":"/v0.31.0/api/search-bookmarks"}}');var n=s(62540),i=s(43023),a=s(3188),l=s.n(a),p=s(95368),o=s.n(p),u=s(60234),d=s.n(u),c=s(33536),y=s.n(c),b=(s(26269),s(71260),s(3450));const m={id:"create-bookmark",title:"Create a new bookmark",description:"Create a new bookmark. The bookmark type (link, text, or asset) is determined by the `type` field in the request body. For link bookmarks, if the URL already exists, the existing bookmark is returned with a 200 status.",sidebar_label:"Create a new bookmark",hide_title:!0,hide_table_of_contents:!0,api:"eJztWuFuI7kNfhVC9+cumDjeRX/5xwHO9hbd3rYXXBIURdaA6Rnao7NGmpM0SbyGgT5En/Ce5EBpPDNOxln7Nijawlhg4UikRJHUR3LEtTAlWfTS6A+ZGInUEnq6NGZZoF2KRGTkUitLJhAj8S5MA4KmB5jVVAO4yan5C/yqJPhWSb1MwNOjT8BYQOfIfwfSQUaebCE1ZTBbgc8JpswxhbkklYHUYczSrxU5DzOTrQbw3ljgBZtNXAJyHghvf/4IqCxhtgJ6lM67JIyH31IvWrmkA0u+srzzg/Q5ILwdDsF59JUbiER4XDgxuhPb0zsxSYSjtLLSr8Tobi1mhJbsuPK5GN1NNpNE1HJemmwlRusn2tpVi4GoXN4qNdqT9syCZalkGixw8YtjvrVwaU4FhlmlfpqHvVlJYiTM7BdKvUhEadlyXpJjOi+9ovAjkjlvpV6IROhKKZzxnLcVJaLAx4+kF3yCN8PhcJMItGku7ynrcM+MUYRabBIxx3vDCtg3r43v2XeTCFcVBdpV71xURDb2X5Y4UOODurLSRDs85yBdFWw4ZR6Y39gClZhsEiGL0lh/Tc7V/t0np6ls2qu67bJYSpGIB5qx4RT/LsxMKmKSR0+aFxeJcFIvFM3jhHVObPcXk81mk6yF0XSYLcPsC8eUehmOV1nVRzdnBXgxEpWVfMLSUlAhZeNo6l5NbKIzS8uWvouzcYsJC/91IjMOBJHDj/1muO070R7Rtmt+rWwBmoJw4dfNF8hlgQvevszmLdMe32Jn+DsWey7I0Sdu5Wu3nWz43yZyuNJoF0/9djh8DkjjFo4CAvpcuh4EjYD+IoIeBWIv20f26+4FjNjwDczkXB4MIQfC41ejocfFQurFdYgph8Dx1qtclaYUMGOOUlU2eBjpjLkmDZrKz0HFr798P4r3qGcvqvfR7kXWfWK+AtImonJk99zHGOGbCbQWV8zsqXB/2FH1vguO3mOaU3b5YtBCPmZeFag5Tuzee5mJev2d1QJd5/b9ZwLLUddoB3cOoA+o2ouF+4jH+3C3zxNTS6RdbvwxXGU2P4Z8Xil1xYJFBDlqp6cR+hjme5mROUpQvJfpgXbJfaHetZ725Vwt0h4jzvbkRySDrw+AWPnc2MOMVc2UdDkdRp2hp6ua4zB9MMff6vB2AMN/b952oKj/03nc3rB3KJY5+bm7rK6KGdkXbtYfVnN/8vjVWq/0UpuHntgVGDg3rbd7/cB7kJk5pv2lA2LdYFBbv17pujs+Q63Jfqh95Am0ixp0ma7OjQPgiR4kFzEhuS2VwYw4nuM9emQTt6o7ysP6coRWFZNNL0GbTe/kzp18dye5fZrJ9iegTa5VZ1atkzY2nzRJQ/NZRcRq5e3wzRe+mDygqz+ZZFDjNxtidao9TrXHqfY41R6n2uNUe5xqj1Ptcao9TrXHqfY41R6H1x5/6nscucSseXb+7V//BqnvUUl+kS4rDxl6fMXCIzVZr76fvtcUmOZS0zk/z7AdgKw1Fph9EGoRco795IClQp73dKGaf/DsySkI2K7f

10eUPzNgosqeIu9UxosnPlAVN8nv8ZXg6B2+WpPkhqZCOU+lkq+bQJUCPJe//RM8M0helQtmv4fbaPWJRBhG7EgRJg6Z8brjFoTQu2AP5DVxcNC0F7Ghk78m6kM6GPFSsMcssObe5wFJe3L/h64dWsgaDHevpqIQ5VorfXXPvSze6uPB2NViixSVROcCyfGYULnfrFcDEfoYfa3qIsrD0nS6Eaz583Lnbi9DogncOMMNkXB4GIsaK8OP99mX4r/+4CRZnt/25bWH4YavBpqGg1W5bnMbspluOxpFYyLUcTb3WDnUK6+7gzvt+/Yz/7O2+s3Bd3NU1W332UEHU9UNL2/v43QFyqeeGz8t2j0Z5MxgOhqL198Yi46sPzyzYTEoHCI7U/Dw3zocbtvUsfkNFzeCC2bn05wo92WBfmRK/tUrHawMqZR4crEzFzSIFalxQt+NF1d0tuHAJ5HKRK7nIeSTiXRI2mWG6rEoHpTULi0WBXqbIH00+6U/6m2+AHYa0r3GLB8dKAemsNFJ7BzUGAO7e2JL3aLpzpuP6eoVFppATZmQH8E9TQYoaFqS5qYgAdTjZklYwt6bY9fAHmsHtB6h0RhbOzq7J83Ozg+8Dz4+0cmdnW7GvcCF1I/JH6XxHZleV7CuQVtYZez5DFrVsOOBeIkzj5DQoaapkIf0Ufq3IrqBEiwV3JdUP39t3dJA6VVVGbNmppkf/rl4idioxsrFaQHpAF/Wy3aRZki05J5/mYZ4XYcFoAGOYcmydwj2qimBu7O4eUmdsIwoLsz0sgTZQGBsErJR3W91sgxtwEHY82HQwBWvMCIymCDCWKDRoudEnfQ5nZ3xpzs7CWcahE2C3QcAEP0cF9R2CgjyGUBjZGZob9gDRoeULGApqkuCcWxoNVZ2MAGcd8G3IhBn6r/78/rsQ0Rie+YPEaF1/3ehvOnt6E9dtxPg/71KLaNcJiu1HkxjT7sSs28HGeMSD6zVfjFurNhseDr7PbWxtRAtNbYmItzkEwSUxINf563mdwQePDej7JP/hjD5yjNOUSv8i7aQTkq9+ur4JCW3soitCciQschzg/0dCJCL6Yoh9YWwtFOpFFbIfEdfc1NV09wPpbgTsfqlCvepIuF5HihvGu81GJPVRAv6J0GPzO29NTqA=",sidebar_class_name:"post api-method",info_path:"api/karakeep-api",custom_edit_url:null},g=void 0,k={},h=[];function f(e){const t={code:"code",p:"p",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(b.default,{as:"h1",className:"openapi__heading",children:"Create a new bookmark"}),"\n",(0,n.jsx)(l(),{method:"post",path:"/bookmarks",context:"endpoint"}),"\n",(0,n.jsxs)(t.p,{children:["Create a new bookmark. The bookmark type (link, text, or asset) is determined by the ",(0,n.jsx)(t.code,{children:"type"})," field in the request body. For link bookmarks, if the URL already exists, the existing bookmark is returned with a 200 status."]}),"\n",(0,n.jsx)(b.default,{id:"request",as:"h2",className:"openapi-tabs__heading",children:"Request"}),"\n",(0,n.jsx)(o(),{parameters:void 0}),"\n",(0,n.jsx)(d(),{title:"Body",body:{description:"The bookmark to create.",content:{"application/json":{schema:{allOf:[{type:"object",properties:{title:{type:"string",nullable:!0,maxLength:1e3},archived:{type:"boolean"},favourited:{type:"boolean"},note:{type:"string"},summary:{type:"string"},createdAt:{type:"string",nullable:!0},crawlPriority:{type:"string",enum:["low","normal"]},importSessionId:{type:"string"},source:{type:"string",enum:["api","web","cli","mobile","extension","singlefile","rss","import"]}}},{oneOf:[{type:"object",properties:{type:{type:"string",enum:["link"]},url:{type:"string",format:"uri"},precrawledArchiveId:{type:"string"}},required:["type","url"]},{type:"object",properties:{type:{type:"string",enum:["text"]},text:{type:"string"},sourceUrl:{type:"string"}},required:["type","text"]},{type:"object",properties:{type:{type:"string",enum:["asset"]},assetType:{type:"string",enum:["image","pdf"]},assetId:{type:"string"},fileName:{type:"string"},sourceUrl:{type:"string"}},required:["type","assetType","assetId"]}]}]}}}}}),"\n",(0,n.jsx)(y(),{id:void 0,label:void 0,responses:{200:{description:"A bookmark with this URL already exists. The existing bookmark is returned.",content:{"application/json":{schema:{type:"object",properties:{id:{type:"string"},createdAt:{type:"string"},modifiedAt:{type:"string",nullable:!0},title:{type:"string",nullable:!0},archived:{type:"boolean"},favourited:{type:"boolean"},taggingStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},summarizationStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},note:{type:"string",nullable:!0},summary:{type:"string",nullable:!0},source:{type:"string",nullable:!0,enum:["api","web","cli","mobile","extension","singlefile","rss","import"]},userId:{type:"string"},tags:{type:"array",items:{type:"object",properties:{id:{type:"string"},name:{type:"string"},attachedBy:{type:"string",enum:["ai","human"]}},required:["id","name","attachedBy"]}},content:{oneOf:[{type:"object",properties:{type:{type:"string",enum:["link"]},url:{type:"string"},title:{type:"string",nullable:!0},description:{type:"string",nullable:!0},imageUrl:{type:"string",nullable:!0},imageAssetId:{type:"string",nullable:!0},screenshotAssetId:{type:"string",nullable:!0},pdfAssetId:{type:"string",nullable:!0},fullPageArchiveAssetId:{type:"string",nullable:!0},precrawledArchiveAssetId:{type:"string",nullable:!0},videoAssetId:{type:"string",nullable:!0},favicon:{type:"string",nullable:!0},htmlContent:{type:"string",nullable:!0},contentAssetId:{type:"string",nullable:!0},crawledAt:{type:"string",nullable:!0},crawlStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},author:{type:"string",nullable:!0},publisher:{type:"string",nullable:!0},datePublished:{type:"string",nullable:!0},dateModified:{type:"string",nullable:!0}},required:["type","url"]},{type:"object",properties:{type:{type:"string",enum:["text"]},text:{type:"string"},sourceUrl:{type:"string",nullable:!0}},required:["type","text"]},{type:"object",properties:{type:{type:"string",enum:["asset"]},assetType:{type:"string",enum:["image","pdf"]},assetId:{type:"string"},fileName:{type:"string",nullable:!0},sourceUrl:{type:"string",nullable:!0},size:{type:"number",nullable:!0},content:{type:"string",nullable:!0}},required:["type","assetType","assetId"]},{type:"object",properties:{type:{type:"string",enum:["unknown"]}},required:["type"]}]},assets:{type:"array",items:{type:"object",properties:{id:{type:"string"},assetType:{type:"string",enum:["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]},fileName:{type:"string",nullable:!0}},required:["id","assetType"]}}},required:["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","tags","content","assets"],title:"Bookmark"}}}},201:{description:"The bookmark was created successfully.",content:{"application/json":{schema:{type:"object",properties:{id:{type:"string"},createdAt:{type:"string"},modifiedAt:{type:"string",nullable:!0},title:{type:"string",nullable:!0},archived:{type:"boolean"},favourited:{type:"boolean"},taggingStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},summarizationStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},note:{type:"string",nullable:!0},summary:{type:"string",nullable:!0},source:{type:"string",nullable:!0,enum:["api","web","cli","mobile","extension","singlefile","rss","import"]}

1,userId:{type:"string"},tags:{type:"array",items:{type:"object",properties:{id:{type:"string"},name:{type:"string"},attachedBy:{type:"string",enum:["ai","human"]}},required:["id","name","attachedBy"]}},content:{oneOf:[{type:"object",properties:{type:{type:"string",enum:["link"]},url:{type:"string"},title:{type:"string",nullable:!0},description:{type:"string",nullable:!0},imageUrl:{type:"string",nullable:!0},imageAssetId:{type:"string",nullable:!0},screenshotAssetId:{type:"string",nullable:!0},pdfAssetId:{type:"string",nullable:!0},fullPageArchiveAssetId:{type:"string",nullable:!0},precrawledArchiveAssetId:{type:"string",nullable:!0},videoAssetId:{type:"string",nullable:!0},favicon:{type:"string",nullable:!0},htmlContent:{type:"string",nullable:!0},contentAssetId:{type:"string",nullable:!0},crawledAt:{type:"string",nullable:!0},crawlStatus:{type:"string",nullable:!0,enum:["success","failure","pending"]},author:{type:"string",nullable:!0},publisher:{type:"string",nullable:!0},datePublished:{type:"string",nullable:!0},dateModified:{type:"string",nullable:!0}},required:["type","url"]},{type:"object",properties:{type:{type:"string",enum:["text"]},text:{type:"string"},sourceUrl:{type:"string",nullable:!0}},required:["type","text"]},{type:"object",properties:{type:{type:"string",enum:["asset"]},assetType:{type:"string",enum:["image","pdf"]},assetId:{type:"string"},fileName:{type:"string",nullable:!0},sourceUrl:{type:"string",nullable:!0},size:{type:"number",nullable:!0},content:{type:"string",nullable:!0}},required:["type","assetType","assetId"]},{type:"object",properties:{type:{type:"string",enum:["unknown"]}},required:["type"]}]},assets:{type:"array",items:{type:"object",properties:{id:{type:"string"},assetType:{type:"string",enum:["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]},fileName:{type:"string",nullable:!0}},required:["id","assetType"]}}},required:["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","tags","content","assets"],title:"Bookmark"}}}},400:{description:"Bad request \u2014 invalid input data.",content:{"application/json":{schema:{type:"object",properties:{code:{type:"string",description:"A machine-readable error code."},message:{type:"string",description:"A human-readable error message."}},required:["code","message"],title:"Error"}}}},401:{description:"Unauthorized \u2014 the Bearer token is missing, invalid, or expired.",content:{"text/plain":{schema:{type:"string",example:"Unauthorized"}}}}}})]})}function v(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(f,{...e})}):f(e)}}}]);