For the complete documentation index, see llms.txt. This page is also available as Markdown.

Community tools

Tools for publishing and managing palettes in the community — authentication required

These tools interact with the UI Color Palette database. They require authentication — see Authentication.


list_published_palettes

List publicly shared palettes from the community. No authentication required.

Input

Parameter
Type
Required
Description

page

number

No

Page number (default: 1)

limit

number

No

Results per page, max 50 (default: 20, recommended: 5 to avoid large payloads)

search

string

No

Filter by palette name


list_my_published_palettes

List the authenticated user's own published palettes. Requires authentication.

Input

Parameter
Type
Required
Description

page

number

No

Page number (default: 1)

limit

number

No

Results per page, max 50 (default: 20, recommended: 5)

search

string

No

Filter by palette name


get_published_palette

Fetch a specific palette by its ID. No authentication required.

Input

Parameter
Type
Required
Description

paletteId

string

Yes

Unique identifier of the palette


publish_palette

Save a new palette to the database. Requires authentication.

The palette is private by default (is_shared: false). Call share_published_palette afterwards to make it public.

Input

Parameter
Type
Required
Description

name

string

Yes

Palette name

description

string

No

Optional description

preset

Yes

Shade stop configuration

shift

{ chroma: number, hue: number }

Yes

Global shift adjustments

are_source_colors_locked

boolean

No

Lock source colors (default: false)

colors

Yes

Source colors — at least one required

themes

Yes

Theme configurations — at least one required

color_space

enum

Yes

Color space for shade interpolation (e.g. "LCH")

algorithm_version

"v1" | "v2" | "v3"

Yes

Algorithm version — use "v3"

is_shared

boolean

No

Whether the palette is publicly visible (default: false)


update_published_palette

Update an existing published palette. Requires authentication. Only the fields you provide are updated.

Input

Parameter
Type
Required
Description

paletteId

string

Yes

ID of the palette to update

name

string

No

Updated name

description

string

No

Updated description

preset

object

No

Updated preset configuration

shift

object

No

Updated shift configuration

are_source_colors_locked

boolean

No

Updated lock state

colors

array

No

Updated color definitions

themes

array

No

Updated theme configurations

color_space

string

No

Updated color space

algorithm_version

string

No

Updated algorithm version

is_shared

boolean

No

Updated sharing visibility


share_published_palette

Make a published palette publicly visible in the community. Requires authentication.

Input

Parameter
Type
Required
Description

paletteId

string

Yes

ID of the palette to share


unshare_published_palette

Remove a palette from the public community listing while keeping it in the database. Requires authentication.

Input

Parameter
Type
Required
Description

paletteId

string

Yes

ID of the palette to make private


unpublish_palette

Permanently delete a published palette from the database. This action is irreversible. Requires authentication.

Input

Parameter
Type
Required
Description

paletteId

string

Yes

ID of the palette to delete


Typical publish workflow

To update later:

Last updated