summarize-a-bookmark.api.mdx•3.39 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: eJytVUuP2zgM/isGT1tAiNNFFy18Sw8FpnvYwc4seghyYCwm1sSWXIlOkxr67wvKzmvGfRzmZFvi4+PHj3QPmkLpTcvGWShgwYxlRSHDLHRNg/6Yscu4omzt3K5Bv8vQ6swTd96GdNG1GpnkrHRez0AB4zZAsYSPo0uAlYJAZecNH6FY9rAm9OQXHVdQLFdxpaBFjw0x+ZAMQllRg1D0wMeWoIDA3tgtKKADNm0tR4aMrg/HbfPt6cN7d/j+V3VgduUHQWA4mZwQ3GmICjx97YwnDQX7jhRYbMRofTFSYISFFrkCQeUptM4GCoLkz/lcHreEPV4xcKbom+HqxB8oKJ1lsizO2La1KVGc86cgESZqdesnKhkUtN615NkM+Y1+yUdUUHqS7AuevG2cNhszfa3AdnWNa6FKGIln4n7DEn1ZmT1dY1o7VxNaSbvBvZN2/+iecbs1dvvAyF34dT4FZLtGNBW6sqQQQFKYuvMkNJHV4rWKCgbWzfdE8euHt45/j55T939teyPMpXT5uqc3Hbxi/Ybi53xO07CKUZK9m797KePToGTWcbZxndWvp9vS6QnORJsUAm6n7p5xkiJc7FMhyZ8rp2VeXUhpZWwLyE9zGPL+MtsxP3EioQL5/WnXdL6GAnrU2lMIMcfW5Pu3oGCP3kijUhXj9UDdBruaoYCKuQ1FnrM/znbocUfUzrBtQU2siTFC5jZpb/492mcDFogxXq3JByF3yHy9LM9MSWapI5nJbCUjUOPLJ+cbFISfvzwmOo3dOHGXqgdIb2fz2fxqV57xLO7vJvEv7u+yjfO34KXYqFIHGkyyGLfqw4ntDM+L8XnY/iKxV/rzDOQwHThvazRp16T+9qM6lud1L2NS3Oz+i0BWCirRVLGEvl9joP98HaMcf+1Ipnq5usgjiUibIO8aig3WgX5S6B//jsp+k/0I8XiI9phUWHfyBQp2dLz9X0XZSRWhJp9QDAaLsqSWr1xfTK8o7Tw99/88PMpquRXYM0Gl8JO4+n6weHQ7sjGeYbJ8C8IY/wc5POmb
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"]},"summarizationStatus":{"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","summarizationStatus"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>