v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-285553225.5 KB
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

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. Must be 1 for OUTBOUND direction.

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)

Response

The updated run plan

Example response

{
  "data": {
    "scenarios": [
      {
        "variables": {
          "customerName": "John Doe",
          "appointmentDate": "2024-02-15"
        }
      }
    ]
  }
}