> 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/api-access-levels.md).

# API Access Levels

Which Captivate editions can use which API commands

Captivate checks each API command against the license before it runs the command. What a command needs depends on two things: the command, and how you connect to Captivate.

## Access by Edition

|                                            | Present, Sport | Broadcast             | Enterprise |
| ------------------------------------------ | -------------- | --------------------- | ---------- |
| Notification commands, on any connection   | Yes            | Yes                   | Yes        |
| Status commands, over the WebSocket API    | No             | Yes                   | Yes        |
| Title commands, over the WebSocket API     | No             | Connected titles only | Yes        |
| All other commands, over the WebSocket API | No             | No                    | Yes        |
| All other commands, over HTTP or TCP       | No             | No                    | Yes        |

Broadcast can get the same access as Enterprise with the **Full API Access** add-on.

## The Three Levels

**Notification commands** work on every edition and on every connection. They are `subscribe`, `unSubscribe` and `getSubscriptions`.

**Partial API Access** comes with Captivate Broadcast. Over the WebSocket API, it allows:

* Status commands, such as `getProductInfo`, `getPlayStatus` and `getTitlesConnected`.
* Title commands, such as `scheduleAction`, `selectTitle` and `getSnapShot`, on a connected title.

**Full API Access** comes with Captivate Enterprise, and with the Full API Access add-on for Broadcast. It allows every command, on any title, over every connection.

Each command in the [All Commands Reference](https://developers.newbluefx.com/captivate-api/all-commands-reference.md) shows the level it needs.

## Connected Titles

A connected title is a title that has an input assigned to it in Captivate. With Partial API Access, a title command works when it names that input, or names the title together with its input. A title command that names a title with no input needs Full API Access.

## How You Connect

**WebSocket API** (port `9023`, used by the `ServiceHandler` library, and also through NewBlue's WebSocket tunnel): each command needs the level shown in the All Commands Reference.

**HTTP** (`/api` on port `9022`) and **TCP** (port `9025`): every command needs Full API Access, except the notification commands.

**TCP and UDP proxy connections** (`/tcp/` and `/udp/` on the WebSocket port): these need Full API Access. See [Leveraging Captivate to Connect to TCP/UDP Network Resources](https://developers.newbluefx.com/captivate-api/advanced-api-reference/leveraging-captivate-to-connect-to-udp-servers.md).

With Partial API Access, use the WebSocket API.

## Controller Methods That Need Full API Access

These `ServiceHandler.scheduler` methods need Full API Access:

* `scheduleVariables`
* `scheduleVariablesEx`
* `scheduleVariablesExSync`
* `scheduleClockVariable`
* `updateInputDefinition`

With Partial API Access, use [`scheduleAction`](https://developers.newbluefx.com/captivate-api/javascript-api-reference/using-the-servicehandler/scheduleaction-method.md) to send variable values to a connected title.

To send messages between your own controllers, use `messageOut` and `messageIn`. They work on every edition. A `scheduleCommand` call with a `to` field needs Full API Access when its command name is not a Captivate command. See [Communication Between Controllers](https://developers.newbluefx.com/captivate-api/javascript-api-reference/using-the-servicehandler/communicating-between-controllers.md).

## Your Own Controllers

The controllers you build follow the same rules as any other software that connects over the WebSocket API. This is true when Captivate hosts the controller, too.

The controllers that ship with Captivate, Stream Deck, Bitfocus Companion and the NLE plug-ins work on every edition.

## When a Command Is Refused

A refused command does nothing. Captivate does not run part of it.

The reply has an `error` field with one of these values:

* `automation_entitlement_required`: the command needs Full API Access.
* `api_access_required`: the command needs Partial API Access.

A refused TCP or UDP proxy connection closes with WebSocket close code `1008` and the reason `automation_entitlement_required`.


---

# 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/api-access-levels.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.
