summarize-a-bookmark.api.mdx•3.26 kB
---
id: summarize-a-bookmark
title: "Summarize a bookmark"
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: eJytVU2P2zYQ/SvCnFqAsJwiRQPdnEOBbQ9ddLfowfBhLI4triWSIUeOHYH/vRhK/tp1mhxyksT5evP4ZjSAplgH49k4CxUsmLFuKBZYxL7rMBwLdgU3VKyd23UYdgVaXQTiPtiYDb3XyCRntQt6BgoYtxGqJXycQiKsFESq+2D4CNVygDVhoLDouYFquUorBR4DdsQUYnaIdUMdQjUAHz1BBZGDsVtQQAfsfCtHhoxuD8dt9/nlw2/u8OXX5sDs6g+CwHB2OSF40JAUBPrUm0AaKg49KbDYidP64qTACAseuQFBFSh6ZyNFQfLLfC6PW8Kerxg4U/TZcHPiDxTUzjJZlmD0vjU1SnD5EiXDnV7d+oVqBgU+OE+BzVjf6Ld8JAV1IKm+4LvWzmmzMffNCmzftrgWqoSRdCbuOzwx1I3Z0zWmtXMtoZWyG9w7ue6v2Rm3W2O3T4zcx2/XU0C270RTsa9rihGkhGn7QEITWS1Rq6TAOv4+/Kfr+bbvjXKWcg3XpN9QfEXLDQevG16lJGnfz9+/VdRJs4V1XGxcb/WPk1Dt9B12RCYUI27v2V51nzNc/HMjOZ4bp2V0XMxlZYIqKE8jEcvhMmapHMk3XyRVpLA/jX0fWqhgQK0DxZhK9KbcvwMFewxGriR3MZlH6jbYtwwVNMw+VmXJ4TjbYcAdkZ+h96DuTOyUoXCbvML+nPyLEQuklK421pOQO1a+3ltnpqSy9JHdRObZCdT08rsLHQrCP/59znQau3ESLl2PkN7N5rP51do641k8PtzFv3h8KDYu3IKXZpPKN9BhlsW04J5ObBd43lGv0w4Xif2gn8BIDtOBS9+iyWOf73eY1LE8b14Z5+pmDV8EslLQiKaqJQzDGiP9E9qU5PhTTzK/y9VFHllE2kR511BtsI30P43+9Pek7J+LryGeDtEeswrbXr5AwY6Ot7+OJNunIdQUMorRYVHX5Pkq9M30itLO0/P419OzLJFbgb0SVE5/F9cwjB7Pbkc2pTNMlm9BmNJ/SMy/hg==
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={"Summarize a bookmark"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/bookmarks/{bookmarkId}/summarize"}
context={"endpoint"}
>
</MethodEndpoint>
Attaches a summary to the bookmark and returns the updated record.
<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 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"]},"note":{"type":"string","nullable":true},"summary":{"type":"string","nullable":true}},"required":["id","createdAt","modifiedAt","archived","favourited","taggingStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>