Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
List a feedback session's comments GETGet a comment GETResolve or reopen a comment PATCHDelete a comment or reply DELETEGet a comment's screenshot GETReply to a comment POSTSend a comment to a coding agent POST
REST APIComments

Get a comment's screenshot

Delete a comment or reply DELETE

A comment goes with its replies; a reply's id deletes just that reply. Requires `comment:delete`.

Reply to a comment POST

Shows up in open widgets right away, from the team: under the member's name with a session, under the key's name with an API key. Replies can't have replies, so a reply's id is a 404. Requires `comment:create`.

GET
/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}/screenshot

The JPEG in context.screenshot: the reviewer's viewport when they pinned the comment, the element outlined. A 404 when the comment has none. Requires comment:read.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Path Parameters

feedbackSessionId*string
commentId*string

Response Body

The screenshot

response?fileimage/jpeg
Formatbinary
Example Request
curl -X GET 'https://api.annoty.app/v1/feedback-sessions/string/comments/string/screenshot'
Example Response
"string"