Run CAD Screenshot

Generate a CAD screenshot of a design on demand, without a user having to open the design and click the manual screenshot button.


Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.

A screenshot can be generated at any stage of a design, including before an Irradiance Analysis has run. Setting image_layers.irradiance to true requires a completed Irradiance Analysis (panels mode); the endpoint returns a 422 otherwise.

Once the job succeeds, the resulting image is delivered as a "CAD API Screenshot" asset, retrievable via the List Design Assets / Retrieve Design Asset endpoints, and an asset_created webhook fires for it — there is no separate download endpoint. Unlike the "CAD Auto Screenshot" produced when a design is saved, a CAD API Screenshot never replaces a prior screenshot of any kind; up to 10 can accumulate per design, after which the endpoint returns a 422.

Path Params
uuid
required

The ID of the tenant to which the design belongs.

uuid
required

The ID of the design to screenshot.

Body Params
cad_screenshot_job
object

CAD screenshot fields to run the job with. The request body may be omitted entirely (or sent as {}) to use the default camera and layers.

Responses

Language
Credentials
Bearer
header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json