> 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

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.

<figure><img src="https://2284285836-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXkMvk0MrY3BcyplZ0pf7%2Fuploads%2Fmwk6d0OAlSLyxdQYJkZC%2Fapi_image.png?alt=media&amp;token=6857c9e3-dd88-458b-b50d-61225deee487" 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.

> **Note:** What your software can do through the API depends on your Captivate edition and on how you connect. See [API Access Levels](https://developers.newbluefx.com/getting-started/api-access-levels.md).

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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
