Render screens to an image
screenshotRender up to four project screens as one inline image, after a design run completes. Rendering is free. Send projectUrl with the image so your user can open and edit the designs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | Pixel density. 1 is right for showing a design in chat; raise it only when the user asked for a high-resolution export. | |
| format | No | Image encoding for the screenshot. | png |
| padding | No | Space in pixels on each side of the row of frames. | |
| projectId | Yes | Project id from an item's id in list_projects, or data.id in create_project. | |
| background | No | CSS background behind the frames, such as "#ffffff" or "transparent". | transparent |
| fullHeight | No | Expand each frame to the full height of its content before capturing, so scrollable screens are rendered fully extended rather than cut off at the bottom of the frame. Frames are capped at 4x the default frame height. | |
| componentIds | Yes | Component id from an item's id in list_components, or a componentId in a run's data.result.operations. Not a screenId. Screens render left to right. Render more than 4 in separate calls. |