Get information about the LedFX server including version and configuration

List all physical LED devices configured in LedFX (WLED, OpenRGB, etc.)

Get detailed information about a specific LED device

List all virtual LED strips. Virtuals are logical strips where effects are applied.

Get detailed information about a specific virtual

Activate or deactivate a virtual. Virtuals must be active to display effects.

Update virtual configuration: transitions, brightness, frequency range, matrix settings, and more.

Set an effect on a virtual (NOT a device). Effects control how LEDs display. Use ledfx_set_blender for blender.

Safely set a blender effect by configuring source virtuals first. Blender mixes background + foreground using a mask; mask should be audio reactive, and at least one of background/foreground should be audio reactive. Static colors are rarely useful.

Update the configuration of the currently running effect on a virtual

Clear/stop the current effect on a virtual

Get schemas for all available effect types with their parameters

Get the schema for a single effect type

Get available presets for a virtual's current effect

Apply a preset to a virtual

Save the current effect configuration on a virtual as a user preset

Delete a preset for a virtual's effect

List all saved scenes. Scenes are complete lighting configurations.

Get a single scene by ID with full scene config payload

Activate a saved scene by ID

Create a new scene from current virtual configurations

Update an existing scene in place by ID

Recreate all blender scenes using their stored virtual configurations (no scene activation)

Delete a saved scene

Create a scene from a natural language description (e.g., 'calm blue ocean waves' or 'energetic party rainbow')

List all colors and gradients from LedFX /api/colors. Returns LedFX native response types.

Get a single color or gradient by ID from LedFX /api/colors.

Create or update a user-defined color or gradient in LedFX /api/colors.

Delete a user-defined color or gradient by ID in LedFX /api/colors.

Delete all user-defined gradients in LedFX /api/colors (includes palettes).

List all palettes stored as user gradients in LedFX /api/colors.

Create or update a palette by saving a user gradient in LedFX /api/colors.

Get a palette by name (stored as a user gradient in LedFX /api/colors).

Delete a palette by name (removes the user gradient from LedFX /api/colors).

List all playlists stored in LedFX

Get a specific LedFX playlist by ID

Start playing a LedFX playlist

Stop the currently playing LedFX playlist

Get the status of the currently playing LedFX playlist

Create a new LedFX playlist with scenes

Update an existing LedFX playlist

Create or replace a playlist safely. If it exists, updates in place.

Patch playlist items with add/remove/move/replace_duration operations

Delete a LedFX playlist

Add a scene to an existing playlist

Get effect recommendations based on description or mood

Get detailed explanation of a LedFX feature or concept

List all explainable LedFX features organized by category

List all available effect types with descriptions, audio-reactivity, gradient support, 2D flag, and blender role recommendations. Use this to choose effects for blenders.

List available audio input devices

Set the active audio input device

Create a complete backup of LedFX configuration (virtuals, scenes, playlists, audio). Optionally saves to a local file path.

Restore LedFX configuration from a backup JSON. Can selectively restore virtuals, scenes, and/or playlists.

Validate a backup JSON structure without restoring it

Deactivate a scene without clearing all effects. Reverses scene activation.

Rename an existing scene

Clear all active effects on all virtuals. Clean slate for authoring.

Apply global config (gradient, brightness, background_color, flip, mirror) to all active effects. Optionally filter by virtual IDs.

Apply a specific effect type and config to multiple virtuals at once. Bulk effect application.

Get full LedFX configuration JSON. Optionally filter to specific sections (audio, melbanks, wled_preferences, etc.).

Update specific LedFX config sections. May trigger restart for core settings.

Import a complete LedFX configuration (with version migration). Creates backup first. Triggers restart.

Reset LedFX configuration to defaults. Creates backup first. Triggers restart.

Delete a virtual and its associated device. Removes references from all scenes.

Update the LED segment mapping of a virtual

Toggle global pause on all virtuals. Returns new paused state.

Delete a specific effect type from a virtual's effect history. Clears the effect if currently active.

Trigger the fallback mechanism on a virtual, reverting it to its default/previous effect

Shutdown or restart LedFX

List all integration instances (QLC+, Spotify, etc.) with their status and config

Create a new integration instance (e.g. QLC+ DMX bridge)

Activate or deactivate an integration by ID

Delete an integration and all its configuration

Get QLC+ integration details: available widgets, event types (Effect Set, Effect Cleared, Scene Activated), and configured event listeners

Map a LedFX event to a QLC+ widget payload. When the event fires, the payload is sent to QLC+ via WebSocket.

Enable or disable a QLC+ event mapping without deleting it

Delete a QLC+ event mapping permanently

Trigger network device discovery to find new LED devices (WLED, etc.)

Get the global brightness value (0-1) that applies to all virtuals

Set the global brightness for all virtuals (0-1)

Set which scene activates automatically when LedFX starts

Check whether all virtuals are globally paused

Send a notification to the LedFX frontend UI