Skip to main content
Version: Latest

API

Sofie User Actions REST API​

Starting with version 1.50.0, there is a semantically-versioned HTTP REST API definied using the OpenAPI specification that exposes some of the functionality available through the GUI in a machine-readable fashion. The API specification can be found in the packages/openapi folder. The latest version of this API is available in Sofie Core using the endpoint: /api/1.0. There should be no assumption of backwards-compatibility for this API, but this API will be semantically-versioned, with redirects set up for minor-version changes for compatibility.

There is a also a legacy REST API available that can be used to fetch data and trigger actions. The documentation for this API is minimal, but the API endpoints are listed by Sofie Core using the endpoint: /api/0

Sofie Live Status Gateway​

Starting with version 1.50.0, there is also a separate service available, called Sofie Live Status Gateway, running as a separate process, which will connect to the Sofie Core as a Peripheral Device, listen to the changes of it's state and provide a PubSub service offering a machine-readable view into the system. The WebSocket API is defined using the AsyncAPI specification and the specification can be found in the packages/live-status-gateway/api folder.

DDP – Core Integration​

If you're planning to build NodeJS applications that talk to Sofie Core, we recommend using the core-integration library, which exposes a number of callable methods and allows for subscribing to data the same way the Gateways do it.