Introduction
Reference and Examples
NewBlue Captivate offers a powerful, easy, and accessible API for driving title graphics. This API is exposed over multiple network connection methods and can be utilized by anything that can communicate over a network.
Using this API, you can write scripted “data controllers” that parse incoming data from any imaginable source and use it to update live titles, control their playback, and much more.
These controllers are often written as small, self-contained web pages using HTML and JavaScript and communicate with the Captivate API over a WebSocket connection. In fact, many of our own built-in controllers are developed that same way, and we provide JavaScript libraries to manage that exact workflow.
OpenAPI Spec
Additionally, our API can be accessed using REST style HTTP requests, direct TCP connections, and more. The attached OpenAPI specification documents the entire API according to the HTTP method and has instructions for how to translate those API calls to the other connection methods as well.
Download our spec here:
API Explorer
Also try out our interactive API explorer.
Last updated