Skip to main content
The Core answers two sets of endpoints:
  • Core API v2 under /api/v2, for new integrations. Every route is listed on Routes, with a plain-text twin under /api/v2/plain (Plain-text routes).
  • Legacy routes under /api, the routes of Core v1. They are listed below and on Legacy routes.
Every Core also serves its own OpenAPI document at /api/v2/openapi.json and a reference page at /api/v2/docs. See OpenAPI.

​
Core API v2 at a glance

BASE URL: http://{core_host_ip}:3002/api/v2/ Authorization: a device token, LAN access or the legacy Basic header - read more in Authentication and LAN access All control routes answer GET and POST and are idempotent. See Routes for the bodies and parameters.

​
Legacy routes (Core v1 and Core v2)

BASE URL: http://{core_host_ip}:3002/api/ Authorization: Basic - read more Connectivity and Access management
Description: Get current studio name of the Core client
Description: Set Active Core Studio OnairContent-type: text/plainResponse: onair
Description: Set Active Core Studio Offair. Same as /studio/control/deactivate.Content-type: text/plainResponse: offair
Description: Toggle Active Core Studio Onair StatusContent-type: text/plainResponse: The new studio state, onair or offair
Description: This endpoint fetches all current state of the serverContent-type: application/json
Description: This endpoint fetches the current state of the server (for example ACTIVE, or DEACTIVATED)Content-type: text/plain
Description: This endpoint fetches the “activeness” of the server (multiple states can indicate “active” and this endpoint will just return true | false)Content-type: text/plain
Description: Activate CoreContent-type: text/plainResponse: Current Core State
Description: Deactivate CoreContent-type: text/plainResponse: Current Core State
Description: Toggle Core stateContent-type: text/plainResponse: Current Core State
Description: ⚠️ REBOOT all managed apps by Core (check Cloud → Studio Advanced → Core Settings)Content-type: application/json
Description: Reload all Core Modules
Description: Restart the Output Player apps on the Core machine. On Core v1 this reloaded the Output Player instances inside the Core instead of the apps.Response: {"ok":true}
The legacy routes answer the same bodies on Core v1 and on Core v2. See Legacy routes for the complete list, including /studio/id, and what changed.
More endpoints coming soon. Got suggestions for other endpoints? Mail feedback@visualradioassist.live or request feature on https://roadmap.visualradioassist.live