Create Chart URL

quickchart.create_chart_url

ActionBusiness appsconnection required

Calls the QuickChart API with the connection's credentials.

Store a Chart.js configuration on QuickChart and return a short URL that renders it, so a chart can be embedded in an email or a page without putting the account's API key in front of the reader.

Ask about QuickChart All QuickChart nodes Provider API docs ↗

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

7 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
chart The Chart.js configuration to render. Send an object for a plain JSON config; a string is forwarded verbatim, which is how QuickChart accepts a config carrying JavaScript such as a label formatter.	object	Yes	—	≥ 1 characters	{"data":{"datasets":[{"data":[50,60,70,180],"label":"Revenue"}],"labels":["Q1","Q2","Q3","Q4"]},"type":"bar"}
width Width of the rendered image in pixels.	number	No	500	≥ 1	—
height Height of the rendered image in pixels.	number	No	300	≥ 1	—
format File format the short URL should render in.	string	No	png	one of "png", "svg", "webp"	—
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
version Chart.js version to render with — '2', '3', '4' or an exact version. Leave empty for the QuickChart default.	string	No	—	—	4
device_pixel_ratio Resolution multiplier applied to the width and height, for retina-quality output.	number	No	2	≥ 1	—

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "background_color": "white",
  "chart": {
    "data": {
      "datasets": [
        {
          "data": [
            50,
            60,
            70,
            180
          ],
          "label": "Revenue"
        }
      ],
      "labels": [
        "Q1",
        "Q2",
        "Q3",
        "Q4"
      ]
    },
    "type": "bar"
  },
  "device_pixel_ratio": 2,
  "format": "png",
  "height": 300,
  "version": "4",
  "width": 500
}

Output

One shape.

result

Field	Type	Example
url The short URL that renders the stored chart.	string	—
success True when QuickChart stored the configuration.	boolean	—
chart_id The identifier at the end of the short URL.	string	—

{
  "chart_id": "",
  "success": false,
  "url": ""
}

Notes

Hosted QuickChart only: the open-source self-hosted server does not serve /chart/create.

Related QuickChart nodes

See Create Chart URL 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.

Book a technical demo Talk to sales