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: eJztWktv4zYQ/ivGnNXYWfTkm3fRoulrgyaLHgwfxtLI4loitSTlxCvovxdDMpKclWJ7ExQtYAQIFHGGHM77y6iGhEysRWmFkjCHD5rQ0gQnkh4ma6W2BeotRGBxY2C+hPfhlYFVBIbiSgu7h/myhjWhJr2obAbz5apZRaDpS0XGvlfJHub1s4PuM2r3n1g1id3BEEGspCVpmQPLMhcxMsf0s2G2GkycUYFuNc8/pu5ouy8J5qDWnym2EEGpVUnaCjJMZ4XNyT14MmO1kBuIQFZ5jmtes7qiCAp8/J3khi9wPZvNmghQx5nYUdLjXiuVE0poIkhxp/j+Y+tS2YFzmwhMVRSo94NrXg/Jwh6X2FHjQ36rhfJm+JaDZFWw3XL1wPxKF5jDqolAFKXS9o6MEUreJMNyqkrHg6p72hZLARE80JoNl/NzodYiZzvSoyXJm0MERshNTqlf0MbA0/mwapomqkFJOs2WbvWFawq5dderdD5El7ICLMyh0oJvWGpyKqRk4U09qInG+7LQbOmlX/VHrFj414ls6dE6kd3DuBk+Dd1oRLSnPV8rGxpDXjj3dH+EXBS44ePLJO2YRnyLneFPLEYC5Owbd/J1x64a/mk8hymVNP7W72azI/kIc02Y7Cf0KIw15ySll/UthnXxQsw3HFGJSMXJKeHEdPfq7GZxsxFyc2fRVub4eZ2XmCqOyeWAFEVeaecxJBPmWrXZUXx1Kn777Yez8oB6RrP0EO1ophwT8w0yZwSVIT0SX75gtwuoNe6Z2VJhvttR5VjAorUYZ5S8f7EIIV8zqwqUnPcP41gkEPY/2M3R9aLv3ykUZ4XRQR45gd5lycHcNka8GMujQ54YayJpMmXP4SqT9BzytMrzWxbMZ5CzTnpecc9h3omE1FmC4k7EJ9ols0X+ofO0472Xpz1HnKebn9HcvX0CxMpmSp9mrGqdC5PRadQJWroNHKfpgzn+COXtBIb/bh92oqj/675stOydmsuM+NrfVlbFmvQLkfXdah5uBl+t9UpupXoYqF2OgXvNcNzbF96TzMw17ZdeEusXg2D9sNNd//0apSR9E3zkWWqHkHSZLnTHLuHBQCYH35B8KnOFCXE9xx1aZBN3qjvLw4Z6hE4Vq2aQoOumD3rnXr970Nw+72SHG9C21wqdVeekrc1XbdPQ/pcEPPp4N7s+Ajg2yob/gCQXtHFBGxe0cUEbF7RxQRsXtHFBGxe0cUEbF7RxQRsno40fh8Yb7zGZhHns2wGMWCXDDVpBxrCBj05v3A4dvZvWOH6bqQTmUConb4k8lIXpup0+8/BZ70gb1525tgpqTBJNxjRTLMV0d83ehFqwhZ24YdkrJ8Uq50FgZm1p5tOp1furLWrcEpVXWJYQDeC1sMNEpROb0eS3QD/xsrD+e1PxO9aiP7k/G29Vwie7qGEyRjuOiF3fPfz8NKr89e97pze2zl/dSP2nRyzK0DQGR2gdu8Navlj30ZV/43FJx9HCj+5VDyf2Xx4MnMNc+Zthcm/jgFUCBAl3dw1xaIc72sFpbM+thEwV35ft7o1yfTW7mkEXCq1FFrc3gxZc3N5MUqUPzcfm5v5DGctoYV4H6DH6NcSzJrwNp/HPJ/y1uSJPyxyFw7QBDHjnXsK6/2lFxo4/X0Jdr9FwzWsafv2lIjbSctW5tvvaIoKMMOHOaVnDltgyIS//ECrTDvPKm+FZvHOl8hyLOKbSvki76sXm7ce7e5eo/ecdhUsGoJEdgn/PASJQTkkuCNy7GnKUm8olB/B7NqFL7AP/w1DoIzCU+56Ede0p7tWWZNNAFK5i+W9w099/AD6dDb4=
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},"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"]}]}]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"The bookmark already exists","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"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":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"pdfAssetId":{"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},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"crawlStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"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":["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","tags","content","assets"],"title":"Bookmark"}}}},"201":{"description":"The bookmark got created","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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"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":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"pdfAssetId":{"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},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"crawlStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"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":["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId","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>
|
