# \&api

General Option! ([`&push`](/advanced-settings/setup-parameters/push.md), [`&room`](/advanced-settings/setup-parameters/room.md), [`&view`](/advanced-settings/mixer-scene-parameters/view.md), [`&scene`](/advanced-settings/mixer-scene-parameters/scene.md))

## Aliases

* `&osc`

{% hint style="warning" %}
`&osc` is only a legacy alias for this HTTP/WSS remote API key parameter. VDO.Ninja does not support native OSC protocol input, such as UDP OSC messages from another app. External OSC tools need their own bridge to the HTTP/WSS API.
{% endhint %}

## Options

Example: `&api=SomeAPIKey`

<table><thead><tr><th width="180">Value</th><th>Description</th></tr></thead><tbody><tr><td>(key)</td><td>API KEY to control VDO.Ninja remotely</td></tr></tbody></table>

## Details

You can use this parameter to enable the HTTP/WSS remote control API for VDO.Ninja. You pass a API KEY value to the parameter, and if it matches the remote control's API KEY, then the remote control interface will be able to send commands to your VDO.Ninja session.

You can control guests in the director's room, or you can control your local microphone and camera, as examples.

Please see <https://github.com/steveseguin/Companion-Ninja> for documentation and details of this command. There is a module for Bitfocus's Companion available, along with HTTP and WSS API endpoints.

Please see <https://companion.vdo.ninja> for a sample interface to test this command out with. The Companion module is available here: <https://github.com/bitfocus/companion-module-vdo-ninja>

## Related

{% content-ref url="/pages/-MfH\_6\_LWILCXPUqo\_2D" %}
[Basic hotkeys](/guides/hotkey-support.md)
{% endcontent-ref %}

{% content-ref url="/pages/bGkmEUJTfwn97zJnThTc" %}
[How to control VDO.Ninja with Touch Portal](/guides/how-to-control-vdo.ninja-with-touch-portal.md)
{% endcontent-ref %}


---

# Agent Instructions: 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:

```
GET https://docs.vdo.ninja/advanced-settings/api-and-midi-parameters/api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.