Skip to main content

Ctrl Engine Web API Overview

Ctrl Engine's HTTP API (released in version 0.8.0) allows Ctrl Engine to be polled, triggered and managed remotely from a custom webpage, 3rd party service or use it to manage Workspaces, trigger outputs and more without manually configuring input triggers. This allows users to build a platform on top of Ctrl Engine.

The Ctrl Engine API exposes functionality of Ctrl Engine to be polled and triggered remotely to allow system integrators and 3rd party manufacturers can harness the wide range of protocols and device integrations already built into Ctrl Suite by integrating the Ctrl Engine API into their product or platform.

The API schema is fully documented and can be found published on StopLight, or directly within the Developer Tab of Ctrl Engine's web interface, where it can be used to interact with the workspace currently running on Ctrl Engine in real time.

(Note: to be able to output from Ctrl Engine, the system needs to be licensed. For testing purposes you can navigate to the "Console" view to see commands or use our free "Starter" tier license if you don't have a paid license on your machine already.).

The "Developer" page can be used to copy requests into your own application to simplify integration of Ctrl Engine into your product or projects.

User permissions can be defined for each API user. (It's worth noting that to be able to write to the API, the user must also be configured to read from it too).

Using the Ctrl Engine API does not impact the entity count for the licensed Engine.

If you're keen to integrate with Ctrl Suite with your product, service or project using the HTTP API, get in touch.