> For the complete documentation index, see [llms.txt](https://developers.newbluefx.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.newbluefx.com/getting-started/openapi.md).

# Introduction

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.

<figure><img src="/files/IXG7EGwHXiMFK4r6J4k6" alt=""><figcaption></figcaption></figure>

### 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:

{% file src="/files/QtCUCNFgpSmrzNpGPNiZ" %}
OpenAPI Captivate Specification
{% endfile %}

## API Explorer

Also try out our interactive [API explorer](https://newbluefx.com/api/explorer).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.newbluefx.com/getting-started/openapi.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.