> ## Documentation Index > Fetch the complete documentation index at: https://docs.plantpredict.com/llms.txt > Use this file to discover all available pages before exploring further. # Get prediction result summary > Returns summary results for a prediction by project and prediction ID. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ResultSummary openapi: 3.1.0 info: title: PlantPredict API version: 12.13.0 description: > ## What is PlantPredict? PlantPredict is an industry-leading performance modeling platform for utility-scale solar power plants. It predicts energy yield across the full project lifecycle — from early-stage site prospecting through detailed engineering and operational monitoring. The same engine that powers the PlantPredict web UI is fully exposed via this REST API, enabling automation of complex, high-time-resolution energy predictions without any UI interaction. ## Domain Model — read this first Understanding the object hierarchy is essential before calling the API: - **Weather** — A weather file (hourly irradiance, temperature, wind, etc.) for a geographic location. Imported from a provider (e.g. SolarAnywhere, Meteonorm) or uploaded manually. Weather files live in a company-wide library and are referenced by Predictions. - **Module** — A PV module definition parameterized with electrical characteristics (STC power, temperature coefficients, single-diode model parameters, IAM curves, etc.). Modules live in a company-wide library. - **Inverter** — An inverter definition with efficiency curves, voltage/power ratings, and optional kVA derating curves. Inverters live in a company-wide library. - **Project** — A named location (lat/lon) that acts as a container for one or more Predictions. Holds geographic metadata (country, elevation, UTC offset) and a status. - **Prediction** — The core simulation configuration nested under a Project. Defines the simulation period, model selections (transposition, air mass, degradation, soiling, shading, spectral shift models), uncertainty error terms, and references to a Weather file. A Prediction must be linked to a PowerPlant before it can be run. Status values: 0 = Draft, 1 = Active, 2 = Issued, 3 = Archived. - **PowerPlant** — The physical plant design attached to a Prediction. Describes the electrical topology: Blocks → Arrays → Inverters → DC Fields (strings of modules). Also includes transformers, transmission lines, energy storage (ESS), availability losses, and LGIA export limits. - **Shade Scene** — An optional 3D shading model (PVJ format) attached to a Prediction's DC Fields. Supports import from PVC or SHD files. Shade and TABT (Tracker Angle Back-Tracking) calculations are queued and run asynchronously. ## Typical workflow to run a prediction 1. Ensure a **Weather** file exists (search, download, or import one). 2. Ensure a **Module** and **Inverter** exist in the library. 3. **POST /Project** — create a project at the site location. 4. **POST /Project/{projectId}/Prediction** — create a prediction with model settings. 5. **POST /Project/{projectId}/Prediction/{predictionId}/PowerPlant** — attach a plant design referencing your module and inverter. 6. **POST /Project/{projectId}/Prediction/{predictionId}/Run** — queue the simulation. 7. Poll **GET /Project/{projectId}/Prediction/{predictionId}/Overview** until `status` reaches 2 (complete), then retrieve results via `/ResultSummary`, `/ResultDetails`, or `/NodalJson`. ## Authentication OAuth 2.0 **Client Credentials** flow via AWS Cognito. The spec advertises a single `bearerAuth` scheme — fetch a token yourself with the snippet below, then either paste it into the in-browser playground or pass it on every request as `Authorization: Bearer `. > **Why not advertise OAuth2 directly?** Most users have access to the > production tenant only, and we don't want to invite anyone to enter > long-lived `client_id` / `client_secret` credentials into a third-party > documentation site. Keep credentials in your own environment; ship > short-lived bearer tokens to wherever they are needed. - Token URL: `https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token` - Scopes: `transactions/get` (read), `transactions/post` (write) — request both to access the entire surface. - Send credentials as **Basic Auth** in the token request header. Example: ```bash curl -X POST 'https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token' \ -u "$PP_CLIENT_ID:$PP_CLIENT_SECRET" \ -d 'grant_type=client_credentials&scope=transactions/get transactions/post' ``` API credentials (Client ID + Secret) are generated per user by a company admin inside the PlantPredict UI (gear icon → user profile → Generate API Credentials). Store them securely — they are shown only once. ## Notes - All request/response bodies are JSON (`Content-Type: application/json`). - The API is stateless — every request must supply complete inputs; there is no session. - POST operations that create entities return `{"id": }`. - Many integer fields (model types, status codes) map to named enums — use `GET /Definitions` to retrieve the full enum catalog at runtime. - Long-running operations (Run, Shade calculations, TABT) are asynchronous; poll the corresponding `ProcessingStatus` endpoint to track progress. - Responses may include an `X-Message` header with non-blocking warnings (e.g. duplicate project name). servers: - url: https://api.plantpredict.terabase.energy description: Production security: - bearerAuth: [] tags: - name: Definitions description: Enum and model type definitions - name: Projects description: Solar project management - name: Predictions description: Energy prediction configuration and execution - name: PowerPlant description: Power plant design (blocks, arrays, inverters, transformers) - name: TimeSeries description: Custom time series data inputs - name: Results description: Prediction results — summary, details, nodal, average energy - name: FinancialModel description: Financial model parameters and cashflow results - name: Reports description: Report generation and export - name: ShadeScene description: 3D shade scene management and calculations - name: Weather description: Weather file import, download, and management - name: Inverters description: Inverter library management - name: Modules description: PV module library and single-diode parameter generation - name: ASHRAE description: ASHRAE climate station lookup - name: System description: System version and maintenance status - name: Company description: Company settings and user management - name: Country description: Reference country data paths: /Project/{projectId}/Prediction/{predictionId}/ResultSummary: get: tags: - Results summary: Get prediction result summary description: | Returns summary results for a prediction by project and prediction ID. **Parameters:** - `projectId` (path, required): The project ID. - `predictionId` (path, required): The prediction ID. operationId: getResultSummary parameters: - name: projectId in: path required: true schema: type: integer - name: predictionId in: path required: true schema: type: integer responses: '200': description: Result summary content: application/json: schema: $ref: '#/components/schemas/ResultSummary' examples: postman-result-summary: value: id: 966660 predictionName: Base Block - Small Weather runBy: Postman Tester timeOfPrediction: '2023-10-02T19:40:22.697' elapsedTimeMinutes: 0.13763712666666666 execDate: '2023-10-02T19:40:22.697' toolName: PlantPredict toolVersion: 11.12.0.26953 start: '2005-06-01T00:00:00' end: '2005-06-04T23:00:00' decompositionModel: None transpositionModel: Perez perezCoefficients: PlantPredict incModel: Physical IAM airMassModel: Bird-Hulstrom moduleTemperatureModel: Heat Balance degradationModel: None circumsolarTreatment: Diffuse directShadingModel: Module File Defined Shading diffuseShadingModel: Schaar-Panchula degradationRate: 0.005 nonLinearDegradationRates: null lightAndElevationTemperatureDegradationRates: null spectralShiftModel: 2-Param Pwat and AM useWeatherDNI: false useMeteoPOAI: false useBacksidePOAI: false soilingModel: Constant Monthly errorIrrAcc: 0.06480740698407861 spatialVariability: 0.02 interannualVariability: 0.03 irradianceMeasurementAccuracy: 0.05 monitoringPeriodRepresentativeness: 0.02 modelingAccuracy: 0.028999999999999998 errorTotal: 0.07100000000000001 yearRepeater: 1 projectName: Doc Generation projectLocality: Toledo, OH projectCountry: United States projectLat: 41.6528052 projectLon: -83.5378674 projectLatLon: 41.65/-83.54 projectElev: 178.5460357666016 timeZone: -5 weatherName: June Weather Data - Toledo weatherGHI: 18457 weatherDHI: 8245 weatherDNI: 15329 weatherPOA: null weatherLat: 41.6528053 weatherLon: -83.5378647 weatherLatLon: 41.65/-83.54 weatherDataProvider: Meteonorm inverterResultSummaries: - id: 980050 name: SMA Sunny Highpower SHP150-US-20-PEAK3 kVARating: 150 powerFactor: 1 kWRating: 150 usedDerateTimeSeries: false inverterEfficiencyModel: 2 moduleResultSummaries: - id: 1074225 name: FS-7505A-TR1 CdTe September2022 wattage: 505 cellTechnologyType: CdTe efficiency: 18.071211307926283 manufacturer: First Solar faciality: Monofacial bifacialityFactor: 0 transmissionFactor: 0 exclEnvironmentIrrDesc: null exclEnvironmentIrrVal: null blockResultSummaries: - id: 1207025 name: 1 acSize: 1.5 dcSize: 1.95 numArrays: 10 dcacRatio: 1.3 trackingType: Horizontal Tracker backTrackingType: Backtracking avgTiltAngle: 0 avgRotationalMax: 60 avgRotationalMin: -60 avgRotationalLimits: '-60.00 / 60.00' avgAzimuth: 180 avgRowSpacing: 5.749999999999999 avgGCR: 40 energizationDate: '2005-06-01T00:00:00' resultDetails: [] years: - id: 2725859 year: 2005 yearIndex: 1 totalEnergy: 54490.73631180844 transpositionOnPlane: -33.39906193172364 farShadingLoss: 0 nearShadingLoss: 3.415010544667114 elecShadingLoss: 0 soilingLoss: 2.124869768017325 iamFactorLoss: 1.6377524309067946 spectralLoss: -1.0148008378121767 moduleIrradianceLoss: 0.6468938283773886 moduleTemperatureLoss: 4.892633443721294 moduleQualityLoss: 0 lidLoss: 0 moduleMismatchLoss: 0.4742915334455463 moduleBackMismatchLoss: 0 biFacialityLoss: 0 structureShadingLoss: 0 backSideIrradiance: 0 dcWiringLoss: 0.9757620328698026 dcHealthLoss: 0.9485830668910926 inverterEfficiencyLoss: 1.3265712574422033 inverterLimitationLoss: 3.2677104358153457 degradationLoss: 0 leTIDLoss: 0 inverterCoolingLoss: 0 trackerMotorLoss: 0.09591772994869588 dataAcquisitionAuxLoss: 1.3598168239123245 mvTransformersLoss: 1.067128156576251 acCollectionLinesLoss: 0.988957626904007 backsideEffPOA: 0 summaryFactors: - id: 2863022 blockName: 1 pValue: 50 pValueString: P50 ghiSum: 26.4092 poAInsolation: 35.229625063672756 specificYieldDC: 28.153536166240844 specificYieldAC: 36.599597016113094 performanceRatio: 79.91437920601527 acCapacityFactor: 38.1245802251178 arrayNetEnergy: 0.005489939552416965 blockNetEnergy: 0.05489939552416965 totalBoSLoss: 1.9834127447536236 nighttimeLosses: 0.4086592123612225 todFactor: -1 acSize: 1.5 dcSize: 1.95 numArrays: 10 dcacRatio: 1.3 gridVoltage: 34.5 trackingType: Horizontal Tracker backTrackingType: Backtracking avgTiltAngle: 0 avgTiltAngleString: '-' avgAzimuth: 180 avgRowSpacing: 5.749999999999999 avgGCR: 40 avgRotationalMin: -60 avgRotationalMax: 60 avgPostHeight: 1.5 avgRotationalLimits: '-60.00 / 60.00' avgDCArraySize: 0.195 avgACArraySize: 0.15 powerFactor: 1 lgiaLimitation: 'Off' availabilityLoss: 0 years: - id: 2358476 year: 2005 yearIndex: 1 totalEnergy: 54490.73631180844 monthlyFactors: - id: 38298098 month: 1 monthName: Jan soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298099 month: 2 monthName: Feb soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298100 month: 3 monthName: Mar soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298101 month: 4 monthName: Apr soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298102 month: 5 monthName: May soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298103 month: 6 monthName: Jun soilingLoss: 2.2 albedo: 0.3 spectralShift: -1.0148008378121767 - id: 38298104 month: 7 monthName: Jul soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298105 month: 8 monthName: Aug soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298106 month: 9 monthName: Sep soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298107 month: 10 monthName: Oct soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298108 month: 11 monthName: Nov soilingLoss: 0 albedo: 0.3 spectralShift: 0 - id: 38298109 month: 12 monthName: Dec soilingLoss: 0 albedo: 0.3 spectralShift: 0 summaryFactors: - id: 2459692 pValue: 50 pValueString: P50 ghiSum: 26.4092 poAInsolation: 35.229625063672756 specificYieldDC: 28.153536166240844 specificYieldAC: 36.599597016113094 performanceRatio: 79.91437920601527 acCapacityFactor: 38.1245802251178 max3hrShortCircuitCurrent: 3.0436804868598837 arrayNetEnergy: 0.005489939552416965 plantNetEnergy: 0.05489939552416965 totalBoSLoss: 1.9834127447536236 nighttimeLosses: 0.4086592123612225 todFactor: -1 hasESSSystem: false esspvEnergy: 0 essBatteryEnergy: 0 essAuxLoss: 0 transpositionOnPlane: -33.39906193172364 farShadingLoss: 0 nearShadingLoss: 3.415010544667114 elecShadingLoss: 0 soilingLoss: 2.124869768017325 iamFactorLoss: 1.6377524309067946 spectralLoss: -1.0148008378121767 moduleIrradianceLoss: 0.6468938283773886 moduleTemperatureLoss: 4.892633443721294 moduleQualityLoss: 0 lidLoss: 0 moduleMismatchLoss: 0.4742915334455463 moduleBackMismatchLoss: 0 biFacialityLoss: 0 structureShadingLoss: 0 backsideIrradiance: 0 dcWiringLoss: 0.9757620328698026 dcHealthLoss: 0.9485830668910926 inverterEfficiencyLoss: 1.3265712574422033 inverterLimitationLoss: 3.2677104358153457 degradationLoss: 0 leTIDLoss: 0 inverterCoolingLoss: 0 trackerMotorLoss: 0.09591772994869588 dataAcquisitionAuxLoss: 1.3598168239123245 mvTransformersLoss: 1.067128156576251 acCollectionLinesLoss: 0.988957626904007 transformerTransmissionLineLoss: [] availabilityLoss: 0 lgiaLimitationLoss: 0 monthlySums: id: 2053402 energySums: - id: 49281610 month: 1 sum: 0 - id: 49281611 month: 2 sum: 0 - id: 49281612 month: 3 sum: 0 - id: 49281613 month: 4 sum: 0 - id: 49281614 month: 5 sum: 0 - id: 49281615 month: 6 sum: 54.89939552416966 - id: 49281616 month: 7 sum: 0 - id: 49281617 month: 8 sum: 0 - id: 49281618 month: 9 sum: 0 - id: 49281619 month: 10 sum: 0 - id: 49281620 month: 11 sum: 0 - id: 49281621 month: 12 sum: 0 ghiSums: - id: 49281622 month: 1 sum: 0 - id: 49281623 month: 2 sum: 0 - id: 49281624 month: 3 sum: 0 - id: 49281625 month: 4 sum: 0 - id: 49281626 month: 5 sum: 0 - id: 49281627 month: 6 sum: 26409.2 - id: 49281628 month: 7 sum: 0 - id: 49281629 month: 8 sum: 0 - id: 49281630 month: 9 sum: 0 - id: 49281631 month: 10 sum: 0 - id: 49281632 month: 11 sum: 0 - id: 49281633 month: 12 sum: 0 hasESSSystem: false essInverterEfficiencyLoss: 0 essmvTransformersLoss: 0 esshvacLoss: 0 essdcRoundtripEfficiencyLoss: 0 esspvEnergy: 0 essBatteryEnergy: 0 backsideEffPOA: 0 reportESSDCRoundtripEfficiencyLoss: ' - ' reportESSHVACLoss: ' - ' reportESSInverterEfficiencyLoss: ' - ' reportESSMVTransformersLoss: ' - ' logicVersion: Version 11 predictionHasESS: false essPowerCapacity: 0 essEnergyCapacity: 0 hasBifacial: false useLeapYears: false useLeTID: false isDraft: false predictionYearSummary: null reportESSPowerCapacity: ' - ' reportESSEnergyCapacity: ' - ' reportTitle: null predictionStatus: null reportShowMonthlySums: false leTIDRates: null '204': description: >- The prediction has not been run yet and no result summary exists. Response body is empty. '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: schemas: ResultSummary: type: object properties: id: type: integer predictionName: type: string runBy: type: string timeOfPrediction: type: string description: >- 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. elapsedTimeMinutes: type: number execDate: type: string description: >- 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. toolName: type: string toolVersion: type: string start: type: string description: >- 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: type: string description: >- 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. decompositionModel: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - Erbs - Reindl - DIRINT - None description: DiffuseDirectDecompModelType transpositionModel: type: integer enum: - 0 - 1 x-enum-varnames: - Hay - Perez description: TranspositionModelType perezCoefficients: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 x-enum-varnames: - PlantPredict - AllSitesComposite1990 - AllSitesComposite1988 - SandiaComposite1988 - USAComposite1988 - France1988 - Pheonix1988 - Elmonte1988 - Osage1988 - Albuquerque1988 - CapeCanaveral1988 - Albany1988 description: PerezCoefficientsEnum incModel: type: integer enum: - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - Sandia - ASHRAE - None - TabularIAM - PhysicalIAM description: IncidenceAngleModelType airMassModel: type: integer enum: - 0 - 1 x-enum-varnames: - BirdHulstrom - KastenSandia description: AirMassModelType moduleTemperatureModel: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - HeatBalance - Sandia - NOCT - DCFieldDefined description: ModuleTemperatureModelType degradationModel: type: integer enum: - 0 - 1 - 2 - 3 - 4 x-enum-varnames: - None - SteppedAC - LinearAC - LinearDC - NonLinearDC description: DegradationModel circumsolarTreatment: type: integer enum: - 0 - 1 x-enum-varnames: - Diffuse - Direct description: CircumsolarTreatmentType directShadingModel: type: integer enum: - 0 - 1 - 2 - 3 - 5 - 6 x-enum-varnames: - Linear - None - V2DimensionRetired - FractionalElectricalShading - ModuleFileDefinedShading - StepFractionalElectricalShading description: DirectBeamShadingModel diffuseShadingModel: type: integer enum: - 0 - 1 x-enum-varnames: - None - SchaarPanchula description: DiffuseShadingModel responses: Unauthorized: description: >- Missing or invalid bearer token. The response body is empty and no `Content-Type` header is set; the 401 status code is the only signal. Fetch a fresh token (see the **Authentication** section of the API description) and retry. NotFound: description: >- The referenced resource does not exist or is not accessible to the caller. content: text/plain: schema: type: string example: Project not found. ServerError: description: | Unexpected server-side error. The body is usually a plain-text message but its structure is not guaranteed — treat it as opaque diagnostic text. Common causes: database constraint violation, downstream service timeout, internal exception. Retry-safe for idempotent requests; for non-idempotent ones, verify state before retrying. content: text/plain: schema: type: string example: An error has occurred. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Pass `Authorization: Bearer ` on every request. See the **Authentication** section of the API description for how to fetch a token. ````