Skip to main content
POST
Run Simulation

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

simulation_id
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Body

application/json
runner_name
string | null

Name of the user running the simulation

Response

Successful Response

Response model for a simulation group run.

simulation_group
SimulationGroupModel · object
required

Simulation group object