Local device API

The HTTP and WebSocket interface the pedal exposes on your own network, for anyone who wants to script it or build something on top.

Updated

The pedal’s configuration page is an ordinary client of an API the device serves. That API is open and local — if you want to script your rig, you do not need anything from us.

HTTP

Endpoint Purpose
GET /api/config The full configuration.
GET /api/status Connection state and health.
GET /api/system Device identity, firmware version, uptime.
GET /api/catalog/* Stored console definitions.
POST /api/mixer/activate Switch the active console.
GET /api/license Which tier this device is running.
GET /api/logs The in-memory log ring.
POST /api/restart Reboot.
POST /api/factory-reset Clear everything.
GET /api/replicate/image Stream a sanitised flash image for cloning.

WebSocket

/ws carries live state, and also implements the virtual pedal — you can trigger a footswitch from software and watch the LED state mirror back. It is how the configuration page previews behaviour, and it makes the pedal testable without a boot on it.

What the replication image contains

/api/replicate/image streams the device’s flash with the Wi-Fi credentials, licence state and log regions overwritten with 0xFF as it goes. The source device is not modified, and the resulting file carries no secrets — which is what makes it safe to hand to somebody else.

See cloning a pedal for the flashing side.

Why this stays open

The firmware and the app are closed, and we would rather be plain about that than dress it up. The local API is not, and it will not be closed later: it is the thing that means a pedal you built is yours to automate, and that a scripting workflow you build today cannot be taken away by a business decision of ours tomorrow.