Skip to main content

Export Storyboard Image

Available September 2026 and later.

Renders a storyboard's active story point from the workbook open in Tableau Studio as an image. Only the currently active story point is rendered — other story points are not included and cannot be selected. By default the image comes back inline in the tool result; supply filePath and Tableau Studio writes the image to that path instead, and the result reports the path rather than the bytes.

Destructive

This tool is not read-only and not idempotent. When you supply filePath, Tableau Studio writes to that location and overwrites any file already there.

APIs called​

This tool reads from the workbook open in the local Tableau Studio instance, not from the Tableau Cloud or Tableau Server REST API. Under the hood these are calls to the local Tableau Studio External Client API — a REST API the running Tableau Studio instance serves at http://127.0.0.1:<port>/v<x>, where <x> is the latest API version. There are no OAuth scopes: each call is authorized by the running Tableau Studio instance's per-session bearer token over the loopback interface. Rendering is a two-step sequence: the storyboard you name is resolved to an id against the live workbook, then that id is rendered.

  • Lists the storyboards in the open workbook so your selector can be resolved to a storyboard id. If it resolves to nothing, or to more than one storyboard, the tool stops here and no render is attempted.
    • GET /v<x>/workbook/storyboards — list the storyboards in the open workbook. API reference
  • Renders the resolved storyboard's active story point. filePath and mimeType ride along as query parameters, so Tableau Studio decides both the output format and whether it writes the file. This call runs under its own deadline (IMAGE_EXPORT_TIMEOUT_MS, 30 seconds by default), so a render that never returns (for example, because Tableau Studio is showing a modal dialog) is reported as a timeout rather than waited on indefinitely.
    • GET /v<x>/workbook/storyboards/{id}/image — render the storyboard's active story point as an image. API reference

Optional arguments​

storyboardName​

The storyboard to render, given as either its name or its id. This selects the storyboard, not a story point: only the currently active story point is rendered, and other points cannot be selected.

Required unless it is supplied through the deprecated storyboard alias. The two arguments are the same selector, so exactly one of them has to carry a value: a call that supplies neither fails with storyboardName is required (storyboard is a deprecated alias). and never reaches Tableau Studio. When both are supplied, storyboardName is the one used — and it must agree with the alias, or the call is refused (see storyboard).

How the selector resolves​

The value is matched against the storyboards in the open workbook, id first and then name:

  • An exact id match wins immediately
  • Otherwise an exact name match is used, provided exactly one storyboard has that name. If several do, the tool lists them with their ids and asks you to pass one id
  • A name containing XML entities (for example &amp;) is also retried in its decoded form
  • If nothing matches, the error lists the storyboards that are available

Example​

"QBR Story"


storyboard​

Deprecated alias of storyboardName, kept working for existing callers. Pass one or the other. Supplying both is allowed only when they are identical; if they disagree the call fails with an error naming both values, and no storyboard list or render is attempted.

Example​

"QBR Story"


session​

Identifier of the target Tableau Studio session. When omitted, the session is resolved automatically (for example, when exactly one Tableau Studio instance is connected).

Example​

"studio-1"


filePath​

Absolute path for Tableau Studio to save the image to. When supplied, the image is not returned inline: Tableau Studio writes the file and the tool reports the path, along with the rendered pixel dimensions when Tableau Studio provides them. Omit it to get the image inline instead.

The path is forwarded exactly as you give it — Tableau Studio is the authority on what a valid path is, and rejects a relative or ..-bearing path with an invalid-path error naming the offending value. Nothing is written in that case.

Inline size cap​

When the image comes back inline, its footprint in the conversation is capped (INLINE_IMAGE_MAX_BYTES, 1 MB by default). Over the cap, the tool writes the rendered bytes to a local cache file and returns that path with an explanatory message instead of the image. SVG counts double against the cap, because it is returned both as markup and as an image.

Example​

"/Users/me/exports/qbr-story.png"


mimeType​

Format to render. One of image/png or image/svg+xml. Defaults to image/png. When omitted, no format is requested and Tableau Studio renders its default, PNG.

An SVG that comes back inline is returned twice in the same result: once as its markup in a text block, so clients that cannot display an SVG image still get the content, and once as an image. The result is labelled with the format Tableau Studio reports it actually rendered, which is not necessarily the one you requested.

Example​

"image/svg+xml"

Example results​

Returned inline (filePath omitted)​

{ "type": "image", "mimeType": "image/png", "data": "iVBORw0KGgoAAAANSUhEUgAA..." }

Written to a file (filePath supplied)​

Storyboard image written to /Users/me/exports/qbr-story.png (1400x1000).

Over the inline cap​

Storyboard image is 2097152 bytes, over the 1048576-byte inline cap. Written to a file instead of returned inline to keep large images out of the conversation.

Image file: /Users/me/.tableau-mcp/cache/storyboard-image-abc123.png

Open the file to view the image. To get a smaller inline image next time, request a worksheet instead of a whole dashboard, or pass a filePath to have Tableau write the image directly to a location of your choosing.
  • get-sheets — lists the storyboards in the open workbook, with the ids this tool accepts.
  • export-dashboard-image — the same image-export pattern for a dashboard rather than a storyboard.