API reference

A clean REST API, token-authenticated

Everything the dashboard and MCP server use is available to you. One bearer token, one JSON envelope, no surprises.

Authentication

Send your token as a bearer header on every request. Generate one on the MCP page; it’s scoped to your account and never expires for a year.

terminal
curl https://www.vynix.in/api/v1/auth/me \
  -H "Authorization: Bearer $VYNIX_TOKEN"
Response envelope

Successful calls return a data object. Errors return an error with a stable code.

200 OK
{
  "data": {
    "id": "ann_8f2c…",
    "title": "Make the primary CTA larger",
    "type": "bug",
    "priority": "high",
    "status": "open"
  }
}
404 Not Found
{
  "error": {
    "code": "not_found",
    "message": "Annotation not found.",
    "details": {}
  }
}

Account

Your profile and personal access tokens.

GET/api/v1/auth/meThe signed-in user.
POST/api/v1/auth/api-tokenMint a long-lived MCP/API token.
GET/api/v1/me/overviewKPI counts, status breakdown, activity.

Projects

Sites you capture feedback on.

GET/api/v1/projectsList your projects.
POST/api/v1/projectsCreate a project.
GET/api/v1/projects/{id}Fetch one project.
GET/api/v1/projects/{id}/annotationsList annotations (filter by status, type, priority).
GET/api/v1/projects/{id}/activityRecent activity feed.
GET/api/v1/projects/{id}/issuesLinked GitHub issues + summary.
POST/api/v1/projects/{id}/issues/syncRefresh issue state from GitHub.
GET/api/v1/projects/{id}/membersList team members.

Annotations

Individual pieces of feedback and their lifecycle.

GET/api/v1/annotations/{id}Full annotation with captured context.
PATCH/api/v1/annotations/{id}/statusUpdate status.
POST/api/v1/annotations/{id}/promptGenerate an agent-ready prompt.
GET/api/v1/annotations/{id}/commentsList the discussion thread.
POST/api/v1/annotations/{id}/commentsAdd a comment.
POST/api/v1/annotations/{id}/issueOpen a linked GitHub issue.

Billing & public

Subscription state and unauthenticated endpoints.

GET/api/v1/billing/subscriptionCurrent plan and status.
GET/api/v1/plansPublic list of plans.
GET/api/v1/healthLiveness probe.

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 freeRead the install guide