Sign in
Simulation Run Plan

Update a run plan

Updates an existing simulation run plan by its ID.

put/v1/simulation/plan/{planId}

Path parameters

planIdstring uuid required

The ID of the run plan to update

Request body

isHiddenboolean

Whether this plan is hidden from GET /v1/simulation/plan.

A run started without saveAsPlan creates a hidden plan to carry it. Send { "name": "...", "isHidden": false } to keep that configuration as a reusable plan, which is what the app does when you save a one-off run.

namestring

Name of the run plan

descriptionstring

Description of the run plan

direction'INBOUND' | 'OUTBOUND'

Direction of the simulation (INBOUND or OUTBOUND)

iterationCountinteger

Number of iterations to run for each test case (1-10000)

maxConcurrentJobsinteger

Maximum number of concurrent simulation jobs

maxSimulationDurationSecondsinteger

Maximum duration in seconds for each simulation

silenceTimeoutSecondsinteger

Timeout in seconds for silence detection

endCallPhrasesstring[]

Phrases that trigger end of call. Empty array disables the feature.

endCallReasonsstring[]

Semantic conditions that trigger end of call. The LLM evaluates the conversation against these conditions. Empty array disables the feature.

executionMode'PARALLEL' | 'SEQUENTIAL_SAME_RUN_PLAN' | 'SEQUENTIAL_PROJECT'

Execution mode (PARALLEL or SEQUENTIAL)

Example request

{
  "flows": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "happyPath": true,
      "edgeCases": [
        {
          "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
          "variables": {
            "tier": "premium"
          }
        }
      ]
    }
  ]
}

Response

The updated run plan

Example response

{
  "data": {
    "scenarios": [
      {
        "variables": {
          "customerName": "John Doe",
          "appointmentDate": "2024-02-15"
        }
      }
    ],
    "flows": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "happyPath": true,
        "edgeCases": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "variables": {
              "tier": "premium"
            }
          }
        ]
      }
    ]
  }
}

Changes