Sign in

v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB
Simulations

Run scenario

Run multiple executions of a scenario.

post/simulations/{simulationReference}/schedule

Path parameters

simulationReferencestring required

Reference ID of the scenario

Query parameters

projectIdstring required

Project identifier

Request body

projectReferencestring required

Project reference (required in body)

namestring required

Name for this simulation

numberOfExecutionsinteger required

Number of simulation runs to execute in this simulation

endPointTypestring

Endpoint type for simulation execution (e.g., 'api', 'rpc')

Response

Scenario execution started successfully

idstring required

Unique identifier for the simulation

referenceIdstring required

Reference ID for the simulation

simulationReferencestring required

Reference ID of the simulated scenario

status'pending' | 'running' | 'completed' | 'failed' | 'stopped' required

Current status of the simulation

runsinteger required

Number of runs in this simulation

completedRunsinteger required

Number of completed runs

failedRunsinteger required

Number of failed runs

createdAtinteger required

Creation timestamp

startedAtinteger nullable

Start timestamp

completedAtinteger nullable

Completion timestamp