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 response = await client.customerFlowEdgeCase.add('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
title: 'x',
});
console.log(response.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
)
response = client.customer_flow_edge_case.add(
flow_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
title="x",
)
print(response.data)
curl --request POST \
--url https://api.roark.ai/v1/customer-flow/{flowId}/edge-case \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"openingLine": "<string>",
"precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeFlowExpectations": true,
"additionalExpectations": [
{
"prompt": "The agent confirmed the new appointment time back to the customer"
}
],
"personaOverrideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}
Customer flows
Add an edge case
Adds a variant to an IMPROV flow.
A scripted flow’s variants are owned by the path engine, one per path through the graph, so they are
created by editing the graph through PUT /v1/customer-flow//graph rather than here.
Leave personaOverrideId or environmentId unset to inherit the happy path’s.
POST
/
v1
/
customer-flow
/
{flowId}
/
edge-case
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 response = await client.customerFlowEdgeCase.add('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {
title: 'x',
});
console.log(response.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
)
response = client.customer_flow_edge_case.add(
flow_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
title="x",
)
print(response.data)
curl --request POST \
--url https://api.roark.ai/v1/customer-flow/{flowId}/edge-case \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"environmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prompt": "<string>",
"openingLine": "<string>",
"precededByCustomerFlowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"precededByCustomerFlowVariantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"includeFlowExpectations": true,
"additionalExpectations": [
{
"prompt": "The agent confirmed the new appointment time back to the customer"
}
],
"personaOverrideId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
"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
flowId
string<uuid>
required
Body
application/json
title
string
required
Minimum string length: 1
environmentId
string<uuid> | null
prompt
string | null
The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: #{emotion:<emotion>}, #{language:<ISO 639-1 code>}, #{noise:<environmentId>}, and #{interrupt}, whose sentence says when to cut in on your agent. Cues are voice only. See "Caller cues" in the customer flows concept.
openingLine
string | null
precededByCustomerFlowId
string<uuid> | null
precededByCustomerFlowVariantId
string<uuid> | null
includeFlowExpectations
boolean
Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.
additionalExpectations
object[]
The expectations graded on this variant only, on top of the flow's own. Sent as the complete set: it replaces whatever the variant had, so omit it to leave the set alone and send [] to clear it. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on every graph edit.
Show child attributes
personaOverrideId
string<uuid> | null
The persona this runs as. Omit to inherit the happy path's.
Response
The edge case that was added
data
Scripted · object
required
One way of running a customer flow.
Scripted
Improv
Voicemail
Show child attributes
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Roark Docs","description":"Roark is the quality platform for voice and chat AI. Simulate every scenario before launch, monitor every production call, and score them with audio-native metrics.","colors":{"primary":"#006838","light":"#4faf62","dark":"#005530"},"logo":{"light":"https://mintcdn.com/roark/roh5qorg6REL9dkn/images/logo/light.svg?fit=max\u0026auto=format\u0026n=roh5qorg6REL9dkn\u0026q=85\u0026s=040c5cac74f0bd94ad25a3ccfdb45dbc","dark":"https://mintcdn.com/roark/85D-0i58gn7fPi1w/images/logo/dark.svg?fit=max\u0026auto=format\u0026n=85D-0i58gn7fPi1w\u0026q=85\u0026s=d666f2dc1f3dc1b8320c0bef62dca06b","href":"https://roark.ai"},"favicon":"https://mintcdn.com/roark/roh5qorg6REL9dkn/favicon.svg?fit=max\u0026auto=format\u0026n=roh5qorg6REL9dkn\u0026q=85\u0026s=95d524da66f21b9f4532ec4f6162efc5","appearance":{"default":"system"},"background":{"color":{"light":"#f0eeeb","dark":"#0e0d0c"}},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://roark.ai/signup"}},"footer":{"socials":{"x":"https://x.com/roarkhq","github":"https://github.com/roarkhq","linkedin":"https://www.linkedin.com/company/roark-innovations"}},"fonts":{"heading":{"family":"Bricolage Grotesque","weight":600},"body":{"family":"Hanken Grotesk"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"section","codeblocks":{"theme":{"light":"everforest-light","dark":"everforest-dark"}},"latex":false},"contextual":{"options":["copy","view","chatgpt","claude","cursor","mcp"],"display":"header"},"navigation":{"global":{},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"roark","hasAudioNarration":false,"actualSubdomain":"roark","customDomains":["docs.roark.ai"],"gitSource":{"type":"github","owner":"roarkhq","repo":"docs-roark-analytics","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6afcaeadb1dbd0187d1f4689","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"API Reference","count":236},{"language":"default","tag":"CLI Reference","count":227},{"language":"default","tag":"Guides","count":86},{"language":"default","tag":"simulation","count":44},{"language":"default","tag":"Simulations","count":38},{"language":"default","tag":"agent","count":37},{"language":"default","tag":"connections","count":31},{"language":"default","tag":"Templates","count":20},{"language":"default","tag":"job","count":19},{"language":"default","tag":"metric","count":19}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"@import url('https://fonts.googleapis.com/css2?family=Geist+Mono:wght@400;500;600\u0026display=swap');:root{--roark-accent: #006838;--roark-accent-hover: #005530;--roark-accent-subtle: rgba(0, 104, 56, 0.08);--roark-shell: #f0eeeb;--roark-panel: #ffffff;--roark-border: #e4e0dc;--roark-radius-card: 14px;--roark-ease: cubic-bezier(0.25, 0.1, 0.25, 1)}.dark{--roark-accent: #4faf62;--roark-accent-hover: #5ec070;--roark-accent-subtle: rgba(79, 175, 98, 0.1);--roark-shell: #0e0d0c;--roark-panel: #1a1918;--roark-border: #2e2c2a}code,kbd,samp,pre,pre *{font-family:'Geist Mono', ui-monospace, 'SF Mono', SFMono-Regular, Menlo, monospace}h1,h2,h3,h4{font-feature-settings:'ss01' on;letter-spacing:-0.02em}#content-area h1{font-size:clamp(2.1rem, 3.4vw, 2.6rem);line-height:1.12}body{font-feature-settings:'ss01' on, 'cv01' on;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}::selection{background:#006838;color:#f0eeeb}.dark ::selection{background:#4faf62;color:#0e0d0c}#content-area a.link{color:var(--roark-accent);text-decoration-color:var(--roark-accent-subtle);text-underline-offset:3px;transition:color 0.15s var(--roark-ease)}#content-area a.link:hover{color:var(--roark-accent-hover);text-decoration-color:currentColor}[class*=\"eyebrow\"]{font-family:'Geist Mono', ui-monospace, monospace;font-size:0.75rem;font-weight:500;text-transform:uppercase;letter-spacing:0.08em}.sidebar-group-header{font-family:'Geist Mono', ui-monospace, monospace;font-size:0.6875rem;font-weight:500;text-transform:uppercase;letter-spacing:0.08em;color:#716f6c}.dark .sidebar-group-header{color:#8a8785}.card{border-radius:var(--roark-radius-card)}.dark .card{background-color:#1a1918;border-color:rgba(255, 255, 255, 0.07)}.card [data-component-part=\"card-icon\"]{width:2.75rem;height:2.75rem;display:flex;align-items:center;justify-content:center;background:var(--roark-accent-subtle);border-radius:12px}[data-component-part=\"step-number\"]>div{font-family:'Geist Mono', ui-monospace, monospace;background:var(--roark-accent-subtle);color:var(--roark-accent)}#content-area hr{margin-top:2.5rem;margin-bottom:2.5rem;border-color:var(--roark-border)}.prose h2{margin-top:2.75rem}#sidebar{border-right:1px solid var(--roark-border)}img.nav-logo{height:1.75rem}#content-area img,#content-area video,#content-area iframe{border-radius:var(--roark-radius-card)}#content-area img{border:1px solid rgba(0, 0, 0, 0.06);box-shadow:0 1px 3px rgba(0, 0, 0, 0.04), 0 8px 24px rgba(0, 0, 0, 0.03)}.dark #content-area img{border-color:rgba(255, 255, 255, 0.06);box-shadow:0 1px 3px rgba(0, 0, 0, 0.3), 0 8px 24px rgba(0, 0, 0, 0.2)}#content-area img.nav-logo{border:none;box-shadow:none;border-radius:0}::-webkit-scrollbar{width:10px;height:10px}::-webkit-scrollbar-thumb{background:#d6d2cc;border-radius:5px;border:2px solid transparent;background-clip:content-box}.dark ::-webkit-scrollbar-thumb{background:#3a3835;border-radius:5px;border:2px solid transparent;background-clip:content-box}::-webkit-scrollbar-track{background:transparent}a,button{transition-timing-function:var(--roark-ease)}button.group>.shrink-0:first-child:has(>svg){width:2rem}"}],"page":{"pagePath":"api-reference/customer-flow/add-an-edge-case","slug":"/api-reference/customer-flow/add-an-edge-case","pageMetadata":{"title":"Add an edge case","description":"Adds a variant to an IMPROV flow.\n\nA scripted flow's variants are owned by the path engine, one per path through the graph, so they are\ncreated by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here.\n\nLeave personaOverrideId or environmentId unset to inherit the happy path's.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow/{flowId}/edge-case","href":"/api-reference/customer-flow/add-an-edge-case","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Adds a variant to an IMPROV flow.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"A scripted flow’s variants are owned by the path engine, one per path through the graph, so they are\\ncreated by editing the graph through PUT /v1/customer-flow/\", \"/graph rather than here.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Leave personaOverrideId or environmentId unset to inherit the happy path’s.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"everforest-light","dark":"everforest-dark"}},"config":{},"pageMetadata":{"title":"Add an edge case","description":"Adds a variant to an IMPROV flow.\n\nA scripted flow's variants are owned by the path engine, one per path through the graph, so they are\ncreated by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here.\n\nLeave personaOverrideId or environmentId unset to inherit the happy path's.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow/{flowId}/edge-case","href":"/api-reference/customer-flow/add-an-edge-case","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"201":"9d0c840e-b945-40c9-8865-5539cc0d322d","400":"1736cd74-cfb6-4755-b2ad-ee7ca0d873fa","401":"6a8550c3-2aef-4582-b198-a29dd7f67cbc","403":"3cd94cde-47ee-4661-9c35-71538103002d","404":"7142a948-0e89-4c33-8e9b-6412da6743b6","429":"79320e88-80d6-414c-bd39-46e8f5c4b23d","500":"a02ad741-51b9-4ece-b39c-40a62c3eba00"},"operationId":"postV1Customer-flowByFlowIdEdge-case","tags":["Customer Flow"],"summary":"Add an edge case","description":"Adds a variant to an IMPROV flow.\n\nA scripted flow's variants are owned by the path engine, one per path through the graph, so they are\ncreated by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here.\n\nLeave personaOverrideId or environmentId unset to inherit the happy path's.","parameters":["a80bd4d5-e673-498f-8d7d-ebc0a06ea259"],"requestBody":"f2c5da48-8388-4d98-917e-92c6aa919311","x-codeSamples":[{"lang":"JavaScript","source":"import Roark from '@roarkanalytics/sdk';\n\nconst client = new Roark({\n bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted\n});\n\nconst response = await client.customerFlowEdgeCase.add('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {\n title: 'x',\n});\n\nconsole.log(response.data);"},{"lang":"Python","source":"import os\nfrom roark_analytics import Roark\n\nclient = Roark(\n bearer_token=os.environ.get(\"ROARK_API_BEARER_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.customer_flow_edge_case.add(\n flow_id=\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n title=\"x\",\n)\nprint(response.data)"}],"method":"post","type":"path","servers":["79950302-db94-4418-b7ae-04b5133c6b9a"],"security":["1c4229f5-8a45-4b8d-98d0-c524e543fb6d"],"path":"/v1/customer-flow/{flowId}/edge-case","baseUrlOptions":["https://api.roark.ai"],"title":"Add an edge case","codeSamples":[{"lang":"JavaScript","source":"import Roark from '@roarkanalytics/sdk';\n\nconst client = new Roark({\n bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted\n});\n\nconst response = await client.customerFlowEdgeCase.add('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', {\n title: 'x',\n});\n\nconsole.log(response.data);"},{"lang":"Python","source":"import os\nfrom roark_analytics import Roark\n\nclient = Roark(\n bearer_token=os.environ.get(\"ROARK_API_BEARER_TOKEN\"), # This is the default and can be omitted\n)\nresponse = client.customer_flow_edge_case.add(\n flow_id=\"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e\",\n title=\"x\",\n)\nprint(response.data)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"a80bd4d5-e673-498f-8d7d-ebc0a06ea259":{"in":"path","name":"flowId","schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"title","typeLabel":"string"},"environmentId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"environmentId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"environmentId.oneOf.1","typeLabel":"null"}],"uniqueKey":"environmentId","typeLabel":"string\u003cuuid> | null"},"prompt":{"oneOf":[{"type":"string","description":"The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:\u003cemotion>}`, `#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See \"Caller cues\" in the customer flows concept.","uniqueKey":"prompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brief the simulated customer improvises from. Caller cues steer the caller from that point in the brief: `#{emotion:\u003cemotion>}`, `#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See \"Caller cues\" in the customer flows concept.","uniqueKey":"prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt","typeLabel":"string | null"},"openingLine":{"oneOf":[{"type":"string","uniqueKey":"openingLine.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"openingLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"openingLine","typeLabel":"string | null"},"precededByCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"precededByCustomerFlowId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"precededByCustomerFlowId.oneOf.1","typeLabel":"null"}],"uniqueKey":"precededByCustomerFlowId","typeLabel":"string\u003cuuid> | null"},"precededByCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"precededByCustomerFlowVariantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"precededByCustomerFlowVariantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"precededByCustomerFlowVariantId","typeLabel":"string\u003cuuid> | null"},"includeFlowExpectations":{"type":"boolean","description":"Whether this edge case is graded on the flow's agentExpectations as well as its own additionalExpectations. Defaults to true; false grades it on its additionalExpectations only.","uniqueKey":"includeFlowExpectations","typeLabel":"boolean"},"additionalExpectations":{"type":"array","items":{"type":"object","properties":{"prompt":{"type":"string","minLength":1,"description":"What the agent under test is graded against.","example":"The agent confirmed the new appointment time back to the customer","isRequired":true,"uniqueKey":"additionalExpectations.items.[INDEX].prompt","typeLabel":"string"}},"required":["prompt"],"uniqueKey":"additionalExpectations.items.[INDEX]","typeLabel":"object"},"description":"The expectations graded on this variant only, on top of the flow's own. Sent as the complete set: it replaces whatever the variant had, so omit it to leave the set alone and send [] to clear it. Improv flows only: a scripted variant's expectations come from the agent turns on its path and are rewritten on every graph edit.","uniqueKey":"additionalExpectations","typeLabel":"object[]"},"personaOverrideId":{"oneOf":[{"type":"string","format":"uuid","description":"The persona this runs as. Omit to inherit the happy path's.","uniqueKey":"personaOverrideId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The persona this runs as. Omit to inherit the happy path's.","uniqueKey":"personaOverrideId.oneOf.1","typeLabel":"null"}],"uniqueKey":"personaOverrideId","typeLabel":"string\u003cuuid> | null"}},"required":["title"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"title":"\u003cstring>","environmentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","prompt":"\u003cstring>","openingLine":"\u003cstring>","precededByCustomerFlowId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","precededByCustomerFlowVariantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","includeFlowExpectations":true,"additionalExpectations":[{"prompt":"The agent confirmed the new appointment time back to the customer"}],"personaOverrideId":"3c90c3cc-0d44-4b50-8888-8dd25736052a"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9d0c840e-b945-40c9-8865-5539cc0d322d":{"description":"The edge case that was added","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"type":"object","title":"Scripted","description":"One way of running a customer flow.","required":["id","title","precededByCustomerFlowId","precededByCustomerFlowVariantId","isGenerated","includeFlowExpectations","createdAt","updatedAt","personaOverride","environment","additionalExpectations","type","steps"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.0.title","typeLabel":"string"},"precededByCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowId","typeLabel":"string\u003cuuid> | null"},"precededByCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowVariantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowVariantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.precededByCustomerFlowVariantId","typeLabel":"string\u003cuuid> | null"},"isGenerated":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"data.oneOf.0.isGenerated","typeLabel":"boolean"},"includeFlowExpectations":{"type":"boolean","description":"Whether this variant is graded on the flow's agentExpectations as well as its additionalExpectations. False grades it on its additionalExpectations only. Always true on the happy path.","isRequired":true,"uniqueKey":"data.oneOf.0.includeFlowExpectations","typeLabel":"boolean"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.0.updatedAt","typeLabel":"string"},"personaOverride":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name the agent will identify as during conversations","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.name","typeLabel":"string"},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.language","typeLabel":"enum\u003cstring>"},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.understoodLanguages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.understoodLanguages","typeLabel":"enum\u003cstring>[]"},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.accent","typeLabel":"enum\u003cstring>"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.age","typeLabel":"enum\u003cstring>"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.gender","typeLabel":"enum\u003cstring>"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.speechPace","typeLabel":"enum\u003cstring>"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.speechClarity","typeLabel":"enum\u003cstring>"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\"","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.hasDisfluencies","typeLabel":"boolean"},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.baseEmotion","typeLabel":"enum\u003cstring>"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.intentClarity","typeLabel":"enum\u003cstring>"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.confirmationStyle","typeLabel":"enum\u003cstring>"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.memoryReliability","typeLabel":"enum\u003cstring>"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.responseTiming","typeLabel":"enum\u003cstring>"},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.interruption","typeLabel":"enum\u003cstring>"},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessages.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessages.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessages","typeLabel":"string[] | null"},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleTimeoutSeconds","typeLabel":"integer"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessageMaxSpokenCount","typeLabel":"integer"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.idleMessageResetCountOnUserSpeechEnabled","typeLabel":"boolean"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.properties.additionalProperties","typeLabel":"any"},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.properties","typeLabel":"object"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.updatedAt","typeLabel":"string"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.displayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.displayName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.description","typeLabel":"string | null"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.secondaryLanguage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.secondaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.secondaryLanguage","typeLabel":"enum\u003cstring> | null"},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.backstoryPrompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.backstoryPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.backstoryPrompt","typeLabel":"string | null"},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919","uniqueKey":"data.oneOf.0.personaOverride.oneOf.0.phoneNumber","typeLabel":"string"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona"},"name":{"type":"string","description":"The name the agent will identify as during conversations"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."}]},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona"},{"type":"null","description":"Human-readable description of the persona"}]},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"}]},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"]},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support."},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports."},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\""},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`."},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level."},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"}]},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."}]},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}]},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"}},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919"},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.personaOverride","typeLabel":"object | null"},"environment":{"oneOf":[{"type":"object","description":"The conditions this runs under. Null means it inherits the happy path's.","required":["id","name","backgroundNoise","backgroundNoiseVolume","lineQuality","lineCustom","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.name","typeLabel":"string"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"backgroundNoiseVolume":{"type":"number","minimum":0,"maximum":1,"default":0.1,"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.backgroundNoiseVolume","typeLabel":"number"},"lineQuality":{"type":"string","enum":["CLEAR","MINOR_LOSS","CELL_EDGE","POOR_CONNECTION","ONE_WAY_DEGRADED","CUSTOM"],"description":"The phone line the simulated caller is on: packet loss applied to its 20 ms audio packets, per direction. The loss pattern is seeded per call, so a redial loses the same packets. CLEAR: No loss. MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways. ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM: the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with a mean burst of up to 10 packets (omit it for random loss).","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineQuality","typeLabel":"enum\u003cstring>"},"lineCustom":{"oneOf":[{"type":"object","description":"The loss of a CUSTOM line; null on every other.","properties":{"toAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.toAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.toAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The caller's audio on its way to the agent: what the agent hears. Omit for no loss.","uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.toAgent","typeLabel":"object"},"fromAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The agent's audio on its way to the caller: what the caller hears. Omit for no loss.","uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0.fromAgent","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.0","typeLabel":"object"},{"type":"null","description":"The loss of a CUSTOM line; null on every other.","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.lineCustom","typeLabel":"object | null"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0.updatedAt","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.environment.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.environment.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.environment.oneOf.0.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The conditions this runs under. Null means it inherits the happy path's.","isRequired":true,"uniqueKey":"data.oneOf.0.environment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.0.environment","typeLabel":"object | null"},"additionalExpectations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.0.additionalExpectations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"prompt":{"type":"string","description":"What the agent under test is graded against.","isRequired":true,"uniqueKey":"data.oneOf.0.additionalExpectations.items.[INDEX].prompt","typeLabel":"string"}},"required":["id","prompt"],"description":"One thing the agent under test is graded against.","uniqueKey":"data.oneOf.0.additionalExpectations.items.[INDEX]","typeLabel":"object"},"description":"Graded on top of the flow's own expectations, for this variant only.","isRequired":true,"uniqueKey":"data.oneOf.0.additionalExpectations","typeLabel":"object[]"},"type":{"type":"string","const":"SCRIPTED","isRequired":true,"uniqueKey":"data.oneOf.0.type","typeLabel":"string"},"steps":{"type":"array","items":{"oneOf":[{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"AGENT_TURN","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.endsCall","typeLabel":"boolean"},"content":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.content","typeLabel":"string | null"},"offScriptPolicy":{"oneOf":[{"type":"object","properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.reaction","typeLabel":"enum\u003cstring>"},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.maxAttempts","typeLabel":"integer"},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.then","typeLabel":"enum\u003cstring>"},"sayLine":{"oneOf":[{"type":"string","minLength":1,"maxLength":2000,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.sayLine.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":2000,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.sayLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.sayLine","typeLabel":"string | null"},"waitSeconds":{"oneOf":[{"type":"integer","minimum":1,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.waitSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.waitSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0.waitSeconds","typeLabel":"integer | null"}},"required":["reaction","maxAttempts","then"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT"},"sayLine":{"oneOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null","minLength":1,"maxLength":2000}]},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP"},"waitSeconds":{"oneOf":[{"type":"integer","minimum":1,"maximum":600},{"type":"null","minimum":1,"maximum":600}]}},"required":["reaction","maxAttempts","then"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0.offScriptPolicy","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_TURN","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.endsCall","typeLabel":"boolean"},"content":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1.content","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_FIRST_MESSAGE","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.endsCall","typeLabel":"boolean"},"content":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2.content","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_VERBATIM_TURN","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.endsCall","typeLabel":"boolean"},"content":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.content.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3.content","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_SILENCE","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.endsCall","typeLabel":"boolean"},"silenceDurationSeconds":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.silenceDurationSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.silenceDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4.silenceDurationSeconds","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.4","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_AUDIO","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.endsCall","typeLabel":"boolean"},"audioClip":{"oneOf":[{"type":"string","enum":["HOLD_MUSIC_CLASSICAL_PIANO","HOLD_MUSIC_CLASSICAL_ORCHESTRA","HOLD_MUSIC_STRING_QUARTET","HOLD_MUSIC_AMBIENT","HOLD_MUSIC_SMOOTH_JAZZ","HOLD_MUSIC_SOFT_SYNTH","HOLD_BEEP","RINGBACK_US","RINGBACK_UK"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.audioClip.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["HOLD_MUSIC_CLASSICAL_PIANO","HOLD_MUSIC_CLASSICAL_ORCHESTRA","HOLD_MUSIC_STRING_QUARTET","HOLD_MUSIC_AMBIENT","HOLD_MUSIC_SMOOTH_JAZZ","HOLD_MUSIC_SOFT_SYNTH","HOLD_BEEP","RINGBACK_US","RINGBACK_UK"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.audioClip.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.audioClip","typeLabel":"enum\u003cstring> | null"},"silenceDurationSeconds":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.silenceDurationSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.silenceDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5.silenceDurationSeconds","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.5","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_DTMF","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.endsCall","typeLabel":"boolean"},"dtmfDigits":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.dtmfDigits.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.dtmfDigits.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6.dtmfDigits","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.6","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"AGENT_DTMF","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.endsCall","typeLabel":"boolean"},"dtmfDigits":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.dtmfDigits.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.dtmfDigits.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.dtmfDigits","typeLabel":"string | null"},"offScriptPolicy":{"oneOf":[{"type":"object","properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.reaction","typeLabel":"enum\u003cstring>"},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.maxAttempts","typeLabel":"integer"},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.then","typeLabel":"enum\u003cstring>"},"sayLine":{"oneOf":[{"type":"string","minLength":1,"maxLength":2000,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.sayLine.oneOf.0","typeLabel":"string"},{"type":"null","minLength":1,"maxLength":2000,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.sayLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.sayLine","typeLabel":"string | null"},"waitSeconds":{"oneOf":[{"type":"integer","minimum":1,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.waitSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":600,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.waitSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0.waitSeconds","typeLabel":"integer | null"}},"required":["reaction","maxAttempts","then"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT"},"sayLine":{"oneOf":[{"type":"string","minLength":1,"maxLength":2000},{"type":"null","minLength":1,"maxLength":2000}]},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP"},"waitSeconds":{"oneOf":[{"type":"integer","minimum":1,"maximum":600},{"type":"null","minimum":1,"maximum":600}]}},"required":["reaction","maxAttempts","then"],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7.offScriptPolicy","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.7","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"VOICEMAIL","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8.endsCall","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.8","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_HANDOFF","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.endsCall","typeLabel":"boolean"},"handoffPersonaId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.handoffPersonaId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.handoffPersonaId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9.handoffPersonaId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.9","typeLabel":"object"},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"SCENARIO_LINK","isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.type","typeLabel":"string"},"nodeId":{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.nodeId","typeLabel":"string\u003cuuid>"},"ref":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.ref","typeLabel":"string"},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.steps","typeLabel":"array"},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.mergeIntoNodeIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.mergeIntoNodeIds","typeLabel":"string[]"},"stage":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage.oneOf.0.name","typeLabel":"string"},"required":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage.oneOf.0.required","typeLabel":"boolean"},"analyze":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage.oneOf.0.analyze","typeLabel":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"required":["name"],"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.stage","typeLabel":"object | null"},"endsCall":{"type":"boolean","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.endsCall","typeLabel":"boolean"},"linkedCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowId","typeLabel":"string\u003cuuid> | null"},"linkedCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowVariantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowVariantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10.linkedCustomerFlowVariantId","typeLabel":"string\u003cuuid> | null"}},"additionalProperties":false,"uniqueKey":"data.oneOf.0.steps.items.[INDEX].oneOf.10","typeLabel":"object"}],"uniqueKey":"data.oneOf.0.steps.items.[INDEX]","typeLabel":"object"},"description":"The one path through the graph this variant runs, in order. Linear by construction, so these steps never nest.","isRequired":true,"uniqueKey":"data.oneOf.0.steps","typeLabel":"object[]"},"systemKey":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.systemKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.systemKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.systemKey","typeLabel":"string | null"},"openingLine":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.0.openingLine.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.0.openingLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.0.openingLine","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.0","typeLabel":"Scripted · object"},{"type":"object","title":"Improv","description":"One way of running a customer flow.","required":["id","title","precededByCustomerFlowId","precededByCustomerFlowVariantId","isGenerated","includeFlowExpectations","createdAt","updatedAt","personaOverride","environment","additionalExpectations","type","handoffPersonas"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.1.title","typeLabel":"string"},"precededByCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowId","typeLabel":"string\u003cuuid> | null"},"precededByCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowVariantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowVariantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.precededByCustomerFlowVariantId","typeLabel":"string\u003cuuid> | null"},"isGenerated":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"data.oneOf.1.isGenerated","typeLabel":"boolean"},"includeFlowExpectations":{"type":"boolean","description":"Whether this variant is graded on the flow's agentExpectations as well as its additionalExpectations. False grades it on its additionalExpectations only. Always true on the happy path.","isRequired":true,"uniqueKey":"data.oneOf.1.includeFlowExpectations","typeLabel":"boolean"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.1.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.1.updatedAt","typeLabel":"string"},"personaOverride":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name the agent will identify as during conversations","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.name","typeLabel":"string"},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.language","typeLabel":"enum\u003cstring>"},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.understoodLanguages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.understoodLanguages","typeLabel":"enum\u003cstring>[]"},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.accent","typeLabel":"enum\u003cstring>"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.age","typeLabel":"enum\u003cstring>"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.gender","typeLabel":"enum\u003cstring>"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.speechPace","typeLabel":"enum\u003cstring>"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.speechClarity","typeLabel":"enum\u003cstring>"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\"","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.hasDisfluencies","typeLabel":"boolean"},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.baseEmotion","typeLabel":"enum\u003cstring>"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.intentClarity","typeLabel":"enum\u003cstring>"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.confirmationStyle","typeLabel":"enum\u003cstring>"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.memoryReliability","typeLabel":"enum\u003cstring>"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.responseTiming","typeLabel":"enum\u003cstring>"},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.interruption","typeLabel":"enum\u003cstring>"},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessages.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessages.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessages","typeLabel":"string[] | null"},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleTimeoutSeconds","typeLabel":"integer"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessageMaxSpokenCount","typeLabel":"integer"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.idleMessageResetCountOnUserSpeechEnabled","typeLabel":"boolean"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.properties.additionalProperties","typeLabel":"any"},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.properties","typeLabel":"object"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.updatedAt","typeLabel":"string"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.displayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.displayName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.description","typeLabel":"string | null"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.secondaryLanguage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.secondaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.secondaryLanguage","typeLabel":"enum\u003cstring> | null"},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.backstoryPrompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.backstoryPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.backstoryPrompt","typeLabel":"string | null"},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919","uniqueKey":"data.oneOf.1.personaOverride.oneOf.0.phoneNumber","typeLabel":"string"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona"},"name":{"type":"string","description":"The name the agent will identify as during conversations"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."}]},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona"},{"type":"null","description":"Human-readable description of the persona"}]},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"}]},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"]},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support."},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports."},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\""},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`."},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level."},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"}]},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."}]},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}]},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"}},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919"},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.personaOverride","typeLabel":"object | null"},"environment":{"oneOf":[{"type":"object","description":"The conditions this runs under. Null means it inherits the happy path's.","required":["id","name","backgroundNoise","backgroundNoiseVolume","lineQuality","lineCustom","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.name","typeLabel":"string"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"backgroundNoiseVolume":{"type":"number","minimum":0,"maximum":1,"default":0.1,"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.backgroundNoiseVolume","typeLabel":"number"},"lineQuality":{"type":"string","enum":["CLEAR","MINOR_LOSS","CELL_EDGE","POOR_CONNECTION","ONE_WAY_DEGRADED","CUSTOM"],"description":"The phone line the simulated caller is on: packet loss applied to its 20 ms audio packets, per direction. The loss pattern is seeded per call, so a redial loses the same packets. CLEAR: No loss. MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways. ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM: the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with a mean burst of up to 10 packets (omit it for random loss).","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineQuality","typeLabel":"enum\u003cstring>"},"lineCustom":{"oneOf":[{"type":"object","description":"The loss of a CUSTOM line; null on every other.","properties":{"toAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.toAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.toAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The caller's audio on its way to the agent: what the agent hears. Omit for no loss.","uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.toAgent","typeLabel":"object"},"fromAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The agent's audio on its way to the caller: what the caller hears. Omit for no loss.","uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0.fromAgent","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.0","typeLabel":"object"},{"type":"null","description":"The loss of a CUSTOM line; null on every other.","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.lineCustom","typeLabel":"object | null"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0.updatedAt","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.environment.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.1.environment.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.environment.oneOf.0.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The conditions this runs under. Null means it inherits the happy path's.","isRequired":true,"uniqueKey":"data.oneOf.1.environment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.environment","typeLabel":"object | null"},"additionalExpectations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.1.additionalExpectations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"prompt":{"type":"string","description":"What the agent under test is graded against.","isRequired":true,"uniqueKey":"data.oneOf.1.additionalExpectations.items.[INDEX].prompt","typeLabel":"string"}},"required":["id","prompt"],"description":"One thing the agent under test is graded against.","uniqueKey":"data.oneOf.1.additionalExpectations.items.[INDEX]","typeLabel":"object"},"description":"Graded on top of the flow's own expectations, for this variant only.","isRequired":true,"uniqueKey":"data.oneOf.1.additionalExpectations","typeLabel":"object[]"},"type":{"type":"string","const":"IMPROV","isRequired":true,"uniqueKey":"data.oneOf.1.type","typeLabel":"string"},"handoffPersonas":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name the agent will identify as during conversations","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].name","typeLabel":"string"},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].language","typeLabel":"enum\u003cstring>"},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].understoodLanguages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].understoodLanguages","typeLabel":"enum\u003cstring>[]"},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].accent","typeLabel":"enum\u003cstring>"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].age","typeLabel":"enum\u003cstring>"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].gender","typeLabel":"enum\u003cstring>"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].backgroundNoise","typeLabel":"enum\u003cstring>"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].speechPace","typeLabel":"enum\u003cstring>"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].speechClarity","typeLabel":"enum\u003cstring>"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\"","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].hasDisfluencies","typeLabel":"boolean"},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].baseEmotion","typeLabel":"enum\u003cstring>"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].intentClarity","typeLabel":"enum\u003cstring>"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].confirmationStyle","typeLabel":"enum\u003cstring>"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].memoryReliability","typeLabel":"enum\u003cstring>"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].responseTiming","typeLabel":"enum\u003cstring>"},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].interruption","typeLabel":"enum\u003cstring>"},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessages.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessages.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessages","typeLabel":"string[] | null"},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleTimeoutSeconds","typeLabel":"integer"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessageMaxSpokenCount","typeLabel":"integer"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].idleMessageResetCountOnUserSpeechEnabled","typeLabel":"boolean"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].properties.additionalProperties","typeLabel":"any"},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].properties","typeLabel":"object"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].updatedAt","typeLabel":"string"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].displayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].displayName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].description","typeLabel":"string | null"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].secondaryLanguage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].secondaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].secondaryLanguage","typeLabel":"enum\u003cstring> | null"},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].backstoryPrompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].backstoryPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].backstoryPrompt","typeLabel":"string | null"},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919","uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX].phoneNumber","typeLabel":"string"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"uniqueKey":"data.oneOf.1.handoffPersonas.items.[INDEX]","typeLabel":"object"},"description":"The personas this brief hands the phone to, in order of first mention. Empty when the brief inherits the happy path's: read the happy path's list.","isRequired":true,"uniqueKey":"data.oneOf.1.handoffPersonas","typeLabel":"object[]"},"systemKey":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.1.systemKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.1.systemKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.systemKey","typeLabel":"string | null"},"openingLine":{"oneOf":[{"type":"string","description":"What the simulated customer says word for word as the call connects. Null on an edge case inherits the happy path's; null on the happy path waits for your agent to speak first. Ignored when a preceding flow runs first. Cannot use {{variables}}.","uniqueKey":"data.oneOf.1.openingLine.oneOf.0","typeLabel":"string"},{"type":"null","description":"What the simulated customer says word for word as the call connects. Null on an edge case inherits the happy path's; null on the happy path waits for your agent to speak first. Ignored when a preceding flow runs first. Cannot use {{variables}}.","uniqueKey":"data.oneOf.1.openingLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.openingLine","typeLabel":"string | null"},"prompt":{"oneOf":[{"type":"string","description":"The brief the simulated customer improvises from. A `@{persona:\u003cid>}` mention hands the phone to that persona mid-call; the sentences around the mention say when. Caller cues steer the caller from that point in the brief: `#{emotion:\u003cemotion>}`, `#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See \"Caller cues\" in the customer flows concept.","uniqueKey":"data.oneOf.1.prompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"The brief the simulated customer improvises from. A `@{persona:\u003cid>}` mention hands the phone to that persona mid-call; the sentences around the mention say when. Caller cues steer the caller from that point in the brief: `#{emotion:\u003cemotion>}`, `#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when to cut in on your agent. Cues are voice only. See \"Caller cues\" in the customer flows concept.","uniqueKey":"data.oneOf.1.prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.1.prompt","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.1","typeLabel":"Improv · object"},{"type":"object","title":"Voicemail","description":"One way of running a customer flow.","required":["id","title","precededByCustomerFlowId","precededByCustomerFlowVariantId","isGenerated","includeFlowExpectations","createdAt","updatedAt","personaOverride","environment","additionalExpectations","type"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.2.title","typeLabel":"string"},"precededByCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowId","typeLabel":"string\u003cuuid> | null"},"precededByCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowVariantId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowVariantId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.precededByCustomerFlowVariantId","typeLabel":"string\u003cuuid> | null"},"isGenerated":{"type":"boolean","default":false,"isRequired":true,"uniqueKey":"data.oneOf.2.isGenerated","typeLabel":"boolean"},"includeFlowExpectations":{"type":"boolean","description":"Whether this variant is graded on the flow's agentExpectations as well as its additionalExpectations. False grades it on its additionalExpectations only. Always true on the happy path.","isRequired":true,"uniqueKey":"data.oneOf.2.includeFlowExpectations","typeLabel":"boolean"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.2.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.2.updatedAt","typeLabel":"string"},"personaOverride":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name the agent will identify as during conversations","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.name","typeLabel":"string"},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.language","typeLabel":"enum\u003cstring>"},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.understoodLanguages.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.understoodLanguages","typeLabel":"enum\u003cstring>[]"},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.accent","typeLabel":"enum\u003cstring>"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.age","typeLabel":"enum\u003cstring>"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.gender","typeLabel":"enum\u003cstring>"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.speechPace","typeLabel":"enum\u003cstring>"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.speechClarity","typeLabel":"enum\u003cstring>"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\"","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.hasDisfluencies","typeLabel":"boolean"},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.baseEmotion","typeLabel":"enum\u003cstring>"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.intentClarity","typeLabel":"enum\u003cstring>"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.confirmationStyle","typeLabel":"enum\u003cstring>"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.memoryReliability","typeLabel":"enum\u003cstring>"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.responseTiming","typeLabel":"enum\u003cstring>"},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.interruption","typeLabel":"enum\u003cstring>"},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessages.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessages.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessages","typeLabel":"string[] | null"},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleTimeoutSeconds","typeLabel":"integer"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessageMaxSpokenCount","typeLabel":"integer"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.idleMessageResetCountOnUserSpeechEnabled","typeLabel":"boolean"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.properties.additionalProperties","typeLabel":"any"},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.properties","typeLabel":"object"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.updatedAt","typeLabel":"string"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.displayName.oneOf.0","typeLabel":"string"},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself.","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.displayName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable description of the persona","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.description","typeLabel":"string | null"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.secondaryLanguage.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.secondaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.secondaryLanguage","typeLabel":"enum\u003cstring> | null"},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.backstoryPrompt.oneOf.0","typeLabel":"string"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.backstoryPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.backstoryPrompt","typeLabel":"string | null"},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919","uniqueKey":"data.oneOf.2.personaOverride.oneOf.0.phoneNumber","typeLabel":"string"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona"},"name":{"type":"string","description":"The name the agent will identify as during conversations"},"displayName":{"oneOf":[{"type":"string","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."},{"type":"null","description":"Label shown in place of the name across the dashboard (e.g. a short descriptor like \"Irate Escalator\"). The persona still identifies as `name` on calls. Omit or set null to display the name itself."}]},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona"},{"type":"null","description":"Human-readable description of the persona"}]},"language":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"],"description":"Primary language ISO 639-1 code for the persona"},"secondaryLanguage":{"oneOf":[{"type":"string","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"},{"type":"null","enum":["EN"],"description":"Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)"}]},"understoodLanguages":{"type":"array","items":{"type":"string","enum":["EN","ES","DE","HI","FR","NL","AR","EL","IT","ID","TH","JA","TL","MS","ZH","TR","PT","HE"]},"minItems":1,"description":"Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support."},"accent":{"type":"string","enum":["US","US_X_SOUTH","GB","ES","DE","IN","FR","NL","SA","GR","AU","IT","ID","TH","JP","NZ","PH","SG","MY","HK","TR","PT","IL"],"description":"Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants"},"age":{"type":"string","enum":["CHILD","TEENAGER","ADULT","ELDERLY"],"default":"ADULT","description":"How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports."},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","description":"Background noise setting"},"speechPace":{"type":"string","enum":["SUPER_SLOW","SLOW","NORMAL","FAST","SUPER_FAST"],"default":"NORMAL","description":"Speech pace of the persona"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\""},"baseEmotion":{"type":"string","enum":["NEUTRAL","CHEERFUL","CONFUSED","FRUSTRATED","SKEPTICAL","RUSHED","DISTRACTED","ANGRY","ANXIOUS","SAD"],"default":"NEUTRAL","description":"Base emotional state of the persona"},"intentClarity":{"type":"string","enum":["CLEAR","INDIRECT","VAGUE"],"default":"CLEAR","description":"How clearly the persona expresses their intentions"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is"},"responseTiming":{"type":"string","enum":["RELAXED","NORMAL","QUICK","BARGE_IN"],"default":"NORMAL","description":"Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use `interruption` for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as `responseTiming: QUICK` with `interruption: OCCASIONAL`."},"interruption":{"type":"string","enum":["OFF","BACKCHANNEL","OCCASIONAL","HEAVY"],"default":"OFF","description":"How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises (\"mm-hm\") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL also cuts in where a caller like this plausibly would, and HEAVY does so readily, though never on every turn. The moments are chosen from what the agent is saying, such as reading back a number or starting a long explanation, not on a timer. A customer flow can also say exactly when to cut in, which applies at any level."},"backstoryPrompt":{"oneOf":[{"type":"string","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"},{"type":"null","description":"Background story and behavioral patterns for the persona","example":"A busy professional calling during lunch break"}]},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."},{"type":"null","items":{"type":"string"},"description":"Messages the persona will say when the agent goes silent during a call. null = \"Automatic\": language-appropriate defaults are used at call time."}]},"idleTimeoutSeconds":{"type":"integer","minimum":5,"maximum":60,"default":10,"description":"Seconds of silence before the persona sends an idle message"},"idleMessageMaxSpokenCount":{"type":"integer","minimum":1,"maximum":10,"default":3,"description":"Maximum number of idle messages the persona will send before giving up"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}]},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"}},"phoneNumber":{"type":"string","description":"The E.164 number every call with this persona uses, when Roark has pinned one for your project. Present only when set; read-only.","example":"+19312830919"},"createdAt":{"type":"string","description":"Creation timestamp"},"updatedAt":{"type":"string","description":"Last update timestamp"}},"required":["id","name","language","understoodLanguages","accent","age","gender","backgroundNoise","speechPace","speechClarity","hasDisfluencies","baseEmotion","intentClarity","confirmationStyle","memoryReliability","responseTiming","interruption","idleMessages","idleTimeoutSeconds","idleMessageMaxSpokenCount","idleMessageResetCountOnUserSpeechEnabled","properties","createdAt","updatedAt"],"description":"The persona this runs as instead of the happy path's. Null means it inherits.","isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.personaOverride","typeLabel":"object | null"},"environment":{"oneOf":[{"type":"object","description":"The conditions this runs under. Null means it inherits the happy path's.","required":["id","name","backgroundNoise","backgroundNoiseVolume","lineQuality","lineCustom","createdAt","updatedAt"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.name","typeLabel":"string"},"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"default":"NONE","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.backgroundNoise","typeLabel":"enum\u003cstring>"},"backgroundNoiseVolume":{"type":"number","minimum":0,"maximum":1,"default":0.1,"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.backgroundNoiseVolume","typeLabel":"number"},"lineQuality":{"type":"string","enum":["CLEAR","MINOR_LOSS","CELL_EDGE","POOR_CONNECTION","ONE_WAY_DEGRADED","CUSTOM"],"description":"The phone line the simulated caller is on: packet loss applied to its 20 ms audio packets, per direction. The loss pattern is seeded per call, so a redial loses the same packets. CLEAR: No loss. MINOR_LOSS: 1% random, both ways. CELL_EDGE: 5% in 80 ms gaps, both ways. POOR_CONNECTION: 10% in 120 ms gaps, both ways. ONE_WAY_DEGRADED: 8% in 80 ms gaps, toward the agent only. CUSTOM: the per-direction loss in `lineCustom`, up to 20% in 0.5 steps, with a mean burst of up to 10 packets (omit it for random loss).","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineQuality","typeLabel":"enum\u003cstring>"},"lineCustom":{"oneOf":[{"type":"object","description":"The loss of a CUSTOM line; null on every other.","properties":{"toAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.toAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.toAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The caller's audio on its way to the agent: what the agent hears. Omit for no loss.","uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.toAgent","typeLabel":"object"},"fromAgent":{"type":"object","properties":{"packetLossPercent":{"type":"number","multipleOf":0.5,"minimum":0,"maximum":20,"description":"Share of packets lost, 0 to 20 in steps of 0.5.","example":3,"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.packetLossPercent","typeLabel":"number"},"meanBurstPackets":{"type":"integer","minimum":2,"maximum":10,"description":"Mean length of a loss gap in 20 ms packets, 2 to 10. Omit for random loss.","example":3,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.fromAgent.meanBurstPackets","typeLabel":"integer"}},"required":["packetLossPercent"],"description":"The agent's audio on its way to the caller: what the caller hears. Omit for no loss.","uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0.fromAgent","typeLabel":"object"}},"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.0","typeLabel":"object"},{"type":"null","description":"The loss of a CUSTOM line; null on every other.","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.lineCustom","typeLabel":"object | null"},"createdAt":{"type":"string","description":"Creation timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp in ISO 8601 format","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0.updatedAt","typeLabel":"string"},"description":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.2.environment.oneOf.0.description.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.2.environment.oneOf.0.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.environment.oneOf.0.description","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.0","typeLabel":"object"},{"type":"null","description":"The conditions this runs under. Null means it inherits the happy path's.","isRequired":true,"uniqueKey":"data.oneOf.2.environment.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.oneOf.2.environment","typeLabel":"object | null"},"additionalExpectations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.oneOf.2.additionalExpectations.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"prompt":{"type":"string","description":"What the agent under test is graded against.","isRequired":true,"uniqueKey":"data.oneOf.2.additionalExpectations.items.[INDEX].prompt","typeLabel":"string"}},"required":["id","prompt"],"description":"One thing the agent under test is graded against.","uniqueKey":"data.oneOf.2.additionalExpectations.items.[INDEX]","typeLabel":"object"},"description":"Graded on top of the flow's own expectations, for this variant only.","isRequired":true,"uniqueKey":"data.oneOf.2.additionalExpectations","typeLabel":"object[]"},"type":{"type":"string","const":"VOICEMAIL","isRequired":true,"uniqueKey":"data.oneOf.2.type","typeLabel":"string"},"systemKey":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.2.systemKey.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.2.systemKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.systemKey","typeLabel":"string | null"},"openingLine":{"oneOf":[{"type":"string","uniqueKey":"data.oneOf.2.openingLine.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.oneOf.2.openingLine.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.oneOf.2.openingLine","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.oneOf.2","typeLabel":"Voicemail · object"}],"isRequired":true,"uniqueKey":"data","typeLabel":"Scripted · object | Improv · object | Voicemail · object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","title":"\u003cstring>","precededByCustomerFlowId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","precededByCustomerFlowVariantId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","isGenerated":false,"includeFlowExpectations":true,"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","personaOverride":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","language":"EN","understoodLanguages":["EN"],"accent":"US","age":"ADULT","gender":"MALE","backgroundNoise":"NONE","speechPace":"NORMAL","speechClarity":"CLEAR","hasDisfluencies":false,"baseEmotion":"NEUTRAL","intentClarity":"CLEAR","confirmationStyle":"EXPLICIT","memoryReliability":"HIGH","responseTiming":"NORMAL","interruption":"OFF","idleMessages":["\u003cstring>"],"idleTimeoutSeconds":10,"idleMessageMaxSpokenCount":3,"idleMessageResetCountOnUserSpeechEnabled":true,"properties":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","displayName":"\u003cstring>","description":"\u003cstring>","secondaryLanguage":"EN","backstoryPrompt":"A busy professional calling during lunch break","phoneNumber":"+19312830919"},"environment":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","backgroundNoise":"NONE","backgroundNoiseVolume":0.1,"lineQuality":"CLEAR","lineCustom":{"toAgent":{"packetLossPercent":3,"meanBurstPackets":3},"fromAgent":{"packetLossPercent":3,"meanBurstPackets":3}},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","description":"\u003cstring>"},"additionalExpectations":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","prompt":"\u003cstring>"}],"type":"SCRIPTED","steps":[{"type":"AGENT_TURN","nodeId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","ref":"\u003cstring>","steps":"\u003carray>","mergeIntoNodeIds":["\u003cstring>"],"stage":{"name":"\u003cstring>","required":true,"analyze":true},"endsCall":true,"content":"\u003cstring>","offScriptPolicy":{"reaction":"STAY_SILENT","maxAttempts":3,"then":"HANG_UP","sayLine":"\u003cstring>","waitSeconds":300}}],"systemKey":"\u003cstring>","openingLine":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"1736cd74-cfb6-4755-b2ad-ee7ca0d873fa":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Validation error","uniqueKey":"","typeLabel":"object"},"example":{"type":"validation","code":"invalid_parameter","message":"The request was invalid","param":"email"},"examples":{"Example":{"title":"Example","value":{"type":"validation","code":"invalid_parameter","message":"The request was invalid","param":"email"}}},"exampleType":"examples"}},"description":"Bad Request","exampleType":"examples"},"6a8550c3-2aef-4582-b198-a29dd7f67cbc":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Authentication error","uniqueKey":"","typeLabel":"object"},"example":{"type":"authentication","code":"unauthorized","message":"Authentication required"},"examples":{"Example":{"title":"Example","value":{"type":"authentication","code":"unauthorized","message":"Authentication required"}}},"exampleType":"examples"}},"description":"Unauthorized","exampleType":"examples"},"3cd94cde-47ee-4661-9c35-71538103002d":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Permission error","uniqueKey":"","typeLabel":"object"},"example":{"type":"forbidden","code":"permission_denied","message":"You do not have permission to access this resource"},"examples":{"Example":{"title":"Example","value":{"type":"forbidden","code":"permission_denied","message":"You do not have permission to access this resource"}}},"exampleType":"examples"}},"description":"Forbidden","exampleType":"examples"},"7142a948-0e89-4c33-8e9b-6412da6743b6":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Not found error","uniqueKey":"","typeLabel":"object"},"example":{"type":"not_found","code":"resource_not_found","message":"The requested resource could not be found"},"examples":{"Example":{"title":"Example","value":{"type":"not_found","code":"resource_not_found","message":"The requested resource could not be found"}}},"exampleType":"examples"}},"description":"Not Found","exampleType":"examples"},"79320e88-80d6-414c-bd39-46e8f5c4b23d":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Rate limit error","uniqueKey":"","typeLabel":"object"},"example":{"type":"rate_limit","code":"too_many_requests","message":"Rate limit exceeded"},"examples":{"Example":{"title":"Example","value":{"type":"rate_limit","code":"too_many_requests","message":"Rate limit exceeded"}}},"exampleType":"examples"}},"description":"Too Many Requests","exampleType":"examples"},"a02ad741-51b9-4ece-b39c-40a62c3eba00":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","enum":["validation","authentication","forbidden","not_found","conflict","payment_required","rate_limit","internal"],"description":"The error type category","examples":["validation","authentication"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Machine-readable error code identifier","examples":["invalid_parameter","missing_required_field","unauthorized"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","examples":["The request was invalid","Authentication required"],"isRequired":true,"uniqueKey":"message","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error (if applicable)","examples":["email","user_id"],"uniqueKey":"param","typeLabel":"string"},"details":{"description":"Additional error context information","uniqueKey":"details","typeLabel":"any"}},"required":["type","code","message"],"description":"Server error","uniqueKey":"","typeLabel":"object"},"example":{"type":"internal","code":"internal_error","message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"type":"internal","code":"internal_error","message":"Internal server error"}}},"exampleType":"examples"}},"description":"Internal Server Error","exampleType":"examples"}},"security":{"1c4229f5-8a45-4b8d-98d0-c524e543fb6d":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"79950302-db94-4418-b7ae-04b5133c6b9a":{"description":"Production","url":"https://api.roark.ai"}},"schemas":{"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9":{"oneOf":[{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"AGENT_TURN","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"content":{"oneOf":[{"type":"string"},{"type":"null"}]},"offScriptPolicy":{"oneOf":[{"type":"object","required":["reaction","maxAttempts","then"],"properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT","isRequired":true},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3,"isRequired":true},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP","isRequired":true},"sayLine":{"oneOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null","maxLength":2000,"minLength":1}]},"waitSeconds":{"oneOf":[{"type":"integer","maximum":600,"minimum":1},{"type":"null","maximum":600,"minimum":1}]}}},{"type":"null","required":["reaction","maxAttempts","then"],"properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT"},"sayLine":{"oneOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null","maxLength":2000,"minLength":1}]},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP"},"waitSeconds":{"oneOf":[{"type":"integer","maximum":600,"minimum":1},{"type":"null","maximum":600,"minimum":1}]}}}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_TURN","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"content":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_FIRST_MESSAGE","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"content":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_VERBATIM_TURN","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"content":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_SILENCE","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"silenceDurationSeconds":{"oneOf":[{"type":"integer","minimum":0,"exclusiveMinimum":true},{"type":"null","minimum":0,"exclusiveMinimum":true}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_AUDIO","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"audioClip":{"oneOf":[{"type":"string","enum":["HOLD_MUSIC_CLASSICAL_PIANO","HOLD_MUSIC_CLASSICAL_ORCHESTRA","HOLD_MUSIC_STRING_QUARTET","HOLD_MUSIC_AMBIENT","HOLD_MUSIC_SMOOTH_JAZZ","HOLD_MUSIC_SOFT_SYNTH","HOLD_BEEP","RINGBACK_US","RINGBACK_UK"]},{"type":"null","enum":["HOLD_MUSIC_CLASSICAL_PIANO","HOLD_MUSIC_CLASSICAL_ORCHESTRA","HOLD_MUSIC_STRING_QUARTET","HOLD_MUSIC_AMBIENT","HOLD_MUSIC_SMOOTH_JAZZ","HOLD_MUSIC_SOFT_SYNTH","HOLD_BEEP","RINGBACK_US","RINGBACK_UK"]}]},"silenceDurationSeconds":{"oneOf":[{"type":"integer","maximum":600,"minimum":0,"exclusiveMinimum":true},{"type":"null","maximum":600,"minimum":0,"exclusiveMinimum":true}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_DTMF","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"dtmfDigits":{"oneOf":[{"type":"string"},{"type":"null"}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"AGENT_DTMF","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"dtmfDigits":{"oneOf":[{"type":"string"},{"type":"null"}]},"offScriptPolicy":{"oneOf":[{"type":"object","required":["reaction","maxAttempts","then"],"properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT","isRequired":true},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3,"isRequired":true},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP","isRequired":true},"sayLine":{"oneOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null","maxLength":2000,"minLength":1}]},"waitSeconds":{"oneOf":[{"type":"integer","maximum":600,"minimum":1},{"type":"null","maximum":600,"minimum":1}]}}},{"type":"null","required":["reaction","maxAttempts","then"],"properties":{"reaction":{"type":"string","enum":["STAY_SILENT","REPEAT","RESPOND","SAY"],"default":"STAY_SILENT"},"sayLine":{"oneOf":[{"type":"string","maxLength":2000,"minLength":1},{"type":"null","maxLength":2000,"minLength":1}]},"maxAttempts":{"type":"integer","minimum":1,"maximum":20,"default":3},"then":{"type":"string","enum":["HANG_UP","MOVE_ON","ADAPT","HANG_UP_INVALIDATE"],"default":"HANG_UP"},"waitSeconds":{"oneOf":[{"type":"integer","maximum":600,"minimum":1},{"type":"null","maximum":600,"minimum":1}]}}}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"VOICEMAIL","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"CUSTOMER_HANDOFF","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"handoffPersonaId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]}},"additionalProperties":false},{"type":"object","description":"One step in a scripted flow's conversation.\n\n`nodeId` is the identity contract: include it to update the existing step, omit it to create a new one.\nA step continues into `steps` (more than one child is a branch point) and/or `mergeIntoNodeIds`, which\nnames steps elsewhere in the same request that this step rejoins. Branches that come back together are\nrepresented that way rather than by repeating the shared step, so reading a flow, editing it and writing\nit back preserves it exactly.\n\nA merge target is named by its `nodeId` when it already exists, or by `ref` when it is being created in\nthe same request. `ref` is a label you choose, it is request-local, and it is never stored or returned.\nPut the shared step inline under the first branch that reaches it and point the others at it: a top-level\nstep is a root wired straight from the start of the flow, so a merge target parked there would also be\nreachable directly.\n\nA `CUSTOMER_TURN` describes what the simulated customer says and the persona phrases it; a\n`CUSTOMER_VERBATIM_TURN` is said word for word, and one placed as a top-level step opens the call\nthe moment it connects, before the agent speaks. `CUSTOMER_FIRST_MESSAGE` is the retired name for\nthat opening case: still accepted, stored and returned as `CUSTOMER_VERBATIM_TURN`.\n\nA step's `content` may carry caller cues that steer the simulated caller from that point: `#{emotion:\u003cemotion>}`,\n`#{language:\u003cISO 639-1 code>}`, `#{noise:\u003cenvironmentId>}`, and `#{interrupt}`, whose sentence says when\nto cut in on your agent (on an `AGENT_TURN`, cut in while your agent says that line). Cues are voice only. See\n\"Caller cues\" in the scripted flows concept.\n\nThe two DTMF types are mirror images and both require `dtmfDigits`. `CUSTOMER_DTMF` is keys the\nsimulated caller presses while navigating your agent. `AGENT_DTMF` is keys your agent under test is\nexpected to press while navigating a menu the simulation is playing, so its digits are an assertion the\nrun is graded against rather than an instruction, and it counts as an agent turn for role alternation.\n\nA `CUSTOMER_HANDOFF` hands the phone to another persona (`handoffPersonaId`), or back to the flow's\nown persona when it is null. The steps after it are spoken by whoever holds the phone. It sits between\nturns like a silence, so it may follow either side.\n\nA `CUSTOMER_AUDIO` plays audio from the library (`audioClip`, see GET /v1/simulation/audio-clip) on the\nline for `silenceDurationSeconds` (up to 600, 30 when unset), looping it or cutting it to fit, the way an IVR plays hold music. It\nplays in a STRICT voice flow only: anywhere else it is a pause of the same length. It sits between turns\nlike a silence.\n\nWhen an improv flow opens with a STRICT scripted flow, every path through the script hands over to the\nimprov. Set `endsCall: true` on the last step of a path to end the call there instead, as an IVR does after\nsaying goodbye. Sharing the script between improvs shares this too. A step with steps after it, or a `SCENARIO_LINK`, is rejected.\n\nIn a STRICT flow an `AGENT_TURN` may carry its own `offScriptPolicy`, which replaces the flow-level one at\nthat step. Omit it (or send null) to follow the flow's policy. Use it where one missed step makes the rest\nof the call meaningless: an authentication menu, say, with `then: HANG_UP_INVALIDATE`.\n\nIn a STRICT flow an `AGENT_DTMF` may carry an `offScriptPolicy` too, read differently: `waitSeconds` is how\nlong to wait for the keys (at least 5, and just under the run's silence timeout by default and at most) and\n`then` what follows (`MOVE_ON`, `HANG_UP` or `HANG_UP_INVALIDATE`). Without one the call hangs up in silence\nafter that wait, whatever the flow-level policy says. Speech does not end the wait. `reaction` is\n`STAY_SILENT` or `REPEAT`: with `REPEAT` the caller says the line before the step again each time the wait\nruns out, up to `maxAttempts` waits (at most 5), and `then` follows the last one.\n\nAny step may set `stage`, the named phase of the flow it belongs to: the IVR, the login, the scenario\nitself. Steps in one stage are drawn as a group in the editor, and the name is yours: the reports say it\nback to you. The stage does not have to exist first, it is created the first time a step names it, and a\nname already in the project is matched ignoring case.\n\nA stage with `required: true` is a gate. A run that ends without getting PAST it never reached what was\nbeing measured, so it stays in the report, labelled with the stage it never completed and the one it\nstopped in, and is left out of the run score and the success-criteria verdict: an agent that never clears\nthe IVR does not fail every check in a scenario it never started. `required` belongs to the stage rather\nthan to the step, so a read returns it on every step in that stage, and a write that sets it on any one\nof them marks the whole stage. A flow that requires no stage is scored exactly as before.\n\nA stage with `analyze: false` is not measured. Its turns are kept out of the core call metrics (talk\ntime, speech pace, turn and response timings), which is what an IVR usually wants alongside\n`required: true`: the run has to get through the menu, but how the agent sounded reading it is not what\nis being tested. Coverage is being extended package by package, so the judged metrics (quality,\ncompliance, repetition, escalation, tone) still read the whole call for now. Nothing is cut and nothing\nis re-timed, so a turn at 4:10 is still at 4:10 with an earlier stage excluded, and rate metrics divide\nby the part of the call that was measured rather than by the whole of it. Defaults to true, belongs to\nthe stage the same way `required` does, and turning it off on any one step turns it off for the stage.","required":["type"],"properties":{"type":{"type":"string","const":"SCENARIO_LINK","isRequired":true},"nodeId":{"type":"string","format":"uuid"},"ref":{"type":"string","minLength":1,"maxLength":64},"steps":{"type":"array","items":{"$circularRef":"dd75ae64-69e2-4859-8e6e-70bcc80b9aa9"}},"mergeIntoNodeIds":{"type":"array","items":{"type":"string","minLength":1}},"stage":{"oneOf":[{"type":"object","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80,"isRequired":true},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false},{"type":"null","required":["name"],"properties":{"name":{"type":"string","minLength":1,"maxLength":80},"required":{"type":"boolean"},"analyze":{"type":"boolean"}},"additionalProperties":false}]},"endsCall":{"type":"boolean"},"linkedCustomerFlowId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]},"linkedCustomerFlowVariantId":{"oneOf":[{"type":"string","format":"uuid"},{"type":"null","format":"uuid"}]}},"additionalProperties":false}]}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"api-reference/openapi.documented.json"},"subdomain":"roark","siteName":"Roark Docs","title":"Add an edge case - Roark Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T19:43:12.059Z","originalFileLocation":"api-reference/customer-flow/add-an-edge-case.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Adds a variant to an IMPROV flow. A scripted flow\u0026#x27;s variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path\u0026#x27;s.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Roark Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add an edge case - Roark Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a variant to an IMPROV flow. A scripted flow\u0026#x27;s variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path\u0026#x27;s.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Roark Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://roark.mintlify.site/_mintlify/api/og/v2?division=Customer+flows\u0026amp;title=Add+an+edge+case\u0026amp;description=Adds+a+variant+to+an+IMPROV+flow.%0A%0AA+scripted+flow%27s+variants+are+owned+by+the+path+engine%2C+one+per+path+through+the+graph%2C+so+they+are%0Acreated+by+editing+the+g\u0026amp;theme=0f3fa282babd51a23ab3534f\u0026amp;signature=c4e6b966ccdba7c64cfd3f903ad5dc6e0eaeabe227d05443392a073a2a82bdbe\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add an edge case - Roark Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a variant to an IMPROV flow. A scripted flow\u0026#x27;s variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path\u0026#x27;s.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://roark.mintlify.site/_mintlify/api/og/v2?division=Customer+flows\u0026amp;title=Add+an+edge+case\u0026amp;description=Adds+a+variant+to+an+IMPROV+flow.%0A%0AA+scripted+flow%27s+variants+are+owned+by+the+path+engine%2C+one+per+path+through+the+graph%2C+so+they+are%0Acreated+by+editing+the+g\u0026amp;theme=0f3fa282babd51a23ab3534f\u0026amp;signature=c4e6b966ccdba7c64cfd3f903ad5dc6e0eaeabe227d05443392a073a2a82bdbe\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/roark/E3SiV_DMp7O0imMO/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Roark Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#006838\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer-flow/add-an-edge-case.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.roark.ai/#organization\",\"name\":\"Roark Docs\",\"url\":\"https://docs.roark.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/roark/roh5qorg6REL9dkn/images/logo/light.svg?fit=max\u0026auto=format\u0026n=roh5qorg6REL9dkn\u0026q=85\u0026s=040c5cac74f0bd94ad25a3ccfdb45dbc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.roark.ai#website\",\"name\":\"Roark Docs\",\"url\":\"https://docs.roark.ai\",\"publisher\":{\"@id\":\"https://docs.roark.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case#webpage\",\"url\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case\",\"name\":\"Add an edge case\",\"description\":\"Adds a variant to an IMPROV flow. A scripted flow's variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path's.\",\"dateModified\":\"2026-11-17T19:43:12.059Z\",\"isPartOf\":{\"@id\":\"https://docs.roark.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Simulate\",\"item\":\"https://docs.roark.ai/api-reference/customer-flow/list-customer-flows\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer flows\",\"item\":\"https://docs.roark.ai/api-reference/customer-flow/list-customer-flows\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add an edge case\",\"item\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case#apireference\",\"headline\":\"Add an edge case\",\"name\":\"Add an edge case\",\"description\":\"Adds a variant to an IMPROV flow. A scripted flow's variants are owned by the path engine, one per path through the graph, so they are created by editing the graph through PUT /v1/customer-flow/{flowId}/graph rather than here. Leave personaOverrideId or environmentId unset to inherit the happy path's.\",\"url\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case\",\"mainEntityOfPage\":{\"@id\":\"https://docs.roark.ai/api-reference/customer-flow/add-an-edge-case#webpage\"},\"dateModified\":\"2026-11-17T19:43:12.059Z\",\"publisher\":{\"@id\":\"https://docs.roark.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.roark.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Roark Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Roark Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/customer-flow/add-an-edge-case.md","siteName":"Roark Docs","nav":{"global":{},"tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/documentation/getting-started/introduction"}]},{"tab":"Config as Code","icon":"file-code","pages":[{"title":"Config as Code","href":"/documentation/config-as-code/overview"}]},{"tab":"SDKs \u0026 CLI","icon":"code","pages":[{"title":"SDKs \u0026 CLI","href":"/documentation/sdks/node-sdk"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Authorization","href":"/api-reference/authorization"},{"group":"Health","icon":"folder","pages":[{"title":"Get API health status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /health","href":"/api-reference/health/get-api-health-status"}]}]},{"group":"Authentication","pages":[{"group":"Current credential","icon":"folder","pages":[{"title":"List accessible projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/projects","href":"/api-reference/authentication/list-accessible-projects"},{"title":"Get the current credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/me","href":"/api-reference/authentication/get-the-current-credential"}]},{"group":"Project API keys","icon":"folder","pages":[{"title":"List project API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/org/project/{projectId}/api-key","href":"/api-reference/project-api-key/list-project-api-keys"},{"title":"Create a project API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/org/project/{projectId}/api-key","href":"/api-reference/project-api-key/create-a-project-api-key"},{"title":"Revoke a project API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/org/project/{projectId}/api-key/{keyId}","href":"/api-reference/project-api-key/revoke-a-project-api-key"}]},{"group":"Personal API keys","icon":"folder","pages":[{"title":"List personal API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/me/api-keys","href":"/api-reference/personal-api-key/list-personal-api-keys"},{"title":"Create a personal API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/me/api-keys","href":"/api-reference/personal-api-key/create-a-personal-api-key"},{"title":"Revoke a personal API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/me/api-keys/{id}","href":"/api-reference/personal-api-key/revoke-a-personal-api-key"}]}]},{"group":"Agents","pages":[{"group":"Agents","icon":"folder","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent","href":"/api-reference/agent/list-agents"},{"title":"Create an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent","href":"/api-reference/agent/create-an-agent"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/{agentId}","href":"/api-reference/agent/get-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/agent/{agentId}","href":"/api-reference/agent/update-an-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/agent/{agentId}","href":"/api-reference/agent/delete-an-agent"},{"title":"List an agent's prompts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/{agentId}/prompts","href":"/api-reference/agent/list-an-agents-prompts"},{"title":"Set an agent's prompt","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/agent/{agentId}/prompts","href":"/api-reference/agent/set-an-agents-prompt"},{"title":"List a prompt's versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/{agentId}/prompts/{promptId}/versions","href":"/api-reference/agent/list-a-prompts-versions"}]},{"group":"Endpoints","icon":"folder","pages":[{"title":"List agent endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/endpoint","href":"/api-reference/agent-endpoint/list-agent-endpoints"},{"title":"Create an agent endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent/endpoint","href":"/api-reference/agent-endpoint/create-an-agent-endpoint"},{"title":"Get an agent endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/endpoint/{endpointId}","href":"/api-reference/agent-endpoint/get-an-agent-endpoint"},{"title":"Update an agent endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/agent/endpoint/{endpointId}","href":"/api-reference/agent-endpoint/update-an-agent-endpoint"}]},{"group":"Tools","icon":"folder","pages":[{"title":"List tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/tool","href":"/api-reference/tool/list-tools"},{"title":"Create a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/tool","href":"/api-reference/tool/create-a-tool"},{"title":"Get a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/tool/{toolId}","href":"/api-reference/tool/get-a-tool"},{"title":"Update a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/tool/{toolId}","href":"/api-reference/tool/update-a-tool"},{"title":"Delete a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/tool/{toolId}","href":"/api-reference/tool/delete-a-tool"}]},{"group":"Automatic test setup","icon":"folder","pages":[{"title":"Set up tests for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent/{agentId}/setup","href":"/api-reference/agent-setup/set-up-tests-for-an-agent"},{"title":"Get an agent's latest test setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/{agentId}/setup","href":"/api-reference/agent-setup/get-an-agents-latest-test-setup"},{"title":"Get a test setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent/{agentId}/setup/{setupId}","href":"/api-reference/agent-setup/get-a-test-setup"},{"title":"Guide a running test setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent/{agentId}/setup/{setupId}/guidance","href":"/api-reference/agent-setup/guide-a-running-test-setup"},{"title":"Answer a test setup's question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent/{agentId}/setup/{setupId}/answer","href":"/api-reference/agent-setup/answer-a-test-setups-question"},{"title":"Cancel a running test setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent/{agentId}/setup/{setupId}/cancel","href":"/api-reference/agent-setup/cancel-a-running-test-setup"}]},{"group":"Autoimprove","icon":"folder","pages":[{"title":"List Autoimprove jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/autoimprove/job","href":"/api-reference/autoimprove/list-autoimprove-jobs"},{"title":"Start an Autoimprove job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job","href":"/api-reference/autoimprove/start-an-autoimprove-job"},{"title":"Get an Autoimprove job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/autoimprove/job/{jobId}","href":"/api-reference/autoimprove/get-an-autoimprove-job"},{"title":"Guide a running Autoimprove job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job/{jobId}/guidance","href":"/api-reference/autoimprove/guide-a-running-autoimprove-job"},{"title":"Answer Roark's question","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job/{jobId}/answer","href":"/api-reference/autoimprove/answer-roarks-question"},{"title":"Cancel an Autoimprove job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job/{jobId}/cancel","href":"/api-reference/autoimprove/cancel-an-autoimprove-job"},{"title":"Promote an Autoimprove job to production","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job/{jobId}/promote","href":"/api-reference/autoimprove/promote-an-autoimprove-job-to-production"},{"title":"Dismiss an Autoimprove job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/autoimprove/job/{jobId}/dismiss","href":"/api-reference/autoimprove/dismiss-an-autoimprove-job"},{"title":"List managed configs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent-config","href":"/api-reference/autoimprove/list-managed-configs"},{"title":"Get a managed config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/agent-config/{key}","href":"/api-reference/autoimprove/get-a-managed-config"},{"title":"Write a config revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/agent-config/{key}","href":"/api-reference/autoimprove/write-a-config-revision"},{"title":"Resolve config for a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent-config/{key}/resolve","href":"/api-reference/autoimprove/resolve-config-for-a-session"},{"title":"Promote staging to production","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/agent-config/{key}/promote","href":"/api-reference/autoimprove/promote-staging-to-production"},{"title":"Discard the staging revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/agent-config/{key}/staging","href":"/api-reference/autoimprove/discard-the-staging-revision"}]}]},{"group":"Simulate","pages":[{"group":"Customer flows","icon":"folder","pages":[{"title":"List customer flows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer-flow","href":"/api-reference/customer-flow/list-customer-flows"},{"title":"Create a customer flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow","href":"/api-reference/customer-flow/create-a-customer-flow"},{"title":"Get a customer flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer-flow/{flowId}","href":"/api-reference/customer-flow/get-a-customer-flow"},{"title":"Update a customer flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer-flow/{flowId}","href":"/api-reference/customer-flow/update-a-customer-flow"},{"title":"Delete a customer flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/customer-flow/{flowId}","href":"/api-reference/customer-flow/delete-a-customer-flow"},{"title":"Replace a scripted flow's steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer-flow/{flowId}/graph","href":"/api-reference/customer-flow/replace-a-scripted-flows-steps"},{"title":"Update a flow's happy path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer-flow/{flowId}/happy-path","href":"/api-reference/customer-flow/update-a-flows-happy-path"},{"title":"Duplicate a customer flow","description":"Deep-copies a flow into a new project-owned flow. The copy carries the source's description, branching mode, linked agents, flow-level expectations and flow-owned metrics. A scripted flow copies its whole step graph; an improv flow copies its variants (personas, briefs, expectations). Duplicating a Roark-managed flow is how you customise it. Voicemail flows are Roark-managed and cannot be duplicated.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow/{flowId}/duplicate","href":"/api-reference/customer-flow/duplicate-a-customer-flow"},{"title":"Add an edge case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow/{flowId}/edge-case","href":"/api-reference/customer-flow/add-an-edge-case"},{"title":"Update an edge case","description":"Updates an edge case's title, persona, environment, brief, preceded-by link or expectations. Omitted fields are left alone; `additionalExpectations` replaces the set wholesale rather than appending. Promoting it to the happy path is a separate call, since that also demotes the incumbent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer-flow/{flowId}/edge-case/{edgeCaseId}","href":"/api-reference/customer-flow/update-an-edge-case"},{"title":"Remove an edge case","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/customer-flow/{flowId}/edge-case/{edgeCaseId}","href":"/api-reference/customer-flow/remove-an-edge-case"},{"title":"Promote an edge case to the happy path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer-flow/{flowId}/edge-case/{edgeCaseId}/promote","href":"/api-reference/customer-flow/promote-an-edge-case-to-the-happy-path"},{"title":"List audio clips","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/audio-clip","href":"/api-reference/customer-flow/list-audio-clips"}]},{"group":"Personas","icon":"folder","pages":[{"title":"List personas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/persona","href":"/api-reference/simulation-persona/list-personas"},{"title":"Create a persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/persona","href":"/api-reference/simulation-persona/create-a-persona"},{"title":"Get a persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/persona/{personaId}","href":"/api-reference/simulation-persona/get-a-persona"},{"title":"Update a persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/persona/{personaId}","href":"/api-reference/simulation-persona/update-a-persona"},{"title":"Delete a persona","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/persona/{personaId}","href":"/api-reference/simulation-persona/delete-a-persona"}]},{"group":"Environments","icon":"folder","pages":[{"title":"List environments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/environment","href":"/api-reference/simulation-environment/list-environments"},{"title":"Create an environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/environment","href":"/api-reference/simulation-environment/create-an-environment"},{"title":"Get an environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/environment/{environmentId}","href":"/api-reference/simulation-environment/get-an-environment"},{"title":"Update an environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/simulation/environment/{environmentId}","href":"/api-reference/simulation-environment/update-an-environment"},{"title":"Delete an environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/environment/{environmentId}","href":"/api-reference/simulation-environment/delete-an-environment"}]},{"group":"Templates","icon":"folder","pages":[{"title":"List simulation templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/template","href":"/api-reference/simulation-template/list-simulation-templates"}]},{"group":"Plans","icon":"folder","pages":[{"title":"List run plans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan","href":"/api-reference/simulation-run-plan/list-run-plans"},{"title":"Create a run plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/plan","href":"/api-reference/simulation-run-plan/create-a-run-plan"},{"title":"Get a run plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan/{planId}","href":"/api-reference/simulation-run-plan/get-a-run-plan"},{"title":"Update a run plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/simulation/plan/{planId}","href":"/api-reference/simulation-run-plan/update-a-run-plan"},{"title":"Delete a run plan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/plan/{planId}","href":"/api-reference/simulation-run-plan/delete-a-run-plan"},{"title":"List plan groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/group","href":"/api-reference/simulation-run-plan/list-plan-groups"},{"title":"Create a plan group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/group","href":"/api-reference/simulation-run-plan/create-a-plan-group"},{"title":"Get a plan group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/group/{groupId}","href":"/api-reference/simulation-run-plan/get-a-plan-group"},{"title":"Update a plan group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/simulation/group/{groupId}","href":"/api-reference/simulation-run-plan/update-a-plan-group"},{"title":"Delete a plan group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/group/{groupId}","href":"/api-reference/simulation-run-plan/delete-a-plan-group"},{"title":"Run a plan group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/group/{groupId}/run","href":"/api-reference/simulation-run-plan/run-a-plan-group"}]},{"group":"Runs","icon":"folder","pages":[{"title":"List simulation runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan/jobs","href":"/api-reference/simulation-run/list-simulation-runs"},{"title":"Run a simulation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/run","href":"/api-reference/simulation-run/run-a-simulation"},{"title":"Get a simulation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan/job/{jobId}","href":"/api-reference/simulation-run/get-a-simulation-run"},{"title":"Delete a simulation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/plan/job/{jobId}","href":"/api-reference/simulation-run/delete-a-simulation-run"},{"title":"Cancel a simulation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/plan/job/{jobId}/cancel","href":"/api-reference/simulation-run/cancel-a-simulation-run"},{"title":"Get a simulation run's results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan/job/{jobId}/results","href":"/api-reference/simulation-run/get-a-simulation-runs-results"},{"title":"Generate a simulation run debrief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/plan/job/{jobId}/debrief","href":"/api-reference/simulation-run/generate-a-simulation-run-debrief"},{"title":"Get a simulation run's cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/plan/job/{jobId}/cost","href":"/api-reference/simulation-run/get-a-simulation-runs-cost"},{"title":"Find a simulated call by phone number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/job/lookup","href":"/api-reference/simulation-run/find-a-simulated-call-by-phone-number"},{"title":"Get a simulated call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/job/{jobId}","href":"/api-reference/simulation-run/get-a-simulated-call"},{"title":"List run groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/run-group","href":"/api-reference/simulation-run/list-run-groups"},{"title":"Create a run group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/run-group","href":"/api-reference/simulation-run/create-a-run-group"},{"title":"Get a run group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/run-group/{groupId}","href":"/api-reference/simulation-run/get-a-run-group"},{"title":"Delete a run group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/run-group/{groupId}","href":"/api-reference/simulation-run/delete-a-run-group"},{"title":"Regenerate a run group report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/run-group/{groupId}/report","href":"/api-reference/simulation-run/regenerate-a-run-group-report"},{"title":"Run a simulation plan","deprecated":true,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/plan/{planId}/job","href":"/api-reference/simulation-run/run-a-simulation-plan"}]},{"group":"Tool mocks and fixtures","icon":"folder","pages":[{"title":"List tool fixtures","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/tool-fixture","href":"/api-reference/simulation-tool-mock/list-tool-fixtures"},{"title":"Mock a tool call during a test call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/tool-mock","href":"/api-reference/simulation-tool-mock/mock-a-tool-call-during-a-test-call"},{"title":"Set a tool fixture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/simulation/tool-fixture","href":"/api-reference/simulation-tool-mock/set-a-tool-fixture"},{"title":"Update a tool fixture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/simulation/tool-fixture/{fixtureId}","href":"/api-reference/simulation-tool-mock/update-a-tool-fixture"},{"title":"Delete a tool fixture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/simulation/tool-fixture/{fixtureId}","href":"/api-reference/simulation-tool-mock/delete-a-tool-fixture"},{"title":"List mocked tool invocations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/simulation/job/{jobId}/tool-mock","href":"/api-reference/simulation-tool-mock/list-mocked-tool-invocations"}]}]},{"group":"Metrics","pages":[{"group":"Definitions","icon":"folder","pages":[{"title":"List metric definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/definitions","href":"/api-reference/metric/list-metric-definitions"},{"title":"Create a metric definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/definitions","href":"/api-reference/metric/create-a-metric-definition"},{"title":"Get a metric definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/definitions/{idOrSlug}","href":"/api-reference/metric/get-a-metric-definition"},{"title":"Update a metric definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/metric/definitions/{idOrSlug}","href":"/api-reference/metric/update-a-metric-definition"},{"title":"Delete a metric definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/metric/definitions/{idOrSlug}","href":"/api-reference/metric/delete-a-metric-definition"},{"title":"Create a threshold on a metric","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/definitions/{idOrSlug}/thresholds","href":"/api-reference/metric/create-a-threshold-on-a-metric"}]},{"group":"Variants","icon":"folder","pages":[{"title":"List a metric's variants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/definitions/{idOrSlug}/variants","href":"/api-reference/metric-variant/list-a-metrics-variants"},{"title":"Create a metric variant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/definitions/{idOrSlug}/variants","href":"/api-reference/metric-variant/create-a-metric-variant"},{"title":"Get a metric variant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/definitions/{idOrSlug}/variants/{variantId}","href":"/api-reference/metric-variant/get-a-metric-variant"},{"title":"Update a metric variant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/metric/definitions/{idOrSlug}/variants/{variantId}","href":"/api-reference/metric-variant/update-a-metric-variant"},{"title":"Delete a metric variant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/metric/definitions/{idOrSlug}/variants/{variantId}","href":"/api-reference/metric-variant/delete-a-metric-variant"}]},{"group":"Policies","icon":"folder","pages":[{"title":"List metric policies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/policies","href":"/api-reference/metric-policy/list-metric-policies"},{"title":"Create a metric policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/policies","href":"/api-reference/metric-policy/create-a-metric-policy"},{"title":"Get a metric policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/policies/{policyId}","href":"/api-reference/metric-policy/get-a-metric-policy"},{"title":"Update a metric policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/metric/policies/{policyId}","href":"/api-reference/metric-policy/update-a-metric-policy"},{"title":"Delete a metric policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/metric/policies/{policyId}","href":"/api-reference/metric-policy/delete-a-metric-policy"}]},{"group":"Collection jobs","icon":"folder","pages":[{"title":"List metric collection jobs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/collection-jobs","href":"/api-reference/metric-collection-job/list-metric-collection-jobs"},{"title":"Create and run a metric collection job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/collection-jobs","href":"/api-reference/metric-collection-job/create-and-run-a-metric-collection-job"},{"title":"Get a metric collection job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/collection-jobs/{jobId}","href":"/api-reference/metric-collection-job/get-a-metric-collection-job"},{"title":"Retry a metric collection job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/collection-jobs/{jobId}/retry","href":"/api-reference/metric-collection-job/retry-a-metric-collection-job"},{"title":"Cancel a metric collection job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/metric/collection-jobs/{jobId}/cancel","href":"/api-reference/metric-collection-job/cancel-a-metric-collection-job"},{"title":"Get metric values produced by a metric collection job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/metric/collection-jobs/{jobId}/metric-values","href":"/api-reference/metric-collection-job/get-metric-values-produced-by-a-metric-collection-job"}]}]},{"group":"Monitoring","pages":[{"group":"Calls","icon":"folder","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call","href":"/api-reference/call/list-calls"},{"title":"Create a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/call","href":"/api-reference/call/create-a-call"},{"title":"Delete calls in batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/call/batch-delete","href":"/api-reference/call/delete-calls-in-batch"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call/{callId}","href":"/api-reference/call/get-a-call"},{"title":"Delete a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/call/{callId}","href":"/api-reference/call/delete-a-call"},{"title":"Get call transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call/{callId}/transcript","href":"/api-reference/call/get-call-transcript"},{"title":"Append tool invocations to a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/call/{callId}/tool-invocations","href":"/api-reference/call/append-tool-invocations-to-a-call"},{"title":"Update the properties of a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/call/{callId}/properties","href":"/api-reference/call/update-the-properties-of-a-call"},{"title":"Get call cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call/{callId}/cost","href":"/api-reference/call/get-call-cost"},{"title":"List call sentiment runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call/{callId}/sentiment-run","href":"/api-reference/call/list-call-sentiment-runs"},{"title":"List call metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/call/{callId}/metrics","href":"/api-reference/call/list-call-metrics"}]},{"group":"Chats","icon":"folder","pages":[{"title":"List chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/chat","href":"/api-reference/chat/list-chats"},{"title":"Create a chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/chat","href":"/api-reference/chat/create-a-chat"},{"title":"Get a chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/chat/{id}","href":"/api-reference/chat/get-a-chat"},{"title":"Get chat transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/chat/{id}/transcript","href":"/api-reference/chat/get-chat-transcript"},{"title":"List chat metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/chat/{id}/metrics","href":"/api-reference/chat/list-chat-metrics"}]},{"group":"Customers","icon":"folder","pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer","href":"/api-reference/customer/list-customers"},{"title":"Get a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer/{customerProfileId}","href":"/api-reference/customer/get-a-customer"},{"title":"Erase a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/customer/{customerProfileId}","href":"/api-reference/customer/erase-a-customer"},{"title":"Set a field on a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer/{customerProfileId}/attributes/{key}","href":"/api-reference/customer/set-a-field-on-a-customer"},{"title":"Clear a field on a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/customer/{customerProfileId}/attributes/{key}","href":"/api-reference/customer/clear-a-field-on-a-customer"},{"title":"Unlock a field on a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer/{customerProfileId}/attributes/{key}/unlock","href":"/api-reference/customer/unlock-a-field-on-a-customer"},{"title":"Update the notes on a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/customer/{customerProfileId}/notes","href":"/api-reference/customer/update-the-notes-on-a-customer"},{"title":"List customer fields","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer/fields","href":"/api-reference/customer/list-customer-fields"},{"title":"Create a customer field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/customer/fields","href":"/api-reference/customer/create-a-customer-field"},{"title":"Update a customer field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/customer/fields/{key}","href":"/api-reference/customer/update-a-customer-field"},{"title":"Delete a customer field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/customer/fields/{key}","href":"/api-reference/customer/delete-a-customer-field"},{"title":"List a customer's conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/customer/{customerProfileId}/conversations","href":"/api-reference/customer/list-a-customers-conversations"}]},{"group":"Issues","icon":"folder","pages":[{"title":"List issues","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/issue","href":"/api-reference/issue/list-issues"},{"title":"Create an issue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/issue","href":"/api-reference/issue/create-an-issue"},{"title":"Get an issue","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/issue/{issueId}","href":"/api-reference/issue/get-an-issue"}]},{"group":"Analytics","icon":"folder","pages":[{"title":"Run an analytics query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/analytics/query","href":"/api-reference/analytics/run-an-analytics-query"},{"title":"Get the analytics schema","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/analytics/schema","href":"/api-reference/analytics/get-the-analytics-schema"}]},{"group":"Dashboards","icon":"folder","pages":[{"title":"List dashboards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/dashboard","href":"/api-reference/dashboard/list-dashboards"},{"title":"Create a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/dashboard","href":"/api-reference/dashboard/create-a-dashboard"},{"title":"Get a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/dashboard/{dashboardId}","href":"/api-reference/dashboard/get-a-dashboard"},{"title":"Update a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/dashboard/{dashboardId}","href":"/api-reference/dashboard/update-a-dashboard"},{"title":"Delete a dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/dashboard/{dashboardId}","href":"/api-reference/dashboard/delete-a-dashboard"},{"title":"Get dashboard data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/dashboard/{dashboardId}/data","href":"/api-reference/dashboard/get-dashboard-data"},{"title":"Add a widget","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/dashboard/{dashboardId}/widget","href":"/api-reference/dashboard/add-a-widget"},{"title":"Replace a widget","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/dashboard/{dashboardId}/widget/{widgetId}","href":"/api-reference/dashboard/replace-a-widget"},{"title":"Remove a widget","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/dashboard/{dashboardId}/widget/{widgetId}","href":"/api-reference/dashboard/remove-a-widget"},{"title":"Get widget data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/dashboard/{dashboardId}/widget/{widgetId}/data","href":"/api-reference/dashboard/get-widget-data"}]},{"group":"Reports","icon":"folder","pages":[{"title":"List live reports","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/live-report","href":"/api-reference/live-report/list-live-reports"},{"title":"Create a live report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/live-report","href":"/api-reference/live-report/create-a-live-report"},{"title":"Get a live report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/live-report/{reportId}","href":"/api-reference/live-report/get-a-live-report"},{"title":"Update a live report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/live-report/{reportId}","href":"/api-reference/live-report/update-a-live-report"},{"title":"Delete a live report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/live-report/{reportId}","href":"/api-reference/live-report/delete-a-live-report"},{"title":"Generate a live report document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/live-report/{reportId}/generate","href":"/api-reference/live-report/generate-a-live-report-document"},{"title":"List report documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/live-report/{reportId}/document","href":"/api-reference/live-report/list-report-documents"},{"title":"Get a report document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/live-report/{reportId}/document/{documentId}","href":"/api-reference/live-report/get-a-report-document"}]}]},{"group":"Connections","pages":[{"group":"Agent platforms","icon":"folder","pages":[{"title":"List agent connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/agent","href":"/api-reference/agent-connection/list-agent-connections"},{"title":"Connect an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/agent","href":"/api-reference/agent-connection/connect-an-agent"},{"title":"Discover agents with a platform API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/agent/discover","href":"/api-reference/agent-connection/discover-agents-with-a-platform-api-key"},{"title":"Get an agent connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/agent/{connectionId}","href":"/api-reference/agent-connection/get-an-agent-connection"},{"title":"Update an agent connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/connections/agent/{connectionId}","href":"/api-reference/agent-connection/update-an-agent-connection"},{"title":"Disconnect an agent connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/connections/agent/{connectionId}","href":"/api-reference/agent-connection/disconnect-an-agent-connection"},{"title":"List agent connection providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/agent/providers","href":"/api-reference/agent-connection/list-agent-connection-providers"},{"title":"List backfills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/agent/{connectionId}/backfills","href":"/api-reference/agent-connection/list-backfills"},{"title":"Import past calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/agent/{connectionId}/backfills","href":"/api-reference/agent-connection/import-past-calls"},{"title":"Cancel a backfill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/agent/{connectionId}/backfills/{backfillId}/cancel","href":"/api-reference/agent-connection/cancel-a-backfill"}]},{"group":"Calendars","icon":"folder","pages":[{"title":"List calendar connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/calendar","href":"/api-reference/calendar-connection/list-calendar-connections"},{"title":"Connect a calendar account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/calendar","href":"/api-reference/calendar-connection/connect-a-calendar-account"},{"title":"Start connecting a Google Calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/calendar/google/authorize-url","href":"/api-reference/calendar-connection/start-connecting-a-google-calendar"},{"title":"Start connecting a Calendly account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/calendar/calendly/authorize-url","href":"/api-reference/calendar-connection/start-connecting-a-calendly-account"},{"title":"Get a calendar connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/calendar/{connectionId}","href":"/api-reference/calendar-connection/get-a-calendar-connection"},{"title":"Update a calendar connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/connections/calendar/{connectionId}","href":"/api-reference/calendar-connection/update-a-calendar-connection"},{"title":"Delete a calendar connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/connections/calendar/{connectionId}","href":"/api-reference/calendar-connection/delete-a-calendar-connection"},{"title":"Check a calendar connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/calendar/{connectionId}/check","href":"/api-reference/calendar-connection/check-a-calendar-connection"}]},{"group":"MCP servers","icon":"folder","pages":[{"title":"List MCP servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/mcp-server","href":"/api-reference/mcp-server-connection/list-mcp-servers"},{"title":"Connect an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/mcp-server","href":"/api-reference/mcp-server-connection/connect-an-mcp-server"},{"title":"Discover an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/mcp-server/discover","href":"/api-reference/mcp-server-connection/discover-an-mcp-server"},{"title":"Get an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/connections/mcp-server/{serverId}","href":"/api-reference/mcp-server-connection/get-an-mcp-server"},{"title":"Update an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json patch /v1/connections/mcp-server/{serverId}","href":"/api-reference/mcp-server-connection/update-an-mcp-server"},{"title":"Disconnect an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/connections/mcp-server/{serverId}","href":"/api-reference/mcp-server-connection/disconnect-an-mcp-server"},{"title":"Refresh an MCP server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/connections/mcp-server/{serverId}/refresh","href":"/api-reference/mcp-server-connection/refresh-an-mcp-server"}]}]},{"group":"Configure","pages":[{"group":"Knowledge bases","icon":"folder","pages":[{"title":"List knowledge bases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/knowledge-base","href":"/api-reference/knowledge-base/list-knowledge-bases"},{"title":"Create a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/knowledge-base","href":"/api-reference/knowledge-base/create-a-knowledge-base"},{"title":"Get a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/knowledge-base/{id}","href":"/api-reference/knowledge-base/get-a-knowledge-base"}]},{"group":"HTTP request definitions","icon":"folder","pages":[{"title":"List HTTP request definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/http-request-definition","href":"/api-reference/http-request-definition/list-http-request-definitions"},{"title":"Create an HTTP request definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/http-request-definition","href":"/api-reference/http-request-definition/create-an-http-request-definition"},{"title":"Get an HTTP request definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/http-request-definition/{definitionId}","href":"/api-reference/http-request-definition/get-an-http-request-definition"},{"title":"Update an HTTP request definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/http-request-definition/{definitionId}","href":"/api-reference/http-request-definition/update-an-http-request-definition"}]},{"group":"Webhooks","icon":"folder","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/webhook","href":"/api-reference/webhook/list-webhooks"},{"title":"Create a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/webhook","href":"/api-reference/webhook/create-a-webhook"},{"title":"Get a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/webhook/{webhookId}","href":"/api-reference/webhook/get-a-webhook"},{"title":"Delete a webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/webhook/{webhookId}","href":"/api-reference/webhook/delete-a-webhook"}]},{"group":"Config as code","icon":"folder","pages":[{"title":"Diff a config bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/config/diff","href":"/api-reference/config/diff-a-config-bundle"},{"title":"Apply a config bundle","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/config/apply","href":"/api-reference/config/apply-a-config-bundle"}]}]},{"group":"Organization","pages":[{"group":"Projects","icon":"folder","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/org/project","href":"/api-reference/organization-project/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/org/project","href":"/api-reference/organization-project/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/org/project/{projectId}","href":"/api-reference/organization-project/get-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/org/project/{projectId}","href":"/api-reference/organization-project/update-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/org/project/{projectId}","href":"/api-reference/organization-project/delete-a-project"}]},{"group":"Project members","icon":"folder","pages":[{"title":"List project members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/org/project/{projectId}/member","href":"/api-reference/organization-project-member/list-project-members"},{"title":"Invite a project member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json post /v1/org/project/{projectId}/member","href":"/api-reference/organization-project-member/invite-a-project-member"},{"title":"Update a project member's role","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json put /v1/org/project/{projectId}/member/{memberId}","href":"/api-reference/organization-project-member/update-a-project-members-role"},{"title":"Remove a project member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json delete /v1/org/project/{projectId}/member/{memberId}","href":"/api-reference/organization-project-member/remove-a-project-member"}]},{"group":"Usage","icon":"folder","pages":[{"title":"Get usage and cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/usage","href":"/api-reference/usage/get-usage-and-cost"}]}]},{"group":"Benchmarks","pages":[{"group":"Benchmarks","icon":"folder","pages":[{"title":"List benchmark suites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/suite","href":"/api-reference/benchmark/list-benchmark-suites"},{"title":"Get the benchmark leaderboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/leaderboard","href":"/api-reference/benchmark/get-the-benchmark-leaderboard"},{"title":"Get a benchmark target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/target/{targetKey}","href":"/api-reference/benchmark/get-a-benchmark-target"},{"title":"List benchmark metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/metric","href":"/api-reference/benchmark/list-benchmark-metrics"},{"title":"List score samples for a target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/target/{targetKey}/score-sample","href":"/api-reference/benchmark/list-score-samples-for-a-target"},{"title":"List a benchmark target's published generations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.documented.json get /v1/benchmark/target/{targetKey}/history","href":"/api-reference/benchmark/list-a-benchmark-targets-published-generations"}]}]}]},{"tab":"CLI Reference","icon":"square-terminal","pages":[{"title":"CLI Reference","href":"/cli-reference/overview"}]},{"tab":"Changelog","icon":"history","href":"https://changelog.roark.ai"}]},"basePath":"","title":"Add an edge case - Roark Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}