Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

release(docs): release the 0.31 docs

Mohamed Bassem473c8a93e4c8
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/_category_.json b/docs/versioned_docs/version-v0.27.0/02-installation/_category_.json
deleted file mode 100644
index acb94a71..00000000
--- a/docs/versioned_docs/version-v0.27.0/02-installation/_category_.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "label": "Installation",
-}
diff --git a/docs/versioned_docs/version-v0.27.0/07-development/_category_.json b/docs/versioned_docs/version-v0.27.0/07-development/_category_.json
deleted file mode 100644
index 73dd67ec..00000000
--- a/docs/versioned_docs/version-v0.27.0/07-development/_category_.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "label": "Development",
-}
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/05-different-ai-providers.md b/docs/versioned_docs/version-v0.27.0/14-guides/05-different-ai-providers.md
deleted file mode 100644
index 33408c00..00000000
--- a/docs/versioned_docs/version-v0.27.0/14-guides/05-different-ai-providers.md
+++ /dev/null
@@ -1,66 +0,0 @@
-# Configuring different AI Providers
-
-Karakeep uses LLM providers for AI tagging and summarization. We support OpenAI-compatible providers and ollama. This guide will show you how to configure different providers.
-
-## OpenAI
-
-If you want to use OpenAI itself, you just need to pass in the OPENAI_API_KEY environment variable.
-
-```
-OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
-
-# You can change the default models by uncommenting the following lines, and choosing your model.
-# INFERENCE_TEXT_MODEL=gpt-4.1-mini
-# INFERENCE_IMAGE_MODEL=gpt-4o-mini
-```
-
-## Ollama
-
-Ollama is a local LLM provider that you can use to run your own LLM server. You'll need to pass ollama's address to karakeep and you need to ensure that it's accessible from within the karakeep container (e.g. no localhost addresses).
-
-```
-# MAKE SURE YOU DON'T HAVE OPENAI_API_KEY set, otherwise it takes precedence.
-
-OLLAMA_BASE_URL=http://ollama.mylab.com:11434
-
-# Make sure to pull the models in ollama first. Example models:
-INFERENCE_TEXT_MODEL=gemma3
-INFERENCE_IMAGE_MODEL=llava
-
-# If the model you're using doesn't support structured output, you also need:
-# INFERENCE_OUTPUT_SCHEMA=plain
-```
-
-## Gemini
-
-Gemini has an OpenAI-compatible API. You need to get an api key from Google AI Studio.
-
-```
-
-OPENAI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
-OPENAI_API_KEY=YOUR_API_KEY
-
-# Example models:
-INFERENCE_TEXT_MODEL=gemini-2.0-flash
-INFERENCE_IMAGE_MODEL=gemini-2.0-flash
-```
-
-## OpenRouter
-
-```
-OPENAI_BASE_URL=https://openrouter.ai/api/v1
-OPENAI_API_KEY=YOUR_API_KEY
-
-# Example models:
-INFERENCE_TEXT_MODEL=meta-llama/llama-4-scout
-INFERENCE_IMAGE_MODEL=meta-llama/llama-4-scout
-```
-
-## Perplexity
-
-```
-OPENAI_BASE_URL: https://api.perplexity.ai
-OPENAI_API_KEY: Your Perplexity API Key
-INFERENCE_TEXT_MODEL: sonar-pro
-INFERENCE_IMAGE_MODEL: sonar-pro
-```
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/_category_.json b/docs/versioned_docs/version-v0.27.0/14-guides/_category_.json
deleted file mode 100644
index 117f7f1b..00000000
--- a/docs/versioned_docs/version-v0.27.0/14-guides/_category_.json
+++ /dev/null
@@ -1,3 +0,0 @@
-{
- "label": "Guides",
-}
diff --git a/docs/versioned_docs/version-v0.27.0/api/_category_.json b/docs/versioned_docs/version-v0.27.0/api/_category_.json
deleted file mode 100644
index 49c10f38..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/_category_.json
+++ /dev/null
@@ -1 +0,0 @@
-{ "label": "API" }
diff --git a/docs/versioned_docs/version-v0.27.0/api/attach-asset.api.mdx b/docs/versioned_docs/version-v0.27.0/api/attach-asset.api.mdx
deleted file mode 100644
index a01e6f1c..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/attach-asset.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-id: attach-asset
-title: "Attach asset"
-description: "Attach a new asset to a bookmark"
-sidebar_label: "Attach asset"
-hide_title: true
-hide_table_of_contents: true
-api: eJztVUGP0zoQ/ivRnB6S2ewiECi3gkAs7/BWbJ84VDlM42njbWIb29m2RP7vT+Okm5YWBNI7comSyefxfJ+/GfcgyVdO2aCMhgJmIWBVZ5hp2mboPYUsmAyzpTGbFt0GBARceygW8HYMeSgFeKo6p8IeikUPS0JHbtaFGopFGUsBFh22FMj5BPBVTS1C0UPYW4ICfHBKr0EA7bC1DYcUKdns9ut2+/Dmtdl9e1XvQjDVG65AhQQ5VHArIQpw9LVTjiQUwXUkQGPLoOUEEqCYo8VQA1fFK8iHt0buuZZTJeY1HQmQZAEBldGBdGA4WtuoChmeP3hec4GYWT5QFUCAdcaSC4o8/1XynHwUkPabp+gFaXTXsu6N0puPoW3ejaUI8JUj0r42/JFy3B9Hlqg1udsW1wQCVl3T3OGaZq6q1SNHHpUkw7hRqRlnSCVT5XDbkJywnd5os9VQxhPFF8zouP4yxgHhrdF+IP3i+uYHMid1SQ56/1H5d1V+ef3yXNhDc2TahGxlOi3/P2ErIy+IFwW05D0LcP7vOyIpw4RPRNL6UBvJPWp82pZbtYD8IJrP+6mfY56U8Hw25B4Pw6VzDRTQo5SOvI85WpU/3vAJoFO4bAYK4+9BtxV2TYAC6hCsL/I8uP3VBh1uiOwVWgvikmuHDJlZZaGm7O8Rnw21QIzxaC7es7LDzsfT8Ukm3jl5jGE8tRKI7ZJePhjXIlf46cs8ackn9nkaX+8PY3Mw/WTnI6+fWTryPFwZXsTiDcxurq6vro9m7BOt2d3tRRlmd7fZyrhTDVizKNIptpisNU7jw/0ymv8kXT/Z85fuoYFVoF3IbYNK847p8PvRN4unZmOPFCc3wWidUkDNVisW0PdL9PSva2Lk8NeOHF9n5WScZC+pPL9LKFbYePoJh78+j4Z/lv2o3DGIep/82XT8BQI2tD+9umIZBdSEklyqYgCMJ/k8HfCU4Ky1ozismFUV2fBTbHnUhnf/3M/TzBpuyDb1PTjcgkjPVKxJ3JO3U6yHBvW6S3MAhpxsWTx1/HcOT6wuytH3A2JuNqRjfFIn8DcLE+N/AisISA==
-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={"Attach asset"}
->
-</Heading>
-
-<MethodEndpoint
- method={"post"}
- path={"/bookmarks/{bookmarkId}/assets"}
- context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
-
-Attach a new asset to a bookmark
-
-<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"}]}
->
-
-</ParamsDetails>
-
-<RequestSchema
- title={"Body"}
- body={{"description":"The asset to attach","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}}}
->
-
-</RequestSchema>
-
-<StatusCodes
- id={undefined}
- label={undefined}
- responses={{"201":{"description":"The attached asset","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","unknown"]}},"required":["id","assetType"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.27.0/api/create-a-new-bookmark.api.mdx
deleted file mode 100644
index 70e0df7a..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/create-a-new-bookmark.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-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: eJzVWN9v4zYM/lcCPntNOuzJb+lhw7pfV6wd9hD4gbGZWBdb8klyejnD//tASbWd1kmdazFsKFA4EilSn0jqoxrIyKRaVFYoCTF80ISWZjiT9DhbK7UrUe8gAotbA/EKbsKQgSQCQ2mthT1AvGpgTahJL2ubQ7xK2iQCTZ9rMvZGZQeIm2eGHnLq1p9ZNUudYYggVdKStKyBVVWIFFlj/smwWgMmzalEN1sUHzfOtD1UBDGo9SdKLURQaVWRtoIMy1lhC3IfXsxYLeQWIpB1UeCa56yuKYISv/xGcssbuF4sFm0EqNNc7CkbaK+VKggltBFscK94/6fmpbIjdtsITF2WqA+jcx6HbGlf99hJ42Nxp4Xyx/BSg2Rd8rkV6pH1lS6xgKRt26gBJWkagG72zNpC7iBpI6h1MSa3YasWYqi14C1WmpzflC09vrfZCBStDyChGd6Vn/UmEnb+bS5b+mKdy+5j9IxUrVP6a2xHJ1x7WvOtvqEx5J1zXw+viIsSt2y+yja90iiiEWxEQX9geSIqL95x719vNmn5r/UaplLS+F1/v7geLwIh4IfFZnIJOA+0GAfhTIa1EZQqExsxOQEnFpc31xKL262Q23uLtjav2+vDw9RpSsZwGqIoau1ChWTGWklXi8RXB/H7Lz9eA0fgOVkTx0B3l1EniFrjASIQlkrzzWEhT+UFWotpTtnN2QKLAiLI6xIll9fjdBEZhPWPVnNyg1j/d+rxRUF7lK4T5F0xGi0hp4SXp8rVWIykmkiaXNlLtDZ1UdyxJZ+Al6i+uKkuUd6LjNRFjuJepBOBzm1ZfOhD53Wi4GUvcedp59MMYG1zpaehWq8LYXKaJp2hpbugMc1x1vg9lPEJCv9dojHR1f818RhL8wsQicCIr8NlZV2uSZ9JgW+GeZztvBn1Wu6kehy5NZwCk6lg7v2vvEnHzLfJz4NqMyzDT0jcD0fWKCXp2xAdz6ovhLrIcoHwuZoEI8WWs/AUOO5K7f1P2lGBnuodEbsBGTtiXs9p1jg7CvyjD6jufJLuau36ZPBU+IfF4iX7vcFsFnrk9yO9qcrGaUxJxvCRvEru3Qq9vCPzTt/mKoMYKuX8rZAbZZivuxcBfhDQe9LGcRhHPqDBLNNkTDvHSsz313z+qAUnm3M3THtwNlgX3Cfm1lYmns+tPlztUOOOqLrCqoJopH8IK8zUZmZzmv0a5GfeF8Z/8FJxzyh6y8P3ig4StuwinMWYgTshDlb38dNTJ/vL3w8ONz6dP/tnjh+/YFkFahUCocunnv97Bj1k/H7Ec+Veo6PE/dCgdxkOHj0ChF4/7MiRwUAFe5XRFnwQLEJuFO+CT9NDfX21uFpAH+Adzsu729FzWd7dzjZKHx8KHyIzAGUsM+W4CbT75LvTMwLaJcnphyq/bb4T51WBwnVPgQj7kF3BeviIlXM4xytomjUavnXaloc/18TQr5I+YN27VgQ5YcbcZdXAjhjvUBm/C3fDHova1ejnWcx3hddYpilV9qxsMsi4u4/3D65g+oe00qU4aORj5v8xQATKgeRC2401UKDc1i7lwa/ZBp42bDGPA3zYfaA8DDxsGi/xoHYk2xaisBXLv8G1/P8ASqIDtw==
-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"]}}},{"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"]},"summarizationStatus":{"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},"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","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","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>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.27.0/api/get-a-single-bookmark.api.mdx
deleted file mode 100644
index 8e3b957f..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/get-a-single-bookmark.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-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: eJzNV01v4zYQ/SvEXNoCQpwttujCN++i3aZFd4MmRQ+GD2NxbDGWSC1JOfEK+u/FUJ92lETJBmhPccQZzuPjm+FMCZJcbFXuldEwh4/kxdqYXYZ2J9YHobwTSkIEHrcO5kt43yw6WEXgKC6s8geYL0tYE1qyi8InMF+uqlUEOVrMyJN1wcDFCWUI8xL8ISeYg/NW6S1EQHeY5Sl/UqRkenfYZrc37342d19/Su68N/E7RqB8MGkRXEioIrD0pVCWJMy9LSgCjRkbrXujCBSfLEefQBWNwFgbkxJqiEDSBovUt3sdU3OxEY688EaE1Y6m75yIjfakvbhVaSrWJJSO00KSFEoLn5Cw5HKjHZ2JT8ZTJHyieqcYNfukaLckNsYKZzLqdndnx6fcYOr+P9A6vpttP9SOLedfCrIHYCm0YRzz/uP5Of85PsPn9Q3FjNMnvQIleuQoDSD2wjxPVYzsNbtx7DpypSZsBhHk1uRkvaoDK3lffVUEsSX0JBd+dDUzUm3U+HIEukhTXLMwmfqqk+kES7RxovYkR6RYRbDBveHkemjd43ar9PbKoy/c0/EiIF1knMGuiGNyDjiESgtLTBNpyV6rKgJXZBla9TVQ/Prba+On0VPjOEwjPVSnzhCtxQOL0FPmXiyLWtojC+g9xgnJ96PgWiJQQQRJkaGGVXWUw0sIJTXsf7RbsBto3Wj6vAm18/ED1KsPQ0mV3gXyC5uOnmi6aI+SdoK9ynBLf4+Ffch44Rz5i5ErGdNIbIm0S4x/jtemSNNLjlQn4HNcc0uxxduU5Auc90qSeRZQ3Kt4ItGJz9IPvXSetG9k9hw47cmnBcDCJ8ZOY7VYp8olNM1aoqfLxmMacPb4synjExxOkjVY17mz4gbi23LR050PuRh+jCWjM4WNJ+bMONQ2xrdiRRZHABt+XT9hHtKXg8hN7zSmLZa2SunTaIEdS/NnMBKBU1+H2+oiW5N9JAVeTHNPSn/WV2C90DttbkdejeCwqjpqX//Jm3TN/Jr8Nqg2wzLcMnE1/LJGrcleNOo4qb7Q1EW2a9q+UJNgpNhyFj5ETnhSe/yratSgb/WOGrtBM3bUeZ22WePdUdN/9ILq7md1f2yBKiB7e/72fg/c2ghtvNiYQsvX631jI8e7mYyc45u5v3ZCYNiht2eGq+DvEyNhDtv60njOmsOsmxJmZT+MVcwg2X07EoZ+BEqU0pJz1QxzNdu/YUmgVZx/AXqzXPPVTGiQeJ+7+Wzm7eFshxZ3RPkZ5jmcDkfXCYlmB2E2Yej5o7EXNRa+ksE0e8WM1pGHM21HD0cOomczbsqDEes3/PjV2AwZ4e//XAcOld4YdudT15DenJ2fnQ9G2g7P4vJiFP/i8iLMX0fg+bD8eBrnucmcl+0wxkM8Cqf0Nu2ntdN9y15Yj0z99Yn5PZnlKaoweTRNZH3Ryy5rOQHmg7l7FUFinGeTslyj4/pdVfy5Hgv5/qVyfMsPzLVDiP/hiDtKwo4OY2PvHtOCjcPQ24r4mUf9/q8m6X4QD0Vvi74+DGO2qAaXEB6LhFByb7UsG4NFHFM+hHuvsDD8LrE//nINdT83HEWPVT+cUo5hlWVtcW12pKuqQ+n5fwZYVf8Ci4Bq+w==
-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},"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","unknown"]}},"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>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.27.0/api/get-all-bookmarks.api.mdx
deleted file mode 100644
index cc0b52c7..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/get-all-bookmarks.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-id: get-all-bookmarks
-title: "Get all bookmarks"
-description: "Get all bookmarks"
-sidebar_label: "Get all bookmarks"
-hide_title: true
-hide_table_of_contents: true
-api: eJzNWEtv20YQ/ivEXHohJKdH3RSjTdyisQG76MHQYUSOxI3IXWZ3KEcR+N+LWVIkJa9syjHQnixz5/3a+XYPKbnEqpKV0TCDT8QR5nm0NGZToN04iIFx7WD2CB+7b4sYHCWVVbyD2eMeloSW7LziDGaPi3oRQ4kWC2KyzhO4JKMCYbYH3pUEM1gakxNqqGOw9K1SllKYrTB3FIPGQkjQJpnaUgoxKDHtW0V2B3X8Nmkr3BoxeJQ8x1bpNcRAuirEdXQJxD5U4ntKK6xyhlnz5QWtzli+tSnZEUp1VSzJviQtV4XiS8xnxbl8uK6sMy+KThqK8aEeRIFtRfFJHd2sIkccsYn8aVdPv7goMZpJc/SkpM4oUjrJq5TSSOmIM4osudJoR5Poi2GKI85Uz5SgFp4c7ZqilbGRMwX11ToJ+vg/Ma0Ldiv2umE8CfpCHGjUOIn7r1dX8ufYh9vlV0rETs6O2zVKkVFUtVYJK5ZlrhIU1ulXJ/yBvBovEWIorSnJsmq093OgJ0VrcSdWMxXudREqfV6adQyJJWRK5xw8LUyqVip8HIOu8hyXUtqSwror9BGU3VQJTo/BlAieM67XSq/vGblyr+vrB4irkoScTNMVqryyJGEinQrXoo7BVUWBVv3wWXp/8drwuPA0duzGBd3fC+9cFk2LBA6QGZOM0o9B47pBrSCGrCpQw6I+mgWPorGVfyTN0w3axWi6Xflb62UHmtPzpuRKb3zwK5sHPRpftEfNP4JeFbimv0NqzxHPnSO+CaQkVCOJJdIuM3wJ16rK8zvR1DTgJaylpcTiU07pG5i3KiVzkaG4VcnIQGdc5Nd96bxK35bZJeYcPB+nACvOjB0X1WqZK5fROOoUme5ajnGGC8df7RgfwXDSrJ666Z2FLCI/14tM39n3ov8RakZnKpuM7JmwqQcdP2srSnF4Y/2vh1fIffuKknTVM4VqS0pb5fQlOGBDbX5BRGJw6sdQbLvMnm+BN4e5D0rv6ztEvdIbbZ4Ct4ZnWNRdaN//yhuVZrlNPg+mzXAMHyJxP/yyRK3J3rTVcTJ9oZ2LQtdueH4mQWDYSheeC46/Unv7F3WQoF/1jha7eAjxjvDZ8ZoV3o7a/aMvqC4/ix74HCAriF2avnOLhC4uviEeHsgZqLrDtdLiZg+T69rHoyDOTAozWDcBRoHJMB2KdGS3B6zs1wXYY5pacq6eYqmm2w+SMbRKLPS11B430OAARzPm0s2mU7a7yQYtbojKCZYlnGKgh4yiVkJkVh7b/NnSR40tYvwA5t8LXmghwQDsd2EUzb4mhUx2Zk8k5eV//G5sgWLhH/88+FwovTLCLl43Jn2YXE2uBpi1s2d+dxO0f35342HWkfHirNxtxrHsgLP9AXOFHjZO1qpuMoVfQRpHZcpPyxyVxwPtatekdFglixgy41g+7vdLdDJH61o+NzBPEp0qJ+nsceqGdsfvHlvMK1HqofgZ8qPGGcMwfJMYQ394dRhD2z0jvEx8NvD/ITYP5rfx6hle771b9G3pn75iyAgltpLghnueJFQOuZ7hcZHSDYlPvz1As8cNIehxOw3RCerdQPZ+31A8mA3puoaDCyz/Qy0D+l+/2OP7
-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 all bookmarks"}
->
-</Heading>
-
-<MethodEndpoint
- method={"get"}
- path={"/bookmarks"}
- context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
-
-Get all bookmarks
-
-<Heading
- id={"request"}
- as={"h2"}
- className={"openapi-tabs__heading"}
- children={"Request"}
->
-</Heading>
-
-<ParamsDetails
- parameters={[{"schema":{"type":"boolean"},"required":false,"name":"archived","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"favourited","in":"query"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 all bookmarks data.","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},"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","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-all-tags.api.mdx b/docs/versioned_docs/version-v0.27.0/api/get-all-tags.api.mdx
deleted file mode 100644
index db50781b..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/get-all-tags.api.mdx
+++ /dev/null
@@ -1,63 +0,0 @@
----
-id: get-all-tags
-title: "Get all tags"
-description: "Get all tags"
-sidebar_label: "Get all tags"
-hide_title: true
-hide_table_of_contents: true
-api: eJyFVE1v2zAM/SsGz0Kc7uhbCmxFt8MKzMMOQQ6MzcSqP6RKdDbD0H8fKLtp4gbtSbZFPj7yPXqEknzhtGVtOsjggTjBpkkYjx4UxCPbQi7nToGnoneaB8i2I+wJHblNzxVk213YKXDkrek8echG+LJey3GN/3P/TAUnfzVX5zpJiYwrUFCYjqljyUJrG12gZKXPXlJH8EVFLcoTD5YgAxPBQIF1xpJjPRWeSJ+j0DkcQIFmav3n2bq8iPHsdHeEoKDDlm5f9O29MXWLrr5E7/p2T24ZcD9smLGoqMxj2GdkUN+ErPoWuxs3IQQR4aXXjkrRTZcwU18Q/ZDWTgFrbgQ5xyO8Q40D3oWpXEtcmRIyOFLkj2IHSGcDeXIncj76pXcNZDBiWTryPqRodXq6AwUndBr3zdzydD1Z54B9w5BBxWx9lqbshlWNDmsiu0JrQS38lVeUzAiJOSRcUfJjjk8mLtLOhZN/iammypd+Po9WKksfMQyyOQjU/PDNuBaF4fc/Ocg4dHcwki5dT5TuVuvVGt5GeuazeXq8yX/z9JgcjLsmL80GBdZ4nrWfHLnc2Cu48W2l3m321B7TP05tg7oT9KjQOGv4qrOCyniW93Hco6ffrglBPr/05ORPsHtTMP4IFFSEJbkoek0DZLApCrIcpW76uJTL/RZNzlZ6+JqDArxWYjH5iP664t1wgT2OU0RuaupCADWTYHmHIMb9D+rOsgM=
-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 all tags"}
->
-</Heading>
-
-<MethodEndpoint
- method={"get"}
- path={"/tags"}
- context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
-
-Get all tags
-
-<ParamsDetails
- parameters={undefined}
->
-
-</ParamsDetails>
-
-<RequestSchema
- title={"Body"}
- body={undefined}
->
-
-</RequestSchema>
-
-<StatusCodes
- id={undefined}
- label={undefined}
- responses={{"200":{"description":"Object with all tags data.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}}},"required":["tags"]}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-in-the-list.api.mdx b/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-in-the-list.api.mdx
deleted file mode 100644
index 25eb8f9b..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-in-the-list.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-id: get-bookmarks-in-the-list
-title: "Get bookmarks in the list"
-description: "Get bookmarks in the list"
-sidebar_label: "Get bookmarks in the list"
-hide_title: true
-hide_table_of_contents: true
-api: eJzNWN9v4zYM/lcMvWwDjKY33LCD39piu3U/rsW1wx6KPDA2E6uRJZ9Ep00D/+8DJcd2Uid17wpsT00tUvz4iaRIbUSGLrWyJGm0SMRHpGhmzLIAu3SR1BHlGCnpSMSCYOFEcif+lI6cmMbCYVpZSWuR3G3EDMGiPasoF8ndtJ7GogQLBRJa5wVcmmMBItkIWpcoEuHISr0QscBHKErFnyTKTD2uF8XD/YefzePTT/kjkUk/sHVJXoStX2aijoXFL5W0mImEbIWx0FCwgAoCsZDsUAmUizo+al5XBfsFLhWx54Ody3AOlSKRhC879uagXGfQGUtXNkO7tfmlQrseNqqrYob22G5KFpJG7NTC3xJzUVlnjm6dBomX954ZoxC06LEQKN4Nlst55JAiMpFfbQPnOxelRhNqih6kUtEMI6lTVWWYbUPKoiuNdngSfTKEcUS57JRS0KyjwC4wmhsbOVNgF5Yngz7+T6C1ZDfbXgTFPdKn7EAw45j3H09P+c+uD1eze0wZJ+U+BaMMCNhCA4Y1oCyVTIE1JveO1QaO0/iNRCxKa0q0JIPRFnVPFKyFNYMlLNzLW8jseUTWsUgtAmF2RoOrhcnkXA4vx0JXSsGMI5pPrm7je4Qk2DSXK8wGIrmOxRxWhsvVoXWCxULqxQ0BVe5le13dcFWaonOCTUhVWWSaUGesNa1j4aqiACuf/Cm9/fba0Dh6Ao71ONJ9rX/jsAiZMbAARJDmmJ0PgmvrsxSxyKsCtJjWOyXgji02++/s5uV66WI0Xs39bXTcgbB6GIqSeunJr6wa9Gh80O7k/Ah5WcAC/x4ye0j4zDnkG3FUjKQWUbvc0Gu05pVS12wpJOBrVEuLqYUHhdlXKK9khuZVQGEl05FE51Soiy50XpRvwuw1cLaejzMAFeXGjmO1minpchwnnQHhdaMxDjhr/NWU8REKe8nqpUPuTLn/+LZcJHwkn4v+x1AyOlPZdGTODEPd2vhWrMDB4cH6X7cviPv0ZSPZvFMaii0Obanw02CBHUrzVzASCyef+ts2PezhFPhqmjtSOl/fgPVKL7V5GLg1vMK0bql9+ytv1DHzbfJbr9r0y/CWiZv+lxlojfayiY696iuaushyTYfna5IYKLachYfI8Vdqh39aDwp0rd5OY9drxnY6r/02a7g7avqPLqDa85l2885545xgXBofqRmAXh18XR+8s0/P1DUspGY3z1vR2tPx/vT9876dJ9RIG4rmptLZ2/XrqcmG26cCneNQeL6256nfoZPnI629PuUmE4lYhCjhkTkRE5453GQT5ul60qfJoV1t53rfAokNZJlF5+oJlHKyesdRCFYy6x58sxzY2k7WOVHpksmE7PpkCRaWiOUJlKXYH+duc4yaHSIz92PaH418FLDwgfSeJG6Y02bM6T1MtASxZZ9nLMZzgBfilPE/fjW2AEb4+z+3nkWp54bV2esA6d3J6clpb/xu8ZxdXw7iP7u+9BPjDnh2lu9r44j72mSzHR+PPcTstYxteB1/vQmO8002KRVIP/M07Ws48Tv/dMLHm7RvKN2hT2ORG0csttnMwPHtUdf8Ocy0HAqZdHzg3VC+xPXeA8kKVMU4/MPDAfntE8gY2fZN47jwQcr+w4eCwRMJXj17POi8m3aJNcz5QVe//9yUgh+iQ9a3d59e92125xKe3vi+zBH4QBlBWDxLUyz7UJ+VOobelpqPv9yK0NL2p/HdLOwParuQNpsgcWuWqOu6RUj8PwOs638Bja0zuw==
-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 bookmarks in the list"}
->
-</Heading>
-
-<MethodEndpoint
- method={"get"}
- path={"/lists/{listId}/bookmarks"}
- context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
-
-Get bookmarks in the list
-
-<Heading
- id={"request"}
- as={"h2"}
- className={"openapi-tabs__heading"}
- children={"Request"}
->
-</Heading>
-
-<ParamsDetails
- parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 list data.","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},"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","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-with-the-tag.api.mdx b/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-with-the-tag.api.mdx
deleted file mode 100644
index b06a9bcc..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/get-bookmarks-with-the-tag.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-id: get-bookmarks-with-the-tag
-title: "Get bookmarks with the tag"
-description: "Get bookmarks with the tag"
-sidebar_label: "Get bookmarks with the tag"
-hide_title: true
-hide_table_of_contents: true
-api: eJzNWEtv4zYQ/isCL20BIc4WW3ShW3bRbtOim6Bx0UPgw1gcW4wlUkuOnHgN/fdiqKcdOlF2A7SnOOI8vnlyhnsh0aVWlaSMFon4iBQtjdkUYDcuuleURZRhRLAWsSBYO5Hcijn/XcTCYVpZRTuR3O7FEsGivagoE8ntol7EogQLBRJa5wlcmmEBItkL2pUoEuHIKs1y8QGKMudPCpXMH3br4v7u3c/m4ctP2QORSd+xckWeZA7rSynqWFj8XCmLUiRkK4yFhoLPyZ/HQrE5JVAm6vhJ5boq2ChwqYi9N9g0iSuochJJ8+VA3QpyN+hzxtKVlWg7nZ8rtLuwUl0VS7RPSctVoWiCpB5+55YPlXXmSdFpQ/G87KUxOYIWIy80Hj5MlctV5JAiMpE/7dPmOxelRhNqiu5VnkdLjJRO80qijJT26WTRlUY7PIs+GcI4okwNTClo5snBrjFaGRs5U+CQlGdBG/8n0Hpnt2I/NIxHTl+wAY0ax37/8fyc/xzacLW8w5SaEsyVo0gCAWtowTAHlGWuUmCO2Z1jtkA4jRckYlFaU6Il1SjtUY9IwVrYMVjCwj0vQsnHGVnHIrUIhPKCgqeFkWqlwsex0FWew5IzmiNX9/k9gRJsmqktykAm17FYwdZwszp1TrBeK72+IaDKPa9v6BuuSlN0TrAKlVcW2U2oJXMt6li4qijAqi8+Sq8vXhua5p4Gx26a032jf+W0aCojcABEkGYo3wfB9f1ZiVhkVQFaLOqDFnDLGlv5B9I83ahcjMarlb+LnjagOT0NJVd6451f2Txo0fSkPaj5CfSqgDX+HVJ7ivjCOaTLQEhCOZJaRO0yQy/hWlV5fs2amgJ8CWtpMbVwn6P8CuatkmheBBS2Kp3o6IyK/MOQOs/St2n2Ejid5dMUQEWZsdO8Wi1z5TKcRi2B8LrlmAacOf5s2/gEhqNi9dRN7Sx4/vi2WiR8IF+L/keoGJ2pbDqxZsJQOx3fihU4OTxY/2v+DLkvX1YiVwNTKLc4tVWOn4INNlTmL/BILJz6MhbbzrCnS+Cr3Tw4ZbD1Fbxe6Y0294FbwzMs6t61r3/lTQoz3ya/jbrNuA13nrgZf1mC1mgv2+w46r6i7YtM1054vieJQLPlKjzlHH+lDvgXdZBgGPUOBrvRMHYweR2PWeHpqJ0/hoTq47MY9p33rXGCcWl8oHYBenHyDXPwgZyRqmtYK81mvu9Ja++Ot+dvH8/tc1hH2lC0MpWWrzeup0aGp6cCneNMeHx2ZKiXMNBzRGvPT5mRIhHrJkl4Y07EjEMw2/tlup6NfeTQbruV3s8/Yg9SWnSunkGpZts3nIJgFbvcQ2+PG1d1a3VGVLpkNiO7O9uAhQ1ieQZlKY53uXmGUSshMiu/o/3R0kcNFo7G6DXihj3a7jijN4nePazZFxmT8RLgibhe/I9fjS2AEf7+z9z7UOmVYXa2uoH05uz87Hy0e/d4Lq4vg/gvri/9ungAno3ly9o44qE22Xe745NvMEcDY59dz7zcNKbzRTYrc1B+5Wmn1ybit13RJd0DyhD0RSwy44iJ9vslOL466po/Nwstp4JUjgM+bOQb3B29jmwhrxiFf3U4Qd+9f0yh7R80niY+6bH/8JUgGI/GqkcvB4N1i6Gwwj4/aer3f7WN4IfolPbu4tO7sc4OVZMU/q7MEDieDKA5u0hTLMdIH/U5Rt73mY+/zEUzzo438cMiHC9ph4j2+4Zibjao63oAyP8zwLr+F/eXMGo=
-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 bookmarks with the tag"}
->
-</Heading>
-
-<MethodEndpoint
- method={"get"}
- path={"/tags/{tagId}/bookmarks"}
- context={"endpoint"}
->
-
-</MethodEndpoint>
-
-
-
-Get bookmarks with the tag
-
-<Heading
- id={"request"}
- as={"h2"}
- className={"openapi-tabs__heading"}
- children={"Request"}
->
-</Heading>
-
-<ParamsDetails
- parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 list data.","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},"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","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.27.0/api/search-bookmarks.api.mdx
deleted file mode 100644
index e15d4156..00000000
--- a/docs/versioned_docs/version-v0.27.0/api/search-bookmarks.api.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-id: search-bookmarks
-title: "Search bookmarks"
-description: "Search bookmarks"
-sidebar_label: "Search bookmarks"
-hide_title: true
-hide_table_of_contents: true
-api: eJzNWEtv20YQ/ivEXNoChOT0qJsSpK1bNDZqFz0YPIzIobjRcpfehxxF4H8vZkmRlEzZVGKgPVnmzuOb587sHjKyqRGVE1rBAu4ITVpEK603JZqNhRgcri0sHuB99y2JwVLqjXA7WDzsYUVoyCy9K2DxkNRJDBUaLMmRsYHApgWVCIs9uF1FsADrjFBrqGMw9OiFoQwWzniKQWHJBI8Qg2BAj57MDur4vJAYSPmSEaJNIQ4GAQuWtEWVEsPNKEcvHSwGn4+U5yhtr91q425MRmYCCuXLFZmXpElRCneJPU44yR8+eGP1i6LThuJ12SutJaGCgSsafx+H/zqPLLnI6Sicdnnwg41SrRwpFz0JKaMVRUKl0meURUJFrqDIkK20sjSLPmlHceQK0TOlqJhHollTlGsTWV1Sn2WzURv/J9A6Z7diPzSMJ05P2IBGjWW//3x1xX+ObbhZfaaUcboiALNNtRmyXrqgqkXFrFhVUqTIrPPPlvlH4qqDRIihMroi40Sjva/fnhSNwR2jdlTa10WIbLReU0PoKFu60dNSZyIX48cxKC8lrji1OYR1l+gTKNlPYkvZSErXMeS41dyOzp07XK+FWt85dN6+rq/vKNanKVnugjkK6Q2xm0hlzJXUMVhflmjE1xCltxevtJvmngbHbprTQz9/47RoSmTkAJ3DtKDs/Si4rnMLiKHwJSpI6qNe8MAaW/lH0gLdoFy0ops83DYvG9CcnocihdoE53sjRy2anrRHxT+BXpS4pr/H1J4jXlpL7nokJGM5khoiZQvtLuHKvZS3rKkpwEtYK0OpwSdJ2Tcwb0VG+iKguBXpREcXrpQf+tR5lb5Ns0vgHCyfpgC9K7SZ5lW/ksIWNI06Q0e3Lcc04MzxZ9vGJzCcFGugbmon4UHk+2rR0RcXajH8GCtGq71JJ9bMONSDju/FipwcAWz4df8KeShfVpLlPdNYbnFqC0mfRhvsWJlf4JEYrPg6FNsOs+dL4Jvd3Dult/UNvO7VRumnkVsjMCR159q3v/ImhZlvk98G3WbYhg+euBt+WaFSZK7b7DjpvtD2RaZrJ7zQk2Ck2XIVnnNOuFJ7/Ek9StCPekeD3WAYO5q8Tses8emonT/6hOrik/SLz2HVBMal6ItrN6GLk2+4xw7kDFTd4looNrNfb+s6+KMkV+gMFrBuHIy83sK8Ezlvpne2k8z2sOqGqQH2mGWGrK3nWIn59h0HDo1goCGl2uNmQzispoVzlV3M587sZhs0uCGqZlhVcLoK3RcUtRIinYdN4o+WPmqwsA2DLf2O14Z2Mxjs6p03WXNITSbj0TkQcZaFH79oUyIj/P2f+xASoXLN7Gx1A+nd7Gp2NVhdOzzL2+tR/Mvb67BtHYFnY/mK09bxKLjYH1avkWeJk+Gq60+jTxiNmdzq55VEEZaCdr5r4nqcKm1kkxgKbR2f7vcrtNxV65o/N0sfxzsTlqN6Zmsd4vrxrzYxf4rOQdrQrn372KL0fB62+Wc6GrrhK8UU+sM7xBTa7mHhZeKzxv6H2/oLnn22wffWJX2FhkesGApC9i0HueFepilVQ65nGzpL6drGrx/voZnshkvpcWUN9xVUu4Hs/b6huNcbUnUNBxMc/w81t+x/AQnz0gw=
-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},"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","unknown"]}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
->
-
-</StatusCodes>
-
-
-
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/01-intro.md b/docs/versioned_docs/version-v0.31.0/01-getting-started/01-intro.md
similarity index 98%
rename from docs/versioned_docs/version-v0.27.0/01-intro.md
rename to docs/versioned_docs/version-v0.31.0/01-getting-started/01-intro.md
index 05d4ae30..1c99f4c0 100644
--- a/docs/versioned_docs/version-v0.27.0/01-intro.md
+++ b/docs/versioned_docs/version-v0.31.0/01-getting-started/01-intro.md
@@ -14,6 +14,7 @@ Karakeep (previously Hoarder) is an open source "Bookmark Everything" app that u
- 🔗 Bookmark links, take simple notes and store images and pdfs.
- ⬇️ Automatic fetching for link titles, descriptions and images.
- 📋 Sort your bookmarks into lists.
+- 👥 Collaborate with others on the same list.
- 🔎 Full text search of all the content stored.
- ✨ AI-based (aka chatgpt) automatic tagging and summarization. With supports for local models using ollama!
- 🤖 Rule-based engine for customized management.
diff --git a/docs/versioned_docs/version-v0.27.0/04-screenshots.md b/docs/versioned_docs/version-v0.31.0/01-getting-started/02-screenshots.md
similarity index 86%
rename from docs/versioned_docs/version-v0.27.0/04-screenshots.md
rename to docs/versioned_docs/version-v0.31.0/01-getting-started/02-screenshots.md
index 07830566..bf1604d3 100644
--- a/docs/versioned_docs/version-v0.27.0/04-screenshots.md
+++ b/docs/versioned_docs/version-v0.31.0/01-getting-started/02-screenshots.md
@@ -24,11 +24,7 @@
![Settings](/img/screenshots/settings.png)
-## Admin Panel
-![Ammin](/img/screenshots/admin.png)
-
-
-## iOS Sharing
+## Sharing
<img src="/img/screenshots/share-sheet.png" width="400px" />
diff --git a/docs/versioned_docs/version-v0.31.0/01-getting-started/_category_.json b/docs/versioned_docs/version-v0.31.0/01-getting-started/_category_.json
new file mode 100644
index 00000000..3562d433
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/01-getting-started/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Getting Started",
+ "position": 1
+}
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/01-docker.md b/docs/versioned_docs/version-v0.31.0/02-installation/01-docker.md
similarity index 68%
rename from docs/versioned_docs/version-v0.27.0/02-installation/01-docker.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/01-docker.md
index ff508b73..80739c80 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/01-docker.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/01-docker.md
@@ -1,4 +1,4 @@
-# Docker Compose [Recommended]
+# Docker
### Requirements
@@ -44,7 +44,7 @@ Persistent storage and the wiring between the different services is already take
Keep in mind that every time you change the `.env` file, you'll need to re-run `docker compose up`.
-If you want more config params, check the config documentation [here](/configuration).
+If you want more config params, check the config documentation [here](../03-configuration/01-environment-variables.md).
### 4. Setup OpenAI
@@ -57,21 +57,9 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t
OPENAI_API_KEY=<key>
```
-Learn more about the costs of using openai [here](/openai).
+Learn more about the costs of using openai [here](../06-administration/03-openai.md).
-<details>
- <summary>If you want to use Ollama (https://ollama.com/) instead for local inference.</summary>
-
- **Note:** The quality of the tags you'll get will depend on the quality of the model you choose.
-
- - Make sure ollama is running.
- - Set the `OLLAMA_BASE_URL` env variable to the address of the ollama API.
- - Set `INFERENCE_TEXT_MODEL` to the model you want to use for text inference in ollama (for example: `llama3.1`)
- - Set `INFERENCE_IMAGE_MODEL` to the model you want to use for image inference in ollama (for example: `llava`)
- - Make sure that you `ollama pull`-ed the models that you want to use.
- - You might want to tune the `INFERENCE_CONTEXT_LENGTH` as the default is quite small. The larger the value, the better the quality of the tags, but the more expensive the inference will be.
-
-</details>
+If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../03-configuration/02-different-ai-providers.md) guide.
### 5. Start the service
@@ -85,11 +73,11 @@ Then visit `http://localhost:3000` and you should be greeted with the Sign In pa
### [Optional] 6. Enable optional features
-Check the [configuration docs](/configuration) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
+Check the [configuration docs](../03-configuration/01-environment-variables.md) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
### [Optional] 7. Setup quick sharing extensions
-Go to the [quick sharing page](/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
+Go to the [quick sharing page](../04-using-karakeep/quick-sharing.md) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
## Updating
@@ -98,4 +86,4 @@ Updating Karakeep will depend on what you used for the `KARAKEEP_VERSION` env va
- If you pinned the app to a specific version, bump the version and re-run `docker compose up -d`. This should pull the new version for you.
- If you used `KARAKEEP_VERSION=release`, you'll need to force docker to pull the latest version by running `docker compose up --pull always -d`.
-Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](/troubleshooting) page.
+Note that if you want to upgrade/migrate `Meilisearch` versions, refer to the [troubleshooting](../06-administration/05-troubleshooting.md) page.
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/02-unraid.md b/docs/versioned_docs/version-v0.31.0/02-installation/02-unraid.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/02-installation/02-unraid.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/02-unraid.md
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/03-archlinux.md b/docs/versioned_docs/version-v0.31.0/02-installation/03-archlinux.md
similarity index 87%
rename from docs/versioned_docs/version-v0.27.0/02-installation/03-archlinux.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/03-archlinux.md
index 63db9d75..de86cdf3 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/03-archlinux.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/03-archlinux.md
@@ -27,7 +27,7 @@
3. Set up
- Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
+ Environment variables can be set in `/etc/karakeep/karakeep.env` according to [configuration page](../03-configuration/01-environment-variables.md). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
4. Enable service
@@ -82,7 +82,7 @@ sudo chown -R karakeep:karakeep /var/lib/karakeep
```
**6. Set Karakeep**
-Edit `/etc/karakeep/karakeep.env` according to [configuration page](/configuration). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
+Edit `/etc/karakeep/karakeep.env` according to [configuration page](../03-configuration/01-environment-variables.md). **The environment variables that are not specified in `/etc/karakeep/karakeep.env` need to be added by yourself.**
Or you can copy old hoarder env file to karakeep:
```shell
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/04-kubernetes.md b/docs/versioned_docs/version-v0.31.0/02-installation/04-kubernetes.md
similarity index 76%
rename from docs/versioned_docs/version-v0.27.0/02-installation/04-kubernetes.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/04-kubernetes.md
index b8c40551..9daac131 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/04-kubernetes.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/04-kubernetes.md
@@ -18,11 +18,11 @@ You should also change the `NEXTAUTH_URL` variable to point to your server addre
Using `KARAKEEP_VERSION=release` will pull the latest stable version. You might want to pin the version instead to control the upgrades (e.g. `KARAKEEP_VERSION=0.10.0`). Check the latest versions [here](https://github.com/karakeep-app/karakeep/pkgs/container/karakeep).
-To see all available configuration options check the [documentation](https://docs.karakeep.app/configuration).
+To see all available configuration options check the [documentation](../03-configuration/01-environment-variables.md).
To configure the neccessary secrets for the application copy the `.secrets_sample` file to `.secrets` and change the sample secrets to your generated secrets.
-> Note: You **should** change the random strings. You can use `openssl rand -base64 36` to generate the random strings.
+> Note: You **should** change the random strings. You can use `openssl rand -base64 36` to generate the random strings.
### 3. Setup OpenAI
@@ -35,21 +35,9 @@ To enable automatic tagging, you'll need to configure OpenAI. This is optional t
OPENAI_API_KEY=<key>
```
-Learn more about the costs of using openai [here](/openai).
+Learn more about the costs of using openai [here](../06-administration/03-openai.md).
-<details>
- <summary>[EXPERIMENTAL] If you want to use Ollama (https://ollama.com/) instead for local inference.</summary>
-
- **Note:** The quality of the tags you'll get will depend on the quality of the model you choose. Running local models is a recent addition and not as battle tested as using openai, so proceed with care (and potentially expect a bunch of inference failures).
-
- - Make sure ollama is running.
- - Set the `OLLAMA_BASE_URL` env variable to the address of the ollama API.
- - Set `INFERENCE_TEXT_MODEL` to the model you want to use for text inference in ollama (for example: `mistral`)
- - Set `INFERENCE_IMAGE_MODEL` to the model you want to use for image inference in ollama (for example: `llava`)
- - Make sure that you `ollama pull`-ed the models that you want to use.
-
-
-</details>
+If you want to use a different AI provider (e.g. Ollama for local inference), check out the [different AI providers](../03-configuration/02-different-ai-providers.md) guide.
### 4. Deploy the service
@@ -103,7 +91,7 @@ If the secret is successfully created you can now configure the Ingress to use T
### [Optional] 6. Setup quick sharing extensions
-Go to the [quick sharing page](/quick-sharing) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
+Go to the [quick sharing page](../04-using-karakeep/quick-sharing.md) to install the mobile apps and the browser extensions. Those will help you hoard things faster!
## Updating
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/06-debuntu.md b/docs/versioned_docs/version-v0.31.0/02-installation/06-debuntu.md
similarity index 95%
rename from docs/versioned_docs/version-v0.27.0/02-installation/06-debuntu.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/06-debuntu.md
index 2f3d1113..e500d411 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/06-debuntu.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/06-debuntu.md
@@ -71,4 +71,4 @@ During installation, the script created a configuration file for `meilisearch`,
## Still Running Hoarder?
-There is a way to upgrade. Please see [Guides > Hoarder to Karakeep Migration](https://docs.karakeep.app/Guides/hoarder-to-karakeep-migration)
+There is a way to upgrade. Please see [Hoarder to Karakeep Migration](../06-administration/08-hoarder-to-karakeep-migration.md)
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/07-minimal-install.md b/docs/versioned_docs/version-v0.31.0/02-installation/07-minimal-install.md
similarity index 90%
rename from docs/versioned_docs/version-v0.27.0/02-installation/07-minimal-install.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/07-minimal-install.md
index 5c2ee399..2702e5aa 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/07-minimal-install.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/07-minimal-install.md
@@ -44,6 +44,4 @@ docker run -d \
You **MUST** change the `super_random_string` to a true random string which you can generate with `openssl rand -hex 32`.
:::
-Check the [configuration docs](/configuration) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
-
-
+Check the [configuration docs](../03-configuration/01-environment-variables.md) for extra features to enable such as full page archival, full page screenshots, inference languages, etc.
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/08-truenas.md b/docs/versioned_docs/version-v0.31.0/02-installation/08-truenas.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/02-installation/08-truenas.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/08-truenas.md
diff --git a/docs/versioned_docs/version-v0.31.0/02-installation/09-cloud-hosting.md b/docs/versioned_docs/version-v0.31.0/02-installation/09-cloud-hosting.md
new file mode 100644
index 00000000..fcbdf50e
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/09-cloud-hosting.md
@@ -0,0 +1,13 @@
+# Karakeep Cloud
+
+:::tip
+If you want to use Karakeep without running your own servers, the hosted cloud option is the fastest way to start.
+:::
+
+[Karakeep Cloud](https://cloud.karakeep.app) is the fully managed version of Karakeep operated by the core team. It handles hosting, updates, monitoring, and backups for you, so you can focus on saving content instead of maintaining infrastructure.
+
+### Get started
+
+1. Visit [cloud.karakeep.app](https://cloud.karakeep.app) and create an account.
+2. Follow the onboarding flow to create your workspace.
+3. Install the browser extension or mobile apps from the [quick sharing page](../04-using-karakeep/quick-sharing.md) and start saving links immediately.
diff --git a/docs/versioned_docs/version-v0.27.0/02-installation/05-pikapods.md b/docs/versioned_docs/version-v0.31.0/02-installation/10-pikapods.md
similarity index 98%
rename from docs/versioned_docs/version-v0.27.0/02-installation/05-pikapods.md
rename to docs/versioned_docs/version-v0.31.0/02-installation/10-pikapods.md
index dad0785a..290e5819 100644
--- a/docs/versioned_docs/version-v0.27.0/02-installation/05-pikapods.md
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/10-pikapods.md
@@ -1,4 +1,4 @@
-# PikaPods [Paid Hosting]
+# PikaPods
:::info
Note: PikaPods shares some of its revenue from hosting Karakeep with the maintainer of this project.
diff --git a/docs/versioned_docs/version-v0.31.0/02-installation/_category_.json b/docs/versioned_docs/version-v0.31.0/02-installation/_category_.json
new file mode 100644
index 00000000..874082cc
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/02-installation/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Installation",
+ "position": 3
+}
diff --git a/docs/versioned_docs/version-v0.27.0/03-configuration.md b/docs/versioned_docs/version-v0.31.0/03-configuration/01-environment-variables.md
similarity index 50%
rename from docs/versioned_docs/version-v0.27.0/03-configuration.md
rename to docs/versioned_docs/version-v0.31.0/03-configuration/01-environment-variables.md
index 0f61360f..f06a9e81 100644
--- a/docs/versioned_docs/version-v0.27.0/03-configuration.md
+++ b/docs/versioned_docs/version-v0.31.0/03-configuration/01-environment-variables.md
@@ -2,27 +2,34 @@
The app is mainly configured by environment variables. All the used environment variables are listed in [packages/shared/config.ts](https://github.com/karakeep-app/karakeep/blob/main/packages/shared/config.ts). The most important ones are:
-| Name | Required | Default | Description |
-| ------------------------------- | ------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| PORT | No | 3000 | The port on which the web server will listen. DON'T CHANGE THIS IF YOU'RE USING DOCKER, instead changed the docker bound external port. |
-| WORKERS_PORT | No | 0 (Random Port) | The port on which the worker will export its prometheus metrics on `/metrics`. By default it's a random unused port. If you want to utilize those metrics, fix the port to a value (and export it in docker if you're using docker). |
-| WORKERS_ENABLED_WORKERS | No | Not set | Comma separated list of worker names to enable. If set, only these workers will run. Valid values: crawler,inference,search,tidyAssets,video,feed,assetPreprocessing,webhook,ruleEngine. |
-| WORKERS_DISABLED_WORKERS | No | Not set | Comma separated list of worker names to disable. Takes precedence over `WORKERS_ENABLED_WORKERS`. |
-| DATA_DIR | Yes | Not set | The path for the persistent data directory. This is where the db lives. Assets are stored here by default unless `ASSETS_DIR` is set. |
-| ASSETS_DIR | No | Not set | The path where crawled assets will be stored. If not set, defaults to `${DATA_DIR}/assets`. |
-| NEXTAUTH_URL | Yes | Not set | Should point to the address of your server. The app will function without it, but will redirect you to wrong addresses on signout for example. |
-| NEXTAUTH_SECRET | Yes | Not set | Random string used to sign the JWT tokens. Generate one with `openssl rand -base64 36`. |
-| MEILI_ADDR | No | Not set | The address of meilisearch. If not set, Search will be disabled. E.g. (`http://meilisearch:7700`) |
-| MEILI_MASTER_KEY | Only in Prod and if search is enabled | Not set | The master key configured for meilisearch. Not needed in development environment. Generate one with `openssl rand -base64 36 \| tr -dc 'A-Za-z0-9'` |
-| MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded |
-| DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. |
-| PROMETHEUS_AUTH_TOKEN | No | Random | Enable a prometheus metrics endpoint at `/api/metrics`. This endpoint will require this token being passed in the Authorization header as a Bearer token. If not set, a new random token is generated everytime at startup. |
-| RATE_LIMITING_ENABLED | No | false | If set to true, API rate limiting will be enabled. |
-| DB_WAL_MODE | No | false | Enables WAL mode for the sqlite database. This should improve the performance of the database. There's no reason why you shouldn't set this to true unless you're running the db on a network attached drive. This will become the default at some time in the future. |
-| SEARCH_NUM_WORKERS | No | 1 | Number of concurrent workers for search indexing tasks. Increase this if you have a high volume of content being indexed for search. |
-| WEBHOOK_NUM_WORKERS | No | 1 | Number of concurrent workers for webhook delivery. Increase this if you have multiple webhook endpoints or high webhook traffic. |
-| ASSET_PREPROCESSING_NUM_WORKERS | No | 1 | Number of concurrent workers for asset preprocessing tasks (image processing, OCR, etc.). Increase this if you have many images or documents that need processing. |
-| RULE_ENGINE_NUM_WORKERS | No | 1 | Number of concurrent workers for rule engine processing. Increase this if you have complex automation rules that need to be processed quickly. |
+| Name | Required | Default | Description |
+| -------------------------------------- | ------------------------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| PORT | No | 3000 | The port on which the web server will listen. DON'T CHANGE THIS IF YOU'RE USING DOCKER, instead changed the docker bound external port. |
+| WORKERS_PORT | No | 0 (Random Port) | The port on which the worker will export its prometheus metrics on `/metrics`. By default it's a random unused port. If you want to utilize those metrics, fix the port to a value (and export it in docker if you're using docker). |
+| WORKERS_HOST | No | 127.0.0.1 | Host to listen to for requests to WORKERS_PORT. You will need to set this if running in a container, since localhost will not be reachable from outside |
+| WORKERS_ENABLED_WORKERS | No | Not set | Comma separated list of worker names to enable. If set, only these workers will run. Valid values: crawler,inference,search,adminMaintenance,video,feed,assetPreprocessing,webhook,ruleEngine. |
+| WORKERS_DISABLED_WORKERS | No | Not set | Comma separated list of worker names to disable. Takes precedence over `WORKERS_ENABLED_WORKERS`. |
+| LOG_LEVEL | No | debug | The application log level as defined in the [winston documentation](https://github.com/winstonjs/winston?tab=readme-ov-file#logging-levels). You may want to set this to `notice` or `warning` when running Karakeep in a production environment. |
+| DATA_DIR | Yes | Not set | The path for the persistent data directory. This is where the db lives. Assets are stored here by default unless `ASSETS_DIR` is set. |
+| ASSETS_DIR | No | Not set | The path where crawled assets will be stored. If not set, defaults to `${DATA_DIR}/assets`. |
+| NEXTAUTH_URL | Yes | Not set | Should point to the address of your server. The app will function without it, but will redirect you to wrong addresses on signout for example. |
+| NEXTAUTH_SECRET | Yes | Not set | Random string used to sign the JWT tokens. Generate one with `openssl rand -base64 36`. |
+| MEILI_ADDR | No | Not set | The address of meilisearch. If not set, Search will be disabled. E.g. (`http://meilisearch:7700`) |
+| MEILI_MASTER_KEY | Only in Prod and if search is enabled | Not set | The master key configured for meilisearch. Not needed in development environment. Generate one with `openssl rand -base64 36 \| tr -dc 'A-Za-z0-9'` |
+| MAX_ASSET_SIZE_MB | No | 50 | Sets the maximum allowed asset size (in MB) to be uploaded |
+| DISABLE_NEW_RELEASE_CHECK | No | false | If set to true, latest release check will be disabled in the admin panel. |
+| RATE_LIMITING_ENABLED | No | false | If set to true, API rate limiting will be enabled. |
+| CRAWLER_DOMAIN_RATE_LIMIT_WINDOW_MS | No | Not set | Time window in milliseconds for per-domain crawler rate limiting. |
+| CRAWLER_DOMAIN_RATE_LIMIT_MAX_REQUESTS | No | Not set | Maximum crawler requests allowed per domain inside the configured window. |
+| DB_WAL_MODE | No | false | Enables WAL mode for the sqlite database. This should improve the performance of the database. There's no reason why you shouldn't set this to true unless you're running the db on a network attached drive. This will become the default at some time in the future. |
+| SEARCH_NUM_WORKERS | No | 1 | Number of concurrent workers for search indexing tasks. Increase this if you have a high volume of content being indexed for search. |
+| SEARCH_JOB_TIMEOUT_SEC | No | 30 | How long to wait for a search indexing job to finish before timing out. Increase this if you have large bookmarks with extensive content that takes longer to index. |
+| WEBHOOK_NUM_WORKERS | No | 1 | Number of concurrent workers for webhook delivery. Increase this if you have multiple webhook endpoints or high webhook traffic. |
+| ASSET_PREPROCESSING_NUM_WORKERS | No | 1 | Number of concurrent workers for asset preprocessing tasks (image processing, OCR, etc.). Increase this if you have many images or documents that need processing. |
+| ASSET_PREPROCESSING_JOB_TIMEOUT_SEC | No | 60 | How long to wait for an asset preprocessing job to finish before timing out. Increase this if you have large images or PDFs that take longer to process. |
+| RULE_ENGINE_NUM_WORKERS | No | 1 | Number of concurrent workers for rule engine processing. Increase this if you have complex automation rules that need to be processed quickly. |
+| MAX_RSS_FEEDS_PER_USER | No | 1000 | The maximum number of RSS feeds a user can create. |
+| MAX_WEBHOOKS_PER_USER | No | 100 | The maximum number of webhooks a user can create. |
## Asset Storage
@@ -63,6 +70,7 @@ When setting up OAuth, the allowed redirect URLs configured at the provider shou
| DISABLE_SIGNUPS | No | false | If enabled, no new signups will be allowed and the signup button will be disabled in the UI |
| DISABLE_PASSWORD_AUTH | No | false | If enabled, only signups and logins using OAuth are allowed and the signup button and login form for local accounts will be disabled in the UI |
| EMAIL_VERIFICATION_REQUIRED | No | false | Whether email verification is required during user signup. If enabled, users must verify their email address before they can use their account. If you enable this, you must configure SMTP settings. |
+| OAUTH_AUTO_REDIRECT | No | false | If enabled and password authentication is disabled, automatically redirect to the OAuth provider instead of showing the login page. Useful when OAuth is the only authentication method available. |
| OAUTH_WELLKNOWN_URL | No | Not set | The "wellknown Url" for openid-configuration as provided by the OAuth provider |
| OAUTH_CLIENT_SECRET | No | Not set | The "Client Secret" as provided by the OAuth provider |
| OAUTH_CLIENT_ID | No | Not set | The "Client ID" as provided by the OAuth provider |
@@ -85,15 +93,18 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin
| Name | Required | Default | Description |
| ------------------------------------ | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](/openai). |
+| OPENAI_API_KEY | No | Not set | The OpenAI key used for automatic tagging. More on that in [here](../06-administration/03-openai.md). |
| OPENAI_BASE_URL | No | Not set | If you just want to use OpenAI you don't need to pass this variable. If, however, you want to use some other openai compatible API (e.g. azure openai service), set this to the url of the API. |
+| OPENAI_PROXY_URL | No | Not set | HTTP proxy server URL for OpenAI API requests (e.g., `http://proxy.example.com:8080`). |
+| OPENAI_SERVICE_TIER | No | Not set | Set to `auto`, `default`, or `flex`. Flex processing provides lower costs in exchange for slower response times and occasional resource unavailability. See [OpenAI Flex Processing](https://platform.openai.com/docs/guides/flex-processing) and [Chat Service Tier](https://platform.openai.com/docs/api-reference/chat/object#chat-object-service_tier) for more details. |
| OLLAMA_BASE_URL | No | Not set | If you want to use ollama for local inference, set the address of ollama API here. |
-| OLLAMA_KEEP_ALIVE | No | Not set | Controls how long the model will stay loaded into memory following the request (example value: "5m"). |
+| OLLAMA_KEEP_ALIVE | No | Not set | Controls how long the model will stay loaded into memory following the request (examples: "5m" for 5 minutes, "-1m" to keep the model loaded indefinitely, "0" to unload the model instantly after processing is complete). |
| INFERENCE_TEXT_MODEL | No | gpt-4.1-mini | The model to use for text inference. You'll need to change this to some other model if you're using ollama. |
| INFERENCE_IMAGE_MODEL | No | gpt-4o-mini | The model to use for image inference. You'll need to change this to some other model if you're using ollama and that model needs to support vision APIs (e.g. llava). |
| EMBEDDING_TEXT_MODEL | No | text-embedding-3-small | The model to be used for generating embeddings for the text. |
| INFERENCE_CONTEXT_LENGTH | No | 2048 | The max number of tokens that we'll pass to the inference model. If your content is larger than this size, it'll be truncated to fit. The larger this value, the more of the content will be used in tag inference, but the more expensive the inference will be (money-wise on openAI and resource-wise on ollama). Check the model you're using for its max supported content size. |
| INFERENCE_MAX_OUTPUT_TOKENS | No | 2048 | The maximum number of tokens that the inference model is allowed to generate in its response. This controls the length of AI-generated content like tags and summaries. Increase this if you need longer responses, but be aware that higher values will increase costs (for OpenAI) and processing time. |
+| INFERENCE_USE_MAX_COMPLETION_TOKENS | No | false | \[OpenAI Only\] Whether to use the newer `max_completion_tokens` parameter instead of the deprecated `max_tokens` parameter. Set to `true` if using GPT-5 or o-series models which require this. Will become the default in a future release. |
| INFERENCE_LANG | No | english | The language in which the tags will be generated. |
| INFERENCE_NUM_WORKERS | No | 1 | Number of concurrent workers for AI inference tasks (tagging and summarization). Increase this if you have multiple AI inference requests and want to process them in parallel. |
| INFERENCE_ENABLE_AUTO_TAGGING | No | true | Whether automatic AI tagging is enabled or disabled. |
@@ -111,25 +122,29 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin
## Crawler Configs
-| Name | Required | Default | Description |
-| ---------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| CRAWLER_NUM_WORKERS | No | 1 | Number of allowed concurrent crawling jobs. By default, we're only doing one crawling request at a time to avoid consuming a lot of resources. |
-| BROWSER_WEB_URL | No | Not set | The browser's http debugging address. The worker will talk to this endpoint to resolve the debugging console's websocket address. If you already have the websocket address, use `BROWSER_WEBSOCKET_URL` instead. If neither `BROWSER_WEB_URL` nor `BROWSER_WEBSOCKET_URL` are set, the worker will use plain http requests skipping screenshotting and javascript execution. |
-| BROWSER_WEBSOCKET_URL | No | Not set | The websocket address of browser's debugging console. If you want to use [browserless](https://browserless.io), use their websocket address here. If neither `BROWSER_WEB_URL` nor `BROWSER_WEBSOCKET_URL` are set, the worker will use plain http requests skipping screenshotting and javascript execution. |
-| BROWSER_CONNECT_ONDEMAND | No | false | If set to false, the crawler will proactively connect to the browser instance and always maintain an active connection. If set to true, the browser will be launched on demand only whenever a crawling is requested. Set to true if you're using a service that provides you with browser instances on demand. |
-| CRAWLER_DOWNLOAD_BANNER_IMAGE | No | true | Whether to cache the banner image used in the cards locally or fetch it each time directly from the website. Caching it consumes more storage space, but is more resilient against link rot and rate limits from websites. |
-| CRAWLER_STORE_SCREENSHOT | No | true | Whether to store a screenshot from the crawled website or not. Screenshots act as a fallback for when we fail to extract an image from a website. You can also view the stored screenshots for any link. |
-| CRAWLER_FULL_PAGE_SCREENSHOT | No | false | Whether to store a screenshot of the full page or not. Disabled by default, as it can lead to much higher disk usage. If disabled, the screenshot will only include the visible part of the page |
-| CRAWLER_SCREENSHOT_TIMEOUT_SEC | No | 5 | How long to wait for the screenshot finish before timing out. If you are capturing full-page screenshots of long webpages, consider increasing this value. |
-| CRAWLER_FULL_PAGE_ARCHIVE | No | false | Whether to store a full local copy of the page or not. Disabled by default, as it can lead to much higher disk usage. If disabled, only the readable text of the page is archived. |
-| CRAWLER_JOB_TIMEOUT_SEC | No | 60 | How long to wait for the crawler job to finish before timing out. If you have a slow internet connection or a low powered device, you might want to bump this up a bit |
-| CRAWLER_NAVIGATE_TIMEOUT_SEC | No | 30 | How long to spend navigating to the page (along with its redirects). Increase this if you have a slow internet connection |
-| CRAWLER_VIDEO_DOWNLOAD | No | false | Whether to download videos from the page or not (using yt-dlp) |
-| CRAWLER_VIDEO_DOWNLOAD_MAX_SIZE | No | 50 | The maximum file size for the downloaded video. The quality will be chosen accordingly. Use -1 to disable the limit. |
-| CRAWLER_VIDEO_DOWNLOAD_TIMEOUT_SEC | No | 600 | How long to wait for the video download to finish |
-| CRAWLER_ENABLE_ADBLOCKER | No | true | Whether to enable an adblocker in the crawler or not. If you're facing troubles downloading the adblocking lists on worker startup, you can disable this. |
-| CRAWLER_YTDLP_ARGS | No | [] | Include additional yt-dlp arguments to be passed at crawl time separated by %%: https://github.com/yt-dlp/yt-dlp?tab=readme-ov-file#general-options |
-| BROWSER_COOKIE_PATH | No | Not set | Path to a JSON file containing cookies to be loaded into the browser context. The file should be an array of cookie objects, each with name and value (required), and optional fields like domain, path, expires, httpOnly, secure, and sameSite (e.g., `[{"name": "session", "value": "xxx", "domain": ".example.com"}`]). |
+| Name | Required | Default | Description |
+| ---------------------------------------- | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| CRAWLER_NUM_WORKERS | No | 1 | Number of allowed concurrent crawling jobs. By default, we're only doing one crawling request at a time to avoid consuming a lot of resources. |
+| BROWSER_WEB_URL | No | Not set | The browser's http debugging address. The worker will talk to this endpoint to resolve the debugging console's websocket address. If you already have the websocket address, use `BROWSER_WEBSOCKET_URL` instead. If neither `BROWSER_WEB_URL` nor `BROWSER_WEBSOCKET_URL` are set, the worker will use plain http requests skipping screenshotting and javascript execution. |
+| BROWSER_WEBSOCKET_URL | No | Not set | The websocket address of browser's debugging console. If you want to use [browserless](https://browserless.io), use their websocket address here. If neither `BROWSER_WEB_URL` nor `BROWSER_WEBSOCKET_URL` are set, the worker will use plain http requests skipping screenshotting and javascript execution. |
+| BROWSER_CONNECT_ONDEMAND | No | false | If set to false, the crawler will proactively connect to the browser instance and always maintain an active connection. If set to true, the browser will be launched on demand only whenever a crawling is requested. Set to true if you're using a service that provides you with browser instances on demand. |
+| CRAWLER_DOWNLOAD_BANNER_IMAGE | No | true | Whether to cache the banner image used in the cards locally or fetch it each time directly from the website. Caching it consumes more storage space, but is more resilient against link rot and rate limits from websites. |
+| CRAWLER_STORE_SCREENSHOT | No | true | Whether to store a screenshot from the crawled website or not. Screenshots act as a fallback for when we fail to extract an image from a website. You can also view the stored screenshots for any link. |
+| CRAWLER_FULL_PAGE_SCREENSHOT | No | false | Whether to store a screenshot of the full page or not. Disabled by default, as it can lead to much higher disk usage. If disabled, the screenshot will only include the visible part of the page |
+| CRAWLER_SCREENSHOT_TIMEOUT_SEC | No | 5 | How long to wait for the screenshot finish before timing out. If you are capturing full-page screenshots of long webpages, consider increasing this value. |
+| CRAWLER_STORE_PDF | No | false | Whether to store a PDF snapshot of the crawled page. Disabled by default, as it can lead to much higher disk usage. When enabled, a PDF version of each crawled page will be captured and stored as an asset, which can be viewed in the bookmark preview. |
+| CRAWLER_FULL_PAGE_ARCHIVE | No | false | Whether to store a full local copy of the page or not. Disabled by default, as it can lead to much higher disk usage. If disabled, only the readable text of the page is archived. |
+| CRAWLER_JOB_TIMEOUT_SEC | No | 60 | How long to wait for the crawler job to finish before timing out. If you have a slow internet connection or a low powered device, you might want to bump this up a bit |
+| CRAWLER_NAVIGATE_TIMEOUT_SEC | No | 30 | How long to spend navigating to the page (along with its redirects). Increase this if you have a slow internet connection |
+| CRAWLER_PARSE_TIMEOUT_SEC | No | 60 | How long to wait for the HTML parsing subprocess (metadata extraction + readability) to finish before timing out. |
+| CRAWLER_PARSER_MEM_LIMIT_MB | No | 512 | Maximum heap size in MB for the HTML parsing subprocess. If the parser OOMs on large pages, increase this value. The subprocess is isolated so an OOM won't crash the main worker. |
+| CRAWLER_VIDEO_DOWNLOAD | No | false | Whether to download videos from the page or not (using yt-dlp) |
+| CRAWLER_VIDEO_DOWNLOAD_MAX_SIZE | No | 50 | The maximum file size for the downloaded video. The quality will be chosen accordingly. Use -1 to disable the limit. |
+| CRAWLER_VIDEO_DOWNLOAD_TIMEOUT_SEC | No | 600 | How long to wait for the video download to finish |
+| CRAWLER_ENABLE_ADBLOCKER | No | true | Whether to enable an adblocker in the crawler or not. If you're facing troubles downloading the adblocking lists on worker startup, you can disable this. |
+| CRAWLER_YTDLP_ARGS | No | [] | Include additional yt-dlp arguments to be passed at crawl time separated by %%: https://github.com/yt-dlp/yt-dlp?tab=readme-ov-file#general-options |
+| BROWSER_COOKIE_PATH | No | Not set | Path to a JSON file containing cookies to be loaded into the browser context. The file should be an array of cookie objects, each with name and value (required), and optional fields like domain, path, expires, httpOnly, secure, and sameSite (e.g., `[{"name": "session", "value": "xxx", "domain": ".example.com"}`]). |
+| HTML_CONTENT_SIZE_INLINE_THRESHOLD_BYTES | No | 5 \* 1024 | The thresholds in bytes after which larger assets will be stored in the assetdb (folder/s3) instead of inline in the database. |
<details>
@@ -138,6 +153,7 @@ Either `OPENAI_API_KEY` or `OLLAMA_BASE_URL` need to be set for automatic taggin
BROWSER_COOKIE_PATH specifies the path to a JSON file containing cookies to be loaded into the browser context for crawling.
The JSON file must be an array of cookie objects, each with:
+
- name: The cookie name (required).
- value: The cookie value (required).
- Optional fields: domain, path, expires, httpOnly, secure, sameSite (values: "Strict", "Lax", or "None").
@@ -163,13 +179,14 @@ Example JSON file:
## OCR Configs
-Karakeep uses [tesseract.js](https://github.com/naptha/tesseract.js) to extract text from images.
+Karakeep uses [tesseract.js](https://github.com/naptha/tesseract.js) to extract text from images by default. Alternatively, you can use an LLM-based OCR by enabling the `OCR_USE_LLM` flag. LLM-based OCR uses the configured inference model (OpenAI or Ollama) to extract text from images, which can provide better results for complex images but requires a configured inference provider.
| Name | Required | Default | Description |
| ------------------------ | -------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| OCR_CACHE_DIR | No | $TEMP_DIR | The dir where tesseract will download its models. By default, those models are not persisted and stored in the OS' temp dir. |
| OCR_LANGS | No | eng | Comma separated list of the language codes that you want tesseract to support. You can find the language codes [here](https://tesseract-ocr.github.io/tessdoc/Data-Files-in-different-versions.html). Set to empty string to disable OCR. |
| OCR_CONFIDENCE_THRESHOLD | No | 50 | A number between 0 and 100 indicating the minimum acceptable confidence from tessaract. If tessaract's confidence is lower than this value, extracted text won't be stored. |
+| OCR_USE_LLM | No | false | If set to true, uses the configured inference model (OpenAI or Ollama) for OCR instead of Tesseract. This can provide better results for complex images but requires a configured inference provider (`OPENAI_API_KEY` or `OLLAMA_BASE_URL`). Falls back to Tesseract if no inference provider is configured. |
## Webhook Configs
@@ -218,12 +235,25 @@ Karakeep can send emails for various purposes such as email verification during
If your Karakeep instance needs to connect through a proxy server, you can configure the following settings:
-| Name | Required | Default | Description |
-| ------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------- |
-| CRAWLER_HTTP_PROXY | No | Not set | HTTP proxy server URL for outgoing HTTP requests (e.g., `http://proxy.example.com:8080`) |
-| CRAWLER_HTTPS_PROXY | No | Not set | HTTPS proxy server URL for outgoing HTTPS requests (e.g., `http://proxy.example.com:8080`) |
-| CRAWLER_NO_PROXY | No | Not set | Comma-separated list of hostnames/IPs that should bypass the proxy (e.g., `localhost,127.0.0.1,.local`) |
+| Name | Required | Default | Description |
+| ---------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| CRAWLER_HTTP_PROXY | No | Not set | HTTP proxy server URL for outgoing HTTP requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. |
+| CRAWLER_HTTPS_PROXY | No | Not set | HTTPS proxy server URL for outgoing HTTPS requests (e.g., `http://proxy.example.com:8080`). You can pass multiple comma separated proxies and the used one will be chosen at random. The proxy is used for crawling, RSS feed fetches and webhooks. |
+| CRAWLER_NO_PROXY | No | Not set | Comma-separated list of hostnames/IPs that should bypass the proxy (e.g., `localhost,127.0.0.1,.local`) |
+| CRAWLER_ALLOWED_INTERNAL_HOSTNAMES | No | Not set | By default, Karakeep blocks worker-initiated requests whose DNS resolves to private, loopback, link-local, or Tailscale CGNAT IP addresses. Use this to allowlist specific hostnames for internal access (e.g., `internal.company.com`, `app-name.local`). Supports domain wildcards by prefixing with a dot (e.g., `.internal.company.com`, `.<tailnet-name>.ts.net`). Passing `.` allowlists all domains. Note: Internal IP validation is bypassed when a proxy is configured for the URL as the local DNS resolver won't necessarily be the same as the one used by the proxy. |
:::info
These proxy settings will be used by the crawler and other components that make outgoing HTTP requests.
:::
+
+## Monitoring
+
+Karakeep supports distributed tracing via OpenTelemetry. When enabled, traces are collected for tRPC API calls, background worker operations, and other key workflows. Karakeep also exports prometheus-based metrics.
+
+| Name | Required | Default | Description |
+| --------------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| OTEL_TRACING_ENABLED | No | false | Set to `true` to enable OpenTelemetry tracing. When disabled, all tracing operations are no-ops. |
+| OTEL_EXPORTER_OTLP_ENDPOINT | No | Not set | The OTLP HTTP endpoint to send traces to (e.g., `http://jaeger:4318/v1/traces` or `http://otel-collector:4318/v1/traces`). If not set, traces are logged to the console. |
+| OTEL_SERVICE_NAME | No | karakeep | The service name that will appear in your tracing backend. The actual service name will include a suffix (e.g., `karakeep-api`, `karakeep-workers`). |
+| OTEL_SAMPLE_RATE | No | 1.0 | The sampling rate for traces, between 0.0 and 1.0. A value of 1.0 means all traces are sampled, while 0.1 means only 10% of traces are sampled. Lower values reduce overhead and storage costs in production. |
+| PROMETHEUS_AUTH_TOKEN | No | Random | Enable a prometheus metrics endpoint at `/api/metrics`. This endpoint will require this token being passed in the Authorization header as a Bearer token. If not set, a new random token is generated everytime at startup. This cannot contain any special characters or you may encounter a 400 Bad Request response. |
diff --git a/docs/versioned_docs/version-v0.31.0/03-configuration/02-different-ai-providers.md b/docs/versioned_docs/version-v0.31.0/03-configuration/02-different-ai-providers.md
new file mode 100644
index 00000000..123871ea
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/03-configuration/02-different-ai-providers.md
@@ -0,0 +1,128 @@
+# Configuring different AI Providers
+
+Karakeep uses LLM providers for AI tagging and summarization. We support OpenAI-compatible providers and ollama. This guide will show you how to configure different providers.
+
+## OpenAI
+
+If you want to use OpenAI itself, you just need to pass in the OPENAI_API_KEY environment variable.
+
+```
+OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+# You can change the default models by uncommenting the following lines, and choosing your model.
+# INFERENCE_TEXT_MODEL=gpt-4.1-mini
+# INFERENCE_IMAGE_MODEL=gpt-4o-mini
+```
+
+## Ollama
+
+Ollama is a local LLM provider that you can use to run your own LLM server. You'll need to pass ollama's address to karakeep and you need to ensure that it's accessible from within the karakeep container (e.g. no localhost addresses).
+
+Ollama provides two API endpoints:
+
+1. **OpenAI-compatible API (Recommended)** - Uses the `/v1` chat endpoint which handles message formatting automatically
+2. **Native Ollama API** - Requires manual formatting for some models
+
+### Option 1: OpenAI-compatible API (Recommended)
+
+This approach uses Ollama's OpenAI-compatible endpoint and is more reliable with various models:
+
+```
+OPENAI_API_KEY=ollama
+OPENAI_BASE_URL=http://ollama.mylab.com:11434/v1
+
+# Make sure to pull the models in ollama first. Example models:
+INFERENCE_TEXT_MODEL=gemma3
+INFERENCE_IMAGE_MODEL=llava
+```
+
+### Option 2: Native Ollama API
+
+Alternatively, you can use the native Ollama API:
+
+```
+# MAKE SURE YOU DON'T HAVE OPENAI_API_KEY set, otherwise it takes precedence.
+
+OLLAMA_BASE_URL=http://ollama.mylab.com:11434
+
+# Make sure to pull the models in ollama first. Example models:
+INFERENCE_TEXT_MODEL=gemma3
+INFERENCE_IMAGE_MODEL=llava
+
+# If the model you're using doesn't support structured output, you also need:
+# INFERENCE_OUTPUT_SCHEMA=plain
+```
+
+:::tip
+If you experience issues with certain models (especially OpenAI's gpt-oss models or other models requiring specific chat formats), try using the OpenAI-compatible API endpoint instead.
+:::
+
+## Gemini
+
+Gemini has an OpenAI-compatible API. You need to get an api key from Google AI Studio.
+
+```
+
+OPENAI_BASE_URL=https://generativelanguage.googleapis.com/v1beta
+OPENAI_API_KEY=YOUR_API_KEY
+
+# Example models:
+INFERENCE_TEXT_MODEL=gemini-2.0-flash
+INFERENCE_IMAGE_MODEL=gemini-2.0-flash
+```
+
+## OpenRouter
+
+```
+OPENAI_BASE_URL=https://openrouter.ai/api/v1
+OPENAI_API_KEY=YOUR_API_KEY
+
+# Example models:
+INFERENCE_TEXT_MODEL=meta-llama/llama-4-scout
+INFERENCE_IMAGE_MODEL=meta-llama/llama-4-scout
+```
+
+## Perplexity
+
+```
+OPENAI_BASE_URL: https://api.perplexity.ai
+OPENAI_API_KEY: Your Perplexity API Key
+INFERENCE_TEXT_MODEL: sonar-pro
+INFERENCE_IMAGE_MODEL: sonar-pro
+```
+
+## Azure
+
+Azure has an OpenAI-compatible API.
+
+You can get your API key from the Overview page of the Azure AI Foundry Portal or via "Keys + Endpoints" on the resource in the Azure Portal.
+
+:::warning
+The [model name is the deployment name](https://learn.microsoft.com/en-us/azure/ai-foundry/openai/how-to/switching-endpoints#keyword-argument-for-model) you specified when deploying the model, which may differ from the base model name.
+:::
+
+```
+# Deployed via Azure AI Foundry:
+OPENAI_BASE_URL=https://{your-azure-ai-foundry-resource-name}.cognitiveservices.azure.com/openai/v1/
+
+# Deployed via Azure OpenAI Service:
+OPENAI_BASE_URL=https://{your-azure-openai-resource-name}.openai.azure.com/openai/v1/
+
+OPENAI_API_KEY=YOUR_API_KEY
+INFERENCE_TEXT_MODEL=YOUR_DEPLOYMENT_NAME
+INFERENCE_IMAGE_MODEL=YOUR_DEPLOYMENT_NAME
+```
+
+## Cloudflare
+
+Cloudflare supports OpenAI compatible endpoints. You can generate an API Token from the Cloudflare dashboard (Workers AI).
+
+```
+OPENAI_BASE_URL=https://api.cloudflare.com/client/v4/accounts/{your-account-id}/ai/v1
+OPENAI_API_KEY=Your Cloudflare Workers AI Token
+
+# Example models:
+INFERENCE_TEXT_MODEL=@cf/meta/llama-3.1-8b-instruct-fast
+INFERENCE_IMAGE_MODEL=@cf/meta/llama-3.2-11b-vision-instruct
+INFERENCE_OUTPUT_SCHEMA=json
+```
diff --git a/docs/versioned_docs/version-v0.31.0/03-configuration/_category_.json b/docs/versioned_docs/version-v0.31.0/03-configuration/_category_.json
new file mode 100644
index 00000000..0aea1748
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/03-configuration/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Configuration",
+ "position": 4
+}
diff --git a/docs/versioned_docs/version-v0.31.0/04-using-karakeep/_category_.json b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/_category_.json
new file mode 100644
index 00000000..b0784ea6
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Using Karakeep",
+ "position": 2
+}
diff --git a/docs/versioned_docs/version-v0.31.0/04-using-karakeep/advanced-workflows.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/advanced-workflows.md
new file mode 100644
index 00000000..5efd889a
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/advanced-workflows.md
@@ -0,0 +1,23 @@
+---
+sidebar_position: 10
+slug: advanced-workflows
+---
+
+# Advanced workflows
+
+Push Karakeep further with automation and integrations.
+
+## Rule engine
+
+- Create if-this-then-that style rules to auto-tag, favourite, or route bookmarks into lists based on metadata or content.
+- Useful for keeping inboxes tidy (e.g. auto-archive newsletters, auto-tag domains, or flag videos).
+
+## API
+
+- Use the API to script imports, syncs, or custom tools. Same surface area the apps use.
+- Great for integrating with personal scripts, cron jobs, or other services.
+
+## Webhooks
+
+- Subscribe to bookmark events and trigger your own systems when something is added, updated, or archived.
+- Pair with the API to build end-to-end automations (e.g. push new saves into a writing queue or a team chat).
diff --git a/docs/versioned_docs/version-v0.31.0/04-using-karakeep/bookmarking.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/bookmarking.md
new file mode 100644
index 00000000..0e2f350f
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/bookmarking.md
@@ -0,0 +1,42 @@
+---
+sidebar_position: 1
+slug: bookmarking
+---
+
+# Bookmarking
+
+Everything in Karakeep starts as a bookmark. Here’s how the different types work and how to keep your home view tidy with favourites and archive.
+
+## Favourites
+
+- Star bookmarks you like so they sit in their own dedicated favourites view for quick return visits.
+- Handy for saved gems you want to re-open often like articles you enjoyed, references you come back to, or things worth sharing.
+
+## Archiving
+
+- Archive hides a bookmark from the homepage without deleting it.
+- Archived items stay searchable and keep all tags, highlights, and attachments.
+- Ideal for achieving inbox-zero style for your homepage.
+
+## Bookmark types
+
+- **Links**: URLs saved from the web or extension. Karakeep grabs metadata, previews, screenshots, and archives when configured.
+- **Text**: Quick notes or snippets you paste in. Great for ideas, quotes, or saving context alongside links.
+- **Media**: Images or PDFs you want to save for later. Karakeep automatically extracts content out of those files and makes them searchable.
+
+## Notes
+
+- Attach personal notes to any bookmark to capture context, reminders, or next steps.
+- Notes live with the bookmark and are searchable, so you can recall why something mattered.
+
+## Highlights
+
+- Save quotes, summaries, or TODOs while reading.
+- Highlights show up in the bookmark detail view/reader and are searchable, so you can jump straight to the key ideas.
+
+## Attachments
+
+- Store extra context alongside a bookmark: screenshots, page captures, videos, and files you upload.
+- **Screenshots & archives**: fallback when the original page changes or disappear.
+- **Uploaded files**: keep PDFs, notes, or supporting assets right with the link.
+- Manage attachments from the bookmark detail view: upload, download, or detach as needed.
diff --git a/docs/versioned_docs/version-v0.27.0/10-import.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/import.md
similarity index 95%
rename from docs/versioned_docs/version-v0.27.0/10-import.md
rename to docs/versioned_docs/version-v0.31.0/04-using-karakeep/import.md
index 8ca8b1f9..3bf07cae 100644
--- a/docs/versioned_docs/version-v0.27.0/10-import.md
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/import.md
@@ -1,4 +1,9 @@
-# Importing Bookmarks
+---
+sidebar_position: 8
+slug: import
+---
+
+# Import your library
Karakeep supports importing bookmarks using the Netscape HTML Format, Pocket's new CSV format & Omnivore's JSONs. Titles, tags and addition date will be preserved during the import. An automatically created list will contain all the imported bookmarks.
@@ -40,7 +45,7 @@ All the URLs in the bookmarks file will be added automatically, you will not be
Importing bookmarks using the CLI requires some technical knowledge and might not be very straightforward for non-technical users. Don't hesitate to ask questions in github discussions or discord though.
:::
-If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](https://docs.karakeep.app/command-line):
+If you can get your bookmarks in a text file with one link per line, you can use the following command to import them using the [karakeep cli](../05-integrations/02-command-line.md):
```
while IFS= read -r url; do
diff --git a/docs/versioned_docs/version-v0.31.0/04-using-karakeep/lists.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/lists.md
new file mode 100644
index 00000000..9882ec59
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/lists.md
@@ -0,0 +1,18 @@
+---
+sidebar_position: 2
+---
+
+# Lists
+
+Lists are the core organizational layer in Karakeep. Every saved item can sit in multiple lists so you can group links by project, topic, or audience without duplicating them.
+
+## Manual lists
+
+- Curated sets you add bookmarks to by hand. Great for projects, reading queues, or hand-picked collections.
+- Can be **private** (visible only to you) or **public** (share a read-only link).
+- Can be **collaborative**: invite people by email as viewers or editors. Editors can add their own bookmarks; viewers can browse. Your personal states (favourite/archive) stay yours even inside a shared list.
+
+## Smart lists
+
+- Auto-updating lists powered by a saved search query (e.g. `#ai -archived`).
+- Best for dynamic views like `Youtube links added last week` or `All reddit links from r/selfhosted`.
diff --git a/docs/versioned_docs/version-v0.27.0/05-quick-sharing.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/quick-sharing.md
similarity index 92%
rename from docs/versioned_docs/version-v0.27.0/05-quick-sharing.md
rename to docs/versioned_docs/version-v0.31.0/04-using-karakeep/quick-sharing.md
index 254bec84..e1f031a5 100644
--- a/docs/versioned_docs/version-v0.27.0/05-quick-sharing.md
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/quick-sharing.md
@@ -1,4 +1,9 @@
-# Quick Sharing Extensions
+---
+sidebar_position: 7
+slug: quick-sharing
+---
+
+# Quick capture and sharing
The whole point of Karakeep is making it easy to hoard the content. That's why there are a couple of
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/02-search-query-language.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/search-query-language.md
similarity index 79%
rename from docs/versioned_docs/version-v0.27.0/14-guides/02-search-query-language.md
rename to docs/versioned_docs/version-v0.31.0/04-using-karakeep/search-query-language.md
index 55e32b98..cdf1f56e 100644
--- a/docs/versioned_docs/version-v0.27.0/14-guides/02-search-query-language.md
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/search-query-language.md
@@ -1,3 +1,8 @@
+---
+sidebar_position: 9
+slug: search-query-language
+---
+
# Search Query Language
Karakeep provides a search query language to filter and find bookmarks. Here are all the supported qualifiers and how to use them:
@@ -6,7 +11,7 @@ Karakeep provides a search query language to filter and find bookmarks. Here are
- Use spaces to separate multiple conditions (implicit AND)
- Use `and`/`or` keywords for explicit boolean logic
-- Prefix qualifiers with `-` to negate them
+- Prefix qualifiers with `-` or `!` to negate them (e.g., `-is:archived` or `!is:archived`)
- Use parentheses `()` for grouping conditions (note that groups can't be negated)
## Qualifiers
@@ -20,14 +25,18 @@ Here's a comprehensive table of all supported qualifiers:
| `is:tagged` | Bookmarks that has one or more tags | `is:tagged` |
| `is:inlist` | Bookmarks that are in one or more lists | `is:inlist` |
| `is:link`, `is:text`, `is:media` | Bookmarks that are of type link, text or media | `is:link` |
+| `is:broken` | Bookmarks with broken/failed links (crawl failures or non-2xx status codes) | `is:broken` |
| `url:<value>` | Match bookmarks with URL substring | `url:example.com` |
-| `#<tag>` | Match bookmarks with specific tag | `#important` |
-| | Supports quoted strings for tags with spaces | `#"work in progress"` |
+| `title:<value>` | Match bookmarks with title substring | `title:example` |
+| | Supports quoted strings for titles with spaces | `title:"my title"` |
+| `#<tag>` or `tag:<tag>` | Match bookmarks with specific tag | `#important` or `tag:important` |
+| | Supports quoted strings for tags with spaces | `#"work in progress"` or `tag:"work in progress"` |
| `list:<name>` | Match bookmarks in specific list | `list:reading` |
| | Supports quoted strings for list names with spaces | `list:"to review"` |
| `after:<date>` | Bookmarks created on or after date (YYYY-MM-DD) | `after:2023-01-01` |
| `before:<date>` | Bookmarks created on or before date (YYYY-MM-DD) | `before:2023-12-31` |
| `feed:<name>` | Bookmarks imported from a particular rss feed | `feed:Hackernews` |
+| `source:<value>` | Match bookmarks from a specific source. Valid values: `api`, `web`, `cli`, `mobile`, `extension`, `singlefile`, `rss`, `import` | `source:rss` `-source:web` |
| `age:<time-range>` | Match bookmarks based on how long ago they were created. Use `<` or `>` to indicate the maximum / minimum age of the bookmarks. Supported units: `d` (days), `w` (weeks), `m` (months), `y` (years). | `age:<1d` `age:>2w` `age:<6m` `age:>3y` |
### Examples
@@ -41,6 +50,8 @@ is:archived and (list:reading or #work)
# Find bookmarks that are not tagged or not in any list
-is:tagged or -is:inlist
+# Find bookmarks with "React" in the title
+title:React
```
## Combining Conditions
@@ -56,6 +67,12 @@ is:archived and (list:reading or #work)
# Find bookmarks that are not favorited and not archived
-is:fav -is:archived
+
+# Using ! as an alias for negation
+!is:fav !is:archived
+
+# Using tag: as an alias for #
+tag:important tag:"work in progress"
```
## Text Search
diff --git a/docs/versioned_docs/version-v0.31.0/04-using-karakeep/tags.md b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/tags.md
new file mode 100644
index 00000000..0ac93bfd
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/04-using-karakeep/tags.md
@@ -0,0 +1,11 @@
+---
+sidebar_position: 3
+---
+
+# Tags
+
+Tags are lightweight labels you can attach to any bookmark to add meaning without rigid folders.
+
+- Use tags to capture topics, sources, people, or workflow states (e.g. `ai`, `design`, `to-read`).
+- Combine multiple tags to filter or build smart lists; tags travel with a bookmark wherever it appears.
+- AI tags might look a little messy, but the extra labels make finding things easier. Use tags for broad discovery and lists when you want a clean, hand-picked setup.
diff --git a/docs/versioned_docs/version-v0.27.0/09-command-line.md b/docs/versioned_docs/version-v0.31.0/05-integrations/02-command-line.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/09-command-line.md
rename to docs/versioned_docs/version-v0.31.0/05-integrations/02-command-line.md
diff --git a/docs/versioned_docs/version-v0.27.0/09-mcp.md b/docs/versioned_docs/version-v0.31.0/05-integrations/03-mcp.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/09-mcp.md
rename to docs/versioned_docs/version-v0.31.0/05-integrations/03-mcp.md
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/03-singlefile.md b/docs/versioned_docs/version-v0.31.0/05-integrations/05-singlefile.md
similarity index 97%
rename from docs/versioned_docs/version-v0.27.0/14-guides/03-singlefile.md
rename to docs/versioned_docs/version-v0.31.0/05-integrations/05-singlefile.md
index c0f4e174..5f8d60ed 100644
--- a/docs/versioned_docs/version-v0.27.0/14-guides/03-singlefile.md
+++ b/docs/versioned_docs/version-v0.31.0/05-integrations/05-singlefile.md
@@ -11,7 +11,7 @@ Karakeep supports being a destination for the [SingleFile extension](https://git
5. In the `authorization token` field, paste an API key that you can get from your karakeep settings.
6. Set `data field name` to `file`.
7. Set `URL field name` to `url`.
-8. (Optional) Add `&ifexists=MODE` to the URL where MODE is one of `skip`, `overwrite`, `overwrite-recrawl`, `append`, or `append-recrawl`. See "Handling Existing Bookmarks" section below for details.
+8. (Optional) Add `?ifexists=MODE` to the URL where MODE is one of `skip`, `overwrite`, `overwrite-recrawl`, `append`, or `append-recrawl`. See "Handling Existing Bookmarks" section below for details.
Now, go to any page and click the singlefile extension icon. Once it's done with the upload, the bookmark should show up in your karakeep instance. Note that the singlefile extension doesn't show any progress on the upload. Given that archives are typically large, it might take 30+ seconds until the upload is done and starts showing up in Karakeep.
diff --git a/docs/versioned_docs/version-v0.31.0/05-integrations/06-rss-feeds.md b/docs/versioned_docs/version-v0.31.0/05-integrations/06-rss-feeds.md
new file mode 100644
index 00000000..e633813c
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/05-integrations/06-rss-feeds.md
@@ -0,0 +1,50 @@
+# RSS Feeds
+
+Karakeep offers RSS feed integration, allowing you to both consume RSS feeds from external sources and publish your lists as RSS feeds for others to subscribe to.
+
+## Publishing RSS Feeds
+
+You can publish any of your lists as an RSS feed, making it easy to share your bookmarks with others or integrate them into RSS readers.
+
+### Enabling RSS for a List
+
+1. Navigate to one of your lists
+2. Click on the list settings (three dots menu)
+3. Toggle the "RSS Feed" switch to enable it
+4. Copy the generated RSS feed URL
+
+### What Gets Published
+
+RSS feeds include:
+- **Links**: Bookmarks of type "link" with their URL, title, description, and author
+- **Assets**: Uploaded files (PDFs, images) are included with a link to view them
+- **Tags**: Bookmark tags are exported as RSS categories
+- **Dates**: The bookmark creation date is used as the publication date
+
+Note: Text notes are not included in RSS feeds as they don't have an associated URL.
+
+### Security Considerations
+
+- Each RSS feed requires a unique token for access
+- Tokens can be regenerated at any time, which will invalidate the old URL
+- Disabling RSS for a list immediately revokes access
+
+## Consuming RSS Feeds
+
+Karakeep can automatically monitor RSS feeds and create bookmarks from new entries, making it perfect for staying up to date with blogs, news sites, and other content sources.
+
+### Adding an RSS Feed
+
+1. Go to **Settings** → **RSS Feeds**
+2. Click **Add Feed**
+3. Enter the feed details:
+ - **Name**: A friendly name for the feed
+ - **URL**: The RSS/Atom feed URL
+ - **Enabled**: Toggle to enable/disable the feed
+ - **Import Tags**: Enable to import RSS categories as bookmark tags
+
+### How It Works
+
+- Karakeep checks enabled RSS feeds **every hour**
+- New entries are automatically created as bookmarks
+- Duplicate entries are automatically detected and skipped
diff --git a/docs/versioned_docs/version-v0.31.0/05-integrations/_category_.json b/docs/versioned_docs/version-v0.31.0/05-integrations/_category_.json
new file mode 100644
index 00000000..c2495ffd
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/05-integrations/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Integrations",
+ "position": 5
+}
diff --git a/docs/versioned_docs/version-v0.27.0/08-security-considerations.md b/docs/versioned_docs/version-v0.31.0/06-administration/01-security-considerations.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/08-security-considerations.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/01-security-considerations.md
diff --git a/docs/versioned_docs/version-v0.27.0/11-FAQ.md b/docs/versioned_docs/version-v0.31.0/06-administration/02-FAQ.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/11-FAQ.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/02-FAQ.md
diff --git a/docs/versioned_docs/version-v0.27.0/06-openai.md b/docs/versioned_docs/version-v0.31.0/06-administration/03-openai.md
similarity index 98%
rename from docs/versioned_docs/version-v0.27.0/06-openai.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/03-openai.md
index 32218da8..9247d065 100644
--- a/docs/versioned_docs/version-v0.27.0/06-openai.md
+++ b/docs/versioned_docs/version-v0.31.0/06-administration/03-openai.md
@@ -1,4 +1,4 @@
-# OpenAI Costs
+# Tagging Costs
This service uses OpenAI for automatic tagging. This means that you'll incur some costs if automatic tagging is enabled. There are two type of inferences that we do:
diff --git a/docs/versioned_docs/version-v0.27.0/12-troubleshooting.md b/docs/versioned_docs/version-v0.31.0/06-administration/05-troubleshooting.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/12-troubleshooting.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/05-troubleshooting.md
diff --git a/docs/versioned_docs/version-v0.31.0/06-administration/06-server-migration.md b/docs/versioned_docs/version-v0.31.0/06-administration/06-server-migration.md
new file mode 100644
index 00000000..147ae1ec
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/06-administration/06-server-migration.md
@@ -0,0 +1,71 @@
+# Migrating Between Servers
+
+This guide explains how to migrate all of your data from one Karakeep server to another using the official CLI.
+
+## What the command does
+
+The migration copies user-owned data from a source server to a destination server in this order:
+
+- User settings
+- Lists (preserving hierarchy and settings)
+- RSS feeds
+- AI prompts (custom prompts and their enabled state)
+- Webhooks (URL and events)
+- Tags (ensures tags by name exist)
+- Rule engine rules (IDs remapped to destination equivalents)
+- Bookmarks (links, text, and assets)
+ - After creation, attaches the correct tags and adds to the correct lists
+
+Notes:
+- Webhook tokens cannot be read via the API, so tokens are not migrated. Re‑add them on the destination if needed.
+- Asset bookmarks are migrated by downloading the original asset and re‑uploading it to the destination. Only images and PDFs are supported for asset bookmarks.
+- Link bookmarks on the destination may be de‑duplicated if the same URL already exists.
+
+## Prerequisites
+
+- Install the CLI:
+ - NPM: `npm install -g @karakeep/cli`
+ - Docker: `docker run --rm ghcr.io/karakeep-app/karakeep-cli:release --help`
+- Collect API keys and base URLs for both servers:
+ - Source: `--server-addr`, `--api-key`
+ - Destination: `--dest-server`, `--dest-api-key`
+
+## Quick start
+
+```
+karakeep --server-addr https://src.example.com --api-key <SOURCE_API_KEY> migrate \
+ --dest-server https://dest.example.com \
+ --dest-api-key <DEST_API_KEY>
+```
+
+The command is long‑running and shows live progress for each phase. You will be prompted for confirmation; pass `--yes` to skip the prompt.
+
+### Options
+
+- `--server-addr <url>`: Source server base URL
+- `--api-key <key>`: API key for the source server
+- `--dest-server <url>`: Destination server base URL
+- `--dest-api-key <key>`: API key for the destination server
+- `--batch-size <n>`: Page size for bookmark migration (default 50, max 100)
+- `-y`, `--yes`: Skip the confirmation prompt
+
+## What to expect
+
+- Lists are recreated parent‑first and retain their hierarchy.
+- Feeds, prompts, webhooks, and tags are recreated by value.
+- Rules are recreated after IDs (tags, lists, feeds) are remapped to their corresponding destination IDs.
+- After each bookmark is created, the command attaches the correct tags and adds it to the correct lists.
+
+## Caveats and tips
+
+- Webhook auth tokens must be re‑entered on the destination after migration.
+- If your destination already contains data, duplicate links may be de‑duplicated; tags and list membership are still applied to the existing bookmark.
+
+## Troubleshooting
+
+- If the command exits early, you can re‑run it, but note:
+ - Tags and lists that already exist are reused.
+ - Link de‑duplication avoids duplicate link bookmarks. Notes and assets will get re-created.
+ - Rules, webhooks, rss feeds will get re-created and you'll have to manually clean them up afterwards.
+ - The progress log indicates how far it got.
+- Use a smaller `--batch-size` if your source or destination is under heavy load.
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/01-legacy-container-upgrade.md b/docs/versioned_docs/version-v0.31.0/06-administration/07-legacy-container-upgrade.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/14-guides/01-legacy-container-upgrade.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/07-legacy-container-upgrade.md
diff --git a/docs/versioned_docs/version-v0.27.0/14-guides/04-hoarder-to-karakeep-migration.md b/docs/versioned_docs/version-v0.31.0/06-administration/08-hoarder-to-karakeep-migration.md
similarity index 84%
rename from docs/versioned_docs/version-v0.27.0/14-guides/04-hoarder-to-karakeep-migration.md
rename to docs/versioned_docs/version-v0.31.0/06-administration/08-hoarder-to-karakeep-migration.md
index 289a091c..689c730d 100644
--- a/docs/versioned_docs/version-v0.27.0/14-guides/04-hoarder-to-karakeep-migration.md
+++ b/docs/versioned_docs/version-v0.31.0/06-administration/08-hoarder-to-karakeep-migration.md
@@ -19,7 +19,7 @@ You can also change the `HOARDER_VERSION` environment variable but if you do so
## Migrating a Baremetal Installation
-If you previously used the [Debian/Ubuntu install script](https://docs.karakeep.app/Installation/debuntu) to install Hoarder, there is an option to migrate your installation to Karakeep.
+If you previously used the [Debian/Ubuntu install script](../02-installation/06-debuntu.md) to install Hoarder, there is an option to migrate your installation to Karakeep.
```bash
bash karakeep-linux.sh migrate
diff --git a/docs/versioned_docs/version-v0.31.0/06-administration/_category_.json b/docs/versioned_docs/version-v0.31.0/06-administration/_category_.json
new file mode 100644
index 00000000..8998ac56
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/06-administration/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Administration",
+ "position": 6
+}
diff --git a/docs/versioned_docs/version-v0.27.0/13-community-projects.md b/docs/versioned_docs/version-v0.31.0/07-community/01-community-projects.md
similarity index 84%
rename from docs/versioned_docs/version-v0.27.0/13-community-projects.md
rename to docs/versioned_docs/version-v0.31.0/07-community/01-community-projects.md
index f7a8df42..828d545f 100644
--- a/docs/versioned_docs/version-v0.27.0/13-community-projects.md
+++ b/docs/versioned_docs/version-v0.31.0/07-community/01-community-projects.md
@@ -12,7 +12,7 @@ _By [@luolei](https://github.com/foru17)._
A user-friendly Raycast extension that seamlessly integrates with Karakeep, bringing powerful bookmark management to your fingertips. Quickly save, search, and organize your bookmarks, texts, and images—all through Raycast's intuitive interface.
-Get it [here](https://www.raycast.com/luolei/hoarder).
+Get it [here](https://www.raycast.com/luolei/karakeep).
### Alfred Workflow
@@ -70,3 +70,18 @@ _By [@thiswillbeyourgithub](https://github.com/thiswillbeyourgithub/)_
A python script to automatically create Karakeep bookmarks from your [FreshRSS](https://github.com/FreshRSS/FreshRSS) *favourites/saved* RSS item. Made to be called periodically. Based on the community project `Karakeep-Python-API` above, by the same author.
Get it [here](https://github.com/thiswillbeyourgithub/freshrss_to_karakeep).
+
+### karakeep-sync
+_By [@sidoshi](https://github.com/sidoshi/)_
+
+Sync links from Hacker News upvotes, Reddit Saves to Karakeep for centralized bookmark management.
+
+Get it [here](https://github.com/sidoshi/karakeep-sync)
+
+### Home Assistant Integration
+
+_By [@sli-cka](https://github.com/sli-cka)_
+
+A custom integration that brings Karakeep data into Home Assistant. It exposes your Karakeep statistics data (like lists, bookmarks, tag, etc.) as Home Assistant entities, enabling dashboards, automations, and notifications based on your Karakeep data.
+
+Get it [here](https://github.com/sli-cka/karakeep-homeassistant)
diff --git a/docs/versioned_docs/version-v0.31.0/07-community/02-community-channels.md b/docs/versioned_docs/version-v0.31.0/07-community/02-community-channels.md
new file mode 100644
index 00000000..3e08e6bc
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/07-community/02-community-channels.md
@@ -0,0 +1,13 @@
+# Community Channels
+
+Stay connected with the Karakeep team and community for updates, support, and feature discussions.
+
+## Discord
+
+- Join the official server: [discord.gg/NrgeYywsFh](https://discord.gg/NrgeYywsFh)
+- Great for getting help, sharing setups, and chatting with the team and other users.
+
+## Twitter / X
+
+- Follow [@karakeep_app](https://twitter.com/karakeep_app) for release announcements, tips, and product news.
+- DM or tag us with feedback or things you'd like to see next.
diff --git a/docs/versioned_docs/version-v0.31.0/07-community/_category_.json b/docs/versioned_docs/version-v0.31.0/07-community/_category_.json
new file mode 100644
index 00000000..6fe06d4a
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/07-community/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Community",
+ "position": 7
+}
diff --git a/docs/versioned_docs/version-v0.27.0/07-development/01-setup.md b/docs/versioned_docs/version-v0.31.0/08-development/01-setup.md
similarity index 97%
rename from docs/versioned_docs/version-v0.27.0/07-development/01-setup.md
rename to docs/versioned_docs/version-v0.31.0/08-development/01-setup.md
index 6072a377..1c98a675 100644
--- a/docs/versioned_docs/version-v0.27.0/07-development/01-setup.md
+++ b/docs/versioned_docs/version-v0.31.0/08-development/01-setup.md
@@ -28,16 +28,16 @@ Press Ctrl+C to stop all services and clean up Docker containers.
## Manual Setup
-Karakeep uses `node` version 22. To install it, you can use `nvm` [^1]
+Karakeep uses `node` version 24. To install it, you can use `nvm` [^1]
```
-$ nvm install 22
+$ nvm install 24
```
Verify node version using this command:
```
$ node --version
-v22.14.0
+v24.14.0
```
Karakeep also makes use of `corepack`[^2]. If you have `node` installed, then `corepack` should already be
@@ -45,7 +45,7 @@ installed on your machine, and you don't need to do anything. To verify the `cor
```
$ command -v corepack
-/home/<user>/.nvm/versions/node/v22.14.0/bin/corepack
+/home/<user>/.nvm/versions/node/v24.14.0/bin/corepack
```
To enable `corepack` run the following command:
diff --git a/docs/versioned_docs/version-v0.27.0/07-development/02-directories.md b/docs/versioned_docs/version-v0.31.0/08-development/02-directories.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/07-development/02-directories.md
rename to docs/versioned_docs/version-v0.31.0/08-development/02-directories.md
diff --git a/docs/versioned_docs/version-v0.27.0/07-development/03-database.md b/docs/versioned_docs/version-v0.31.0/08-development/03-database.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/07-development/03-database.md
rename to docs/versioned_docs/version-v0.31.0/08-development/03-database.md
diff --git a/docs/versioned_docs/version-v0.27.0/07-development/04-architecture.md b/docs/versioned_docs/version-v0.31.0/08-development/04-architecture.md
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/07-development/04-architecture.md
rename to docs/versioned_docs/version-v0.31.0/08-development/04-architecture.md
diff --git a/docs/versioned_docs/version-v0.31.0/08-development/_category_.json b/docs/versioned_docs/version-v0.31.0/08-development/_category_.json
new file mode 100644
index 00000000..3f59497c
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/08-development/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Development",
+ "position": 8
+}
diff --git a/docs/versioned_docs/version-v0.31.0/api/_category_.json b/docs/versioned_docs/version-v0.31.0/api/_category_.json
new file mode 100644
index 00000000..695d9dbe
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/_category_.json
@@ -0,0 +1 @@
+{ "label": "API", "position": 9 }
diff --git a/docs/versioned_docs/version-v0.27.0/api/add-a-bookmark-to-a-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/add-a-bookmark-to-a-list.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/add-a-bookmark-to-a-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/add-a-bookmark-to-a-list.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/attach-asset.api.mdx b/docs/versioned_docs/version-v0.31.0/api/attach-asset.api.mdx
new file mode 100644
index 00000000..b1dc7233
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/attach-asset.api.mdx
@@ -0,0 +1,71 @@
+---
+id: attach-asset
+title: "Attach asset"
+description: "Attach a new asset to a bookmark"
+sidebar_label: "Attach asset"
+hide_title: true
+hide_table_of_contents: true
+api: eJztVU2P2zYQ/SvCnBqAXe0GKRro5hQtsgnQLrIOejB8GIsji2uKVEjKHxX434Oh5JUdO8EeesxFkEaP5Lw3b4Y9SPKlU21Q1kABsxCwrDPMDO0y9J5CFmyG2craTYNuAwICrj0UC3g3hjwsBXgqO6fCAYpFDytCR27WhRqKxTIuBbTosKFAzieAL2tqEIoewqElKMAHp8waBNAem1ZzSJGSen9YN7unt7/b/X+/1fsQbPmWM1AhQY4Z3EuIAhx96ZQjCUVwHQkw2DBoNYEEKObYYqiBs+IV5MM7Kw+cy7kS85pOBEiygIDSmkAmMBzbVqsSGZ4/eV5zhZhdPVEZQEDrbEsuKPL8V8lL8lFAOm+eolekMV3DumtlNu9Do/8YUxHgS0dkfG3TQbKCcafH0/gKjSF33+CaQEDVaf2Aa5q5slZbjmyVJMu4Ua8Z75ASp9LhTpOcsJ0n97nVFiWxqrjFgI7jZmPszsAyntVjwXxP2S1jHBC+tcYPkry+vftOEZL2JIdq/KzBi2sgoFKa/k5tcEnFdFrjivuI2+VlBXtz++ayRscuzIwNWWU7I/+/GpVWXkk+CmjIe1bx8t83RNIOEz4RSetDbSUPA+vTsTwTCsiPyvu8nwZHzJMSnstMbnucYp3TUECPUjryPubYqnx7x2VEp1jaRGH8PehWYacDFFCH0Poiz4M73GzQ4YaovcG2BXGtAYYdMltloabs44jPhlwgxngygB9Z2eHk0zH8LBOfnOzKMB6PCcSeSy9/WdcgZ/jh33nSkiv2aZqTfx7n89A/k51O2uaiOyIP3sryIhZvYHZ3c3tzezLMn2nNHu6vyjB7uM8q6841YM2iSFVsMFlrHPvHi2zsoLPt+smeL7rwBlaB9iFvNSrDJ6bi96NvFs8dyx4pzq6c0TpLATVbrVhA36/Q02enY+Twl44c35vLyTjJXlJ5fpdQVKg9/YDDL59Gw7/KvpfuGERzSP7UHX+BgA0dzu/IyHOjJpTkUhYDYKzkr6nA0wYXrR3FccWsLKkNP8QuT9rw4Z/HeRp8w1XcpL4HhzsQ6ZmStYl78naK9aDRrLs0B2DYky2L547/xuGJ1VU5+n5AzO2GTIzP6gT+ZmFi/ApH4yvL
+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={"Attach asset"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"post"}
+ path={"/bookmarks/{bookmarkId}/assets"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Attach a new asset to a bookmark
+
+<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"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={{"description":"The asset to attach","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","pdf","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","avatar","unknown"]}},"required":["id","assetType"]}}}}}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"201":{"description":"The attached asset","content":{"application/json":{"schema":{"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"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/attach-tags-to-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/attach-tags-to-a-bookmark.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/attach-tags-to-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/attach-tags-to-a-bookmark.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/create-a-new-bookmark.api.mdx
new file mode 100644
index 00000000..550c1e88
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/create-a-new-bookmark.api.mdx
@@ -0,0 +1,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>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/create-a-new-highlight.api.mdx b/docs/versioned_docs/version-v0.31.0/api/create-a-new-highlight.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/create-a-new-highlight.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/create-a-new-highlight.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/create-a-new-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/create-a-new-list.api.mdx
similarity index 56%
rename from docs/versioned_docs/version-v0.27.0/api/create-a-new-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/create-a-new-list.api.mdx
index 35e45c79..aea2e62b 100644
--- a/docs/versioned_docs/version-v0.27.0/api/create-a-new-list.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/create-a-new-list.api.mdx
@@ -5,7 +5,7 @@ description: "Create a new list"
sidebar_label: "Create a new list"
hide_title: true
hide_table_of_contents: true
-api: eJy1VU1v2zAM/SsGz1qSDtvFt7TYgG4FVqwZdghyYGw2UStLqiS3DQz994GyEzup12JAdwliiZ/vPVINlOQLJ22QRkMOF44wUIaZpqdMSR9AQMCNh3wJV9IHDysBnoraybCDfNnAmtCRm9dhC/lyFVcCHD3U5MO5KXeQNycJFltKcbNgsiIlAwGF0YF0YGu0VskC2Xp659mlAV9sqUL+F3aWIAezvqOCS7POWHJBkudbjRUNrHxwUm9AQCX1FekNV3gmoMLnw9dsFsVxga96z468PydvWYy5RdEdvIxHuq4Yzgp1jQoE+ApdYFxLusVaBcj3d1HAQ01u91ZTUYBFRzpclmOmulYK14ogD66mGFuKpKOS60iodX2sYmyvvTXat6h+nJ2N09jSV+5l8k4kypEWovgLt2+zd9L7K3z9A4L/ndwX+Wy9VrIYmK6NUYQaTtmUJYgjSgeNHcKsBAQZOHwaamhZ/zSbvST6HMusG+j347gw5TiZFXmPm7G7kzZThN4+6Tb5h60pIQdrUr0WeT5gqtLq4s3lHsn5tLhqpyCHBsvSkfdxilZOH89AwCM6yeCnUrvrFpg9g9sQrM+n0+B2k3t0eE9kJ2gtiJEx6SJk5jYLW8q+d/ZZWwtjP1ipN4xgm3m4WA9wcGbuI5mxDJIRiO7PV+Mq5Aq//V4kzJiZn/0+/vKMlVXUL8tecseFH47bcem/uzoO+u4k3Bv0YzTgVepbw0kZ/DbB2WQ2mUGvwwMs8+vLURjn15fZrXHHGDLmPB3Ghwr1oK2xd+xkUxy0PP7otX0Geg5Tq1BqzpMk03SqWoLaP4hbVlu+hKZZo6dfTsXIxx02y1WvqfRGCtgSluSSDO+J4btoi/mw4LRsrmpO/2LIoth7zIuCbHjVdjUYiOsfNwuWSfcoV2kCweETiPSbAwgwCZykvnTWgEK9qdNEQhuTRYXHmjzRYOqqu0K9G1TYNK3FwtyTjhFE10rgb4g8xH8AqpnrCg==
+api: eJy1VsFu2zAM/RWDZ61Jh+3iW1dsQLcCK7YMOwQ5MDYba5UlVZLbBob+faDkJE7qtRiwXQJLIsXHx0cqPdTkKydtkEZDCZeOMFCBhabHQkkfQEDAjYdyCdfSBw8rAZ6qzsmwhXLZw5rQkbvoQgPlchVXAhzdd+TDB1NvoexPAiwaSvcWwRRVCgYCKqMD6cDWaK2SFbL17Jdnlx581VCL/BW2lqAEs/5FFUOzzlhyQZLnU40tjax8cFJvQEAr9TXpDSM8F9Di0341n0dxDPBF7/mR9/vkLasptyiGjef3ke5aprNF3aECAb5FF5jXmm6xUwHK3VkUcN+R276WVBRg0ZEOV/WUqe6UwrUiKIPrKMZcIumoZhyJtSGPVYz52FujfWb17fx8uoy5fPVOJv+oiHIihSj+UNvXq3eS+wv1+gsG/3txn8Wz3VrJamS6NkYRar6lQX9p2N44DMb5aavOk/tm1IuozaMmx+taBsMfD5Ie084Qf3UqHlmDOFLQiMe91wTEEZ6VgCADA0sTBrIE383nz1X3AetimC7/TnCVqaeV1ZL3uJk6OyEh3XCwT02U/ENjaijBmoTXIjcrzFSaozxG3QNxuZY9dE5BCT3WtSPv4wytnD2ccwXQSVZCgjocZ2J2cmpCsL6czYLbnt2hwzsie4bWgpjo2eGGwtwWoaHiy2BfZCzM/Wi+f2cGc+TxlN/TwZE5j2TGaktGIIaPT8a1yAg//1wkzrgy3w6Pw8cnbG0WZO7ugyCPge+3c+8e1gOOfbMN/XQwOPT0qK5S3xoOyuTnAOdn87M5HHS4p+Xi5mqSxoubq+LWuGMOmXNuVeNDi3qU1tSjejK29lqefoFznoGewswqlLmhWTL9oKolqN3r3LDayiX0/Ro9/XAqRt4euFmuDppKD7aAhrAml2R4R0zfZQbzZsFh2Vx1HP5Zk0Wx87ioKrLhRdvVqCFuvn5fsEyGfwht6kBw+Agi/ZYAAkwiJ6kv7fWgUG+61JGQ72RR4bEmTzSYshqOUG9HCPs+WyzMHekYQQypBF5D5Cb+DVD4G/I=
sidebar_class_name: "post api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -62,7 +62,7 @@ Create a new list
<StatusCodes
id={undefined}
label={undefined}
- responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+ responses={{"201":{"description":"The created list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/create-a-new-tag.api.mdx b/docs/versioned_docs/version-v0.31.0/api/create-a-new-tag.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/create-a-new-tag.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/create-a-new-tag.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/delete-a-backup.api.mdx b/docs/versioned_docs/version-v0.31.0/api/delete-a-backup.api.mdx
new file mode 100644
index 00000000..9d2f3be3
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/delete-a-backup.api.mdx
@@ -0,0 +1,71 @@
+---
+id: delete-a-backup
+title: "Delete a backup"
+description: "Delete backup by its id"
+sidebar_label: "Delete a backup"
+hide_title: true
+hide_table_of_contents: true
+api: eJx9U8Fu2zAM/RWBpw3Q4nbosMG3DO2AbsNQbBl2CHJgbCZWY1uqRLfJDP37QNlNkzarL5bEJ/Hx8bGHkkLhjWNjW8jhkmpiUkssNp1Ty50yHJQpQQPjOkA+h88pFGChIVDRecM7yOc9LAk9+WnHFeTzRVxocOixISYfEiAUFTUIeQ+8cwQ5BPamXYMG2mLjajkyZMp6u1s3D7efPtrt3w/VltkWnyS/4QQZ8l+XEDV4uuuMpxJy9h1paLERyPIRosFIUQ65AmHkKTjbBgrC4v3ZhfyO6/9hVWFbppbVO8XVXokHDKpM2qTEF6fuDsxUa1mtbNdK+vEtwaJztSlQsNltkAsnJLHLWyoYNDhvHXk2A9XClvRSuKihoRBwfSp2pM58eOEJv4jyyZ4rW0IOQ22SWLTKIRvqDln/KGYEabi/f2xn52vIocey9BRCzNCZ7P4cNNyjN7isB+ZjeBBrhV3NkEPF7EKeZex3kw163BC5CToH+pmis4rU+IKyq9SPbyNeDVwgxnjgxF8i6JD50I97dSSz1JFg4pQEAj0uvljfoDD8+meWJDTtysp1qXqgdD45m5wd2HHPZ3pzfZL/9OZaraw/Ji/FRg3OBm4wWWG07jh/OPru+Yv9k6NeG9WhWKYtZ65G00qu1K9+7O98nJEAGvL9uCw0VDawhPt+iYF++zpGOb7ryMuYL57am0xQmiDrEvIV1oFeYfvm5+jGt+p/DMdDbHfJRXUnO9Cwod3hUMdF1FARluQThyE8LQpyfHDxxbyJT/Z+v7z6fjW7Ag14bJBnhkgJTvLq+wExsxtqY9zTZNkLxxj/AVwN0vk=
+sidebar_class_name: "delete 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={"Delete a backup"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"delete"}
+ path={"/backups/{backupId}"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Delete backup by its id
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BackupId"},"required":true,"name":"backupId","in":"path"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"204":{"description":"No content - the backup was deleted"},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/delete-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/delete-a-bookmark.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/delete-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/delete-a-bookmark.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/delete-a-highlight.api.mdx b/docs/versioned_docs/version-v0.31.0/api/delete-a-highlight.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/delete-a-highlight.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/delete-a-highlight.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/delete-a-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/delete-a-list.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/delete-a-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/delete-a-list.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/delete-a-tag.api.mdx b/docs/versioned_docs/version-v0.31.0/api/delete-a-tag.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/delete-a-tag.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/delete-a-tag.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/detach-asset.api.mdx b/docs/versioned_docs/version-v0.31.0/api/detach-asset.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/detach-asset.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/detach-asset.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/detach-tags-from-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/detach-tags-from-a-bookmark.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/detach-tags-from-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/detach-tags-from-a-bookmark.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/download-a-backup.api.mdx b/docs/versioned_docs/version-v0.31.0/api/download-a-backup.api.mdx
new file mode 100644
index 00000000..34fd0777
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/download-a-backup.api.mdx
@@ -0,0 +1,71 @@
+---
+id: download-a-backup
+title: "Download a backup"
+description: "Download backup file"
+sidebar_label: "Download a backup"
+hide_title: true
+hide_table_of_contents: true
+api: eJx9VE1v2zAM/SsGTy0gxOnQYYVvKfaBbpdiy7BD4ANjM7Ea21IlOk1q6L8PtJ3PJTvZpijyvcdHt5CTz5y2rE0NCXw2b3VpMI/mmK0aGy10SaCAcekhmcFjF/WQKvCUNU7zFpJZC3NCR27ScAHJLA2pAosOK2JyvkvwWUEVQtICby1BAp6drpeggDZY2VJCmnRebrbL6u3l4ZPZvH8sNswme5D+mruUvv9TDkGBo9dGO8ohYdeQghorSZnvUhRoYWSRCxBEjrw1tScvKD6Mx/I4Jf944BzdvGsbocsKvaZbUJCZmqlmuYTWljpDuRS/ayuhPb0QQlBwP76/Wr02HC1MU+fXi754uXBBNDN/oYxBgXXGkmPdk8lMTv9KGxRU5D0uL52d6DfrKxzy09DzqIgLk0MCS+q6ipQJxL3EPm53Woc4H3wDYgy33o29cSUk0GKeO/I+xGh1vL4DBWt0Gudlj3847iVbYFMyJFAwW5/EMbvtaIUOV0R2hNaCOtN1WlA0VIjMIuKCoh9DftRjgRDCkWN/iax952Pf7jWSzsKjSxNHdUmghpevxlUoCL//mXZC6nph5Lqw7iHdjcaj8ZFt93gmz08X8U+en6KFcafghWxQYI3nCjtDDBbfLykOa3pesz046+pG91yZNhzbEnUtrbpxtcOcZ8MqeVCQHG3VftSpgsJ4lsy2naOn364MQcKvDTn5MaSHQXd2yLWX9xySBZae/oP65ufgztvoGtghiPW281PZyBcoWNH2+DcQ0qCgIMzJdRj640mWkeWji+dLLYbZ2//blykowFObnNmiK34RU9v2GVOzojqEPUSWb8EXwl+BY+PE
+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={"Download a backup"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/backups/{backupId}/download"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Download backup file
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BackupId"},"required":true,"name":"backupId","in":"path"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Backup file (zip archive)","content":{"application/zip":{"schema":{}}}},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-a-single-asset.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-asset.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/get-a-single-asset.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-a-single-asset.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-a-single-backup.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-backup.api.mdx
new file mode 100644
index 00000000..da620ed9
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-a-single-backup.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-a-single-backup
+title: "Get a single backup"
+description: "Get backup by its id"
+sidebar_label: "Get a single backup"
+hide_title: true
+hide_table_of_contents: true
+api: eJytVMGO2zYQ/RVhTi1A2E6RooFubpEG2yBo0G6Rg+HDSBpbXEskQw43dgT+ezGU1uv1aoMccrLMGc689+ZxBmgo1F471tZACe+IiwrrQ3RFdSo0h0I3oIBxH6DcwO85FGCrIFAdveYTlJsBKkJPfh25hXKzTVsFDj32xORDTgh1Sz1COQCfHEEJgb02e1BAR+xdJ0eadNMdT/v+y92b3+zx66/tkdnWb6S/5pwy9r9pICnw9DlqTw2U7CMpMNhLSvWQokALI4fcgiDyFJw1gYKg+GW1kp+n5P+u7qjm4ovm9kGEBhkXoKC2hsmw3EHnOl2j3FneBbk4Q8/mUqDAeevIsx7b6ua5BElBDORv5kMYAvFcTIGJXYeV6CICJAW1J2Rq1jxbKeivdBEwsa/IS6Cy9tCjP/xho+HZjMDIMcxOz8RejOHINONJiHVNIYCCHeoueoJtUkDeW/+BQsA9fQeXJ+PdQPbgJNKjJJeEJ3rXZM7QtylJ0der18/HPpqqMJaLnY2m+XHjrm0zwzYp6F9S4pp5rvCYn2nk+9zaBkrYU+4qHi9hOZo2LIeHR5BEAfL3D88w+g5KGLBpPIWQluj08v4VKLhHr0X/DHsKj0rtMHYMJbTMLpTLJfvT4oAeD0Rugc6BupLztqViqlDYXcEtFe+n/GLEAimliw3yr6g5dr7cI2dppLPwyGnywnOSzDp//Gl9j4Lwr0+3WT9tdlauC+sR0qvFarG6WCNnPOuPN7P41x9vip31T8EL2aTA2cA9Zh9MK0eWJhZBm31H0+K4rjo8WurFHTuyZTry0nWoTd4MMrBhGvBmWm7yuMrzntsqaG1gCQ9DhYH+811Kcvw5kpf9vH2cb3ZBo4N8N1DusAv0Dag//TN58efiJYTTIZpTtlEX5R8oONDpchsn2QItYUM+YxjD67omxxcXn702McrZ7e/e3sr7f2qPKzvk6rOghmHMuLUHMimdMbL8F4Ap/Q8pJ2jm
+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 backup"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/backups/{backupId}"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get backup by its id
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"BackupId"},"required":true,"name":"backupId","in":"path"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Object with backup data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"assetId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"size":{"type":"number"},"bookmarkCount":{"type":"number"},"status":{"type":"string","enum":["pending","success","failure"]},"errorMessage":{"type":"string","nullable":true}},"required":["id","userId","assetId","createdAt","size","bookmarkCount","status"]}}}},"404":{"description":"Backup not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-a-single-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-bookmark.api.mdx
new file mode 100644
index 00000000..1c436efd
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-a-single-bookmark.api.mdx
@@ -0,0 +1,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: eJzNWF9v2zYQ/yrCvWwDhDgdOqzwW1psXTasDZYUewj8cBJPFmOKVEnKiWPouxdHyZKcyImcBtieoph3x9/9v+MWBLnUytJLo2EOH8lHiTGrAu0qSjaR9C6SAmLwuHQwv4b37aGDRQyO0spKv4H59RYSQkv2rPI5zK8X9SKGEi0W5Mm6QODSnAqE+Rb8piSYg/NW6iXEQHdYlIp/kiSFutssi9ubd7+au/tf8jvvTfqOEUgfSHYIzgXUMVj6WklLAubeVhSDxoKJkp4oBsmalehzqOMRGIkxilBDDIIyrJTfydo3zXkWOfKRN1E47cz0g4tSoz1pH91KpaKEIqlTVQkSkdSRzymy5EqjHZ1En4ynOPK57JlS1Myj0C4pyoyNnCmok+5O9rXMULn/D7TO3q3YDw3jzuZfK7Ib4FDYXePY7j+fnvKffR0+JzeUMk6f9xEo0CPf0gJiLixLJVNkrtmNY9YRl5ogDGIorSnJetlcLMXj6KtjSC2hJ3HmR08LI2Qmx49j0JVSmHBgsunrLkwnUKJNc7kmMRKKdQwZrg0n16Fzj8ul1MtLj75yz98XA+mq4Ax2VZqSc8BXSFVZYjORFsy1qGNwVVGglffBxK8vXhs/zTwNjs00WlPZdILYHiaWEmK4pYSjS/F3YRKpKFQjT9pxVMbgpF4qypoDG9SSRWmsD7pUjuz5eEw19bI7QGtxw8yeCvfiQG2SbeQAvcc0J/F+1FydzqxmXhWoYVHvVZVrCEU+yN+TFugG2Wc0fc5CNX9ageb0MBQl9aoxoVXj9pucRntlZAK9LHBJX8auPUR85hz5MT+PRWJqibTLjT+GqxTZMeRZpdQFA2sqyFE3WUot3ioSL2BeS0HmKKC4lulEv+S+UB/6SHuWvo3KY+DsNJ94AVO/fgHEyufGTnNWlSjpcppGLdDTRcsxzR7M8Xfb3iYwPCgZgbrJ4AUPVt9XETzdNUU1fIyVhKbIT8vccai7O74XK3LMNc7kr6tnyEMRgZDlPdOBvsGt5tNomT/Y9qbWMifvh2J1VSRkn8isF5u5N0qv6ytYvdIrbW5HeldgWNSdaV+/8U5yM/e0PwZFbNgMWu+3ki6HvyeoNdnzNkYelHZoiy7TtUNxKHgwUsmhGUi+lMqgIO7nuEaP7OLedEdF2NiM0JtiUY8S9NP03uw8mHf3htuHk+z4ANrNWu1k1Qdp5/PF4xUR6gDx7enbx/vGjibSxkeZqbR4vT0jNWJ8TivIOfbz47MHlgwSeno2dR34fW4EzGHZhADvtHOYdRvZbNsvvjWbkux6t36HSQu2KIQl5+oZlnK2fsMBhlay0wP09rixV7sNQ+596eazmbebkxVaXBGVJ1iW8HARvcopaiVEJgsL5l8tfdRgYZcMXg4u2aLNzcP3g848fHNIJCbjBSgQcTaEj9+NLZAR/vnvVbCh1Jlhdta6gfTm5PTkdPB80OE5uzgfxX92cR523T3wrCw3ZOM8j8/z7W7x5QcTjJo1odtbH8rd9oH1xAtLozH3qFmpUIYtrx2PG0dfdzWAE2A+eONYxJAb55lku03QcU+oa/65WcHZ/0I69vKBN4QhxP/wOWHUCCvajD0xrFFVTBweGHZBfKSqP/7TJt1P0aHbd41Eb4Z37lANnBAaUE4oeF673rYEZ2lK5RDuo8LC8LvE/vjbFTQz4nDt34/64f61D2u7bSiuzIp0XXcoPf/PAOv6G9QU5oo=
+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"]},"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"}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-a-single-highlight.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-highlight.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/get-a-single-highlight.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-a-single-highlight.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-a-single-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-list.api.mdx
similarity index 52%
rename from docs/versioned_docs/version-v0.27.0/api/get-a-single-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-a-single-list.api.mdx
index d00690b6..f826bf41 100644
--- a/docs/versioned_docs/version-v0.27.0/api/get-a-single-list.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/get-a-single-list.api.mdx
@@ -5,7 +5,7 @@ description: "Get list by its id"
sidebar_label: "Get a single list"
hide_title: true
hide_table_of_contents: true
-api: eJytVMFu2zAM/RWDpw0QknTosMK3Hrai24AVW4cdghwYm4nVypIq0W0yQ/8+UHbTpE2HHXayLVLke3zP7KGmWAXtWTsLJVwQF0ZHLpbbQnMsdA0KGNcRyjl81ZEjLBREqrqgeQvlvIclYaBw3nED5XyRFgo8BmyJKcScEKuGWoSyB956ghIiB23XoIA22HojR5p0bTbbdftwc/bBbX6/bzbMrjqT7ppzinS/rCEpCHTX6UA1lBw6UmCxlQQzJCjQwsQjNyBoAkXvbKQoCN7NZvI4JP1teUMVFw+am4F8jYwTUFA5y2RZbqD3RlcoN6Y3Ua4dIeZyIVDgg/MUWA9Ndf2SfHqEfSRwgO7l1GxnDC5lJkI/KdDVscSUhSArM/mXKkPCEZFs14r6LdoODSiILQYWG9S0ws4wlI+xpOCuo7D9p36+Wxpd7aUunTOEFtKBxHPIHszDGqnuEduVWRwaBVKSMqez05dyS7ywjouV62z9/2SuXH1cz5ZixPWx2DOmucJT/iINLFrixtVQwppyV3F2CVOxapz2g+2TCEPh/vGn64KBEnqs60Axpil6Pb0/AQX3GLTokCGP4WFGj2I2zD6W0ymH7eQWA94S+Ql6D8+cCdcNFWOFwq0Kbqj4MuYXAxaRYW9f/JBJDp33t8ZuLNJZeOQ0cUROAjW+fHKhRUH4+dd1np22KyfXhfUA6WQym8z2lsYOz/nV5VH851eXxcqFQ/BCVhzqIreYPTCuGFmPWERt14byqnhes38y0yu7dGDKtOGpN6itNMpi9aOw87zIIigox422UNC4yBLq+yVG+hlMSnI8/m3zxZOuWf1aR3mvoVyhifQXkG++j/57W7yGbjxEu832MZ18gYJb2j5t3bRIChrCmkJGMATPq4o871178X+JPXb+vvh4DQrw0BTPTJCrH4XU90PGtbslm9IOIcu3AEzpD17EW8M=
+api: eJytVUFv2zoM/isGTxtgJNmwhzf4Vjy8Dd0GbNg67BD4wFhMrFaWNIlukxn67wNlN01ab9hhp8jiJ/Ij+ZEZQFFsgvasnYUK3hIXRkcuNodCcyy0ghIYdxGqNXzQkSPUJURq+qD5ANV6gA1hoHDRcwvVuk51CR4DdsQUYgbEpqUOoRqAD56ggshB2x2UQHvsvJErTVqZ/WHX3V2//tftf/zT7pld81qia84QiX6pIJUQ6HuvAymoOPRUgsVOAGYElKAlE4/cgrAJFL2zkaIweLlayc950h8319Rwcae5HZNXyLiAEhpnmSzLC/Te6AblxfI6yrOZxFx2BCX44DwF1mNQrZ4mn+5pzxjO2D2tmu2NwY3URNJPJehmDphyI8hKTf7EywiYaZLtO+l+h7ZHAyXEDgOLDBRtsTcM1b0tlfC9p3D4o3i+3xjdnEA3zhlCK15ajP85wbuA7EKcR/WRwmdnfsva3VkK8q00OzncarrLN1P8Op0pag1Z8rk3U2VP6nh8NUPxhE99rlpISYK8Wr16qj2xF9ZxsXW9VX9Pc41T8+LqKEbczdke1SF7eMDXacyiI26dggp2lKPKmFWwlLmJy2GcwSQqoXB7vwH6YKCCAZUKFGNaotfL2xfSDAxaRJEpT+axRvfKapl9rJZLDofFDQa8IfIL9B4ejQlctVRMHgq3Lbil4v2EL0Yu0oaT5fVFKjlGPl1hx7JIZMkjw0R4GQTldHjjQofC8N23q1w7bbdOnkvWI6UXi9VidbLBjnwuPl3O8r/4dFlsXTgnL8nKuLjIHWYNTPtOdjUWUdudoby3HvscHsT0i8U+Zsq056U3qMepkmYNU2PXeauKuKtpvdYltC6ymIZhg5G+BpOSXE+jv64f+pq7r3SUs4JqiybSb0g++zzp73nxK3bTJdpDlo/p5QtKuKHDw19AqmWHECoKmcFovGga8nzy7Ml8iTyO+n77/xWUgOeieCSC7H2W0jCMiCt3QzalI0OWbyGY0k9EOoyc
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -62,7 +62,7 @@ Get list by its id
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+ responses={{"200":{"description":"Object with list data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-a-single-tag.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-a-single-tag.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/get-a-single-tag.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-a-single-tag.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-all-backups.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-all-backups.api.mdx
new file mode 100644
index 00000000..10776c8d
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-all-backups.api.mdx
@@ -0,0 +1,63 @@
+---
+id: get-all-backups
+title: "Get all backups"
+description: "Get all backups"
+sidebar_label: "Get all backups"
+hide_title: true
+hide_table_of_contents: true
+api: eJyNVMGO00AM/ZXI51Hb5ZhbQYAWhFiJIg6rHtzEbWabzMx6PAslmn9HTrNtWirBqenY43nP79k91BQrtkGsd1DCR5IC27bYYLVPIYIBwV2E8hHejidrA5GqxFYOUD72sCFk4mWSBsrHdV4bYIrBu0gRyh7eLBb6c/nK180TVVL8tNJMXytqFJyBgco7ISd6EUNobYV6cf4U9XYPsWqoQ/2SQyAowQ/1wEBgH4jFHt9+JXFORGY8gAEr1MV/F7D1JCcKW7eDbCBF4vvbIYyR5FbMgEtti5uWoBROlA1UTChUL+VmpWh/0yTgUrch1sDG+32HvH/nk5ObGVFQUryFgVzqVMxArj6exFRVFFXoLdo2McE6GyBmz18oRtzRf3DJKvpzsky1Vrc1nJp0bsmU8EjvmswJ+jpf13zVUiMa60gaX0MJOxp0Q/UfzM++jcQvxHHwaOIWSuixrplizHMMdv5yBwZekK3yGJo1ho923WJqBUpoREIs53Phw2yPjHuiMMMQwFx5etVQMVYo/LaQhorPY35xxAI558n0fFMXj0adzNCp2fqy8hjSoByTtGfDxwfPHSrCTz9WoB2xbuv1urI+QrqbLWYLHWErKhWc8Cwf7m/iXz7cF1vPl+CVbDYQfJQOh/lzOAD6e1dcVOzPY3xrrRxJCv2SeWjRumGwVKd+FHOiuYHGR9Gjvt9gpO/c5qzHz4lY19D6LOWwhQw0hDXxoP6eDlDCsqooyKB5m4ZdcL1ZVJyTrT6+X6l3LyW5kmCo/rpZ3GFSu++PGSu/J5czmBGE6H/IauI/FkLfgQ==
+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 all backups"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/backups"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get all backups
+
+<ParamsDetails
+ parameters={undefined}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Object with all backups data.","content":{"application/json":{"schema":{"type":"object","properties":{"backups":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"assetId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"size":{"type":"number"},"bookmarkCount":{"type":"number"},"status":{"type":"string","enum":["pending","success","failure"]},"errorMessage":{"type":"string","nullable":true}},"required":["id","userId","assetId","createdAt","size","bookmarkCount","status"]}}},"required":["backups"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-all-bookmarks.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-all-bookmarks.api.mdx
new file mode 100644
index 00000000..7beabd7f
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-all-bookmarks.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-all-bookmarks
+title: "Get all bookmarks"
+description: "Get all bookmarks"
+sidebar_label: "Get all bookmarks"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNWM1u4zYQfhVhLr0IcbZH37KLdpsW3QRIFj0EPoylkcU1RWpJyonX0LsXQ8qS7NCJnA3QnuKI8z/DjzOzg5xsZkTthFYwh8/kEpQyWWq9rtCsLaTgcGVh/gAf+2+LFCxljRFuC/OHHSwJDZmrxpUwf1i0ixRqNFiRI2M9gc1KqhDmO3DbmmAOS60loYI2BUPfG2Eoh3mB0lIKCismQZOVYkM5pCDYtO8NmS206dukFbjRbPAkedYZoVaQAqmmYtfRZpD6ULHvORXYSAfz8OUFrVYbd2NyMhOUqqZaknlJmhSVcOeY74ST/OFTY6x+UXQWKKaHehQFZxpKj+roukgsucTpxJ/29fSLTTKtHCmXPAquM0qEymSTU54IlbiSEkO21srSRfJFO0oTV4qBKUPFPBLNipJCm8TqioZqvYj6+D8xrQ92J/ZTYDwK+oIdCGosx/3Xy0v+c+jDzfIbZWynKw+va5KjQ1bVWcWsWNdSZMiss2+W+SN51V4ipFAbXZNxImgfcGAgRWNwy1Y7quzrIkT+vDTbFDJD6Ci/ctHTSueiEPHjFFQjJS65tDmFbV/oEyh7VImixwgloucOVyuhVncOXWNf1zcAiG2yjCyjaYFCNoY4TKRy5lq0KdimqtCIHz5L7y9eaTctPMGO7TRa3ZhsgtgRjNYCUnikJReo5N+VXgrJ1tKTI2W5ulOwQq0kFeHAeLdEVWvjvC+NJXMdr6nwUr1zoYZLGzlA5zArKf8YDVfvM7tZNhUqWLQH6PTAGjv5B9I83egCa0U3hX9HX3YgnJ42RQq1DiE0Mh6/ydfoAI4m0IsKV/Q1pvYU8ZW15GJ5jlViZoiULbU7h6vOi3PIi0bKWzYsIMhZmgxlBh8l5W9g3oic9FmG4kZkE/NSukp+GirtVfquKs8xZ+/5RAVM/f4AiI0rtZmWrGYphS1pGnWOjm47jmnxYI6/u+dtAsMRZHjqcIMX3KD9HCI4egqg6n/EICGA/LSbGzd1r+NnbUWuuZBM/nX/CrkHEfC3fGA68W7wU/MlCvMnn72pWGbFj7HYrsk/fbPeHOYhKIOv7xD1Rq2Vfoy8XZ5h0fahff+Hd1Ka+U37YwRi48egy34n6W78fYlKkbnuauQI2qEDXabr+l8PeBBBcggNyddaasz9cIkbdMgpHkJ3VoXFeoQhFIs2SjB00we9czqeog9G4MNONt6A9r1W11kNRdrnfDEMmfv1ALCBip5cN3We7fF49zCSM1J1iyuh2N9hJdG2PjAVuVLnMIdVSBfySgJmY5GWzGa/l/CNEOwwzw1Z286wFrPNB84/GsEW+vrsjsMYth/9S+dqO5/NnNlerNHgmqi+wLqG43nzvqSkk5Dows+Rf3X0SbCFjR+tVO54NuvGr9FipQ8ja/Z1zmQ8n3giLlb/43dtKmQL//zn3udCqEIzO3sdTPpwcXlxOdoP9PZc3V5H7b+6vfYj7YHx7Cy/l9o67m7nu/18G1siHTWMPdrFN07BUX45ZrVE4WevrmkNKR1XySKFUlvHH3e7JVrG5rblz2Gk5kTnwnI6h53AmraHO6YNyoaV+rXHCfKDGzSFYbz/mUK/3/BMoe1XNi8Tnwz8f7gHieY3ePVsNzJ4txiupV8zplAScmw5wYH7KsuoHnM9232wlB4kPv92D6E3HI/7h9dpPHeh2o5k73aB4l6vSbUt7F1w/D+0jNT/AhF9X5k=
+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 all bookmarks"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/bookmarks"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get all bookmarks
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"boolean"},"required":false,"name":"archived","in":"query"},{"schema":{"type":"boolean"},"required":false,"name":"favourited","in":"query"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 all bookmarks data.","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},"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-all-highlights.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-all-highlights.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/get-all-highlights.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-all-highlights.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-all-lists.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-all-lists.api.mdx
similarity index 55%
rename from docs/versioned_docs/version-v0.27.0/api/get-all-lists.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-all-lists.api.mdx
index 04adc330..18531d85 100644
--- a/docs/versioned_docs/version-v0.27.0/api/get-all-lists.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/get-all-lists.api.mdx
@@ -5,7 +5,7 @@ description: "Get all lists"
sidebar_label: "Get all lists"
hide_title: true
hide_table_of_contents: true
-api: eJyNVE1v2zAM/SsGz0Kc7ehbDlvRbcAKLMMOQQ6MzdRqZEmV6G6Gof8+UHY+G2A7WRYfP98TR2go1kF71s5CBQ/EBRpTGB05ggLG5wjVBr7l/62CSHUfNA9QbUbYEQYKq55bqDbbtFUQKHpnI0WoRvi4XMrnOsP33QvVXPzW3J4zFQ0yLkBB7SyTZXFD742uUdzKlyi+I8S6pQ7lxIMnqMDlaKDAB+cpsJ4yT+WfYRgCDqBAM3Xx3+66ucBEDto+Q1JgsaO7hqsOb+0KbG8M7gxBxaGnpEDX94BJgcdAlh/vpL8TZQK8B5LtO+GsQ9ujAQWxw8BCXkN77A1DdbQlBa89heG/8vl+Z3R9Ad05ZwgtpCTEv/Y6UCOJdQPzsOZWLxo7hdkqYM0SPosL0m2UicNtStnSEbeugQqeKfOFojkojzqNFN4oxKzKPhioYMSmCRRjKtHr8u0DKHjDoKWjzPFsngR6HEvL7GNVlhyGxQEDHoj8Ar2HG45h3VIxRyjcvuCWiq8zvphqkYYu3ssPUe6U+fLVnGYpmaWPDJPZZhCo+fDZhQ6lwi+/1nne2u6duEvXU0kfFsvFEs5TPdWzenq8W//q6bHYu3BdvDQrXLvIHWaRTqp/txluNH96uO9XyNQg0x8uvUFtJX7maJxpPHGtoHWR5WIcdxjpZzApyfUs0s32TGLeOApawoZC5v1AA1SwqmvynNk2fX77t3tEaDnJ6eHTGhTgNRk3w8/Rj5vEDhexx3FCrN2BbEqg5iJY/iGJeP8CO0jVRg==
+api: eJyNVMFu2zAM/RWDZyHJdvQtGLai24AVW4YdghwYm6nVyJIq0e0CQ/8+UHYSJw22nSxLj+QjH8keaopV0J61s1DCHXGBxhRGR46ggPExQrmGr/l/oyBS1QXNByjXPWwJA4Vlxw2U603aKAgUvbORIpQ9vF8s5HMZ4dv2iSouXjU350hFjYwzUFA5y2RZzNB7oysUs/lTFNseYtVQi3LigycowWVvoMAH5ymwHiIP9M8wDAEPoEAztfHf5rqeYCIHbR8hKbDY0s2Hiwyv3xXYzhjcGoKSQ0dJga5uAZMCj4Es398If8PLAHgLJNu1olmLtkMDCmKLgUW8mnbYGYby+JYUPHcUDv8Vz3dbo6sJdOucIbTipcH4wQneBWQX4m1UFyl8d+avrN2rpSD/tWYnhxdNr/lmjL9JSfrsudOBarHQNYzajJWd1PFkdYPihM9GAWsWYrnTIV3HGBpqk1J+aYkbV0MJj5SbB2UAYH4cmkjhhaQG6x66YKCEHus6UIxpjl7PX95JWhi0lDeXanwepuWoUcPsYzmfczjM9hhwT+Rn6D1cNRysGipGD4XbFdxQ8WXEFwMXSWgyvD9kjIbI0xE+iSKRJY8MEwkzCNR4+ORCi8Lw868VSD203Tkxl6wHSu9mi9kCzlU98Vk+3N/kv3y4L3YuXJKXZKXxXOQW88QMI/hmTV0N4GmLvN1nQ4JMv3nuDeqhLUWjfpTxpLWCxkWWi77fYqSfwaQk1+PErDdnEfP6U9AQ1hSy7ns6QAnLqiLPWW3T5UV0vdREllM73X1cgQK8FOOq+Nn7ca3Zw8R33w+IlduTTQnUSILlH5I07x+0owYu
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -54,7 +54,7 @@ Get all lists
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"Object with all lists data.","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}},"required":["lists"]}}}}}}
+ responses={{"200":{"description":"Object with all lists data.","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}},"required":["lists"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-all-tags.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-all-tags.api.mdx
new file mode 100644
index 00000000..50358c6f
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-all-tags.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-all-tags
+title: "Get all tags"
+description: "Get all tags"
+sidebar_label: "Get all tags"
+hide_title: true
+hide_table_of_contents: true
+api: eJydVU1v2zAM/SsGz0LS7uhbWmxFt8MKLMMOgQ+MzcRqbEmV6KyB4f8+0HK+0zTYSXFMPj6ST88tFBRyrx1rayCFJ+IEqyphXAZQ0B/pDKZyZgoC5Y3XvIF01sKc0JOfNFxCOsu6TIFDjzUx+dAHhLykGiFtgTeOIIXAXpsldAo8vTXaUwHpAqtACgzWEiHHozWM2kh9LZzeGvIb6NTHgArINLUQ7WEUNAGXcnqqaI0mJyFf0AKbiiEdXl+hEazn/ymPGhSUTY0GFBhrCLIrVZAZ85KKh83tta7A5Y0P1t8AZZp6ThJomqrCeUWQsm/oCnSla306kEzCg7MmUBDwL3d3chzr6ef8lXJO/moud7pKCmQcgYLcGibDkoXOVTpHyRq/Bkm9wNv2YKDAeevIs46Fo0h3Ueg99gNlqsPn2bq4OOTY+KUXTf1g7apGvwrnMz0JeNhMhh1P+7DPyKC+CBkVdf6m6452NpNm1PYOHBG9SitTwJpFBnLRQUANvfNj1NMFuZ/o5oTE4B0HEFkXqdbEpS0ghSX1vaNYB4yHhEB+vbWOxleQQotF4SmEboxOj9f3oGCNXkvpOK74Ospue7lLZhfS8Zj9ZrRCjysiN0LnQJ1oc1pSMiAkdpFwScmPIT6JXGTCB673SwQZKx96324+Uln66MMgHYJADT++WV+jMPz+Z9oPWZuFlXTpOlK6H92N7mC/jh2fycvzRf6Tl+dkYf0xeWm2U+Bs4EE3wzU+cfcjuHZ/Hc++ArE9pnceuwq1EfR+Q+2ww2HpmYLSBpbntp1joN++6jr5O3qGbLbQQfa3t5gVbc6Nf41VIzV7A/sgZTDpW0KPnPaWhJ2X3hK8dcd9bLYXav9tVFASFuT7CcSkSZ6TO8w6s0BB2d2Yp69TUIDHgjsRWI++dUFz2GrbxoipXZHpOtgyZ3mGTu7nPyWsuhQ=
+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 all tags"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/tags"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get all tags
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string"},"required":false,"name":"nameContains","in":"query"},{"schema":{"type":"string","enum":["name","usage","relevance"],"default":"usage"},"required":false,"name":"sort","in":"query"},{"schema":{"type":"string","enum":["ai","human","none"]},"required":false,"name":"attachedBy","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"number","nullable":true},"required":false,"name":"limit","in":"query"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"Object with all tags data.","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"numBookmarks":{"type":"number"},"numBookmarksByAttachedType":{"type":"object","properties":{"ai":{"type":"number"},"human":{"type":"number"}}}},"required":["id","name","numBookmarks","numBookmarksByAttachedType"],"title":"Tag"}},"nextCursor":{"type":"string","nullable":true}},"required":["tags","nextCursor"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-in-the-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-in-the-list.api.mdx
new file mode 100644
index 00000000..950c7c4b
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-in-the-list.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-bookmarks-in-the-list
+title: "Get bookmarks in the list"
+description: "Get bookmarks in the list"
+sidebar_label: "Get bookmarks in the list"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNWN1v2zYQ/1cEvmwDhDgdOqzQW1psXfbRBmuKPQR+OEsnizVFquTJiWvofx+OlCXZkR25DbA9xRHv83fHu+NtRYYutbIiabRIxFukaGHMqgS7cpHUERUYKelIxIJg6URyJ/6UjpyYx8JhWltJG5HcbcUCwaK9qqkQyd28mceiAgslElrnCVxaYAki2QraVCgS4chKvRSxwAcoK8WfJMpMPWyW5f2nVz+bhy8/FQ9EJn3F2iV5EtZ+nYkmFhY/19JiJhKyNcZCQ8kEKhDEQrJDFVAhmvikel2X7Be4VMQeD3YuwxxqRSIJX/b05aBcr9AZS+9thnan83ONdjOuVNflAu0paUqWkiZI6szfAfOmts6cFJ0GiqdlL4xRCFoMUAgQ7yfLdR45pIhM5E+7xPnORanRhJqie6lUtMBI6lTVGWa7lLLoKqMdXkTvDGEcUSF7phQ08yiwS4xyYyNnSuzT8mLUx/+JaR3Yrdg3gfEA9Dk7ENQ4xv3Hy0v+s+/D+8UnTNlOKvwVjDIgYA2tMcwBVaVkCswx++SYbSScxgsSsaisqdCSDEo7qwekYC1s2FjC0j0tQmaPM7KJRWoRCLMrGj0tTSZzOX4cC10rBQvOaI5c0+X3BEqwaSHXmI1kchOLHNaGy9Wxc4LlUurlBwKq3dP6+rrh6jRF5wSrkKq2yDChzphr3sTC1WUJVn7xUXp+8drQNHiCHZtptKa26QSxg+pZSRGLe1xwgir+XZqFVOjrO6F2nNSxcFIvFebhwHq3ZFkZS96X2qG9Hs+p0H2eOVHDXR05ACJIC8xej8LV+cxuFnUJWsybvaJ0xxpb+XvSPN3gAhuN73PfH087EE6Pm6KkXgUIrRrHb/I12qtCE+hlCUv8OKb2GPGVc0hjcR7LxNQialcYOoeryvJzyPNaqRs2LFSQszRZTC3cK8y+gnktMzRnGQprmU6MS0GletNn2pP0bVaeY87O84kKmPr5CyDUVBg7LVj1QklX4DTqDAhvWo5peDDHX217m8BwUDI8dbjBc57Lvq0iED6Eoup/jJWEUOSn3dxxU3c6vtVW4JwLweRft0+Q+yIi/C3vmY70DW4170bL/NG2N7WWOfllKLad7Y/frK+GuQel9/UZUK/1Spv7kd7lGeZNB+3zN95JYeae9tugiA2bQRv9VtKH4fcFaI32us2Rg9Iu2qLLdO386wueGKnkIgwkHytlIEPu57AGAg5xD91ZGTY2I/RQzJtRgn6a3pudB/Pu3nB7OMmOD6DdrNVOVn2SdjGf92/L1y1Ugg3U+EDtY/Nsj/s3x56cgaobWErN/r7uSBuPy8vLl4/fSLwNiLShKDe1zp7vbZSabHwwLNE5TqzHZweeegk9Pce28fxUmEwkYhlyjtcTiZjx+87NtmF30cyGMDm0690OxQ93YgtZZtG5ZgaVnK1fcE6DlYy6N749DmjtthgFUeWS2Yzs5mIFFlaI1QVUlTh8Ot8WGLUSIpP7J/EfLX0UbOGADNY/HxjT9kk5WAJ1ALFmf3eZjN9cnogvoP/xq7ElsIW//3PrUZQ6N8zOXgeTXlxcXlwOVh2dPVc316P2X91c+9f5nvHsLM8AxhFP7Ml291Q/tfQ6GIa79Dq9KQuOc3ecVQqkf1+2g3mI+J1fU3F4k25f1Qd9HovCOGKy7XYBjjtS0/DnsD/gVMik44D3C5AVbg6WUWtQNdvhlzxH6Hfrpim03f7oNPFRyP7DpcxoRIJXjxY1vXfz/mKNY37U1e//bkvBD9Ex7bt+qjdDnX1cwpqTG0yBwAFlC8LhVZpiNTT1Ualj07tS8/aXWxHG5OHmY/8WDp+g+yZtt4Hi1qxQN01nIfH/bGDT/Au5qa9K
+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 bookmarks in the list"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/lists/{listId}/bookmarks"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get bookmarks in the list
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"ListId"},"required":true,"name":"listId","in":"path"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 list data.","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},"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-with-the-tag.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-with-the-tag.api.mdx
new file mode 100644
index 00000000..8467fd98
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-bookmarks-with-the-tag.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-bookmarks-with-the-tag
+title: "Get bookmarks with the tag"
+description: "Get bookmarks with the tag"
+sidebar_label: "Get bookmarks with the tag"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNWF9v2zYQ/yoCX7YBQpwOHVboLS22LhvWBquLPQR+OEtniTVFquTJiWvouxdHypLsyIncBtie4oj393fHu+PtRIYutbIiabRIxFukaGnMugS7dtGdpCKiAiOCXMSCIHciuRVz/ruIhcO0tpK2IrndiSWCRXtVUyGS20WziEUFFkoktM4TuLTAEkSyE7StUCTCkZWa5eI9lJXiTxJlpu63eXn36dWv5v7LL8U9kUlfsXJJnmQO+XUmmlhY/FxLi5lIyNYYCw0ln5M/j4VkdyqgQjTxo8p1XbJT4FIRezTYtQxXUCsSSfhyoG4FyvX6nLH03mZo9zo/12i340p1XS7RPiZNyVLSBEmd+XtY3tTWmUdFp4HiadlLYxSCFgMUAsKHqXK9ihxSRCbyp13a/OCi1GhCTdGdVCpaYiR1quoMs0hqn04WXWW0w4vonSGMIypkz5SCZh4FNsdoZWzkTIl9Ul6M+vg/Ma0DuxX7JjAegb5gB4Iax7j/fHnJfw59eL/8hCmFK6ikoygDAtbQGsMcUFVKpsAcs0+O2UbCabwgEYvKmgotyaC0s3pACtbClo0lLN3TImT2MCObWKQWgTC7otHT0mRyJcePY6FrpWDJGc2Ra7r8nkAJNi3kBrORTG5isYKN4WJ16pwgz6XOPxBQ7Z7W19cNV6cpOidYhVS1RYYJdcZciyYWri5LsPKLj9Lzi9eGpsET7NhOozW1TSeIHVTPSopY3OGSE1Tx79IspUJf3Qm146SOhZM6V7gKB9a7JcvKWPK+1A7t9XhOhdbzzIka7urIARBBWmD2ehSuzmd2s6hL0GLRHBSlW9bYyj+Q5ukGF9hofL/y3fFxB8LpaVOU1OsAoVXj+E2+RgdVaAK9LCHHj2NqTxFfOYc0FuexTEwtonaFoXO4qmx1DvmqVuqGDQsV5CxNFlMLdwqzb2DeyAzNWYbCRqYT41JQqd70mfYkfZuV55iz93yiAqZ+/gIINRXGTgtWvVTSFTiNOgPCm5ZjGh7M8Xfb3iYwHJUMTx1u8ILnsu+rCIT3oaj6H2MlIRT5aTd33NS9ju+1FTjnQjD51/wJcl9EhL/lPdOJvsGt5t1omT/Z9qbWMie/DMW2s/3pm/XNMPeg9L4+A+q1XmtzN9K7PMOi6aB9/sY7Kczc0/4YFLFhM2ij30r6MPy+BK3RXrc5clTaRVt0ma6df33BEyOVXISB5GOlDGTI/Rw2QMAh7qE7K8PGZoQeikUzStBP0wez82DePRhujyfZ8QG0m7XayapP0i7mi/5t+bqFSrCBGu+pfWye7XH/5jiQM1B1A7nU7O/rjrTxuLy8fPnwjTSHPNKGopWpdfZ8T6PUZONzYYnOcV49PDty1Evo6Tm0jeenwmQiEXlIOd5OJGLGIZjt/OKimQ0xcmg3+/WJn+zEDrLMonPNDCo527zghAYrGXJvenscoNqvMAqiyiWzGdntxRosrBGrC6gqcfxunhcYtRIis/Lv4b9a+ijYwtEYbH4+MKLte3Kw/+ngYc3+4jIZP7g8Ed8+/+N3Y0tgC//8d+4xlHplmJ29Dia9uLi8uBzsOTp7rm6uR+2/urn2T/MD49lZHgCMIx7Xk93+nf7ovutoFO6y64ktWXCdm+OsUiD987Kdy0PEb/eXLtkvq/qgL2JRGEdMtNstwXE7ahr+HJYHnAqZdBzwfvuxxu3RJmoDqmYr/IbnBP1+1zSFtlsePU58ErH/cCMzGo/g1YMtTe/dor9Y45ifdPXHf9pC8FN0Svu+mertUOfeqpAUvv8WCBxPNiCcXaUpVkNLH9Q5tryrM29/m4swIg+3HoeXcPj8PLRotwsUc7NG3TS9gfw/G9g0XwGixqv5
+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 bookmarks with the tag"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/tags/{tagId}/bookmarks"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get bookmarks with the tag
+
+<Heading
+ id={"request"}
+ as={"h2"}
+ className={"openapi-tabs__heading"}
+ children={"Request"}
+>
+</Heading>
+
+<ParamsDetails
+ parameters={[{"schema":{"type":"string","example":"ieidlxygmwj87oxz5hxttoc8","title":"TagId"},"required":true,"name":"tagId","in":"path"},{"schema":{"type":"string","enum":["asc","desc"],"default":"desc"},"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 list data.","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},"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}},"404":{"description":"Tag not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-current-user-info.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-current-user-info.api.mdx
similarity index 58%
rename from docs/versioned_docs/version-v0.27.0/api/get-current-user-info.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-current-user-info.api.mdx
index e2cbb08b..529bfc4f 100644
--- a/docs/versioned_docs/version-v0.27.0/api/get-current-user-info.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/get-current-user-info.api.mdx
@@ -5,7 +5,7 @@ description: "Returns info about the current user"
sidebar_label: "Get current user info"
hide_title: true
hide_table_of_contents: true
-api: eJyNUz1v2zAQ/SvCmwnL7ajNQxukHRq0DjoYHs7SOWIsiQx5SmsI/O/FUUJiJx2iRRJ5H+/eezeh4VgH68W6ARV+soxhiIUdjq6ggxulkJaLegyBBynGyAEGQg8R1Q73kUPE3iByPQYrZ1S7CQemwGEzSotqt097g8DRuyFyRDXh83qtr+u+Pw6PXEvxx0qbmxQNCa1gULtBeBDNIO87W5NmlI9R0ybEuuWe9EvOnlHB5UIw8MF5DmLnpra5iIkS7PCAZDBQz+8vDIax6+jQMSoJIycD7sl2H4rsXE2dEnMRfXCuYxqQknLxNNrAjfJnG1wm7JM+Bj1L6xpUeOA8CSmTKJWXWPYM5Ts8K/VK9xg6VJioaQLHmErytnz+BINnClahZQKW65n5I42doEIr4mNVlhLOqxMFOjH7FXkP80aebcvFUqFwx2yJ70t8MWNBSunCCL9Ul7nzpR1eGNHOOkcOU4ZyEMzy8dWFnhTht9/bzJr6UdN16hnSp9V6tVYvWlH28YJnc3f7X/ybu9vi6MI1eB02GXgXpafsqNkSuGG5cn3eiLd1p1d7fnRz5vGF/0rpO7KDds8KTovOO2SdoTbQ1WpdFD2dpgNFvg9dSnr8NHLQddu/6py3zaBlatR9uwknPqPCpq7ZSzZEN2r3d4ukyr2Y7ubLFgZ0rdcbfXL15YqG80XtaZojtu7EQ0owCwjRfyS1+D9TYIbk
+api: eJyNUz1v2zAQ/SvCmwnL6ajNQxukHRq0DjoYHs7S2WIsiQx5SmsI/O/FUUZiJxmiRRJ5H+/eezeh4VgH68W6ARV+sYxhiIUd9q6gnRulkJaLegyBBynGyAEGQoeIaoOHyCFiaxC5HoOVE6rNhB1T4LAapUW12aatQeDo3RA5oprwZbnU13Xfn7tHrqX4a6XNTYqGhBYwqN0gPIhmkPedrUkzyseoaRNi3XJP+iUnz6jgciEY+OA8B7FzU9tcxEQJdjggGQzU8/sLg2HsOtp1jErCyMmAe7LdpyJtT4fP1excTZ1SeBG9c65jGpCSsvY02sCNMm0bXCZskz4GPUvrGlQ4cJ6ZlHOUymAse4YqE55VJBVmDB0qTNQ0gWNMJXlbPt/A4JmCVWiZqvP1rNGexk5QoRXxsSpLCafFkQIdmf2CvId5I+S65eJcoXD7bJ4f5/hixoKU0oVlfquCc+dL47wwop11jhymDOUgmPPHNxd6UoTf/6wza+pcTdepZ0g3i+Viqa61ouzjBc/q/u5D/Kv7u2LvwjV4HTYZeBelp+y92Ty4Zbnaj7w7b+tOr0b+7I7N4wv/k9J3ZAftnhWczjpvkHWG2kCXsHVR9HSadhT5IXQp6fHTyEEXc/uqc95Lg5apUfdtJhz5hAqrumYv2RDdqN3frZwq92K6269rGNC1Xm/0ydXPVzScLmpP0xyxdkceUoI5gxD9R1KL/wcmvpVd
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -54,7 +54,7 @@ Returns info about the current user
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"Object with user data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"localUser":{"type":"boolean"}},"required":["id","localUser"]}}}}}}
+ responses={{"200":{"description":"Object with user data.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","nullable":true},"email":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"localUser":{"type":"boolean"}},"required":["id","localUser"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-current-user-stats.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-current-user-stats.api.mdx
similarity index 60%
rename from docs/versioned_docs/version-v0.27.0/api/get-current-user-stats.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-current-user-stats.api.mdx
index 483f1f86..63486eba 100644
--- a/docs/versioned_docs/version-v0.27.0/api/get-current-user-stats.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/get-current-user-stats.api.mdx
@@ -5,7 +5,7 @@ description: "Returns stats about the current user"
sidebar_label: "Get current user stats"
hide_title: true
hide_table_of_contents: true
-api: eJylVkuPm0AM/ivIZxSyPXJL1cduH2rVZlVVUQ4OccI0MENnTFqK+O+VB5IAG7S77WnZ+PXZ/mxPDVtyiVUFK6Mhhi/EpdUucIzsAtyYkgNOKUhKa0lzUDqyEALj3kG8gntH1sE6BEdJaRVXEK9q2BBasouSU4hX62YdgiVXGO3IQVzDi/lc/gwDf9r8oISDX4pTH6RFMIMQEqOZNIsJFkWmEhST6IcTuxpcklKO8sVVQRCD8Z4ghMKagiyrNqou85fGHHK0B9fT1mW+IQtNKF9v8GisYppUWNgkVUfaTsmXvi7XZR+U40nhrdqnmdqnExqbE/KX1dLLHss2U/pw1RPTb74qQOfomqSR7v0slZWsV63jzs3JaC1+TfHK5Kh0PwG0FisIQTHl7nHQW++gp+fYKr0XdIkp9RPQdR5O+gIsx993bfibucfJmC0E9lf1h6Yr8bDSz0yGh9aPp9Jhm4A1StRLT776luumRxel94uE1dEP5qOAU+W+EU3QJlXuo9Ey0RPS74T2OnerW1Pafy9kOrS+OH4iJ7z9hREe0SusPu1GyT6XrFj9D6qtj3UGNW7vqRf9yvfqfK7qMBk/iLi/d7j/D+ZqzJ/H3BF4bz85gmPl/loeLeHhyr0s2N46HS/Ph6tysJoezP9o2q+PTq+o0ipJISdOzRZi2JMvIMpkQCSXy0U5Rf56gdxFe5QTKWextBnEUON2a8m5JsJCRccbCOGIVuEma6vfidsLucMyY4ghZS5cHEVsq9kBLR6IihkWBYSjM7pMKeg8BGbnT/f7Tj9osUDTNL2D/VXOZxu5f7bPPZbIkodXg7hTkkL5jzfG5igI331beiIovTNiLlm3kG5m89lcaqg4Ew9nPIvPd1fxLz7fBTtjh+Al2SaEwjjOUV9oCm+JB6+T4FT6geP68ox48hunLYBcuqjI5Kw0YdvDuuv3Cny/QeggNfKB1yGkxrFI63qDju5t1jTy88+SrDyQ1peO+/dRCCnhlqwnyYEqiGGRJFSwp0ZW+hEev3ykh2cSvn29FCYPOzfqlPd+Wgi66vmu61ZjaQ6kmwbCDgTL/9AI5f8C4yOBiw==
+api: eJylVktv20gM/isCz4Ll7FE3F32lu4sWGwdFYfgwkmlramlG5VBuVEH/veBItiXF3iTNKYr5+kh+Q7KBDbqUdMnaGojhP+SKjAscK3aBSmzFAWcYpBURGg4qhwQhsNo5iFdw75AcrENwmFakuYZ41UCCipAWFWcQr9btOgRCV1rj0EHcwF/zufwZB/6cfMeUg5+aMx+kQzCDEFJrGA2LiSrLXKdKTKLvTuwacGmGhZIvrkuEGKz3BCGUZEsk1l1UUxVvrN0XivZuoG2qIkGCNpSv9+pgSTNeVVhQmukDbq7Jl74ul2X/aMdXhR/1Lsv1LruikRyRv6mXXvZUtrk2+4ueGB/4okA5h5ckrXTvR6VJsl51jns3R6O1+LXlW1sobYYJKCJVQwiasXBPg954BwM9x6TNTtCltjLPQNd7OOoLsEI93Hbhb+YeJ6t8IbDv9C+8XonHlX5hMjy2fjqVHtsVWJNEvfToa2i5bgd00Wa3SFkf/MN8EnCm3VfEK7TJtPvXGnnRV6TfUNFl7tYfbUV/XshsbH12/ExOePszIzyit6r+vJ0k+1Kyqvo1qDY+1gnUtL3HXgwrP6jzqarjZPxDVLt7p3avYK5RxcuYOwHv7f/nCQ6G2Z2tKH0FVDe178HKTM1zleQIMVOFIaCpCgGnSg0h/MREEObyXdhE5wIYHxiNk3UUgtNml+O2E5BzAqkoLXUJPbMQPbrrbR7tpMkGGu+b83YZ7JLp5ni8J0Zz+dHwm4y6y3NjwKhLrZOkJK0CObMbiGGHvk1KRgVEsspdVGDk17kUFukgN4PcCRXlEEOjNhtC59pIlTo63EAIB0Vamud73Iu7k2Grqpwhhoy5dHEUMdWzvSK1RyxnqiwhnNwVywyD3kNgt/6W+bvXDzos0Lbt4IK5k3uiizy8Y069lsiSh1eDuFeS2viP95YKJQg/fV16QmiztWIuWXeQbmbz2Vzqqln4CSc8iy+3F/EvvtwGW0tj8JJsG0JpHRfKnN8tfEAenWvBsfQjx835rnr20dcVQFZ/VOayZ9uw62HT93sFvt/yqIQtXeB1CJl1LNKmSZTDe8rbVn7+USHJxbg+d9wfjCFkqDZIniR7rCGGRZpiyZ4aeeUHxfQUlB6eSPjh3VLYPe7cpFPe+3HsmHrgu2k6jaXdo2lbCHsQLP9DK5T/DVVi30E=
sidebar_class_name: "get api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -54,7 +54,7 @@ Returns stats about the current user
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"Object with user stats.","content":{"application/json":{"schema":{"type":"object","properties":{"numBookmarks":{"type":"number"},"numFavorites":{"type":"number"},"numArchived":{"type":"number"},"numTags":{"type":"number"},"numLists":{"type":"number"},"numHighlights":{"type":"number"},"bookmarksByType":{"type":"object","properties":{"link":{"type":"number"},"text":{"type":"number"},"asset":{"type":"number"}},"required":["link","text","asset"]},"topDomains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"count":{"type":"number"}},"required":["domain","count"]},"maxItems":10},"totalAssetSize":{"type":"number"},"assetsByType":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"number"},"totalSize":{"type":"number"}},"required":["type","count","totalSize"]}},"bookmarkingActivity":{"type":"object","properties":{"thisWeek":{"type":"number"},"thisMonth":{"type":"number"},"thisYear":{"type":"number"},"byHour":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"number"},"count":{"type":"number"}},"required":["hour","count"]}},"byDayOfWeek":{"type":"array","items":{"type":"object","properties":{"day":{"type":"number"},"count":{"type":"number"}},"required":["day","count"]}}},"required":["thisWeek","thisMonth","thisYear","byHour","byDayOfWeek"]},"tagUsage":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}},"required":["name","count"]},"maxItems":10}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights","bookmarksByType","topDomains","totalAssetSize","assetsByType","bookmarkingActivity","tagUsage"]}}}}}}
+ responses={{"200":{"description":"Object with user stats.","content":{"application/json":{"schema":{"type":"object","properties":{"numBookmarks":{"type":"number"},"numFavorites":{"type":"number"},"numArchived":{"type":"number"},"numTags":{"type":"number"},"numLists":{"type":"number"},"numHighlights":{"type":"number"},"bookmarksByType":{"type":"object","properties":{"link":{"type":"number"},"text":{"type":"number"},"asset":{"type":"number"}},"required":["link","text","asset"]},"topDomains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"count":{"type":"number"}},"required":["domain","count"]},"maxItems":10},"totalAssetSize":{"type":"number"},"assetsByType":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"count":{"type":"number"},"totalSize":{"type":"number"}},"required":["type","count","totalSize"]}},"bookmarkingActivity":{"type":"object","properties":{"thisWeek":{"type":"number"},"thisMonth":{"type":"number"},"thisYear":{"type":"number"},"byHour":{"type":"array","items":{"type":"object","properties":{"hour":{"type":"number"},"count":{"type":"number"}},"required":["hour","count"]}},"byDayOfWeek":{"type":"array","items":{"type":"object","properties":{"day":{"type":"number"},"count":{"type":"number"}},"required":["day","count"]}}},"required":["thisWeek","thisMonth","thisYear","byHour","byDayOfWeek"]},"tagUsage":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"count":{"type":"number"}},"required":["name","count"]},"maxItems":10},"bookmarksBySource":{"type":"array","items":{"type":"object","properties":{"source":{"type":"string","nullable":true,"enum":["api","web","cli","mobile","extension","singlefile","rss","import"]},"count":{"type":"number"}},"required":["source","count"]}}},"required":["numBookmarks","numFavorites","numArchived","numTags","numLists","numHighlights","bookmarksByType","topDomains","totalAssetSize","assetsByType","bookmarkingActivity","tagUsage","bookmarksBySource"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/get-highlights-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-highlights-of-a-bookmark.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/get-highlights-of-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/get-highlights-of-a-bookmark.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/get-lists-of-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/get-lists-of-a-bookmark.api.mdx
new file mode 100644
index 00000000..61f46bf0
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/get-lists-of-a-bookmark.api.mdx
@@ -0,0 +1,71 @@
+---
+id: get-lists-of-a-bookmark
+title: "Get lists of a bookmark"
+description: "Get lists of a bookmark"
+sidebar_label: "Get lists of a bookmark"
+hide_title: true
+hide_table_of_contents: true
+api: eJytVU2P3DYM/SsGTy0grCdFiga+bYs22CaHINmih8EcODZnrB1ZUiR6dyaG/ntB2fO162x76Mm29CQ+Pj7SAzQU66A9a2ehgvfEhdGRY+E2BRZr53Ydhh0oYNxGqJbw67QUYaUgUt0HzQeolgOsCQOF255bqJartFLgMWBHTCFmQKxb6hCqAfjgCSqIHLTdggLaY+eNLGnSjdkftt3Tw7tf3P7bz+2e2dXvhIHmDDkyuGsgKQj0tdeBGqg49KTAYieg9RmkQEtqHrkFYRUoemcjRWHy02Ihj2sV7lvKKogIrd62Rm9bjqCgdpbJspxA742uUU6UD1GOzSTo1g9UMyjwwXkKrMegWeELGIaAB+HJ1MV/P66blxqmY+YzG1fJvRTf9sbgWqQVBZMCXc8BU64nWb6bCT9zywiYqbXtOzFSh7ZHAwpih4HFTQ1tsDcM1XEvKfjaUzj8p3i+XxtdX0DXzhlCK7e0GH9zgncB2YU4j+ojhc/OvMraPVkK8t1odvLyqOkpr0zxV+nKlEup1lSbSdkLHU+nZihe8Fmdzf9RR4b0PMZoqFXKG28Xb19a+tg0hXVcbFxvm//PzrVr5o3XUYy4ndt7xj/fcMbnRPJ5bl0DFWwpR5UOrqA89nYsh3Obp3IUQYZSeDyOnD4YqGDApgkUYyrR6/LxjZQNgxb75ASm7VG1owdbZh+rsuRwuNlhwB2Rv0HvQc1Mi+kGGRjcUvFhwhcjFynYxbT8IrqOkS9n5kkkiSx5ZJhYNINATS9/uNChMPzz7/uspLYbJ8cl65HSm5vFzeJiZJ743H66m+V/++mu2LhwTV6SlcZykTvMjpiG6/f/Es9Gzclgr/1YxqSZ9lx6g3psRanbMFV8eZrmUt7qarRPzlfQusgCHYY1RvormJRkeZofy9W55NkYjY7y3kC1QRPpFeY/fJ6M+mPxPbbHMW4P2Vmmly9QsKPD9a8orWQYETYUMosRcFvX5Pni6ItmFPecmuH97/egAK8988wj+fZZWsMwIu7djmxKJ5Ys30IwpX8ASlbEvw==
+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 lists of a bookmark"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"get"}
+ path={"/bookmarks/{bookmarkId}/lists"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Get lists of a bookmark
+
+<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"}]}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"200":{"description":"The list of highlights","content":{"application/json":{"schema":{"type":"object","properties":{"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}},"required":["lists"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/karakeep-api.info.mdx b/docs/versioned_docs/version-v0.31.0/api/karakeep-api.info.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/karakeep-api.info.mdx
rename to docs/versioned_docs/version-v0.31.0/api/karakeep-api.info.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/remove-a-bookmark-from-a-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/remove-a-bookmark-from-a-list.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/remove-a-bookmark-from-a-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/remove-a-bookmark-from-a-list.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/replace-asset.api.mdx b/docs/versioned_docs/version-v0.31.0/api/replace-asset.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/replace-asset.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/replace-asset.api.mdx
diff --git a/docs/versioned_docs/version-v0.31.0/api/search-bookmarks.api.mdx b/docs/versioned_docs/version-v0.31.0/api/search-bookmarks.api.mdx
new file mode 100644
index 00000000..e7491d34
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/search-bookmarks.api.mdx
@@ -0,0 +1,71 @@
+---
+id: search-bookmarks
+title: "Search bookmarks"
+description: "Search bookmarks"
+sidebar_label: "Search bookmarks"
+hide_title: true
+hide_table_of_contents: true
+api: eJzNWEtv4zYQ/ivCXNoCQpzt0Tdv0EdadBM0WfQQ6DCWRhbXFKmQlBOvof9eDClLsiMn8m6A9hRHnMc3Dw5nZgcZ2dSIygmtYA53hCYtoqXW6xLN2kIMDlcW5g/wsfuWxGAprY1wW5g/7GBJaMgsalfA/CFpkhgqNFiSI2M9gU0LKhHmO3DbimAO1hmhVtDEYOixFoYymDtTUwwKSyZ4hBgEA3qsyWyhiU8LiYFUXTJCtCnE3iBgwZI2qFJiuBnlWEsH88HnA+U5Sttrt9q4G5ORmYBC1eWSzGvSpCiFO8ceJ5zkD1e1sfpV0WmgeFv2UmtJqGDgiuDvw/Bf55ElFzkd+dMuD36wUaqVI+WiJyFltKRIqFTWGWWRUJErKDJkK60sXUSftKM4coXomVJUzCPRrCjKtYmsLqnPsotRG/8n0Dpnt2KvAuOR0xM2IKix7PefLy/5z6ENN8svlDJOV3hgNtw2Q7aWzqtqUTErVpUUKTLr7Itl/pG4ai8RYqiMrsg4EbT397cnRWNwy6gdlfZtESIbva+pIXSULdzoaakzkYvx4xhULSUuObU5hE2X6BMo2U9iQ9lISjcx5LjRXI5OnTtcrYRa3Tl0tX1bX19RbJ2mZLkK5ihkbYjdRCpjrqSJwdZliUZ89VF6f/FKu2nuCTi202h1bdIJYgd1tRIQwxMtOUEl/y71UkhGS8+OlOXsjsEKtZKUhwPjzRJlpY3zttSWzPV4ToUX5p0TNVzakQN0DtOCso+j7upsZjOLukQFSXNQnR5YYyv/QJqnG1xgregm9+/f6waE09NQpFDr4EIjx/03+RodlKMJ9KLEFX0eU3uKeGEtubE4j2ViaoiULbQ7h6vK8nPI81rKWwYWKshZmgylBp8kZd/AvBEZ6bOA4kakE+NSuFJe9Zn2Jn2blefA2Vs+UQFTv38BxNoV2kwLVr2UwhY0jTpDR7ctxzR/MMdf7fM2geGoZHjqcIMTbtC+ryI4eg5F1f8YKwmhyE+7ueNQ9zq+FytyzoVg8q/7N8h9EQF/y3umE+8GPzWfRsv8yWdvai2z4utQbNvkn75Z3+zm3im9re/g9VqtlX4aebs8Q9J0rn3/h3dSmPlN+31QxIaPQRv9VtLd8PsSlSJz3ebIUWmHtugyXdv/+oIHI5UcQkPyuZIaM+L3HDfokEPcu+6sDBvrEXpXJM0oQd9NH/TOg373oLk97mTHG9Cu12o7qz5Ju5gn/ZC5H+uBASp6du3UebbFw53BQM5A1S2uhGJ7+1VC03jHlOQKncEcViFcyKsEmHUiZ2FSYoPJbPZrBd8PwQ6zzJC1zQwrMdt84DRAIxioT9P2OExj+zVA4Vxl57OZM9uLNRpcE1UXWFVwPHbeFxS1EiKd+6ntz5Y+CljYhsFG5I5HtHYKG+xFOm+yZp/uTMZjiifinPU/ftWmREb4xz/3PiRC5ZrZ2eoA6cPF5cXlYE3Q4VncXo/iX9xe+8n2ADwby8+mto6b3PluP+aOrICO2sau5o2ui4KZ/HzMKonCD2Bt5xriepgqbWSTGAptHZ/udku0XKmbhj+HAZvjnQnLUT2xIRji+vHvNjF/ik5BWtO23TNtUNZ87jcnL3QEuuFGaAr9fuczhbZb4rxOfNLY/3Az8opnX2xLeuuS/ob6hWEMBSH7loMcuBdpStWQ68U2hKV0ZeO3X+4hdIvDBcDhzRpOYqi2A9m7XaC412tSTQN7Exz/Dw3X7n8BUIFNqg==
+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},"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"}},"nextCursor":{"type":"string","nullable":true}},"required":["bookmarks","nextCursor"],"title":"PaginatedBookmarks"}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/sidebar.ts b/docs/versioned_docs/version-v0.31.0/api/sidebar.ts
similarity index 86%
rename from docs/versioned_docs/version-v0.27.0/api/sidebar.ts
rename to docs/versioned_docs/version-v0.31.0/api/sidebar.ts
index bfc37dce..0b9c7fb6 100644
--- a/docs/versioned_docs/version-v0.27.0/api/sidebar.ts
+++ b/docs/versioned_docs/version-v0.31.0/api/sidebar.ts
@@ -64,6 +64,12 @@ const sidebar: SidebarsConfig = {
label: "Detach tags from a bookmark",
className: "api-method delete",
},
+ {
+ type: "doc",
+ id: "api/get-lists-of-a-bookmark",
+ label: "Get lists of a bookmark",
+ className: "api-method get",
+ },
{
type: "doc",
id: "api/get-highlights-of-a-bookmark",
@@ -270,6 +276,42 @@ const sidebar: SidebarsConfig = {
},
],
},
+ {
+ type: "category",
+ label: "Backups",
+ items: [
+ {
+ type: "doc",
+ id: "api/get-all-backups",
+ label: "Get all backups",
+ className: "api-method get",
+ },
+ {
+ type: "doc",
+ id: "api/trigger-a-new-backup",
+ label: "Trigger a new backup",
+ className: "api-method post",
+ },
+ {
+ type: "doc",
+ id: "api/get-a-single-backup",
+ label: "Get a single backup",
+ className: "api-method get",
+ },
+ {
+ type: "doc",
+ id: "api/delete-a-backup",
+ label: "Delete a backup",
+ className: "api-method delete",
+ },
+ {
+ type: "doc",
+ id: "api/download-a-backup",
+ label: "Download a backup",
+ className: "api-method get",
+ },
+ ],
+ },
],
};
diff --git a/docs/versioned_docs/version-v0.27.0/api/summarize-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/summarize-a-bookmark.api.mdx
similarity index 54%
rename from docs/versioned_docs/version-v0.27.0/api/summarize-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/summarize-a-bookmark.api.mdx
index 07ec3243..05396a02 100644
--- a/docs/versioned_docs/version-v0.27.0/api/summarize-a-bookmark.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/summarize-a-bookmark.api.mdx
@@ -5,7 +5,7 @@ description: "Attaches a summary to the bookmark and returns the updated record.
sidebar_label: "Summarize a bookmark"
hide_title: true
hide_table_of_contents: true
-api: eJytVUuP2zgM/isGT1tAiNNFFy18Sw8FpnvYwc4seghyYCwm1sSWXIlOkxr67wvKzmvGfRzmZFvi4+PHj3QPmkLpTcvGWShgwYxlRSHDLHRNg/6Yscu4omzt3K5Bv8vQ6swTd96GdNG1GpnkrHRez0AB4zZAsYSPo0uAlYJAZecNH6FY9rAm9OQXHVdQLFdxpaBFjw0x+ZAMQllRg1D0wMeWoIDA3tgtKKADNm0tR4aMrg/HbfPt6cN7d/j+V3VgduUHQWA4mZwQ3GmICjx97YwnDQX7jhRYbMRofTFSYISFFrkCQeUptM4GCoLkz/lcHreEPV4xcKbom+HqxB8oKJ1lsizO2La1KVGc86cgESZqdesnKhkUtN615NkM+Y1+yUdUUHqS7AuevG2cNhszfa3AdnWNa6FKGIln4n7DEn1ZmT1dY1o7VxNaSbvBvZN2/+iecbs1dvvAyF34dT4FZLtGNBW6sqQQQFKYuvMkNJHV4rWKCgbWzfdE8euHt45/j55T939teyPMpXT5uqc3Hbxi/Ybi53xO07CKUZK9m797KePToGTWcbZxndWvp9vS6QnORJsUAm6n7p5xkiJc7FMhyZ8rp2VeXUhpZWwLyE9zGPL+MtsxP3EioQL5/WnXdL6GAnrU2lMIMcfW5Pu3oGCP3kijUhXj9UDdBruaoYCKuQ1FnrM/znbocUfUzrBtQU2siTFC5jZpb/492mcDFogxXq3JByF3yHy9LM9MSWapI5nJbCUjUOPLJ+cbFISfvzwmOo3dOHGXqgdIb2fz2fxqV57xLO7vJvEv7u+yjfO34KXYqFIHGkyyGLfqw4ntDM+L8XnY/iKxV/rzDOQwHThvazRp16T+9qM6lud1L2NS3Oz+i0BWCirRVLGEvl9joP98HaMcf+1Ipnq5usgjiUibIO8aig3WgX5S6B//jsp+k/0I8XiI9phUWHfyBQp2dLz9X0XZSRWhJp9QDAaLsqSWr1xfTK8o7Tw99/88PMpquRXYM0Gl8JO4+n6weHQ7sjGeYbJ8C8IY/wc5POmb
+api: eJytVU2P2zYQ/SvCnFKAsJ0iRQLd3EOBbQ9ddLfIwfBhLI0triWSIYdeOwL/ezCUP3eVdg97skwOZ948vnnsoaZQee1YWwMlzJmxaigUWITYdegPBduCGypW1m479NsCTV144uhNyBvR1cgka5X19QQUMG4ClAv4/XgkwFJBoCp6zQcoFz2sCD35eeQGysUyLRU49NgRkw85IFQNdQhlD3xwBCUE9tpsQAHtsXOtLGnSdbs/bLrnpy+f7f77b82e2VZfBIHmHHJCcFdDUuDpW9SeaijZR1JgsJOg1SVIgRYWHHIDgspTcNYECoLk19lMfm4Je7xi4EzRs+bmxB8oqKxhMiyH0blWVyiHp09BMoz0aldPVDEocN468qyH+rp+zUdSUHmS6nMe3e1srdd6fFuBiW2LK6FKGEln4t4Qib5q9I6uMa2sbQmNlF3jzsp1/2yfcbPRZvPAyDH8fz0FZGInmgqxqigEkBK6jZ6EJjK1nFomBQPr+num+P3TG8tvo+d0+2+KtdFXb0h7gYlOg4JnWom6Wvnu7Eq3lOeDyQQRp4Kgzaal9bDhc1u6c9Zz7iUG8ndjmroZlYXo7lplN5q60sHNpb+84fGLOWNYpiRVP80+vZ6w0wwXxnKxttHU7zdSla1HeJexoRBwM7b3gpyc4RKfG8nnubG1WIkNuaw4SgnTk0WEaX+xnTQ9kSOpAvndyQajb6GEHuvaUwhpik5Pdx9BwQ69FmHkLo7bA3VrjC1DCQ2zC+V0yv4w2aLHLZGboHOgRhzsmKGw62zpfx3jiwELpJSuHPxByB0qX/v4mSmpLH3kMBn7HATq+PGH9R0Kwj+/PmY6tVlbOS5dD5A+TmaT2ZWNn/HM7+9G8c/v74q19bfgpdmk8g10mGVxNPyHE9sFnj37Zdr+IrF3ehQHcpj2PHUt6myD+X77ozoW55dIJqO8eZYuAlkqaERT5QL6foWB/vVtSrL8LZIYzmJ5kUcWUa2DfNdQrrEN9B+NfvjnqOxfip8hPi6iOWQVtlH+gYItHW6f0iQW0xDW5DOKIWBeVeT46uir6RWlnafn/u+HR/GYW4G9EFROP4qr74eIR7slk9IZJst/QZjSD3WCHTs=
sidebar_class_name: "post api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -62,7 +62,7 @@ Attaches a summary to the bookmark and returns the updated record.
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"The updated bookmark with summary","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}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+ responses={{"200":{"description":"The updated bookmark with summary","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"}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.31.0/api/trigger-a-new-backup.api.mdx b/docs/versioned_docs/version-v0.31.0/api/trigger-a-new-backup.api.mdx
new file mode 100644
index 00000000..d4eabb18
--- /dev/null
+++ b/docs/versioned_docs/version-v0.31.0/api/trigger-a-new-backup.api.mdx
@@ -0,0 +1,63 @@
+---
+id: trigger-a-new-backup
+title: "Trigger a new backup"
+description: "Trigger a new backup"
+sidebar_label: "Trigger a new backup"
+hide_title: true
+hide_table_of_contents: true
+api: eJyNVE1v2zAM/SsGz0Lc7qhbNmBANwwr0Aw7BDnQNhOrtiWVkrplhv77QNvIR5cC88W2SJGPfI8coaFQs/HROAsaNmwOB+ICC0u/igrrLnlQEPEQQG/h43QQYKcgUJ3YxCPo7QgVIROvU2xBb3d5p4ApeGcDBdAjfLi7l9d1qjlWUTNhpKYIqa4phH3q+yMoqJ2NZKNcQ+97U6NcK5+D3B0h1C0NKF/x6Ak0uOqZ6ggKPDtPHM2c2TQXPiGysQfIClIgfrhtwhAo3rIpsKnvseoJdOREWcGCfR1vRgrmD10YbBoqYjFUznUDcvfJJRtveoSIMYVbGMimQZjwZJv5ZGkcKNij6RMT7LICYnb8jULAA/1HLVkYe0mGqZHopoFTk84tuSx4Ke9tMSfouyyPgoFi6xrQ4F2Y6EHRCJTVoiQREr8Sh0lHiXvQMGLTMIWQS/SmfL0HBa/IRuBOPVnMs6T2mPoIGtoYfdBlGfm46pCxI/Ir9KLeNxJvqVgiFG5fxJaKr4t/MWOBnPOFwp9Ea3PmS52feiqZpY7JDfTiJK2ZPj47HlAQfvm5AWmJsXsn16XqGdL96m51J2NmojACJzzrx4eb+NePD8Xe8TV4KTarqdEDTlNicQL0zlBfhR3PE/fuEpjLjfQ7lr5HY6dJEsbGhdYtVOcF0QrhegvjWGGgH9znLMcviViWxu5M6rQzFLSEDfGkg46OoGFd1+TjxH6fJPU/m0BoOins8fvTRtR6zc4bNqbwiwnt8SL4OM4eG9eRzRnUgiLKP2QR9F+uE8Zd
+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={"Trigger a new backup"}
+>
+</Heading>
+
+<MethodEndpoint
+ method={"post"}
+ path={"/backups"}
+ context={"endpoint"}
+>
+
+</MethodEndpoint>
+
+
+
+Trigger a new backup
+
+<ParamsDetails
+ parameters={undefined}
+>
+
+</ParamsDetails>
+
+<RequestSchema
+ title={"Body"}
+ body={undefined}
+>
+
+</RequestSchema>
+
+<StatusCodes
+ id={undefined}
+ label={undefined}
+ responses={{"201":{"description":"Backup created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"assetId":{"type":"string","nullable":true},"createdAt":{"type":"string"},"size":{"type":"number"},"bookmarkCount":{"type":"number"},"status":{"type":"string","enum":["pending","success","failure"]},"errorMessage":{"type":"string","nullable":true}},"required":["id","userId","assetId","createdAt","size","bookmarkCount","status"]}}}}}}
+>
+
+</StatusCodes>
+
+
+
\ No newline at end of file
diff --git a/docs/versioned_docs/version-v0.27.0/api/update-a-bookmark.api.mdx b/docs/versioned_docs/version-v0.31.0/api/update-a-bookmark.api.mdx
similarity index 57%
rename from docs/versioned_docs/version-v0.27.0/api/update-a-bookmark.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/update-a-bookmark.api.mdx
index a6947c6d..5536c01c 100644
--- a/docs/versioned_docs/version-v0.27.0/api/update-a-bookmark.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/update-a-bookmark.api.mdx
@@ -5,7 +5,7 @@ description: "Update bookmark by its id"
sidebar_label: "Update a bookmark"
hide_title: true
hide_table_of_contents: true
-api: eJytVk2P2zYQ/SvCnFpAtb1Figa6OUGLbj/QRbJBD4YPI3FscS2RCkl5rQj678FQsj52lY2Arg+GSA7J4Zv3ZqYGQTYxsnBSK4jgUyHQURBrfcrRnIK4CqSzgRQQgsOjhWgH77pFC/sQLCWlka6CaFdDTGjIbEuXQrTbN/sQCjSYkyNjvYFNUsoRohpcVRBEYJ2R6ggh0AXzIuMpSVJkl+qYPz68/VVfvvySXpzTyVv2QDpvcvXgVkATgqHPpTQkIHKmpBAU5mwUD0YhSH5cgS4F9op3kHXvtKjYlykE9ykFAh0GTgelh2MV/KuyKnApBQdJmbBBpcvgEZUbbAJFJHgYU1AYfZaCxApCSLRypBxfg0WRyQT5mvWD5btmANHxAyUOQiiMLsg4SdbvNUkqz/zG3jLWOiNUjMABz5qj8K11W+Y5mmoOd1VmGcaMKoPXhKC0o+eGTQ/+944IIcfL36SOTIKbzWbThJAYQkdi6xZ5UJpszu6gTY4OIiiNZH8mUVtwLJYu1WaRaVHGmbQpLbPm8N91O8TiHf9oIQ9y4QZHl2XYobXk3g+c+84G/2M92EIr21Lt581mXhQt0UWfHF6P3XIGhZdp04SQdwAuZNVC+jKG/0trDo9HqY4fHbrSLpELqTLntGrLJCFrmekos9IQw0RK8K59L2L5xUP8+sfP634GnuXJZJKbd+CLyBDTSQRHqE8gfornPAz7lsZvNm+eM/daKwKlXXDQpRKvx9tEi/lcmZO1eJxbe4KJP2Gw33eCzMmlWrQlK0n5Xi5dEayv2rPreqhvDcNC5nytsj6BQo1CGLK2WWMh1+cbCOGMRnJ82pLSLreIHbDMOLemzhU2Wq+dqVYnNHgiKlZYFBDOJITuhEAffG38q7MPWl+gaZpRg/CRMW1vHrcJPUB8M7/Dm7GkvBGE3cfv1+z/53/3HkWO1Yehjv927R/GtbJVwFix7UxP4RF1Pf2H8bXV6CdGyWiYbJHuh1OI+ulr5RlmRgVmtHtaR6YLQ7kY+eirwuieSfIf0VGqg2ZkmCGtbzerzWozemYfu+3d7Wyst3e3wUGbaaCZGFwutXU5euV0vVfXRuK4Vjyp170EX+45W3LwS9dFhtKn2K5BaDWx6xs9zg7RqOvbh5Bq69ikrmO09MlkTcPTn0vi6O/2gyS8cIS0/C0gOmBm6QWff/jQifjH4FtedpOoKq+8rOQRhHCiatqdNpx+U0LBdNjVnUEXx5/u+ZjhgGfpqgmvO7ZJQoV70XY/Si132/v3f7C+ui4498kMDD5C6P+9t9o/3svWz9WQoTqWPrlBe2jTNVfjejgVr3/WLB513Vrc6xOppunhcTxmZJrmK4OCX9A=
+api: eJytVtuO2zYQ/RVhnlpAtb1FigZ6c4IW3V7QRbJBHww/jMSRxbVEKrx47Rj692IoWZddZeOiqyeRHJLDM+fMzBkE2czI2kmtIIFPtUBHUar1vkKzj9JTJJ2NpIAYHO4sJBt41y1a2MZgKfNGuhMkmzOkhIbM2rsCks222cZQo8GKHBkbDGxWUIWQnMGdaoIErDNS7SAGOmJVlzwlSYryeNpVjw9vf9bHLz8VR+d09pY9kC6YXDy4FdDEYOizl4YEJM54ikFhxUbpYBSD5MfV6Apgr3gHWfdOixP7MoXgvqBIoMPI6cgHOBbR36o8Ra6gKJdUChudtI8eUbnBJlJEgocpRbXRBylILCCGTCtHyvE1WNelzJCvWT5YvmsGEJ0+UOYghtromoyTZMNekxXywG/sLVOtS0LFCOR40ByFr61bX1VoTnO4K1+WmDKqDF4Tg9KOnhs2PfjfOiKGCo9/ktoxCW5Wq1UTQ2YIHYm1u8oDb8o5u1ybCh0k4I1kfyZRu+JY9K7Q5irT2qeltAVdZ83hv+t2iKt3/KWFzOWVGxwdr8MOrSX3fuDcNzaEj/Vga61sS7UfV6t5UbREF31yeD12yxkUXqZNE0PVAXglq66kL2P4v7TmcLeTavfRofP2GrmQ8hWnVeuzjKxlpqMsvSGGiZTgXdtexPJLgPj1j5/X/Qw8/yWZWO1NdlXSuLiJtYQYHilldpX8X+lUlhRKhCNlmY8xWKl2JeXtggnPklWtjQtv8ZbM7RynJtViA6GsDSybcGrEg0nQn0Z4PjC9D9tWYW9Wb56L6lLGIqVdlGuvxOtJKtNiPo1XZC3u5taegBNOGOy3Xa6oyBVatNU0K/herqoJLC9pwS7PQ+ltGB8yh0sDEHI7nFEIQ9Y2S6zl8nADMRzQSOZDW+3a5RaxHH3Jab9wrrbJcunMabFHg3uieoF1DfFMrupOiHQeyvYfnX3U+gJN04x6l4+MaXvzuIPpAeKb+R3BjNUejCDufn69FKbf/7kPKHKsPgwtxi+X1mZcxlvWj5NJO9OraySVoMxhfOmC+olRnhwmW6T74RSifvpSFIeZUe0b7Z6WuOnCUMlGPoaCNbpnUpdGdJQq14wMM6T17WaxWqxGz+xjt767nY31+u42yrWZBpqJwZVcW1dhUE7XFnYdLo7L2JNWopfgy+1wSw5+6bIuUYbs3/UurSY2fQ/KCSEZNaTbGAptHZuczyla+mTKpuHpz544+pvtIIkgHCEt/wtIciwtveDzdx86EX8ffc3LbhLVKSiv9DyCGPZ0mjbODWfTglAwHTbnzqCL4w/3fMxwwLN01cSXHesso9q9aLsdpZa79f3731hfXYNehWQGBh852+Nj660Ojw+yDXNnKFHtfEhu0B7adH3fuFRPxRueNYvH+dxa3Os9qabp4XE8ZmSa5l9CRZNh
sidebar_class_name: "patch api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -62,7 +62,7 @@ Update bookmark by its id
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"The updated 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"]},"summarizationStatus":{"type":"string","nullable":true,"enum":["success","failure","pending"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+ responses={{"200":{"description":"The updated 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"]},"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"}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","userId"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/update-a-highlight.api.mdx b/docs/versioned_docs/version-v0.31.0/api/update-a-highlight.api.mdx
similarity index 64%
rename from docs/versioned_docs/version-v0.27.0/api/update-a-highlight.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/update-a-highlight.api.mdx
index e137a989..c8b25624 100644
--- a/docs/versioned_docs/version-v0.27.0/api/update-a-highlight.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/update-a-highlight.api.mdx
@@ -5,7 +5,7 @@ description: "Update highlight by its id"
sidebar_label: "Update a highlight"
hide_title: true
hide_table_of_contents: true
-api: eJytVcGO2zYQ/RVhTi3A2k6RooFubtAi2x6ySB30YOhAi2OLa4lkyNGuVYH/Xgwl2/Kusi3Q+CRrnmbePL4Z9qAwlF470tZADp+dkoRZpQ9VrQ8VZbsu0xQyrUAAyUOAfAsfztEAhYCAZes1dZBve9ih9OjXLVWQb4tYCHDSywYJfUiAUFbYSMh7oM4h5BDIa3MAAXiSjav5lUat6lN3aJ4e3v1sT3//VJ2IbPmOKWhKkAuFOwVRgMcvrfaoICffogAjG0ZVE5QAzQ06SRUwL/4EA/1iVcdsbmXYVJgpSTIjm7VJkkX20dRdRhVme421Clln2+xJGrpiMoOo+O8OM+fto1aoFiCgtIbQEJeRztW6lFxm+RC41owkdveAJYEA561DTxoDR0tbWz+rnGkbPpcO69o+AffG/R48ogEBu7pFKGL6cSw4a8KQ8sfVar75oSF1NcK3a2Nn7bGR/ninXvYSBQSSnj7u9wFpEjdts0PPcTTqlej/00iAwr1sa4L8DIwCCE80l9K0dS13bEc2XRRgLOF/Aur51tuA/iuqlB75PNYzROKN/7dTfW/VnGo3djVyTowu9afVipmRg8FIb1dvX3rnAsqMpWxvW6O+5QCoGX2jgAZDkIe52DNtUoYrvhhnokGqrBq2Q1lxXd4SOSwv9g/LfrJMIiuL/vG81FpfQw69VMpjCHEpnV4+vgEBj9JrPvlEfwwPop1tVhG5kC+X5LvFUXp5RHQL6RyImakcM2R2nxbRHyM+G7jwuUz28Z+s6jhyk618kYgrcx8JBvkI4llID79Z30hm+Ptfm6Qjn9an69L89byuL4tpMjLa7C1HWKGB/pvFarGaLPAL9/X93Wyv6/u7bG/9baMsTBTgbKBGJu+Mm368t+TNwrpJ2l9d+C+33CAPz8fS1VKbNJp8wv3oi+31YgkgIJ9eM4WAygZiUN/vZMDPvo6RX39p0fMlWVxtkcyjdOBnBfle1gFfof3dp9HK32df4zm+lKZL7uOtlgMIOGL37D6MRRRQoVToE40B8X4o9sOG81wzvJjaKM5frMsSHb2KLSYTdr/evP/AJhvv3SbNNHiZdrJ8Guja1H3ybnrXQy3NoU0zDkNStqS8dfQzB6e2ZgXp+wGxsUc0MV70If7PysT4D5kaH2M=
+api: eJytVcGO2zYQ/RViTg3A2E6QooFubtAimx6ySBzkYPhAi2OLa4lkyNGuVUH/Xgwl2/Kusg2Q+CSLT5yZN+/NtKAx5sF4Ms5CBl+8VoSiMPuiNPuCxLYRhqIwGiSQ2kfI1vD+dBphIyFiXgdDDWTrFraoAoZlTQVk6023keBVUBUShpgAMS+wUpC1QI1HyCBSMHYPEvCoKl/yK4NGl8dmXz3cvf3DHf/9vTgSufwtp2AoQc4p3GjoJAT8VpuAGjIKNUqwqmJUMUJJMFygV1QA58WfYKQ/nW44m2saVgUKrUgJcqJOlMzER1s2ggoUO4OljqJxtXhQli4YYRE1/92i8MHdG416BhJyZwktcRjlfWlyxWHmd5FjTVDitneYE0jwwXkMZDDyae5KFyaZs3XFfWmwLN0DcG1c7z4gWpCwLWuETSfBOsKp721dlmrLvDJ7XfrxJdE7G/vYrxeLaZb6yvVFMb+u3q1zh0qFw41+mnQnIZIK9HG3i0ijc1tXWwx8jlY/c/pzZErQuFN1SZCdgJ0EwiP9AL8/3AgJZrr0OmL4Dit5QO7HciKR7soo6zG/12yOuRuqGnJOGZ3jj6NtJrwJvZDeLN481c4ZJKwjsXO11b/SKXqC305ChTGq/dTZI27SDRf8ZvBEhVQ43Y+RvOC4PE4ymJ/lH+ftaOp0zCyG+9P0q0MJGbRK64AxdnPlzfz+FUi4V8Fw51P6w3FP2klmBZGP2XxOoZkdVFAHRD9T3oOccOVwg3C7NLH+GfCiz4X7Mhrcn5nVwXKj8X2miCNzHQkG2QBiL6SHv12oFGf44esq8cjd+nSZrn+d5vp5gl281Rth1CBjd46RzFhfzqvZYrYYTf5zLcvbm8nal7c3YufCdeFMVCfBu0iVSloaVsSw8NTVALu6tL2o8n/WY08X+2XuS2Vssip3vB10sr5spAgSsvF+2kgoXCQGte1WRfwSyq7j199qDLxdNxeZJDFpE/lZQ7ZTZcRn0v7t0yDtF+J7eQ4vlW2SGnnKZQASDtg8WqQdr5IClcaQ0ugR7/pgL1d8z+WGJy7u5OmLZZ6jp2exm5Hjbperd+9ZdMPCrpLHIag0o9VDn65L1Sctp3ctlMru6+R56C9liaprhT9SdCprkpC27RErd0DbdWd+iP8zM133H3AUMso=
sidebar_class_name: "patch api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -54,7 +54,7 @@ Update highlight by its id
<RequestSchema
title={"Body"}
- body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"color":{"type":"string","enum":["yellow","red","green","blue"]}}}}}}}
+ body={{"description":"The data to update. Only the fields you want to update need to be provided.","content":{"application/json":{"schema":{"type":"object","properties":{"color":{"type":"string","enum":["yellow","red","green","blue"]},"note":{"type":"string","nullable":true}}}}}}}
>
</RequestSchema>
diff --git a/docs/versioned_docs/version-v0.27.0/api/update-a-list.api.mdx b/docs/versioned_docs/version-v0.31.0/api/update-a-list.api.mdx
similarity index 54%
rename from docs/versioned_docs/version-v0.27.0/api/update-a-list.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/update-a-list.api.mdx
index fa31e48d..a6d82888 100644
--- a/docs/versioned_docs/version-v0.27.0/api/update-a-list.api.mdx
+++ b/docs/versioned_docs/version-v0.31.0/api/update-a-list.api.mdx
@@ -5,7 +5,7 @@ description: "Update list by its id"
sidebar_label: "Update a list"
hide_title: true
hide_table_of_contents: true
-api: eJytVk1v4zYQ/SvEnFqAtZ1iF13o5i5aNO0CDbZe9GDoMBbHFhOJ1JJUYlXQf18MJVtyrGRRID4YIjmaj/feDNWCIp85XQVtDSTwpVIYSBTaB7FrhA5eaAUSAh48JFv4pH3wkErwlNVOhwaSbQs7QkduXYcckm3apRIqdFhSIOejgc9yKhGSFkJTESTgg9PmABLoiGVV8JYmrYpjcyif7j/8Yo//vc+PIdjsA0fXIZpw9FsFnQRHX2vtSEESXE0SDJZsUPQGEjQXU2HIgbNha/LhV6sazuGy5E1OQmFAEayoY/kL8bcpGhFyEntNhfKisbV4QhNGG2GIFC93JCpnH7UitQAJmTWBTOAwWFWFzpDDLO89x5oBwu7uKQsgoXK2Ihc0eT7t67mGq9TmE5kDA30jocTjebVadfKysuu3TV0UuGMoe9Qm3lYX3t5Hbzqbc9NFdskw0N+N0Un4WpNrvlcLO613hc4mhjtrC0IDXfwxi76yxvcA/bxazVPZ06OihN+ODz1TaydfoOn/EvFmUPcGM01m6pK7t0RTYwESfIkucBsr2mNdBEhOZ68RdhXvFcqmLbqFOEMiWEOpk8LObtLLRoee9Xerd9dE87kwNoi9rY16O5ozq+b5LMl7PMydPas0ehjt00G7JYXcqn4mZXksn3UPS5apX7b94OqYGnKPp7FZuwISaFEpR953S6z08vEGJDyi08xETHo47lE60ZmHUPlkuQyuWTygwweiaoFVBXKmZwYPwu7j0PtrsBd9LkzEZOL/w1j2kadz/wwMR+Y6ohlrIhqBHB5+t65EzvDPfzcRPebo8zigfztdCKchOOrvMvHzdt8743psmXFv0PTEaJDuqf/M3nJIhr53f7NYLVaTu+cMyvrudhbE9d2t2Ft3iSAjzo1ifSjRTIoaLlo8zalnA+Os55dv5B7tQMewrArUhuNEwbSDuLbxOvQgIRnuxVRCbn3go7bdoacvrug63h7w2aajtqIClfb8rCDZY+HplTx/+Dx0wY/ipeyGTTRNlHBR8wokPFAz3t1d2knICRW5mEF/+LGP89OGXYwvX/V6J09vrLOMqvCqbTrpy7v15uMfLNLhG6GMkwAcPoGM/zFTGwuP2o97LRRoDnWcDNA7ZUnjZUc864BY1iwWbdtbbOwDma47QxN4zch03Tdsok9Y
+api: eJytVk1v4zYQ/SvEnFqAtZ1iF13o5gYtmnaBBqkXPRg6jMWxxUQitSQVWxX03xdDyZYdK1kUiA+GSI7m4817Q7WgyGdOV0FbAwl8qRQGEoX2QWwaoYMXWoGEgDsPyRo+ax88pBI8ZbXToYFk3cKG0JFb1iGHZJ12qYQKHZYUyPlo4LOcSoSkhdBUBAn44LTZgQQ6YFkVvKVJq+LQ7Mr946df7OG/j/khBJt94ug6RBOOfqegk+Doa60dKUiCq0mCwZINit5AguZiKgw5cDZsTT78alXDOVyWvMpJKAwoghV1LH8m/jZFI0JOYqupUF40thZ7NGG0EYZI8XJDonL2WStSM5CQWRPIBA6DVVXoDDnM/NFzrAkg7OaRsgASKmcrckGT59O+nmu4Sm0+k9kx0DcSSjycVotFJy8ru37b1EWBG4ayR+3M2+LC28foTWdTbrrYXTIM9HdjdBK+1uSa79XCTutNobMzw421BaGBLv64i76yxvcA/bxYTLeyb4+KFH6/fuiJWjv5Spv+byPeDereYEJkpi5ZvSWaGguQ4Et0gWWsaIt1ESA5nr3VsKt4r7dMQo7+1rK9dRis89NWtSf3YIs3s7Z7Q47XSgfLD8+a9nFniJ92FxNhDXFkxd4MyJ7heHprIsWzfNLLqQM9BT8sPlyzjs+FsUFsbW3U+3Eus2qaXCV5j7upsxc4RA+jfToIqaSQW9UPyCyP4LAIYc6a8fO2n6Id84Tc83GG166ABFpUypH33RwrPX++4Xag00yLmPRw3KN05FYeQuWT+Ty4ZvaEDp+IqhlWFcgJAQ8ehN3GCfzXYC/6XLgRZ9fPP4xlH/n8EjoBw5G5jmjG1ItGIIeH360rkTP8899VRI979DDeFr8db6fjRB7ZeZn4absX8rge9TvuDQI7Mxp0dBwGZms5JEPfu7+ZLWaLs4vwBMry/m4SxOX9ndhad4kgI86qtT6UaM6KGm59PA7NF9PrxOfXPw96tAMdwrwqUPfaZsK0A7nW8W5miSXDJZ1KyK0PfNS2G/T0xRVdx9sDPut05FZkoNKenxUkWyw8vZHnDw+DCn4Ur2U3bKJpIoWLmlcg4Yma8UOiS3mSESpyMYP+8LaP89OKXYwvX2m9k8c3lllGVXjTNj3T5f1ydfsHk3T4YCnjJACHe5DxP2ZqY+GR+3GvhQLNro6TAXqnTGm8VMQLBcSyJrFo295iZZ/IdN0JmsBrRqbrvgEFSoAx
sidebar_class_name: "patch api-method"
info_path: api/karakeep-api
custom_edit_url: null
@@ -62,7 +62,7 @@ Update list by its id
<StatusCodes
id={undefined}
label={undefined}
- responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"}},"required":["id","name","icon","parentId","public"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
+ responses={{"200":{"description":"The updated list","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"icon":{"type":"string"},"parentId":{"type":"string","nullable":true},"type":{"type":"string","enum":["manual","smart"],"default":"manual"},"query":{"type":"string","nullable":true},"public":{"type":"boolean"},"hasCollaborators":{"type":"boolean"},"userRole":{"type":"string","enum":["owner","editor","viewer","public"]}},"required":["id","name","icon","parentId","public","hasCollaborators","userRole"],"title":"List"}}}},"404":{"description":"List not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>
diff --git a/docs/versioned_docs/version-v0.27.0/api/update-a-tag.api.mdx b/docs/versioned_docs/version-v0.31.0/api/update-a-tag.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/update-a-tag.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/update-a-tag.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/update-user.api.mdx b/docs/versioned_docs/version-v0.31.0/api/update-user.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/update-user.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/update-user.api.mdx
diff --git a/docs/versioned_docs/version-v0.27.0/api/upload-a-new-asset.api.mdx b/docs/versioned_docs/version-v0.31.0/api/upload-a-new-asset.api.mdx
similarity index 100%
rename from docs/versioned_docs/version-v0.27.0/api/upload-a-new-asset.api.mdx
rename to docs/versioned_docs/version-v0.31.0/api/upload-a-new-asset.api.mdx
diff --git a/docs/versioned_sidebars/version-v0.27.0-sidebars.json b/docs/versioned_sidebars/version-v0.31.0-sidebars.json
similarity index 85%
rename from docs/versioned_sidebars/version-v0.27.0-sidebars.json
rename to docs/versioned_sidebars/version-v0.31.0-sidebars.json
index aa799324..40971125 100644
--- a/docs/versioned_sidebars/version-v0.27.0-sidebars.json
+++ b/docs/versioned_sidebars/version-v0.31.0-sidebars.json
@@ -5,7 +5,9 @@
"dirName": "."
},
{
- "API": [
+ "type": "category",
+ "label": "API",
+ "items": [
{
"type": "doc",
"id": "api/karakeep-api"
@@ -68,6 +70,12 @@
"label": "Detach tags from a bookmark",
"className": "api-method delete"
},
+ {
+ "type": "doc",
+ "id": "api/get-lists-of-a-bookmark",
+ "label": "Get lists of a bookmark",
+ "className": "api-method get"
+ },
{
"type": "doc",
"id": "api/get-highlights-of-a-bookmark",
@@ -273,6 +281,42 @@
"className": "api-method put"
}
]
+ },
+ {
+ "type": "category",
+ "label": "Backups",
+ "items": [
+ {
+ "type": "doc",
+ "id": "api/get-all-backups",
+ "label": "Get all backups",
+ "className": "api-method get"
+ },
+ {
+ "type": "doc",
+ "id": "api/trigger-a-new-backup",
+ "label": "Trigger a new backup",
+ "className": "api-method post"
+ },
+ {
+ "type": "doc",
+ "id": "api/get-a-single-backup",
+ "label": "Get a single backup",
+ "className": "api-method get"
+ },
+ {
+ "type": "doc",
+ "id": "api/delete-a-backup",
+ "label": "Delete a backup",
+ "className": "api-method delete"
+ },
+ {
+ "type": "doc",
+ "id": "api/download-a-backup",
+ "label": "Download a backup",
+ "className": "api-method get"
+ }
+ ]
}
]
}
diff --git a/docs/versions.json b/docs/versions.json
index 4de72d52..4ee24d5f 100644
--- a/docs/versions.json
+++ b/docs/versions.json
@@ -1,6 +1,6 @@
[
+ "v0.31.0",
"v0.30.0",
"v0.29.0",
- "v0.28.0",
- "v0.27.0"
+ "v0.28.0"
]