Skip to main content

Run a scenario in the attached environment.

POST 
/api/sim/start

One press. This used to be load (spawn and hold) followed by play (start the clock), preserving a gap in which the geometry could be checked before anything moved. That gap moved up a level: attaching an ENVIRONMENT is now separate, so by the time this is called the engine is connected and the world is up — and the scenario's geometry is inspected on a map in the console before anything connects, which is a better place for it than a frozen live world.

Request​

Responses​

the run is open and the workspace state says Running