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: search-bookmarks
title: "Search bookmarks"
description: "Search bookmarks"
sidebar_label: "Search bookmarks"
hide_title: true
hide_table_of_contents: true
api: eJzNWEtv4zYQ/ivCXNoCQpzt0Tdv0EdadBM0WfQQ6DCWRhbXFKmQlBOvof9eDClLsiMn8m6A9hRHnMc3T85wBxnZ1IjKCa1gDneEJi2ipdbrEs3aQgwOVxbmD/Cx+5bEYCmtjXBbmD/sYEloyCxqV8D8IWmSGCo0WJIjYz2BTQsqEeY7cNuKYA7WGaFW0MRg6LEWhjKYO1NTDApLJniEGAQDeqzJbKGJTwuJgVRdMkK0KcTeIGDBkjaoUmK4GeVYSwfzwecD5TlK22u32rgbk5GZgELV5ZLMa9KkKIU7xx4nnOQPV7Wx+lXRaaB4W/ZSa0moYOCK4O/D8F/nkSUXOR350y4PfrBRqpUj5aInIWW0pEioVNYZZZFQkSsoMmQrrSxdRJ+0ozhyheiZUlTMI9GsKMq1iawuqc+yi1Eb/yfQOme3Yq8C45HTEzYgqLHs958vL/nPoQ03yy+UMk5XeGA2VJshW0vnVbWomBWrSooUmXX2xTL/SFy1lwgxVEZXZJwI2vv67UnRGNwyakelfVuEyEbrNTWEjrKFGz0tdSZyMX4cg6qlxCWnNoew6RJ9AiX7SWwoG0npJoYcN5rb0alzh6uVUKs7h662b+vrO4qt05Qsd8EchawNsZtIZcyVNDHYuizRiK8+Su8vXmk3zT0Bx3Yara5NOkHsoK9WAmJ4oiUnqOTfpV4KyWjp2ZGynN0xWKFWkvJwYLxZoqy0cd6W2pK5Hs+pcMO8c6KGoh05QOcwLSj7OOquzmY2s6hLVJA0B93pgTW28g+kebpBAWtFN7m//143IJyehiKFWgcXGjnuv8lldNCOJtCLElf0eUztKeKFteTG4jyWiakhUrbQ7hyuvJbyljWFlnAOa2UoNfgkKfsG5o3ISJ8FFDcinejowpXyqk+dN+nbNDsHzt7yaQqwdoU207xaL6WwBU2jztDRbcsxDThz/NVeLBMYjorVU4faSXg0+r5adPQc2pn/MVaMob1Oq5lxqHsd34sVOTk8WP/r/g1yX76sJMt7phMdm5v8p9EGe/LCmdpFrPg6FNuO16dL4Jvd3Dult/UdvF6rtdJPI7eGZ0iazrXvf+VNCjPfJr8Pus2wDe89cTf8skSlyFy32XHUfaHti0zXzpy+J8FIs4UwBHyupMaM+A7tfXVWSo1dx73tSTNK0A+uB2PqYLQ8mCOPh8bxWa8ba9ohps/KLshJv8/tN2hggIqeXbvgnW3xcD0fyBmousWVUGxvv7U3jXdMSa7QGcxhFaKEvLXDrBM5C0sJG0xms9/g/egBO8wyQ9Y2M6zEbPOBo49GMFCfl+1xWHz2G3fhXGXns5kz24s1GlwTVRdYVXC84d0XFLUSIp37BenPlj4KWNiGwePDHW9D7cIzeILovMmafX4zGW8EnohT1f/4VZsSGeEf/9z7kAiVa2ZnqwOkDxeXF5eDjbzDs7i9HsW/uL32S+QBeDaW70ltHc+T891+oxx5bTma0LomN/oyE8zk+2JWSRR+12mHxBDXw1RpI5vEUGjr+HS3W6Ll1tw0/DnsshzvTFiO6ollfIjrx7/bxPwpOgVpTdv2SWeDsuZz/0jxQkegGz6+TKHfP69Moe3eS14nPmnsf/gI8YpnXzxM9NYlfYX6t7kYCkL2LQc5cC/SlKoh14uHB5bStY3ffrmHMB4Od+3DyhouPai2A9m7XaC412tSTQN7Exz/Dw337n8BoeUaoA==
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={"Search bookmarks"}
>
</Heading>
<MethodEndpoint
method={"get"}
path={"/bookmarks/search"}
context={"endpoint"}
>
</MethodEndpoint>
Search bookmarks
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={[{"schema":{"type":"string"},"required":true,"name":"q","in":"query"},{"schema":{"type":"string","enum":["asc","desc","relevance"],"default":"relevance"},"required":false,"name":"sortOrder","in":"query"},{"schema":{"type":"number"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","title":"Cursor"},"required":false,"name":"cursor","in":"query"},{"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 the search results.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarks":{"type":"array","items":{"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
>
</StatusCodes>
|
