Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vigolium.com/llms.txt

Use this file to discover all available pages before exploring further.

​
GET /api/diagnostics — System Readiness Check

Returns a diagnostic report checking database connectivity, agent provider readiness, third-party tools, and directory configuration. Useful for verifying the scanner is ready to operate before starting scans. Auth: Viewer (requires Bearer token) 
curl -s -H "Authorization: Bearer $TOKEN" http://localhost:9002/api/diagnostics | jq .

{
  "status": "degraded",
  "timestamp": "2026-04-29T03:40:08+08:00",
  "database": {
    "status": "ok",
    "message": "driver=sqlite"
  },
  "queue": {
    "status": "ok",
    "message": "depth=0"
  },
  "agent": {
    "status": "ok",
    "name": "olium",
    "provider": "codex-oauth",
    "model": "gpt-5.5"
  },
  "browser": {
    "status": "warning",
    "message": "disabled in config"
  },
  "tools": {
    "chromium": {
      "status": "ok",
      "path": "/opt/homebrew/bin/chromium"
    }
  },
  "templates_dir": {
    "status": "ok",
    "message": "path=~/.vigolium/prompts, templates=38"
  },
  "sessions_dir": {
    "status": "ok",
    "message": "path=~/.vigolium/agent-sessions, writable=true"
  }
}

​
Top-Level Status

ValueMeaning
readyAll checks passed
degradedSome non-critical checks failed (e.g., optional tool missing, browser disabled)
not_readyCritical checks failed (database or agent unavailable)

​
Check Statuses

Each individual check returns one of: ok, warning, error.

​
Checks Performed

CheckCriticalDescription
databaseYesPings the database with a 2s timeout
agentYesResolves the configured olium provider and confirms credentials are available
queueNoReports queue depth and error counts
browserNoChecks agent-browser binary if enabled in config
tools.chromiumNoChecks for chromium/chrome binary (fallbacks: chromium-browser, google-chrome, google-chrome-stable)
templates_dirNoVerifies prompt templates directory exists and contains .md files
sessions_dirNoVerifies agent sessions directory exists and is writable

​
CLI Equivalent

The same checks are available via the CLI without a running server: 
# Colored console output
vigolium doctor

# JSON output
vigolium doctor --json
The CLI version omits the queue check since the queue is only available when the server is running.