KPI card

chart.kpi

ProductionBounded custom (Class B)Deterministicstrictfastv1.0.0

No network

Overview

Send one exact-decimal KPI value plus optional previous value, target, compact trend and closed threshold ranges. The result is a deterministic safe SVG; requested host behavior adds bounded explanatory panels and digest-bound update recipes. Do not use for qualitative status-only cards or point-level trend exploration. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.

KPI arithmetic and threshold boundaries must remain reproducible and explainable instead of being inferred from formatted floating-point text.

Reliability

You provide bounded exact decimal strings; we produce byte-stable SVG and behavior artifacts for identical input. Declared failures: CHART_CAPACITY_EXCEEDED — trigger: the required KPI text or compact trend cannot fit legibly; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. CHART_OUTPUT_TOO_LARGE — trigger: the inline SVG byte budget would be exceeded at the requested size and data density; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. CHART_UNSAFE_OUTPUT — trigger: the finished SVG failed our final safety re-validation (this is on us, not your data); retryable: no; unchanged input: will not succeed; next: contact support with the request id — retrying the same input will not help.

Context footprint

Prefer descriptor.contractSections.recommendedRendering. Pass output.behavior.artifact unchanged to SquillifyChartRuntime.mount; resolve artifact.runtimeRequirement and every resourceRequirements item first. motionPlan.requiredRuntime is not a resolver input. A successful call costs 3 execution credits.

When to use it

When one exact quantitative metric is the primary reading.

When the input is qualitative, contains several metrics, or needs a full axis.

Scope

Note

One quantitative KPI card with exact-decimal calculations, optional target, threshold-derived status, and one compact trend.

Non-goals

Qualitative caller-owned status
Point-level trend exploration
Multiple KPI cards in one invocation

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

generationimage-processing

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call3 credits

File handling

Accepts file_refProduces file_refMax input195.3 KB

How we handle your data

Sensitive output possible

What this means

This skill may receive sensitive content and may return submitted, transformed, extracted, or reformatted content.

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 may contain submitted or transformed 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
data	object	Yes	Required closed object: value is an exact decimal string; previous and target are optional exact decimal strings; trend is 2..200 finite JSON numbers or null gaps with at least two numbers.
options	object	No	Optional closed object containing content, delta, thresholds, and format. format may deterministically format the visible primary value while leaving exact calculation values unchanged; omission uses two fixed decimals, and percentage-typed values add %. Thresholds require basis value\|deltaAbsolute\|deltaPercent\|attainment and 1..16 ordered non-overlapping ranges with inclusive min and exclusive max. When omitted, content is generated, delta is hidden, and no status is classified.
localization	object	No	Optional closed locale selection for deterministic visible number formatting; defaults to en and accepts only the frozen locale registry.
behavior	object	No	Optional bounded host motion and interaction request. Motion presets: enter_metric, update_value, update_attainment, append_trend, status_change, focus_explanation. Interaction capability: focus_explanation. When omitted, the result is static SVG only. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
width	integer	No	Canvas width in pixels, 100..1600 (optional; default 360). Outside that range the request is refused as invalid input rather than clamped. The ceiling is the size a chart is read at — a full-HD dashboard or a report page; beyond it the canvas stops being what limits how much fits, and type sized for the canvas is illegible once the export is displayed smaller. It applies per side, so a tall portrait canvas for a long horizontal ranking is allowed.
height	integer	No	Canvas height in pixels, 60..1600 (optional; default 210). Outside that range the request is refused as invalid input rather than clamped. The ceiling is the size a chart is read at — a full-HD dashboard or a report page; beyond it the canvas stops being what limits how much fits, and type sized for the canvas is illegible once the export is displayed smaller. It applies per side, so a tall portrait canvas for a long horizontal ranking is allowed.
title	string	No	Heading drawn above the plot (optional; at most 1024 code points). Omit it and the chart renders untitled — we never invent a title from your data. One code point past that ceiling is refused as TOOL_INPUT_INVALID.
subtitle	string	No	Second line under the title, useful for the period covered or the unit (optional; at most 1024 code points). Omit it and no second line is drawn.
theme	string	No	Visual language: basic, modern or squillify (optional; default squillify). An unregistered value is rejected with the registered names listed — we never substitute silently.
surface	string	No	Surface the theme renders on: dark or light (optional; default light).
density	string	No	How tightly the chrome is packed: compact, standard or spacious (optional; default standard). Density scales spacing only — it never lowers a legibility minimum.
visualProfile	string	No	What the SVG promises about the host font: portable or certified (optional; default portable). The default is layout-deterministic and tolerates substitution; certified refuses text the certified metrics cannot fully measure.
style	object	No	Optional bounded paint and typography styling; omit it to use the selected theme defaults. text.size is expressed in normalized design pixels at an 800-pixel reference width, so equivalent roles match at equal CSS width. It never changes data or accessibility. 'contract' selects the published semantics. 'tokens' sets design tokens; 'rules' applies typed properties to a role and optional series/category facets; 'palette' accepts a digest-checked palette; 'css' is a bounded post-layout stylesheet. The styleCapabilities section publishes this family's accepted roles, properties and copyable examples. For Bar, target one mark with role 'bar' plus seriesIndex and categoryIndex; categoryIndex alone targets that category across series. A minimal rule is {"target":{"role":"bar"},"set":{"paint.fill":"#2563eb"}}. Unsupported typed rules are refused; unsupported CSS is dropped and reported. Do not discover the grammar through trial calls: style validation failures are currently billable. Before calling, read this contract's styleSurface and styleCapabilities sections for the complete rule shape, accepted roles and properties, limits, and copyable examples.
output	object	No	Output scoping (optional). Nested key output.idNamespace ([a-z][a-z0-9-]{0,31}) is prefixed onto every generated element id when several charts share one host document; omit for a standalone chart. An invalid namespace is rejected.

Output schema

Field	Type	Required	Description
svg	string	Yes	Final script-free canonical SVG. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
width	integer	Yes	Rendered width in pixels.
height	integer	Yes	Rendered height in pixels.
viewBox	string	Yes	Rendered SVG coordinate system in min-x min-y width height form.
behavior	object	No	Validated manifest, bounded data index, digest-bound artifact, optional entry plan, and renderer-owned transition recipe when behavior is requested. svg is a complete static, script-free chart. Mark highlight, the dotted guide, and the value panel are not in that SVG, and entry motion, focus, and updates stay inactive there. Pass the entire output.behavior.artifact unchanged to SquillifyChartRuntime.mount(container, artifact, options), then call the returned handle's replay() once to play the entry. A later value change uses update(nextArtifact, {intent}). Injecting svg directly leaves hover and motion off. Interaction is on by default for every host chart: after mount, pointer and keyboard focus open the value panel and the dotted guide. Set behavior.interaction.enabled to false to turn that off. motion.preset accepts only the family's entrance.
styleReport	object	No	Always reports the resolved typographyProfile and fontMetrics contract, plus tokensApplied, rulesApplied, typedRulesApplied, typedAssignmentsApplied, rulesDropped, declarationsDropped and, when anything was dropped, a bounded list of reasons.
warnings	array	No	Present when the render succeeded with a known degradation. Each entry is an object with a stable code, a message and details. Every chart can emit FONT_SUBSTITUTION_POSSIBLE under visualProfile 'portable', FONT_GLYPH_UNMEASURED when a code point falls outside the certified metrics, and CHART_STYLE_PARTIALLY_APPLIED when part of your styling was dropped — styleReport then names which part and why. Codes are stable for agent routing.

API contract

POST /v1/execute

curl

curl -sS -X POST "$BASE/v1/execute" \
  -H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
  -d '{"skillKey":"chart.kpi","input":{"data":{"value":"1250000","previous":"1180000"},"options":{"content":{"label":"Annual recurring revenue","unit":"USD"},"delta":{"mode":"percent","direction":"higherIsBetter"}},"behavior":{"motion":{"enabled":true,"preset":"enter_metric","reducedMotion":"respect"},"interaction":{"enabled":true,"capabilities":["focus_explanation"]}}}}'

Integrations

TypeScript SDK

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

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

const { output } = await sq.execute("chart.kpi", {"height":210,"data":{"value":"1250000","previous":"1180000","target":"1300000"},"options":{"delta":{"direction":"higherIsBetter","mode":"percent"},"content":{"label":"Annual recurring revenue","unit":"USD"}},"width":360});

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.
CHART_CAPACITY_EXCEEDED	429	No	A size, quota, rate, or time limit was exceeded.
CHART_OUTPUT_TOO_LARGE	429	No	A size, quota, rate, or time limit was exceeded.
CHART_UNSAFE_OUTPUT	500	No	The skill encountered an unexpected execution failure.

Other limits

Limit	Value
Recommended inline bytes	32 KiB

Limitations

Qualitative caller-owned status
Point-level trend exploration
Multiple KPI cards in one invocation
Full time series (use chart.line)
Qualitative health state (use chart.signal)
Dashboard composition

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "chart.kpi",
  "input": {
    "height": 210,
    "data": {
      "value": "1250000",
      "previous": "1180000",
      "target": "1300000"
    },
    "options": {
      "delta": {
        "direction": "higherIsBetter",
        "mode": "percent"
      },
      "content": {
        "label": "Annual recurring revenue",
        "unit": "USD"
      }
    },
    "width": 360
  }
}

Examples

Revenue KPI

Inputjson

{
  "height": 210,
  "data": {
    "value": "1250000",
    "previous": "1180000",
    "target": "1300000"
  },
  "options": {
    "delta": {
      "direction": "higherIsBetter",
      "mode": "percent"
    },
    "content": {
      "label": "Annual recurring revenue",
      "unit": "USD"
    }
  },
  "width": 360
}

Expected outputjson

{
  "viewBox": "0 0 360 210",
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"360\" height=\"210\" viewBox=\"0 0 360 210\" role=\"img\" class=\"sq-chart sq-chart--kpi sq-family--kpi-status sq-theme--squillify sq-surface--light sq-density--standard\" data-sq-style-contract=\"CHART_STYLE@1\" data-sq-chart=\"kpi\" data-sq-family=\"kpi-status\" data-sq-theme=\"squillify\" data-sq-theme-version=\"1\" data-sq-surface=\"light\" data-sq-density=\"standard\" data-sq-a11y-detail=\"full\" aria-labelledby=\"sq-82dc4b46f057-title-1 sq-82dc4b46f057-desc-2\"><title id=\"sq-82dc4b46f057-title-1\">Annual recurring revenue</title><desc id=\"sq-82dc4b46f057-desc-2\">KPI Annual recurring revenue: 1,250,000.00 USD; delta 5.93%; 96.15% target</desc><style>.sq-chart{--sq-chart-axis:#c9d1df;--sq-chart-font-family:'Squillify Mono', 'IBM Plex Mono', monospace;--sq-chart-grid:#d8dee9;--sq-chart-surface:#ffffff;--sq-chart-text-muted:#667085;--sq-chart-text-primary:#101828;--sq-series-1:#2563eb;--sq-series-2:#6d5ce7;--sq-series-3:#168a5b;--sq-series-4:#c45412;--sq-series-5:#d92d20;--sq-series-6:#667085;font-family:var(--sq-chart-font-family);font-weight:500;}.sq-chart .sq-background{fill:var(--sq-chart-surface);}.sq-chart .sq-title{fill:var(--sq-chart-text-primary);}.sq-chart .sq-kpi-label{fill:var(--sq-chart-text-muted);}.sq-chart .sq-kpi-value{fill:var(--sq-chart-text-primary);}.sq-chart .sq-kpi-delta{fill:var(--sq-chart-text-primary);}</style><defs><linearGradient id=\"sq-82dc4b46f057-fh-0\" gradientUnits=\"objectBoundingBox\" x1=\"0\" y1=\"0\" x2=\"1\" y2=\"0\"><stop offset=\"0\" stop-color=\"#f0f5fe\"/><stop offset=\"0.54\" stop-color=\"#ffffff\"/></linearGradient></defs><rect x=\"0\" y=\"0\" width=\"360\" height=\"210\" fill=\"#ffffff\" class=\"sq-background\" data-sq-role=\"background\"/><rect x=\"0\" y=\"0\" width=\"360\" height=\"60\" fill=\"url(#sq-82dc4b46f057-fh-0)\" class=\"sq-brand-band\"/><rect x=\"0\" y=\"60\" width=\"360\" height=\"150\" fill=\"#f8fafd\" class=\"sq-plot\" data-sq-role=\"plot\"/><line x1=\"0\" y1=\"60\" x2=\"360\" y2=\"60\" stroke=\"#c9d1df\" stroke-width=\"1\" class=\"sq-card-frame\"/><text x=\"12\" y=\"16\" font-size=\"4.5\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"600\" letter-spacing=\"0.54\" textLength=\"11\" lengthAdjust=\"spacing\" fill=\"#2563eb\" class=\"sq-caption\" data-sq-role=\"caption\">KPI</text><text x=\"12\" y=\"43\" font-size=\"7.2\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"600\" letter-spacing=\"-0.144\" textLength=\"102\" lengthAdjust=\"spacing\" fill=\"#101828\" class=\"sq-title\" data-sq-role=\"title\">Annual recurring revenue</text><rect x=\"0.5\" y=\"0.5\" width=\"359\" height=\"209\" fill=\"none\" stroke=\"#c9d1df\" stroke-width=\"1\" class=\"sq-card-frame\"/><rect x=\"17.4\" y=\"74\" width=\"32\" height=\"16.5\" fill=\"none\" stroke=\"#168a5b\" stroke-width=\"1\" class=\"sq-label-badge\" data-sq-role=\"kpi-label\"/><text x=\"23.4\" y=\"85.22\" font-size=\"4.5\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"600\" letter-spacing=\"0.54\" textLength=\"20\" lengthAdjust=\"spacing\" fill=\"#168a5b\" class=\"sq-kpi-label\" data-sq-role=\"kpi-label\" data-sq-target-key=\"t-kpi-3f4594c47531adad\">ANNUAL</text><text x=\"17.4\" y=\"115.577\" font-size=\"21.6\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"600\" letter-spacing=\"-0.157\" textLength=\"206\" lengthAdjust=\"spacing\" fill=\"#101828\" class=\"sq-kpi-value\" data-sq-role=\"kpi-value\" data-sq-target-key=\"t-kpi-b374ebf1171ab454\">1,250,000.00 USD</text><text x=\"17.4\" y=\"129.577\" font-size=\"4.5\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"600\" textLength=\"20\" lengthAdjust=\"spacing\" fill=\"#168a5b\" class=\"sq-kpi-delta\" data-sq-role=\"kpi-delta\" data-sq-target-key=\"t-kpi-d9e25064dd3b6fcf\">↑ 5.93%</text><text x=\"41.9\" y=\"129.577\" font-size=\"4.5\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"500\" textLength=\"50\" lengthAdjust=\"spacing\" fill=\"#667085\" class=\"sq-kpi-delta\" data-sq-role=\"kpi-delta\" data-sq-target-key=\"t-kpi-82f0fcf5cc273d8f\">vs previous period</text><text x=\"17.4\" y=\"137.427\" font-size=\"4.5\" text-anchor=\"start\" font-family=\"&#39;Squillify Mono&#39;, &#39;IBM Plex Mono&#39;, monospace\" font-weight=\"500\" textLength=\"37\" lengthAdjust=\"spacing\" fill=\"#667085\" class=\"sq-kpi-delta\" data-sq-role=\"kpi-delta\" data-sq-target-key=\"t-kpi-83c840b7181e09f9\">96.15% target</text></svg>",
  "width": 360,
  "height": 210
}

Compact trend with a missing observation