Get Chart Palette

palette.get

ProductionBounded custom (Class B)Deterministicstrictinstantv5.0.0

No network

Overview

When you already know which palette you want, pass its id or alias and we return the approved colours — and for gradients, the colour stops — plus ready-to-apply tokens. We look up one reviewed Squillify palette only; we do not search, rank, or invent colours. Works for distinct series colours (categorical) and continuous scales (sequential, diverging, cyclical). If you are still choosing colours, use palette.recommend instead. Max input 4096 bytes.

Charts need stable, reviewed colours that you can reuse by id without drift.

Reliability

STRICT and deterministic — same id, count, center, target, and direction always resolve the same colours. Domain errors (not retryable — fix the input; unchanged input will fail again): PALETTE_NOT_FOUND (unknown id or alias — check the id or call palette.recommend); PALETTE_COUNT_REQUIRED (adaptive categorical palette without count — pass count 2..8); PALETTE_UNSUPPORTED_COUNT (count outside the range for this palette's shape, or a count a fixed set does not publish — 2..8 series colours, 2..32 stops); PALETTE_KIND_UNSUPPORTED (a field that does not apply to this palette's kind, such as center on a non-diverging one — remove the extra field); PALETTE_TARGET_UNSUPPORTED (target belongs to the other shape, or is not one of chart_series, color_gradient, generic — leave it out and the palette's shape decides); PALETTE_VALUE_INVALID (malformed direction, center, or related fields — correct the value).

Context footprint

Returns one palette object with hex colours and, for continuous kinds, stops. No chart image is rendered. A successful call costs 1 execution credit.

When to use it

You already have a palette id or alias and need its colours or stops.

You need suggestions from preferences — use palette.recommend. If no reviewed palette fits hard constraints, use palette.generate.

Scope

Note

Returns one reviewed Squillify chart palette by id or alias — series colours or a continuous scale — with hex colours and ready-to-apply tokens.

Non-goals

Does not search or rank palettes by preference — use palette.recommend
Does not invent or remix colours
Does not draw or restyle a chart — you apply the returned colours
Does not map your data values onto colours — your chart skill does that

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

searchvalidation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call1 credit

File handling

Accepts file_refProduces file_refMax input4 KB

How we handle your data

Sensitive input, safe output

What this means

This skill may receive sensitive content, but it does not target sensitive data and returns only a structured non-sensitive result.

Squillify guarantees

Runs inside Squillify
This skill runs inside Squillify.
Payloads are not sent to an external service by this skill.
Squillify does not permanently store submitted payloads.
Telemetry records metadata only, not submitted content.
Submitted payloads are not used for training.
Submitted payloads are not reviewed by humans.
This skill does not target sensitive data.
The response does not contain submitted content.

Your responsibility

Squillify does not determine whether submitted content is sensitive. Your application is responsible for deciding what data it is allowed to submit. Your application is responsible for securing the response.

Read the Microskill Data Handling Policy

Input schema

Field	Type	Required	Description
id	string	Yes	Palette id or stable alias to resolve, for example sq.default.categorical.adaptive.light@1.
count	integer	No	How many colours to return, 2 through 8 for categorical and 2 through 32 stops for a continuous ramp. Required when the palette is adaptive; omit it for a fixed published set.
center	string	No	Where a diverging ramp is centred; omit it for zero on diverging palettes. Rejected for other kinds.
target	string	No	Where the colours will be applied: chart_series, color_gradient or generic; omit it so the palette's own shape chooses.
direction	string	No	Colour order; omit it for normal.

Output schema

Field	Type	Required	Description
palette	object	Yes	Closed ready-to-apply palette with provenance, kind, model, surface, colours, optional gradient stops, application tokens, evidence and warnings.
warnings	array	Yes	Non-fatal notices as strings, 0 through 32 items, often empty.

API contract

POST /v1/execute

curl

curl -sS -X POST "$BASE/v1/execute" -H "Authorization: Bearer $KEY" -H 'Content-Type: application/json' -d '{"skillKey":"palette.get","input":{"id":"sq.default.categorical.adaptive.light@1","count":6,"target":"chart_series"}}'

Integrations

TypeScript SDK

import { Squillify } from "@squillify/sdk";

const sq = new Squillify({ apiKey: process.env.SQUILLIFY_API_KEY });

const { output } = await sq.execute("palette.get", {"target":"chart_series","id":"sq.default.categorical.adaptive.light@1","count":6});

Errors

Code	HTTP	Retryable	Description
VALIDATION_ERROR	400	No	The request payload failed schema validation.
UNAUTHORIZED	401	No	Missing or invalid API key.
SKILL_NOT_ACCESSIBLE	403	No	The API key is not granted access to this skill.
SKILL_NOT_AVAILABLE_FOR_PLAN	403	No	This skill is not included in your current plan.
PLAN_ELIGIBILITY_UNAVAILABLE	503	Yes	Plan eligibility could not be decided. Retry after backoff.
SKILL_NOT_FOUND	404	No	The requested skill or version does not exist.
TENANT_RATE_LIMITED	429	Yes	Request rate limit exceeded. Retry after backoff.
QUOTA_EXCEEDED	429	Yes	Plan quota exhausted. Retryable once the quota period resets.
EXECUTION_TIMEOUT	504	Yes	Execution exceeded the allowed time budget.
PALETTE_NOT_FOUND	412	No	The input is valid but cannot be processed as-is.
PALETTE_COUNT_REQUIRED	400	No	The request payload failed this skill's input validation.
PALETTE_UNSUPPORTED_COUNT	400	No	The request payload failed this skill's input validation.
PALETTE_KIND_UNSUPPORTED	400	No	The skill does not support the requested variant.
PALETTE_TARGET_UNSUPPORTED	400	No	The skill does not support the requested variant.
PALETTE_VALUE_INVALID	400	No	The request payload failed this skill's input validation.

Other limits

Limit	Value
Recommended inline bytes	32 KiB

Limitations

Does not search or rank palettes by preference — use palette.recommend
Does not invent or remix colours
Does not draw or restyle a chart — you apply the returned colours
Does not map your data values onto colours — your chart skill does that
Browsing for a palette when you do not know the id yet
Picking colours from mood or brand adjectives alone

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "palette.get",
  "input": {
    "target": "chart_series",
    "id": "sq.default.categorical.adaptive.light@1",
    "count": 6
  }
}

Examples

Six-series default on a light chart

Inputjson

{
  "target": "chart_series",
  "id": "sq.default.categorical.adaptive.light@1",
  "count": 6
}

Expected outputjson

{
  "palette": {
    "ref": {
      "source": "registry",
      "registry": "squillify-core-palettes",
      "registryDigest": "sha256:d5d4ee7cdb6425cdfe6cc0cf1bac317cb9bb0bc7c9b70380de4adf31fb0b3e17",
      "paletteId": "sq.categorical.dashboard.professional-cool-spectrum.002@1",
      "variant": "count-6.light",
      "paletteDigest": "sha256:73536ed4d96c4c3dcc431ea6094df3ca993597ffd17f2e86ab42073f17025a9f"
    },
    "displayName": "Squillify Dashboard Professional — Cool Spectrum 002",
    "kind": "categorical",
    "model": "adaptive",
    "surface": "light",
    "cardinality": 6,
    "colors": [
      "#077F61",
      "#00616C",
      "#2E8FB5",
      "#004273",
      "#705FA2",
      "#004E1E"
    ],
    "direction": "normal",
    "application": {
      "target": "chart_series",
      "chartStyleTokens": {
        "--sq-series-1": "#077F61",
        "--sq-series-2": "#00616C",
        "--sq-series-3": "#2E8FB5",
        "--sq-series-4": "#004273",
        "--sq-series-5": "#705FA2",
        "--sq-series-6": "#004E1E"
      }
    },
    "evidence": {
      "state": "certified"
    },
    "warnings": []
  },
  "warnings": []
}

Tip

Six approved colours plus matching chart style tokens for a light surface

Sequential default for a light heatmap