2

API-Reference

Shawn edited this page 2026-05-19 23:07:19 -04:00

Table of Contents

• API Reference
• REST API (Port 8080)
• WebSocket (ws://host:8080/ws)
• OSC (UDP Port 9000)

API Reference

REST API (Port 8080)

Endpoint	Method	Description
/api/health	GET	Health check
/api/channels	GET	List all channels
/api/channels/{id}	GET	Channel state
/api/channels/{id}	PUT	Update channel (fader, mute, solo, pan)
/api/routing	GET	Routing matrix
/api/routing	PUT	Update routing
/api/transport	GET	Transport state
/api/transport/play	POST	Start playback
/api/transport/stop	POST	Stop
/api/transport/record	POST	Toggle record
/api/plugins	GET	List plugins
/api/scenes	GET	List scenes/snapshots
/api/scenes/{id}	POST	Recall scene

WebSocket (ws://host:8080/ws)

Real-time bi-directional state sync. Messages are JSON:

{"type": "fader_move", "channel": 3, "value": 0.75}
{"type": "state_sync", "channels": [...], "meters": {...}}

OSC (UDP Port 9000)

Address	Args	Description
/channel/{id}/fader	f	Set fader level
/channel/{id}/mute	i	Set mute
/channel/{id}/pan	f	Set pan
/transport/play	—	Start play
/transport/stop	—	Stop