> 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/captivate-api/all-commands-reference.md).

# All Commands Reference

The following pages will show you (almost) all of the commands that Captivate makes available to API consumers.

You can call these commands with the ServiceHandler library by using the `scheduleCommand` method on the `scheduler` object as described in the [JavaScript API Reference](https://developers.newbluefx.com/captivate-api/javascript-api-reference/using-the-servicehandler/schedulecommand-method.md), and this reference assumes you are familiar with information contained there.

You can also call these commands through the use of one of our [Advanced API](https://developers.newbluefx.com/captivate-api/advanced-api-reference.md) connection methods.

These reference will describe the commands according to the HTTP connection method but they can easily be translated back to the `scheduleCommand` method.

> **Note:** Each command starts with an **API access** line. It tells you which Captivate editions can use the command, over HTTP and TCP and over the WebSocket API. The pages group commands by topic, so one page can hold commands at different levels. See [API Access Levels](https://developers.newbluefx.com/getting-started/api-access-levels.md).

**Translating from this documentation back to `scheduleCommand`**

For `/api/command/` endpoints:

```javascript
await ServiceHandler.scheduler.scheduleCommand([command], [params], [variables]);
```

* `command` is the path element after `/api/command/`
* `params` is an object described by the `properties` field
* `variables` is an object with the variables to set.
* all arguments are required

For `/api/action/` endpoints:

```javascript
await ServiceHandler.scheduler.scheduleAction([action], [input], [title], [variables]);
```

* `action` is the path element after `/api/action/`
* `input` is the input name to target
* `title` is the id or the name of the title to target
* `variables` is an object with the variables to set
* all arguments are required, so to target just an input or a title, pass an empty string for the other one


---

# 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/captivate-api/all-commands-reference.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.
