Run AutoDesigner on a design.
This endpoint is not provisioned by default in all tenants. For availability, please contact your Aurora account team.
Note that this is an asynchronous endpoint. See the Asynchronous Endpoints appendix for more info.
There are currently 2 run modes available for AutoDesigner:
max_fit: Places the maximum number of panels possible within the constraints passed in through
- Only takes
componentsinput parameter, will ignore other components.
- Optionally include an energy
target(yearly kWh) to enable a set of panels that produce the
targetenergy. The rest of the panels (that
max_fitthe remaining roof) will be disabled, meaning they will not affect the performance simulation but users of the app can toggle them on or off as necessary.
- Additionally when including an energy
target, optionally attach a microinverter to all panels by specifying one in tenant settings (the "Add Microinverters" field in the Aurora Solar App admin settings: https://v2.aurorasolar.com/settings/sales-mode-design).
- Only takes
energy: Places components to generate energy production that is as close as possible to the
targetfield (in kWh) within the constraints passed in through
In order to find the IDs for
components to use, you need to use the Aurora application. Go to https://v2.aurorasolar.com/database for a list of all components, or:
Solar Panels: https://v2.aurorasolar.com/database/solar-panels
Inverters / Micro Inverters: https://v2.aurorasolar.com/database/solar-inverters
DC Optimizers: https://v2.aurorasolar.com/database/dc-optimizers
Click on a component and the ID will be included in the URL. Ex: