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 projects GETCreate a project POSTGet a project GETUpdate a project PATCHDelete a project DELETERegenerate the project embed link POST
REST APIProjects

Delete a project

Update a project PATCH

Only the fields you send change. Requires `project:update`.

Regenerate the project embed link POST

Gives the project a new `embedKey`: every project embed link shared so far stops working, and widgets opened with one leave on their next connect. Feedback sessions it created keep their comments and their own `embedUrl`. Requires `project:update`.

DELETE
/v1/projects/{projectId}

Fails with 409 while the project still has feedback sessions. Requires project:delete.

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

projectId*string

Response Body

Deleted

Example Request
curl -X DELETE 'https://api.annoty.app/v1/projects/string'
Example Response
Empty