1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
---
id: create-a-new-bookmark
title: "Create a new bookmark"
description: "Create a new bookmark"
sidebar_label: "Create a new bookmark"
hide_title: true
hide_table_of_contents: true
api: eJzVWMFu4zYQ/RVjzmrsLHrSzVl0gXTbbtCk6MHQYSyNLa4lUktSTlxB/14MyUiyIydysyhaBAhkcYYcPr4ZvlEDGZlUi8oKJSGGj5rQ0gxnkh5na6V2JeodRGBxayBewU14ZSCJwFBaa2EPEK8aWBNq0sva5hCvkjaJQNO3moy9UdkB4uZkoYecuvlnVs1StzBEkCppSVr2wKoqRIrsMf9q2K0Bk+ZUohstii8bt7Q9VAQxqPVXSi1EUGlVkbaCDNtZYQtyD97MWC3kFiKQdVHgmsesrimCEp9+IbnlDVwvFos2AtRpLvaUDbzXShWEEtoINrhXvP9z41LZkXXbCExdlqgPo2Meh2xp3464bduoASVpGgxu9OWcJOuST7YQcgdJG0GtizG7jdIlWoih1oIDrTSlGh8LypYepdtsZEOtp4HQDNLKj/olEg7+fSFberIuZPcwirSqdUp/jO3oTGjPc743NjSGfHDu6eENc1Hilpevsk3vNIpoBBtR0G9YnuHWxTvu4+uXTVr+a72HqZQ0ftcfFtfjqRxoOywZkxP5daDFOAiv5EkbQakysRET0yiaWiLeXREsbrdCbu8t2tpMKUnP9DB1mpIxnIYoilo7qpDM2Cs5W2pG4j9besZQcTW/M0St8QARCEul+cfnJs8RF63FNKfsZjS4Lq0ERJDXJUpITvksMgjzH83m7AZk/HcK5kWsOsqnCfauWozm+Dnj5bl6MsaRVBNJkyt7idemLoo7XslnyCWuL66SS5z3IiN1UaC4F+lEoHNbFh976rxp/7yNadZY21zpaRDV60KYnKZZZ2jpLnhMA4U9fg1Fc4ry+M9e6xND/V9f82M5ewEiERjx13BaWZdr0qN8nsz9S7TFu1Gv5U6qx5ErwDmwdAnLff/7a9Ix9xX0ed/3wzdrlJL0beDCSeGEUNLYLogpV91gpE5yzp2Dwt2GfbRJO2rQy6gj0TQQOkeq5lTCBJHQE6XDPenuv65nBC8of1wsXmrIG8xmoV/8ftIxVdm41ijJGAb/TYnsZujtnSR2/jZXGcRQKRdvhdw0wnzddcfcHOs9aeOEhlMI0GCWaTKmnWMl5vtrPmnUgpPIhRuGPTgbrAvutnJrKxPP51YfrnaocUdUXWFVQTSiwsMMM7WZ2Zxmn4P9zMfC+A+69ntG0a887N07SHhl3oczYx3rjJiW7uHTcz/4858PDjc+nd/7lv+nJyyroH8CEbo86VW0l7lD3ezfeEHbe3S6tX816AD6lyF2p82CMusHR1vWAS2E3CiOl8/Ng3p9tbhaQE/lDtHl3e3oCSzvbmcbpY/h5+PiO1wZy8I1boIKPvu15UQPdulw/vOM3zbfavOqQOG6jaBLPTlXsB5+usmZuPEKmmaNhu+NtuXX32pikFdJT033NSeCnDBj9bFqYEd8DkEW/RCq+x6L2lXZ03zlau89lmlKlX3VNhnk1t2X+wdXBP3no9IlM2h8hMj9jwEiUA4kR2L3roEC5bZ2yQ1+zjYorWFLdkzlYTOA8jCIsGm8xYPakWxbiMJWLP8G1yL/DT9YpU4=
sidebar_class_name: "post api-method"
info_path: API/karakeep-api
custom_edit_url: null
---
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Create a new bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new bookmark
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The bookmark to create","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"title":{"type":"string","nullable":true,"maxLength":1000},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"note":{"type":"string"},"summary":{"type":"string"},"createdAt":{"type":"string","nullable":true}}},{"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"]}]}]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created bookmark","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string"},"modifiedAt":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"archived":{"type":"boolean"},"favourited":{"type":"boolean"},"taggingStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"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":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"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":["screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","tags","content","assets"],"title":"Bookmark"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
