Access and Usage

The following documentation describes how users with valid Veracity credentials can access the Renewables.Architect run and analysis API. Any user or application needs to have an account registered with Veracity and needs to be registered as an API user. Please contact the Renewables.Architect team (renewables.architect@dnv.com).

To access the Renewables.Architect API, you must first authenticate yourself and obtain an API Token, valid for 60 minutes.

To then get started interacting with the API, please follow the API Workflow.

Application files define what type of analysis to run and with which inputs, example applications with default inputs can be obtained from the Applications Library after login.

Applications

The API accepts JSON payloads describing your wind farm configuration and returns detailed engineering calculations. All requests follow a consistent structure:

{
  "driver": {
    "driver_type": "CSVBatchTable",
    "driver_parameters": {
      /* batch processing options */
    }
  },
  "application_name": "Application Name",
  "environment": {
    "environment_type": "Sequential",
    "environment_parameters": {
      /* analysis parameters */
    }
  },
  "shared_inputs": {
    /* Your wind farm configuration parameters */
  }
}