Create Layout
curl --request POST \
--url https://api.example.com/layoutsimport requests
url = "https://api.example.com/layouts"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/layouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/layouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/layouts"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/layouts")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/layouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyLayouts
Create Layout
Create a new layout with metadata and optional inline bulk data
POST
/
layouts
Create Layout
curl --request POST \
--url https://api.example.com/layoutsimport requests
url = "https://api.example.com/layouts"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/layouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/layouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/layouts"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/layouts")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/layouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_bodyPOST /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
metadatafield must includesimulationParamswith array configuration (arrayType, gcr, tilt, etc.). - An optional
topologySummaryprovides component counts (inverters, combiners, strings, tables). - Small layouts can include inline
bulkDatadirectly 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
formatfield specifies the bulk data serialization format:"json"(default) or"arrow". - Returns the created layout’s
layoutId,globalLayoutId,name,version,snapshotHash, anddateCreated.
