Charts by Szum

Use this when the user wants to preview or generate a chart. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Stores a 1 hour preview and returns public image URLs. Authenticated previews use the account's render allowance, and each image produced from a returned URL is another render. Anonymous previews are complimentary; their images use the anonymous image allowance.

Use this when the user wants to permanently save and publish a Szum chart document. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Supply one idempotencyKey per intended chart and reuse it for retries. Returns permanent public Image and Embed URLs plus Edit and Studio links; requires authentication and saved-chart storage.

Use this when the user wants to find charts in their saved library. Returns paginated metadata and URLs, not chart documents; requires authentication. Draft-only editor charts have publishedAt null, hasDraft true, and sizeBytes 0 because sizeBytes measures only the stored published document, not draft storage.

Use this when the user identifies a saved chart by id and wants to view it or retrieve its metadata and URLs. Displays the published chart when available and does not return its document; requires authentication.

Use this when the user identifies a saved chart by id and needs its complete published Szum document for inspection or reuse, or an earlier version's document from list_chart_versions. Does not return a newer editor draft; requires authentication.

Use this when the user wants to see a saved chart's earlier publications, find one to read with get_chart_document, or pick one to restore with restore_chart_version. Returns versions newest first with who published each, from where and what changed; requires authentication.

Use this when the Szum chart App needs to restore a rendered preview as its current transient or saved view. It is read-only, owner-scoped when authenticated, and hidden from the model.

Use this when the user wants to replace and publish a saved chart's document while keeping its id and URLs. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Refuses charts with unpublished editor changes; requires authentication and saved-chart storage.

Use this when the user wants a saved chart to go back to an earlier version from list_chart_versions. Publishes that version's document again as a new version, keeping the chart's id and URLs, so the version it replaces stays restorable. Refuses charts with unpublished editor changes; requires authentication.

Use this when the user wants to change a saved chart's library title without changing its document, publication state, or public URLs; requires authentication.

Use this when the user explicitly wants to permanently delete one saved chart. Deletion cannot be undone, and retrying an already completed deletion succeeds; requires authentication.

Use this when choosing a visual theme for a chart. Returns every built-in theme with guidance on where each works best and, when signed in, the workspace's shared themes.

Takes no parameters.

Use this when a chart request or document will be rendered, saved, or updated. Validate each generated or changed chart input once before rendering, saving, or updating. Do not revalidate unchanged input; a successful render preflights it for later saves or updates. Errors block; warnings require explicit user approval for the exact chart input. Rendering may add layout warnings to the semantic findings before an action proceeds. Suggestions do not block. A suggestedDocument is a complete, validated replacement. Review the proposed changes before using it; validate again only if you modify it. Read-only, free, and fast.

Use this when choosing a chart family. Returns every current chart type with its shared and family-specific fields.

Takes no parameters.

Get complete Szum documents for validation, rendering, or saving, with guidance on when to use each pattern. No filters returns one starter per chart type. Any filter searches the complete catalog; all supplied filters intersect. Most data is illustrative; the Vinyl waterfall cites RIAA reports. Empty matches mean no example satisfies every filter; remove a filter to broaden the search.

Use this before authoring an unfamiliar field instead of probing validate_chart for errors. Returns the JSON Schema for the whole Szum document, covering config, data, presentation, size, and output, with every referenced definition included. Pass chart_type to keep only that family's config variants; omitting it returns every family and is much larger. Generated value lists are summarized rather than enumerated; validate_chart remains the authority.