Render Word Cloud
quickchart.render_word_cloud
ActionBusiness appsconnection required
Calls the QuickChart API with the connection's credentials.
Render a word cloud from a block of text and emit it as a base64 file blob.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- QuickChart
- Secret shape
- the API key, or {"api_key": "…"} — optional, since QuickChart's free tier and a self-hosted instance need none
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
15 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
text The text to build the cloud from. Set use_word_list when this is a comma-separated list of words rather than prose. | string | Yes | — | — | renewal churn upgrade renewal onboarding renewal upgrade |
format File format QuickChart should render the cloud in. | string | No | svg | one of "svg", "png" | — |
width Width of the rendered image in pixels. | number | No | 600 | ≥ 1 | — |
height Height of the rendered image in pixels. | number | No | 600 | ≥ 1 | — |
background_color Canvas background behind the chart, as a colour name, hex, rgb() or hsl() value. QuickChart leaves it transparent when this is empty. | string | No | — | — | white |
font_family Font family to draw the words in. | string | No | — | — | serif |
font_scale Approximate size in pixels of the largest word in the cloud. | number | No | 25 | ≥ 1 | — |
scale How a word's frequency is scaled to its font size. | string | No | linear | one of "linear", "sqrt", "log" | — |
max_num_words Maximum number of distinct words to draw. | number | No | 200 | ≥ 1 | — |
min_word_length Shortest word, in characters, that is allowed into the cloud. | number | No | 1 | ≥ 1 | — |
case How the words are cased before they are counted and drawn. | string | No | lower | one of "lower", "upper", "none" | — |
colors Colours to pick from at random for each word; QuickChart chooses its own when this is empty. | array | No | — | array of string | ["#3366cc","#dc3912","#ff9900"] |
remove_stopwords Drop common filler words such as 'the' and 'and' before counting. | boolean | No | false | — | — |
use_word_list Treat the text as a comma-separated list of words instead of prose. | boolean | No | false | — | — |
filename Name to give the rendered file on the wire. Defaults to the node's subject and the chosen format, such as chart.png. | string | No | — | — | chart.png |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"background_color": "white",
"case": "lower",
"colors": [
"#3366cc",
"#dc3912",
"#ff9900"
],
"filename": "chart.png",
"font_family": "serif",
"font_scale": 25,
"format": "svg",
"height": 600,
"max_num_words": 200,
"min_word_length": 1,
"remove_stopwords": false,
"scale": "linear",
"text": "renewal churn upgrade renewal onboarding renewal upgrade",
"use_word_list": false,
"width": 600
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
file_content The file, base64-encoded. | string | — |
content_encoding | string | base64 |
filename | string | app-main.zip |
content_type | string | application/zip |
size Raw size in bytes (before base64). | number | — |
{
"content_encoding": "base64",
"content_type": "application/zip",
"file_content": "",
"filename": "app-main.zip",
"size": 0
}Notes
- Hosted QuickChart only: the open-source self-hosted server does not serve /wordcloud.
Related QuickChart nodes
See Render Word Cloud run in a workflow.
In a technical demo we add the QuickChart connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.