Render a PNG snapshot
render_snapshotRenders the diagram, or one part of it, as a PNG image for checking a drawing. Long edge 1568 px (scale 1, default) or 2000 px (scale 2); the background is the theme colour (light by default). It takes at most one of frameId (a frame, or any node, with everything inside it), region ({ x, y, w, h } in diagram coordinates, like get_canvas: the nodes it touches; frames reaching outside it are cut to it) or nodeIds (up to 60 nodes with their children). effectiveScale in the result is the pixels per diagram unit, and warnings lists low_detail below 0.6, where small text is not readable (a part of a large diagram renders with more detail). In a part, an edge to a node outside it is drawn up to just outside the part and listed in clippedEdges (clippedEdgeCount counts them all). Adds the Archboard watermark with watermark: true, or always when the organization’s plan requires it; watermarkStyle and watermarkPosition choose its look and corner, and the result reports what was applied. Returns the image plus { diagramId, width, height, effectiveScale, seq, watermark, watermarkSource, watermarkStyle, watermarkPosition, warnings, animatedEdgeCount, animatedEdges, clippedEdgeCount, clippedEdges, externalImageCount, externalImageNodeIds }; warnings lists watermark_style_adjusted when the requested style was replaced by badge, external_images_placeholder when images that point to an outside URL were drawn as placeholders (add_image imports them), and empty_diagram when the diagram has nothing to draw yet (the image is only the background). The PNG is a still image: animated edges are drawn in their first frame. animatedEdgeCount and animatedEdges [{ id, animation }] (up to 50) list the edges that animate in the editor; an edge animation setting that is not listed has no effect. export_diagram makes image files for the person. Known limits: external and AVIF images render as placeholders, colour emoji render in one colour, text inside nested SVG images is not drawn.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | 1 (default): long edge 1568 px. 2: long edge 2000 px. | |
| theme | No | Colour theme (default light). | |
| region | No | Render only this area { x, y, w, h } (diagram coordinates): the nodes it touches. | |
| frameId | No | Render only this frame (or any node) and its subtree. | |
| nodeIds | No | Render only these nodes (up to 60) and their children. | |
| diagramId | Yes | Diagram id (from list_diagrams or create_diagram). | |
| watermark | No | Add the Archboard watermark. Ignored when the organization’s plan always adds it (watermarkSource "plan"). | |
| watermarkStyle | No | Watermark style: badge (default: logo, name and domain on a light chip), badge-dark (the same on a dark chip), mark (logo only; replaced by badge when the organization’s plan requires the watermark), band (edge band). | |
| watermarkPosition | No | Corner: bottom-right (default), bottom-left, top-right, top-left. |