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

Send a comment to a coding agent

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`.

List a project's notification destinations GET

Newest first, including those for a single feedback session. Requires `notificationDestination:read`.

POST
/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}/send-to-agent

Starts a run of the project's Claude Code scheduled task, or dispatches annoty-comment to its GitHub repository, with the comment. Threads only: a reply's id is a 404. Every call starts another run. Requires comment:sendToAgent and a plan with agents.

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

Request Body

application/json
  1. body
  1. body
  2. …
destinationId*string

The coding agent: one of the project's notification destinations of type claude_code or github_actions

Length1 <= length

Response Body

What the first attempt did

application/json
  1. response
  1. response
  2. …
deliveryId*string

The send in the agent's delivery log

status*string

delivered: the run started. pending: the first attempt failed and Annoty tries again. failed: it can't work as set up, see error

Value in"delivered""pending""failed"
runUrl*|

Where to watch the run: the Claude Code session, or the repository's Actions tab. Null until it's delivered

error*|

Why the first attempt failed

Example Request
curl -X POST 'https://api.annoty.app/v1/feedback-sessions/string/comments/string/send-to-agent' \
  -H 'Content-Type: application/json' \
  -d '{
  "destinationId": "string"
}'
Example Response
{
  "deliveryId": "string",
  "status": "delivered",
  "runUrl": "string",
  "error": "string"
}