element shown as a browser tooltip and used by screen readers. Example: ?title=ChartQuery+Website","schema":{"type":"string","description":"SVG <title> element shown as a browser tooltip and used by screen readers. Example: ?title=ChartQuery+Website"}},{"name":"desc","in":"query","required":false,"description":"SVG <desc> element for extended accessibility description. Example: ?desc=Scan+to+visit+https://chartquery.com","schema":{"type":"string","description":"SVG <desc> element for extended accessibility description. Example: ?desc=Scan+to+visit+https://chartquery.com"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png"}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/barcode":{"get":{"summary":"Barcode","description":"Generate a barcode image via GET. Output: SVG (default) or PNG. Supports 25+ formats: EAN-13, Code 128, ITF-14, GS1-128, postal codes and more.\n\n**Credit cost:** 3 credits per call","operationId":"barcode","parameters":[{"name":"data","in":"query","required":true,"description":"The data to encode in the barcode. Examples by type:\n\n**EAN-13** (retail): `4006381333931`\n**EAN-8** (small pack): `73513535`\n**UPC-A** (North America): `012345678905`\n**Code 128** (general): `HELLO-WORLD-2026` or `INV-2026-00456`\n**Code 39** (uppercase): `CODE39-DEMO` or `SHELF-A12`\n**ITF-14** (carton): `00012345678905`\n**GS1-128** (with AIs): `(01)12345678901234(17)260101`\n**Codabar** (library): `A1234567890B`\n**POSTNET** (postal): `902100123`","schema":{"type":"string","description":"The data to encode in the barcode. Examples by type:\n\n**EAN-13** (retail): `4006381333931`\n**EAN-8** (small pack): `73513535`\n**UPC-A** (North America): `012345678905`\n**Code 128** (general): `HELLO-WORLD-2026` or `INV-2026-00456`\n**Code 39** (uppercase): `CODE39-DEMO` or `SHELF-A12`\n**ITF-14** (carton): `00012345678905`\n**GS1-128** (with AIs): `(01)12345678901234(17)260101`\n**Codabar** (library): `A1234567890B`\n**POSTNET** (postal): `902100123`"}},{"name":"type","in":"query","required":false,"description":"Barcode format. Default: `code128`.\n\n**Retail:** `ean13`, `ean8`, `ean5`, `ean2`, `upca`, `upce`\n**General:** `code128`, `code39`, `code39ext`, `code93`, `code93ext`\n**Logistics:** `itf`, `itf14`, `gs1-128`, `gs1-databar`, `gs1-databar-limited`, `gs1-databar-expanded`\n**Other:** `codabar`, `msi`, `pharmacode`, `code11`, `plessey`\n**Postal:** `postnet`, `planet`, `identcode`, `leitcode`","schema":{"type":"string","enum":["code128","ean13","ean8","upca","upce","code39","itf","itf14","codabar","gs1-128","postnet","planet","plessey"],"default":"code128","description":"Barcode format. Default: `code128`.\n\n**Retail:** `ean13`, `ean8`, `ean5`, `ean2`, `upca`, `upce`\n**General:** `code128`, `code39`, `code39ext`, `code93`, `code93ext`\n**Logistics:** `itf`, `itf14`, `gs1-128`, `gs1-databar`, `gs1-databar-limited`, `gs1-databar-expanded`\n**Other:** `codabar`, `msi`, `pharmacode`, `code11`, `plessey`\n**Postal:** `postnet`, `planet`, `identcode`, `leitcode`"}},{"name":"height","in":"query","required":false,"description":"Bar height in pixels. Default: 80. Typical values: 50 (compact), 80 (standard), 100–120 (tall labels). Example: ?height=100","schema":{"type":"number","description":"Bar height in pixels. Default: 80. Typical values: 50 (compact), 80 (standard), 100–120 (tall labels). Example: ?height=100"}},{"name":"color","in":"query","required":false,"description":"Bar color as a CSS color string. Default: #000. Examples: ?color=%231e293b (dark slate), ?color=%230f172a (near black), ?color=%237c3aed (purple), ?color=%23dc2626 (red). Use %23 to URL-encode the # character.","schema":{"type":"string","description":"Bar color as a CSS color string. Default: #000. Examples: ?color=%231e293b (dark slate), ?color=%230f172a (near black), ?color=%237c3aed (purple), ?color=%23dc2626 (red). Use %23 to URL-encode the # character."}},{"name":"show_text","in":"query","required":false,"description":"Show human-readable text below the bars. Example: ?show_text=true. Combine with font_size and text_align for print labels.","schema":{"type":"boolean","description":"Show human-readable text below the bars. Example: ?show_text=true. Combine with font_size and text_align for print labels."}},{"name":"text_position","in":"query","required":false,"description":"Position of the human-readable text label. Default: bottom. Example: ?text_position=top","schema":{"type":"string","enum":["bottom","top"],"default":"bottom","description":"Position of the human-readable text label. Default: bottom. Example: ?text_position=top"}},{"name":"text_align","in":"query","required":false,"description":"Horizontal alignment of the text label. Default: center. Example: ?text_align=left","schema":{"type":"string","enum":["center","left","right"],"default":"center","description":"Horizontal alignment of the text label. Default: center. Example: ?text_align=left"}},{"name":"font_size","in":"query","required":false,"description":"Font size of the text label in pixels. Default: 14. Example: ?font_size=12","schema":{"type":"number","description":"Font size of the text label in pixels. Default: 14. Example: ?font_size=12"}},{"name":"font_family","in":"query","required":false,"description":"Font family of the text label. Default: monospace. Examples: ?font_family=monospace, ?font_family=sans-serif, ?font_family=Arial","schema":{"type":"string","description":"Font family of the text label. Default: monospace. Examples: ?font_family=monospace, ?font_family=sans-serif, ?font_family=Arial"}},{"name":"bar_width","in":"query","required":false,"description":"Width multiplier per module (bar). Default: 2. Increase for wider, more scannable barcodes. Example: ?bar_width=3","schema":{"type":"number","description":"Width multiplier per module (bar). Default: 2. Increase for wider, more scannable barcodes. Example: ?bar_width=3"}},{"name":"bar_gap","in":"query","required":false,"description":"Extra horizontal spacing between bars in pixels. Default: 0. Example: ?bar_gap=1","schema":{"type":"number","description":"Extra horizontal spacing between bars in pixels. Default: 0. Example: ?bar_gap=1"}},{"name":"background","in":"query","required":false,"description":"Background fill color. Default: #fff. Use transparent for no background. Example: ?background=%23f8fafc","schema":{"type":"string","description":"Background fill color. Default: #fff. Use transparent for no background. Example: ?background=%23f8fafc"}},{"name":"margin","in":"query","required":false,"description":"Uniform margin around the barcode in pixels. Default: 10. Overridden per side by margin_top/bottom/left/right. Example: ?margin=6","schema":{"type":"number","description":"Uniform margin around the barcode in pixels. Default: 10. Overridden per side by margin_top/bottom/left/right. Example: ?margin=6"}},{"name":"margin_top","in":"query","required":false,"description":"Top margin in pixels (overrides margin). Example: ?margin_top=4","schema":{"type":"number","description":"Top margin in pixels (overrides margin). Example: ?margin_top=4"}},{"name":"margin_bottom","in":"query","required":false,"description":"Bottom margin in pixels (overrides margin). Example: ?margin_bottom=4","schema":{"type":"number","description":"Bottom margin in pixels (overrides margin). Example: ?margin_bottom=4"}},{"name":"margin_left","in":"query","required":false,"description":"Left margin in pixels (overrides margin). Example: ?margin_left=8","schema":{"type":"number","description":"Left margin in pixels (overrides margin). Example: ?margin_left=8"}},{"name":"margin_right","in":"query","required":false,"description":"Right margin in pixels (overrides margin). Example: ?margin_right=8","schema":{"type":"number","description":"Right margin in pixels (overrides margin). Example: ?margin_right=8"}},{"name":"rotation","in":"query","required":false,"description":"Rotate the barcode by 0, 90, 180 or 270 degrees. Default: 0. Use 90 or 270 for vertical label orientation. Example: ?rotation=90","schema":{"type":"number","enum":[0,90,180,270],"description":"Rotate the barcode by 0, 90, 180 or 270 degrees. Default: 0. Use 90 or 270 for vertical label orientation. Example: ?rotation=90"}},{"name":"bearer_bars","in":"query","required":false,"description":"Add horizontal bearer bars above and below the barcode. Required for ITF-14. Default: false. Example: ?bearer_bars=true","schema":{"type":"boolean","description":"Add horizontal bearer bars above and below the barcode. Required for ITF-14. Default: false. Example: ?bearer_bars=true"}},{"name":"unit","in":"query","required":false,"description":"Measurement unit for dimensions. Default: px. Use mm, in or cm for print-ready output. Example: ?unit=mm","schema":{"type":"string","enum":["px","mm","in","cm"],"default":"px","description":"Measurement unit for dimensions. Default: px. Use mm, in or cm for print-ready output. Example: ?unit=mm"}},{"name":"aria_label","in":"query","required":false,"description":"Accessible label added as aria-label on the SVG element. Improves screen reader support. Example: ?aria_label=EAN-13+barcode+for+product+4006381333931","schema":{"type":"string","description":"Accessible label added as aria-label on the SVG element. Improves screen reader support. Example: ?aria_label=EAN-13+barcode+for+product+4006381333931"}},{"name":"title","in":"query","required":false,"description":"SVG <title> element for tooltip and accessibility. Example: ?title=Product+Barcode","schema":{"type":"string","description":"SVG <title> element for tooltip and accessibility. Example: ?title=Product+Barcode"}},{"name":"desc","in":"query","required":false,"description":"SVG <desc> element for extended accessibility description. Example: ?desc=EAN-13+encoding+GTIN+for+Nivea+cream+75ml","schema":{"type":"string","description":"SVG <desc> element for extended accessibility description. Example: ?desc=EAN-13+encoding+GTIN+for+Nivea+cream+75ml"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png"}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/view/{id}":{"get":{"summary":"Chart View","description":"View a previously saved chart as an interactive HTML page. Public, no API key required. Iframe-embeddable.","operationId":"chart-view-id","parameters":[{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}},{"name":"id","in":"path","required":true,"description":"The chart ID returned in the X-Chart-View-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The chart ID returned in the X-Chart-View-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"HTML page (interactive chart)":{"value":"<!DOCTYPE html><html></html>"},"Not found (404)":{"value":{"error":"Chart not found or expired."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram/render/{id}":{"get":{"summary":"Diagram Render","description":"Render a previously saved diagram by ID. Public, no API key required. Supports ?format= and ?query= overrides.","operationId":"diagram-render-id","parameters":[{"name":"format","in":"query","required":false,"description":"Override output format.","schema":{"type":"string","enum":["svg","png","jpeg","pdf"],"default":"svg","description":"Override output format."}},{"name":"query","in":"query","required":false,"description":"Override the diagram source code (URL-encoded).","schema":{"type":"string","description":"Override the diagram source code (URL-encoded)."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}},{"name":"id","in":"path","required":true,"description":"The diagram ID returned in the X-Diagram-Render-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The diagram ID returned in the X-Diagram-Render-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/render/{id}":{"get":{"summary":"Chart Render","description":"Render a previously saved chart by ID. Public, no API key required. Supports URL overrides for templates (?data1=, ?labels=, ?title=…).","operationId":"chart-render-id","parameters":[{"name":"title","in":"query","required":false,"description":"Override the chart title.","schema":{"type":"string","description":"Override the chart title."}},{"name":"labels","in":"query","required":false,"description":"Override X-axis labels. Comma-separated.","schema":{"type":"string","description":"Override X-axis labels. Comma-separated."}},{"name":"data1","in":"query","required":false,"description":"Override first dataset values. Comma-separated numbers. Use data2, data3… for additional datasets.","schema":{"type":"string","description":"Override first dataset values. Comma-separated numbers. Use data2, data3… for additional datasets."}},{"name":"width","in":"query","required":false,"description":"Override output width in pixels (50–4000).","schema":{"type":"string","description":"Override output width in pixels (50–4000)."}},{"name":"height","in":"query","required":false,"description":"Override output height in pixels (50–4000).","schema":{"type":"string","description":"Override output height in pixels (50–4000)."}},{"name":"format","in":"query","required":false,"description":"Override output format.","schema":{"type":"string","enum":["png","svg"],"default":"png","description":"Override output format."}},{"name":"id","in":"path","required":true,"description":"The chart ID returned in the X-Chart-Render-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The chart ID returned in the X-Chart-Render-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/ai":{"get":{"summary":"Chart AI","description":"Describe a chart in plain English via GET and get a rendered image back. Powered by AI.\n\n**Credit cost:** 10 credits per call","operationId":"chart-ai","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"prompt","in":"query","required":true,"description":"Describe your chart in plain English (max 1000 chars). Be specific: mention chart type, data topic, colors, style.","schema":{"type":"string","description":"Describe your chart in plain English (max 1000 chars). Be specific: mention chart type, data topic, colors, style."}},{"name":"raw_data","in":"query","required":false,"description":"Raw data for the chart. URL-encoded string, CSV, or JSON. AI will parse and structure it.\n\nExamples:\n- String: `Jan: 12400, Feb: 18900, Mar: 15200`\n- JSON array: `[{\"month\":\"Jan\",\"a\":120,\"b\":85},{\"month\":\"Feb\",\"a\":145,\"b\":102}]`\n- JSON object: `{\"Organic\":38,\"Paid\":24,\"Direct\":18}`\n\nLimit: 10 000 characters / 500 items. Need more? Open a support ticket.","schema":{"type":"string","description":"Raw data for the chart. URL-encoded string, CSV, or JSON. AI will parse and structure it.\n\nExamples:\n- String: `Jan: 12400, Feb: 18900, Mar: 15200`\n- JSON array: `[{\"month\":\"Jan\",\"a\":120,\"b\":85},{\"month\":\"Feb\",\"a\":145,\"b\":102}]`\n- JSON object: `{\"Organic\":38,\"Paid\":24,\"Direct\":18}`\n\nLimit: 10 000 characters / 500 items. Need more? Open a support ticket."}},{"name":"title","in":"query","required":false,"description":"Override the chart title generated by AI.","schema":{"type":"string","description":"Override the chart title generated by AI."}},{"name":"subtitle","in":"query","required":false,"description":"Override the chart subtitle.","schema":{"type":"string","description":"Override the chart subtitle."}},{"name":"legend","in":"query","required":false,"description":"Legend position or visibility. Use \"false\" to hide.","schema":{"type":"string","enum":["top","bottom","left","right","chartArea","false"],"default":"top","description":"Legend position or visibility. Use \"false\" to hide."}},{"name":"format","in":"query","required":false,"description":"Output format. Default: \"png\".","schema":{"type":"string","enum":["png","svg"],"default":"png","description":"Output format. Default: \"png\"."}},{"name":"width","in":"query","required":false,"description":"Image width in pixels (50–4000). Default: 1200.","schema":{"type":"number","description":"Image width in pixels (50–4000). Default: 1200."}},{"name":"height","in":"query","required":false,"description":"Image height in pixels (50–4000). Default: 600.","schema":{"type":"number","description":"Image height in pixels (50–4000). Default: 600."}},{"name":"background","in":"query","required":false,"description":"Background color as a hex value. Default: #ffffff.","schema":{"type":"string","description":"Background color as a hex value. Default: #ffffff."}},{"name":"device_pixel_ratio","in":"query","required":false,"description":"Device pixel ratio for the rendered image. Default: 1.","schema":{"type":"number","description":"Device pixel ratio for the rendered image. Default: 1."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"PNG image":{"value":"(binary image/png: use directly in <img src=\"...\"> or download)"},"SVG image (format: \"svg\")":{"value":"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"400\">  </svg>"},"Shared chart (share: true)":{"value":{"id":"cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","view_url":"https://api.chartquery.com/v1/chart/view/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","embed_url":"<iframe src=\"https://api.chartquery.com/v1/chart/view/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890\" frameborder=\"0\" width=\"800\" height=\"500\" style=\"border:none;\"></iframe>","expires_in":"3 days","render_url":"https://api.chartquery.com/v1/chart/render/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"Prompt too long (400)":{"value":{"error":"Prompt must not exceed 1000 characters."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram":{"get":{"summary":"Diagram","description":"Generate a diagram (SVG, PNG…) via GET using ?type=mermaid&query=...&format=svg.\n\n**Credit cost:** 5 credits per call","operationId":"diagram","parameters":[{"name":"type","in":"query","required":true,"description":"Diagram language.","schema":{"type":"string","enum":["mermaid","graphviz","plantuml","d2","svgbob","nomnoml","blockdiag","seqdiag","actdiag","nwdiag","bpmn","erd","excalidraw","ditaa","vega","vegalite","wavedrom","wireviz","c4plantuml","structurizr","tikz","pikchr","umlet","symbolator","packetdiag","rackdiag","bytefield","dbml"],"default":"mermaid","description":"Diagram language."}},{"name":"query","in":"query","required":true,"description":"Diagram source code (URL-encoded).\n\n**mermaid**: flowchart:\n`graph TD\\n A[Start] --> B{OK?}\\n B -->|yes| C[End]\\n B -->|no| D[Error]`\n\n**mermaid**: sequence:\n`sequenceDiagram\\n Client->>API: GET /v1/diagram\\n API-->>Client: 200 SVG`\n\n**mermaid**: ER:\n`erDiagram\\n USER ||--o{ ORDER : places\\n ORDER ||--|{ ITEM : contains`\n\n**graphviz**:\n`digraph G { rankdir=LR; A -> B -> C }`\n\n**plantuml**:\n`@startuml\\nA -> B: request\\nB --> A: response\\n@enduml`\n\n**d2**:\n`Client -> API: POST /v1/diagram\\nAPI -> SVG`\n\n**svgbob**:\n`+-------+ +-------+\\n| Box A |-->| Box B |\\n+-------+ +-------+`\n\n**nomnoml**:\n`[Client] -> [API]\\n[API] -> [Handler]`","schema":{"type":"string","description":"Diagram source code (URL-encoded).\n\n**mermaid**: flowchart:\n`graph TD\\n A[Start] --> B{OK?}\\n B -->|yes| C[End]\\n B -->|no| D[Error]`\n\n**mermaid**: sequence:\n`sequenceDiagram\\n Client->>API: GET /v1/diagram\\n API-->>Client: 200 SVG`\n\n**mermaid**: ER:\n`erDiagram\\n USER ||--o{ ORDER : places\\n ORDER ||--|{ ITEM : contains`\n\n**graphviz**:\n`digraph G { rankdir=LR; A -> B -> C }`\n\n**plantuml**:\n`@startuml\\nA -> B: request\\nB --> A: response\\n@enduml`\n\n**d2**:\n`Client -> API: POST /v1/diagram\\nAPI -> SVG`\n\n**svgbob**:\n`+-------+ +-------+\\n| Box A |-->| Box B |\\n+-------+ +-------+`\n\n**nomnoml**:\n`[Client] -> [API]\\n[API] -> [Handler]`"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: \"svg\".","schema":{"type":"string","enum":["svg","png","jpeg","pdf"],"default":"svg","description":"Output format. Default: \"svg\"."}},{"name":"share","in":"query","required":false,"description":"Set share: true to persist the diagram and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (no auth required, supports ?format= override). view_url is a shareable HTML page embeddable as an iframe. Free plan: expires after 3 days. Paid plan: expires after 6 months.","schema":{"type":"boolean","description":"Set share: true to persist the diagram and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (no auth required, supports ?format= override). view_url is a shareable HTML page embeddable as an iframe. Free plan: expires after 3 days. Paid plan: expires after 6 months."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart":{"get":{"summary":"Chart","description":"Generate a chart image (PNG or SVG) via GET. Pass the full chart config as URL-encoded JSON in the query parameter.\n\n**Credit cost:** 5 credits per call","operationId":"chart","parameters":[{"name":"query","in":"query","required":true,"description":"$5e","schema":{"type":"string","description":"$5f"}},{"name":"version","in":"query","required":false,"description":"Chart.js version to use. Alias: ?v=. Only v4.x is supported. Defaults to the installed version (4.5.1). Example: \"4\", \"4.5\", \"4.5.1\". The installed version is always returned in the X-ChartJS-Version response header.","schema":{"type":"string","default":"4.5.1","description":"Chart.js version to use. Alias: ?v=. Only v4.x is supported. Defaults to the installed version (4.5.1). Example: \"4\", \"4.5\", \"4.5.1\". The installed version is always returned in the X-ChartJS-Version response header."}},{"name":"share","in":"query","required":false,"description":"Set share: true to persist the chart and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (embeddable in emails, iframes, Markdown). view_url is a shareable interactive HTML page. Free plan: expires after 3 days with watermark. Paid plan: expires after 6 months, no branding.","schema":{"type":"boolean","description":"Set share: true to persist the chart and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (embeddable in emails, iframes, Markdown). view_url is a shareable interactive HTML page. Free plan: expires after 3 days with watermark. Paid plan: expires after 6 months, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your API key. Include it in the x-api-key header for every request."}}}},"proxyUrl":"$undefined"}}] </article></body></html>

5b:["$","$L5d",null,{"operations":[{"path":"/v1/label/render/{id}","method":"get"}],"webhooks":"$undefined","showTitle":"$undefined","showDescription":true,"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"Chartquery API Reference","description":"Complete API reference documentation.","version":"1.0.0"},"servers":[{"url":"https://api.chartquery.com","description":"API Server"}],"paths":{"/v1/stats":{"get":{"summary":"Stats","description":"Infrastructure health for an engine or endpoint over the last hour. Not scoped to your account or tenant. Enabled per account: HTTP 403 means contact support to activate it.","operationId":"stats","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"engine","in":"query","required":false,"description":"API family to check, for example `chart`. Provide at least `engine` or `path`.","schema":{"type":"string","description":"API family to check, for example `chart`. Provide at least `engine` or `path`."}},{"name":"path","in":"query","required":false,"description":"Specific endpoint to check, for example `/v1/chart`. If you also pass `engine`, use an endpoint from that API.","schema":{"type":"string","description":"Specific endpoint to check, for example `/v1/chart`. If you also pass `engine`, use an endpoint from that API."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"path":{"nullable":true},"engine":{"type":"string"},"health":{"type":"string"},"window":{"type":"string"},"success_rate":{"type":"number"},"avg_response_time_ms":{"type":"integer"}}},"examples":{"Engine health snapshot":{"value":{"path":null,"engine":"chart","health":"operational","window":"1h","success_rate":99.412,"avg_response_time_ms":840}},"Path health snapshot":{"value":{"path":"/v1/chart","engine":"chart","health":"operational","window":"1h","success_rate":99.412,"avg_response_time_ms":840}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/view/{id}":{"get":{"summary":"Label View","description":"View a previously saved label as an HTML page. Public, no API key required. Iframe-embeddable with inline SVG rendering.","operationId":"label-view-id","parameters":[{"name":"id","in":"query","required":true,"description":"Label ID from the share response.","schema":{"type":"string","description":"Label ID from the share response."}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"HTML page (rendered label)":{"value":""},"Not found (410)":{"value":{"error":"Label not found or expired."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/render/{id}":{"get":{"summary":"Label Render","description":"Render a previously saved label by ID. Public, no API key required. Supports ?format= override.","operationId":"label-render-id","parameters":[{"name":"id","in":"query","required":true,"description":"Label ID from the share response.","schema":{"type":"string","description":"Label ID from the share response."}},{"name":"format","in":"query","required":false,"description":"Override output format.","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Override output format."}},{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/parse":{"post":{"summary":"Label Parse","description":"Parse printer commands back to structured data. Reverse-engineer existing label code into elements, dimensions and metadata.\n\n**Credit cost:** 1 credit per call","operationId":"label-parse","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"dpi":{"type":"integer"},"commands":{"type":"array","items":{"type":"object","properties":{"cmd":{"type":"string"},"unit":{"type":"string"},"widthMM":{"type":"integer"},"heightMM":{"type":"integer"}}}},"elements":{"type":"array","items":{"type":"object","properties":{"x":{"type":"integer"},"y":{"type":"integer"},"font":{"type":"string"},"size":{"type":"integer"},"type":{"type":"string"},"content":{"type":"string"},"rotation":{"type":"integer"}}}},"warnings":{"type":"array","items":{}},"widthDots":{"type":"integer"},"heightDots":{"type":"integer"}}},"examples":{"Parsed TSC result":{"value":{"dpi":203,"commands":[{"cmd":"SIZE","unit":"mm","widthMM":40,"heightMM":30},{"cmd":"CLS"},{"x":10,"y":10,"cmd":"TEXT","font":"2","xMul":1,"yMul":1,"content":"Hello","rotation":0},{"cmd":"PRINT","sets":1}],"elements":[{"x":10,"y":10,"font":"2","size":1,"type":"text","content":"Hello","rotation":0}],"warnings":[],"widthDots":320,"heightDots":240}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/validate":{"post":{"summary":"Label Validate","description":"Validate printer commands for errors, warnings and best practices. Checks parameter ranges, command order and structure.\n\n**Credit cost:** 1 credit per call","operationId":"label-validate","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"infos":{"type":"integer"},"valid":{"type":"boolean"},"errors":{"type":"integer"},"issues":{"type":"array","items":{"type":"object","properties":{"level":{"type":"string"},"command":{"type":"string"},"message":{"type":"string"}}}},"warnings":{"type":"integer"}}},"examples":{"Validation result with errors":{"value":{"infos":0,"valid":false,"errors":1,"issues":[{"level":"error","command":"TEXT","message":"CLS must appear before label elements"},{"level":"warning","message":"No GAP command found"}],"warnings":1}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/convert":{"post":{"summary":"Label Convert","description":"Cross-compile printer commands between languages. 7 source x 9 target = 63 conversion paths. TSC to ZPL, ZPL to ESC/POS, EPL to CPCL and more.\n\n**Credit cost:** 5 credits per call","operationId":"label-convert","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"to":{"type":"string"},"from":{"type":"string"},"output":{"type":"string"},"warnings":{"type":"array","items":{}},"width_dots":{"type":"integer"},"height_dots":{"type":"integer"},"elements_count":{"type":"integer"},"output_encoding":{"type":"string"}}},"examples":{"TSC → ZPL conversion":{"value":{"to":"zpl","from":"tsc","output":"^XA\n^PW320\n^LL240\n^FO10,10^A0N,20,20^FDHello World^FS\n^PQ1\n^XZ","warnings":[],"width_dots":320,"height_dots":240,"elements_count":1,"output_encoding":"utf-8"}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label/compile":{"post":{"summary":"Label Compile","description":"Compile a label definition into printer commands. Returns raw TSC, ZPL, EPL, ESC/POS or other language output ready to send to a thermal printer.\n\n**Credit cost:** 3 credits per call","operationId":"label-compile","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"Compiled TSC commands":{"value":"SIZE 40 mm, 30 mm\nGAP 3 mm, 0\nSPEED 4\nDENSITY 8\nDIRECTION 1\nCLS\nTEXT 10,10,\"2\",0,1,1,\"ACME Corp\"\nTEXT 10,35,\"1\",0,1,1,\"SKU: PRD-00123\"\nBAR 5,55,305,1\nBOX 5,5,315,235,2\nPRINT 1"}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/label":{"get":{"summary":"Label Preview","description":"Generate a thermal label preview via GET. Output: SVG (default) or PNG. Supports 9 printer languages: TSC, ZPL, EPL, ESC/POS, CPCL, DPL, SBPL, Star PRNT, IPL.\n\n**Credit cost:** 3 credits per call","operationId":"label","parameters":[{"name":"format","in":"query","required":false,"description":"Output format. Default: svg. Use png to get a raster image.","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Output format. Default: svg. Use png to get a raster image."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image."}},{"name":"query","in":"query","required":true,"description":"Full label config as URL-encoded JSON.","schema":{"type":"string","description":"Full label config as URL-encoded JSON."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/usage":{"get":{"summary":"Usage","description":"Retrieve real-time usage statistics and credit balance for your Chartquery account.","operationId":"usage","security":[{"ApiKeyAuth":[]}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"remaining":{"type":"integer"},"total_used":{"type":"integer"},"renewal_date":{"type":"string"},"period":{"type":"object","properties":{"start":{"type":"string"},"end":{"type":"string"}}},"subscription":{"type":"object","properties":{"used":{"type":"integer"},"total":{"type":"integer"},"remaining":{"type":"integer"},"percent_used":{"type":"integer"}}},"credits":{"type":"object","properties":{"given":{"type":"integer"},"consumed":{"type":"integer"},"remaining":{"type":"integer"},"percent_used":{"type":"integer"}}},"rate_limit":{"type":"object","properties":{"per_minute":{"nullable":true},"per_second":{"nullable":true}}},"account":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"}}},"api_key":{"type":"object","properties":{"alias":{"type":"string"},"active":{"type":"boolean"},"category":{"type":"string"},"expires":{"nullable":true},"quotas":{"type":"object","properties":{"total":{"nullable":true},"daily":{"nullable":true},"weekly":{"nullable":true},"monthly":{"nullable":true}}}}}}},"examples":{"Account usage overview":{"value":{"remaining":0,"total_used":15871,"renewal_date":"2026-04-25","period":{"start":"2026-03-25","end":"2026-04-25"},"subscription":{"used":15871,"total":50,"remaining":0,"percent_used":31742},"credits":{"given":0,"consumed":0,"remaining":0,"percent_used":0},"rate_limit":{"per_minute":null,"per_second":null},"account":{"name":"Microsoft","slug":"microsoft"},"api_key":{"alias":"my-api-key","active":true,"category":"development","expires":null,"quotas":{"total":null,"daily":null,"weekly":null,"monthly":null}}}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram/ai":{"get":{"summary":"Diagram AI","description":"Describe a diagram in plain English via GET and get a rendered image back. Powered by AI.\n\n**Credit cost:** 10 credits per call","operationId":"diagram-ai","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"prompt","in":"query","required":true,"description":"Describe your diagram in plain English (max 1000 chars). Be specific: mention the diagram type, key entities, and relationships.","schema":{"type":"string","description":"Describe your diagram in plain English (max 1000 chars). Be specific: mention the diagram type, key entities, and relationships."}},{"name":"diagram_type","in":"query","required":false,"description":"Preferred diagram language. AI chooses if omitted. Examples: \"mermaid\", \"d2\", \"plantuml\", \"graphviz\".","schema":{"type":"string","enum":["mermaid","d2","plantuml","graphviz"],"default":"mermaid","description":"Preferred diagram language. AI chooses if omitted. Examples: \"mermaid\", \"d2\", \"plantuml\", \"graphviz\"."}},{"name":"output_format","in":"query","required":false,"description":"Output format. Default: \"svg\".","schema":{"type":"string","enum":["svg","png","jpeg","pdf"],"default":"svg","description":"Output format. Default: \"svg\"."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry. Paid plan: 6-month expiry.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry. Paid plan: 6-month expiry."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"SVG image (default)":{"value":""},"Shared diagram (share: true)":{"value":{"id":"cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","view_url":"https://api.chartquery.com/v1/diagram/view/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","embed_url":"","expires_in":"3 days","render_url":"https://api.chartquery.com/v1/diagram/render/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"Prompt too long (400)":{"value":{"error":"Prompt must not exceed 1000 characters."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram/view/{id}":{"get":{"summary":"Diagram View","description":"View a previously saved diagram as an HTML page. Public, no API key required. Iframe-embeddable with inline SVG rendering.","operationId":"diagram-view-id","parameters":[{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}},{"name":"id","in":"path","required":true,"description":"The diagram ID returned in the X-Diagram-View-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The diagram ID returned in the X-Diagram-View-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"HTML page (rendered diagram)":{"value":""},"Not found (404)":{"value":{"error":"Diagram not found or expired."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/qrcode":{"get":{"summary":"QR Code","description":"Generate a styled QR code via GET. Output: SVG (default) or PNG. Supports dot styles, gradients, custom corners and all QR versions.\n\n**Credit cost:** 3 credits per call","operationId":"qrcode","parameters":[{"name":"data","in":"query","required":true,"description":"Data to encode in the QR code. Examples:\n\n**URL:** `https://chartquery.com`\n**Email:** `mailto:hello@chartquery.com`\n**Phone:** `tel:+1234567890`\n**SMS:** `SMSTO:+1234567890:Hello!`\n**WiFi:** `WIFI:T:WPA;S:MyNetwork;P:secret123;;`\n**Geo:** `geo:48.8566,2.3522`\n**Plain text:** `Hello from ChartQuery!`\n**vCard:** `BEGIN:VCARD\nVERSION:3.0\nFN:John Doe\nEMAIL:john@example.com\nEND:VCARD`","schema":{"type":"string","description":"Data to encode in the QR code. Examples:\n\n**URL:** `https://chartquery.com`\n**Email:** `mailto:hello@chartquery.com`\n**Phone:** `tel:+1234567890`\n**SMS:** `SMSTO:+1234567890:Hello!`\n**WiFi:** `WIFI:T:WPA;S:MyNetwork;P:secret123;;`\n**Geo:** `geo:48.8566,2.3522`\n**Plain text:** `Hello from ChartQuery!`\n**vCard:** `BEGIN:VCARD\nVERSION:3.0\nFN:John Doe\nEMAIL:john@example.com\nEND:VCARD`"}},{"name":"size","in":"query","required":false,"description":"Output size in pixels (width = height). Default: 200. Examples: ?size=200 (thumbnail), ?size=300 (standard), ?size=400 (large), ?size=600 (poster). For print, use the unit param with mm/cm instead.","schema":{"type":"number","description":"Output size in pixels (width = height). Default: 200. Examples: ?size=200 (thumbnail), ?size=300 (standard), ?size=400 (large), ?size=600 (poster). For print, use the unit param with mm/cm instead."}},{"name":"ec_level","in":"query","required":false,"description":"Error correction level. Default: M. Higher levels allow more damage/obscuring before the code becomes unreadable.\n\n- **L** (7%): smallest size, minimal redundancy, best for clean environments\n- **M** (15%): balanced, good for most use cases\n- **Q** (25%), for outdoor or rough surfaces\n- **H** (30%): required when adding a logo or image overlay\n\nExample: ?ec_level=H","schema":{"type":"string","enum":["L","M","Q","H"],"default":"M","description":"Error correction level. Default: M. Higher levels allow more damage/obscuring before the code becomes unreadable.\n\n- **L** (7%): smallest size, minimal redundancy, best for clean environments\n- **M** (15%): balanced, good for most use cases\n- **Q** (25%), for outdoor or rough surfaces\n- **H** (30%): required when adding a logo or image overlay\n\nExample: ?ec_level=H"}},{"name":"dot_type","in":"query","required":false,"description":"Module (dot) shape. Default: `square`. Controls the visual style of each QR code module.\n\n- `square`: classic, maximum compatibility\n- `rounded`: softer edges, clean modern look\n- `dots`: fully circular modules, artistic\n- `diamond`: angular style\n- `classy`: elegant angular corners\n- `classy-rounded`: classy with rounded tips\n- `extra-rounded`: large pill-shaped modules\n- `small-square` / `tiny-square`: spaced square modules\n- `vertical-line` / `horizontal-line`: striped effect\n\nExample: ?dot_type=rounded","schema":{"type":"string","enum":["square","rounded","dots","diamond","classy","classy-rounded","extra-rounded","vertical-line","horizontal-line","small-square","tiny-square"],"default":"square","description":"Module (dot) shape. Default: `square`. Controls the visual style of each QR code module.\n\n- `square`: classic, maximum compatibility\n- `rounded`: softer edges, clean modern look\n- `dots`: fully circular modules, artistic\n- `diamond`: angular style\n- `classy`: elegant angular corners\n- `classy-rounded`: classy with rounded tips\n- `extra-rounded`: large pill-shaped modules\n- `small-square` / `tiny-square`: spaced square modules\n- `vertical-line` / `horizontal-line`: striped effect\n\nExample: ?dot_type=rounded"}},{"name":"color","in":"query","required":false,"description":"Module color as CSS hex. Default: #000. Examples: ?color=%236366f1 (indigo), ?color=%23dc2626 (red), ?color=%23059669 (green), ?color=%230891b2 (teal). Use %23 to URL-encode #. For gradient objects, use POST instead.","schema":{"type":"string","description":"Module color as CSS hex. Default: #000. Examples: ?color=%236366f1 (indigo), ?color=%23dc2626 (red), ?color=%23059669 (green), ?color=%230891b2 (teal). Use %23 to URL-encode #. For gradient objects, use POST instead."}},{"name":"shape","in":"query","required":false,"description":"Overall QR code shape. Default: square. Use circle to clip the entire QR into a circle: great for profile/avatar-style codes. Example: ?shape=circle&dot_type=dots","schema":{"type":"string","enum":["square","circle"],"default":"square","description":"Overall QR code shape. Default: square. Use circle to clip the entire QR into a circle: great for profile/avatar-style codes. Example: ?shape=circle&dot_type=dots"}},{"name":"dot_size","in":"query","required":false,"description":"Module size ratio between 0.1 and 1. Default: 1 (full). Values below 1 add spacing between modules for a lighter look. Example: ?dot_size=0.85","schema":{"type":"number","description":"Module size ratio between 0.1 and 1. Default: 1 (full). Values below 1 add spacing between modules for a lighter look. Example: ?dot_size=0.85"}},{"name":"background","in":"query","required":false,"description":"Background color. Default: #fff. Set to transparent for no background. Example: ?background=%230f172a for dark background. Use %23 to encode #.","schema":{"type":"string","description":"Background color. Default: #fff. Set to transparent for no background. Example: ?background=%230f172a for dark background. Use %23 to encode #."}},{"name":"margin","in":"query","required":false,"description":"Quiet zone width in modules around the QR code. Default: 4. Minimum recommended by the QR standard: 4. Example: ?margin=2 (compact) or ?margin=6 (extra padding).","schema":{"type":"number","description":"Quiet zone width in modules around the QR code. Default: 4. Minimum recommended by the QR standard: 4. Example: ?margin=2 (compact) or ?margin=6 (extra padding)."}},{"name":"version","in":"query","required":false,"description":"QR version from 1 to 40 (determines grid size and data capacity). Leave unset for auto-selection based on data length and ec_level. Example: ?version=5","schema":{"type":"number","description":"QR version from 1 to 40 (determines grid size and data capacity). Leave unset for auto-selection based on data length and ec_level. Example: ?version=5"}},{"name":"mode","in":"query","required":false,"description":"Encoding mode. Default: auto (best mode selected for the data). Use numeric for digits-only, alphanumeric for uppercase + digits, byte for arbitrary text/UTF-8. Example: ?mode=numeric","schema":{"type":"string","enum":["auto","numeric","alphanumeric","byte"],"default":"auto","description":"Encoding mode. Default: auto (best mode selected for the data). Use numeric for digits-only, alphanumeric for uppercase + digits, byte for arbitrary text/UTF-8. Example: ?mode=numeric"}},{"name":"mask","in":"query","required":false,"description":"Mask pattern from 0 to 7. Default: auto (best mask selected to minimize visual patterns). Only set manually if you need a deterministic output. Example: ?mask=3","schema":{"type":"number","description":"Mask pattern from 0 to 7. Default: auto (best mask selected to minimize visual patterns). Only set manually if you need a deterministic output. Example: ?mask=3"}},{"name":"unit","in":"query","required":false,"description":"Measurement unit for the size param. Default: px. Use mm, in or cm with the size param for print-ready output. Example: ?size=50&unit=mm","schema":{"type":"string","enum":["px","mm","in","cm"],"default":"px","description":"Measurement unit for the size param. Default: px. Use mm, in or cm with the size param for print-ready output. Example: ?size=50&unit=mm"}},{"name":"xml_declaration","in":"query","required":false,"description":"Prepend an XML declaration () to the SVG output. Useful when the SVG will be used as a standalone XML file. Default: false. Example: ?xml_declaration=true","schema":{"type":"boolean","description":"Prepend an XML declaration () to the SVG output. Useful when the SVG will be used as a standalone XML file. Default: false. Example: ?xml_declaration=true"}},{"name":"aria_label","in":"query","required":false,"description":"Accessible label added as aria-label on the SVG element. Example: ?aria_label=QR+code+linking+to+chartquery.com","schema":{"type":"string","description":"Accessible label added as aria-label on the SVG element. Example: ?aria_label=QR+code+linking+to+chartquery.com"}},{"name":"title","in":"query","required":false,"description":"SVG element shown as a browser tooltip and used by screen readers. Example: ?title=ChartQuery+Website","schema":{"type":"string","description":"SVG <title> element shown as a browser tooltip and used by screen readers. Example: ?title=ChartQuery+Website"}},{"name":"desc","in":"query","required":false,"description":"SVG <desc> element for extended accessibility description. Example: ?desc=Scan+to+visit+https://chartquery.com","schema":{"type":"string","description":"SVG <desc> element for extended accessibility description. Example: ?desc=Scan+to+visit+https://chartquery.com"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png"}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/barcode":{"get":{"summary":"Barcode","description":"Generate a barcode image via GET. Output: SVG (default) or PNG. Supports 25+ formats: EAN-13, Code 128, ITF-14, GS1-128, postal codes and more.\n\n**Credit cost:** 3 credits per call","operationId":"barcode","parameters":[{"name":"data","in":"query","required":true,"description":"The data to encode in the barcode. Examples by type:\n\n**EAN-13** (retail): `4006381333931`\n**EAN-8** (small pack): `73513535`\n**UPC-A** (North America): `012345678905`\n**Code 128** (general): `HELLO-WORLD-2026` or `INV-2026-00456`\n**Code 39** (uppercase): `CODE39-DEMO` or `SHELF-A12`\n**ITF-14** (carton): `00012345678905`\n**GS1-128** (with AIs): `(01)12345678901234(17)260101`\n**Codabar** (library): `A1234567890B`\n**POSTNET** (postal): `902100123`","schema":{"type":"string","description":"The data to encode in the barcode. Examples by type:\n\n**EAN-13** (retail): `4006381333931`\n**EAN-8** (small pack): `73513535`\n**UPC-A** (North America): `012345678905`\n**Code 128** (general): `HELLO-WORLD-2026` or `INV-2026-00456`\n**Code 39** (uppercase): `CODE39-DEMO` or `SHELF-A12`\n**ITF-14** (carton): `00012345678905`\n**GS1-128** (with AIs): `(01)12345678901234(17)260101`\n**Codabar** (library): `A1234567890B`\n**POSTNET** (postal): `902100123`"}},{"name":"type","in":"query","required":false,"description":"Barcode format. Default: `code128`.\n\n**Retail:** `ean13`, `ean8`, `ean5`, `ean2`, `upca`, `upce`\n**General:** `code128`, `code39`, `code39ext`, `code93`, `code93ext`\n**Logistics:** `itf`, `itf14`, `gs1-128`, `gs1-databar`, `gs1-databar-limited`, `gs1-databar-expanded`\n**Other:** `codabar`, `msi`, `pharmacode`, `code11`, `plessey`\n**Postal:** `postnet`, `planet`, `identcode`, `leitcode`","schema":{"type":"string","enum":["code128","ean13","ean8","upca","upce","code39","itf","itf14","codabar","gs1-128","postnet","planet","plessey"],"default":"code128","description":"Barcode format. Default: `code128`.\n\n**Retail:** `ean13`, `ean8`, `ean5`, `ean2`, `upca`, `upce`\n**General:** `code128`, `code39`, `code39ext`, `code93`, `code93ext`\n**Logistics:** `itf`, `itf14`, `gs1-128`, `gs1-databar`, `gs1-databar-limited`, `gs1-databar-expanded`\n**Other:** `codabar`, `msi`, `pharmacode`, `code11`, `plessey`\n**Postal:** `postnet`, `planet`, `identcode`, `leitcode`"}},{"name":"height","in":"query","required":false,"description":"Bar height in pixels. Default: 80. Typical values: 50 (compact), 80 (standard), 100–120 (tall labels). Example: ?height=100","schema":{"type":"number","description":"Bar height in pixels. Default: 80. Typical values: 50 (compact), 80 (standard), 100–120 (tall labels). Example: ?height=100"}},{"name":"color","in":"query","required":false,"description":"Bar color as a CSS color string. Default: #000. Examples: ?color=%231e293b (dark slate), ?color=%230f172a (near black), ?color=%237c3aed (purple), ?color=%23dc2626 (red). Use %23 to URL-encode the # character.","schema":{"type":"string","description":"Bar color as a CSS color string. Default: #000. Examples: ?color=%231e293b (dark slate), ?color=%230f172a (near black), ?color=%237c3aed (purple), ?color=%23dc2626 (red). Use %23 to URL-encode the # character."}},{"name":"show_text","in":"query","required":false,"description":"Show human-readable text below the bars. Example: ?show_text=true. Combine with font_size and text_align for print labels.","schema":{"type":"boolean","description":"Show human-readable text below the bars. Example: ?show_text=true. Combine with font_size and text_align for print labels."}},{"name":"text_position","in":"query","required":false,"description":"Position of the human-readable text label. Default: bottom. Example: ?text_position=top","schema":{"type":"string","enum":["bottom","top"],"default":"bottom","description":"Position of the human-readable text label. Default: bottom. Example: ?text_position=top"}},{"name":"text_align","in":"query","required":false,"description":"Horizontal alignment of the text label. Default: center. Example: ?text_align=left","schema":{"type":"string","enum":["center","left","right"],"default":"center","description":"Horizontal alignment of the text label. Default: center. Example: ?text_align=left"}},{"name":"font_size","in":"query","required":false,"description":"Font size of the text label in pixels. Default: 14. Example: ?font_size=12","schema":{"type":"number","description":"Font size of the text label in pixels. Default: 14. Example: ?font_size=12"}},{"name":"font_family","in":"query","required":false,"description":"Font family of the text label. Default: monospace. Examples: ?font_family=monospace, ?font_family=sans-serif, ?font_family=Arial","schema":{"type":"string","description":"Font family of the text label. Default: monospace. Examples: ?font_family=monospace, ?font_family=sans-serif, ?font_family=Arial"}},{"name":"bar_width","in":"query","required":false,"description":"Width multiplier per module (bar). Default: 2. Increase for wider, more scannable barcodes. Example: ?bar_width=3","schema":{"type":"number","description":"Width multiplier per module (bar). Default: 2. Increase for wider, more scannable barcodes. Example: ?bar_width=3"}},{"name":"bar_gap","in":"query","required":false,"description":"Extra horizontal spacing between bars in pixels. Default: 0. Example: ?bar_gap=1","schema":{"type":"number","description":"Extra horizontal spacing between bars in pixels. Default: 0. Example: ?bar_gap=1"}},{"name":"background","in":"query","required":false,"description":"Background fill color. Default: #fff. Use transparent for no background. Example: ?background=%23f8fafc","schema":{"type":"string","description":"Background fill color. Default: #fff. Use transparent for no background. Example: ?background=%23f8fafc"}},{"name":"margin","in":"query","required":false,"description":"Uniform margin around the barcode in pixels. Default: 10. Overridden per side by margin_top/bottom/left/right. Example: ?margin=6","schema":{"type":"number","description":"Uniform margin around the barcode in pixels. Default: 10. Overridden per side by margin_top/bottom/left/right. Example: ?margin=6"}},{"name":"margin_top","in":"query","required":false,"description":"Top margin in pixels (overrides margin). Example: ?margin_top=4","schema":{"type":"number","description":"Top margin in pixels (overrides margin). Example: ?margin_top=4"}},{"name":"margin_bottom","in":"query","required":false,"description":"Bottom margin in pixels (overrides margin). Example: ?margin_bottom=4","schema":{"type":"number","description":"Bottom margin in pixels (overrides margin). Example: ?margin_bottom=4"}},{"name":"margin_left","in":"query","required":false,"description":"Left margin in pixels (overrides margin). Example: ?margin_left=8","schema":{"type":"number","description":"Left margin in pixels (overrides margin). Example: ?margin_left=8"}},{"name":"margin_right","in":"query","required":false,"description":"Right margin in pixels (overrides margin). Example: ?margin_right=8","schema":{"type":"number","description":"Right margin in pixels (overrides margin). Example: ?margin_right=8"}},{"name":"rotation","in":"query","required":false,"description":"Rotate the barcode by 0, 90, 180 or 270 degrees. Default: 0. Use 90 or 270 for vertical label orientation. Example: ?rotation=90","schema":{"type":"number","enum":[0,90,180,270],"description":"Rotate the barcode by 0, 90, 180 or 270 degrees. Default: 0. Use 90 or 270 for vertical label orientation. Example: ?rotation=90"}},{"name":"bearer_bars","in":"query","required":false,"description":"Add horizontal bearer bars above and below the barcode. Required for ITF-14. Default: false. Example: ?bearer_bars=true","schema":{"type":"boolean","description":"Add horizontal bearer bars above and below the barcode. Required for ITF-14. Default: false. Example: ?bearer_bars=true"}},{"name":"unit","in":"query","required":false,"description":"Measurement unit for dimensions. Default: px. Use mm, in or cm for print-ready output. Example: ?unit=mm","schema":{"type":"string","enum":["px","mm","in","cm"],"default":"px","description":"Measurement unit for dimensions. Default: px. Use mm, in or cm for print-ready output. Example: ?unit=mm"}},{"name":"aria_label","in":"query","required":false,"description":"Accessible label added as aria-label on the SVG element. Improves screen reader support. Example: ?aria_label=EAN-13+barcode+for+product+4006381333931","schema":{"type":"string","description":"Accessible label added as aria-label on the SVG element. Improves screen reader support. Example: ?aria_label=EAN-13+barcode+for+product+4006381333931"}},{"name":"title","in":"query","required":false,"description":"SVG <title> element for tooltip and accessibility. Example: ?title=Product+Barcode","schema":{"type":"string","description":"SVG <title> element for tooltip and accessibility. Example: ?title=Product+Barcode"}},{"name":"desc","in":"query","required":false,"description":"SVG <desc> element for extended accessibility description. Example: ?desc=EAN-13+encoding+GTIN+for+Nivea+cream+75ml","schema":{"type":"string","description":"SVG <desc> element for extended accessibility description. Example: ?desc=EAN-13+encoding+GTIN+for+Nivea+cream+75ml"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png","schema":{"type":"string","enum":["svg","png"],"default":"svg","description":"Output format. Default: svg. Use png to get a raster image. SVG is lossless and scalable; PNG is pixel-based and suitable for email, PDF or messaging. Example: ?format=png"}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/view/{id}":{"get":{"summary":"Chart View","description":"View a previously saved chart as an interactive HTML page. Public, no API key required. Iframe-embeddable.","operationId":"chart-view-id","parameters":[{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}},{"name":"id","in":"path","required":true,"description":"The chart ID returned in the X-Chart-View-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The chart ID returned in the X-Chart-View-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"HTML page (interactive chart)":{"value":"<!DOCTYPE html><html></html>"},"Not found (404)":{"value":{"error":"Chart not found or expired."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram/render/{id}":{"get":{"summary":"Diagram Render","description":"Render a previously saved diagram by ID. Public, no API key required. Supports ?format= and ?query= overrides.","operationId":"diagram-render-id","parameters":[{"name":"format","in":"query","required":false,"description":"Override output format.","schema":{"type":"string","enum":["svg","png","jpeg","pdf"],"default":"svg","description":"Override output format."}},{"name":"query","in":"query","required":false,"description":"Override the diagram source code (URL-encoded).","schema":{"type":"string","description":"Override the diagram source code (URL-encoded)."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}},{"name":"id","in":"path","required":true,"description":"The diagram ID returned in the X-Diagram-Render-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The diagram ID returned in the X-Diagram-Render-URL header when saving a diagram. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/render/{id}":{"get":{"summary":"Chart Render","description":"Render a previously saved chart by ID. Public, no API key required. Supports URL overrides for templates (?data1=, ?labels=, ?title=…).","operationId":"chart-render-id","parameters":[{"name":"title","in":"query","required":false,"description":"Override the chart title.","schema":{"type":"string","description":"Override the chart title."}},{"name":"labels","in":"query","required":false,"description":"Override X-axis labels. Comma-separated.","schema":{"type":"string","description":"Override X-axis labels. Comma-separated."}},{"name":"data1","in":"query","required":false,"description":"Override first dataset values. Comma-separated numbers. Use data2, data3… for additional datasets.","schema":{"type":"string","description":"Override first dataset values. Comma-separated numbers. Use data2, data3… for additional datasets."}},{"name":"width","in":"query","required":false,"description":"Override output width in pixels (50–4000).","schema":{"type":"string","description":"Override output width in pixels (50–4000)."}},{"name":"height","in":"query","required":false,"description":"Override output height in pixels (50–4000).","schema":{"type":"string","description":"Override output height in pixels (50–4000)."}},{"name":"format","in":"query","required":false,"description":"Override output format.","schema":{"type":"string","enum":["png","svg"],"default":"png","description":"Override output format."}},{"name":"id","in":"path","required":true,"description":"The chart ID returned in the X-Chart-Render-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.","schema":{"type":"string","description":"The chart ID returned in the X-Chart-Render-URL header when saving a chart. Format: cq-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart/ai":{"get":{"summary":"Chart AI","description":"Describe a chart in plain English via GET and get a rendered image back. Powered by AI.\n\n**Credit cost:** 10 credits per call","operationId":"chart-ai","security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"prompt","in":"query","required":true,"description":"Describe your chart in plain English (max 1000 chars). Be specific: mention chart type, data topic, colors, style.","schema":{"type":"string","description":"Describe your chart in plain English (max 1000 chars). Be specific: mention chart type, data topic, colors, style."}},{"name":"raw_data","in":"query","required":false,"description":"Raw data for the chart. URL-encoded string, CSV, or JSON. AI will parse and structure it.\n\nExamples:\n- String: `Jan: 12400, Feb: 18900, Mar: 15200`\n- JSON array: `[{\"month\":\"Jan\",\"a\":120,\"b\":85},{\"month\":\"Feb\",\"a\":145,\"b\":102}]`\n- JSON object: `{\"Organic\":38,\"Paid\":24,\"Direct\":18}`\n\nLimit: 10 000 characters / 500 items. Need more? Open a support ticket.","schema":{"type":"string","description":"Raw data for the chart. URL-encoded string, CSV, or JSON. AI will parse and structure it.\n\nExamples:\n- String: `Jan: 12400, Feb: 18900, Mar: 15200`\n- JSON array: `[{\"month\":\"Jan\",\"a\":120,\"b\":85},{\"month\":\"Feb\",\"a\":145,\"b\":102}]`\n- JSON object: `{\"Organic\":38,\"Paid\":24,\"Direct\":18}`\n\nLimit: 10 000 characters / 500 items. Need more? Open a support ticket."}},{"name":"title","in":"query","required":false,"description":"Override the chart title generated by AI.","schema":{"type":"string","description":"Override the chart title generated by AI."}},{"name":"subtitle","in":"query","required":false,"description":"Override the chart subtitle.","schema":{"type":"string","description":"Override the chart subtitle."}},{"name":"legend","in":"query","required":false,"description":"Legend position or visibility. Use \"false\" to hide.","schema":{"type":"string","enum":["top","bottom","left","right","chartArea","false"],"default":"top","description":"Legend position or visibility. Use \"false\" to hide."}},{"name":"format","in":"query","required":false,"description":"Output format. Default: \"png\".","schema":{"type":"string","enum":["png","svg"],"default":"png","description":"Output format. Default: \"png\"."}},{"name":"width","in":"query","required":false,"description":"Image width in pixels (50–4000). Default: 1200.","schema":{"type":"number","description":"Image width in pixels (50–4000). Default: 1200."}},{"name":"height","in":"query","required":false,"description":"Image height in pixels (50–4000). Default: 600.","schema":{"type":"number","description":"Image height in pixels (50–4000). Default: 600."}},{"name":"background","in":"query","required":false,"description":"Background color as a hex value. Default: #ffffff.","schema":{"type":"string","description":"Background color as a hex value. Default: #ffffff."}},{"name":"device_pixel_ratio","in":"query","required":false,"description":"Device pixel ratio for the rendered image. Default: 1.","schema":{"type":"number","description":"Device pixel ratio for the rendered image. Default: 1."}},{"name":"share","in":"query","required":false,"description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding.","schema":{"type":"boolean","enum":["false","true"],"default":"false","description":"Set share=true to persist the config and receive JSON instead of an image: { id, render_url, view_url, embed_url, expires_in }. Free plan: 3-day expiry with watermark. Paid plan: 6-month expiry, no branding."}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"string"},"examples":{"PNG image":{"value":"(binary image/png: use directly in <img src=\"...\"> or download)"},"SVG image (format: \"svg\")":{"value":"<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"400\">  </svg>"},"Shared chart (share: true)":{"value":{"id":"cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","view_url":"https://api.chartquery.com/v1/chart/view/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890","embed_url":"<iframe src=\"https://api.chartquery.com/v1/chart/view/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890\" frameborder=\"0\" width=\"800\" height=\"500\" style=\"border:none;\"></iframe>","expires_in":"3 days","render_url":"https://api.chartquery.com/v1/chart/render/cq-a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"Prompt too long (400)":{"value":{"error":"Prompt must not exceed 1000 characters."}}}}}},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"401":{"description":"Unauthorized — the API key is missing, invalid, inactive, or expired.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Invalid API Key"}}}},"402":{"description":"Payment Required — your subscription or credit balance is insufficient.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Payment required"}}}},"429":{"description":"Too Many Requests — you exceeded your rate limit quota.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Rate limit exceeded for the API key: quota monthly"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/diagram":{"get":{"summary":"Diagram","description":"Generate a diagram (SVG, PNG…) via GET using ?type=mermaid&query=...&format=svg.\n\n**Credit cost:** 5 credits per call","operationId":"diagram","parameters":[{"name":"type","in":"query","required":true,"description":"Diagram language.","schema":{"type":"string","enum":["mermaid","graphviz","plantuml","d2","svgbob","nomnoml","blockdiag","seqdiag","actdiag","nwdiag","bpmn","erd","excalidraw","ditaa","vega","vegalite","wavedrom","wireviz","c4plantuml","structurizr","tikz","pikchr","umlet","symbolator","packetdiag","rackdiag","bytefield","dbml"],"default":"mermaid","description":"Diagram language."}},{"name":"query","in":"query","required":true,"description":"Diagram source code (URL-encoded).\n\n**mermaid**: flowchart:\n`graph TD\\n A[Start] --> B{OK?}\\n B -->|yes| C[End]\\n B -->|no| D[Error]`\n\n**mermaid**: sequence:\n`sequenceDiagram\\n Client->>API: GET /v1/diagram\\n API-->>Client: 200 SVG`\n\n**mermaid**: ER:\n`erDiagram\\n USER ||--o{ ORDER : places\\n ORDER ||--|{ ITEM : contains`\n\n**graphviz**:\n`digraph G { rankdir=LR; A -> B -> C }`\n\n**plantuml**:\n`@startuml\\nA -> B: request\\nB --> A: response\\n@enduml`\n\n**d2**:\n`Client -> API: POST /v1/diagram\\nAPI -> SVG`\n\n**svgbob**:\n`+-------+ +-------+\\n| Box A |-->| Box B |\\n+-------+ +-------+`\n\n**nomnoml**:\n`[Client] -> [API]\\n[API] -> [Handler]`","schema":{"type":"string","description":"Diagram source code (URL-encoded).\n\n**mermaid**: flowchart:\n`graph TD\\n A[Start] --> B{OK?}\\n B -->|yes| C[End]\\n B -->|no| D[Error]`\n\n**mermaid**: sequence:\n`sequenceDiagram\\n Client->>API: GET /v1/diagram\\n API-->>Client: 200 SVG`\n\n**mermaid**: ER:\n`erDiagram\\n USER ||--o{ ORDER : places\\n ORDER ||--|{ ITEM : contains`\n\n**graphviz**:\n`digraph G { rankdir=LR; A -> B -> C }`\n\n**plantuml**:\n`@startuml\\nA -> B: request\\nB --> A: response\\n@enduml`\n\n**d2**:\n`Client -> API: POST /v1/diagram\\nAPI -> SVG`\n\n**svgbob**:\n`+-------+ +-------+\\n| Box A |-->| Box B |\\n+-------+ +-------+`\n\n**nomnoml**:\n`[Client] -> [API]\\n[API] -> [Handler]`"}},{"name":"format","in":"query","required":false,"description":"Output format. Default: \"svg\".","schema":{"type":"string","enum":["svg","png","jpeg","pdf"],"default":"svg","description":"Output format. Default: \"svg\"."}},{"name":"share","in":"query","required":false,"description":"Set share: true to persist the diagram and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (no auth required, supports ?format= override). view_url is a shareable HTML page embeddable as an iframe. Free plan: expires after 3 days. Paid plan: expires after 6 months.","schema":{"type":"boolean","description":"Set share: true to persist the diagram and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (no auth required, supports ?format= override). view_url is a shareable HTML page embeddable as an iframe. Free plan: expires after 3 days. Paid plan: expires after 6 months."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}},"/v1/chart":{"get":{"summary":"Chart","description":"Generate a chart image (PNG or SVG) via GET. Pass the full chart config as URL-encoded JSON in the query parameter.\n\n**Credit cost:** 5 credits per call","operationId":"chart","parameters":[{"name":"query","in":"query","required":true,"description":"$5e","schema":{"type":"string","description":"$5f"}},{"name":"version","in":"query","required":false,"description":"Chart.js version to use. Alias: ?v=. Only v4.x is supported. Defaults to the installed version (4.5.1). Example: \"4\", \"4.5\", \"4.5.1\". The installed version is always returned in the X-ChartJS-Version response header.","schema":{"type":"string","default":"4.5.1","description":"Chart.js version to use. Alias: ?v=. Only v4.x is supported. Defaults to the installed version (4.5.1). Example: \"4\", \"4.5\", \"4.5.1\". The installed version is always returned in the X-ChartJS-Version response header."}},{"name":"share","in":"query","required":false,"description":"Set share: true to persist the chart and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (embeddable in emails, iframes, Markdown). view_url is a shareable interactive HTML page. Free plan: expires after 3 days with watermark. Paid plan: expires after 6 months, no branding.","schema":{"type":"boolean","description":"Set share: true to persist the chart and receive a JSON response with render_url and view_url instead of the image. render_url is a public direct image URL (embeddable in emails, iframes, Markdown). view_url is a shareable interactive HTML page. Free plan: expires after 3 days with watermark. Paid plan: expires after 6 months, no branding."}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad Request — missing or invalid parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Bad Request"}}}},"500":{"description":"Internal Server Error — something went wrong on our side.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"Internal Error"}}}}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message."}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your API key. Include it in the x-api-key header for every request."}}}},"proxyUrl":"$undefined"}}] </article></body></html>

Label Render

Paramètres de chemin

Paramètres de requête

Corps de la réponse

200

400application/json

500application/json

`application/json`

`application/json`