> ## 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. # Parse a PAN file and return module data > This endpoint will convern a .PAN file and its contents into a JSON structure which is compatible with PlantPredict. The response can be used as the body in a POST request to create a new module. ## OpenAPI ````yaml /api-docs/api-reference/plantpredict-api.yaml post /Module/ImportPANFile 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: /Module/ImportPANFile: post: tags: - Modules summary: Parse a PAN file and return module data description: >- This endpoint will convern a .PAN file and its contents into a JSON structure which is compatible with PlantPredict. The response can be used as the body in a POST request to create a new module. operationId: importPANFile requestBody: required: true content: multipart/form-data: schema: type: object properties: file: type: string format: binary responses: '200': description: Parsed module data content: application/json: schema: $ref: '#/components/schemas/Module' examples: postman-pan-file-convert: value: name: First Solar FS-6455A-P Jan2022 cellTechnologyType: 6 cellDesignType: 0 pvModel: 0 numberOfCellsInSeries: 264 referenceTemperature: 25 referenceIrradiance: 1000 numIVPoints: 100 currentNegation: false stcShortCircuitCurrent: 2.64 stcmppCurrent: 2.4404701579949415 stcOpenCircuitVoltage: 225.2100000003078 stcmppVoltage: 186.47387999999947 stcMaxPower: 455 relativeEfficiency: 0 targetEfficiency: 0 stcPowerTempCoef: -0.30465598891628975 stcShortCircuitCurrentTempCoef: 0.06098484848484849 stcOpenCircuitVoltageTempCoef: -0.2760090582123352 saturationCurrentAtSTC: 5.5255324312167533e-11 diodeIdealityFactorAtSTC: 1.3560137077739796 lightGeneratedCurrent: 2.6548008322394048 seriesResistanceAtSTC: 4.124 recombinationParameter: 1.078 shuntResistanceAtSTC: 5000 exponentialDependencyOnShuntResistance: 3 darkShuntResistance: 15289 maximumSeriesResistance: 5.268999999999999 maximumRecombinationParameter: 3.4320000000000004 linearTempDependenceOnGamma: 0.002208077500000174 moduleShadingResponse: 1 electricalShadingFractionalEffect: 100 bandgapVoltage: 1.5 builtInVoltage: 0.9 effectiveIrradianceResponse: null status: 0 model: FS-6455A-P Jan2022 manufacturer: First Solar length: 2024 width: 1245 weight: 34.9 defaultOrientation: 1 numberOfCellsInParallel: 1 stcEfficiency: 18.060271928663266 minTolerance: 0 maxTolerance: 5 constructionType: 2 faciality: 0 bifacialityFactor: null transmissionFactor: 0 backSideMismatch: 3 dataSource: 1 lightInducedDegradation: 0 moduleQuality: 0 moduleMismatchCoefficient: 0.5 heatBalanceConvectiveCoef: 0 heatBalanceConductiveCoef: 29 sandiaConductiveCoef: -3.56 sandiaConvectiveCoef: -0.075 cellToModuleTempDiff: 3 shortCircuitCurrentAtSTC: 2.64 linearTempDependenceOnIsc: 0.06098484848484849 heatAbsorptionCoefAlphaT: 0.9 aGamma: null bGamma: null cGamma: null dGamma: null spectralResponse: 1 useDefaultSandiaIAM: true useDefaultTabularIAM: false sandiaSpectralA0: 0 sandiaSpectralA1: 0 sandiaSpectralA2: 0 sandiaSpectralA3: 0 sandiaSpectralA4: 0 sandiaIAMB0: 6.038242275137197 sandiaIAMB1: -0.5248112239136882 sandiaIAMB2: 0.02130703918426116 sandiaIAMB3: -0.00042240723312322523 sandiaIAMB4: 0.000004091960268471147 sandiaIAMB5: -1.5564126828688897e-8 ashraeiamB0: 0.05 spectral2B0: 0.86273 spectral2B1: -0.038948 spectral2B2: -0.012506 spectral2B3: 0.098871 spectral2B4: 0.084658 spectral2B5: -0.0042948 iamFactors: - id: 0 incidenceAngle: 0 factor: 1 - id: 0 incidenceAngle: 30 factor: 1 - id: 0 incidenceAngle: 50 factor: 0.99 - id: 0 incidenceAngle: 60 factor: 0.98 - id: 0 incidenceAngle: 65 factor: 0.96 - id: 0 incidenceAngle: 70 factor: 0.92 - id: 0 incidenceAngle: 75 factor: 0.85 - id: 0 incidenceAngle: 80 factor: 0.72 - id: 0 incidenceAngle: 90 factor: 0 degradationModel: 1 linearDegradationRate: 0.5 nonLinearDegradationRates: null sandiaAFactors: null sandiaBFactors: null '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '500': $ref: '#/components/responses/ServerError' components: schemas: Module: type: object required: - name - manufacturer - model - stcMaxPower 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 length: type: number description: mm width: type: number description: mm weight: type: number description: kg defaultOrientation: type: integer enum: - 0 - 1 x-enum-varnames: - Landscape - Portrait description: ModuleOrientation numberOfCellsInSeries: type: integer numberOfCellsInParallel: type: integer stcShortCircuitCurrent: type: number stcOpenCircuitVoltage: type: number stcmppCurrent: type: number stcmppVoltage: type: number stcMaxPower: type: number description: Wp stcPowerTempCoef: type: number stcShortCircuitCurrentTempCoef: type: number stcOpenCircuitVoltageTempCoef: type: number stcEfficiency: type: number minTolerance: type: number maxTolerance: type: number cellTechnologyType: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 x-enum-varnames: - NTypeMonoCSi - PTypeMonoCSiPERC - PTypeMonoCSiBSF - PolyCSiPERC - PolyCSiBSF - CdTe - CIGS - Mixed description: CellTechnologyTypeEnum cellDesignType: type: integer enum: - 0 - 1 - 2 - 3 x-enum-varnames: - FullCellTechnology - HalfCellTechnology - NA - NoneSpecified description: CellDesignType constructionType: type: integer enum: - 1 - 2 x-enum-varnames: - GlassGlass - GlassBacksheet description: ConstructionTypeEnum faciality: type: integer enum: - 0 - 1 x-enum-varnames: - Monofacial - Bifacial description: FacialityEnum bifacialityFactor: type: - number - 'null' transmissionFactor: type: - number - 'null' backSideMismatch: type: - number - 'null' dataSource: type: integer enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 x-enum-varnames: - Manufacturer - PVsyst - UniversityOfGeneva - Photon - SandiaDatabase - Custom - PlantPredict description: DataSourceType lightInducedDegradation: type: number moduleQuality: type: number moduleMismatchCoefficient: type: number heatBalanceConvectiveCoef: type: number heatBalanceConductiveCoef: type: number sandiaConductiveCoef: type: number sandiaConvectiveCoef: type: number cellToModuleTempDiff: type: number pvModel: type: integer enum: - 0 - 1 - 3 x-enum-varnames: - V1DiodeRecombination - V1Diode - V1DiodeRecombinationNonLinearTemp description: PvModelType referenceIrradiance: type: number referenceTemperature: type: number degradationModel: type: integer enum: - 0 - 1 - 2 x-enum-varnames: - Unspecified - Linear - NonLinear description: ModuleDegradationModel linearDegradationRate: type: number effectiveIrradianceResponse: type: - array - 'null' items: type: object iamFactors: type: - array - 'null' items: type: object nonLinearDegradationRates: type: array items: type: object ModelStateError: type: object description: | ASP.NET Web API validation error. `modelState` maps the offending field name (or `request`) to a list of human-readable messages. properties: message: type: string modelState: type: object additionalProperties: type: array items: type: string required: - message responses: BadRequest: description: | The request was rejected. PlantPredict returns one of two shapes: * `application/json` with `{message, modelState}` for input validation errors (ASP.NET Web API model-state). The `modelState` map keys field names to lists of human-readable error messages. * `text/plain` with a free-form message for runtime / database errors that bubble up before validation completes. Clients should branch on the `Content-Type` header. content: application/json: schema: $ref: '#/components/schemas/ModelStateError' example: message: The request is invalid. modelState: latitude: - The field Latitude must be between -90 and 90. text/plain: schema: type: string example: A successfully completed prediction cannot be cancelled. 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. 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. ````