> 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/api-examples/json-command-tester.md).

# JSON Command Tester

The JSON Command Tester is built on the `scheduleCommand` function, and provides cut and paste fields to try out parameters. Once you’ve found and verified the functionality you need, you can even copy and paste from here into your own code. The JSON Command Tester can be accessed from the Data Controller column in your Captivate project panel under API Examples --> API Tour.

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

**Command**

Choose the command from the Command: drop down menu. Once selected, it displays information about the specific command, including details about all parameters.

This is the first parameter of the scheduleCommand() function. The second and third parameters are JavaScript objects that carry the attributes and variables for each command, respectively.

#### Parameters <a href="#parameters" id="parameters"></a>

The parameters box sets up the JavaScript object which carries all the attributes and options available for that command. To add or change values, edit directly in this.

Note that some parameters, are automatically filled in for convenience. These include the `input` name and title `id`.

#### Variables <a href="#variables" id="variables"></a>

If the particular command supports a set of variables, this displays a JavaScript object to manage the variables.

For convenience, it pre-fills the JavaScript object with all the variables of the connected title with their current values.

#### Execute Command <a href="#execute-command" id="execute-command"></a>

Once you have chosen a command and prepared the parameters and variables, click here to execute the command.

#### Returned <a href="#returned" id="returned"></a>

This displays the JavaScript object that is passed to the `scheduleCommand` callback as a JSON string.

#### Notification <a href="#notification" id="notification"></a>

Some commands, such as `subscribe` or `getSnapShot`, send JavaScript objects back later, via the `onNotify` callback (see above).


---

# 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/api-examples/json-command-tester.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.
