Create a new solar system design

Creates a new solar system design for a project with specifications and performance data.

Business Context:
Solar designs define the technical specifications and performance characteristics
of the proposed solar installation, including system size, equipment selection,
and energy production estimates.

Design Creation Process:

  1. Layout Planning: System size and equipment configuration
  2. Performance Modeling: Energy production and shading analysis
  3. Equipment Selection: Modules, inverters, racking, and storage
  4. Optimization: Balancing cost, performance, and aesthetics

Required Design Data:

  • System Size: Total DC capacity in kilowatts
  • Performance Metrics: Annual production and system offset
  • Shading Analysis: Annual Solar Access (ASA) percentage
  • Design Identity: Name and source system

Primary Design Logic:

  • If isPrimary=true: Sets this as the active design (others become secondary)
  • If isPrimary=false/null and no primary exists: Becomes primary automatically
  • If isPrimary=false/null and primary exists: Becomes secondary design

Integration Sources:

  • Manual Entry: Basic system specifications
  • Design Software: Aurora Solar, Helioscope, PV*SOL
  • Site Analysis: Scanifly, Sunobi integration
  • API Import: External design tools and platforms

Common Use Cases:

  • Initial system sizing and layout
  • Design import from engineering software
  • Alternative design scenarios
  • System optimization iterations
  • Customer presentation materials
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Schema for creating a new solar system design for a project.

uuid
required

The unique identifier of the project this design belongs to.

string
required
length ≤ 255

Human-readable name for this design version.

string | null
enum
Defaults to api

The source system or tool used to create this design.

Allowed:
float
required
≥ 1

Total system size in kilowatts.

float
required
≥ 1

Percentage of customer's annual energy usage that this system will offset.

float
required
≥ 1

Annual Solar Access percentage representing shading analysis results.

float
required
≥ 1

Estimated annual energy production in kilowatt-hours (kWh).

boolean

Whether this design should be set as the primary/active design for the project.

batteries
array of objects

Optional battery storage systems to be included with this design.

batteries
inverters
array of objects

Inverter systems to convert DC solar power to AC electricity.

inverters
racking
array of objects

Mounting and racking systems to secure solar panels.

racking
segments
array of objects

The solar module arrays.

segments
externalId
array of objects

External identifiers to link this design with other systems.

externalId
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/ld+json