CAD Screenshot

Note that this is an asynchronous set of endpoints. See the Asynchronous Endpoints appendix for more info.

Use this set of endpoints to generate a CAD screenshot of a design on demand, without a user having to open the design in Aurora and click the manual screenshot button. The design must have a completed Irradiance Analysis (panels mode) before a screenshot can be generated.

The resulting image is not returned directly. Once the job succeeds, it 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. Unlike the "CAD Auto Screenshot" produced automatically when a design is saved, a CAD API Screenshot never replaces a prior screenshot of any kind — multiple can accumulate for the same design, up to a limit of 10 per design.

Camera and layer settings

By default, the screenshot uses a standard camera framing and a standard set of visible layers (see below). Optionally, pass camera_settings and/or image_layers in the request body of Run CAD Screenshot to override either for that screenshot only.

Currently supported:

• camera_settings.preset: "top_down" — a straight-down camera view. With no camera_settings given at all, the camera uses the design's own saved position; there's no single fixed default distance to reproduce, since the engine's framing is computed per design.
• camera_settings.radius: a number between 1 and 150, in meters — sets the camera's distance from the design, keeping its saved tilt/rotation/look-at. Cannot be combined with preset in the same request.
• image_layers: any of azimuths, buildings, droneMesh, map, measurements, modules, parcel, lidar, irradiance, rulers, setbacks, sunpath, trees, each true/false. A layer set to true is shown and one set to false is hidden; a layer not mentioned at all falls back to this API's standard default (below) rather than the design's own saved state -- this keeps results stable for fully automated callers who screenshot a design before anyone has reviewed or edited it, so there's no saved state of its own to rely on yet. Note that map also controls the ground plane and sky backdrop it's rendered against -- all three are toggled together by this one flag.

Standard default layers (used for any layer not mentioned in image_layers): azimuths, buildings, map, measurements, modules, setbacks, and trees are visible by default; droneMesh, irradiance, lidar, parcel, rulers, and sunpath are hidden by default. This default is a fixed part of this API's contract -- it won't silently change if Aurora's own default CAD rendering changes elsewhere.

Both objects are optional, and more presets/layers may be added over time.