Skip to Content
annotyDocs

REST API

Manage projects, feedback sessions, comments and notifications from your own code.

The REST API is at https://api.annoty.app. Every endpoint is in the sidebar, generated from the OpenAPI spec, which you can also load into your own tools.

Authenticate

Create an API key in the dashboard under Settings → API keys and send it as a bearer token:

curl https://api.annoty.app/v1/projects \
  -H "Authorization: Bearer annoty_…"

x-api-key: annoty_… works too. While your organization has no subscription or trial, every request except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Errors

Errors always look like { "error": { "code", "message", "details", "requestId" } }. Branch on code; message may change.

Pagination

List endpoints take limit and cursor and return { data, nextCursor }. Pass nextCursor as cursor to get the next page; it's null on the last one.

Rate limits

300 requests per minute per key, 100 while your organization is on its trial. Over that you get 429 with Retry-After.

On this page