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.simulationRunPlanJob.getByID('7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f');
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.simulation_run_plan_job.get_by_id(
"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
)
print(response.data)
{
"type": "internal",
"code": "internal_error",
"message": "Internal server error"
}
Runs
Get a simulation run
Retrieve details of a simulation plan job including all associated simulation jobs (calls)
GET
/
v1
/
simulation
/
plan
/
job
/
{jobId}
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.simulationRunPlanJob.getByID('7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f');
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.simulation_run_plan_job.get_by_id(
"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
)
print(response.data)
{"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":"control","enabled":true,"payload":{"type":"string","value":"control"},"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/simulation-run/get-a-simulation-run","slug":"/api-reference/simulation-run/get-a-simulation-run","pageMetadata":{"title":"Get a simulation run","description":"Retrieve details of a simulation plan job including all associated simulation jobs (calls)","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\"\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":"Get a simulation run","description":"Retrieve details of a simulation plan job including all associated simulation jobs (calls)","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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"responses":{"200":"adf8f475-f132-4109-a1db-671e2c1c46de","400":"7cbfe892-e3ad-400e-ad68-dcdfdcb605db","401":"642cd616-c633-472e-8436-8d6c299aeca0","403":"6bb08ae9-f095-4c40-8745-6408ae7af642","404":"2fdbfabb-9238-4e6e-9826-62fedf883cce","429":"932cecb6-4ea5-415d-b17b-25aea801a03e","500":"2df7e35b-17bb-4756-a7ba-0a7fd7651938"},"operationId":"getV1SimulationPlanJobByJobId","tags":["Simulation Run"],"summary":"Get a simulation run","description":"Retrieve details of a simulation plan job including all associated simulation jobs (calls)","parameters":["77633052-63a2-4a3f-a8cb-aa7534f3a38a"],"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.simulationRunPlanJob.getByID('7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f');\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.simulation_run_plan_job.get_by_id(\n \"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f\",\n)\nprint(response.data)"}],"method":"get","type":"path","servers":["79950302-db94-4418-b7ae-04b5133c6b9a"],"security":["1c4229f5-8a45-4b8d-98d0-c524e543fb6d"],"path":"/v1/simulation/plan/job/{jobId}","baseUrlOptions":["https://api.roark.ai"],"title":"Get a simulation run","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.simulationRunPlanJob.getByID('7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f');\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.simulation_run_plan_job.get_by_id(\n \"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f\",\n)\nprint(response.data)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"77633052-63a2-4a3f-a8cb-aa7534f3a38a":{"in":"path","name":"jobId","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Simulation run plan job ID","uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"example":"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f","description":"Simulation run plan job ID"}},"responses":{"adf8f475-f132-4109-a1db-671e2c1c46de":{"description":"Successfully retrieved simulation plan job","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"simulationRunPlanJobId":{"type":"string","format":"uuid","description":"ID of the simulation run plan job","isRequired":true,"uniqueKey":"data.simulationRunPlanJobId","typeLabel":"string\u003cuuid>"},"simulationRunPlanId":{"type":"string","format":"uuid","description":"ID of the simulation run plan","isRequired":true,"uniqueKey":"data.simulationRunPlanId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["PENDING","QUEUED","CREATING_SNAPSHOTS","CREATING_SIMULATIONS","PREPARING_CAPACITY","RUNNING_SIMULATIONS","COMPLETED","FAILED","TIMED_OUT","CANCELLED","CANCELLING","ENDING_SIMULATIONS"],"description":"Job status","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"createdAt":{"type":"string","description":"When the job was created","isRequired":true,"uniqueKey":"data.createdAt","typeLabel":"string"},"simulationJobs":{"type":"array","items":{"type":"object","properties":{"simulationJobId":{"type":"string","format":"uuid","description":"Simulation job ID","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].simulationJobId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["PENDING","QUEUED","PROCESSING","COMPLETED","FAILED","TIMED_OUT","CANCELLED","CANCELLING","RETRY_SCHEDULED"],"description":"Job status. `RETRY_SCHEDULED` is a retry of a simulation your agent never spoke on, waiting out the plan’s `noResponseRetryBackoffSeconds` before it dials.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"processingStatus":{"type":"string","enum":["PENDING","RESERVING_CAPACITY","CONNECTING","WAITING_FOR_OUTBOUND_CALL","SIMULATING","ENDING","ANALYZING","WAITING_FOR_LIVE_CONVERSATION","EVALUATING","COLLECTING_METRICS","COMPLETED"],"description":"Processing status. PENDING until the job starts connecting.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].processingStatus","typeLabel":"enum\u003cstring>"},"persona":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the persona","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The name the agent will identify as during conversations","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.age","typeLabel":"enum\u003cstring>"},"gender":{"type":"string","enum":["MALE","FEMALE"],"description":"Gender of the persona","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.speechPace","typeLabel":"enum\u003cstring>"},"speechClarity":{"type":"string","enum":["CLEAR","VAGUE","RAMBLING"],"default":"CLEAR","description":"Speech clarity of the persona","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.speechClarity","typeLabel":"enum\u003cstring>"},"hasDisfluencies":{"type":"boolean","default":false,"description":"Whether the persona uses filler words like \"um\" and \"uh\"","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.intentClarity","typeLabel":"enum\u003cstring>"},"confirmationStyle":{"type":"string","enum":["EXPLICIT","VAGUE"],"default":"EXPLICIT","description":"How the persona confirms information","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.confirmationStyle","typeLabel":"enum\u003cstring>"},"memoryReliability":{"type":"string","enum":["HIGH","LOW"],"default":"HIGH","description":"How reliable the persona's memory is","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.interruption","typeLabel":"enum\u003cstring>"},"idleMessages":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.idleMessages.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.idleMessageMaxSpokenCount","typeLabel":"integer"},"idleMessageResetCountOnUserSpeechEnabled":{"type":"boolean","default":true,"description":"Whether the idle message counter resets when the agent speaks","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.idleMessageResetCountOnUserSpeechEnabled","typeLabel":"boolean"},"properties":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"data.simulationJobs.items.[INDEX].persona.properties.additionalProperties","typeLabel":"any"},"default":{},"description":"Additional custom properties about the persona","example":{"age":35,"zipCode":"94105","occupation":"Software Engineer"},"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.properties","typeLabel":"object"},"createdAt":{"type":"string","description":"Creation timestamp","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","description":"Last update timestamp","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.displayName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].persona.displayName","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","description":"Human-readable description of the persona","uniqueKey":"data.simulationJobs.items.[INDEX].persona.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable description of the persona","uniqueKey":"data.simulationJobs.items.[INDEX].persona.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.secondaryLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.backstoryPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].persona.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.simulationJobs.items.[INDEX].persona.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"],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].persona","typeLabel":"object"},"backgroundNoise":{"type":"object","properties":{"backgroundNoise":{"type":"string","enum":["NONE","AIRPORT","CHILDREN_PLAYING","CITY","COFFEE_SHOP","CONSTRUCTION","CRYING_BABY","DRIVING","LIBRARY","OFFICE","THUNDERSTORM","TRAIN"],"description":"The noise bed the simulated caller was placed with. NONE when the call ran in silence.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].backgroundNoise.backgroundNoise","typeLabel":"enum\u003cstring>"},"backgroundNoiseVolume":{"type":"number","minimum":0,"maximum":1,"description":"Linear gain (0..1) the bed played at. 1 is as loud as the caller’s voice.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].backgroundNoise.backgroundNoiseVolume","typeLabel":"number"},"source":{"type":"string","enum":["ENVIRONMENT","PERSONA"],"description":"`ENVIRONMENT` when the flow’s environment decided the bed (a sweep arm, or an environment with noise), `PERSONA` when the persona’s own setting did.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].backgroundNoise.source","typeLabel":"enum\u003cstring>"}},"required":["backgroundNoise","backgroundNoiseVolume","source"],"description":"The background noise the call actually ran with. `persona.backgroundNoise` is only what the persona was set to; a flow’s environment overrides it, and on a background-noise sweep every arm’s persona says NONE while the arms differ here. Filter by arm on this field.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].backgroundNoise","typeLabel":"object"},"scenario":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Scenario ID","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].scenario.id","typeLabel":"string\u003cuuid>"},"description":{"oneOf":[{"type":"string","description":"Scenario description","uniqueKey":"data.simulationJobs.items.[INDEX].scenario.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Scenario description","uniqueKey":"data.simulationJobs.items.[INDEX].scenario.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].scenario.description","typeLabel":"string | null"}},"required":["id"],"description":"Scenario used in a simulation","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].scenario","typeLabel":"object"},"agentEndpoint":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Agent endpoint ID","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Agent endpoint name","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.name","typeLabel":"string"},"phoneNumber":{"oneOf":[{"type":"string","description":"Agent endpoint phone number","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent endpoint phone number","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.phoneNumber","typeLabel":"string | null"},"type":{"type":"string","enum":["PHONE","WEBSOCKET","LIVEKIT","SMALL_WEBRTC","ELEVENLABS_WS","KORE","GOOGLE_CES","DAILY","ROARK_WEBRTC"],"description":"Agent endpoint type","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint.type","typeLabel":"enum\u003cstring>"}},"required":["id","name","phoneNumber","type"],"description":"Agent endpoint used in a simulation","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].agentEndpoint","typeLabel":"object"},"invalidation":{"oneOf":[{"type":"object","description":"Present when the result does not count (a strict flow went off script and its policy invalidated the run); null otherwise.","required":["reason","invalidatedAt"],"properties":{"reason":{"type":"string","enum":["SCRIPT_DIVERGED","REQUIRED_STEP_NOT_REACHED","REQUIRED_STAGE_INCOMPLETE","CALLER_NEVER_TOOK_OVER","AGENT_NEVER_SPOKE"],"description":"Why the result does not count. `SCRIPT_DIVERGED`: a strict flow went off script at a step whose off-script policy is HANG_UP_INVALIDATE. `REQUIRED_STAGE_INCOMPLETE`: the call ended before it got through a stage its flow requires. `CALLER_NEVER_TOOK_OVER`: the call opened on the persona of a preceding flow, which never handed the phone to the persona under test, so none of that persona's properties were exercised. `AGENT_NEVER_SPOKE`: your agent answered and never said a word (it hung up within seconds, or the line stayed silent until our caller gave up), so there was nothing to grade.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"invalidatedAt":{"type":"string","description":"When the run was invalidated.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0.invalidatedAt","typeLabel":"string"},"detail":{"oneOf":[{"type":"string","description":"One sentence: where the script was left and what your agent did instead.","uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0.detail.oneOf.0","typeLabel":"string"},{"type":"null","description":"One sentence: where the script was left and what your agent did instead.","uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0.detail.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0.detail","typeLabel":"string | null"}},"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.0","typeLabel":"object"},{"type":"null","description":"Present when the result does not count (a strict flow went off script and its policy invalidated the run); null otherwise.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].invalidation","typeLabel":"object | null"},"retryOfSimulationJobId":{"oneOf":[{"type":"string","format":"uuid","description":"The simulation this one retries, because your agent never spoke on it. Null on a test case’s first attempt.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].retryOfSimulationJobId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"The simulation this one retries, because your agent never spoke on it. Null on a test case’s first attempt.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].retryOfSimulationJobId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].retryOfSimulationJobId","typeLabel":"string\u003cuuid> | null"},"attemptNumber":{"type":"integer","exclusiveMinimum":0,"description":"This simulation’s place among its test case’s attempts: 1 for the first, 2 for the first retry. Above 1 only when the plan retries simulations your agent never spoke on.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].attemptNumber","typeLabel":"integer"},"scheduledAt":{"oneOf":[{"type":"string","description":"When a `RETRY_SCHEDULED` retry dials, ISO 8601. Null on a first attempt.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].scheduledAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When a `RETRY_SCHEDULED` retry dials, ISO 8601. Null on a first attempt.","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].scheduledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].scheduledAt","typeLabel":"string | null"},"createdAt":{"type":"string","description":"When the simulation job was created","isRequired":true,"uniqueKey":"data.simulationJobs.items.[INDEX].createdAt","typeLabel":"string"},"callId":{"oneOf":[{"type":"string","format":"uuid","description":"ID of the call created for this simulation job. Null if the call has not been created yet.","uniqueKey":"data.simulationJobs.items.[INDEX].callId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"ID of the call created for this simulation job. Null if the call has not been created yet.","uniqueKey":"data.simulationJobs.items.[INDEX].callId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].callId","typeLabel":"string\u003cuuid> | null"},"roarkPhoneNumber":{"oneOf":[{"type":"string","description":"Phone number provisioned by Roark for this simulation job in E.164 format. Null if the simulation job is queued and has not been assigned a phone number yet.","uniqueKey":"data.simulationJobs.items.[INDEX].roarkPhoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"Phone number provisioned by Roark for this simulation job in E.164 format. Null if the simulation job is queued and has not been assigned a phone number yet.","uniqueKey":"data.simulationJobs.items.[INDEX].roarkPhoneNumber.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].roarkPhoneNumber","typeLabel":"string | null"},"startedAt":{"oneOf":[{"type":"string","description":"When the simulation job started","uniqueKey":"data.simulationJobs.items.[INDEX].startedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the simulation job started","uniqueKey":"data.simulationJobs.items.[INDEX].startedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].startedAt","typeLabel":"string | null"},"completedAt":{"oneOf":[{"type":"string","description":"When the simulation job completed","uniqueKey":"data.simulationJobs.items.[INDEX].completedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the simulation job completed","uniqueKey":"data.simulationJobs.items.[INDEX].completedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.simulationJobs.items.[INDEX].completedAt","typeLabel":"string | null"}},"required":["simulationJobId","status","processingStatus","persona","backgroundNoise","scenario","agentEndpoint","invalidation","retryOfSimulationJobId","attemptNumber","scheduledAt","createdAt"],"uniqueKey":"data.simulationJobs.items.[INDEX]","typeLabel":"object"},"description":"List of simulation jobs (calls) in this run plan job, every attempt included: a simulation your agent never spoke on stays listed after a retry replaces it.","isRequired":true,"uniqueKey":"data.simulationJobs","typeLabel":"object[]"},"attemptSummary":{"type":"object","properties":{"testCaseCount":{"type":"integer","minimum":0,"description":"Test cases in the run. Each one has a single final attempt that its result is read from.","isRequired":true,"uniqueKey":"data.attemptSummary.testCaseCount","typeLabel":"integer"},"attemptCount":{"type":"integer","minimum":0,"description":"Every simulation placed, retries included. Each is a separate, billed call.","isRequired":true,"uniqueKey":"data.attemptSummary.attemptCount","typeLabel":"integer"},"silentAttemptCount":{"type":"integer","minimum":0,"description":"Simulations your agent never spoke on, including the ones a retry replaced.","isRequired":true,"uniqueKey":"data.attemptSummary.silentAttemptCount","typeLabel":"integer"},"retryCount":{"type":"integer","minimum":0,"description":"Simulations placed as a retry of one your agent never spoke on.","isRequired":true,"uniqueKey":"data.attemptSummary.retryCount","typeLabel":"integer"},"stillSilentTestCaseCount":{"type":"integer","minimum":0,"description":"Test cases whose final attempt your agent still never spoke on. This is what the `AGENT_NEVER_SPOKE` verdict failure counts.","isRequired":true,"uniqueKey":"data.attemptSummary.stillSilentTestCaseCount","typeLabel":"integer"}},"required":["testCaseCount","attemptCount","silentAttemptCount","retryCount","stillSilentTestCaseCount"],"description":"The run’s simulations against its test cases. Differs from a plain job count only when the plan retries simulations your agent never spoke on.","isRequired":true,"uniqueKey":"data.attemptSummary","typeLabel":"object"},"pendingRetries":{"type":"array","items":{"type":"object","properties":{"simulationJobId":{"type":"string","format":"uuid","description":"The scheduled retry.","isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].simulationJobId","typeLabel":"string\u003cuuid>"},"attemptNumber":{"type":"integer","exclusiveMinimum":0,"description":"Its place among its test case’s attempts, 2 for the first retry.","isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].attemptNumber","typeLabel":"integer"},"maxAttempts":{"type":"integer","exclusiveMinimum":0,"description":"The most attempts a test case can get on this run: the plan’s `maxNoResponseRetries` plus 1.","isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].maxAttempts","typeLabel":"integer"},"scheduledAt":{"oneOf":[{"type":"string","description":"When the retry dials, ISO 8601. It may wait longer behind the run’s concurrency limit.","isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].scheduledAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the retry dials, ISO 8601. It may wait longer behind the run’s concurrency limit.","isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].scheduledAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.pendingRetries.items.[INDEX].scheduledAt","typeLabel":"string | null"}},"required":["simulationJobId","attemptNumber","maxAttempts","scheduledAt"],"description":"A retry of a simulation your agent never spoke on, waiting out its backoff before it dials.","uniqueKey":"data.pendingRetries.items.[INDEX]","typeLabel":"object"},"description":"Retries waiting out their backoff, soonest first. While this is not empty the run is waiting, not stuck: it settles only once every test case has a final attempt. Empty when nothing is scheduled.","isRequired":true,"uniqueKey":"data.pendingRetries","typeLabel":"object[]"},"startedAt":{"oneOf":[{"type":"string","description":"When the job started","uniqueKey":"data.startedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the job started","uniqueKey":"data.startedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.startedAt","typeLabel":"string | null"},"endedAt":{"oneOf":[{"type":"string","description":"When the job ended","uniqueKey":"data.endedAt.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the job ended","uniqueKey":"data.endedAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.endedAt","typeLabel":"string | null"},"dialRate":{"oneOf":[{"type":"object","description":"The dial rate this run was paced at, and the rate it achieved. `null` for a run started without one.","required":["targetCallsPerSecond","rampUpSeconds","achievedCallsPerSecond"],"properties":{"targetCallsPerSecond":{"type":"number","description":"The `callsPerSecond` the plan asked for when this run started.","isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.targetCallsPerSecond","typeLabel":"number"},"rampUpSeconds":{"oneOf":[{"type":"integer","description":"The ramp up to that rate, in seconds. `null` when the run started at the full rate.","isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.rampUpSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The ramp up to that rate, in seconds. `null` when the run started at the full rate.","isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.rampUpSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.rampUpSeconds","typeLabel":"integer | null"},"achievedCallsPerSecond":{"oneOf":[{"type":"number","description":"Simulations started per second after the ramp, from the first start past it to the last. Below the target when concurrency or phone capacity held the run back. `null` until two have started.","isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.achievedCallsPerSecond.oneOf.0","typeLabel":"number"},{"type":"null","description":"Simulations started per second after the ramp, from the first start past it to the last. Below the target when concurrency or phone capacity held the run back. `null` until two have started.","isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.achievedCallsPerSecond.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.dialRate.oneOf.0.achievedCallsPerSecond","typeLabel":"number | null"}},"uniqueKey":"data.dialRate.oneOf.0","typeLabel":"object"},{"type":"null","description":"The dial rate this run was paced at, and the rate it achieved. `null` for a run started without one.","uniqueKey":"data.dialRate.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.dialRate","typeLabel":"object | null"},"verdict":{"oneOf":[{"type":"object","description":"Pass/fail verdict for this run. Null when the plan carried no pass/fail metric to judge, so an absent verdict means \"nothing to judge\", never a pass.","required":["passed","score","checks","failures"],"example":{"passed":false,"score":85,"checks":[{"metricDefinitionId":"aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa","metricName":"silence duration \u003c 500ms","passRate":100,"minPassRate":40,"inherited":false,"passedSims":10,"evaluatedSims":10,"passed":true},{"metricDefinitionId":"bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb","metricName":"word count \u003c 1000","passRate":70,"minPassRate":80,"inherited":false,"passedSims":7,"evaluatedSims":10,"passed":false}],"failures":[{"type":"METRIC_BELOW_MIN_PASS_RATE","metricDefinitionId":"bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb","metricName":"word count \u003c 1000","passRate":70,"minPassRate":80,"inherited":false}]},"properties":{"passed":{"type":"boolean","description":"Whether every check cleared its own `minPassRate` (and the run completed with full coverage).\nUse this as the CI exit status.\n\nNever derived from `score`: a run can score 95 and still fail, or score 40 and still pass.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.passed","typeLabel":"boolean"},"score":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"The run's headline quality number, 0-100: the mean of each check's own pass rate.\n\nEvery check weighs the same, however many simulations it evaluated, which is the same way\n`passed` treats them. It is the number the Roark dashboard shows for this run.\n\nREPORTING ONLY, for dashboards and trend lines. Nothing is judged against it. Null when\nnothing was evaluated.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.score.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"The run's headline quality number, 0-100: the mean of each check's own pass rate.\n\nEvery check weighs the same, however many simulations it evaluated, which is the same way\n`passed` treats them. It is the number the Roark dashboard shows for this run.\n\nREPORTING ONLY, for dashboards and trend lines. Nothing is judged against it. Null when\nnothing was evaluated.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.score","typeLabel":"number | null"},"checks":{"type":"array","items":{"type":"object","properties":{"metricDefinitionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].metricDefinitionId","typeLabel":"string\u003cuuid>"},"passRate":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"This check's own pass rate, 0-100: the share of sims it evaluated that passed it. Null when it evaluated nothing.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].passRate.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"This check's own pass rate, 0-100: the share of sims it evaluated that passed it. Null when it evaluated nothing.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].passRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].passRate","typeLabel":"number | null"},"minPassRate":{"type":"number","minimum":0,"maximum":100,"description":"THE BAR it was judged against: the share of the run's simulations it had to pass.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].minPassRate","typeLabel":"number"},"inherited":{"type":"boolean","description":"Whether `minPassRate` is the 80% default (`true`) or a minimum this metric set for itself.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].inherited","typeLabel":"boolean"},"passedSims":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].passedSims","typeLabel":"integer"},"evaluatedSims":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].evaluatedSims","typeLabel":"integer"},"passed":{"type":"boolean","description":"`passRate >= minPassRate`.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].passed","typeLabel":"boolean"},"metricName":{"oneOf":[{"type":"string","uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].metricName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].metricName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX].metricName","typeLabel":"string | null"}},"required":["metricDefinitionId","passRate","minPassRate","inherited","passedSims","evaluatedSims","passed"],"description":"How one check did. Present for every check the run was judged on, passing or not.\n\nA check is a metric that yields a pass/fail: a threshold (`Silence Duration \u003c= 2s`) or a\nyes/no metric you authored. Provider readings such as `Comprehension Failure` are\nobservations, not checks: their `true` is whatever the underlying field happens to mean, so\nthey carry no passing side and never appear here. Put a threshold on one to judge it.","uniqueKey":"data.verdict.oneOf.0.checks.items.[INDEX]","typeLabel":"object"},"description":"Every check the run was judged on, with its rate and the minimum it had to reach.\n\nThresholds and authored yes/no metrics only. See `SimulationRunPlanJobCheck` for why a\nprovider reading is not one.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.checks","typeLabel":"object[]"},"failures":{"type":"array","items":{"oneOf":[{"type":"object","description":"One reason the run failed. Every reason is a hard fail: the run passes only when this list is empty.","required":["type","status"],"properties":{"type":{"type":"string","const":"RUN_NOT_COMPLETED","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.0.type","typeLabel":"string"},"status":{"type":"string","enum":["PENDING","QUEUED","CREATING_SNAPSHOTS","CREATING_SIMULATIONS","PREPARING_CAPACITY","RUNNING_SIMULATIONS","COMPLETED","FAILED","TIMED_OUT","CANCELLED","CANCELLING","ENDING_SIMULATIONS"],"description":"The status the run actually ended in.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One reason the run failed. Every reason is a hard fail: the run passes only when this list is empty.","required":["type","evaluatedCalls","expectedCalls"],"properties":{"type":{"type":"string","const":"INCOMPLETE_COVERAGE","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.1.type","typeLabel":"string"},"evaluatedCalls":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.1.evaluatedCalls","typeLabel":"integer"},"expectedCalls":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.1.expectedCalls","typeLabel":"integer"}},"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"One reason the run failed. Every reason is a hard fail: the run passes only when this list is empty.","required":["type","neverSpokeCalls","totalCalls","maxShare"],"properties":{"type":{"type":"string","const":"AGENT_NEVER_SPOKE","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.type","typeLabel":"string"},"neverSpokeCalls":{"type":"integer","minimum":0,"description":"Test cases your agent never spoke on, judged on each test case’s last attempt: a silent simulation a retry later reached your agent on does not count here.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.neverSpokeCalls","typeLabel":"integer"},"totalCalls":{"type":"integer","minimum":0,"description":"Every test case of the run whose last attempt reached your agent.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.totalCalls","typeLabel":"integer"},"maxShare":{"type":"number","minimum":0,"maximum":100,"description":"The largest share of simulations, 0-100, your agent may never speak on while the run can pass.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.maxShare","typeLabel":"number"},"agentName":{"oneOf":[{"type":"string","description":"The agent as the run tested it. Null when the simulations tested more than one agent.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.agentName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The agent as the run tested it. Null when the simulations tested more than one agent.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.agentName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.agentName","typeLabel":"string | null"},"silentAttempts":{"type":"integer","minimum":0,"description":"Every simulation your agent never spoke on, including the ones a retry replaced. Above `neverSpokeCalls` only when the plan retries silent simulations (`maxNoResponseRetries`).","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2.silentAttempts","typeLabel":"integer"}},"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"One reason the run failed. Every reason is a hard fail: the run passes only when this list is empty.","required":["type","metricDefinitionId"],"properties":{"type":{"type":"string","const":"METRIC_NOT_EVALUATED","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3.type","typeLabel":"string"},"metricDefinitionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3.metricDefinitionId","typeLabel":"string\u003cuuid>"},"metricName":{"oneOf":[{"type":"string","description":"The check’s name, for rendering the failure.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3.metricName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The check’s name, for rendering the failure.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3.metricName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3.metricName","typeLabel":"string | null"}},"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"One reason the run failed. Every reason is a hard fail: the run passes only when this list is empty.","required":["type","metricDefinitionId","passRate","minPassRate","inherited"],"properties":{"type":{"type":"string","const":"METRIC_BELOW_MIN_PASS_RATE","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.type","typeLabel":"string"},"metricDefinitionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.metricDefinitionId","typeLabel":"string\u003cuuid>"},"passRate":{"type":"number","minimum":0,"maximum":100,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.passRate","typeLabel":"number"},"minPassRate":{"type":"number","minimum":0,"maximum":100,"isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.minPassRate","typeLabel":"number"},"inherited":{"type":"boolean","description":"Whether the missed minimum was the 80% default (`true`) or this metric's own.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.inherited","typeLabel":"boolean"},"metricName":{"oneOf":[{"type":"string","description":"The check’s name, for rendering the failure.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.metricName.oneOf.0","typeLabel":"string"},{"type":"null","description":"The check’s name, for rendering the failure.","uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.metricName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4.metricName","typeLabel":"string | null"}},"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"data.verdict.oneOf.0.failures.items.[INDEX]","typeLabel":"object"},"description":"Every criterion the run missed. Empty when it passed.","isRequired":true,"uniqueKey":"data.verdict.oneOf.0.failures","typeLabel":"object[]"}},"uniqueKey":"data.verdict.oneOf.0","typeLabel":"object"},{"type":"null","description":"Pass/fail verdict for this run. Null when the plan carried no pass/fail metric to judge, so an absent verdict means \"nothing to judge\", never a pass.","uniqueKey":"data.verdict.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.verdict","typeLabel":"object | null"},"sweepAttribution":{"oneOf":[{"type":"object","description":"For a run that swept a property: which check failures the property caused, which were not specific to it, and which values had too few simulations to compare. Null for a run that swept nothing, and until the run has ended.","required":["values","checks","testableValueCount","testedComparisonCount","minimumDetectableGap","caveats","neverSpokeValues","minArmCalls","falseDiscoveryRate","foundUnattributedFailureRate"],"example":{"values":[{"key":"ACCENT=US","value":"US","label":"American","isBaseline":true,"attempted":3,"counted":2,"silentAttempts":0,"retries":0,"testable":false,"score":50},{"key":"ACCENT=IN","value":"IN","label":"Indian","isBaseline":false,"attempted":8,"counted":8,"silentAttempts":0,"retries":0,"testable":true,"score":62.5},{"key":"ACCENT=GB","value":"GB","label":"British","isBaseline":false,"attempted":8,"counted":8,"silentAttempts":0,"retries":0,"testable":true,"score":68.8}],"checks":[{"metricDefinitionId":"aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa","metricName":"Voice consistency","attribution":"FOUND_UNATTRIBUTED","failed":7,"evaluated":18,"failureRate":38.9,"worseValues":[]}],"testableValueCount":2,"testedComparisonCount":8,"minimumDetectableGap":45,"caveats":["American had fewer than 5 counted calls, so it is shown but not compared.","With about 8 calls per value, only large differences can be detected: a value would need to fail roughly 45 points more often than the rest to be reliably flagged. Smaller effects may exist and go unseen."],"neverSpokeValues":[],"minArmCalls":5,"falseDiscoveryRate":0.1,"foundUnattributedFailureRate":20},"properties":{"values":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The arm's identity: the override signature its calls ran with, e.g. `BACKGROUND_NOISE=DRIVING;BACKGROUND_NOISE_VOLUME=0.7`. Join on this rather than on `value`: a sweep can run one value as several arms (Driving at 70% and at 100%), and those share a value.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","description":"The stored value of the swept property, e.g. `US`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","description":"The value in words, with what else the arm pinned, e.g. `American` or `Driving (70% noise)`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].label","typeLabel":"string"},"isBaseline":{"type":"boolean","description":"Whether this is the baseline the plan named.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].isBaseline","typeLabel":"boolean"},"attempted":{"type":"integer","minimum":0,"description":"Simulations run at this value. Simulations that failed on the Roark platform are left out, since they say nothing about your agent.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].attempted","typeLabel":"integer"},"counted":{"type":"integer","minimum":0,"description":"Simulations that actually tested the property: not invalidated, and graded by at least one check. Only these are used in the comparison.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].counted","typeLabel":"integer"},"silentAttempts":{"type":"integer","minimum":0,"description":"Of `attempted`, the simulations your agent never spoke on, whether or not a retry followed. They are invalidated, so they are never in `counted`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].silentAttempts","typeLabel":"integer"},"retries":{"type":"integer","minimum":0,"description":"Of `attempted`, the retries of simulations your agent never spoke on. Zero unless the plan retries silent simulations.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].retries","typeLabel":"integer"},"testable":{"type":"boolean","description":"Whether this value had at least `minArmCalls` counted simulations. A value below that is \"insufficient data\": it is reported with its numbers but never compared or ranked, because a rate from one or two calls cannot be told apart from luck.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].testable","typeLabel":"boolean"},"score":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"The mean of each check's pass rate at this value, 0-100, the same rule as the run's `score`. Descriptive only: a lower score alone never makes a value worse. Null when nothing counted.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].score.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"The mean of each check's pass rate at this value, 0-100, the same rule as the run's `score`. Descriptive only: a lower score alone never makes a value worse. Null when nothing counted.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].score.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX].score","typeLabel":"number | null"}},"required":["key","value","label","isBaseline","attempted","counted","silentAttempts","retries","testable","score"],"description":"One value of the swept property.","uniqueKey":"data.sweepAttribution.oneOf.0.values.items.[INDEX]","typeLabel":"object"},"description":"Every value of the swept property, baseline first.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.values","typeLabel":"object[]"},"checks":{"type":"array","items":{"type":"object","properties":{"metricDefinitionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].metricDefinitionId","typeLabel":"string\u003cuuid>"},"metricName":{"type":"string","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].metricName","typeLabel":"string"},"attribution":{"type":"string","enum":["PROPERTY_ATTRIBUTABLE","FOUND_UNATTRIBUTED","WITHIN_NOISE"],"description":"How this check relates to the swept property:\n\n- `PROPERTY_ATTRIBUTABLE`: at least one value failed it significantly more often than every other value combined. `worseValues` names them. This is the only case in which a value is called worse.\n- `FOUND_UNATTRIBUTED`: no value stands out, but the check failed on at least `foundUnattributedFailureRate`% of counted simulations overall. A real issue with the agent on which no value stood out, so the run cannot tie it to the property. It does not show the property had no effect: a small run may be unable to see one.\n- `WITHIN_NOISE`: neither. Any differences between values are within what chance produces.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].attribution","typeLabel":"enum\u003cstring>"},"failed":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].failed","typeLabel":"integer"},"evaluated":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].evaluated","typeLabel":"integer"},"failureRate":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"Share of counted simulations across every value that failed the check, 0-100.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].failureRate.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"Share of counted simulations across every value that failed the check, 0-100.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].failureRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].failureRate","typeLabel":"number | null"},"worseValues":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The arm's identity: the override signature its calls ran with, e.g. `BACKGROUND_NOISE=DRIVING;BACKGROUND_NOISE_VOLUME=0.7`. Join on this rather than on `value`: a sweep can run one value as several arms (Driving at 70% and at 100%), and those share a value.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].label","typeLabel":"string"},"failed":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].failed","typeLabel":"integer"},"evaluated":{"type":"integer","minimum":0,"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].evaluated","typeLabel":"integer"},"failureRate":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"Share of the counted simulations at this value that failed the check, 0-100.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].failureRate.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"Share of the counted simulations at this value that failed the check, 0-100.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].failureRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].failureRate","typeLabel":"number | null"},"restFailureRate":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"The same share across every other value combined, 0-100. This is what the value is compared with.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].restFailureRate.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"The same share across every other value combined, 0-100. This is what the value is compared with.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].restFailureRate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].restFailureRate","typeLabel":"number | null"},"adjustedPValue":{"type":"number","minimum":0,"maximum":1,"description":"How likely a difference at least this large would be by chance alone, after correcting for every comparison in the run (Benjamini-Hochberg). The value is called worse only when this is at most `falseDiscoveryRate`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX].adjustedPValue","typeLabel":"number"}},"required":["key","value","label","failed","evaluated","failureRate","restFailureRate","adjustedPValue"],"description":"A value that failed a check significantly more often than the rest of the run.","uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues.items.[INDEX]","typeLabel":"object"},"description":"The values significantly worse than the rest, most significant first. Empty unless `attribution` is `PROPERTY_ATTRIBUTABLE`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX].worseValues","typeLabel":"object[]"}},"required":["metricDefinitionId","metricName","attribution","failed","evaluated","failureRate","worseValues"],"description":"How one check's failures relate to the swept property.","uniqueKey":"data.sweepAttribution.oneOf.0.checks.items.[INDEX]","typeLabel":"object"},"description":"Every check the run was graded on: `PROPERTY_ATTRIBUTABLE` first, then `FOUND_UNATTRIBUTED`, then `WITHIN_NOISE`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.checks","typeLabel":"object[]"},"testableValueCount":{"type":"integer","minimum":0,"description":"How many values had enough counted simulations to be compared.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.testableValueCount","typeLabel":"integer"},"testedComparisonCount":{"type":"integer","minimum":0,"description":"How many value and check pairs were actually tested. A value can have enough simulations and still go untested (no other value graded that check, or too few verdicts on it). When this is 0 no comparison ran, so an empty `worseValues` everywhere means nothing was tested, not that no value did worse.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.testedComparisonCount","typeLabel":"integer"},"minimumDetectableGap":{"oneOf":[{"type":"number","minimum":0,"maximum":100,"description":"Roughly how many percentage points more often a value would need to fail than the rest of the run to be flagged at this sample size. Optimistic: it uses simulation counts rather than the verdicts on each check and ignores the correction, so checks graded on fewer simulations need larger gaps. Large when few simulations ran per value: finding no significant difference then means the run could not see one, not that none exists.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.minimumDetectableGap.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"maximum":100,"description":"Roughly how many percentage points more often a value would need to fail than the rest of the run to be flagged at this sample size. Optimistic: it uses simulation counts rather than the verdicts on each check and ignores the correction, so checks graded on fewer simulations need larger gaps. Large when few simulations ran per value: finding no significant difference then means the run could not see one, not that none exists.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.minimumDetectableGap.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.minimumDetectableGap","typeLabel":"number | null"},"caveats":{"type":"array","items":{"type":"string","uniqueKey":"data.sweepAttribution.oneOf.0.caveats.items.[INDEX]","typeLabel":"string"},"description":"Plain sentences on what this run could not see, ready to show to a reader.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.caveats","typeLabel":"string[]"},"neverSpokeValues":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"The arm's identity: the override signature its calls ran with, e.g. `BACKGROUND_NOISE=DRIVING;BACKGROUND_NOISE_VOLUME=0.7`. Join on this rather than on `value`: a sweep can run one value as several arms (Driving at 70% and at 100%), and those share a value.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].key","typeLabel":"string"},"value":{"type":"string","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].label","typeLabel":"string"},"silentAttempts":{"type":"integer","minimum":0,"description":"Simulations at this value your agent never spoke on, retried or not.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].silentAttempts","typeLabel":"integer"},"attempted":{"type":"integer","minimum":0,"description":"Simulations run at this value.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].attempted","typeLabel":"integer"},"retries":{"type":"integer","minimum":0,"description":"Retries placed at this value because your agent never spoke.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].retries","typeLabel":"integer"},"restSilentAttempts":{"type":"integer","minimum":0,"description":"Simulations your agent never spoke on across every other value combined.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].restSilentAttempts","typeLabel":"integer"},"restAttempted":{"type":"integer","minimum":0,"description":"Simulations run across every other value combined.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].restAttempted","typeLabel":"integer"},"adjustedPValue":{"type":"number","minimum":0,"maximum":1,"description":"How likely a difference at least this large would be by chance alone, after correcting across the values (Benjamini-Hochberg).","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX].adjustedPValue","typeLabel":"number"}},"required":["key","value","label","silentAttempts","attempted","retries","restSilentAttempts","restAttempted","adjustedPValue"],"description":"A value your agent never spoke on significantly more often than the rest of the run.","uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues.items.[INDEX]","typeLabel":"object"},"description":"The values your agent never spoke on significantly more often than the rest of the run, most significant first, tested the same way as `worseValues`. Empty on a run with no silent simulations.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.neverSpokeValues","typeLabel":"object[]"},"minArmCalls":{"type":"integer","exclusiveMinimum":0,"description":"Counted simulations a value needs before it is compared.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.minArmCalls","typeLabel":"integer"},"falseDiscoveryRate":{"type":"number","minimum":0,"maximum":1,"description":"The Benjamini-Hochberg false discovery rate the comparisons are held to.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.falseDiscoveryRate","typeLabel":"number"},"foundUnattributedFailureRate":{"type":"number","minimum":0,"maximum":100,"description":"The overall failure rate, 0-100, at which a check with no standout value is reported as `FOUND_UNATTRIBUTED`.","isRequired":true,"uniqueKey":"data.sweepAttribution.oneOf.0.foundUnattributedFailureRate","typeLabel":"number"}},"uniqueKey":"data.sweepAttribution.oneOf.0","typeLabel":"object"},{"type":"null","description":"For a run that swept a property: which check failures the property caused, which were not specific to it, and which values had too few simulations to compare. Null for a run that swept nothing, and until the run has ended.","uniqueKey":"data.sweepAttribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.sweepAttribution","typeLabel":"object | null"}},"required":["simulationRunPlanJobId","simulationRunPlanId","status","createdAt","simulationJobs","attemptSummary","pendingRetries"],"description":"Simulation run plan job with all associated simulation jobs","example":{"simulationRunPlanJobId":"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f","simulationRunPlanId":"9a8b7c6d-5e4f-3210-abcd-ef9876543210","status":"RUNNING_SIMULATIONS","createdAt":"2024-01-15T10:30:00Z","startedAt":"2024-01-15T10:30:15Z","endedAt":null,"simulationJobs":[{"simulationJobId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"COMPLETED","processingStatus":"COMPLETED","callId":"b2c3d4e5-f6a7-8901-bcde-f23456789012","roarkPhoneNumber":"+15551234567","invalidation":null,"retryOfSimulationJobId":null,"attemptNumber":1,"scheduledAt":null,"persona":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"Sarah Johnson - Anxious Patient","displayName":"Anxious Patient","language":"EN","secondaryLanguage":null,"understoodLanguages":["EN"],"accent":"US","age":"ADULT","gender":"FEMALE","backgroundNoise":"OFFICE","speechPace":"NORMAL","speechClarity":"CLEAR","hasDisfluencies":false,"baseEmotion":"FRUSTRATED","intentClarity":"CLEAR","confirmationStyle":"EXPLICIT","memoryReliability":"HIGH","responseTiming":"NORMAL","interruption":"OCCASIONAL","backstoryPrompt":"A busy professional calling during lunch break","idleMessages":null,"idleTimeoutSeconds":10,"idleMessageMaxSpokenCount":3,"idleMessageResetCountOnUserSpeechEnabled":true,"properties":{"age":"35","zipCode":"94105"},"createdAt":"2025-01-10T12:00:00.000Z","updatedAt":"2025-01-10T12:00:00.000Z"},"backgroundNoise":{"backgroundNoise":"CITY","backgroundNoiseVolume":0.1,"source":"ENVIRONMENT"},"scenario":{"id":"f8e7d6c5-b4a3-9281-7069-5f4e3d2c1b0a","description":"Patient calling to schedule an urgent dental appointment"},"agentEndpoint":{"id":"3c2b1a09-8f7e-6d5c-4b3a-291807060504","name":"PHONE","phoneNumber":"+15555551234","type":"PHONE"},"createdAt":"2024-01-15T10:30:20Z","startedAt":"2024-01-15T10:30:25Z","completedAt":"2024-01-15T10:32:45Z"}],"attemptSummary":{"testCaseCount":1,"attemptCount":1,"silentAttemptCount":0,"retryCount":0,"stillSilentTestCaseCount":0},"pendingRetries":[],"dialRate":null},"isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"simulationRunPlanJobId":"7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f","simulationRunPlanId":"9a8b7c6d-5e4f-3210-abcd-ef9876543210","status":"RUNNING_SIMULATIONS","createdAt":"2024-01-15T10:30:00Z","startedAt":"2024-01-15T10:30:15Z","endedAt":null,"simulationJobs":[{"simulationJobId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"COMPLETED","processingStatus":"COMPLETED","callId":"b2c3d4e5-f6a7-8901-bcde-f23456789012","roarkPhoneNumber":"+15551234567","invalidation":null,"retryOfSimulationJobId":null,"attemptNumber":1,"scheduledAt":null,"persona":{"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","name":"Sarah Johnson - Anxious Patient","displayName":"Anxious Patient","language":"EN","secondaryLanguage":null,"understoodLanguages":["EN"],"accent":"US","age":"ADULT","gender":"FEMALE","backgroundNoise":"OFFICE","speechPace":"NORMAL","speechClarity":"CLEAR","hasDisfluencies":false,"baseEmotion":"FRUSTRATED","intentClarity":"CLEAR","confirmationStyle":"EXPLICIT","memoryReliability":"HIGH","responseTiming":"NORMAL","interruption":"OCCASIONAL","backstoryPrompt":"A busy professional calling during lunch break","idleMessages":null,"idleTimeoutSeconds":10,"idleMessageMaxSpokenCount":3,"idleMessageResetCountOnUserSpeechEnabled":true,"properties":{"age":"35","zipCode":"94105"},"createdAt":"2025-01-10T12:00:00.000Z","updatedAt":"2025-01-10T12:00:00.000Z"},"backgroundNoise":{"backgroundNoise":"CITY","backgroundNoiseVolume":0.1,"source":"ENVIRONMENT"},"scenario":{"id":"f8e7d6c5-b4a3-9281-7069-5f4e3d2c1b0a","description":"Patient calling to schedule an urgent dental appointment"},"agentEndpoint":{"id":"3c2b1a09-8f7e-6d5c-4b3a-291807060504","name":"PHONE","phoneNumber":"+15555551234","type":"PHONE"},"createdAt":"2024-01-15T10:30:20Z","startedAt":"2024-01-15T10:30:25Z","completedAt":"2024-01-15T10:32:45Z"}],"attemptSummary":{"testCaseCount":1,"attemptCount":1,"silentAttemptCount":0,"retryCount":0,"stillSilentTestCaseCount":0},"pendingRetries":[],"dialRate":null}}}},"exampleType":"generated"}},"exampleType":"generated"},"7cbfe892-e3ad-400e-ad68-dcdfdcb605db":{"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"},"642cd616-c633-472e-8436-8d6c299aeca0":{"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"},"6bb08ae9-f095-4c40-8745-6408ae7af642":{"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"},"2fdbfabb-9238-4e6e-9826-62fedf883cce":{"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":"Simulation plan job not found","exampleType":"examples"},"932cecb6-4ea5-415d-b17b-25aea801a03e":{"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"},"2df7e35b-17bb-4756-a7ba-0a7fd7651938":{"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"}},"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":"Get a simulation run - Roark Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T19:43:11.498Z","originalFileLocation":"api-reference/simulation-run/get-a-simulation-run.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=\"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\">\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=\"Get a simulation run - Roark Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\">\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/simulation-run/get-a-simulation-run\">\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=Runs\u0026amp;title=Get+a+simulation+run\u0026amp;description=Retrieve+details+of+a+simulation+plan+job+including+all+associated+simulation+jobs+%28calls%29\u0026amp;theme=0f3fa282babd51a23ab3534f\u0026amp;signature=94d4bd9fd17b9d043c81cb7b04ecdd8ab37c370d423cc2cb253b363062e58dcd\">\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=\"Get a simulation run - Roark Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://roark.mintlify.site/_mintlify/api/og/v2?division=Runs\u0026amp;title=Get+a+simulation+run\u0026amp;description=Retrieve+details+of+a+simulation+plan+job+including+all+associated+simulation+jobs+%28calls%29\u0026amp;theme=0f3fa282babd51a23ab3534f\u0026amp;signature=94d4bd9fd17b9d043c81cb7b04ecdd8ab37c370d423cc2cb253b363062e58dcd\">\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/simulation-run/get-a-simulation-run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/simulation-run/get-a-simulation-run.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/simulation-run/get-a-simulation-run#webpage\",\"url\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run\",\"name\":\"Get a simulation run\",\"description\":\"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\",\"dateModified\":\"2026-11-17T19:43:11.498Z\",\"isPartOf\":{\"@id\":\"https://docs.roark.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run#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\":\"Runs\",\"item\":\"https://docs.roark.ai/api-reference/simulation-run/list-simulation-runs\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a simulation run\",\"item\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run#apireference\",\"headline\":\"Get a simulation run\",\"name\":\"Get a simulation run\",\"description\":\"Retrieve details of a simulation plan job including all associated simulation jobs (calls)\",\"url\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.roark.ai/api-reference/simulation-run/get-a-simulation-run#webpage\"},\"dateModified\":\"2026-11-17T19:43:11.498Z\",\"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/simulation-run/get-a-simulation-run.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","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","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","description":"Starts a simulation and returns the run.\n\nSend `template` to run one of the built-in templates: it supplies the metrics and checks,\nand for some templates the flows too, so the request only names the agent and the direction.\nSend `plan` to describe a simulation yourself and run it once. Send `planId` to run a plan\nyou already have.\n\n`template` and `plan` both resolve to a run plan, returned as `simulationRunPlanId`. Add\n`saveAsPlan` to keep it, or read it back to see exactly what ran. A plan built from a\ntemplate is a snapshot: retuning the template later never changes what that plan runs, which\nis what makes a saved one safe to pin in CI.","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","description":"Removes a finished run from the run history (a soft delete). The run stops appearing in run lists,\ncounts and plan run histories, and reading it by ID returns 404.\n\nA run that is still in progress is refused with 409: cancel it first.","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":"Get a simulation run - 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"]}