Sign in

v4

latestOpenAPI 3.0.2raw.githubusercontent.com2026-08-01241621.9 KB
Run

Start a Run

post/runs/{runId}/start

Path parameters

runIdstring required
Example:7cf4afb6-9c15-431f-9f50-11bca0870f77

ID of run

Request body

startDatetimestring date-time required

Start Time

endDatetimestring date-time required

End Time

timescalenumber

Time multiplier determining simulation speed

externalClockboolean

When true the Run will only advance when triggered via the API

realtimeboolean

Simulate the model in realtime

Example request

{
  "timescale": 1,
  "externalClock": true
}

Response

The run was started