Skip to content

Docs

GitHub Try the demo

Start Guides Reference Internals Help

GitHub Online demo Releases

HTTP API WebSocket API Protocols

GETList effects GETHealth check GETGet the LED layout GETGet the activity log GETGet this computer's addresses GETGet the whole state

GETGet the live status

POSTTrigger a live pad POSTSet brightness PATCHLike, ban or tune an effect POSTTurn the lights on or off PATCHChange the show PUTSet the zones

Your own effects

GETList your effects POSTMake an effect PUTChange an effect DELDelete an effect

Scenes & schedules

GETList scenes POSTSave a scene PUTChange a scene DELDelete a scene POSTApply a scene GETList schedules POSTAdd a schedule PUTChange a schedule DELDelete a schedule POSTRun a schedule now

GETGet home settings PUTChange home settings POSTStart the sleep timer DELCancel the sleep timer POSTStart a sunrise DELCancel the next sunrise POSTMake a new link key POSTSnooze the sunrise POSTStop the sunrise

GETList devices POSTAdd a device PATCHChange a device DELRemove a device POSTCheck a device POSTIdentify a device POSTWrite WLED segments POSTFind devices POSTCamera mapping GETGet the room PUTSet the room POSTIdentify a shape POSTUse a room preset

POSTAdd a fixture PATCHChange a fixture DELRemove a fixture GETGet DMX output GETList fixture profiles

GETList sound inputs POSTStart a song DELStop the song POSTSend the song's clock GETList remembered songs DELForget a song GETGet a song's show PUTSave a song's show DELReset a song's show PUTPreview a draft show DELStop the draft

GETGet the hearing panel POSTCheck again POSTChoose how to hear music

GETGet now playing PATCHChange now playing DELDisconnect Spotify GETSpotify sign-in callback POSTFinish the Spotify sign-in POSTStart the Spotify sign-in

GETGet Spotify sync PATCHChange Spotify sync POSTSend cover colours

GETList requests POSTRequest a song DELRemove all requests PATCHMark a request played DELRemove a request POSTVote for a request

PATCHChange settings

Backup & updates

GETDownload a backup POSTQuit Tempolight POSTReset to defaults POSTRestore a backup GETCheck for an update POSTUpdate and restart

GETGet Wi-Fi setup POSTOpen the setup hotspot

POSTSet a PIN DELRemove the PIN POSTUnlock

GETGet the HomeKit bridge PATCHTurn the bridge on or off DELForget a controller POSTReset pairing

GETGet integrations PATCHChange Discord POSTTest Discord PATCHLet the docs site try API calls PATCHChange OBS GETDownload the Stream Deck plugin PATCHChange Twitch POSTSign in to Twitch DELSign out of Twitch POSTTest a Twitch reaction

POSTGame state (from the game)PATCHChange a game GETGet the game's config file POSTTest a game event POSTMake a new game token

API reference

Lock

The PIN lock and unlock tokens.

POSTSet a PIN/api/lockDELRemove the PIN/api/lockPOSTUnlock/api/unlock

Was this page helpful?Thanks for telling us.Tell us what was missing

PreviousOpen the setup hotspot NextSet a PIN

About Online demo Releases

Tempolight is free and open source (MIT). These docs are built from docs/ in the repository.

Esc

↑↓ to move↵ to openEsc to close