Update a run plan

Updates an existing simulation run plan by its ID.

PUT /v1/simulation/plan/{planId}

JavaScript

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const simulationRunPlan = await client.simulationRunPlan.update(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(simulationRunPlan.data);

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "isConfigManaged": true,
    "direction": "INBOUND",
    "iterationCount": 123,
    "maxConcurrentJobs": 123,
    "maxSimulationDurationSeconds": 123,
    "silenceTimeoutSeconds": 123,
    "endCallPhrases": [
      "<string>"
    ],
    "endCallReasons": [
      "<string>"
    ],
    "executionMode": "PARALLEL",
    "scenarios": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "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"
            }
          }
        ]
      }
    ],
    "personas": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "agentEndpoints": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "evaluators": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "metrics": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "conversationSource": "SIMULATED"
      }
    ],
    "enrichWithLiveConversation": true,
    "includeFlowMetrics": true,
    "includeAutomaticMetrics": true,
    "testCaseCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

planId · string<uuid> · required

The ID of the run plan to update

Body

application/json

Input for updating an existing simulation run plan

isHidden · boolean

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.

name · string

Name of the run plan

Minimum string length: 1

description · string

Description of the run plan

direction · enum<string>

Direction of the simulation (INBOUND or OUTBOUND)

Available options: INBOUND, OUTBOUND

iterationCount · integer

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

Required range: 1 <= x <= 10000

maxConcurrentJobs · integer

Maximum number of concurrent simulation jobs

Required range: x >= 1

maxSimulationDurationSeconds · integer

Maximum duration in seconds for each simulation

Required range: x >= 1

silenceTimeoutSeconds · integer

Timeout in seconds for silence detection

Required range: x >= 1

endCallPhrases · string[]

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

endCallReasons · string[]

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

executionMode · enum<string>

Execution mode (PARALLEL or SEQUENTIAL)

Available options: PARALLEL, SEQUENTIAL_SAME_RUN_PLAN, SEQUENTIAL_PROJECT

scenarios · object[] · deprecated

Deprecated: use flows instead. Replaces the scenarios on this run plan. Omit to leave them unchanged; send an empty array to detach them all, which is how a scenario-based plan is moved over to flows.

Show child attributes

flows · object[]

Replaces the customer flows attached to this run plan. Omit to leave them unchanged; send an empty array to detach them all.

Show child attributes

personas · object[]

Personas to include in this run plan

Minimum array length: 1

Show child attributes

agentEndpoints · object[]

Agent endpoints to include in this run plan

Minimum array length: 1

Show child attributes

metrics · object[]

Metric definitions to include in this run plan. Reference each by id (UUID) or slug.

Minimum array length: 1

Show child attributes

enrichWithLiveConversation · boolean

Whether to merge the customer's own live recording into each simulation of this plan.

includeFlowMetrics · boolean

Whether to also collect each attached flow's own metrics, on top of this plan's list.

includeAutomaticMetrics · boolean

Whether to let the run add metrics by itself off the attached flows. See POST /v1/simulation/plan.

Response

200

application/json

The updated run plan

data · object · required

A simulation run plan defining the test matrix

Show child attributes