MOmodoenergy
Forecasts

Upload Custom File

Upload a custom CSV file to use in a forecast run, such as a battery degradation curve, a solar or wind generation profile, or grid charges/curtailment limits.

The file is validated on upload (CSV only, max 20 MB, and the column structure must match the selected file_type); invalid files are rejected with a 400 describing the problem.

How to use the result: take the filename from the response and reference it in your simulation_config when calling POST /runs/. For example, a degradation_curve upload goes in simulation_config.assets.battery.degradation.profile_filename.

Send the request as multipart/form-data.

post/file-uploads/

Request

  • Base URL
    https://api.modoenergy.com/pub/v1/forecasts
  • URL
    https://api.modoenergy.com/pub/v1/forecasts/file-uploads/
  • Auth
    API key in header X-token

Request body multipart/form-data

filestring binary required

The CSV file to upload (max 20 MB).

file_type'degradation_curve' | 'grid_charges' | 'grid_curtailment' | 'mlf_forecast' | 'solar_profile' | 'wind_profile' required

The kind of file being uploaded. Determines which column structure is required.

Response

File uploaded and validated.

filestring uri

Short-lived presigned URL to download the file.

file_type'degradation_curve' | 'grid_charges' | 'grid_curtailment' | 'mlf_forecast' | 'solar_profile' | 'wind_profile'

The file type.

filenamestring

The value to reference from your simulation_config when creating a run (e.g. assets.battery.degradation.profile_filename).

idstring uuid

Unique ID of the uploaded file.

uploaded_bystring email

Email of the user who uploaded the file.

Example response

{
  "filename": "my_curve.csv"
}

Changes

No recorded changes to this operation across all 1 revision of this API.