API overview

Lightpath exposes three control surfaces, all backed by the same engine. Pick whichever matches the system you’re integrating from — and feel free to mix.

HTTP (REST)

Best for: backend systems, schedulers, custom dashboards, anything that already speaks HTTP.

Activate a look named Sunset:

curl -X POST "http://<your-install>:3001/api/looks/Sunset/activate" \
  -H "Authorization: Bearer $TOKEN"

Fire an action, set output brightness, jump to a track in a playlist — every mutation in the UI has an HTTP endpoint.

→ HTTP API reference

OSC

Best for: lighting consoles, audio software, show-control hardware, Resolume.

Trigger content by name on the default inbound port (8000):

/lightpath/content/sunset 1

Lightpath also broadcasts state — content activations, dimmer changes, playlist transitions — outbound on port 9000, so the other system can stay in sync. Resolume Avenue clip messages are compatible out of the box.

→ OSC API reference

TouchDesigner Python

Best for: TD-based show-control rigs that already host the visuals, or any project where you want to drive Lightpath from a .toe.

Load Lightpath's LightpathAPI.tox (provided by Digital Ambiance) into your .toe. The component exposes everything two ways:

• Custom parameters — drop-down menus of looks, scenes, playlists, outputs, and actions, plus pulse buttons to activate or fire them. Wire these to your show-control logic in the editor.

• Extension methods — call from any DAT or CHOP script:

  op.LIGHTPATH_API.ActivateLook("Sunset")
  op.LIGHTPATH_API.FireAction("All Lights On")
  op.LIGHTPATH_API.SetDimmer("Facade", 0.75)

→ TouchDesigner Python API reference

Picking between them