Run AutoDesigner

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 through placement_options.

  • Only takes solar_panels in the components input parameter, will ignore other components.
  • Optionally include an energy target (yearly kWh) to enable a set of panels that approximately produce the target energy. The rest of the panels (that max_fit the 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.

• energy: Places components to generate energy production that is as close as possible to the target field (in kWh) within the constraints passed in through placement_options

You can use Components API or the Aurora application to find the ids for components. Go to https://v2.aurorasolar.com/database for a list of all components, or:

• Solar Panels: https://v2.aurorasolar.com/database/generation/modules

• Inverters / Micro Inverters: https://v2.aurorasolar.com/database/generation/inverters

• DC Optimizers: https://v2.aurorasolar.com/database/generation/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]