API Quick Reference

Base URL: http://localhost:5050/api/v1

Endpoints

Method Path Description
GET /slots List all slots
GET /slots/:id Get slot by ID
POST /slots Create a slot
PATCH /slots/:id Update a slot
DELETE /slots/:id Delete a slot
POST /slots/:id/playback Control playback (play/pause/stop/reset)
POST /slots/:id/jump Jump to timecode
GET /slots/:id/presets List slot presets
POST /slots/:id/presets Create a preset
POST /slots/:id/presets/trigger Trigger a preset
GET /routing Get routing matrix
POST /routing Set a route
DELETE /routing Remove a route
GET /config/hardware Get hardware devices
GET /config/network-interfaces Get network interfaces
GET /config/devices Get configured devices
POST /config/devices Add a device
GET /health Get system health
GET /health/devices Get device health

Common Payloads

Create Slot

POST /slots
{
  "name": "Main TC",
  "frameRate": "29.97df"
}

Playback Control

POST /slots/:id/playback
{ "action": "play" }  // play, pause, stop, reset

Jump to Timecode

POST /slots/:id/jump
{
  "timecode": { "hours": 1, "minutes": 30, "seconds": 0, "frames": 0 },
  "shouldPlay": true
}

Frame Rates

23.976 24 25 29.97 29.97df 30 50 59.94 60

For detailed examples and response formats, see Full API Documentation.