Quick Start

Get the Runtime running and dispatch your first command in under 5 minutes.

Download and run the Runtime

Download AudraqSetup.exe from the Download page and run it. The installer launches the AUDRAQ Tray App automatically.

During development, you can also start the Runtime directly:

terminal

cd apps/API/Audraq.ExternalApiGateway
dotnet run

Register a Node

Go to Login or create an account, then open the Dashboard and click “Connect this Runtime”.

Alternatively, call the endpoint directly:

POST http://localhost:5000/runtime/claim

{
  "accessToken": "<your-token>",
  "organizationId": "<your-org-id>",
  "runtimeName": "My Studio"
}

Configure a Driver

Open Studio → Driver Config and enable the driver for your Consumer (OBS, REAPER, or X32). Click Save & Reload Drivers.

Or drop a audraq-drivers.json next to the Runtime exe:

audraq-drivers.json

{
  "drivers": [
    {
      "id": "obs-websocket",
      "consumer": "obs-main",
      "enabled": true,
      "endpoint": "ws://localhost:4455",
      "password": ""
    }
  ]
}

Send your first Command

Open Studio → Send Command. Type an intent in pipe-delimited format and click Send Command →.

OBS — switch scene

video.scene.set|obs-main|scene|sceneName=Gaming

REAPER — mute track 1

audio.track.mute.set|reaper-main|track/1|muted=true

X32 — set channel 3 fader to 80%

audio.channel.fader.set|x32-main|channel/3|value=0.8

The Live Event Stream panel on the same page will show the event as it happens. Check the Command Timeline to see the full audit trail.

Intent Format Reference

format

capabilityId|consumerId|resourceTarget|param=value,param2=value2

capabilityId

The unique identifier of the capability (e.g. video.scene.set)

consumerId

Which Consumer to target (configured in Driver Config)

resourceTarget

The sub-resource (e.g. track/1, scene, channel/3)

param=value

Comma-separated key=value pairs for the capability's parameters

← Back to Docs Driver Reference →