Skip to main content
POST
/
layouts
Create Layout
curl --request POST \
  --url https://api.example.com/layouts

​
POST /layouts

Creates a new layout record in the workspace. Layouts represent the physical arrangement of solar arrays, including simulation parameters, topology summaries, and optionally inline bulk data (table/string geometry).

​
Notes

  • Requires workspace write access.
  • The metadata field must include simulationParams with array configuration (arrayType, gcr, tilt, etc.).
  • An optional topologySummary provides component counts (inverters, combiners, strings, tables).
  • Small layouts can include inline bulkData directly in the request body.
  • Bulk data is stored on S3. For larger layouts, upload data separately and retrieve it via GET /layouts/{layout_id}/data.
  • The format field specifies the bulk data serialization format: "json" (default) or "arrow".
  • Returns the created layout’s layoutId, globalLayoutId, name, version, snapshotHash, and dateCreated.