Skip to main content
POST
Preview Fleet

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

org_id
string<uuid>
required

Body

application/json
request_id
string<uuid>
required
name
string
default:Simulated fleet
Required string length: 1 - 120
Pattern: \S
count
integer
default:10
Required range: 1 <= x <= 1000
seed
integer
default:42
Required range: 0 <= x <= 9007199254740991
history_days
integer
default:0
Required range: 0 <= x <= 90
history_cutoff
string<date-time> | null
latitude
number | null
Required range: -90 <= x <= 90
longitude
number | null
Required range: -180 <= x <= 180
density
DensityRasterInput · object | null

Painted household density for one country. The Go contract holds the full rules; these checks stop malformed payloads before a runtime call and give the Console field-level errors.

ev_ownership_fraction
number
default:0.25
Required range: 0 <= x <= 1
pv_rating_kw
number | null
Required range: 0 <= x <= 100
battery_capacity_kwh
number | null
Required range: 0.1 <= x <= 1000
max_charge_power_w
integer | null
Required range: 1 <= x <= 100000
max_discharge_power_w
integer | null
Required range: 1 <= x <= 100000
initial_soc_percent
number | null
Required range: 5 <= x <= 100
pv_rating_kw_range
IntegerRange · object | null
battery_capacity_kwh_range
IntegerRange · object | null
initial_soc_percent_range
IntegerRange · object | null
max_charge_power_w_range
IntegerRange · object | null
max_discharge_power_w_range
IntegerRange · object | null
annual_consumption_kwh
number | null
Required range: 1 <= x <= 100000
annual_consumption_with_ev_kwh
number | null
Required range: 1 <= x <= 100000
groups
FleetGroupInput · object[]
Maximum array length: 100

Response

200

OK