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: eJztWktv2zgQ/ivGnLWxU+zJN6fYYrOvBpsUezB8GEtji7VEqiTlxBX03xdD0pacSrHcBIsuYBQoFHGGnPd89KiChEysRWGFkjCF95rQ0ghHkh5HS6U2OeoNRGBxbWA6h5vwysAiAkNxqYXdwXRewZJQk56VNoXpfFEvItD0pSRjb1Syg2n17KCHlA77j6waxe5giCBW0pK0zIFFkYkYmWP82TBbBSZOKUe3mmUfV+5ouysIpqCWnym2EEGhVUHaCjJMZ4XNyD14MmO1kGuIQJZZhktes7qkCHJ8+oPkmhW4nkwmdQSo41RsKWlxL5XKCCXUEaxwq1j/vnWpbMe5dQSmzHPUu841b4dkZk9L7KjxMbvTQnk3fMtBsszZb5l6ZH6lc8xgUUcg8kJpe0/GCCVvk245VanjTtPtt8VCQASPtGTHZfycq6XI2I/0ZEny5hCBEXKd0covaGNgfz4s6rqOKlCShvnSrb6gppAbp16psy66FRvAwhRKLVjDQpMzISUz7+pOS9Q+loVmT8/9qj9iwcK/TmRLT9aJ7B763fCpS6Me0fZ7vlY2NIa8cO7p4QS5yHHNxxfJqmHqiS0Ohr8w70mQszVu5GuOXdT8r/YcplDSeK3fTSYn6hFmmjDZjehJGGvOKUov21t02+KFnK85oxKxEoNLwsBy9+rqZnG9FnJ9b9GW5vR5TZSYMo7J1YAViqzULmJIJsy1OFRH8dWZ+O23767KHebprdJdtL2Vsk/MN6icEZSGdE9++YZ9WECtccfMlnLz3YEq+xIWrcU4peTmxSaErGZa5ii57h/nsUgg7H+0m6NrZd9/0yjOSqOjOjKA3lXJztrWRzzrq6NdkRhrImlSZc/hWpVZdscn+ZJwDus3LfQc5q1ISJ0lKG5FPNDQqc2z903onAZTnvYccfaaDzsAS5sqPcyq5TITJqVh1AlaugscwwRnjj9DYxnA8OMioIGi/q8RUW/DGVpFjPja3laW+ZL0Cynw3WbuhmGvtnopN1I9dnQNx8AoLxz39i1vkJu5m/zaqjbtMry3xH37zRKlJH0bouNZ9YVQF5kuIFJXk6Cj2IIHAZ+KTGFC3EMbW50VUl3tuNF9UXcSNMD1CKa2oOURjnwOGrux3gHWBBDTROXByYtDfz78IAEe6L+bXJ/A9mtlw48NyQXYX4D9BdhfgP0F2F+A/QXYX4D9BdhfgP0F2P+YwP7nrh/tbzAZhSnj22H5WCXdWCgnY9ivJ2cSboeG3s0gHL9NVQJTKJSTt0AeNcJ4eZip8khVb0kbB4QcgoEKk0STMfUYCzHeXnMQoRbsYSduWPbGWWGZ8XgrtbYw0/HY6t3VBjVuiIorLAqIOq5GYYeRWo1sSqPfA/3Iy8L2b81679mK/uT2xPdgEj7ZpQmT8cXCEXHEu4cP+wHcb/88OLuxd/5uBsW/PGFeBHwWAuEQ2M21xiPu9kXGv/FXgIbjgPSbV60rWfvl0Rg1TEu/GZG2Ng7XgoD2g+4Oewbk2dB2zhhbYSXkSrG+7HfvlOurydUEmlQ4eGR2d9vpwdnd7Wil9LH72N0MOJSxDMynVUD5vTP+Z3j3kE79HwV4tbkFj4sMhbs+Btztg3sOy/YHAykH/nQOVbVEw02urvn1l5LYSfNFE9ruG4IIUsKEodK8gg2xZ0Ih/im0oi1mpXfDs3zn1uQ5ZnFMhX2RdtHKzbuP9w+uPvuPFnJXDEAjBwT/PwWIQDkjuSRw7yrIUK5LVxzA71kHWNi+Yx+nQvuyg3LXkrCqPMWD2pCsa4iCKpb/BjfT/Bc8h6eb
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},"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},"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","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","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},"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},"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","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","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>
|
