Projects

Import a PVsyst project from a ZIP export

Imports a PVsyst project export directly, without using the web application.

Send the ZIP exactly as PVsyst produced it. The import runs asynchronously and can take several minutes, so this returns 202 Accepted immediately with a job ID. Poll GET /Project/Import/PVsyst/{jobId} with that ID until the status is Completed or Failed.

Every variant whose referenced module, inverter and weather files are in the ZIP — or which match a record already in your library — is imported. A variant that references a file which is absent or unreadable is left out and reported in the status response, naming the file so you can fix the export and send it again. Files are never substituted automatically.

Unlike the web application there is no review step: everything that can be built is built. See the PVsyst import guide for a full walkthrough.

POST

Project

Import

PVsyst

Import a PVsyst project from a ZIP export

curl --request POST \
  --url https://api.plantpredict.terabase.energy/Project/Import/PVsyst \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVsyst"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.plantpredict.terabase.energy/Project/Import/PVsyst', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plantpredict.terabase.energy/Project/Import/PVsyst",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plantpredict.terabase.energy/Project/Import/PVsyst"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.plantpredict.terabase.energy/Project/Import/PVsyst")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVsyst")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "jobId": 4471,
  "statusUrl": "/Project/Import/PVsyst/4471"
}

{
  "message": "The request is invalid.",
  "modelState": {
    "latitude": [
      "The field Latitude must be between -90 and 90."
    ]
  }
}

"An error has occurred."

Authorizations

Authorization

string

header

required

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

Body

multipart/form-data

file

required

The ZIP file exactly as PVsyst exported it.

Response

The import was accepted and is now running. The Location header carries the status URL. No project exists yet.

Returned when a PVsyst import is accepted. No project exists yet — poll statusUrl until the job reaches a terminal status.

jobId

integer<int64>

required

Identifier for this import. Worth logging: it is the fastest way for support to find a specific import.

statusUrl

string

Relative URL to poll for the import status.

Check the progress and outcome of a PVsyst importPoll this with the ID returned by `POST /Project/Import/PVsyst`. Checking once every 10 seconds is plenty; a large export can take several minutes. `status` is `Processing` while the import is running, then `Completed` or `Failed`. On `Completed`, `projectId` is the created project and `imported` lists the variants that became predictions. `skipped` lists variants that were left out, each naming the file references that could not be used, so an incomplete export can be corrected and sent again. On `Failed`, `errorCode` distinguishes a problem with the ZIP from a problem on the PlantPredict side. A partial import — some variants imported, others skipped — is a normal `Completed` outcome, not an error. If no variant could be imported the job is `Failed` and no project is created. An import is visible only to the account that created it. **Parameters:** - `jobId` (path, required): The import job ID returned by `POST /Project/Import/PVsyst`.

⌘I

Import a PVsyst project from a ZIP export

curl --request POST \
  --url https://api.plantpredict.terabase.energy/Project/Import/PVsyst \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'

import requests

url = "https://api.plantpredict.terabase.energy/Project/Import/PVsyst"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.plantpredict.terabase.energy/Project/Import/PVsyst', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.plantpredict.terabase.energy/Project/Import/PVsyst",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.plantpredict.terabase.energy/Project/Import/PVsyst"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.plantpredict.terabase.energy/Project/Import/PVsyst")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.plantpredict.terabase.energy/Project/Import/PVsyst")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "jobId": 4471,
  "statusUrl": "/Project/Import/PVsyst/4471"
}

{
  "message": "The request is invalid.",
  "modelState": {
    "latitude": [
      "The field Latitude must be between -90 and 90."
    ]
  }
}

"An error has occurred."

Introduction

Quick Start Guides

API Reference

API Tools

SDK Documentation

Import a PVsyst project from a ZIP export

Authorizations

Body

Response