Skip to main content

Using the API

The automation door: every engine operation as JSON — for custom dashboards, CI gates, scripts, and integrations. (Endpoint detail: API Reference, rendered from the live OpenAPI spec.)

Start​

vyasa serve --port 8873

The same server hosts the API beside the console. Call it from anything that speaks HTTP: sessions, nodes, gates, reviews, scores, violations, files, projects, terminal — same functions the CLI calls, no duplicate behavior, structured JSON instead of panels.

What it's for (and not for)​

  • CI gates that approve on green builds — run checks, then call the gate endpoints.
  • Custom dashboards — project state as JSON, your charts.
  • Scripts and migrations — bulk operations the CLI would make tedious.
  • NOT for replacing human approval — automation prepares and proposes; gates still decide with reasons on record.

Auth posture today: loopback by default, open CORS — a local console companion, not a hardened public API. Harden before exposing beyond your machine.