Render the model
onshape_shaded_viewGenerate an on-demand shaded image of a CAD element to verify current geometry before exporting.
Instructions
Render the element server-side and return the image. Unlike a thumbnail this is generated on demand, so it always shows the current geometry — use it to check a model visually before exporting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ws | Yes | Workspace id — the <ws> segment of the document URL. | |
| doc | Yes | Document id — the <doc> in cad.onshape.com/documents/<doc>/w/<ws>/e/<elem>. | |
| out | No | Output PNG path (default onshape-<timestamp>.png in the output directory). | |
| elem | Yes | Element id (tab) — the <elem> segment of the document URL. | |
| kind | No | Element kind being exported (default partstudios). | |
| width | No | Image width in pixels (default 600). | |
| height | No | Image height in pixels (default 340). | |
| no_edges | No | Hide edges in the render. | |
| view_matrix | No | 3x4 row-major camera matrix as 12 comma-separated numbers (default isometric). | |
| return_image | No | Also return the PNG inline (default true). | |
| configuration | No | Encoded configuration string. |