{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"PlantPredict","colors":{"primary":"#086EC1","light":"#086EC1","dark":"#086EC1"},"logo":{"light":"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_Full_Color.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=d951c2fe4058ac3998997d5ed958bfe9","dark":"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_White.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=00d16ee188089d2e0fd9f9985ac4b900","href":"https://plantpredict.com/"},"favicon":"https://mintcdn.com/terabaseenergy/eQgx_CYJ74LVr_OK/favicon.ico?fit=max\u0026auto=format\u0026n=eQgx_CYJ74LVr_OK\u0026q=85\u0026s=187e381231017c22c54a0ce44fc17094","appearance":{"default":"system"},"navbar":{"links":[{"href":"mailto:support@plantpredict.com","label":"Support"}]},"footer":{"socials":{"github":"https://github.com/plantpredict","linkedin":"https://www.linkedin.com/showcase/plantpredict"}},"seo":{"metatags":{"canonical":"https://docs.plantpredict.com"}},"styling":{"latex":true},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"terabaseenergy","hasAudioNarration":false,"actualSubdomain":"terabaseenergy","customDomains":["docs.plantpredict.com"],"gitSource":{"type":"github","owner":"plantpredict","repo":"plantpredict-product-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af63734d89d0834a9bd7ca8","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"Release Notes","count":420},{"language":"default","tag":"PlantPredict","count":248},{"language":"default","tag":"API \u0026 SDK","count":122},{"language":"default","tag":"API Reference","count":115},{"language":"default","tag":"Models \u0026 Algorithms","count":66},{"language":"default","tag":"User Guide","count":62},{"language":"default","tag":"Version 11","count":40},{"language":"default","tag":"User Interface","count":37},{"language":"default","tag":"1. Irradiance Calculation","count":36},{"language":"default","tag":"Version 12","count":36}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@plantpredict.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"starterQuestions":[{"_id":"6a7f91873c58081693a6b2bf","deploymentId":"68def69020f53d6d18a22d89","questionText":"What is nodal data?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:07:03.879Z","updatedAt":"2026-08-14T22:07:03.879Z","__v":0},{"_id":"6a7f91823c58081693a6b25b","deploymentId":"68def69020f53d6d18a22d89","questionText":"How do I create a 3D shade scene?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:06:58.200Z","updatedAt":"2026-08-14T22:06:58.200Z","__v":0},{"_id":"6a7f917b3c58081693a6b1f9","deploymentId":"68def69020f53d6d18a22d89","questionText":"How can I run a sub-hourly prediction?","status":"active","generatedBy":"manual","createdAt":"2026-08-14T22:06:51.302Z","updatedAt":"2026-08-14T22:06:51.302Z","__v":0}],"googleFontsInlined":false},"customCss":[{"filePath":"styles/custom.css","content":".katex-display{overflow-y:hidden!important}.katex-display>.katex{overflow-y:hidden!important}.katex-display::-webkit-scrollbar{display:none!important;width:0!important;height:0!important}.katex-display{-ms-overflow-style:none!important;scrollbar-width:none!important}"},{"filePath":"style.css","content":".card{border:2px solid #1b3359!important;box-shadow:0 4px 12px rgba(27, 51, 89, 0.15)!important;transition:box-shadow 0.2s ease, transform 0.2s ease!important}.card:hover{box-shadow:0 8px 24px rgba(27, 51, 89, 0.25)!important;transform:translateY(-2px)!important}@media (min-width: 1024px){#sidebar{display:flex!important}}.pricing-desc{color:oklch(37.3% .034 259.733)}.dark .pricing-desc{color:oklch(87.2% .01 258.338)!important}.pricing-page-marker{display:none}#content:has(>.pricing-page-marker){max-width:none!important}#content-area:has(.pricing-page-marker){max-width:calc(36rem + 300px)!important}@media (min-width: 1536px){#content-area:has(.pricing-page-marker){max-width:calc(42rem + 150px)!important}}.landing-desc{color:oklch(37.3% .034 259.733);opacity:0.8}.dark .landing-desc{color:oklch(87.2% .01 258.338)!important}"}],"page":{"pagePath":"api-reference/modules/get-a-module-by-id","slug":"/api-reference/modules/get-a-module-by-id","pageMetadata":{"title":"Get a module by ID","description":"Gets the specific module from the provided Id.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}","href":"/api-reference/modules/get-a-module-by-id","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Gets the specific module from the provided Id.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get a module by ID","description":"Gets the specific module from the provided Id.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}","href":"/api-reference/modules/get-a-module-by-id","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Modules"],"summary":"Get a module by ID","description":"Gets the specific module from the provided Id.","operationId":"getModule","x-doc-source":"postman","parameters":["23fad2b4-eae2-434f-aa17-7816d9c42dc3"],"responses":{"200":"3921ea49-b0c0-4ea8-bfea-b308c200678d","401":"5d2d515b-96aa-4675-b50b-20c5ce53e355","404":"9fc04bb9-ee1b-4abf-a200-45de19509e35","500":"f1860145-cbba-458b-8318-bcb7837a2e6e"},"method":"get","type":"path","servers":["0326022f-84c8-4719-a04b-ce3dd0760239"],"security":["9994906a-351a-473d-bbaa-0f0494dd42d1"],"path":"/Module/{moduleId}","baseUrlOptions":["https://api.plantpredict.terabase.energy"],"title":"Get a module by ID","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"23fad2b4-eae2-434f-aa17-7816d9c42dc3":{"name":"moduleId","in":"path","required":true,"schema":{"type":"integer","isRequired":true,"uniqueKey":"","typeLabel":"integer"}}},"responses":{"3921ea49-b0c0-4ea8-bfea-b308c200678d":{"description":"Module entity","content":{"application/json":{"schema":{"type":"object","required":["name","manufacturer","model","stcMaxPower"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"model":{"type":"string","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"manufacturer":{"type":"string","isRequired":true,"uniqueKey":"manufacturer","typeLabel":"string"},"stcMaxPower":{"type":"number","description":"Wp","isRequired":true,"uniqueKey":"stcMaxPower","typeLabel":"number"},"id":{"type":"integer","readOnly":true,"uniqueKey":"id","typeLabel":"integer"},"description":{"oneOf":[{"type":"string","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"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","uniqueKey":"status","typeLabel":"enum\u003cinteger>"},"length":{"type":"number","description":"mm","uniqueKey":"length","typeLabel":"number"},"width":{"type":"number","description":"mm","uniqueKey":"width","typeLabel":"number"},"weight":{"type":"number","description":"kg","uniqueKey":"weight","typeLabel":"number"},"defaultOrientation":{"type":"integer","enum":[0,1],"x-enum-varnames":["Landscape","Portrait"],"description":"ModuleOrientation","uniqueKey":"defaultOrientation","typeLabel":"enum\u003cinteger>"},"numberOfCellsInSeries":{"type":"integer","uniqueKey":"numberOfCellsInSeries","typeLabel":"integer"},"numberOfCellsInParallel":{"type":"integer","uniqueKey":"numberOfCellsInParallel","typeLabel":"integer"},"stcShortCircuitCurrent":{"type":"number","uniqueKey":"stcShortCircuitCurrent","typeLabel":"number"},"stcOpenCircuitVoltage":{"type":"number","uniqueKey":"stcOpenCircuitVoltage","typeLabel":"number"},"stcmppCurrent":{"type":"number","uniqueKey":"stcmppCurrent","typeLabel":"number"},"stcmppVoltage":{"type":"number","uniqueKey":"stcmppVoltage","typeLabel":"number"},"stcPowerTempCoef":{"type":"number","uniqueKey":"stcPowerTempCoef","typeLabel":"number"},"stcShortCircuitCurrentTempCoef":{"type":"number","uniqueKey":"stcShortCircuitCurrentTempCoef","typeLabel":"number"},"stcOpenCircuitVoltageTempCoef":{"type":"number","uniqueKey":"stcOpenCircuitVoltageTempCoef","typeLabel":"number"},"stcEfficiency":{"type":"number","uniqueKey":"stcEfficiency","typeLabel":"number"},"minTolerance":{"type":"number","uniqueKey":"minTolerance","typeLabel":"number"},"maxTolerance":{"type":"number","uniqueKey":"maxTolerance","typeLabel":"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","uniqueKey":"cellTechnologyType","typeLabel":"enum\u003cinteger>"},"cellDesignType":{"type":"integer","enum":[0,1,2,3],"x-enum-varnames":["FullCellTechnology","HalfCellTechnology","NA","NoneSpecified"],"description":"CellDesignType","uniqueKey":"cellDesignType","typeLabel":"enum\u003cinteger>"},"constructionType":{"type":"integer","enum":[1,2],"x-enum-varnames":["GlassGlass","GlassBacksheet"],"description":"ConstructionTypeEnum","uniqueKey":"constructionType","typeLabel":"enum\u003cinteger>"},"faciality":{"type":"integer","enum":[0,1],"x-enum-varnames":["Monofacial","Bifacial"],"description":"FacialityEnum","uniqueKey":"faciality","typeLabel":"enum\u003cinteger>"},"bifacialityFactor":{"oneOf":[{"type":"number","uniqueKey":"bifacialityFactor.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"bifacialityFactor.oneOf.1","typeLabel":"null"}],"uniqueKey":"bifacialityFactor","typeLabel":"number | null"},"transmissionFactor":{"oneOf":[{"type":"number","uniqueKey":"transmissionFactor.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"transmissionFactor.oneOf.1","typeLabel":"null"}],"uniqueKey":"transmissionFactor","typeLabel":"number | null"},"backSideMismatch":{"oneOf":[{"type":"number","uniqueKey":"backSideMismatch.oneOf.0","typeLabel":"number"},{"type":"null","uniqueKey":"backSideMismatch.oneOf.1","typeLabel":"null"}],"uniqueKey":"backSideMismatch","typeLabel":"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","uniqueKey":"dataSource","typeLabel":"enum\u003cinteger>"},"lightInducedDegradation":{"type":"number","uniqueKey":"lightInducedDegradation","typeLabel":"number"},"moduleQuality":{"type":"number","uniqueKey":"moduleQuality","typeLabel":"number"},"moduleMismatchCoefficient":{"type":"number","uniqueKey":"moduleMismatchCoefficient","typeLabel":"number"},"heatBalanceConvectiveCoef":{"type":"number","uniqueKey":"heatBalanceConvectiveCoef","typeLabel":"number"},"heatBalanceConductiveCoef":{"type":"number","uniqueKey":"heatBalanceConductiveCoef","typeLabel":"number"},"sandiaConductiveCoef":{"type":"number","uniqueKey":"sandiaConductiveCoef","typeLabel":"number"},"sandiaConvectiveCoef":{"type":"number","uniqueKey":"sandiaConvectiveCoef","typeLabel":"number"},"cellToModuleTempDiff":{"type":"number","uniqueKey":"cellToModuleTempDiff","typeLabel":"number"},"pvModel":{"type":"integer","enum":[0,1,3],"x-enum-varnames":["V1DiodeRecombination","V1Diode","V1DiodeRecombinationNonLinearTemp"],"description":"PvModelType","uniqueKey":"pvModel","typeLabel":"enum\u003cinteger>"},"referenceIrradiance":{"type":"number","uniqueKey":"referenceIrradiance","typeLabel":"number"},"referenceTemperature":{"type":"number","uniqueKey":"referenceTemperature","typeLabel":"number"},"degradationModel":{"type":"integer","enum":[0,1,2],"x-enum-varnames":["Unspecified","Linear","NonLinear"],"description":"ModuleDegradationModel","uniqueKey":"degradationModel","typeLabel":"enum\u003cinteger>"},"linearDegradationRate":{"type":"number","uniqueKey":"linearDegradationRate","typeLabel":"number"},"effectiveIrradianceResponse":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"effectiveIrradianceResponse.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"effectiveIrradianceResponse.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object"},"uniqueKey":"effectiveIrradianceResponse.oneOf.1","typeLabel":"null"}],"uniqueKey":"effectiveIrradianceResponse","typeLabel":"object[] | null"},"iamFactors":{"oneOf":[{"type":"array","items":{"type":"object","uniqueKey":"iamFactors.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"iamFactors.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object"},"uniqueKey":"iamFactors.oneOf.1","typeLabel":"null"}],"uniqueKey":"iamFactors","typeLabel":"object[] | null"},"nonLinearDegradationRates":{"type":"array","items":{"type":"object","uniqueKey":"nonLinearDegradationRates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"nonLinearDegradationRates","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","model":"\u003cstring>","manufacturer":"\u003cstring>","stcMaxPower":123,"id":123,"description":"\u003cstring>","status":0,"length":123,"width":123,"weight":123,"defaultOrientation":0,"numberOfCellsInSeries":123,"numberOfCellsInParallel":123,"stcShortCircuitCurrent":123,"stcOpenCircuitVoltage":123,"stcmppCurrent":123,"stcmppVoltage":123,"stcPowerTempCoef":123,"stcShortCircuitCurrentTempCoef":123,"stcOpenCircuitVoltageTempCoef":123,"stcEfficiency":123,"minTolerance":123,"maxTolerance":123,"cellTechnologyType":1,"cellDesignType":0,"constructionType":1,"faciality":0,"bifacialityFactor":123,"transmissionFactor":123,"backSideMismatch":123,"dataSource":1,"lightInducedDegradation":123,"moduleQuality":123,"moduleMismatchCoefficient":123,"heatBalanceConvectiveCoef":123,"heatBalanceConductiveCoef":123,"sandiaConductiveCoef":123,"sandiaConvectiveCoef":123,"cellToModuleTempDiff":123,"pvModel":0,"referenceIrradiance":123,"referenceTemperature":123,"degradationModel":0,"linearDegradationRate":123,"effectiveIrradianceResponse":[{}],"iamFactors":[{}],"nonLinearDegradationRates":[{}]}}},"exampleType":"generated"},"text/plain":{"examples":{"postman-module":{"title":"postman-module","value":"{\n \"status\": 5,\n \"model\": \"FS-7540A-TR1 September2022\",\n \"manufacturer\": \"First Solar\",\n \"length\": 2300,\n \"width\": 1215,\n \"weight\": 39.7,\n \"defaultOrientation\": 1,\n \"numberOfCellsInSeries\": 268,\n \"numberOfCellsInParallel\": 1,\n \"stcShortCircuitCurrent\": 3.064,\n \"stcOpenCircuitVoltage\": 227.717,\n \"stcmppCurrent\": 2.861,\n \"stcmppVoltage\": 188.69,\n \"stcMaxPower\": 540,\n \"stcPowerTempCoef\": -0.32,\n \"stcShortCircuitCurrentTempCoef\": 0.04,\n \"stcOpenCircuitVoltageTempCoef\": -0.28,\n \"stcEfficiency\": 19.32367149758454,\n \"minTolerance\": 0,\n \"maxTolerance\": 5,\n \"cellTechnologyType\": 6,\n \"constructionType\": 1,\n \"faciality\": 0,\n \"bifacialityFactor\": null,\n \"transmissionFactor\": null,\n \"backSideMismatch\": null,\n \"dataSource\": 1,\n \"lightInducedDegradation\": 0,\n \"moduleQuality\": 0,\n \"moduleMismatchCoefficient\": 0.5,\n \"heatBalanceConvectiveCoef\": 0,\n \"heatBalanceConductiveCoef\": 29,\n \"sandiaConductiveCoef\": -3.47,\n \"sandiaConvectiveCoef\": -0.0594,\n \"cellToModuleTempDiff\": 3,\n \"saturationCurrentAtSTC\": 2.269097e-11,\n \"seriesResistanceAtSTC\": 4.602,\n \"shuntResistanceAtSTC\": 7000,\n \"diodeIdealityFactorAtSTC\": 1.292,\n \"exponentialDependencyOnShuntResistance\": 5.5,\n \"darkShuntResistance\": 7000,\n \"linearTempDependenceOnGamma\": 0.03637770897832817,\n \"shortCircuitCurrentAtSTC\": 3.064,\n \"recombinationParameter\": 0.2000000000000001,\n \"builtInVoltage\": 0.9,\n \"bandgapVoltage\": 1.5,\n \"linearTempDependenceOnIsc\": 0.04,\n \"heatAbsorptionCoefAlphaT\": 0.9,\n \"referenceIrradiance\": 1000,\n \"referenceTemperature\": 25,\n \"aGamma\": null,\n \"bGamma\": null,\n \"cGamma\": null,\n \"dGamma\": null,\n \"spectralResponse\": 2,\n \"pvModel\": 0,\n \"useDefaultSandiaIAM\": false,\n \"useDefaultTabularIAM\": false,\n \"sandiaSpectralA0\": null,\n \"sandiaSpectralA1\": null,\n \"sandiaSpectralA2\": null,\n \"sandiaSpectralA3\": null,\n \"sandiaSpectralA4\": null,\n \"sandiaIAMB0\": 6.038242275137197,\n \"sandiaIAMB1\": -0.5248112239136882,\n \"sandiaIAMB2\": 0.02130703918426116,\n \"sandiaIAMB3\": -0.00042240723312322523,\n \"sandiaIAMB4\": 0.000004091960268471148,\n \"sandiaIAMB5\": -1.5564126828688897e-8,\n \"ashraeiamB0\": 0.05,\n \"spectral2B0\": 0.86273,\n \"spectral2B1\": -0.038948,\n \"spectral2B2\": -0.012506,\n \"spectral2B3\": 0.098871,\n \"spectral2B4\": 0.084658,\n \"spectral2B5\": -0.0042948,\n \"iamFactors\": [\n {\n \"id\": 410266,\n \"incidenceAngle\": 0,\n \"factor\": 1\n },\n {\n \"id\": 410267,\n \"incidenceAngle\": 30,\n \"factor\": 1\n },\n {\n \"id\": 410268,\n \"incidenceAngle\": 55,\n \"factor\": 0.99\n },\n {\n \"id\": 410269,\n \"incidenceAngle\": 60,\n \"factor\": 0.98\n },\n {\n \"id\": 410270,\n \"incidenceAngle\": 65,\n \"factor\": 0.96\n },\n {\n \"id\": 410271,\n \"incidenceAngle\": 70,\n \"factor\": 0.92\n },\n {\n \"id\": 410272,\n \"incidenceAngle\": 75,\n \"factor\": 0.85\n },\n {\n \"id\": 410273,\n \"incidenceAngle\": 80,\n \"factor\": 0.72\n },\n {\n \"id\": 410274,\n \"incidenceAngle\": 90,\n \"factor\": 0\n }\n ],\n \"degradationModel\": 1,\n \"linearDegradationRate\": 0.3,\n \"nonLinearDegradationRates\": [],\n \"cellDesignType\": null,\n \"useAntiReflectiveCoating\": false,\n \"refractiveIndex\": 1.526,\n \"refractiveIndexOfARC\": 1.29,\n \"glazingExtinctionCoef\": 4,\n \"glazingThickness\": 0.002,\n \"powerAtSTC\": 0,\n \"powerAtSTCExcludingWiringLosses\": 0,\n \"effectiveIrradianceResponse\": [\n {\n \"irradiance\": 100,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.8814819319715739\n },\n {\n \"irradiance\": 200,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9467641893572506\n },\n {\n \"irradiance\": 300,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9727857600367622\n },\n {\n \"irradiance\": 400,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9864198360018204\n },\n {\n \"irradiance\": 500,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.994194382349794\n },\n {\n \"irradiance\": 600,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9986027250356551\n },\n {\n \"irradiance\": 700,\n \"temperature\": 25,\n \"relativeEfficiency\": 1.0008398407389827\n },\n {\n \"irradiance\": 800,\n \"temperature\": 25,\n \"relativeEfficiency\": 1.0015713396635646\n },\n {\n \"irradiance\": 900,\n \"temperature\": 25,\n \"relativeEfficiency\": 1.001203606468212\n },\n {\n \"irradiance\": 1000,\n \"temperature\": 25,\n \"relativeEfficiency\": 1\n },\n {\n \"irradiance\": 1100,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9981406314820271\n },\n {\n \"irradiance\": 1200,\n \"temperature\": 25,\n \"relativeEfficiency\": 0.9957540528792794\n },\n {\n \"irradiance\": 100,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.8742670870403499\n },\n {\n \"irradiance\": 200,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9404278435155332\n },\n {\n \"irradiance\": 300,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9680071162319765\n },\n {\n \"irradiance\": 400,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9829378885559052\n },\n {\n \"irradiance\": 500,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9917136616820472\n },\n {\n \"irradiance\": 600,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9969019479321173\n },\n {\n \"irradiance\": 700,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9997423852901055\n },\n {\n \"irradiance\": 800,\n \"temperature\": 50,\n \"relativeEfficiency\": 1.0009460787440676\n },\n {\n \"irradiance\": 900,\n \"temperature\": 50,\n \"relativeEfficiency\": 1.000936227746243\n },\n {\n \"irradiance\": 1000,\n \"temperature\": 50,\n \"relativeEfficiency\": 1\n },\n {\n \"irradiance\": 1100,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9983320742461258\n },\n {\n \"irradiance\": 1200,\n \"temperature\": 50,\n \"relativeEfficiency\": 0.9960749126620079\n }\n ],\n \"electricalShadingFractionalEffect\": 0,\n \"moduleShadingResponse\": 1,\n \"isMetastable\": false,\n \"metastabilityProperties\": null,\n \"id\": 42176,\n \"name\": \"FS-7540A-TR1 CdTe September2022\",\n \"description\": \"S7_505_540\",\n \"companyId\": 1,\n \"company\": null,\n \"ownerId\": 742\n \"createdDate\": \"2022-09-16T18:40:26.71\",\n \"lastModified\": \"2022-09-19T11:52:55.073\",\n \"lastModifiedById\": 742\n}"}},"exampleType":"examples"}},"exampleType":"examples"},"5d2d515b-96aa-4675-b50b-20c5ce53e355":{"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.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"9fc04bb9-ee1b-4abf-a200-45de19509e35":{"description":"The referenced resource does not exist or is not accessible to the caller.","content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"Project not found.","examples":{"Example":{"title":"Example","value":"Project not found."}},"exampleType":"examples"}},"exampleType":"examples"},"f1860145-cbba-458b-8318-bcb7837a2e6e":{"description":"Unexpected server-side error. The body is usually a plain-text message\nbut its structure is not guaranteed — treat it as opaque diagnostic\ntext. Common causes: database constraint violation, downstream\nservice timeout, internal exception. Retry-safe for idempotent\nrequests; for non-idempotent ones, verify state before retrying.\n","content":{"text/plain":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"example":"An error has occurred.","examples":{"Example":{"title":"Example","value":"An error has occurred."}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"9994906a-351a-473d-bbaa-0f0494dd42d1":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","scopes":[]}}},"servers":{"0326022f-84c8-4719-a04b-ce3dd0760239":{"url":"https://api.plantpredict.terabase.energy","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Pass `Authorization: Bearer \u003ctoken>` on every request. See the **Authentication** section of the API description for how to fetch a token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-docs/api-reference/plantpredict-api.yaml"},"subdomain":"terabaseenergy","siteName":"PlantPredict","title":"Get a module by ID - PlantPredict","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-21T19:43:13.136Z","originalFileLocation":"api-reference/modules/get-a-module-by-id.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Gets the specific module from the provided Id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"PlantPredict\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a module by ID - PlantPredict\">\u003cmeta data-mint-head property=\"og:description\" content=\"Gets the specific module from the provided Id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"PlantPredict\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://terabaseenergy.mintlify.site/_mintlify/api/og/v2?division=Modules\u0026amp;title=Get+a+module+by+ID\u0026amp;description=Gets+the+specific+module+from+the+provided+Id.\u0026amp;theme=2b6fb3ebaa44c141d890c8c6\u0026amp;signature=f9df4b6fbcdd520dd900d41b9fe90c732c3a85d4d666f991756a02fd5ffbfd80\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a module by ID - PlantPredict\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Gets the specific module from the provided Id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://terabaseenergy.mintlify.site/_mintlify/api/og/v2?division=Modules\u0026amp;title=Get+a+module+by+ID\u0026amp;description=Gets+the+specific+module+from+the+provided+Id.\u0026amp;theme=2b6fb3ebaa44c141d890c8c6\u0026amp;signature=f9df4b6fbcdd520dd900d41b9fe90c732c3a85d4d666f991756a02fd5ffbfd80\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/terabaseenergy/ilK7irh8meTrRs2B/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"PlantPredict\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#086EC1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/modules/get-a-module-by-id.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.plantpredict.com/#organization\",\"name\":\"PlantPredict\",\"url\":\"https://docs.plantpredict.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/terabaseenergy/iiAvm3u0yaPPvDgU/logo/Terabase_PlantPredict_Primary_Logo_Full_Color.svg?fit=max\u0026auto=format\u0026n=iiAvm3u0yaPPvDgU\u0026q=85\u0026s=d951c2fe4058ac3998997d5ed958bfe9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.plantpredict.com#website\",\"name\":\"PlantPredict\",\"url\":\"https://docs.plantpredict.com\",\"publisher\":{\"@id\":\"https://docs.plantpredict.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id#webpage\",\"url\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id\",\"name\":\"Get a module by ID\",\"description\":\"Gets the specific module from the provided Id.\",\"dateModified\":\"2026-08-21T19:43:13.136Z\",\"isPartOf\":{\"@id\":\"https://docs.plantpredict.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.plantpredict.com/api-reference/definitions/get-all-definitions-or-filter-by-enum-type\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Modules\",\"item\":\"https://docs.plantpredict.com/api-reference/modules/list-all-accessible-modules\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a module by ID\",\"item\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id#apireference\",\"headline\":\"Get a module by ID\",\"name\":\"Get a module by ID\",\"description\":\"Gets the specific module from the provided Id.\",\"url\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id\",\"mainEntityOfPage\":{\"@id\":\"https://docs.plantpredict.com/api-reference/modules/get-a-module-by-id#webpage\"},\"dateModified\":\"2026-08-21T19:43:13.136Z\",\"publisher\":{\"@id\":\"https://docs.plantpredict.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.plantpredict.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"PlantPredict\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"PlantPredict\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/modules/get-a-module-by-id.md","siteName":"PlantPredict","nav":{"global":null,"tabs":[{"tab":"Home","icon":"house"},{"tab":"PlantPredict","icon":"sun","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/intro/introduction"}]},{"item":"Models \u0026 Algorithms","pages":[{"title":"Models \u0026 Algorithms","href":"/models/general/intro"}]},{"item":"API \u0026 SDK","groups":[{"group":"Introduction","icon":"book-open","pages":[{"title":" ","sidebarTitle":"Introduction","href":"/api-docs/intro"}]},{"group":"Quick Start Guides","icon":"gauge","pages":[{"title":"PlantPredict Performance API - Quick Start Guide","sidebarTitle":"Performance API","href":"/api-docs/api_quick_start_guide"},{"title":"PlantPredict Python SDK - Quick Start Guide","sidebarTitle":"Python SDK","href":"/api-docs/sdk_quick_start_guide"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Definitions","pages":[{"title":"Get all definitions or filter by enum type","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Definitions","href":"/api-reference/definitions/get-all-definitions-or-filter-by-enum-type"}]},{"group":"Projects","pages":[{"title":"List projects (paginated)","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project","href":"/api-reference/projects/list-projects-paginated"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project","href":"/api-reference/projects/create-a-project"},{"title":"Get current user's projects","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/My","href":"/api-reference/projects/get-current-users-projects"},{"title":"Get current user's projects including their predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ProjectsAndPredictions/My","href":"/api-reference/projects/get-current-users-projects-including-their-predictions"},{"title":"Search projects by geographic radius","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Search","href":"/api-reference/projects/search-projects-by-geographic-radius"},{"title":"List projects filtered by status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/ByStatus","href":"/api-reference/projects/list-projects-filtered-by-status"},{"title":"Change status of one or more projects","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/Status","href":"/api-reference/projects/change-status-of-one-or-more-projects"},{"title":"Import a PVsyst project from a ZIP export","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/Import/PVsyst","href":"/api-reference/projects/import-a-pvsyst-project-from-a-zip-export"},{"title":"Check the progress and outcome of a PVsyst import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Import/PVsyst/{jobId}","href":"/api-reference/projects/check-the-progress-and-outcome-of-a-pvsyst-import"},{"title":"Import a PVFARM project onto an existing prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Import/PVFarm","href":"/api-reference/projects/import-a-pvfarm-project-onto-an-existing-prediction"},{"title":"Check the progress and outcome of a PVFARM import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/Import/PVFarm/{jobId}","href":"/api-reference/projects/check-the-progress-and-outcome-of-a-pvfarm-import"},{"title":"Get a project by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}","href":"/api-reference/projects/get-a-project-by-id"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}","href":"/api-reference/projects/delete-a-project"},{"title":"Get project overview","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Overview","href":"/api-reference/projects/get-project-overview"},{"title":"Export a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Export","href":"/api-reference/projects/export-a-project"},{"title":"Get notes for a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Note","href":"/api-reference/projects/get-notes-for-a-project"},{"title":"Add a note to a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Note","href":"/api-reference/projects/add-a-note-to-a-project"},{"title":"Delete a project note","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Note/{noteId}","href":"/api-reference/projects/delete-a-project-note"}]},{"group":"Predictions","pages":[{"title":"List predictions for a project","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction","href":"/api-reference/predictions/list-predictions-for-a-project"},{"title":"Update a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction","href":"/api-reference/predictions/update-a-prediction"},{"title":"Create a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction","href":"/api-reference/predictions/create-a-prediction"},{"title":"Get a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}","href":"/api-reference/predictions/get-a-prediction"},{"title":"Delete a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Prediction/{predictionId}","href":"/api-reference/predictions/delete-a-prediction"},{"title":"Get prediction overview","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Overview","href":"/api-reference/predictions/get-prediction-overview"},{"title":"Run a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Run","href":"/api-reference/predictions/run-a-prediction"},{"title":"Cancel a running prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/Cancel","href":"/api-reference/predictions/cancel-a-running-prediction"},{"title":"Change status of one or more predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/Status","href":"/api-reference/predictions/change-status-of-one-or-more-predictions"},{"title":"Export a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Export","href":"/api-reference/predictions/export-a-prediction"},{"title":"Export and compare multiple predictions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionIds}/ExportMulti","href":"/api-reference/predictions/export-and-compare-multiple-predictions"},{"title":"Get albedo data for a prediction","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/GetAlbedoData","href":"/api-reference/predictions/get-albedo-data-for-a-prediction"},{"title":"Update export options for a prediction's power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/PowerPlant/ExportOptions","href":"/api-reference/predictions/update-export-options-for-a-predictions-power-plant"}]},{"group":"PowerPlant","pages":[{"title":"Get power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/get-power-plant"},{"title":"Update power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/update-power-plant"},{"title":"Create power plant","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/PowerPlant","href":"/api-reference/powerplant/create-power-plant"}]},{"group":"TimeSeries","pages":[{"title":"List time series data sets","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/list-time-series-data-sets"},{"title":"Upload time series CSV","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/upload-time-series-csv"},{"title":"Create new time series","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData","href":"/api-reference/timeseries/create-new-time-series"},{"title":"Download time series CSV template","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/Template","href":"/api-reference/timeseries/download-time-series-csv-template"},{"title":"Get time series details","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}/Details","href":"/api-reference/timeseries/get-time-series-details"},{"title":"Download time series as CSV","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}/CSV","href":"/api-reference/timeseries/download-time-series-as-csv"},{"title":"Delete a time series","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Project/{projectId}/Prediction/{predictionId}/TimeSeriesData/{timeSeriesId}","href":"/api-reference/timeseries/delete-a-time-series"}]},{"group":"Results","pages":[{"title":"Get prediction result summary","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ResultSummary","href":"/api-reference/results/get-prediction-result-summary"},{"title":"Get detailed energy results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ResultDetails","href":"/api-reference/results/get-detailed-energy-results"},{"title":"Get average energy results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/AverageEnergy","href":"/api-reference/results/get-average-energy-results"},{"title":"Get nodal JSON results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/NodalJson","href":"/api-reference/results/get-nodal-json-results"}]},{"group":"FinancialModel","pages":[{"title":"Get financial model parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/FinancialModelParameters","href":"/api-reference/financialmodel/get-financial-model-parameters"},{"title":"Save financial model parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/FinancialModelParameters","href":"/api-reference/financialmodel/save-financial-model-parameters"},{"title":"Calculate cashflow results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/CalculateCashflowResults","href":"/api-reference/financialmodel/calculate-cashflow-results"}]},{"group":"Reports","pages":[{"title":"Get URL for a generated report","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ReportURL/{reportType}","href":"/api-reference/reports/get-url-for-a-generated-report"},{"title":"Get plant block details report","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/Report/PlantBlockDetails","href":"/api-reference/reports/get-plant-block-details-report"},{"title":"Trigger report generation","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/GenerateReports","href":"/api-reference/reports/trigger-report-generation"},{"title":"Cancel report generation","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/CancelReportGeneration","href":"/api-reference/reports/cancel-report-generation"}]},{"group":"ShadeScene","pages":[{"title":"Convert PVC file to PVJ shade scene format","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /ShadeScene/ConvertPVCtoPVJ","href":"/api-reference/shadescene/convert-pvc-file-to-pvj-shade-scene-format"},{"title":"Convert SHD file to PVJ shade scene format","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /ShadeScene/ConvertSHDtoPVJ","href":"/api-reference/shadescene/convert-shd-file-to-pvj-shade-scene-format"},{"title":"Create/upload a shade scene from PVJ data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/ShadeScene/PVJData","href":"/api-reference/shadescene/createupload-a-shade-scene-from-pvj-data"},{"title":"Get shade scene properties for a DC field","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Properties/{dcFieldNumber}","href":"/api-reference/shadescene/get-shade-scene-properties-for-a-dc-field"},{"title":"Update shade scene properties","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Project/{projectId}/Prediction/{predictionId}/ShadeScene","href":"/api-reference/shadescene/update-shade-scene-properties"},{"title":"Queue TABT calculations","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/TABT/Run","href":"/api-reference/shadescene/queue-tabt-calculations"},{"title":"Get TABT processing status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/TABT/ProcessingStatus","href":"/api-reference/shadescene/get-tabt-processing-status"},{"title":"Queue shade calculations","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Run","href":"/api-reference/shadescene/queue-shade-calculations"},{"title":"Get shade calculation processing status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/ProcessingStatus","href":"/api-reference/shadescene/get-shade-calculation-processing-status"},{"title":"Get 3D shade calculation results","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Project/{projectId}/Prediction/{predictionId}/ShadeScene/Results","href":"/api-reference/shadescene/get-3d-shade-calculation-results"}]},{"group":"Weather","pages":[{"title":"Create a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather","href":"/api-reference/weather/create-a-weather-file"},{"title":"Get a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}","href":"/api-reference/weather/get-a-weather-file"},{"title":"Export a weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}/Export","href":"/api-reference/weather/export-a-weather-file"},{"title":"Update weather file metadata","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Weather/{weatherId}/TitleUpdate","href":"/api-reference/weather/update-weather-file-metadata"},{"title":"Get weather hourly detail records","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/{weatherId}/Detail","href":"/api-reference/weather/get-weather-hourly-detail-records"},{"title":"Update weather hourly detail records","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Weather/{weatherId}/Detail","href":"/api-reference/weather/update-weather-hourly-detail-records"},{"title":"Search weather files by location","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/Search","href":"/api-reference/weather/search-weather-files-by-location"},{"title":"Parse a raw weather file upload","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Parse","href":"/api-reference/weather/parse-a-raw-weather-file-upload"},{"title":"Run quality check on a parsed weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/QualityCheck","href":"/api-reference/weather/run-quality-check-on-a-parsed-weather-file"},{"title":"Finalize import of a parsed weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/FinalizeImport","href":"/api-reference/weather/finalize-import-of-a-parsed-weather-file"},{"title":"Finalize a system-generated weather file","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/FinalizeGeneratedWeather","href":"/api-reference/weather/finalize-a-system-generated-weather-file"},{"title":"Download weather data from a provider","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Download/{providerId}","href":"/api-reference/weather/download-weather-data-from-a-provider"},{"title":"Validate a weather download or import","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Weather/Download/ValidateDownload","href":"/api-reference/weather/validate-a-weather-download-or-import"},{"title":"Get horizon elevation profile for a location","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Weather/GetHorizonScene","href":"/api-reference/weather/get-horizon-elevation-profile-for-a-location"}]},{"group":"Inverters","pages":[{"title":"List all accessible inverters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter","href":"/api-reference/inverters/list-all-accessible-inverters"},{"title":"Create an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter","href":"/api-reference/inverters/create-an-inverter"},{"title":"Get inverter overview list","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/InverterOverview","href":"/api-reference/inverters/get-inverter-overview-list"},{"title":"Change status of one or more inverters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/Status","href":"/api-reference/inverters/change-status-of-one-or-more-inverters"},{"title":"Calculate kVA for an inverter at given conditions","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/kVA","href":"/api-reference/inverters/calculate-kva-for-an-inverter-at-given-conditions"},{"title":"Parse an OND file and return inverter data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Inverter/ParseONDFile","href":"/api-reference/inverters/parse-an-ond-file-and-return-inverter-data"},{"title":"Get an inverter by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/{inverterId}","href":"/api-reference/inverters/get-an-inverter-by-id"},{"title":"Update an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Inverter/{inverterId}","href":"/api-reference/inverters/update-an-inverter"},{"title":"Delete an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Inverter/{inverterId}","href":"/api-reference/inverters/delete-an-inverter"},{"title":"Get stored kVA for an inverter","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Inverter/{inverterId}/kVA","href":"/api-reference/inverters/get-stored-kva-for-an-inverter"}]},{"group":"Modules","pages":[{"title":"List all accessible modules","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module","href":"/api-reference/modules/list-all-accessible-modules"},{"title":"Create a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module","href":"/api-reference/modules/create-a-module"},{"title":"Get module overview list","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/ModuleOverview","href":"/api-reference/modules/get-module-overview-list"},{"title":"Get default IAM curve for a given ASHRAE IAM coefficient","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/DefaultIAM","href":"/api-reference/modules/get-default-iam-curve-for-a-given-ashrae-iam-coefficient"},{"title":"Parse a PAN file and return module data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/ImportPANFile","href":"/api-reference/modules/parse-a-pan-file-and-return-module-data"},{"title":"Create a module from parsed PAN file data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/CreatePANFileModule","href":"/api-reference/modules/create-a-module-from-parsed-pan-file-data"},{"title":"Generate single-diode parameters from basic datasheet values","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateSingleDiodeParametersDefault","href":"/api-reference/modules/generate-single-diode-parameters-from-basic-datasheet-values"},{"title":"Advanced generation of single-diode parameters","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateSingleDiodeParametersAdvanced","href":"/api-reference/modules/advanced-generation-of-single-diode-parameters"},{"title":"Optimize series resistance for effective irradiance response","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/OptimizeSeriesResistance","href":"/api-reference/modules/optimize-series-resistance-for-effective-irradiance-response"},{"title":"Calculate effective irradiance response","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/CalculateEffectiveIrradianceResponse","href":"/api-reference/modules/calculate-effective-irradiance-response"},{"title":"Generate IV curve for a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/GenerateIVCurve","href":"/api-reference/modules/generate-iv-curve-for-a-module"},{"title":"Process IV curve data","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/ProcessIVCurves","href":"/api-reference/modules/process-iv-curve-data"},{"title":"Process key IV points for module parameter derivation","description":"Takes pre-extracted IV operating points across multiple irradiance/temperature conditions and computes derived parameters (temperature coefficients, fill factors, etc.) used as inputs to the single-diode solvers. Lighter-weight alternative to `processIVCurves` when you already have the key points.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Module/Generator/ProcessKeyIVPoints","href":"/api-reference/modules/process-key-iv-points-for-module-parameter-derivation"},{"title":"Get a module by ID","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}","href":"/api-reference/modules/get-a-module-by-id"},{"title":"Update a module","description":"Updates an existing module using the request body. **All fields are required**, even if they haven’t changed. The module will be overwritten with the values you provide, any fields left out may replace existing values with empty/default ones.","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Module/{moduleId}","href":"/api-reference/modules/update-a-module"},{"title":"Delete a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Module/{moduleId}","href":"/api-reference/modules/delete-a-module"},{"title":"Export a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}/Export","href":"/api-reference/modules/export-a-module"},{"title":"Get notes for a module","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Module/{moduleId}/Note","href":"/api-reference/modules/get-notes-for-a-module"},{"title":"Delete a module note","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml delete /Module/{moduleId}/Note/{noteId}","href":"/api-reference/modules/delete-a-module-note"}]},{"group":"ASHRAE","pages":[{"title":"Get nearest ASHRAE station by coordinates","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ASHRAE","href":"/api-reference/ashrae/get-nearest-ashrae-station-by-coordinates"},{"title":"Get a specific ASHRAE station by name","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /ASHRAE/GetStation","href":"/api-reference/ashrae/get-a-specific-ashrae-station-by-name"}]},{"group":"System","pages":[{"title":"Get API version","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /System/Version","href":"/api-reference/system/get-api-version"},{"title":"Get maintenance mode status","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /System/MaintenanceMode","href":"/api-reference/system/get-maintenance-mode-status"}]},{"group":"Company","pages":[{"title":"Get company default settings","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Company/DefaultSettings","href":"/api-reference/company/get-company-default-settings"},{"title":"Update company default settings","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml put /Company/DefaultSettings","href":"/api-reference/company/update-company-default-settings"},{"title":"Add a user to a company","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /Company/{companyId}/User","href":"/api-reference/company/add-a-user-to-a-company"},{"title":"Generate API credentials for a user","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml post /User/{userId}/Secret","href":"/api-reference/company/generate-api-credentials-for-a-user"}]},{"group":"Country","pages":[{"title":"List all countries","deprecated":null,"version":null,"openapi":"/api-docs/api-reference/plantpredict-api.yaml get /Country","href":"/api-reference/country/list-all-countries"}]}]},{"group":"API Tools","icon":"wrench","pages":[{"title":"Postman Collection","href":"/api-docs/postman"},{"title":"Import a PVsyst project","href":"/api-docs/pvsyst-import"},{"title":"Import a PVFARM project","href":"/api-docs/pvfarm-import"}]},{"group":"SDK Documentation","icon":"github","pages":[{"title":"Github SDK Repository","url":"https://github.com/plantpredict/python-sdk","href":"/api-docs/python-sdk"}]}]}]},{"tab":"Design Pro","icon":"compass-drafting","menu":[{"item":"User Guide","href":"https://terabase.atlassian.net/servicedesk/customer/portal/3/topic/058fa7a7-e6a7-4b23-8c73-84ae563d6cd7/article/1295253542"}]},{"tab":"Terrain Pro","icon":"mountain","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/terrain-pro/terrain-pro-user-guide"}]}],"pages":[{"title":"Terrain Pro","href":"/user-guide/terrain-pro/terrain-pro-user-guide"}]},{"tab":"Voltage Pro","icon":"bolt","menu":[{"item":"User Guide","pages":[{"title":"User Guide","href":"/user-guide/voltage-pro/voltage-pro-user-guide"}]}],"pages":[{"title":"Voltage Pro","href":"/user-guide/voltage-pro/voltage-pro-user-guide"}]},{"tab":"Extensions","icon":"puzzle-piece","menu":[{"item":"PVRADAR Soiling","href":"https://pvradar.com/partners/terabase"},{"item":"PowerUQ","href":"https://www.poweruq.com/plantpredict-integration"}]},{"tab":"Release Notes","icon":"notebook","pages":[{"title":"Release Notes","href":"/release-notes/Current-Version"}]}]},"basePath":"","title":"Get a module by ID - PlantPredict","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CnLhKuUV.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}