These endpoints are part of the Platform API. See the Aurora Solar API section for details.

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

AutoDesigner is a tool for automatically creating an optimal system design (e.g. panels, inverters) on a roof design, within user-defined constraints. This action allows you to run AutoDesigner on a specific design.

On a successful AutoDesigner run, a new system design is added to the specified design_id. Note that a pre-existing system design will be replaced when you run AutoDesigner. Upon completion of an asynchronous AutoDesigner job, a webhook can be sent out to: https://HOST/PATH?design_id=<DESIGN_ID>&job_id=<JOB_ID>&status=<STATUS>

  • <DESIGN_ID> is the ID of the design for which the AutoDesigner was run.

  • <JOB_ID> is the ID identifying the specific AutoDesigner run.

  • <STATUS> is the status of the completed AutoDesigner job ("succeeded" or "failed").

To set up this webhook, please contact your Aurora Account Executive or the Aurora support team at [email protected]