diff options
| author | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
|---|---|---|
| committer | Mohamed Bassem <me@mbassem.com> | 2025-11-08 21:29:59 +0000 |
| commit | d9ef832e0b4fb04909a848ae948e22a01613c3b7 (patch) | |
| tree | 1e977b94fca1a36eff16df56535271e8ab0b5e8e /docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx | |
| parent | 7339d1dfcde77d8945534180f8780ed6cc2063c5 (diff) | |
| download | karakeep-d9ef832e0b4fb04909a848ae948e22a01613c3b7.tar.zst | |
release(docs): release the 0.28 docs
Diffstat (limited to 'docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.28.0/api/create-a-new-bookmark.api.mdx new file mode 100644 index 00000000..2b078007 --- /dev/null +++ b/docs/versioned_docs/version-v0.28.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: eJztWktv2zgQ/ivGnLWxU+zJN6fYYrOvBpsUezB8GElji7VEqiTlxBX03xdD0pacSrHdBMUuYAQIFHGGM5znR01qSMkkWpRWKAlTeK8JLY1wJOlxFCu1LlCvIQKLKwPTOdyEVwYWERhKKi3sFqbzGmJCTXpW2Qym80WziEDTl4qMvVHpFqb1M0EPGe33H1k1SpxgiCBR0pK0zIFlmYsEmWP82TBbDSbJqEC3mucfl0603ZYEU1DxZ0osRFBqVZK2ggzTWWFzcg+ezFgt5AoikFWeY8xrVlcUQYFPf5Bc8QGuJ5NJEwHqJBMbSjvcsVI5oYQmgiVuFJ9/aF0q2yO3icBURYF627vm7ZDO7HGNHTU+5ndaKO+GbzlIVgX7LVePzK90gTksmghEUSpt78kYoeRt2q+nqnTSa7rdtlgKiOCRYnZczs+FikXOfqQnS5I3hwiMkKucln5BGwM7+bBomiaqQUk6zZdu9YVjCrl2x6t03ke3ZANYmEKlBZ+w1ORMSOnMu7rXEo2PZaHZ03O/6kUsWPnXqWzpyTqV3cOwGz71nWhAtd2er9UNjSGvnHt6OEIuClyx+DJdtkwDscXB8BcWAwly9olb/Vqxi4Z/Gs9hSiWNP/W7yeRIPcJcE6bbET0JY805Relle4t+W7yQ8w1nVCqW4uSScGK5e3V1s7haCbm6t2grc1xeGyWmShJyNWCJIq+0ixiSKXMt9tVRfHUmfvvt+6tyj3kGq3Qf7WClHFLzDSrnrivvhaLWuGUKS4X57miUQ1mJ1mKSUXrzYqdBPktWFSi5uB8mq0gh7H+wm6PrpNiP6QZn5cpBsTiB3pXC3gI2RDwbKpZ94ZZoImkyZc/hWlZ5fseSfN6fw/pNnzyHeSNSUmcpihuRnGjozBb5+zZ0jiMmT3uOOruTnyYAK5spfZpVqzgXJqPTqFO0dBc4TlOcOf4M3eMEhv8uzDlR1f817BnsKqdWESO+dreVVRGTfiEFvtvM/Vjr1Vav5Fqqx56u4RgYygVxb9/yTnIzd5NfO9WmW4Z3lrjvvolRStK3ITqeVV8IdZHpAux0NQl6ii1noSH9qcwVpsQ9tLXVWSHV147bsy+aXoIWnR5g0Q5+PACLz5FhP6AL2KUNxr1vF/u2vP/YAB7Ev5tcH8HtK2XDh4T0AtovoP0C2i+g/QLaL6D9AtovoP0C2i+g/QLafzxo/7nvY/sNpqMwHXw7nJ6otB8CFWQMu/PoLMHt0NK72YHjt5lKYQqlcvqWyCNCGMf7WSiPQvWGtHH4xwEXqDFNNRnTjLEU4801xw5qwY516oZlb5wlVjmPpTJrSzMdj63eXq1R45qovMKyhKjn2hN2GKnlyGY0+j3Qj7wubP/OjPaeregldye1e5OwZJcdTMaXBkfEge4ePuwGZ7/98+Dsxt75ux3w/vKERRlgWQiEfTy3VxaPpruXFP/Gw/uWY4/i21ed61b35cH4M0w5vxltdjYOkD8g+XB2BzkD4Gxpe2eDnbAScqn4vOx375Trq8nVBNpU2Htkdnfb68HZ3e1oqfSh+9jdjDOUsYzHp3UA94Oz+Wcwd59Ow8N8f2zuvOMyR+GuhgFu++CeQ9wd9Gcc+NM51HWMhntb0/DrLxWxk+aLNrTd7D+CjDBlhDSvYU3smVB/fwodaIN55d3wLN+5I3mOWZJQaV+kXXRy8+7j/YMry/6fDQpXDEAjBwT/ngJEoJyRXBK4dzXkKFeVKw7g92wCGuzenw9ToXvHQbntaFjXnuJBrUk2DUThKJb/BjeL/Bepno+R +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"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"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"]},"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"attachedBy":{"type":"string","enum":["ai","human"]}},"required":["id","name","attachedBy"]}},"content":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["link"]},"url":{"type":"string"},"title":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"imageUrl":{"type":"string","nullable":true},"imageAssetId":{"type":"string","nullable":true},"screenshotAssetId":{"type":"string","nullable":true},"fullPageArchiveAssetId":{"type":"string","nullable":true},"precrawledArchiveAssetId":{"type":"string","nullable":true},"videoAssetId":{"type":"string","nullable":true},"favicon":{"type":"string","nullable":true},"htmlContent":{"type":"string","nullable":true},"contentAssetId":{"type":"string","nullable":true},"crawledAt":{"type":"string","nullable":true},"author":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"datePublished":{"type":"string","nullable":true},"dateModified":{"type":"string","nullable":true}},"required":["type","url"]},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"text":{"type":"string"},"sourceUrl":{"type":"string","nullable":true}},"required":["type","text"]},{"type":"object","properties":{"type":{"type":"string","enum":["asset"]},"assetType":{"type":"string","enum":["image","pdf"]},"assetId":{"type":"string"},"fileName":{"type":"string","nullable":true},"sourceUrl":{"type":"string","nullable":true},"size":{"type":"number","nullable":true},"content":{"type":"string","nullable":true}},"required":["type","assetType","assetId"]},{"type":"object","properties":{"type":{"type":"string","enum":["unknown"]}},"required":["type"]}]},"assets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"assetType":{"type":"string","enum":["linkHtmlContent","screenshot","assetScreenshot","bannerImage","fullPageArchive","video","bookmarkAsset","precrawledArchive","userUploaded","unknown"]},"fileName":{"type":"string","nullable":true}},"required":["id","assetType"]}}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus","summarizationStatus","tags","content","assets"],"title":"Bookmark"}}}},"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 |
