Render a design
render_designRead-only
A PNG of the design, rendered as it will export. Check the work with it after each meaningful change. Zoom with region or node_id, read pixel colours with sample_points, or judge shapes with hide, only and mode; time shows one moment of an animation. For layout problems as data use check_layout; for many moments of an animation use render_contact_sheet. Previews are PNGs at most 800 px on the longest side, with a faint repeating "Kalpana preview" mark. The mark is only on previews; the design, its exports and batch renders do not have it, and sample_points read the design's own colours. Zoom with region or node_id to check small text or detail.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hide | No | Hide these layers for this picture only (the design is unchanged). | |
| mode | No | "color" (default), "grey" for a value study, or "silhouette" to judge a shape's read (use with `only`). | |
| only | No | Show only these layers (with their children) for this picture. | |
| time | No | Second of the animation to show (default 0). See render_contact_sheet for many moments in one picture. | |
| sizes | No | Several pictures in one call, each with this longest side in px (1 to 4 values, each at most 800), in place of max_size. | |
| intent | No | Optional: a few words on why. | |
| region | No | Zoom into this part: [x, y, width, height] in design px. | |
| node_id | No | Zoom into a layer: its laid-out box grown by `padding`. | |
| padding | No | Space around `node_id`'s box in design px (default 24). | |
| page_id | Yes | The page to work on, as returned by create_design. | |
| regions | No | Several close-ups in one call: each [x, y, width, height] in design px. Combines with `node_ids`; 4 pictures at most, each `max_size`. | |
| max_size | No | Longest side of the picture in px (default and at most 800). Zoom with region or node_id for detail. | |
| node_ids | No | Several layers to zoom into, one picture each (box grown by `padding`). | |
| sample_points | No | Points [x, y] in design px whose colour to read; returned as {x, y, hex, alpha}. |