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.

The design must have a completed Irradiance Analysis (panels mode) before a screenshot can be generated; 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.

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