# Vynix REST API Reference

> Overview of the Vynix REST API: how annotations are ingested, how the dashboard and MCP server read data, authentication, and where to go for endpoint details.

[Docs](/docs/)/REST API

Developer reference

# Vynix REST API reference

Vynix is built on a single REST API that the widget, dashboard, MCP server and extension all share. This page explains the shape of the API and how authentication works.

## Conventions

The API is JSON over HTTPS under the /api/v1 path. Successful responses return a data object; errors return an error object with a code and message. Enumerations such as priority, type and status are fixed and documented per endpoint.

The widget ingests feedback with a write-only project key, while the dashboard and MCP server authenticate with a signed bearer token. This separation keeps the public ingest path safe while the read and management paths stay private.

## What you can build

You can ingest annotations from your own surfaces, read and filter a project feedback inbox, and drive the same actions the dashboard exposes. For agent workflows, the MCP server is usually the fastest path because it wraps these endpoints as tools.

## Related

[API overview](/api/)[MCP server](/docs/mcp/)[Security](/docs/security/)

[<- Browser extension](/docs/browser-extension/)[Security ->](/docs/security/)

## Stop describing bugs. Point at them.

Add one script tag and give your AI agent the context it has been missing. Free while we grow.

[Get started free](/register)[Read the install guide](/install/)

---

Source: https://www.vynix.in/docs/api/ | Markdown version for AI agents. Full site index: https://www.vynix.in/llms.txt