create-a-new-highlight.api.mdx•3.64 kB
---
id: create-a-new-highlight
title: "Create a new highlight"
description: "Create a new highlight"
sidebar_label: "Create a new highlight"
hide_title: true
hide_table_of_contents: true
api: eJztVj1v2zAQ/SvCzaztFJm4uUWLph0SNC46GB7O0tlSLJEMSSUxBP734ig5khwl6JChQzdbd7yPd+8e2UBGLrWF8YVWIOGzJfSUYKLoMcmLfV4W+9yDAI97B3IN307fHGwEOEprW/gjyHUDW0JLdln7HOR6EzYCLN3X5PwnnR1BNmepVjn1GRKvkzTmBgGpVp6U5yNoTFmkyEfmd47PNeDSnCrkX/5oCCTo7R2lXKSx2pD1BTm2brU+VGgPV9nA13lbqD0EAc6j9de7nSM/sKu62pJlO6nsDWuqS21fxuVjdcVAHaks9SMwCBkI2FsiBQK2ZU2MXEY7rEsP8uQYBHh68lMhVV2WuC0JpLc1BQFKe/oLx9BOoOAK5HqIx7j7Ya9dFV2OTQhtFGe0ci2sHxcX08Ns55eNaPN/lO8zSgHFdOu1I/sKKt08lhOFvAM1YkXP+YfZNgJ84bn0Xi2gJdLlYvGSO59wwJmk04z3406qswmEg4CKnMP9lO0MnRih99+cermc6KUDMlHaJztdq+xfbySe97nOQILREXiDLOEwz3utZ6m3D2RdVPraliChwSyz5FyYoynmDxcg4AFtwayN9XbmFqTTiuTeGyfnc2+PswNaPBCZGRoDYkJRugiJ3iU+p+RH55+0tTCnBnfQLcPYycXgJnrGhDNzH9ENZOfEexx/fNW2Qq7w++9VBI7H87O/wL48YWVKOlejfmNHIrQYic7iWWR6LWkVYrDwUQgGUy3UTnM2Rr2F5GK2mC2g365nPJY3V5P4LW+ukp22Y/AY7CDirCuMBFQYAXn17h8Fbno6v/FaaCHnHuemxEJFqWLWNB271pCPXhI5U0+uoWm26OiXLUPgz/c1WX5dbHpuxceFgJwwIxvpeKAjF9OW9WHFudmd5Vm+3LggTieWaUrGv+m7GWzHzfXtiunSvWaquI5gMd4M+AgSQICOMEUWxm8NlKj2dVxPaGMyuXDMzTMuxq46E6rjoMKmaT1W+kAqBBBdK57/Q+CN/gPpI19E
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 highlight"}
>
</Heading>
<MethodEndpoint
method={"post"}
path={"/highlights"}
context={"endpoint"}
>
</MethodEndpoint>
Create a new highlight
<Heading
id={"request"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Request"}
>
</Heading>
<ParamsDetails
parameters={undefined}
>
</ParamsDetails>
<RequestSchema
title={"Body"}
body={{"description":"The highlight to create","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true}},"required":["bookmarkId","startOffset","endOffset","text","note"]}}}}}
>
</RequestSchema>
<StatusCodes
id={undefined}
label={undefined}
responses={{"201":{"description":"The created highlight","content":{"application/json":{"schema":{"type":"object","properties":{"bookmarkId":{"type":"string"},"startOffset":{"type":"number"},"endOffset":{"type":"number"},"color":{"type":"string","enum":["yellow","red","green","blue"],"default":"yellow"},"text":{"type":"string","nullable":true},"note":{"type":"string","nullable":true},"id":{"type":"string"},"userId":{"type":"string"},"createdAt":{"type":"string"}},"required":["bookmarkId","startOffset","endOffset","text","note","id","userId","createdAt"],"title":"Highlight"}}}},"400":{"description":"Bad highlight request","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}},"404":{"description":"Bookmark not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"]}}}}}}
>
</StatusCodes>