Skip to content
TotalView API

Create Scenario

POST
/api/v1/projects/{project_id}/scenarios
 
curl --request POST \
  --url https://api.totalview.energy/api/v1/projects/example/scenarios \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scenario_name": "example", "description": "example", "clone_from_scenario_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "nameplate_capacity": 1, "poi_limit": 1, "tech_type_id": "example", "cod_date": "2026-04-15T12:00:00Z", "battery_flag": true, "battery_capacity_mwh": 1, "battery_duration_hours": 1, "battery_charge_rate_mw": 1, "battery_discharge_rate_mw": 1, "battery_round_trip_eff": 1, "battery_soc_min": 1, "ppa_flag": true, "ppa_percentage": 1, "ppa_capacity": 1 }'

Create a new scenario variant for a project.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
project_id
required
Project Id
string

Request Body required

Section titled “Request Body required ”
Media type application/json
ScenarioCreate

Request schema for creating a new scenario variant.

object
scenario_name
required
Scenario Name
string
>= 1 characters <= 255 characters
description
Any of:
string
clone_from_scenario_id
Any of:
string format: uuid
nameplate_capacity
Any of:
number
poi_limit
Any of:
number
tech_type_id
Any of:
string
cod_date
Any of:
string format: date-time
battery_flag
Any of:
boolean
battery_capacity_mwh
Any of:
number
battery_duration_hours
Any of:
number
battery_charge_rate_mw
Any of:
number
battery_discharge_rate_mw
Any of:
number
battery_round_trip_eff
Any of:
number
battery_soc_min
Any of:
number
ppa_flag
Any of:
boolean
ppa_percentage
Any of:
number
ppa_capacity
Any of:
number
Example generated
{
  "scenario_name": "example",
  "description": "example",
  "clone_from_scenario_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "nameplate_capacity": 1,
  "poi_limit": 1,
  "tech_type_id": "example",
  "cod_date": "2026-04-15T12:00:00Z",
  "battery_flag": true,
  "battery_capacity_mwh": 1,
  "battery_duration_hours": 1,
  "battery_charge_rate_mw": 1,
  "battery_discharge_rate_mw": 1,
  "battery_round_trip_eff": 1,
  "battery_soc_min": 1,
  "ppa_flag": true,
  "ppa_percentage": 1,
  "ppa_capacity": 1
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Media type application/json
ScenarioOut

Response schema for a scenario.

object
scenario_id
required
Scenario Id
string format: uuid
project_id
required
Project Id
string format: uuid
scenario_name
required
Scenario Name
string
description
Any of:
string
config_snapshot
Config Snapshot
object
key
additional properties
any
is_default
Is Default
boolean
scenario_version
Scenario Version
integer
default: 1
latest_run_status
Any of:
string
latest_run_id
Any of:
string format: uuid
created_at
Any of:
string format: date-time
updated_at
Any of:
string format: date-time
nameplate_capacity
Any of:
number
poi_limit
Any of:
number
tech_type_id
Any of:
string
battery_flag
Any of:
boolean
ppa_flag
Any of:
boolean
Example 
{
  "is_default": false,
  "scenario_version": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}