create-a-new-bookmark.api.mdx•6.82 kB
---
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>