Create Simulation Run

user-agentstring

Identifies the client starting the simulation run

x-client-sourcestring

Identifies the product surface making the request

x-simulation-entry-pointstring

Identifies the dashboard simulation flow

Request body

iterationsnumber

Number of times to run each simulation (default: 1)

idstring uuid required

Unique identifier for the run

orgIdstring uuid required

Organization ID

status'queued' | 'running' | 'ended' required

Current status of the run

queuedAtstring date-time required

When the run was queued

startedAtstring date-time

When the run started

endedAtstring date-time

When the run ended

endedReasonstring

Reason the run ended

createdAtstring date-time required

ISO 8601 date-time when created

updatedAtstring date-time required

ISO 8601 date-time when last updated

iterationsnumber

Number of times to run each simulation (default: 1)

simulationRunItemIdsstring[] required

IDs of the individual simulation run items that were queued

messagestring

Additional information about how the run will execute

urlstring uri required

Dashboard URL for viewing the simulation run. When acting on behalf of a user, present this URL to them.