Back to Karakeep

Check if a URL exists in bookmarks

docs/versioned_docs/version-v0.31.0/api/check-bookmark-url.api.mdx

0.31.01.7 KB
Original Source

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={"Check if a URL exists in bookmarks"}

</Heading>

<MethodEndpoint method={"get"} path={"/bookmarks/check-url"} context={"endpoint"}

</MethodEndpoint>

Check if a URL is already bookmarked. Uses substring matching to find candidates, then normalizes URLs (ignoring hash fragments and trailing slashes) for exact comparison.

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}

</Heading>

<ParamsDetails parameters={[{"schema":{"type":"string","description":"The URL to check against existing bookmarks."},"required":true,"description":"The URL to check against existing bookmarks.","name":"url","in":"query"}]}

</ParamsDetails>

<RequestSchema title={"Body"} body={undefined}

</RequestSchema>

<StatusCodes id={undefined} label={undefined} responses={{"200":{"description":"Object indicating whether the URL is bookmarked. bookmarkId is null if not found.","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string","nullable":true,"description":"The ID of the existing bookmark, or null if the URL is not bookmarked."}},"required":["bookmarkId"]}}}},"401":{"description":"Unauthorized — the Bearer token is missing, invalid, or expired.","content":{"text/plain":{"schema":{"type":"string","example":"Unauthorized"}}}}}}

</StatusCodes>