Skip to main content
The Core Control API delivers a direct way of communicating with the Local Core Application running on your machine. The Core is the main server application responsible for all major triggers, connections and active state of the automation of the VRA software. Normally you can control the Core easily via the Cloud, but in some advanced cases you also want direct Local API control over the VRA automations.

​
Core API v2

The Core API v2 is made for control surfaces on the studio network: an Elgato Stream Deck, Bitfocus Companion, a SKAARHOJ panel, a monitoring tool or your own script.
  • Every action is a plain GET. Arguments live in the path or the query string, so any device that can open a URL can control the studio. POST works on the same paths.
  • Explicit, idempotent actions. /on, /off, /toggle and /set?value=. Asking for a state that already holds answers ok and changes nothing.
  • JSON and plain text. /api/v2/... answers JSON. /api/v2/plain/... answers one flat value, OK or ERR <code>, for panels that cannot read JSON.
  • TCP and OSC. The same routes as text lines over TCP or as OSC messages over UDP, for tools that cannot send HTTP. Both are off by default.
  • A token per device. Each device gets its own token, access level and feature limits. Access without a token is off by default.
  • Station safety. Automation, output and variable calls can be tied to a station, for studios that several stations share.
The API covers the Core’s state, the studio’s on-air status, the station and its program, Signals (including Audio Director and Camera Assist), Macros, Automations, the Output Players (their status and scene, and commands such as taking a scene, the next rundown item or a clip), the cameras (tally, cut, preview and angles) and the station’s variables (read, and set user input values).
You manage access, features and devices in VRA Cloud under Studio settings → Core API.

Authentication and LAN access

Device tokens, access without a token and legacy authorization.

Routes

Every v2 route per feature, with its plain value and JSON body.

Plain-text routes

One flat value per call, for panels and regular expressions.

TCP and OSC

The same API as text lines over TCP or as OSC messages, for tools without HTTP.

Station safety

Keep output and variable calls on the right station.

Errors and status codes

What a failed call answers and when to retry.

Stream Deck

One key, one URL, with the built-in Website action.

Bitfocus Companion

The VRA Core module: tally, on-air status and presets made from your studio.

SKAARHOJ

Commands and regex feedback for Blue Pill and Reactor.

OpenAPI

The OpenAPI document and reference page every Core serves.

Legacy routes

Core v1’s /api routes and what changed.

Connectivity and Access management

Ports, hostnames and network access of the Core API.

Core API Endpoints

Base URLs at a glance and the legacy endpoints.

​
Existing functionality endpoints

The Core API is also being used for all external communication to VRA. The AutomationLink is one of the important modules that makes heavy use of the Core API. Read more in the Generic HTTP Radio Automation Link and Connecting with AutomationLink documentation.