Skip to main content
POST
/
Project
/
{projectId}
/
Prediction
Create a prediction
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
}
'
{
  "id": 726228
}

Authorizations

​
Authorization
string
header
required

Pass Authorization: Bearer <token> on every request. See the Authentication section of the API description for how to fetch a token.

Path Parameters

​
projectId
integer
required

Body

application/json
​
name
string
required
​
description
string | null
​
status
enum<integer>

PredictionStatusEnum

Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10
​
projectId
integer
​
powerPlantId
integer | null
​
weatherId
integer | null
​
start
string

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.

​
end
string

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.

​
yearRepeater
integer
​
transpositionModel
enum<integer>

TranspositionModelType

Available options:
0,
1
​
perezCoefficients
enum<integer>

PerezCoefficientsEnum

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
​
diffuseDirectDecompModel
enum<integer>

DiffuseDirectDecompModelType

Available options:
0,
1,
2,
3
​
circumsolarTreatment
enum<integer>

CircumsolarTreatmentType

Available options:
0,
1
​
airMassModel
enum<integer>

AirMassModelType

Available options:
0,
1
​
soilingModel
enum<integer>

SoilingModelType

Available options:
0,
1,
2
​
modTempModel
enum<integer>

ModuleTemperatureModelType

Available options:
0,
1,
2,
3
​
incAngleModel
enum<integer>

IncidenceAngleModelType

Available options:
2,
3,
4,
5,
6
​
directBeamShadingModel
enum<integer>

DirectBeamShadingModel

Available options:
0,
1,
2,
3,
5,
6
​
degradationModel
enum<integer>

DegradationModel

Available options:
0,
1,
2,
3,
4
​
diffuseShadingModel
enum<integer>

DiffuseShadingModel

Available options:
0,
1
​
spectralShiftModel
enum<integer>

SpectralShiftModel

Available options:
0,
1,
2,
3
​
linearDegradationRate
number
​
firstYearDegradation
boolean
​
errorModelAcc
number
​
errorSensAcc
number
​
errorIntAnnVar
number
​
errorMonAcc
number
​
errorSpaVar
number
​
useMeteoDni
boolean
​
useMeteoPOAI
boolean
​
useBacksidePOAI
boolean
​
useLeapYears
boolean
​
useWeatherFileAlbedoData
boolean
​
useMetastability
boolean
​
enableLeTID
boolean
​
max50Year
number
​
min50Year
number
​
cool996
number
​
minAnnualMeanDBTemp
number | null
​
elevation
number | null
​
timeZone
number | null
​
ashraeStation
string
​
ashraeWMO
string
​
ashraeDistance
number
​
ashraeVersion
enum<integer>

AshraeVersionEnum

Available options:
0,
1
​
logicVersion
enum<integer>

PredictionVersionEnum

Available options:
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
​
pValues
object[]
​
horizonDetails
object[]
​
nonLinearDegradationRates
object[]
​
monthlyFactors
object[]

Response

Created prediction ID

​
id
integer
required