POWER STUDIO

REST API

The REST API plugin exposes Power Studio control over HTTP for trusted systems such as Bitfocus Companion, internal automation tools or custom studio integrations.

The default port is 9876. Authentication can use Basic authentication or current-user based behavior, depending on the station configuration.

The plugin includes an embedded Swagger UI for technical testing and discovery. Use it only on trusted networks and preferably from an administrator workstation.

Configure Safely

  1. Open Options and Settings > Plugins.
  2. Select REST API Server plugin.
  3. Configure the port.
  4. Configure authentication.
  5. Add allowed IP addresses where possible.
  6. Add CORS origins only for trusted browser-based clients.
  7. Enable the plugin.
  8. Restart Power Studio.

Do not expose the REST API directly to the public internet. Use it on trusted station networks only.

Check The Connection

After restarting, test from the client system that will use the API. Confirm the exact actions that need to work, such as player control, cart control, playlist control, Mix Editor control and Recorder control.

The API can be used for operational control and administrative workflows, including:

  • Playout player and cart player control.
  • Setting visible playlist items as next.
  • Mix Editor transport and voice-tracking control.
  • Recorder transport and recording control.
  • Creating or updating tracks from an external system.
  • Adding lines to a playlist from an external system.
  • Looking up the running application version for diagnostics.

Only enable the API endpoints needed by the station workflow. A remote control system should run on the studio LAN or over a managed VPN, and the administrator should document which external systems are allowed to connect.

Authentication Behavior

With Basic authentication disabled, REST API actions use the permissions of the user currently logged into Power Studio. If no user is logged in, protected control actions fail with HTTP 401.

With Basic authentication enabled, the client can send a username and password. Some operational actions still require a Power Studio user session because they control the active user interface and current workstation state.

For Companion installations, keep the authentication model simple. Either run Companion on the trusted studio network with current-user authorization, or configure Basic authentication deliberately and test every required action.