Run AutoDesigner on a design.
[block:callout] { "type": "info", "body": "This endpoint is not provisioned by default in all tenants. For availability, please contact your Aurora account team." } [/block] 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 throughplacement_options
.- Only takes
solar_panels
in thecomponents
input parameter, will ignore other components.
- Only takes
-
energy
: Places components to generate energy production that is as close as possible to thetarget
field (in kWh) within the constraints passed in throughplacement_options
In order to find the IDs for components
to use, you need to use the Aurora application. Go to https://app.aurorasolar.com/database for a list of all components, or:
-
Solar Panels: https://app.aurorasolar.com/database/solar-panels
-
Inverters / Micro Inverters: https://app.aurorasolar.com/database/solar-inverters
-
DC Optimizers: https://app.aurorasolar.com/database/dc-optimizers
Click on a component and the ID will be included in the URL. Ex: [block:image] { "images": [ { "image": [ "https://aurorasolar-backend-docs.s3.amazonaws.com/images/autodesigner_v2_database_screenshot.png", "autodesigner_v2_database_screenshot.png", 1844, 1708, "#ededed" ] } ] } [/block]