diff options
Diffstat (limited to 'docs/versioned_docs/version-v0.25.0/API/create-a-new-bookmark.api.mdx')
| -rw-r--r-- | docs/versioned_docs/version-v0.25.0/API/create-a-new-bookmark.api.mdx | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/versioned_docs/version-v0.25.0/API/create-a-new-bookmark.api.mdx b/docs/versioned_docs/version-v0.25.0/API/create-a-new-bookmark.api.mdx new file mode 100644 index 00000000..1d398219 --- /dev/null +++ b/docs/versioned_docs/version-v0.25.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: eJzVWFtv6zYM/isBn7UmHfbkt/RgA7rbKdYOewj8wNhMrBNb8pHktDmG//ugS20nVVpnLYYNBQpHIkXqE0l9VAs56Uzx2nApIIFPitDQDGeCHmdrKXcVqh0wMLjVkKzgJgxpSBloyhrFzQGSVQtrQkVq2ZgCklXapQwUfW1ImxuZHyBpTww9FNSvPzNyljnDwCCTwpAwVgPruuQZWo35F23VWtBZQRW62bL8vHGmzaEmSECuv1BmgEGtZE3KcNJWznBTkvvwYtooLrbAQDRliWs7Z1RDDCp8+pXE1m7gerFYdAxQZQXfUz7SXktZEgroGGxwL+3+z80LaSJ2Owa6qSpUh+icxyFfmrc97rqOtSAFTYPBzb5ck0RT2ZMtudhB2jFoVBmT20hVoYEEGsWto7WiTOFjSfnSo3SbRzbU+TDgyoK08rPeRGqdf5/Lhp6Mc9l9RJGWjcroz9iOzrj2vOZ7fUOtyTvnvh7eEOcVbq35Ot8MSlFEGWx4Sb9jdSa2Lt7x4N9gNu3sX+c1dC2F9rv+fnEdT+UQtuOSMTmRXweax0F4JU86BpXM+YZPTCM2tUS8uyIY3G652N4bNI2eUpKew0M3WUZa2zREXjbKhQqJ3GqlfUXh3xzEH798vJJF4Dlb2WKguyulF0Sl8AAMuKFK/+OwEOfyAo3BrKD8Jupcn7UcGBRNhQLS03ThOYT1j1ZzcqNY/3fq8UVBe5SuE+RdMYqWkHPCy3PlKhYjmSISupDmEq1NU5Z31pJPwEtUX9xUlyjveU7yIkdxz7OJQBemKj8NofOm/PM2pkljYwqppkHUrEuuC5omnaOhu6AxDRSr8VuoyVOIzX+WNUx09X/NImI5ewEiDDT/Nl5WNNWaVDSeJ8f+JdTl3ag3YifkY+QKcAqWGQVzH39/TTrmoYI+7/t+PLJGIUjdhlg4KZwQSpqVC1zNVTeI1Embc+egcLfh4G3aRQUGlnbEyUY86og0nTKkOLEJ1GEIn/400v5W7BtV8Cz2h8XiJXG9wXwWmtSP46uZzOMMpCKt7ZG8ycvdCoO84+FO3xQyhwRq6fyt0XaqMF/3LbntyNWelHb0w/EGaDHPFWndzbHm8/21PX9U3KaWczdMe3A22JS2xSuMqXUynxt1uNqhwh1RfYV1DSxC/cMKM7mZmYJmvwT5mffF4j96Kri3KHrL4weDHhJr2e7DiVny7IRssLqPn56b0J//enC42dP5Y3hn+PEJqzqwohAIffYM1N2T3zFZ9yOe5g4aPZsdhkZtxzAYfHeMLfC1YTLaJ4/CgouNtP7ac/OgXl8trhYwhHKP6PLuNnoCy7vb2UaqY/jtcdmbXWpj6WzSBm589onnhCX26XD+Tchv295187pE7lqcwFZ9cK5gPX4vKmzgJito2zVqe5t0nR3+2pAFeZUOoemekBgUhLnlJKsWdmTPIZCl70LN32PZuNp7mq/2DvAayyyj2rwqm45y6+7z/YMrjf7NqnLJDAofgbn/CQAD6UByQezGWihRbBuX3ODX7AL/GveBx6E8bhFQHEYetq2XeJA7El0HLGzF2N/g+vK/AWXoz2M= +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}}},{"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},"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":["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 |
