Predictions
Update export options for a prediction's power plant
Sets which sub-systems are included when results for this prediction are exported (e.g. nodal-level vs. aggregate, AC system, ESS, custom array configurations). Has no effect on the simulation itself — only on what the export endpoints subsequently return.
PUT
/
Project
/
{projectId}
/
Prediction
/
{predictionId}
/
PowerPlant
/
ExportOptions
Update export options for a prediction's power plant
curl --request PUT \
--url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exportSystem": true,
"exportESS": true,
"nodalExportOptions": [
{
"name": 1,
"exportBlock": true,
"exportArrays": true,
"exportInverters": true,
"exportDCFields": true
},
{
"name": 2,
"exportBlock": true,
"exportArrays": true,
"exportInverters": true,
"exportDCFields": true
}
]
}
'import requests
url = "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions"
payload = {
"exportSystem": True,
"exportESS": True,
"nodalExportOptions": [
{
"name": 1,
"exportBlock": True,
"exportArrays": True,
"exportInverters": True,
"exportDCFields": True
},
{
"name": 2,
"exportBlock": True,
"exportArrays": True,
"exportInverters": True,
"exportDCFields": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
exportSystem: true,
exportESS: true,
nodalExportOptions: [
{
name: 1,
exportBlock: true,
exportArrays: true,
exportInverters: true,
exportDCFields: true
},
{
name: 2,
exportBlock: true,
exportArrays: true,
exportInverters: true,
exportDCFields: true
}
]
})
};
fetch('https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions', 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.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'exportSystem' => true,
'exportESS' => true,
'nodalExportOptions' => [
[
'name' => 1,
'exportBlock' => true,
'exportArrays' => true,
'exportInverters' => true,
'exportDCFields' => true
],
[
'name' => 2,
'exportBlock' => true,
'exportArrays' => true,
'exportInverters' => true,
'exportDCFields' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions"
payload := strings.NewReader("{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "The request is invalid.",
"modelState": {
"latitude": [
"The field Latitude must be between -90 and 90."
]
}
}"Project not found.""An error has occurred."Authorizations
Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.
Body
application/json
The System Details page allows you to specify interconnection-related parameters including system availability, power plant output limits, and high-voltage (HV) transformation and transmission line details. These settings affect losses between the plant collection point and the energy meter (point of interconnection).
Response
Success
⌘I
Update export options for a prediction's power plant
curl --request PUT \
--url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"exportSystem": true,
"exportESS": true,
"nodalExportOptions": [
{
"name": 1,
"exportBlock": true,
"exportArrays": true,
"exportInverters": true,
"exportDCFields": true
},
{
"name": 2,
"exportBlock": true,
"exportArrays": true,
"exportInverters": true,
"exportDCFields": true
}
]
}
'import requests
url = "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions"
payload = {
"exportSystem": True,
"exportESS": True,
"nodalExportOptions": [
{
"name": 1,
"exportBlock": True,
"exportArrays": True,
"exportInverters": True,
"exportDCFields": True
},
{
"name": 2,
"exportBlock": True,
"exportArrays": True,
"exportInverters": True,
"exportDCFields": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
exportSystem: true,
exportESS: true,
nodalExportOptions: [
{
name: 1,
exportBlock: true,
exportArrays: true,
exportInverters: true,
exportDCFields: true
},
{
name: 2,
exportBlock: true,
exportArrays: true,
exportInverters: true,
exportDCFields: true
}
]
})
};
fetch('https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions', 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.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'exportSystem' => true,
'exportESS' => true,
'nodalExportOptions' => [
[
'name' => 1,
'exportBlock' => true,
'exportArrays' => true,
'exportInverters' => true,
'exportDCFields' => true
],
[
'name' => 2,
'exportBlock' => true,
'exportArrays' => true,
'exportInverters' => true,
'exportDCFields' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions"
payload := strings.NewReader("{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"exportSystem\": true,\n \"exportESS\": true,\n \"nodalExportOptions\": [\n {\n \"name\": 1,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n },\n {\n \"name\": 2,\n \"exportBlock\": true,\n \"exportArrays\": true,\n \"exportInverters\": true,\n \"exportDCFields\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "The request is invalid.",
"modelState": {
"latitude": [
"The field Latitude must be between -90 and 90."
]
}
}"Project not found.""An error has occurred."