Word cloud

chart.word_cloud

ProductionBounded custom (Class B)Deterministicstrictmoderatev1.0.0

No network

Overview

Ranks exact positive weights by value then stable ID and places every supplied NFC term with a frozen deterministic family-local scan. Position and ink area are not quantitative axes. 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.

Weighted display terms need deterministic collision-free placement without pretending to analyze text.

Reliability

We rank the exact weights you supply by value then ID; placement has no PRNG, time, dropping, or rescue rotation. Declared failures: WORD_CLOUD_TERM_INVALID — trigger: a term id, text, annotation, or item bound is invalid; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. WORD_CLOUD_DUPLICATE_TERM — trigger: two supplied terms share the same stable id; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. WORD_CLOUD_WEIGHT_INVALID — trigger: a weight is not a positive exact decimal; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. WORD_CLOUD_GROUP_INVALID — trigger: a term references an absent group or group ids repeat; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. WORD_CLOUD_SCALE_INVALID — trigger: the scale, font range, orientation, or vertical share is invalid; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details. WORD_CLOUD_TERMS_DO_NOT_FIT — trigger: the deterministic scan cannot place every term; retryable: no; unchanged input: will not succeed; next: follow the recovery intent in the error details.

Context footprint

Every glyph box and placement attempt is bounded. A successful call costs 3 execution credits.

When to use it

When terms and weights are already supplied.

When text needs tokenization or linguistic analysis.

Scope

Note

Caller-authored exact weighted terms with deterministic full-fit placement.

Non-goals

Tokenization
Stop words
Stemming
Sentiment
NLP clusters
Computed frequency

Properties

IdempotentRetry safeStreaming supportedFile input supportedRequires external service

Capabilities

generation

Cost & billing

Flat rate per invocation

MetercallsBillable onsuccessCost per call3 credits

File handling

Accepts file_refProduces file_refMax input488.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
terms	array	Yes	Array of 1..500 objects with id, text, positive exact-decimal weight, and optional group, meaning, annotation, and language properties.
groups	array	No	Optional array of 0..24 objects with unique id and optional label properties; omit it when terms are ungrouped.
weightScale	object	No	Optional object with type and fontSize min/max properties for linear, sqrt, or log10 scaling; omit for sqrt and the default 12..64 range.
orientation	string	No	horizontal or orthogonalMixed; default horizontal when omitted.
orthogonal	object	No	Optional object with exact verticalShare from 0..0.5; omit it for the default share used only by orthogonalMixed.
shape	string	No	rectangle or ellipse; default rectangle when omitted.
groupMode	string	No	color or facets; default color when omitted and groups exist.
emphasis	object	No	Optional object with termIds containing existing IDs; omit it for no emphasis and weights are never changed.
width	integer	No	Canvas width in pixels, 100..1600 (optional; default 800). 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, 100..1600 (optional; default 500). 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.
caption	string	No	Optional bounded caption drawn below the cloud; omit it and no caption is emitted.
source	string	No	Optional bounded source attribution; omit it and no source line is emitted.
period	string	No	Optional bounded reporting-period label; omit it and no period line is emitted.
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.
behavior	object	No	Optional motion and interaction object for enter_terms, update_weights, focus_term, focus_group, and trace_rank; omit for static 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.
accessibility	object	No	Optional object with detail and maxItems properties; omit it for the default bounded rank-order detail.
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	Allowlist-checked SVG document, ready to embed. 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	SVG viewBox string (for example "0 0 800 400").
termResults	array	Yes	Array of term objects with exact weight, rank, normalized position, font size, angle, box, facet, group, and target identity.
groupResults	array	Yes	Array of caller-order group objects with id, label, input index, term count, and exact minimum/maximum weight.
scaleResult	object	Yes	Object with scale type, exact minimum/maximum, font-size range, and flat-domain flag properties.
placementResult	object	Yes	Object with frozen no-PRNG scan strategy, shape, orientation, attempt count, and full-fit plot dimensions.
renderSummary	object	Yes	Object with bounded term, group, orientation, and full-fit counts or flags in rank order.
transformationSummary	object	Yes	Object proving no tokenization, merging, filtering, dropping, rescue rotation, or reweighting occurred.
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.
accessibility	object	No	Optional object containing bounded rank-order reading text, detail level, and truncation metadata.
behavior	object	No	Resolved default-on motion and interaction report. Includes the digest-bound host artifact when behavior is enabled and always preserves a complete script-free 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.
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.word_cloud","input":{"terms":[{"id":"quality","text":"Quality","weight":"184"},{"id":"support","text":"Support","weight":"121"}]}}'

Integrations

TypeScript SDK

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

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

const { output } = await sq.execute("chart.word_cloud", {"terms":[{"text":"Quality","id":"quality","weight":"184"},{"text":"Support","id":"support","weight":"121"}]});

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.
WORD_CLOUD_TERM_INVALID	400	No	The request payload failed this skill's input validation.
WORD_CLOUD_DUPLICATE_TERM	400	No	The request payload failed this skill's input validation.
WORD_CLOUD_WEIGHT_INVALID	400	No	The request payload failed this skill's input validation.
WORD_CLOUD_GROUP_INVALID	400	No	The request payload failed this skill's input validation.
WORD_CLOUD_SCALE_INVALID	400	No	The request payload failed this skill's input validation.
WORD_CLOUD_TERMS_DO_NOT_FIT	400	No	The request payload failed this skill's input validation.

Other limits

Limit	Value
Recommended inline bytes	32 KiB

Limitations

Tokenization
Stop words
Stemming
Sentiment
NLP clusters
Computed frequency
Raw documents
Precise area comparison

How to call

POST /v1/execute (requires authentication)

Request bodyjson

{
  "skillKey": "chart.word_cloud",
  "input": {
    "terms": [
      {
        "text": "Quality",
        "id": "quality",
        "weight": "184"
      },
      {
        "text": "Support",
        "id": "support",
        "weight": "121"
      }
    ]
  }
}

Examples

Feedback themes

Inputjson

{
  "terms": [
    {
      "text": "Quality",
      "id": "quality",
      "weight": "184"
    },
    {
      "text": "Support",
      "id": "support",
      "weight": "121"
    }
  ]
}

Expected outputjson

{
  "viewBox": "0 0 800 500",
  "width": 800,
  "groupResults": [],
  "scaleResult": {
    "type": "sqrt",
    "minimum": "121",
    "maximum": "184",
    "minimumFontSize": 12,
    "maximumFontSize": 52,
    "flatDomain": false
  },
  "height": 500,
  "termResults": [
    {
      "group": "",
      "rank": 1,
      "inputIndex": 0,
      "normalizedPosition": "1",
      "id": "quality",
      "box": {
        "width": 226,
        "height": 65.36,
        "x": 287,
        "y": 217.32
      },
      "weight": "184",
      "angle": 0,
      "targetKey": "t-word-09b1a834fd913269",
      "text": "Quality",
      "fontSizePx": 52,
      "facet": 0,
      "meaning": ""
    },
    {
      "group": "",
      "rank": 2,
      "inputIndex": 1,
      "normalizedPosition": "0",
      "id": "support",
      "box": {
        "width": 58,
        "height": 18.16,
        "x": 366.8529892881931,
        "y": 195.9816833631236
      },
      "weight": "121",
      "angle": 0,
      "targetKey": "t-word-f93142b154311000",
      "text": "Support",
      "fontSizePx": 12,
      "facet": 0,
      "meaning": ""
    }
  ],
  "transformationSummary": {
    "applied": false,
    "operations": [],
    "affectedCategoryCount": 0,
    "affectedPointCount": 0,
    "affectedLabelCount": 0
  },
  "accessibility": {
    "title": "Word cloud",
    "detail": "grouped",
    "description": "2 caller-supplied terms ranked by exact weight. Font size is monotonic; position and ink area do not encode quantitative relation."
  },
  "placementResult": {
    "randomized": false,
    "allTermsPlaced": true,
    "algorithm": "frozen-rank-id-spiral-scan-v1",
    "orientation": "horizontal",
    "shape": "rectangle",
    "placementAttempts": 387
  },
  "svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"500\" viewBox=\"0 0 800 500\" role=\"img\" class=\"sq-chart sq-chart--word-cloud sq-family--cartesian sq-theme--squillify sq-surface--light sq-density--standard\" data-sq-style-contract=\"CHART_STYLE@1\" data-sq-chart=\"word-cloud\" data-sq-family=\"cartesian\" data-sq-theme=\"squillify\" data-sq-theme-version=\"1\" data-sq-surface=\"light\" data-sq-density=\"standard\" data-sq-a11y-detail=\"grouped\" aria-labelledby=\"sq-5e7778dbd767-title-0 sq-5e7778dbd767-desc-1\"><title id=\"sq-5e7778dbd767-title-0\">Word cloud</title><desc id=\"sq-5e7778dbd767-desc-1\">2 caller-supplied terms ranked by exact weight. Font size is monotonic; position and ink area do not encode quantitative relation.</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);}</style><rect x=\"0\" y=\"0\" width=\"800\" height=\"500\" fill=\"#ffffff\" class=\"sq-background\" data-sq-role=\"background\"/><g class=\"sq-plot\" data-sq-role=\"plot\"><text x=\"400\" y=\"267.68\" font-size=\"52\" text-anchor=\"middle\" textLength=\"218.4\" lengthAdjust=\"spacing\" fill=\"#2563eb\" class=\"sq-word\" data-sq-role=\"word\" data-sq-target-key=\"t-word-09b1a834fd913269\" data-sq-series-index=\"0\" data-sq-point-index=\"0\" data-sq-palette-index=\"0\">Quality</text><text x=\"395.853\" y=\"209.142\" font-size=\"12\" text-anchor=\"middle\" textLength=\"50.4\" lengthAdjust=\"spacing\" fill=\"#2563eb\" class=\"sq-word\" data-sq-role=\"word\" data-sq-target-key=\"t-word-f93142b154311000\" data-sq-series-index=\"0\" data-sq-point-index=\"1\" data-sq-palette-index=\"0\">Support</text></g></svg>",
  "renderSummary": {
    "variation": "word-cloud",
    "termCount": 2,
    "groupCount": 0,
    "scale": "sqrt",
    "positionIsQuantitative": false,
    "inkAreaIsProportional": false
  }
}

Grouped survey topics