Request schema
{
"type": "object",
"description": "Exactly one of `spec` or `chart` is required. `data` is required with `chart` and optional with `spec` (a spec may carry inline data.values). Remote data URLs are refused; every input lives in the body.",
"properties": {
"data": {
"type": "object",
"description": "Inline data; exactly one of csv, tsv, json or values.",
"properties": {
"csv": {
"type": "string",
"description": "CSV text with a header row. Numbers and ISO dates are parsed."
},
"tsv": {
"type": "string",
"description": "Tab-separated text with a header row."
},
"json": {
"type": "string",
"description": "A JSON array of row objects, as a string."
},
"values": {
"type": "array",
"items": {
"type": "object"
},
"description": "Row objects."
}
}
},
"spec": {
"type": "object",
"description": "A Vega-Lite v6 spec. Any `url` anywhere in it is refused."
},
"chart": {
"type": "object",
"description": "Shorthand that compiles to a single-view Vega-Lite spec. `type` is one of bar, line, area, point, scatter, circle, square, tick, rect, heatmap, arc, pie, donut, boxplot, errorbar, errorband, rule, text, trail; channels (x, y, color, size, shape, theta, ...) take a column name or a field definition; plus xRange, yRange, colors, colorScheme, stack, title, width, height, tooltip.",
"required": [
"type"
],
"properties": {
"type": {
"type": "string"
},
"x": {},
"y": {},
"color": {},
"title": {},
"tooltip": {},
"xRange": {
"type": "array"
},
"yRange": {
"type": "array"
},
"colors": {
"type": "array",
"items": {
"type": "string"
}
},
"width": {
"type": "number"
},
"height": {
"type": "number"
}
}
},
"options": {
"type": "object",
"description": "Render options.",
"properties": {
"format": {
"type": "string",
"enum": [
"svg",
"html"
],
"default": "svg"
},
"tooltips": {
"type": "boolean",
"default": true
},
"theme": {
"type": "string",
"description": "A vega-themes preset",
"e.g. dark.": null
},
"width": {
"type": "number"
},
"height": {
"type": "number"
},
"background": {
"type": "string"
},
"title": {
"type": "string"
}
}
}
}
}
Response schema
{
"type": "object",
"description": "For POST /v1/chart, the rendered chart as JSON: `service` (\"pretty-charts\"), `format` (svg or html), `content_type` (image/svg+xml or text/html), `width` and `height` in pixels, `rows` (inline data rows received), `marks` (data marks drawn), `tooltips`, `render_ms`, `warnings` (Vega and Vega-Lite warnings, if any) and `html` — the SVG element, or a complete HTML document for format html; always the last field. Errors return `{ error: { code, message, details? } }` with a code such as invalid_spec, too_many_rows or render_failed. The other routes (healthz, version, capabilities, openapi.json) return their own small JSON documents.",
"examples": [
{
"service": "pretty-charts",
"format": "svg",
"content_type": "image/svg+xml",
"width": 480,
"height": 300,
"rows": 2,
"marks": 2,
"tooltips": true,
"render_ms": 41,
"warnings": [],
"html": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"480\" height=\"300\" viewBox=\"0 0 480 300\">…</svg>"
}
]
}