> For the complete documentation index, see [llms.txt](https://docs.vdo.ninja/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.vdo.ninja/advanced-settings/api-and-midi-parameters.md).

# API & MIDI Parameters

<table><thead><tr><th width="213.75007715635093">Parameter</th><th width="446.4285714285714">Explanation</th></tr></thead><tbody><tr><td><a href="/pages/-Mj8bfVV-0wZjmDO9Y11"><code>&#x26;api</code></a></td><td>Remote control API (HTTP-GET / WSS-based)</td></tr><tr><td><a href="/pages/-Mb8b7EbTo0dKATmqnY5"><code>&#x26;pie</code></a></td><td>Support for piesocket.com</td></tr><tr><td><a href="/pages/-Mc_UOSBkF5dmJtHVpoX"><code>&#x26;midi</code></a></td><td>Global hotkey support via MIDI input and more</td></tr><tr><td><a href="/pages/-Mc_UOSBkF5dmJtHVpoX"><code>&#x26;midiin</code></a></td><td>Allows for receiving of remote MIDI</td></tr><tr><td><a href="/pages/-Mc_UXdBJlUZNeFfvMCY"><code>&#x26;midiout</code></a></td><td>Broadcast MIDI commands to a remote computer's virtual MIDI device</td></tr><tr><td><a href="/pages/-MfYmMZrIuCBJM3_i5C1"><code>&#x26;midiremote</code></a></td><td>Remote MIDI control</td></tr><tr><td><a href="/pages/jycA2GneGJ1erZYplwUt"><code>&#x26;midichannel</code></a></td><td>Allows for specifying which midi channel (1 to 16) to listen on</td></tr><tr><td><a href="/pages/no1ptkE2Xn1UJ2ySlOK8"><code>&#x26;mididevice</code></a></td><td>Allows to specify which midi device (1 and up) selected</td></tr><tr><td><a href="/pages/QgUcAJWWi6sYtT1sWONB"><code>&#x26;midioffset</code></a></td><td>Allows you to set a series of buttons on a MIDI controller to be mute controls for those guests</td></tr><tr><td><a href="/pages/Ef0we5N84kVJkyaymWzD"><code>&#x26;mididelay</code></a></td><td>Lets you precisely delay the MIDI play-out</td></tr><tr><td><a href="/pages/acjtjHvgaNcPh7fv5bye"><code>&#x26;datamode</code></a></td><td>Combines a bunch of flags together; no video, no audio, GUI, etc.</td></tr><tr><td><a href="/pages/zEgjzHra4k1YKI5Usl9P"><code>&#x26;postapi</code></a></td><td>Lets you specify a custom POST URL to send events within VDO.Ninja to</td></tr></tbody></table>


---

# 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://docs.vdo.ninja/advanced-settings/api-and-midi-parameters.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.
