Skip to content
docs

REST API

The REST API serves every feature in the dashboard. Authenticate with an API key in the Authorization: Bearer … header. Pagination uses page and page_size; filtering uses query parameters.

Base URL

Section titled “Base URL”
https://api.vygl.io

Self-hosted instances use whatever URL points at the API container; for local development that’s typically http://localhost:8000.

Authentication

Section titled “Authentication”

Every request needs a bearer token:

GET /api/v1/findings
Host: api.vygl.io
Authorization: Bearer vgl_your_api_key_here

Generate keys at Settings → API Keys. Each key has scopes that control which endpoints it can call — see API Keys for the scope list.

Versioning

Section titled “Versioning”

All routes live under /api/v1. Future major versions will get their own prefix; v1 is supported indefinitely.

Pagination

Section titled “Pagination”

List endpoints accept page (1-based) and page_size (default 50, max 200):

GET /api/v1/findings?page=1&page_size=100

The response includes total, page, page_size, and items[].

Error format

Section titled “Error format”

Errors return JSON with a detail field:

{
  "detail": "API key lacks required scope: triage:write"
}

HTTP status codes follow REST conventions: 200 for success, 400 for validation, 401 for missing auth, 403 for insufficient scopes, 404 for missing resources, 429 for rate limits, 5xx for server errors.

Interactive docs

Section titled “Interactive docs”

Rate limits

Section titled “Rate limits”

The API enforces tiered limits — standard endpoints, dashboard read endpoints, and AI-tier write endpoints each have separate buckets. Rate-limit headers (X-RateLimit-Remaining, X-RateLimit-Reset) are included on every response.

Where to next

Section titled “Where to next”