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: get-a-single-bookmark
title: "Get a single bookmark"
description: "Get bookmark by its id"
sidebar_label: "Get a single bookmark"
hide_title: true
hide_table_of_contents: true
api: eJzNWN9v3DYM/lcMvmwDjFw6dFhxb2mxddmwNlhS7CG4B9qiz8rJkivJl1wO/t8Lyj8vcRInDbA9nc8ixY+fSIr0HgS51MrSS6NhCR/JR4kxmwLtJkp2kfQukgJi8Lh2sLyE9+2ig1UMjtLKSr+D5eUeEkJL9qTyOSwvV/UqhhItFuTJuiDg0pwKhOUe/K4kWILzVuo1xEA3WJSKX0mSQt3s1sX11btfzc3tL/mN9yZ9xwikDyIdglMBdQyWvlbSkoCltxXFoLFgoWQQikGyZyX6HOp4AkZijCLUEIOgDCvlu70OqTnNIkc+8iYKqz1NP7goNdqT9tG1VCpKKJI6VZUgEUkd+ZwiS6402tFR9Ml4iiOfy0EpRc06Cu2aoszYyJmC+t3d0aGXGSr3/4HW891u+6FR7Dj/WpHdAYdCZ8Yx7z8fH/PPoQ+fkytKGafPhwgU6JGttIBYC8tSyRRZa3HlWHXiSE3YDGIorSnJetkYluJ+9NUxpJbQkzjxk6uFETKT08sx6EopTDgwmfq6D9MZkmjTXG5JTIRiHUOGW8PJ9dC6x/Va6vW5R1+5p+3FQLoqOINdlabkHLAJqSpLTBNpwVqrOgZXFQVaeRsofv3ttfHz6Glw7ObJmsqmM7YdYGIpIYZrSji6FD8XJpGKQjXypB1HZQxO6rWirFmwwS1ZlMb64EtTFHujaC3uWMJT4V4cjU1GTSyg95jmJN5PctI7xr7kVYEaVvVB6biEUMnD/ge7BblRihlNn7NQsh93oFl9GIqSehN4qqya9Gh+rhzUihnyssA1fZky+5DwiXPkTyeOZCrcUkukXW78c7SySqkzttTk/XNUS0upxWtF4gXKWynIPAsobmU6k+jcF+rDEDpPyrdh9hw4nefzDGDlc2PnsVolSrqc5kkL9HTWaswDzhp/t7fHDIU7yRqkm9xZcd/yfbno6aatWfwwlYxNDZ2XM9NQOxvfixU5OALY8HTxhHhIXzYiskFpKrY4tKWiT5MF9sFbZW4VcfJ2vK2uioTsIynwYpoHUgZfX4H1Sm+0uZ64NYLCqu6pff0rb9Yx823yx6jajMtwx8T5+E2CWpM9baPjTvWFti6yXNtthpoEE8WWs9CR/VIqg4L4Dh24elZITV3Hg++relJg6E4PetFR/3jQLN7tDKcburZ3GYKxP9vV/UkL6oDs7fHb+217JxNp46PMVFq8XrueGjHdCRXkHJ/q/bU7BIYdBnlmuA76PjcClrBuDpxHwyUs+sFmsR/mx5oZJLvtptjQy8AehbDkXL3AUi62bzic0Eo+6wC9XW74aodKyL0v3XKx8HZ3tEGLG6LyCMsS7s5zFzlF7Q6RycKc9lcrHzVY+EhGA/g5M9pYHo/hPT1sOSQMi/EcEYQ49sPD78YWyAj//PcicCh1ZlidvW4gvTk6PjoeTeE9npOz00n8J2enYWQ8AM/O8sVrnOcGdbnv5kf+7oBR023349/dffdDYD3yoaLxmO+iRalQhmGpbUCbg77sM54TYDn6VLCKITfOs8h+n6Dj2l/X/LqZZPn8hXR8yg+M4mOI/+FUPknChnZTk/oWVcXCYU7vgviZrv74T5t0P0UPWe8uDL0b2+xQjQ4hXDQ5oeC+7HLfCpykKZVjuPcKC8PvE/vjbxfQ9ILj6fkw6scTziGs/b6RuDAb0nXdo/T8nwHW9Tfb7Kd7
sidebar_class_name: "get 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={"Get a single bookmark"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/{bookmarkId}"}
context={"endpoint"}
>
</MethodEndpoint>
Get bookmark by its id
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BookmarkId"},"required":true,"name":"bookmarkId","in":"path"},{"schema":{"type":"boolean","default":true,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks."},"required":false,"description":"If set to true, bookmark's content will be included in the response. Note, this content can be large for some bookmarks.","name":"includeContent","in":"query"}]}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={undefined}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"200":{"description":"Object with bookmark data.","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"]},"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","tags","content","assets"],"title":"Bookmark"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
|
