Create a prediction
Creates a new prediction under the given project. The prediction starts in status: 0 (Draft) and must subsequently be associated with a PowerPlant via POST .../PowerPlant before it can be run. Most model parameters can be left at their defaults; see the Prediction schema for the complete list and their enum values.
curl --request POST \
--url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Postman Doc Sample",
"status": 1,
"pValues": [],
"horizonDetails": [],
"nonLinearDegradationRates": [],
"plantDesignTemperatures": [],
"yearRepeater": 1,
"airMassModel": 0,
"modTempModel": 0,
"incAngleModel": 5,
"directBeamShadingModel": 5,
"degradationModel": 0,
"diffuseShadingModel": 1,
"transpositionModel": 1,
"diffuseDirectDecompModel": 3,
"max50Year": 39.4,
"min50Year": -30.3,
"cool996": 32.5,
"minAnnualMeanDBTemp": -19.1,
"elevation": 184,
"timeZone": -5,
"ashraeStation": "TOLEDO CGS, OH, USA",
"ashraeWMO": "997295",
"ashraeDistance": 7.079021066538359,
"monthlyFactors": [
{
"month": 1,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 2,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 3,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 4,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 5,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 6,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 7,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 8,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 9,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 10,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 11,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 12,
"soilingLoss": 2.2,
"albedo": 0.3
}
],
"spectralShiftModel": 2,
"soilingModel": 0,
"useMeteoDni": false,
"firstYearDegradation": false,
"linearDegradationRate": 0.5,
"errorIntAnnVar": 3,
"errorSensAcc": 5,
"errorMonAcc": 2,
"errorSpaVar": 2,
"errorModelAcc": 2.9,
"logicVersion": 11,
"ashraeVersion": 2021,
"originalAshraeStation": "TOLEDO CGS, OH, USA",
"originalAshraeWMO": "997295",
"originalAshraeDistance": 7.079021066538359,
"originalCool996": 32.5,
"originalMax50Year": 39.4,
"originalMin50Year": -30.3,
"originalMinAnnualMeanDBTemp": -19.1,
"originalTimeZone": -5,
"originalElevation": 184,
"circumsolarTreatment": 0
}
'import requests
url = "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction"
payload = {
"name": "Postman Doc Sample",
"status": 1,
"pValues": [],
"horizonDetails": [],
"nonLinearDegradationRates": [],
"plantDesignTemperatures": [],
"yearRepeater": 1,
"airMassModel": 0,
"modTempModel": 0,
"incAngleModel": 5,
"directBeamShadingModel": 5,
"degradationModel": 0,
"diffuseShadingModel": 1,
"transpositionModel": 1,
"diffuseDirectDecompModel": 3,
"max50Year": 39.4,
"min50Year": -30.3,
"cool996": 32.5,
"minAnnualMeanDBTemp": -19.1,
"elevation": 184,
"timeZone": -5,
"ashraeStation": "TOLEDO CGS, OH, USA",
"ashraeWMO": "997295",
"ashraeDistance": 7.079021066538359,
"monthlyFactors": [
{
"month": 1,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 2,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 3,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 4,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 5,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 6,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 7,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 8,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 9,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 10,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 11,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 12,
"soilingLoss": 2.2,
"albedo": 0.3
}
],
"spectralShiftModel": 2,
"soilingModel": 0,
"useMeteoDni": False,
"firstYearDegradation": False,
"linearDegradationRate": 0.5,
"errorIntAnnVar": 3,
"errorSensAcc": 5,
"errorMonAcc": 2,
"errorSpaVar": 2,
"errorModelAcc": 2.9,
"logicVersion": 11,
"ashraeVersion": 2021,
"originalAshraeStation": "TOLEDO CGS, OH, USA",
"originalAshraeWMO": "997295",
"originalAshraeDistance": 7.079021066538359,
"originalCool996": 32.5,
"originalMax50Year": 39.4,
"originalMin50Year": -30.3,
"originalMinAnnualMeanDBTemp": -19.1,
"originalTimeZone": -5,
"originalElevation": 184,
"circumsolarTreatment": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Postman Doc Sample',
status: 1,
pValues: [],
horizonDetails: [],
nonLinearDegradationRates: [],
plantDesignTemperatures: [],
yearRepeater: 1,
airMassModel: 0,
modTempModel: 0,
incAngleModel: 5,
directBeamShadingModel: 5,
degradationModel: 0,
diffuseShadingModel: 1,
transpositionModel: 1,
diffuseDirectDecompModel: 3,
max50Year: 39.4,
min50Year: -30.3,
cool996: 32.5,
minAnnualMeanDBTemp: -19.1,
elevation: 184,
timeZone: -5,
ashraeStation: 'TOLEDO CGS, OH, USA',
ashraeWMO: '997295',
ashraeDistance: 7.079021066538359,
monthlyFactors: [
{month: 1, soilingLoss: 2.2, albedo: 0.3},
{month: 2, soilingLoss: 2.2, albedo: 0.3},
{month: 3, soilingLoss: 2.2, albedo: 0.3},
{month: 4, soilingLoss: 2.2, albedo: 0.3},
{month: 5, soilingLoss: 2.2, albedo: 0.3},
{month: 6, soilingLoss: 2.2, albedo: 0.3},
{month: 7, soilingLoss: 2.2, albedo: 0.3},
{month: 8, soilingLoss: 2.2, albedo: 0.3},
{month: 9, soilingLoss: 2.2, albedo: 0.3},
{month: 10, soilingLoss: 2.2, albedo: 0.3},
{month: 11, soilingLoss: 2.2, albedo: 0.3},
{month: 12, soilingLoss: 2.2, albedo: 0.3}
],
spectralShiftModel: 2,
soilingModel: 0,
useMeteoDni: false,
firstYearDegradation: false,
linearDegradationRate: 0.5,
errorIntAnnVar: 3,
errorSensAcc: 5,
errorMonAcc: 2,
errorSpaVar: 2,
errorModelAcc: 2.9,
logicVersion: 11,
ashraeVersion: 2021,
originalAshraeStation: 'TOLEDO CGS, OH, USA',
originalAshraeWMO: '997295',
originalAshraeDistance: 7.079021066538359,
originalCool996: 32.5,
originalMax50Year: 39.4,
originalMin50Year: -30.3,
originalMinAnnualMeanDBTemp: -19.1,
originalTimeZone: -5,
originalElevation: 184,
circumsolarTreatment: 0
})
};
fetch('https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Postman Doc Sample',
'status' => 1,
'pValues' => [
],
'horizonDetails' => [
],
'nonLinearDegradationRates' => [
],
'plantDesignTemperatures' => [
],
'yearRepeater' => 1,
'airMassModel' => 0,
'modTempModel' => 0,
'incAngleModel' => 5,
'directBeamShadingModel' => 5,
'degradationModel' => 0,
'diffuseShadingModel' => 1,
'transpositionModel' => 1,
'diffuseDirectDecompModel' => 3,
'max50Year' => 39.4,
'min50Year' => -30.3,
'cool996' => 32.5,
'minAnnualMeanDBTemp' => -19.1,
'elevation' => 184,
'timeZone' => -5,
'ashraeStation' => 'TOLEDO CGS, OH, USA',
'ashraeWMO' => '997295',
'ashraeDistance' => 7.079021066538359,
'monthlyFactors' => [
[
'month' => 1,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 2,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 3,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 4,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 5,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 6,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 7,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 8,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 9,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 10,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 11,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 12,
'soilingLoss' => 2.2,
'albedo' => 0.3
]
],
'spectralShiftModel' => 2,
'soilingModel' => 0,
'useMeteoDni' => false,
'firstYearDegradation' => false,
'linearDegradationRate' => 0.5,
'errorIntAnnVar' => 3,
'errorSensAcc' => 5,
'errorMonAcc' => 2,
'errorSpaVar' => 2,
'errorModelAcc' => 2.9,
'logicVersion' => 11,
'ashraeVersion' => 2021,
'originalAshraeStation' => 'TOLEDO CGS, OH, USA',
'originalAshraeWMO' => '997295',
'originalAshraeDistance' => 7.079021066538359,
'originalCool996' => 32.5,
'originalMax50Year' => 39.4,
'originalMin50Year' => -30.3,
'originalMinAnnualMeanDBTemp' => -19.1,
'originalTimeZone' => -5,
'originalElevation' => 184,
'circumsolarTreatment' => 0
]),
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"
payload := strings.NewReader("{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}"
response = http.request(request)
puts response.read_body{
"id": 726228
}{
"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.
Path Parameters
Body
PredictionStatusEnum
1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.
ISO-8601 datetime as returned by the PlantPredict API. May or may not include a timezone offset; treat as server-local when no offset is present.
TranspositionModelType
0, 1 PerezCoefficientsEnum
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 DiffuseDirectDecompModelType
0, 1, 2, 3 CircumsolarTreatmentType
0, 1 AirMassModelType
0, 1 SoilingModelType
0, 1, 2 ModuleTemperatureModelType
0, 1, 2, 3 IncidenceAngleModelType
2, 3, 4, 5, 6 DirectBeamShadingModel
0, 1, 2, 3, 5, 6 DegradationModel
0, 1, 2, 3, 4 DiffuseShadingModel
0, 1 SpectralShiftModel
0, 1, 2, 3 AshraeVersionEnum
0, 1 PredictionVersionEnum
3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 Show child attributes
Show child attributes
Response
Created prediction ID
curl --request POST \
--url https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Postman Doc Sample",
"status": 1,
"pValues": [],
"horizonDetails": [],
"nonLinearDegradationRates": [],
"plantDesignTemperatures": [],
"yearRepeater": 1,
"airMassModel": 0,
"modTempModel": 0,
"incAngleModel": 5,
"directBeamShadingModel": 5,
"degradationModel": 0,
"diffuseShadingModel": 1,
"transpositionModel": 1,
"diffuseDirectDecompModel": 3,
"max50Year": 39.4,
"min50Year": -30.3,
"cool996": 32.5,
"minAnnualMeanDBTemp": -19.1,
"elevation": 184,
"timeZone": -5,
"ashraeStation": "TOLEDO CGS, OH, USA",
"ashraeWMO": "997295",
"ashraeDistance": 7.079021066538359,
"monthlyFactors": [
{
"month": 1,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 2,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 3,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 4,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 5,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 6,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 7,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 8,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 9,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 10,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 11,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 12,
"soilingLoss": 2.2,
"albedo": 0.3
}
],
"spectralShiftModel": 2,
"soilingModel": 0,
"useMeteoDni": false,
"firstYearDegradation": false,
"linearDegradationRate": 0.5,
"errorIntAnnVar": 3,
"errorSensAcc": 5,
"errorMonAcc": 2,
"errorSpaVar": 2,
"errorModelAcc": 2.9,
"logicVersion": 11,
"ashraeVersion": 2021,
"originalAshraeStation": "TOLEDO CGS, OH, USA",
"originalAshraeWMO": "997295",
"originalAshraeDistance": 7.079021066538359,
"originalCool996": 32.5,
"originalMax50Year": 39.4,
"originalMin50Year": -30.3,
"originalMinAnnualMeanDBTemp": -19.1,
"originalTimeZone": -5,
"originalElevation": 184,
"circumsolarTreatment": 0
}
'import requests
url = "https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction"
payload = {
"name": "Postman Doc Sample",
"status": 1,
"pValues": [],
"horizonDetails": [],
"nonLinearDegradationRates": [],
"plantDesignTemperatures": [],
"yearRepeater": 1,
"airMassModel": 0,
"modTempModel": 0,
"incAngleModel": 5,
"directBeamShadingModel": 5,
"degradationModel": 0,
"diffuseShadingModel": 1,
"transpositionModel": 1,
"diffuseDirectDecompModel": 3,
"max50Year": 39.4,
"min50Year": -30.3,
"cool996": 32.5,
"minAnnualMeanDBTemp": -19.1,
"elevation": 184,
"timeZone": -5,
"ashraeStation": "TOLEDO CGS, OH, USA",
"ashraeWMO": "997295",
"ashraeDistance": 7.079021066538359,
"monthlyFactors": [
{
"month": 1,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 2,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 3,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 4,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 5,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 6,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 7,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 8,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 9,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 10,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 11,
"soilingLoss": 2.2,
"albedo": 0.3
},
{
"month": 12,
"soilingLoss": 2.2,
"albedo": 0.3
}
],
"spectralShiftModel": 2,
"soilingModel": 0,
"useMeteoDni": False,
"firstYearDegradation": False,
"linearDegradationRate": 0.5,
"errorIntAnnVar": 3,
"errorSensAcc": 5,
"errorMonAcc": 2,
"errorSpaVar": 2,
"errorModelAcc": 2.9,
"logicVersion": 11,
"ashraeVersion": 2021,
"originalAshraeStation": "TOLEDO CGS, OH, USA",
"originalAshraeWMO": "997295",
"originalAshraeDistance": 7.079021066538359,
"originalCool996": 32.5,
"originalMax50Year": 39.4,
"originalMin50Year": -30.3,
"originalMinAnnualMeanDBTemp": -19.1,
"originalTimeZone": -5,
"originalElevation": 184,
"circumsolarTreatment": 0
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Postman Doc Sample',
status: 1,
pValues: [],
horizonDetails: [],
nonLinearDegradationRates: [],
plantDesignTemperatures: [],
yearRepeater: 1,
airMassModel: 0,
modTempModel: 0,
incAngleModel: 5,
directBeamShadingModel: 5,
degradationModel: 0,
diffuseShadingModel: 1,
transpositionModel: 1,
diffuseDirectDecompModel: 3,
max50Year: 39.4,
min50Year: -30.3,
cool996: 32.5,
minAnnualMeanDBTemp: -19.1,
elevation: 184,
timeZone: -5,
ashraeStation: 'TOLEDO CGS, OH, USA',
ashraeWMO: '997295',
ashraeDistance: 7.079021066538359,
monthlyFactors: [
{month: 1, soilingLoss: 2.2, albedo: 0.3},
{month: 2, soilingLoss: 2.2, albedo: 0.3},
{month: 3, soilingLoss: 2.2, albedo: 0.3},
{month: 4, soilingLoss: 2.2, albedo: 0.3},
{month: 5, soilingLoss: 2.2, albedo: 0.3},
{month: 6, soilingLoss: 2.2, albedo: 0.3},
{month: 7, soilingLoss: 2.2, albedo: 0.3},
{month: 8, soilingLoss: 2.2, albedo: 0.3},
{month: 9, soilingLoss: 2.2, albedo: 0.3},
{month: 10, soilingLoss: 2.2, albedo: 0.3},
{month: 11, soilingLoss: 2.2, albedo: 0.3},
{month: 12, soilingLoss: 2.2, albedo: 0.3}
],
spectralShiftModel: 2,
soilingModel: 0,
useMeteoDni: false,
firstYearDegradation: false,
linearDegradationRate: 0.5,
errorIntAnnVar: 3,
errorSensAcc: 5,
errorMonAcc: 2,
errorSpaVar: 2,
errorModelAcc: 2.9,
logicVersion: 11,
ashraeVersion: 2021,
originalAshraeStation: 'TOLEDO CGS, OH, USA',
originalAshraeWMO: '997295',
originalAshraeDistance: 7.079021066538359,
originalCool996: 32.5,
originalMax50Year: 39.4,
originalMin50Year: -30.3,
originalMinAnnualMeanDBTemp: -19.1,
originalTimeZone: -5,
originalElevation: 184,
circumsolarTreatment: 0
})
};
fetch('https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Postman Doc Sample',
'status' => 1,
'pValues' => [
],
'horizonDetails' => [
],
'nonLinearDegradationRates' => [
],
'plantDesignTemperatures' => [
],
'yearRepeater' => 1,
'airMassModel' => 0,
'modTempModel' => 0,
'incAngleModel' => 5,
'directBeamShadingModel' => 5,
'degradationModel' => 0,
'diffuseShadingModel' => 1,
'transpositionModel' => 1,
'diffuseDirectDecompModel' => 3,
'max50Year' => 39.4,
'min50Year' => -30.3,
'cool996' => 32.5,
'minAnnualMeanDBTemp' => -19.1,
'elevation' => 184,
'timeZone' => -5,
'ashraeStation' => 'TOLEDO CGS, OH, USA',
'ashraeWMO' => '997295',
'ashraeDistance' => 7.079021066538359,
'monthlyFactors' => [
[
'month' => 1,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 2,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 3,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 4,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 5,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 6,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 7,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 8,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 9,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 10,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 11,
'soilingLoss' => 2.2,
'albedo' => 0.3
],
[
'month' => 12,
'soilingLoss' => 2.2,
'albedo' => 0.3
]
],
'spectralShiftModel' => 2,
'soilingModel' => 0,
'useMeteoDni' => false,
'firstYearDegradation' => false,
'linearDegradationRate' => 0.5,
'errorIntAnnVar' => 3,
'errorSensAcc' => 5,
'errorMonAcc' => 2,
'errorSpaVar' => 2,
'errorModelAcc' => 2.9,
'logicVersion' => 11,
'ashraeVersion' => 2021,
'originalAshraeStation' => 'TOLEDO CGS, OH, USA',
'originalAshraeWMO' => '997295',
'originalAshraeDistance' => 7.079021066538359,
'originalCool996' => 32.5,
'originalMax50Year' => 39.4,
'originalMin50Year' => -30.3,
'originalMinAnnualMeanDBTemp' => -19.1,
'originalTimeZone' => -5,
'originalElevation' => 184,
'circumsolarTreatment' => 0
]),
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"
payload := strings.NewReader("{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plantpredict.terabase.energy/Project/{projectId}/Prediction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Postman Doc Sample\",\n \"status\": 1,\n \"pValues\": [],\n \"horizonDetails\": [],\n \"nonLinearDegradationRates\": [],\n \"plantDesignTemperatures\": [],\n \"yearRepeater\": 1,\n \"airMassModel\": 0,\n \"modTempModel\": 0,\n \"incAngleModel\": 5,\n \"directBeamShadingModel\": 5,\n \"degradationModel\": 0,\n \"diffuseShadingModel\": 1,\n \"transpositionModel\": 1,\n \"diffuseDirectDecompModel\": 3,\n \"max50Year\": 39.4,\n \"min50Year\": -30.3,\n \"cool996\": 32.5,\n \"minAnnualMeanDBTemp\": -19.1,\n \"elevation\": 184,\n \"timeZone\": -5,\n \"ashraeStation\": \"TOLEDO CGS, OH, USA\",\n \"ashraeWMO\": \"997295\",\n \"ashraeDistance\": 7.079021066538359,\n \"monthlyFactors\": [\n {\n \"month\": 1,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 2,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 3,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 4,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 5,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 6,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 7,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 8,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 9,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 10,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 11,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n },\n {\n \"month\": 12,\n \"soilingLoss\": 2.2,\n \"albedo\": 0.3\n }\n ],\n \"spectralShiftModel\": 2,\n \"soilingModel\": 0,\n \"useMeteoDni\": false,\n \"firstYearDegradation\": false,\n \"linearDegradationRate\": 0.5,\n \"errorIntAnnVar\": 3,\n \"errorSensAcc\": 5,\n \"errorMonAcc\": 2,\n \"errorSpaVar\": 2,\n \"errorModelAcc\": 2.9,\n \"logicVersion\": 11,\n \"ashraeVersion\": 2021,\n \"originalAshraeStation\": \"TOLEDO CGS, OH, USA\",\n \"originalAshraeWMO\": \"997295\",\n \"originalAshraeDistance\": 7.079021066538359,\n \"originalCool996\": 32.5,\n \"originalMax50Year\": 39.4,\n \"originalMin50Year\": -30.3,\n \"originalMinAnnualMeanDBTemp\": -19.1,\n \"originalTimeZone\": -5,\n \"originalElevation\": 184,\n \"circumsolarTreatment\": 0\n}"
response = http.request(request)
puts response.read_body{
"id": 726228
}{
"message": "The request is invalid.",
"modelState": {
"latitude": [
"The field Latitude must be between -90 and 90."
]
}
}"Project not found.""An error has occurred."