Sign in

v5

OpenAPI 3.1.02026-07-31129337684.6 KB
Simulations

Create Simulation

Endpoint to create a new simulation.

post/workflows/v1/simulations

Request body

logical_idstring nullable

Unique identifier for the simulation

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' nullable

Current status of the simulation

namestring nullable

Name of the simulation

descriptionstring nullable

Description of the simulation

timeout_secondsinteger nullable

Maximum time in seconds to run the simulation

max_eventsinteger nullable

Maximum number of events to process in the simulation

number_of_simulationsinteger nullable

Number of times to run the simulation

max_concurrent_runsinteger nullable

Maximum number of concurrent simulation runs allowed

assistant_starts_firstboolean nullable

If True, the assistant workflow will kick off first, else it will be the user workflow.

stop_on_failureboolean nullable

Whether to stop the simulation on failure

run_bystring nullable

Identifier of the user or system that initiated the workflow simulation

Example request

{
  "selected_workflow": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "run_id": "5eb7cf5a86d9755df3a6c593"
  },
  "counter_workflow": {
    "workflow_id": "5eb7cf5a86d9755df3a6c593",
    "run_id": "5eb7cf5a86d9755df3a6c593"
  }
}

Response

Successful Response

Example response

{
  "simulation": {
    "_id": "5eb7cf5a86d9755df3a6c593"
  }
}