Sign in
Simulation

Run a simulation

Starts a simulation and returns the run.

Send plan to describe a simulation and run it once. Add saveAsPlan to keep that configuration as a reusable run plan. Send planId instead to run a plan you already have.

post/v1/simulation/run

Request body

OR

Example request

{
  "saveAsPlan": true,
  "plan": {
    "name": "Billing regression",
    "direction": "OUTBOUND",
    "maxSimulationDurationSeconds": 300,
    "agentEndpoints": [
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
      }
    ],
    "metrics": [
      {
        "slug": "customer_satisfaction"
      }
    ],
    "flows": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "happyPath": true,
        "edgeCases": "ALL"
      }
    ]
  },
  "variables": {
    "orderNumber": "12345"
  }
}

Response

The run that was started

Changes