Update a run plan

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);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
simulation_run_plan = client.simulation_run_plan.update(
    plan_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(simulation_run_plan.data)

curl --request PUT \
  --url https://api.roark.ai/v1/simulation/plan/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isHidden": true,
  "name": "<string>",
  "description": "<string>",
  "iterationCount": 5000,
  "maxConcurrentJobs": 2,
  "maxSimulationDurationSeconds": 2,
  "silenceTimeoutSeconds": 2,
  "maxNoResponseRetries": 5,
  "noResponseRetryBackoffSeconds": 315,
  "endCallPhrases": [
    "<string>"
  ],
  "endCallReasons": [
    "<string>"
  ],
  "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"
    }
  ],
  "metrics": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "metricId": "<string>",
      "minPassRate": 80
    }
  ],
  "enrichWithLiveConversation": true,
  "includeFlowMetrics": true,
  "includeAutomaticMetrics": true,
  "comparisonBaseline": "<string>",
  "comparisonValues": [
    "NONE",
    {
      "value": "OFFICE",
      "backgroundNoiseVolume": 0.6
    },
    {
      "value": "DRIVING",
      "backgroundNoiseVolume": 0.7
    },
    {
      "value": "DRIVING",
      "backgroundNoiseVolume": 1
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/simulation/plan/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isHidden' => true,
    'name' => '<string>',
    'description' => '<string>',
    'iterationCount' => 5000,
    'maxConcurrentJobs' => 2,
    'maxSimulationDurationSeconds' => 2,
    'silenceTimeoutSeconds' => 2,
    'maxNoResponseRetries' => 5,
    'noResponseRetryBackoffSeconds' => 315,
    'endCallPhrases' => [
        '<string>'
    ],
    'endCallReasons' => [
        '<string>'
    ],
    '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'
        ]
    ],
    'metrics' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'slug' => '<string>',
                'metricId' => '<string>',
                'minPassRate' => 80
        ]
    ],
    'enrichWithLiveConversation' => true,
    'includeFlowMetrics' => true,
    'includeAutomaticMetrics' => true,
    'comparisonBaseline' => '<string>',
    'comparisonValues' => [
        'NONE',
        [
                'value' => 'OFFICE',
                'backgroundNoiseVolume' => 0.6
        ],
        [
                'value' => 'DRIVING',
                'backgroundNoiseVolume' => 0.7
        ],
        [
                'value' => 'DRIVING',
                'backgroundNoiseVolume' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/simulation/plan/{planId}"

	payload := strings.NewReader("{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.roark.ai/v1/simulation/plan/{planId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/simulation/plan/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "isConfigManaged": true,
    "template": "accent-handling",
    "direction": "INBOUND",
    "iterationCount": 123,
    "maxConcurrentJobs": 123,
    "maxSimulationDurationSeconds": 123,
    "silenceTimeoutSeconds": 123,
    "maxNoResponseRetries": 123,
    "noResponseRetryBackoffSeconds": 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",
        "minPassRate": 123
      }
    ],
    "enrichWithLiveConversation": true,
    "includeFlowMetrics": true,
    "includeAutomaticMetrics": true,
    "comparisonProperty": "ACCENT",
    "comparisonBaseline": "<string>",
    "testCaseCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>"
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "conflict",
  "code": "resource_in_use",
  "message": "The resource is in use and cannot be deleted"
}

{
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "Rate limit exceeded"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

PUT

simulation

plan

{planId}

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);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
simulation_run_plan = client.simulation_run_plan.update(
    plan_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(simulation_run_plan.data)

curl --request PUT \
  --url https://api.roark.ai/v1/simulation/plan/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isHidden": true,
  "name": "<string>",
  "description": "<string>",
  "iterationCount": 5000,
  "maxConcurrentJobs": 2,
  "maxSimulationDurationSeconds": 2,
  "silenceTimeoutSeconds": 2,
  "maxNoResponseRetries": 5,
  "noResponseRetryBackoffSeconds": 315,
  "endCallPhrases": [
    "<string>"
  ],
  "endCallReasons": [
    "<string>"
  ],
  "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"
    }
  ],
  "metrics": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "metricId": "<string>",
      "minPassRate": 80
    }
  ],
  "enrichWithLiveConversation": true,
  "includeFlowMetrics": true,
  "includeAutomaticMetrics": true,
  "comparisonBaseline": "<string>",
  "comparisonValues": [
    "NONE",
    {
      "value": "OFFICE",
      "backgroundNoiseVolume": 0.6
    },
    {
      "value": "DRIVING",
      "backgroundNoiseVolume": 0.7
    },
    {
      "value": "DRIVING",
      "backgroundNoiseVolume": 1
    }
  ]
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/simulation/plan/{planId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'isHidden' => true,
    'name' => '<string>',
    'description' => '<string>',
    'iterationCount' => 5000,
    'maxConcurrentJobs' => 2,
    'maxSimulationDurationSeconds' => 2,
    'silenceTimeoutSeconds' => 2,
    'maxNoResponseRetries' => 5,
    'noResponseRetryBackoffSeconds' => 315,
    'endCallPhrases' => [
        '<string>'
    ],
    'endCallReasons' => [
        '<string>'
    ],
    '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'
        ]
    ],
    'metrics' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'slug' => '<string>',
                'metricId' => '<string>',
                'minPassRate' => 80
        ]
    ],
    'enrichWithLiveConversation' => true,
    'includeFlowMetrics' => true,
    'includeAutomaticMetrics' => true,
    'comparisonBaseline' => '<string>',
    'comparisonValues' => [
        'NONE',
        [
                'value' => 'OFFICE',
                'backgroundNoiseVolume' => 0.6
        ],
        [
                'value' => 'DRIVING',
                'backgroundNoiseVolume' => 0.7
        ],
        [
                'value' => 'DRIVING',
                'backgroundNoiseVolume' => 1
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.roark.ai/v1/simulation/plan/{planId}"

	payload := strings.NewReader("{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.roark.ai/v1/simulation/plan/{planId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/simulation/plan/{planId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isHidden\": true,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"iterationCount\": 5000,\n  \"maxConcurrentJobs\": 2,\n  \"maxSimulationDurationSeconds\": 2,\n  \"silenceTimeoutSeconds\": 2,\n  \"maxNoResponseRetries\": 5,\n  \"noResponseRetryBackoffSeconds\": 315,\n  \"endCallPhrases\": [\n    \"<string>\"\n  ],\n  \"endCallReasons\": [\n    \"<string>\"\n  ],\n  \"scenarios\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"variables\": {\n        \"customerName\": \"John Doe\",\n        \"appointmentDate\": \"2024-02-15\"\n      }\n    }\n  ],\n  \"flows\": [\n    {\n      \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n      \"happyPath\": true,\n      \"edgeCases\": [\n        {\n          \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n          \"variables\": {\n            \"tier\": \"premium\"\n          }\n        }\n      ]\n    }\n  ],\n  \"personas\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"agentEndpoints\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n    }\n  ],\n  \"metrics\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"slug\": \"<string>\",\n      \"metricId\": \"<string>\",\n      \"minPassRate\": 80\n    }\n  ],\n  \"enrichWithLiveConversation\": true,\n  \"includeFlowMetrics\": true,\n  \"includeAutomaticMetrics\": true,\n  \"comparisonBaseline\": \"<string>\",\n  \"comparisonValues\": [\n    \"NONE\",\n    {\n      \"value\": \"OFFICE\",\n      \"backgroundNoiseVolume\": 0.6\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 0.7\n    },\n    {\n      \"value\": \"DRIVING\",\n      \"backgroundNoiseVolume\": 1\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "isConfigManaged": true,
    "template": "accent-handling",
    "direction": "INBOUND",
    "iterationCount": 123,
    "maxConcurrentJobs": 123,
    "maxSimulationDurationSeconds": 123,
    "silenceTimeoutSeconds": 123,
    "maxNoResponseRetries": 123,
    "noResponseRetryBackoffSeconds": 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",
        "minPassRate": 123
      }
    ],
    "enrichWithLiveConversation": true,
    "includeFlowMetrics": true,
    "includeAutomaticMetrics": true,
    "comparisonProperty": "ACCENT",
    "comparisonBaseline": "<string>",
    "testCaseCount": 123,
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>"
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "conflict",
  "code": "resource_in_use",
  "message": "The resource is in use and cannot be deleted"
}

{
  "type": "rate_limit",
  "code": "too_many_requests",
  "message": "Rate limit exceeded"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

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

maxNoResponseRetries

integer

How many more times to run a test case when the agent under test never responds: it never speaks on a call or never replies in a chat (0-10). 0 turns retries off. Failed checks and failures on Roark’s side are never retried.

Each retry is a separate attempt, billed like any other, so a plan retrying N times can place up to N + 1 calls per test case. Every silent attempt stays on the run with its own call; the run settles once each test case has a final attempt, and the agent never spoke verdict is judged on each test case’s last attempt.

Required range: 0 <= x <= 10

noResponseRetryBackoffSeconds

integer

Seconds a retry waits before it dials (30-600). Only used when maxNoResponseRetries is above 0.

Required range: 30 <= x <= 600

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.

comparisonProperty

enum<string> | null

The property this plan investigates. Send null to clear the comparison; omit the field to leave it unchanged. See POST /v1/simulation/plan.

The pair moves together. Sending comparisonProperty without comparisonBaseline keeps the stored baseline when the property is unchanged and the baseline is still one of the values being run. Otherwise it becomes the new property's norm, or null when that norm is not being run either, because a baseline is a value of one specific property.

Available options:

ACCENT,

AGE,

BACKGROUND_NOISE,

BACKGROUND_NOISE_VOLUME,

BASE_EMOTION,

CONFIRMATION_STYLE,

GENDER,

INTENT_CLARITY,

LANGUAGE,

INTERRUPTION,

MEMORY_RELIABILITY,

RESPONSE_TIMING,

SPEECH_CLARITY,

SPEECH_PACE

comparisonBaseline

string | null

The reference value, shown first in the results. See POST /v1/simulation/plan.

A real value cannot be sent on its own: the property it belongs to decides which values are legal, and an omitted property means "leave unchanged", which this endpoint cannot check a baseline against. Send comparisonProperty with it, or get a 400.

null on its own IS allowed, and clears just the baseline while leaving the property set. Nothing needs validating when clearing, and a property with no baseline is a real state: the report falls back to that property's own norm, and GENDER has no norm to fall back to.

comparisonValues

(string | object)[]

The arms to run. See POST /v1/simulation/plan.

Omitting it keeps the arms the plan already has, pins included, so an edit that only renames the plan never widens a sweep you deliberately narrowed, and never multiplies what it costs. Send it with comparisonProperty and flows, which the arms are rebuilt from.

Minimum array length: 1

A value of comparisonProperty, run as its plain arm.

Minimum string length: 1

Example:

[
  "NONE",
  {
    "value": "OFFICE",
    "backgroundNoiseVolume": 0.6
  },
  {
    "value": "DRIVING",
    "backgroundNoiseVolume": 0.7
  },
  {
    "value": "DRIVING",
    "backgroundNoiseVolume": 1
  }
]

Response

The updated run plan

data

object

required

A simulation run plan defining the test matrix

Show child attributes

API Reference

Health

CLI Auth

Prospect Simulation

Me

Project

Agent Endpoint

Agent

Call

Chat

Metric

Metric Policy

Metric Collection Job

Simulation Persona

Simulation

Simulation Environment

Simulation Run Plan

Simulation Run Plan Job

Simulation Template

Simulation Job

Customer Flow

Customer Flow Edge Case

HTTP Request Definition

Webhook

Issue

Autoimprove

Agent Config

Knowledge Base

Config

Organization Project

Organization Project Member

Organization Project API Key

Usage

Benchmark

Authorizations

Path Parameters

Body

Response