> ## 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 an inverter by ID > Creates a .PPI file, which can be used to import the Inverter into PlantPredict for another user. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml get /Inverter/{inverterId} 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: /Inverter/{inverterId}: get: tags: - Inverters summary: Get an inverter by ID description: >- Creates a .PPI file, which can be used to import the Inverter into PlantPredict for another user. operationId: getInverter parameters: - name: inverterId in: path required: true schema: type: integer responses: '200': description: Inverter content: application/json: schema: $ref: '#/components/schemas/Inverter' examples: postman-inverter: value: status: 2 model: Sunny Highpower SHP150-US-20-PEAK3 manufacturer: SMA powerRated: 150 apparentPower: 150 minDCPowerThreshold: 100 minVoltage: 855 maxMPPVoltage: 1450 maxAbsoluteVoltage: 1500 maxCurrent: 180 maxElevation: 100 outputVoltage: 600 usekVACurves: true usePQCurves: false dataSource: 2 efficiencyCurves: - id: 29409 voltage: 880 efficiencyPoints: - id: 208781 power: 14.8065 efficiency: 98.71 - id: 208782 power: 29.715 efficiency: 99.05 - id: 208783 power: 44.541 efficiency: 98.98 - id: 208784 power: 74.22 efficiency: 98.96 - id: 208785 power: 111.2713 efficiency: 98.82 - id: 208786 power: 147.87 efficiency: 98.58 - id: 29410 voltage: 960 efficiencyPoints: - id: 208787 power: 14.808 efficiency: 98.72 - id: 208788 power: 29.709 efficiency: 99.03 - id: 208789 power: 44.559 efficiency: 99.02 - id: 208790 power: 74.22 efficiency: 98.96 - id: 208791 power: 111.2038 efficiency: 98.76 - id: 208792 power: 147.78 efficiency: 98.52 - id: 29411 voltage: 1200 efficiencyPoints: - id: 208793 power: 14.712 efficiency: 98.08 - id: 208794 power: 29.589 efficiency: 98.63 - id: 208795 power: 44.415 efficiency: 98.7 - id: 208796 power: 74.0325 efficiency: 98.71 - id: 208797 power: 110.9898 efficiency: 98.57 - id: 208798 power: 147.48 efficiency: 98.32 kVACurves: - id: 10338 elevation: 100 kVAPoints: - id: 54563 temperature: -25 kVA: 150 - id: 54564 temperature: 50 kVA: 150 - id: 54565 temperature: 50 kVA: 150 - id: 54566 temperature: 60 kVA: 127 - id: 54567 temperature: 62 kVA: 0 pqCurves: [] inverterType: 1 id: 10373 name: SMA Sunny Highpower SHP150-US-20-PEAK3 description: null companyId: 1042 company: null ownerId: 8903 createdDate: '2026-02-03T12:39:07.753' lastModified: '2026-02-03T12:39:07.753' lastModifiedById: 8903 text/plain: examples: postman-get-export: value: |- { "status": 2, "model": "Sunny Highpower SHP150-US-20-PEAK3", "manufacturer": "SMA", "powerRated": 150, "apparentPower": 150, "minDCPowerThreshold": 100, "minVoltage": 855, "maxMPPVoltage": 1450, "maxAbsoluteVoltage": 1500, "maxCurrent": 180, "maxElevation": 100, "outputVoltage": 600, "usekVACurves": true, "usePQCurves": false, "dataSource": 2, "efficiencyCurves": [ { "id": 29409, "voltage": 880, "efficiencyPoints": [ { "id": 208781, "power": 14.8065, "efficiency": 98.71 }, { "id": 208782, "power": 29.715, "efficiency": 99.05 }, { "id": 208783, "power": 44.541, "efficiency": 98.98 }, { "id": 208784, "power": 74.22, "efficiency": 98.96 }, { "id": 208785, "power": 111.2713, "efficiency": 98.82 }, { "id": 208786, "power": 147.87, "efficiency": 98.58 } ] }, { "id": 29410, "voltage": 960, "efficiencyPoints": [ { "id": 208787, "power": 14.808, "efficiency": 98.72 }, { "id": 208788, "power": 29.709, "efficiency": 99.03 }, { "id": 208789, "power": 44.559, "efficiency": 99.02 }, { "id": 208790, "power": 74.22, "efficiency": 98.96 }, { "id": 208791, "power": 111.2038, "efficiency": 98.76 }, { "id": 208792, "power": 147.78, "efficiency": 98.52 } ] }, { "id": 29411, "voltage": 1200, "efficiencyPoints": [ { "id": 208793, "power": 14.712, "efficiency": 98.08 }, { "id": 208794, "power": 29.589, "efficiency": 98.63 }, { "id": 208795, "power": 44.415, "efficiency": 98.7 }, { "id": 208796, "power": 74.0325, "efficiency": 98.71 }, { "id": 208797, "power": 110.9898, "efficiency": 98.57 }, { "id": 208798, "power": 147.48, "efficiency": 98.32 } ] } ], "kVACurves": [ { "id": 10338, "elevation": 100, "kVAPoints": [ { "id": 54563, "temperature": -25, "kVA": 150 }, { "id": 54564, "temperature": 50, "kVA": 150 }, { "id": 54565, "temperature": 50, "kVA": 150 }, { "id": 54566, "temperature": 60, "kVA": 127 }, { "id": 54567, "temperature": 62, "kVA": 0 } ] } ], "pqCurves": [], "inverterType": 1, "id": 10373, "name": "SMA Sunny Highpower SHP150-US-20-PEAK3", "description": "Sample test note", "companyId": 1042, "company": null, "ownerId": 8903 "createdDate": "2026-02-03T12:39:07.753", "lastModified": "2026-02-03T12:50:48.95", "lastModifiedById": 8903 } '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/ServerError' components: schemas: Inverter: type: object required: - name - manufacturer - model - powerRated properties: id: type: integer readOnly: true name: type: string description: type: - string - 'null' status: type: integer enum: - 0 - 1 - 2 - 3 - 4 - 5 - 6 x-enum-varnames: - Unknown - DraftPrivate - DraftShared - Active - Retired - Global - GlobalRetired description: LibraryStatusEnum model: type: string manufacturer: type: string powerRated: type: number description: kW apparentPower: type: number minDCPowerThreshold: type: number minVoltage: type: number maxMPPVoltage: type: number maxAbsoluteVoltage: type: number maxCurrent: type: number maxElevation: type: number outputVoltage: type: number usekVACurves: type: boolean usePQCurves: type: boolean dataSource: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 x-enum-varnames: - Manufacturer - PVsyst - UniversityOfGeneva - Photon - SandiaDatabase - Custom - PlantPredict description: DataSourceType inverterType: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - Unspecified - String - Central description: InverterType efficiencyCurves: type: - array - 'null' items: type: object kVACurves: type: - array - 'null' items: type: object pqCurves: type: - array - 'null' items: type: object companyId: type: integer readOnly: true ownerId: type: integer readOnly: true createdDate: type: string readOnly: true 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. lastModified: type: string readOnly: true 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. 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. ````