Custom Annotation ID. If not provided, Velt will generate a unique ID for the annotation.
Object
Show properties
string
required
Location ID
string
Location Name
Object
Target Element
Show properties
string
Element DOM Id
string
Target Text. Provide this if you want to add comment annotation on the provided text content.
number
Occurrence. Provide this if you want to add comment annotation on a text content.
boolean
Select All Content. Provide this if you want to select and add comment annotation on the entire text content of the target elementId.
Object[]
required
Array of Comment Data
Show properties
number
Custom Comment ID. If not provided, Velt will generate a unique ID for the comment.
string
Comment content in plain text string
string
Comment content in HTML string
boolean
Use this for self-hosting comments data. Set this as true if you are comments resolver data provider in the SDK.
boolean
Use this for self-hosting comments data. Set this as true if this comment will have text content. Sometimes, comments might only have attachments and in that case, set this as false.
User
required
User object from whom the comment is added
number
Created At timestamp (in milliseconds since epoch).
number
Last Updated timestamp (in milliseconds since epoch).
Object[]
Array of tagged user contacts
Show properties
string
required
Display text of the tagged user (e.g. “@Username”)
string
required
User ID of the tagged user
Object
required
Show properties
string
required
Email of the tagged user
string
required
Name of the tagged user
string
required
User ID of the tagged user
Status
Status
Show properties
string
required
Status ID
string
required
Status Name
'default' | 'ongoing' | 'terminal'
required
Type.
string
required
Text and comment pin color
string
required
Background color on the status indicator
string
Raw SVG of the icon. Either svg or iconUrl is required.
string
Icon URL. Either svg or iconUrl is required.
User
User object to whom the comment is assigned
Object
Custom key/value metadata object
number
Created At timestamp (in milliseconds since epoch).
number
Last Updated timestamp (in milliseconds since epoch).
Object
Priority
Show properties
string
required
Priority ID
string
required
Priority Color
string
required
Priority Name
string
required
Priority Light Color
Example Requests
Add comment annotation by organizationId, documentId and location
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Velt","colors":{"primary":"#272728","light":"#D5D5D5","dark":"#000000"},"logo":{"light":"https://mintcdn.com/velt/gY7ilEx2g4g3-HVe/velt-logo-big-light.png?fit=max\u0026auto=format\u0026n=gY7ilEx2g4g3-HVe\u0026q=85\u0026s=c75fd62a074f53174a364509b4363fdc","dark":"https://mintcdn.com/velt/gY7ilEx2g4g3-HVe/velt-logo-big.png?fit=max\u0026auto=format\u0026n=gY7ilEx2g4g3-HVe\u0026q=85\u0026s=3b5f452918e68f127b7dcae71c396463","href":"https://docs.velt.dev"},"favicon":"https://mintcdn.com/velt/gY7ilEx2g4g3-HVe/velt-favi.png?fit=max\u0026auto=format\u0026n=gY7ilEx2g4g3-HVe\u0026q=85\u0026s=5ddfb042b3fd320882626c440411bd95","api":{"playground":{"display":"interactive"}},"appearance":{"default":"dark"},"background":{"color":{"dark":"#090014"}},"navbar":{"primary":{"type":"button","label":"Get API Key","href":"https://console.velt.dev/"}},"footer":{"socials":{"twitter":"https://twitter.com/veltjs","linkedin":"https://www.linkedin.com/company/veltjs"}},"search":{"prompt":"Search or ask..."},"seo":{"metatags":{"og:image":"https://firebasestorage.googleapis.com/v0/b/snippyly.appspot.com/o/external%2Fvelt_docs.png?alt=media\u0026token=9e4502da-66ef-4005-9124-dbc76f04b1fd","twitter:image":"https://firebasestorage.googleapis.com/v0/b/snippyly.appspot.com/o/external%2Fvelt_docs.png?alt=media\u0026token=9e4502da-66ef-4005-9124-dbc76f04b1fd","twitter:card":"summary_large_image"},"indexing":"all"},"integrations":{"intercom":{"appId":"fxx14qnk"},"mixpanel":{"projectToken":"6fe5c5cd3adeb341288776482e7bb147"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"velt","hasAudioNarration":false,"actualSubdomain":"velt","customDomains":["velt.dev"],"gitSource":{"type":"github","owner":"velt-js","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afe47d15fdab1c8edbdb513","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API Reference","count":218},{"language":"default","tag":"REST APIs","count":215},{"language":"default","tag":"v2","count":170},{"language":"default","tag":"Documentation","count":168},{"language":"default","tag":"UI Customization","count":125},{"language":"default","tag":"Comments","count":94},{"language":"default","tag":"Release Notes","count":90},{"language":"default","tag":"Components: Async Collaboration","count":75},{"language":"default","tag":"Async Collaboration","count":62},{"language":"default","tag":"Realtime Collaboration","count":46}],"searchSettings":{"showContentSnippets":true,"isFiltersEnabled":true}},"assistantConfig":{"enableAskAiButton":true,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"rakesh@velt.dev","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":""},{"filePath":"style.css","content":"::-webkit-scrollbar{display:none}*{-ms-overflow-style:none;scrollbar-width:none}th{text-align:left}.update-container .relative{max-width:525px!important}#table-of-contents-content{overflow-x:clip;height:100%}"},{"filePath":"public/custom.css","content":""}],"page":{"pagePath":"api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations","slug":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations","pageMetadata":{"title":"Add Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/add","description":null,"href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Expandable,Heading,ParamField}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Expandable)_missingMdxReference(`Expandable`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Use this API to add comment annotations to a document within an organization.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`You can add comments on an elemement, text or page.`}),`\n`,_jsx(_components.li,{children:`You can provide HTML or text content.`}),`\n`,_jsx(_components.li,{children:`Additional filters can be applied using location IDs.`}),`\n`]}),`\n`,_jsx(Heading,{level:`1`,id:`endpoint`,children:`Endpoint`}),`\n`,_jsx(_components.p,{children:_jsx(_components.code,{children:`POST https://api.velt.dev/v1/commentannotations/add`})}),`\n`,_jsx(Heading,{level:`1`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`x-velt-api-key`,type:`string`,required:true,id:`param-x-velt-api-key`,children:_jsx(_components.p,{children:`Your API key.`})}),`\n`,_jsx(ParamField,{header:`x-velt-auth-token`,type:`string`,required:true,id:`param-x-velt-auth-token`,children:_jsxs(_components.p,{children:[`Your `,_jsx(_components.a,{href:`/security/auth-tokens`,children:`Auth Token`}),`.`]})}),`\n`,_jsx(Heading,{level:`1`,id:`body`,children:`Body`}),`\n`,_jsx(Heading,{level:`4`,id:`params`,children:`Params`}),`\n`,_jsx(ParamField,{body:`data`,type:`Object`,required:true,id:`param-data`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`organizationId`,type:`string`,required:true,id:`param-organization-id`,children:_jsx(_components.p,{children:`Organization ID`})}),_jsx(ParamField,{body:`documentId`,type:`string`,required:true,id:`param-document-id`,children:_jsx(_components.p,{children:`Document ID`})}),_jsx(ParamField,{body:`commentAnnotations`,type:`Object[]`,required:true,id:`param-comment-annotations`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`annotationId`,type:`string`,id:`param-annotation-id`,children:_jsx(_components.p,{children:`Custom Annotation ID. If not provided, Velt will generate a unique ID for the annotation.`})}),_jsx(ParamField,{body:`location`,type:`Object`,id:`param-location`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id`,children:_jsx(_components.p,{children:`Location ID`})}),_jsx(ParamField,{body:`locationName`,type:`string`,id:`param-location-name`,children:_jsx(_components.p,{children:`Location Name`})})]})}),_jsxs(ParamField,{body:`targetElement`,type:`Object`,id:`param-target-element`,children:[_jsx(_components.p,{children:`Target Element`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`elementId`,type:`string`,id:`param-element-id`,children:_jsx(_components.p,{children:`Element DOM Id`})}),_jsx(ParamField,{body:`targetText`,type:`string`,id:`param-target-text`,children:_jsx(_components.p,{children:`Target Text. Provide this if you want to add comment annotation on the provided text content.`})}),_jsx(ParamField,{body:`occurrence`,type:`number`,id:`param-occurrence`,children:_jsx(_components.p,{children:`Occurrence. Provide this if you want to add comment annotation on a text content.`})}),_jsx(ParamField,{body:`selectAllContent`,type:`boolean`,id:`param-select-all-content`,children:_jsx(_components.p,{children:`Select All Content. Provide this if you want to select and add comment annotation on the entire text content of the target elementId.`})})]})]}),_jsxs(ParamField,{body:`commentData`,type:`Object[]`,required:true,id:`param-comment-data`,children:[_jsx(_components.p,{children:`Array of Comment Data`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`commentId`,type:`number`,id:`param-comment-id`,children:_jsx(_components.p,{children:`Custom Comment ID. If not provided, Velt will generate a unique ID for the comment.`})}),_jsx(ParamField,{body:`commentText`,type:`string`,id:`param-comment-text`,children:_jsx(_components.p,{children:`Comment content in plain text string`})}),_jsx(ParamField,{body:`commentHtml`,type:`string`,id:`param-comment-html`,children:_jsx(_components.p,{children:`Comment content in HTML string`})}),_jsx(ParamField,{body:`isCommentResolverUsed`,type:`boolean`,id:`param-is-comment-resolver-used`,children:_jsx(_components.p,{children:`Use this for self-hosting comments data. Set this as true if you are comments resolver data provider in the SDK.`})}),_jsx(ParamField,{body:`isCommentTextAvailable`,type:`boolean`,id:`param-is-comment-text-available`,children:_jsx(_components.p,{children:`Use this for self-hosting comments data. Set this as true if this comment will have text content. Sometimes, comments might only have attachments and in that case, set this as false.`})}),_jsx(ParamField,{body:`from`,type:`User`,required:true,id:`param-from`,children:_jsx(_components.p,{children:`User object from whom the comment is added`})}),_jsx(ParamField,{body:`createdAt`,type:`number`,id:`param-created-at`,children:_jsx(_components.p,{children:`Created At timestamp (in milliseconds since epoch).`})}),_jsx(ParamField,{body:`lastUpdated`,type:`number`,id:`param-last-updated`,children:_jsx(_components.p,{children:`Last Updated timestamp (in milliseconds since epoch).`})}),_jsxs(ParamField,{body:`taggedUserContacts`,type:`Object[]`,id:`param-tagged-user-contacts`,children:[_jsx(_components.p,{children:`Array of tagged user contacts`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`text`,type:`string`,required:true,id:`param-text`,children:_jsx(_components.p,{children:`Display text of the tagged user (e.g. “@Username”)`})}),_jsx(ParamField,{body:`userId`,type:`string`,required:true,id:`param-user-id`,children:_jsx(_components.p,{children:`User ID of the tagged user`})}),_jsx(ParamField,{body:`contact`,type:`Object`,required:true,id:`param-contact`,children:_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`email`,type:`string`,required:true,id:`param-email`,children:_jsx(_components.p,{children:`Email of the tagged user`})}),_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name`,children:_jsx(_components.p,{children:`Name of the tagged user`})}),_jsx(ParamField,{body:`userId`,type:`string`,required:true,id:`param-user-id-1`,children:_jsx(_components.p,{children:`User ID of the tagged user`})})]})})]})]})]})]}),_jsxs(ParamField,{body:`status`,type:`Status`,id:`param-status`,children:[_jsx(_components.p,{children:`Status`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-1`,children:_jsx(_components.p,{children:`Status ID`})}),_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name-1`,children:_jsx(_components.p,{children:`Status Name`})}),_jsx(ParamField,{body:`type`,type:`'default' | 'ongoing' | 'terminal'`,required:true,id:`param-type`,children:_jsx(_components.p,{children:`Type.`})}),_jsx(ParamField,{body:`color`,type:`string`,required:true,id:`param-color`,children:_jsx(_components.p,{children:`Text and comment pin color`})}),_jsx(ParamField,{body:`lightColor`,type:`string`,required:true,id:`param-light-color`,children:_jsx(_components.p,{children:`Background color on the status indicator`})}),_jsx(ParamField,{body:`svg`,type:`string`,id:`param-svg`,children:_jsxs(_components.p,{children:[`Raw SVG of the icon. Either `,_jsx(_components.code,{children:`svg`}),` or `,_jsx(_components.code,{children:`iconUrl`}),` is required.`]})}),_jsx(ParamField,{body:`iconUrl`,type:`string`,id:`param-icon-url`,children:_jsxs(_components.p,{children:[`Icon URL. Either `,_jsx(_components.code,{children:`svg`}),` or `,_jsx(_components.code,{children:`iconUrl`}),` is required.`]})})]})]}),_jsx(ParamField,{body:`assignedTo`,type:`User`,id:`param-assigned-to`,children:_jsx(_components.p,{children:`User object to whom the comment is assigned`})}),_jsx(ParamField,{body:`context`,type:`Object`,id:`param-context`,children:_jsx(_components.p,{children:`Custom key/value metadata object`})}),_jsx(ParamField,{body:`createdAt`,type:`number`,id:`param-created-at-1`,children:_jsx(_components.p,{children:`Created At timestamp (in milliseconds since epoch).`})}),_jsx(ParamField,{body:`lastUpdated`,type:`number`,id:`param-last-updated-1`,children:_jsx(_components.p,{children:`Last Updated timestamp (in milliseconds since epoch).`})}),_jsxs(ParamField,{body:`priority`,type:`Object`,id:`param-priority`,children:[_jsx(_components.p,{children:`Priority`}),_jsxs(Expandable,{title:`properties`,children:[_jsx(ParamField,{body:`id`,type:`string`,required:true,id:`param-id-2`,children:_jsx(_components.p,{children:`Priority ID`})}),_jsx(ParamField,{body:`color`,type:`string`,required:true,id:`param-color-1`,children:_jsx(_components.p,{children:`Priority Color`})}),_jsx(ParamField,{body:`name`,type:`string`,required:true,id:`param-name-2`,children:_jsx(_components.p,{children:`Priority Name`})}),_jsx(ParamField,{body:`lightColor`,type:`string`,required:true,id:`param-light-color-1`,children:_jsx(_components.p,{children:`Priority Light Color`})})]})]})]})})]})}),`\n`,_jsx(Heading,{level:`2`,id:`example-requests`,children:_jsx(_components.strong,{children:`Example Requests`})}),`\n`,_jsx(Heading,{level:`4`,id:`add-comment-annotation-by-organizationid-documentid-and-location`,children:`Add comment annotation by organizationId, documentId and location`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`31`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`31`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"organizationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourOrganizationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"documentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourDocumentId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commentAnnotations\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"location\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourLocationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"locationName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourLocationName\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targetElement\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"elementId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourElementId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"targetText\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Your Target Text\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"occurrence\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"selectAllContent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commentData\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commentText\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Sample Comment\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commentHtml\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"\u003cdiv>Sample Comment\u003c/div>\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"from\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"userId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourUserId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourUserName\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"yourUserEmail\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`1`,id:`response`,children:`Response`}),`\n`,_jsx(Heading,{level:`4`,id:`success-response`,children:`Success Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`17`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`17`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"result\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Comment Annotation(s) added successfully.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"-O0mpUziLcBwzREvZKs6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"annotationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"-O0mpUziLcBwzREvZKs6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"commentIds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 126535`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Added Successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`]})})}),`\n`,_jsx(Heading,{level:`4`,id:`failure-response`,children:`Failure Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`6`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`6`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"ERROR_MESSAGE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"INVALID_ARGUMENT\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/add","description":null,"href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[344,348,",ResponseExample}=_c"],[570,585,"if(!ResponseExample)_missingMdxReference(`ResponseExample`,true);return _jsxs(_F"],[25762,26190,",`\n`,_jsx(ResponseExample,{children:_jsx(CodeBlock,{filename:``,numberOfLines:`16`,language:`javascript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`javascript`,children:_jsxs(_components.code,{language:`javascript`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"result\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Comment Annotation(s) added successfully.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"data\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"-O0mpUziLcBwzREvZKs6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"annotationId\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"-O0mpUziLcBwzREvZKs6\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"commentIds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:` 126535`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`:`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Added Successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}"]]},"mdxExtracts":{"tableOfContents":[{"title":"Endpoint","slug":"endpoint","depth":1,"children":[]},{"title":"Headers","slug":"headers","depth":1,"children":[]},{"title":"Body","slug":"body","depth":1,"children":[{"title":"Params","slug":"params","depth":4,"children":[]}]},{"title":"Example Requests","slug":"example-requests","depth":2,"children":[{"title":"Add comment annotation by organizationId, documentId and location","slug":"add-comment-annotation-by-organizationid-documentid-and-location","depth":4,"children":[]}]},{"title":"Response","slug":"response","depth":1,"children":[{"title":"Success Response","slug":"success-response","depth":4,"children":[]},{"title":"Failure Response","slug":"failure-response","depth":4,"children":[]}]}],"codeExamples":{"response":{"type":"ResponseExample","children":[{"filename":"","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"javascript\">\u003ccode language=\"javascript\" numberOfLines=\"16\">\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">{\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"result\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">: {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"status\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Comment Annotation(s) added successfully.\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"data\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"-O0mpUziLcBwzREvZKs6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> {\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"success\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> true\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"annotationId\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"-O0mpUziLcBwzREvZKs6\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">,\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"commentIds\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> [\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#B5CEA8\"> 126535\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> ],\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"message\"\u003c/span>\u003cspan style=\"color:#1F2328;--shiki-dark:#9CDCFE\">:\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> \"Added Successfully\"\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\"> }\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#1F2328;--shiki-dark:#D4D4D4\">}\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}},"endpoint":{"title":"Add Comment Annotations","path":"/v1/commentannotations/add","servers":[{"url":"https://api.velt.dev"}],"method":"post","request":{"security":[],"parameters":{"query":{},"header":{"x-velt-api-key":{"schema":[{"type":"string","description":"Your API key.","required":true}]},"x-velt-auth-token":{"schema":[{"type":"string","description":"Your Auth Token .","required":true}]}},"cookie":{},"path":{}},"body":{"application/json":{"schemaArray":[{"type":"object","properties":{"data":[{"type":"object","properties":{"organizationId":[{"type":"string","description":"Organization ID","required":true}],"documentId":[{"type":"string","description":"Document ID","required":true}],"commentAnnotations":[{"type":"array","items":[{"type":"object","properties":{"annotationId":[{"type":"string","description":"Custom Annotation ID. If not provided, Velt will generate a unique ID for the annotation."}],"location":[{"type":"object","properties":{"id":[{"type":"string","description":"Location ID","required":true}],"locationName":[{"type":"string","description":"Location Name"}]}}],"targetElement":[{"type":"object","properties":{"elementId":[{"type":"string","description":"Element DOM Id"}],"targetText":[{"type":"string","description":"Target Text. Provide this if you want to add comment annotation on the provided text content."}],"occurrence":[{"type":"number","description":"Occurrence. Provide this if you want to add comment annotation on a text content."}],"selectAllContent":[{"type":"boolean","description":"Select All Content. Provide this if you want to select and add comment annotation on the entire text content of the target elementId."}]},"description":"Target Element"}],"commentData":[{"type":"array","items":[{"type":"object","properties":{"commentId":[{"type":"number","description":"Custom Comment ID. If not provided, Velt will generate a unique ID for the comment."}],"commentText":[{"type":"string","description":"Comment content in plain text string"}],"commentHtml":[{"type":"string","description":"Comment content in HTML string"}],"isCommentResolverUsed":[{"type":"boolean","description":"Use this for self-hosting comments data. Set this as true if you are comments resolver data provider in the SDK."}],"isCommentTextAvailable":[{"type":"boolean","description":"Use this for self-hosting comments data. Set this as true if this comment will have text content. Sometimes, comments might only have attachments and in that case, set this as false."}],"from":[{"type":"object","properties":{},"description":"User object from whom the comment is added","required":true}],"createdAt":[{"type":"number","description":"Created At timestamp (in milliseconds since epoch)."}],"lastUpdated":[{"type":"number","description":"Last Updated timestamp (in milliseconds since epoch)."}],"taggedUserContacts":[{"type":"array","items":[{"type":"object","properties":{"text":[{"type":"string","description":"Display text of the tagged user (e.g. “@Username”)","required":true}],"userId":[{"type":"string","description":"User ID of the tagged user","required":true}],"contact":[{"type":"object","properties":{"email":[{"type":"string","description":"Email of the tagged user","required":true}],"name":[{"type":"string","description":"Name of the tagged user","required":true}],"userId":[{"type":"string","description":"User ID of the tagged user","required":true}]},"required":true}]}}],"description":"Array of tagged user contacts"}]}}],"description":"Array of Comment Data","required":true}],"status":[{"type":"object","properties":{"id":[{"type":"string","description":"Status ID","required":true}],"name":[{"type":"string","description":"Status Name","required":true}],"type":[{"type":"object","properties":{},"description":"Type.","required":true}],"color":[{"type":"string","description":"Text and comment pin color","required":true}],"lightColor":[{"type":"string","description":"Background color on the status indicator","required":true}],"svg":[{"type":"string","description":"Raw SVG of the icon. Either `svg` or `iconUrl` is required."}],"iconUrl":[{"type":"string","description":"Icon URL. Either `svg` or `iconUrl` is required."}]},"description":"Status"}],"assignedTo":[{"type":"object","properties":{},"description":"User object to whom the comment is assigned"}],"context":[{"type":"object","properties":{},"description":"Custom key/value metadata object"}],"createdAt":[{"type":"number","description":"Created At timestamp (in milliseconds since epoch)."}],"lastUpdated":[{"type":"number","description":"Last Updated timestamp (in milliseconds since epoch)."}],"priority":[{"type":"object","properties":{"id":[{"type":"string","description":"Priority ID","required":true}],"color":[{"type":"string","description":"Priority Color","required":true}],"name":[{"type":"string","description":"Priority Name","required":true}],"lightColor":[{"type":"string","description":"Priority Light Color","required":true}]},"description":"Priority"}]}}],"required":true}]},"required":true}]}}],"examples":{"example":{"value":{"data":{"organizationId":"\u003cstring>","documentId":"\u003cstring>","commentAnnotations":[{"annotationId":"\u003cstring>","location":{"id":"\u003cstring>","locationName":"\u003cstring>"},"targetElement":{"elementId":"\u003cstring>","targetText":"\u003cstring>","occurrence":123,"selectAllContent":true},"commentData":[{"commentId":123,"commentText":"\u003cstring>","commentHtml":"\u003cstring>","isCommentResolverUsed":true,"isCommentTextAvailable":true,"from":{},"createdAt":123,"lastUpdated":123,"taggedUserContacts":[{"text":"\u003cstring>","userId":"\u003cstring>","contact":{"email":"\u003cstring>","name":"\u003cstring>","userId":"\u003cstring>"}}]}],"status":{"id":"\u003cstring>","name":"\u003cstring>","type":{},"color":"\u003cstring>","lightColor":"\u003cstring>","svg":"\u003cstring>","iconUrl":"\u003cstring>"},"assignedTo":{},"context":{},"createdAt":123,"lastUpdated":123,"priority":{"id":"\u003cstring>","color":"\u003cstring>","name":"\u003cstring>","lightColor":"\u003cstring>"}}]}}}}}}},"response":{},"deprecated":false}},"jsLinks":["/docs/_mintlify/custom/velt/752c38235fc975ab/reb2b-tracking.js","/docs/_mintlify/custom/velt/39475307ed77f9b2/signals-tracking.js"],"subdomain":"velt","siteName":"Velt","title":"Add Comment Annotations - Velt","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T20:56:02.248Z","originalFileLocation":"api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Velt\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add Comment Annotations - Velt\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Velt\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://firebasestorage.googleapis.com/v0/b/snippyly.appspot.com/o/external%2Fvelt_docs.png?alt=media\u0026amp;token=9e4502da-66ef-4005-9124-dbc76f04b1fd\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add Comment Annotations - Velt\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://firebasestorage.googleapis.com/v0/b/snippyly.appspot.com/o/external%2Fvelt_docs.png?alt=media\u0026amp;token=9e4502da-66ef-4005-9124-dbc76f04b1fd\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/velt/XJwux-wDtXKfbtc-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Velt\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#272728\">\u003clink data-mint-head rel=\"canonical\" href=\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://velt.dev/#organization\",\"name\":\"Velt\",\"url\":\"https://velt.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/velt/gY7ilEx2g4g3-HVe/velt-logo-big-light.png?fit=max\u0026auto=format\u0026n=gY7ilEx2g4g3-HVe\u0026q=85\u0026s=c75fd62a074f53174a364509b4363fdc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://velt.dev/docs#website\",\"name\":\"Velt\",\"url\":\"https://velt.dev/docs\",\"publisher\":{\"@id\":\"https://velt.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations#webpage\",\"url\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations\",\"name\":\"Add Comment Annotations\",\"dateModified\":\"2026-10-29T20:56:02.248Z\",\"isPartOf\":{\"@id\":\"https://velt.dev/docs#website\"},\"breadcrumb\":{\"@id\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"REST APIs\",\"item\":\"https://velt.dev/docs/api-reference/rest-apis/v2/organizations/add-organizations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"v1\",\"item\":\"https://velt.dev/docs/api-reference/rest-apis/v1/organizations/add-organizations\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add Comment Annotations\",\"item\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations#apireference\",\"headline\":\"Add Comment Annotations\",\"name\":\"Add Comment Annotations\",\"url\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations\",\"mainEntityOfPage\":{\"@id\":\"https://velt.dev/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations#webpage\"},\"image\":\"https://firebasestorage.googleapis.com/v0/b/snippyly.appspot.com/o/external%2Fvelt_docs.png?alt=media\u0026token=9e4502da-66ef-4005-9124-dbc76f04b1fd\",\"dateModified\":\"2026-10-29T20:56:02.248Z\",\"publisher\":{\"@id\":\"https://velt.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://velt.dev/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Velt\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Velt\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.md","siteName":"Velt","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started/overview"}]},{"tab":"UI Customization","pages":[{"title":"UI Customization","href":"/ui-customization/overview"}]},{"tab":"API Reference","groups":[{"group":"REST APIs","pages":[{"group":"v2","pages":[{"group":"Organizations","pages":[{"title":"Add Organizations","api":"POST https://api.velt.dev/v2/organizations/add","href":"/api-reference/rest-apis/v2/organizations/add-organizations"},{"title":"Get Organizations","api":"POST https://api.velt.dev/v2/organizations/get","href":"/api-reference/rest-apis/v2/organizations/get-organizations-v2"},{"title":"Update Organizations","api":"POST https://api.velt.dev/v2/organizations/update","href":"/api-reference/rest-apis/v2/organizations/update-organizations"},{"title":"Delete Organizations","api":"POST https://api.velt.dev/v2/organizations/delete","href":"/api-reference/rest-apis/v2/organizations/delete-organizations"},{"title":"Update Disabled State for Organizations","api":"POST https://api.velt.dev/v2/organizations/access/disablestate/update","href":"/api-reference/rest-apis/v2/organizations/update-organization-disable-state"}]},{"group":"Folders","pages":[{"title":"Add Folder","api":"POST https://api.velt.dev/v2/organizations/folders/add","href":"/api-reference/rest-apis/v2/folders/add-folder"},{"title":"Get Folders","api":"POST https://api.velt.dev/v2/organizations/folders/get","href":"/api-reference/rest-apis/v2/folders/get-folders"},{"title":"Update Folder","api":"POST https://api.velt.dev/v2/organizations/folders/update","href":"/api-reference/rest-apis/v2/folders/update-folder"},{"title":"Delete Folder","api":"POST https://api.velt.dev/v2/organizations/folders/delete","href":"/api-reference/rest-apis/v2/folders/delete-folder"},{"title":"Update Access for Folders","api":"POST https://api.velt.dev/v2/organizations/folders/access/update","href":"/api-reference/rest-apis/v2/folders/update-folder-access"}]},{"group":"Documents","pages":[{"title":"Add Documents","api":"POST https://api.velt.dev/v2/organizations/documents/add","href":"/api-reference/rest-apis/v2/documents/add-documents"},{"title":"Get Documents","api":"POST https://api.velt.dev/v2/organizations/documents/get","href":"/api-reference/rest-apis/v2/documents/get-documents-v2"},{"title":"Update Documents","api":"POST https://api.velt.dev/v2/organizations/documents/update","href":"/api-reference/rest-apis/v2/documents/update-documents"},{"title":"Delete Documents","api":"POST https://api.velt.dev/v2/organizations/documents/delete","href":"/api-reference/rest-apis/v2/documents/delete-documents"},{"title":"Move Documents","api":"POST https://api.velt.dev/v2/organizations/documents/move","href":"/api-reference/rest-apis/v2/documents/move-documents"},{"title":"Migrate Documents","api":"POST https://api.velt.dev/v2/organizations/documents/migrate","href":"/api-reference/rest-apis/v2/documents/migrate-documents"},{"title":"Migrate Documents Status","api":"POST https://api.velt.dev/v2/organizations/documents/migrate/status","href":"/api-reference/rest-apis/v2/documents/migrate-documents-status"},{"title":"Update Access for Documents","api":"POST https://api.velt.dev/v2/organizations/documents/access/update","href":"/api-reference/rest-apis/v2/documents/update-document-access"},{"title":"Update Disabled State for Documents","api":"POST https://api.velt.dev/v2/organizations/documents/access/disablestate/update","href":"/api-reference/rest-apis/v2/documents/update-document-disable-state"}]},{"group":"Users","pages":[{"title":"Add Users","api":"POST https://api.velt.dev/v2/users/add","href":"/api-reference/rest-apis/v2/users/add-users"},{"title":"Get Users","api":"POST https://api.velt.dev/v2/users/get","href":"/api-reference/rest-apis/v2/users/get-users-v2"},{"title":"Update Users","api":"POST https://api.velt.dev/v2/users/update","href":"/api-reference/rest-apis/v2/users/update-users"},{"title":"Delete Users","api":"POST https://api.velt.dev/v2/users/delete","href":"/api-reference/rest-apis/v2/users/delete-users"}]},{"group":"User Groups","pages":[{"title":"Add User Groups","api":"POST https://api.velt.dev/v2/organizations/usergroups/add","href":"/api-reference/rest-apis/v2/user-groups/add-groups"},{"title":"Add Users to Groups","api":"POST https://api.velt.dev/v2/organizations/usergroups/users/add","href":"/api-reference/rest-apis/v2/user-groups/add-users-to-group"},{"title":"Delete Users from Groups","api":"POST https://api.velt.dev/v2/organizations/usergroups/users/delete","href":"/api-reference/rest-apis/v2/user-groups/delete-users-from-group"}]},{"group":"Comments Feature","pages":[{"group":"Comments Annotations","pages":[{"title":"Add Comment Annotations","api":"POST https://api.velt.dev/v2/commentannotations/add","href":"/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations"},{"title":"Get Comment Annotations","api":"POST https://api.velt.dev/v2/commentannotations/get","href":"/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2"},{"title":"Update Comment Annotations","api":"POST https://api.velt.dev/v2/commentannotations/update","href":"/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations"},{"title":"Delete Comment Annotations","api":"POST https://api.velt.dev/v2/commentannotations/delete","href":"/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations"},{"title":"Get Comment Annotations Count","api":"POST https://api.velt.dev/v2/commentannotations/count/get","href":"/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count"}]},{"group":"Comments","pages":[{"title":"Add Comments","api":"POST https://api.velt.dev/v2/commentannotations/comments/add","href":"/api-reference/rest-apis/v2/comments-feature/comments/add-comments"},{"title":"Get Comments","api":"POST https://api.velt.dev/v2/commentannotations/comments/get","href":"/api-reference/rest-apis/v2/comments-feature/comments/get-comments"},{"title":"Update Comments","api":"POST https://api.velt.dev/v2/commentannotations/comments/update","href":"/api-reference/rest-apis/v2/comments-feature/comments/update-comments"},{"title":"Delete Comments","api":"POST https://api.velt.dev/v2/commentannotations/comments/delete","href":"/api-reference/rest-apis/v2/comments-feature/comments/delete-comments"}]}]},{"group":"Notifications","pages":[{"title":"Add Notifications","api":"POST https://api.velt.dev/v2/notifications/add","href":"/api-reference/rest-apis/v2/notifications/add-notifications"},{"title":"Get Notifications","api":"POST https://api.velt.dev/v2/notifications/get","href":"/api-reference/rest-apis/v2/notifications/get-notifications-v2"},{"title":"Update Notifications","api":"POST https://api.velt.dev/v2/notifications/update","href":"/api-reference/rest-apis/v2/notifications/update-notifications"},{"title":"Delete Notifications","api":"POST https://api.velt.dev/v2/notifications/delete","href":"/api-reference/rest-apis/v2/notifications/delete-notifications"},{"title":"Set Config","api":"POST https://api.velt.dev/v2/notifications/config/set","href":"/api-reference/rest-apis/v2/notifications/set-config"},{"title":"Get Config","api":"POST https://api.velt.dev/v2/notifications/config/get","href":"/api-reference/rest-apis/v2/notifications/get-config"}]},{"group":"Activity Logs","pages":[{"title":"Add Activity Logs","api":"POST https://api.velt.dev/v2/activities/add","href":"/api-reference/rest-apis/v2/activities/add-activities"},{"title":"Get Activity Logs","api":"POST https://api.velt.dev/v2/activities/get","href":"/api-reference/rest-apis/v2/activities/get-activities"},{"title":"Update Activity Logs","api":"POST https://api.velt.dev/v2/activities/update","href":"/api-reference/rest-apis/v2/activities/update-activities"},{"title":"Delete Activity Logs","api":"POST https://api.velt.dev/v2/activities/delete","href":"/api-reference/rest-apis/v2/activities/delete-activities"}]},{"group":"Recordings","pages":[{"title":"Get Recordings","api":"POST https://api.velt.dev/v2/recordings/get","href":"/api-reference/rest-apis/v2/recordings/get-recordings"}]},{"group":"GDPR","pages":[{"title":"Get All User Data","api":"POST https://api.velt.dev/v2/users/data/get","href":"/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr"},{"title":"Delete All User Data","api":"POST https://api.velt.dev/v2/users/data/delete","href":"/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr"},{"title":"Get Delete All User Data Status","api":"POST https://api.velt.dev/v2/users/data/delete/status","href":"/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr"}]},{"group":"Access Control","pages":[{"title":"Generate Token","api":"POST https://api.velt.dev/v2/auth/generate_token","href":"/api-reference/rest-apis/v2/auth/generate-token"},{"title":"Add Permissions","api":"POST https://api.velt.dev/v2/auth/permissions/add","href":"/api-reference/rest-apis/v2/auth/add-permissions"},{"title":"Get Permissions","api":"POST https://api.velt.dev/v2/auth/permissions/get","href":"/api-reference/rest-apis/v2/auth/get-permissions"},{"title":"Remove Permissions","api":"POST https://api.velt.dev/v2/auth/permissions/remove","href":"/api-reference/rest-apis/v2/auth/remove-permissions"}]},{"group":"CRDT","pages":[{"title":"Get CRDT Data","api":"POST https://api.velt.dev/v2/crdt/get","href":"/api-reference/rest-apis/v2/crdt/get-crdt-data"},{"title":"Add CRDT Data","api":"POST https://api.velt.dev/v2/crdt/add","href":"/api-reference/rest-apis/v2/crdt/add-crdt-data"},{"title":"Update CRDT Data","api":"POST https://api.velt.dev/v2/crdt/update","href":"/api-reference/rest-apis/v2/crdt/update-crdt-data"}]},{"group":"Live State","pages":[{"title":"Broadcast Event","api":"POST https://api.velt.dev/v2/livestate/broadcast","href":"/api-reference/rest-apis/v2/livestate/broadcast-event"}]},{"group":"Presence","pages":[{"title":"Add Presence","api":"POST https://api.velt.dev/v2/presence/add","href":"/api-reference/rest-apis/v2/presence/add-presence"},{"title":"Update Presence","api":"POST https://api.velt.dev/v2/presence/update","href":"/api-reference/rest-apis/v2/presence/update-presence"},{"title":"Delete Presence","api":"POST https://api.velt.dev/v2/presence/delete","href":"/api-reference/rest-apis/v2/presence/delete-presence"}]},{"group":"Rewriter","pages":[{"title":"Ask AI","api":"POST https://api.velt.dev/v2/rewriter/ask-ai","href":"/api-reference/rest-apis/v2/rewriter/ask-ai"}]},{"group":"Review Workflow Builder","pages":[{"group":"Definitions","pages":[{"title":"Create Definition","api":"POST https://api.velt.dev/v2/workflow/definitions/create","href":"/api-reference/rest-apis/v2/approval-engine/definitions/create-definition"},{"title":"Update Definition","api":"POST https://api.velt.dev/v2/workflow/definitions/update","href":"/api-reference/rest-apis/v2/approval-engine/definitions/update-definition"},{"title":"Delete Definition","api":"POST https://api.velt.dev/v2/workflow/definitions/delete","href":"/api-reference/rest-apis/v2/approval-engine/definitions/delete-definition"},{"title":"Get Definition","api":"POST https://api.velt.dev/v2/workflow/definitions/get","href":"/api-reference/rest-apis/v2/approval-engine/definitions/get-definition"},{"title":"List Definitions","api":"POST https://api.velt.dev/v2/workflow/definitions/list","href":"/api-reference/rest-apis/v2/approval-engine/definitions/list-definitions"}]},{"group":"Executions","pages":[{"title":"Dispatch Execution","api":"POST https://api.velt.dev/v2/workflow/executions/dispatch","href":"/api-reference/rest-apis/v2/approval-engine/executions/dispatch-execution"},{"title":"Get Execution","api":"POST https://api.velt.dev/v2/workflow/executions/get","href":"/api-reference/rest-apis/v2/approval-engine/executions/get-execution"},{"title":"Cancel Execution","api":"POST https://api.velt.dev/v2/workflow/executions/cancel","href":"/api-reference/rest-apis/v2/approval-engine/executions/cancel-execution"},{"title":"Get Execution Events","api":"POST https://api.velt.dev/v2/workflow/executions/getEvents","href":"/api-reference/rest-apis/v2/approval-engine/executions/get-execution-events"},{"title":"List Executions","api":"POST https://api.velt.dev/v2/workflow/executions/list","href":"/api-reference/rest-apis/v2/approval-engine/executions/list-executions"}]},{"group":"Steps","pages":[{"title":"Record Reviewer Decision","api":"POST https://api.velt.dev/v2/workflow/steps/recordReviewerDecision","href":"/api-reference/rest-apis/v2/approval-engine/steps/record-reviewer-decision"},{"title":"Record Agent Resolution","api":"POST https://api.velt.dev/v2/workflow/steps/recordAgentResolution","href":"/api-reference/rest-apis/v2/approval-engine/steps/record-agent-resolution"},{"title":"Cancel Step","api":"POST https://api.velt.dev/v2/workflow/steps/cancel","href":"/api-reference/rest-apis/v2/approval-engine/steps/cancel-step"},{"title":"Resolve Step","api":"POST https://api.velt.dev/v2/workflow/steps/resolve","href":"/api-reference/rest-apis/v2/approval-engine/steps/resolve-step"}]}]},{"group":"Agents","pages":[{"title":"Create Agent","api":"POST https://api.velt.dev/v2/agents/create","href":"/api-reference/rest-apis/v2/agents/create"},{"title":"Get Agent(s)","api":"POST https://api.velt.dev/v2/agents/get","href":"/api-reference/rest-apis/v2/agents/get"},{"title":"Update Agent (Identity)","api":"POST https://api.velt.dev/v2/agents/update","href":"/api-reference/rest-apis/v2/agents/update"},{"title":"Delete Agent","api":"POST https://api.velt.dev/v2/agents/delete","href":"/api-reference/rest-apis/v2/agents/delete"},{"title":"Extract Agents from File","api":"POST https://api.velt.dev/v2/agents/extract","href":"/api-reference/rest-apis/v2/agents/extract"},{"group":"Versioning","pages":[{"title":"Update Agent Version","api":"POST https://api.velt.dev/v2/agents/version/update","href":"/api-reference/rest-apis/v2/agents/version/update"},{"title":"List Agent Versions","api":"POST https://api.velt.dev/v2/agents/versions/list","href":"/api-reference/rest-apis/v2/agents/versions/list"},{"title":"Restore Agent Version","api":"POST https://api.velt.dev/v2/agents/versions/restore","href":"/api-reference/rest-apis/v2/agents/versions/restore"}]},{"group":"Execution","pages":[{"title":"Run Execution","api":"POST https://api.velt.dev/v2/agents/execution/run","href":"/api-reference/rest-apis/v2/agents/execution/run"},{"title":"Get Execution","api":"POST https://api.velt.dev/v2/agents/execution/get","href":"/api-reference/rest-apis/v2/agents/execution/get"},{"title":"List Executions","api":"POST https://api.velt.dev/v2/agents/execution/list","href":"/api-reference/rest-apis/v2/agents/execution/list"},{"title":"Count Executions","api":"POST https://api.velt.dev/v2/agents/execution/count","href":"/api-reference/rest-apis/v2/agents/execution/count"}]},{"group":"Fix It Everywhere","pages":[{"title":"Estimate Fix It Everywhere","api":"POST https://api.velt.dev/v2/agents/fix-it-everywhere/estimate","href":"/api-reference/rest-apis/v2/agents/fix-it-everywhere/estimate"}]},{"group":"Prompt","pages":[{"title":"Enhance Prompt","api":"POST https://api.velt.dev/v2/agents/prompt/enhance","href":"/api-reference/rest-apis/v2/agents/prompt/enhance"},{"title":"Validate Prompt","api":"POST https://api.velt.dev/v2/agents/prompt/validate","href":"/api-reference/rest-apis/v2/agents/prompt/validate"},{"title":"Refine Prompt","api":"POST https://api.velt.dev/v2/agents/prompt/refine","href":"/api-reference/rest-apis/v2/agents/prompt/refine"}]},{"group":"Config","pages":[{"title":"Resolve Config","api":"POST https://api.velt.dev/v2/agents/config/resolve","href":"/api-reference/rest-apis/v2/agents/config/resolve"}]},{"group":"Analytics","pages":[{"title":"Get Agent Analytics","api":"POST https://api.velt.dev/v2/agents/analytics/get","href":"/api-reference/rest-apis/v2/agents/analytics/get"}]},{"group":"Groups","pages":[{"title":"Create Agent Group","api":"POST https://api.velt.dev/v2/agents/groups/create","href":"/api-reference/rest-apis/v2/agents/groups/create"},{"title":"Get Agent Group","api":"POST https://api.velt.dev/v2/agents/groups/get","href":"/api-reference/rest-apis/v2/agents/groups/get"},{"title":"List Agent Groups","api":"POST https://api.velt.dev/v2/agents/groups/list","href":"/api-reference/rest-apis/v2/agents/groups/list"},{"title":"Update Agent Group","api":"POST https://api.velt.dev/v2/agents/groups/update","href":"/api-reference/rest-apis/v2/agents/groups/update"},{"title":"Delete Agent Group","api":"POST https://api.velt.dev/v2/agents/groups/delete","href":"/api-reference/rest-apis/v2/agents/groups/delete"},{"title":"Add Agents to Group","api":"POST https://api.velt.dev/v2/agents/groups/add-agents","href":"/api-reference/rest-apis/v2/agents/groups/add-agents"},{"title":"Remove Agents from Group","api":"POST https://api.velt.dev/v2/agents/groups/remove-agents","href":"/api-reference/rest-apis/v2/agents/groups/remove-agents"}]},{"group":"Checks","pages":[{"title":"Checks Overview","href":"/api-reference/rest-apis/v2/agents/checks/overview"},{"title":"List Checks","api":"POST https://api.velt.dev/v2/agents/checks/list","href":"/api-reference/rest-apis/v2/agents/checks/list"},{"title":"List Check Comments","api":"POST https://api.velt.dev/v2/agents/checks/comments/list","href":"/api-reference/rest-apis/v2/agents/checks/comments/list"},{"title":"Get Site Score","api":"POST https://api.velt.dev/v2/agents/checks/score/get","href":"/api-reference/rest-apis/v2/agents/checks/score/get"},{"title":"Get Capture Focus","api":"POST https://api.velt.dev/v2/agents/checks/capture-focus/get","href":"/api-reference/rest-apis/v2/agents/checks/capture-focus/get"},{"title":"Get Source Location","api":"POST https://api.velt.dev/v2/agents/checks/source-location/get","href":"/api-reference/rest-apis/v2/agents/checks/source-location/get"},{"title":"Resolve Comment","api":"POST https://api.velt.dev/v2/agents/checks/comments/resolve","href":"/api-reference/rest-apis/v2/agents/checks/comments/resolve"},{"title":"Resolve Check","api":"POST https://api.velt.dev/v2/agents/checks/resolve","href":"/api-reference/rest-apis/v2/agents/checks/resolve"},{"title":"Reject Comment","api":"POST https://api.velt.dev/v2/agents/checks/comments/reject","href":"/api-reference/rest-apis/v2/agents/checks/comments/reject"},{"title":"Reopen Comment","api":"POST https://api.velt.dev/v2/agents/checks/comments/reopen","href":"/api-reference/rest-apis/v2/agents/checks/comments/reopen"},{"title":"Exclude Check","api":"POST https://api.velt.dev/v2/agents/checks/exclude","href":"/api-reference/rest-apis/v2/agents/checks/exclude"},{"title":"Include Check","api":"POST https://api.velt.dev/v2/agents/checks/include","href":"/api-reference/rest-apis/v2/agents/checks/include"},{"title":"Set Check Owner","api":"POST https://api.velt.dev/v2/agents/checks/owner/set","href":"/api-reference/rest-apis/v2/agents/checks/owner/set"},{"title":"Get Check Settings","api":"POST https://api.velt.dev/v2/agents/checks/settings/get","href":"/api-reference/rest-apis/v2/agents/checks/settings/get"},{"title":"Update Check Settings","api":"POST https://api.velt.dev/v2/agents/checks/settings/update","href":"/api-reference/rest-apis/v2/agents/checks/settings/update"},{"title":"Attach Comment","api":"POST https://api.velt.dev/v2/agents/checks/comments/attach","href":"/api-reference/rest-apis/v2/agents/checks/comments/attach"},{"title":"Detach Comment","api":"POST https://api.velt.dev/v2/agents/checks/comments/detach","href":"/api-reference/rest-apis/v2/agents/checks/comments/detach"},{"title":"List Rescan Agents","api":"POST https://api.velt.dev/v2/agents/checks/rescan-agents/list","href":"/api-reference/rest-apis/v2/agents/checks/rescan-agents/list"}]}]},{"group":"Memory","pages":[{"group":"Search and Ask","pages":[{"title":"Search Judgments","api":"POST https://api.velt.dev/v2/memory/search","href":"/api-reference/rest-apis/v2/memory/search"},{"title":"Ask Memory","api":"POST https://api.velt.dev/v2/memory/ask","href":"/api-reference/rest-apis/v2/memory/ask"},{"title":"Suggest Decision","api":"POST https://api.velt.dev/v2/memory/suggest","href":"/api-reference/rest-apis/v2/memory/suggest"},{"title":"Query Judgments","api":"POST https://api.velt.dev/v2/memory/judgments/query","href":"/api-reference/rest-apis/v2/memory/judgments/query"}]},{"group":"Knowledge","pages":[{"title":"Ingest Knowledge","api":"POST https://api.velt.dev/v2/memory/knowledge/ingest","href":"/api-reference/rest-apis/v2/memory/knowledge/ingest"},{"title":"Get Ingest Status","api":"POST https://api.velt.dev/v2/memory/knowledge/ingest-status","href":"/api-reference/rest-apis/v2/memory/knowledge/ingest-status"},{"title":"Get Upload URL","api":"POST https://api.velt.dev/v2/memory/knowledge/upload-url","href":"/api-reference/rest-apis/v2/memory/knowledge/upload-url"},{"title":"Search Knowledge Base","api":"POST https://api.velt.dev/v2/memory/knowledge/search","href":"/api-reference/rest-apis/v2/memory/knowledge/search"},{"title":"List Knowledge Sources","api":"POST https://api.velt.dev/v2/memory/knowledge/list","href":"/api-reference/rest-apis/v2/memory/knowledge/list"},{"title":"List Extracted Rules","api":"POST https://api.velt.dev/v2/memory/knowledge/rules","href":"/api-reference/rest-apis/v2/memory/knowledge/rules"},{"title":"Update Knowledge","api":"POST https://api.velt.dev/v2/memory/knowledge/update","href":"/api-reference/rest-apis/v2/memory/knowledge/update"},{"title":"Download Canonical Markdown","api":"POST https://api.velt.dev/v2/memory/knowledge/download","href":"/api-reference/rest-apis/v2/memory/knowledge/download"},{"title":"Delete Knowledge","api":"POST https://api.velt.dev/v2/memory/knowledge/delete","href":"/api-reference/rest-apis/v2/memory/knowledge/delete"}]},{"group":"Insights","pages":[{"title":"Get Reviewer Profile","api":"POST https://api.velt.dev/v2/memory/profiles/get","href":"/api-reference/rest-apis/v2/memory/profiles/get"},{"title":"Get Patterns","api":"POST https://api.velt.dev/v2/memory/patterns/get","href":"/api-reference/rest-apis/v2/memory/patterns/get"},{"title":"Get Stats","api":"POST https://api.velt.dev/v2/memory/stats/get","href":"/api-reference/rest-apis/v2/memory/stats/get"}]},{"group":"Alerts","pages":[{"title":"List Alerts","api":"POST https://api.velt.dev/v2/memory/alerts/list","href":"/api-reference/rest-apis/v2/memory/alerts/list"},{"title":"Dismiss Alert","api":"POST https://api.velt.dev/v2/memory/alerts/dismiss","href":"/api-reference/rest-apis/v2/memory/alerts/dismiss"},{"title":"Mark Alert Actioned","api":"POST https://api.velt.dev/v2/memory/alerts/action","href":"/api-reference/rest-apis/v2/memory/alerts/action"},{"title":"Get Alert Config","api":"POST https://api.velt.dev/v2/memory/alerts/config/get","href":"/api-reference/rest-apis/v2/memory/alerts/config/get"},{"title":"Update Alert Config","api":"POST https://api.velt.dev/v2/memory/alerts/config/update","href":"/api-reference/rest-apis/v2/memory/alerts/config/update"}]}]},{"group":"Workspace","pages":[{"group":"Account Creation and Verification","pages":[{"title":"Create Workspace","api":"POST https://api.velt.dev/v2/workspace/create","href":"/api-reference/rest-apis/v2/workspace/create"},{"title":"Get Workspace","api":"POST https://api.velt.dev/v2/workspace/get","href":"/api-reference/rest-apis/v2/workspace/get"},{"title":"Get Email Verification Status","api":"POST https://api.velt.dev/v2/workspace/email/status","href":"/api-reference/rest-apis/v2/workspace/email-status"},{"title":"Send Login Link","api":"POST https://api.velt.dev/v2/workspace/email/send-login-link","href":"/api-reference/rest-apis/v2/workspace/send-login-link"}]},{"group":"API Key Management","pages":[{"title":"Create API Key","api":"POST https://api.velt.dev/v2/workspace/apikey/create","href":"/api-reference/rest-apis/v2/workspace/apikey-create"},{"title":"Get API Keys","api":"POST https://api.velt.dev/v2/workspace/apikeys/get","href":"/api-reference/rest-apis/v2/workspace/apikeys-get"},{"title":"Update API Key","api":"POST https://api.velt.dev/v2/workspace/apikey/update","href":"/api-reference/rest-apis/v2/workspace/apikey-update"}]},{"group":"API Key Configuration","pages":[{"title":"Get API Key Config","api":"POST https://api.velt.dev/v2/workspace/apikeyconfig/get","href":"/api-reference/rest-apis/v2/workspace/apikeyconfig-get"},{"title":"Update API Key Config","api":"POST https://api.velt.dev/v2/workspace/apikeyconfig/update","href":"/api-reference/rest-apis/v2/workspace/apikeyconfig-update"}]},{"group":"Auth Tokens","pages":[{"title":"Get Auth Tokens","api":"POST https://api.velt.dev/v2/workspace/authtokens/get","href":"/api-reference/rest-apis/v2/workspace/authtokens-get"},{"title":"Reset Auth Token","api":"POST https://api.velt.dev/v2/workspace/authtoken/reset","href":"/api-reference/rest-apis/v2/workspace/authtoken-reset"}]},{"group":"Manage Domains","pages":[{"title":"Add Domains","api":"POST https://api.velt.dev/v2/workspace/domains/add","href":"/api-reference/rest-apis/v2/workspace/add-domain"},{"title":"Delete Domains","api":"POST https://api.velt.dev/v2/workspace/domains/delete","href":"/api-reference/rest-apis/v2/workspace/delete-domain"},{"title":"Get Domains","api":"POST https://api.velt.dev/v2/workspace/domains/get","href":"/api-reference/rest-apis/v2/workspace/domains-get"}]},{"group":"Email Notifications Configuration","pages":[{"title":"Get Email Config","api":"POST https://api.velt.dev/v2/workspace/emailconfig/get","href":"/api-reference/rest-apis/v2/workspace/emailconfig-get"},{"title":"Update Email Config","api":"POST https://api.velt.dev/v2/workspace/emailconfig/update","href":"/api-reference/rest-apis/v2/workspace/emailconfig-update"}]},{"group":"Basic Webhooks","pages":[{"title":"Get Webhook Config","api":"POST https://api.velt.dev/v2/workspace/webhookconfig/get","href":"/api-reference/rest-apis/v2/workspace/webhookconfig-get"},{"title":"Update Webhook Config","api":"POST https://api.velt.dev/v2/workspace/webhookconfig/update","href":"/api-reference/rest-apis/v2/workspace/webhookconfig-update"}]},{"group":"Advanced Webhooks","pages":[{"title":"Get Advanced Webhook Config","api":"POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/get","href":"/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-get"},{"title":"Update Advanced Webhook Config","api":"POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/update","href":"/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update"},{"title":"Create Advanced Webhook Endpoint","api":"POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/create","href":"/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-create"},{"title":"Get Advanced Webhook Endpoints","api":"POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get","href":"/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-get"},{"title":"Update Advanced Webhook Endpoint","api":"POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/update","href":"/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-update"},{"title":"Delete Advanced Webhook Endpoint","api":"POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/delete","href":"/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-delete"},{"title":"Get Advanced Webhook Endpoint Secret","api":"POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/secret/get","href":"/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get"}]},{"group":"Activity Configuration","pages":[{"title":"Get Activity Config","api":"POST https://api.velt.dev/v2/workspace/activityconfig/get","href":"/api-reference/rest-apis/v2/workspace/activityconfig-get"},{"title":"Update Activity Config","api":"POST https://api.velt.dev/v2/workspace/activityconfig/update","href":"/api-reference/rest-apis/v2/workspace/activityconfig-update"}]},{"group":"Notification Configuration","pages":[{"title":"Get Notification Config","api":"POST https://api.velt.dev/v2/workspace/notificationconfig/get","href":"/api-reference/rest-apis/v2/workspace/notificationconfig-get"},{"title":"Update Notification Config","api":"POST https://api.velt.dev/v2/workspace/notificationconfig/update","href":"/api-reference/rest-apis/v2/workspace/notificationconfig-update"}]},{"group":"Permission Provider Configuration","pages":[{"title":"Get Permission Provider Config","api":"POST https://api.velt.dev/v2/workspace/permissionproviderconfig/get","href":"/api-reference/rest-apis/v2/workspace/permissionproviderconfig-get"},{"title":"Update Permission Provider Config","api":"POST https://api.velt.dev/v2/workspace/permissionproviderconfig/update","href":"/api-reference/rest-apis/v2/workspace/permissionproviderconfig-update"}]}]}]},{"group":"v1","pages":[{"group":"Organizations","pages":[{"title":"Add Organizations","api":"POST https://api.velt.dev/v1/organizations/add","href":"/api-reference/rest-apis/v1/organizations/add-organizations"},{"title":"Get Organizations","api":"POST https://api.velt.dev/v1/organizations/get","href":"/api-reference/rest-apis/v1/organizations/get-organizations"},{"title":"Update Organizations","api":"POST https://api.velt.dev/v1/organizations/update","href":"/api-reference/rest-apis/v1/organizations/update-organizations"},{"title":"Delete Organizations","api":"POST https://api.velt.dev/v1/organizations/delete","href":"/api-reference/rest-apis/v1/organizations/delete-organizations"},{"title":"Update Disabled State for Organizations","api":"POST https://api.velt.dev/v1/organizations/access/disablestate/update","href":"/api-reference/rest-apis/v1/organizations/update-organization-disable-state"}]},{"group":"Folders","pages":[{"title":"Add Folder","api":"POST https://api.velt.dev/v1/organizations/folders/add","href":"/api-reference/rest-apis/v1/folders/add-folder"},{"title":"Get Folders","api":"POST https://api.velt.dev/v1/organizations/folders/get","href":"/api-reference/rest-apis/v1/folders/get-folders"},{"title":"Update Folder","api":"POST https://api.velt.dev/v1/organizations/folders/update","href":"/api-reference/rest-apis/v1/folders/update-folder"},{"title":"Update Access for Folders","api":"POST https://api.velt.dev/v1/organizations/folders/access/update","href":"/api-reference/rest-apis/v1/folders/update-folder-access"}]},{"group":"Documents","pages":[{"title":"Add Documents","api":"POST https://api.velt.dev/v1/organizations/documents/add","href":"/api-reference/rest-apis/v1/documents/add-documents"},{"title":"Get Documents","api":"POST https://api.velt.dev/v1/organizations/documents/get","href":"/api-reference/rest-apis/v1/documents/get-documents"},{"title":"Update Documents","api":"POST https://api.velt.dev/v1/organizations/documents/update","href":"/api-reference/rest-apis/v1/documents/update-documents"},{"title":"Delete Documents","api":"POST https://api.velt.dev/v1/organizations/documents/delete","href":"/api-reference/rest-apis/v1/documents/delete-documents"},{"title":"Move Documents","api":"POST https://api.velt.dev/v1/organizations/documents/move","href":"/api-reference/rest-apis/v1/documents/move-documents"},{"title":"Update Access for Documents","api":"POST https://api.velt.dev/v1/organizations/documents/access/update","href":"/api-reference/rest-apis/v1/documents/update-document-access"},{"title":"Update Disabled State for Documents","api":"POST https://api.velt.dev/v1/organizations/documents/access/disablestate/update","href":"/api-reference/rest-apis/v1/documents/update-document-disable-state"}]},{"group":"Users","pages":[{"title":"Add Users","api":"POST https://api.velt.dev/v1/users/add","href":"/api-reference/rest-apis/v1/users/add-users"},{"title":"Get Users","api":"POST https://api.velt.dev/v1/users/get","href":"/api-reference/rest-apis/v1/users/get-users"},{"title":"Update Users","api":"POST https://api.velt.dev/v1/users/update","href":"/api-reference/rest-apis/v1/users/update-users"},{"title":"Delete Users","api":"POST https://api.velt.dev/v1/users/delete","href":"/api-reference/rest-apis/v1/users/delete-users"}]},{"group":"User Groups","pages":[{"title":"Add User Groups","api":"POST https://api.velt.dev/v1/organizations/usergroups/add","href":"/api-reference/rest-apis/v1/user-groups/add-groups"},{"title":"Add Users to Groups","api":"POST https://api.velt.dev/v1/organizations/usergroups/users/add","href":"/api-reference/rest-apis/v1/user-groups/add-users-to-group"},{"title":"Delete Users from Groups","api":"POST https://api.velt.dev/v1/organizations/usergroups/users/delete","description":null,"href":"/api-reference/rest-apis/v1/user-groups/delete-users-from-group"}]},{"group":"Comments Feature","pages":[{"group":"Comments Annotations","pages":[{"title":"Add Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/add","href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations"},{"title":"Get Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/get","description":null,"href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations"},{"title":"Update Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/update","href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations"},{"title":"Delete Comment Annotations","api":"POST https://api.velt.dev/v1/commentannotations/delete","href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations"},{"title":"Get Comment Annotations Count","api":"POST https://api.velt.dev/v1/commentannotations/count/get","href":"/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count"}]},{"group":"Comments","pages":[{"title":"Add Comments","api":"POST https://api.velt.dev/v1/commentannotations/comments/add","href":"/api-reference/rest-apis/v1/comments-feature/comments/add-comments"},{"title":"Get Comments","api":"POST https://api.velt.dev/v1/commentannotations/comments/get","href":"/api-reference/rest-apis/v1/comments-feature/comments/get-comments"},{"title":"Update Comments","api":"POST https://api.velt.dev/v1/commentannotations/comments/update","href":"/api-reference/rest-apis/v1/comments-feature/comments/update-comments"},{"title":"Delete Comments","api":"POST https://api.velt.dev/v1/commentannotations/comments/delete","href":"/api-reference/rest-apis/v1/comments-feature/comments/delete-comments"}]}]},{"group":"Notifications","pages":[{"title":"Add Notifications","api":"POST https://api.velt.dev/v1/notifications/add","href":"/api-reference/rest-apis/v1/notifications/add-notifications"},{"title":"Get Notifications","api":"POST https://api.velt.dev/v1/notifications/get","href":"/api-reference/rest-apis/v1/notifications/get-notifications"},{"title":"Update Notifications","api":"POST https://api.velt.dev/v1/notifications/update","href":"/api-reference/rest-apis/v1/notifications/update-notifications"},{"title":"Delete Notifications","api":"POST https://api.velt.dev/v1/notifications/delete","href":"/api-reference/rest-apis/v1/notifications/delete-notifications"},{"title":"Set Config","api":"POST https://api.velt.dev/v1/notifications/config/set","href":"/api-reference/rest-apis/v1/notifications/set-config"},{"title":"Get Config","api":"POST https://api.velt.dev/v1/notifications/config/get","href":"/api-reference/rest-apis/v1/notifications/get-config"}]},{"group":"Access Control","pages":[{"title":"Generate Token","api":"POST https://api.velt.dev/v1/auth/token/get","href":"/api-reference/rest-apis/v1/auth/generate-token"}]},{"group":"GDPR","pages":[{"title":"Get All User Data","api":"POST https://api.velt.dev/v1/users/data/get","href":"/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr"},{"title":"Delete All User Data","api":"POST https://api.velt.dev/v1/users/data/delete","href":"/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr"},{"title":"Get Delete All User Data Status","api":"POST https://api.velt.dev/v1/users/data/delete/status","href":"/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr"}]},{"group":"Live State","pages":[{"title":"Broadcast Event","api":"POST https://api.velt.dev/v1/livestate/broadcast","href":"/api-reference/rest-apis/v1/livestate/broadcast-event"}]},{"group":"Workspace","pages":[{"title":"Add Domains","api":"POST https://api.velt.dev/v1/workspace/domains/add","href":"/api-reference/rest-apis/v1/workspace/add-domain"},{"title":"Delete Domains","api":"POST https://api.velt.dev/v1/workspace/domains/delete","href":"/api-reference/rest-apis/v1/workspace/delete-domain"}]}]}]},{"group":"SDK","pages":[{"group":"APIs","pages":[{"title":"API Methods Index","href":"/api-reference/sdk/api/api-methods"},{"title":"React Hooks Index","href":"/api-reference/sdk/api/react-hooks"}]},{"title":null,"href":"/api-reference/sdk/models/data-models"}]}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/release-notes/version-6/sdk-changelog"}]},{"tab":"Examples","href":"https://velt.dev/examples"},{"tab":"DevTools","href":"https://velt.dev/devtools"}]},"basePath":"","title":"Add Comment Annotations - Velt","deploymentId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","buildId":"dpl_J2QdBVuN65x4CCtpqPb371YPt4xi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff"],"chunks":["OpenApiReferenceProvider-tiVafkWW.js","utils-CURQcKis.js","cloneDeep-D7WNbvHt.js","_Uint8Array-BY_XlfVz.js","isObject-FP1Yky1u.js","utils-CdFTKPRO.js","addUniqueKeysToSchema-BSfwE63N.js","snippetPresets-BHyg8yZ0.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CQdVXSju.js","isEqual-ft5OxoSH.js","usePlaygroundInputsStore-BILH4rrw.js","shallow-DterCiSU.js","getApiPlaygroundDisplay-uFtORr6j.js","CodeSnippet-BeuhEvUS.js","CodeSnippets-laCoJsvn.js","Page-CTsmHnLF.js","getPastedJson-DOT1n5Lt.js","icon-COH-nmcZ.js","MethodPill-BbAWkCf6.js","DuplicateIcon-CpagiAFQ.js","createIcon-Bw2Dnowf.js","DynamicMarkdown-DzuINhDe.js","SectionHeading-B3H20qI6.js","axios-vUo_bRtp.js"]}