import Retell from 'retell-sdk';
const client = new Retell({
apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});
const testCaseJobResponse = await client.tests.getTestRun('test_case_job_id');
console.log(testCaseJobResponse.test_case_definition_id);
import os
from retell import Retell
client = Retell(
api_key=os.environ.get("RETELL_API_KEY"), # This is the default and can be omitted
)
test_case_job_response = client.tests.get_test_run(
"test_case_job_id",
)
print(test_case_job_response.test_case_definition_id)
{
"status": "error",
"message": "An unexpected server error occurred."
}
Authorizations
Authorization
string
header
required
Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"
Path Parameters
test_case_job_id
string
required
ID of the test case job to retrieve
Response
Test case job retrieved successfully
test_case_job_id
string
required
Unique identifier for the test case job
status
enum<string>
required
Status of the test case job. pending means the run is queued but has not started yet; it becomes in_progress once a worker picks it up, then resolves to pass, fail, or error.
Available options:
pending,
in_progress,
pass,
fail,
error
test_case_definition_id
string
required
ID of the test case definition used
test_case_definition_snapshot
object
required
Snapshot of the test case definition at time of execution
Show child attributes
creation_timestamp
integer
required
Timestamp when the test case job was created (milliseconds since epoch)
user_modified_timestamp
integer
required
Timestamp when the test case job was last modified (milliseconds since epoch)
transcript_snapshot
object | null
Snapshot of the transcript generated during test execution. Can be either ConversationFlowPlaygroundSnapshot or RetellLlmPlaygroundSnapshot
result_explanation
string | null
Explanation of the test result
Was this page helpful?
⌘I
JavaScript
import Retell from 'retell-sdk';
const client = new Retell({
apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});
const testCaseJobResponse = await client.tests.getTestRun('test_case_job_id');
console.log(testCaseJobResponse.test_case_definition_id);
import os
from retell import Retell
client = Retell(
api_key=os.environ.get("RETELL_API_KEY"), # This is the default and can be omitted
)
test_case_job_response = client.tests.get_test_run(
"test_case_job_id",
)
print(test_case_job_response.test_case_definition_id)
{
"status": "error",
"message": "An unexpected server error occurred."
}
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Retell AI","description":"Explore Retell AI docs to learn how to build, test, deploy, and optimize AI voice agents with APIs, integrations, conversation flows, and production-ready tools.","colors":{"primary":"#606A78","light":"#F5F5FA","dark":"#172131"},"logo":{"light":"https://mintcdn.com/retellai/-E9UettTBfBiCBBS/images/docs-light.png?fit=max\u0026auto=format\u0026n=-E9UettTBfBiCBBS\u0026q=85\u0026s=64eb26a2d3cc9a67ee3ea0bfe086dd14","dark":"https://mintcdn.com/retellai/-E9UettTBfBiCBBS/images/docs-dark.png?fit=max\u0026auto=format\u0026n=-E9UettTBfBiCBBS\u0026q=85\u0026s=08472a0c78599498b85d23348d7826f6"},"favicon":"https://mintcdn.com/retellai/TsBk7Stx4694-7p1/logo/favicon-light.ico?fit=max\u0026auto=format\u0026n=TsBk7Stx4694-7p1\u0026q=85\u0026s=4e90f4db5e89b5ec7fe249a4844c2d97","api":{"openapi":["openapi-final.yaml"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.retellai.com"}},"navbar":{"links":[{"icon":"message-circle-question-mark","href":"https://docs.retellai.com/general/support","label":"Support"},{"icon":"chart-line","href":"https://status.retellai.com/","label":"Status"},{"icon":"book","href":"https://www.retellai.com/changelog","label":"Changelog"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.retellai.com"}},"footer":{"socials":{"x":"https://x.com/retellai","linkedin":"https://www.linkedin.com/company/98828489","github":"https://github.com/RetellAI","instagram":"https://www.instagram.com/retell_ai","youtube":"https://www.youtube.com/@retellai"}},"fonts":{"family":"Inter"},"icons":{"library":"lucide"},"styling":{"codeblocks":"dark","latex":true},"integrations":{"mixpanel":{"projectToken":"c8676d3561adb5eefc366aa2a66725bc"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retellai","hasAudioNarration":false,"actualSubdomain":"retellai","customDomains":["docs.retellai.com"],"gitSource":{"type":"github","owner":"retellai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff925fe928c7c97409b0ed","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"Guides","count":217},{"language":"default","tag":"API Reference","count":107},{"language":"default","tag":"Build","count":68},{"language":"default","tag":"Deploy","count":35},{"language":"default","tag":"Integrations","count":31},{"language":"default","tag":"Conversation flow agents","count":24},{"language":"default","tag":"Deprecations","count":24},{"language":"default","tag":"Detailed Deprecation Guide","count":23},{"language":"default","tag":"CRM","count":21},{"language":"default","tag":"Accounts and Workspace","count":17}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"site-roles","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":"instinct-self-updating-docs","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"@media (min-width: 1024px){#navbar .flex-1:has(>[data-slot=\"context-menu-trigger\"]),#navbar .flex-1:has(>a>.nav-logo){flex:none!important;width:15rem}#navbar .ustify-end:has(.nav-tabs),#navbar .justify-end:has(.nav-tabs){justify-content:space-between!important;margin-left:0!important}#navbar .flex:has(>.ustify-end),#navbar .flex:has(>.justify-end){flex:1!important}#navbar .nav-tabs{white-space:nowrap}}article{max-width:48rem!important}.max-w-prose{max-width:48rem!important}.max-w-xl{max-width:48rem!important}video.scroll-play{cursor:zoom-in}.video-zoom-overlay{position:fixed;inset:0;z-index:9999;display:flex;align-items:center;justify-content:center;padding:4vmin;background:rgba(0, 0, 0, 0.8);backdrop-filter:blur(2px);cursor:zoom-out}.video-zoom-media{max-width:92vw;max-height:92vh;width:auto;height:auto;border-radius:12px;box-shadow:0 10px 40px rgba(0, 0, 0, 0.5);cursor:default}.video-zoom-close{position:fixed;top:16px;right:20px;display:flex;align-items:center;justify-content:center;width:40px;height:40px;padding:0;border:none;border-radius:999px;background:rgba(255, 255, 255, 0.15);color:#fff;font-size:24px;line-height:1;cursor:pointer}.video-zoom-close:hover{background:rgba(255, 255, 255, 0.3)}.ui-btn{background-color:#f4f5f7!important;color:#1f2328!important;border:1px solid #d0d5dd!important;border-bottom-width:2px!important;border-radius:6px!important;padding:0.1em 0.42em!important}html.dark .ui-btn,[data-theme=\"dark\"] .ui-btn{background-color:#21252d!important;color:#e6e8eb!important;border-color:#3a4048!important}img[src$=\"/images/icons/wss-badge.svg\"]{width:auto!important;height:15px!important}a[aria-current=\"page\"] img[src$=\"/images/icons/wss-badge.svg\"]{content:url(\"data:image/svg+xml,%3Csvg xmlns=%22http://www.w3.org/2000/svg%22 width=%2227%22 height=%2215%22 viewBox=%220 0 27 15%22 role=%22img%22 aria-label=%22WSS%22%3E %3Crect width=%2227%22 height=%2215%22 rx=%224%22 fill=%22%23F54A00%22/%3E %3Ctext x=%2213.5%22 y=%2210.7%22 text-anchor=%22middle%22 font-family=%22ui-sans-serif, system-ui, -apple-system, Segoe UI, Inter, Helvetica, Arial, sans-serif%22 font-size=%228.8%22 font-weight=%22700%22 fill=%22%23FFFFFF%22%3EWSS%3C/text%3E %3C/svg%3E\")}"}]}
{"page":{"pagePath":"api-references/get-test-run","slug":"/api-references/get-test-run","pageMetadata":{"title":"Get Test Run","openapi":"openapi-final get /get-test-run/{test_case_job_id}","description":"Get a test case job (test run) by ID","href":"/api-references/get-test-run"},"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: \"Get a test case job (test run) by ID\"\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":"dark","config":{},"pageMetadata":{"title":"Get Test Run","openapi":"openapi-final get /get-test-run/{test_case_job_id}","description":"Get a test case job (test run) by ID","href":"/api-references/get-test-run"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/retellai/e3fe5c9b64f9e274/scroll-play-videos.js"],"openApiReferenceData":{"operation":{"description":"Get a test case job (test run) by ID","operationId":"getTestRun","parameters":["6b324729-4b9a-429b-b76a-d22f098ff3c4"],"responses":{"200":"d9d72286-a855-480d-a79d-1c881656c06d","400":"7fc59bbf-f7ea-44db-899e-d57b4d3d576e","401":"cc379998-7928-4d94-8485-5ac6a86ce69b","404":"73ebd2f3-008d-47b8-8626-4a1261695a9c","429":"fe22ea16-d195-40f3-89f6-d94e38de64ec","500":"c8cc1c58-b4ae-4800-8758-7227b17d4733"},"x-codeSamples":[{"lang":"JavaScript","source":"import Retell from 'retell-sdk';\n\nconst client = new Retell({\n apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted\n});\n\nconst testCaseJobResponse = await client.tests.getTestRun('test_case_job_id');\n\nconsole.log(testCaseJobResponse.test_case_definition_id);"},{"lang":"Python","source":"import os\nfrom retell import Retell\n\nclient = Retell(\n api_key=os.environ.get(\"RETELL_API_KEY\"), # This is the default and can be omitted\n)\ntest_case_job_response = client.tests.get_test_run(\n \"test_case_job_id\",\n)\nprint(test_case_job_response.test_case_definition_id)"}],"method":"get","type":"path","servers":["714d602d-4888-4d5a-8a68-67611f5a5f79"],"security":["562dbd81-4dc1-41b7-a2ce-b4235fd9f37b"],"path":"/get-test-run/{test_case_job_id}","baseUrlOptions":["https://api.retellai.com"],"title":"","codeSamples":[{"lang":"JavaScript","source":"import Retell from 'retell-sdk';\n\nconst client = new Retell({\n apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted\n});\n\nconst testCaseJobResponse = await client.tests.getTestRun('test_case_job_id');\n\nconsole.log(testCaseJobResponse.test_case_definition_id);"},{"lang":"Python","source":"import os\nfrom retell import Retell\n\nclient = Retell(\n api_key=os.environ.get(\"RETELL_API_KEY\"), # This is the default and can be omitted\n)\ntest_case_job_response = client.tests.get_test_run(\n \"test_case_job_id\",\n)\nprint(test_case_job_response.test_case_definition_id)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"6b324729-4b9a-429b-b76a-d22f098ff3c4":{"in":"path","name":"test_case_job_id","schema":{"type":"string","isRequired":true,"description":"ID of the test case job to retrieve","uniqueKey":"","typeLabel":"string"},"required":true,"description":"ID of the test case job to retrieve"}},"responses":{"d9d72286-a855-480d-a79d-1c881656c06d":{"description":"Test case job retrieved successfully","content":{"application/json":{"schema":{"type":"object","required":["test_case_job_id","status","test_case_definition_id","test_case_definition_snapshot","creation_timestamp","user_modified_timestamp"],"properties":{"test_case_job_id":{"type":"string","description":"Unique identifier for the test case job","isRequired":true,"uniqueKey":"test_case_job_id","typeLabel":"string"},"status":{"type":"string","enum":["pending","in_progress","pass","fail","error"],"description":"Status of the test case job. `pending` means the run is queued but has not started yet; it becomes `in_progress` once a worker picks it up, then resolves to `pass`, `fail`, or `error`.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"test_case_definition_id":{"type":"string","description":"ID of the test case definition used","isRequired":true,"uniqueKey":"test_case_definition_id","typeLabel":"string"},"test_case_definition_snapshot":{"type":"object","description":"Snapshot of the test case definition at time of execution","required":["name","response_engine","metrics","user_prompt","dynamic_variables","tool_mocks","llm_model","test_case_definition_id","type","creation_timestamp","user_modified_timestamp"],"properties":{"name":{"type":"string","description":"Name of the test case definition","isRequired":true,"uniqueKey":"test_case_definition_snapshot.name","typeLabel":"string"},"response_engine":{"oneOf":[{"type":"object","description":"Response engine to use for the test case. Custom LLM is not supported.","required":["type","llm_id"],"properties":{"type":{"type":"string","enum":["retell-llm"],"description":"type of the Response Engine.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0.type","typeLabel":"enum\u003cstring>"},"llm_id":{"type":"string","description":"id of the Retell LLM Response Engine.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0.llm_id","typeLabel":"string"},"version":{"oneOf":[{"type":"number","example":0,"description":"Version of the Retell LLM Response Engine.","uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0.version.oneOf.0","typeLabel":"number"},{"type":"null","example":0,"description":"Version of the Retell LLM Response Engine.","uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0.version.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0.version","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.0","typeLabel":"object"},{"type":"object","description":"Response engine to use for the test case. Custom LLM is not supported.","required":["type","conversation_flow_id"],"properties":{"type":{"type":"string","enum":["conversation-flow"],"description":"type of the Response Engine.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1.type","typeLabel":"enum\u003cstring>"},"conversation_flow_id":{"type":"string","description":"ID of the Conversation Flow Response Engine.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1.conversation_flow_id","typeLabel":"string"},"version":{"oneOf":[{"type":"number","example":0,"description":"Version of the Conversation Flow Response Engine.","uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1.version.oneOf.0","typeLabel":"number"},{"type":"null","example":0,"description":"Version of the Conversation Flow Response Engine.","uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1.version.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1.version","typeLabel":"number | null"}},"isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"test_case_definition_snapshot.response_engine","typeLabel":"object"},"user_prompt":{"type":"string","description":"User prompt to simulate in the test case","isRequired":true,"uniqueKey":"test_case_definition_snapshot.user_prompt","typeLabel":"string"},"metrics":{"type":"array","items":{"type":"string","uniqueKey":"test_case_definition_snapshot.metrics.items.[INDEX]","typeLabel":"string"},"description":"Array of metric names to evaluate","isRequired":true,"uniqueKey":"test_case_definition_snapshot.metrics","typeLabel":"string[]"},"dynamic_variables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"test_case_definition_snapshot.dynamic_variables.additionalProperties","typeLabel":"string"},"description":"Dynamic variables to inject into the response engine","isRequired":true,"uniqueKey":"test_case_definition_snapshot.dynamic_variables","typeLabel":"object"},"tool_mocks":{"type":"array","items":{"description":"A fake response for one tool. During a simulation, when a tool call matches `tool_name`, `node_id` and `input_match_rule`, the real tool is not run; `output` is returned to the LLM instead. This keeps runs deterministic and avoids calling live integrations. A tool call that matches no mock falls through to the real tool.","type":"object","required":["input_match_rule","output"],"properties":{"input_match_rule":{"oneOf":[{"type":"object","description":"Decides which calls to this tool the mock applies to.","required":["type"],"properties":{"type":{"type":"string","enum":["any"],"description":"Match every call to the tool, no matter what arguments were passed. Use this for a catch-all mock.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule.oneOf.0","typeLabel":"object"},{"type":"object","description":"Decides which calls to this tool the mock applies to.","required":["type","args"],"properties":{"type":{"type":"string","enum":["partial_match"],"description":"Match only calls whose arguments contain the values listed in `args`.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule.oneOf.1.type","typeLabel":"enum\u003cstring>"},"args":{"type":"object","description":"Argument values the call must have to match. Only the fields you list here are checked, and each must equal the value in the actual call. Extra fields in the call are ignored, so this is a subset match.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule.oneOf.1.args","typeLabel":"object"}},"isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].input_match_rule","typeLabel":"object"},"output":{"type":"string","maxLength":15000,"description":"The tool result fed back to the LLM in place of the real tool's output. Should be a JSON string, the same shape the real tool would return.","isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].output","typeLabel":"string"},"tool_name":{"type":"string","description":"The tool's function name, not the tool ID, i.e. the name the LLM uses when it calls the tool (for example `check_availability_cal`, `book_appointment_cal`, or the name you gave a custom function). Leave it out to match every tool.","uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].tool_name","typeLabel":"string"},"node_id":{"type":"string","description":"Conversation flow agents only. The ID of the node the tool runs in. Leave it out to match every node. To mock an SMS or Call Transfer node, set `node_id` and `result`, and leave out `tool_name`.","uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].node_id","typeLabel":"string"},"result":{"oneOf":[{"type":"boolean","description":"Whether the call succeeds (`true`) or fails (`false`). Required to mock SMS, transfer and escalation calls; for those calls, a mock without `result` is ignored. Not used for other tools.","uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].result.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether the call succeeds (`true`) or fails (`false`). Required to mock SMS, transfer and escalation calls; for those calls, a mock without `result` is ignored. Not used for other tools.","uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].result.oneOf.1","typeLabel":"null"}],"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX].result","typeLabel":"boolean | null"}},"uniqueKey":"test_case_definition_snapshot.tool_mocks.items.[INDEX]","typeLabel":"object"},"description":"Mock tool calls for testing","isRequired":true,"uniqueKey":"test_case_definition_snapshot.tool_mocks","typeLabel":"object[]"},"llm_model":{"type":"string","enum":["gpt-4.1","gpt-4.1-mini","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5.1","gpt-5.2","gpt-5.4","gpt-5.4-mini","gpt-5.4-nano","gpt-5.5","gpt-5.6-terra","gpt-5.6-luna","gpt-6.2-astra","gpt-6.2-sol","gpt-6-astra","gpt-6-sol","gpt-6.1-sol","gpt-6.1-terra","gpt-6-luna","tell-1","claude-4.6-sonnet","claude-5-opus","claude-5.5-opus","claude-5-sonnet","claude-5.5-sonnet","claude-5.5-haiku","claude-4.5-haiku","gemini-3.0-flash","gemini-3.1-flash-lite","gemini-3.5-flash","gemini-3.5-flash-lite","gemini-3.6-flash","gemini-3.7-flash","gemini-3.8-flash","gemini-4-hydrogen","gemini-4-carbon","gemini-4-argon"],"description":"LLM model to use for simulation","isRequired":true,"uniqueKey":"test_case_definition_snapshot.llm_model","typeLabel":"enum\u003cstring>"},"test_case_definition_id":{"type":"string","description":"Unique identifier for the test case definition","isRequired":true,"uniqueKey":"test_case_definition_snapshot.test_case_definition_id","typeLabel":"string"},"type":{"type":"string","enum":["simulation"],"description":"Type of test case definition","isRequired":true,"uniqueKey":"test_case_definition_snapshot.type","typeLabel":"enum\u003cstring>"},"creation_timestamp":{"type":"integer","description":"Timestamp when the test case definition was created (milliseconds since epoch)","isRequired":true,"uniqueKey":"test_case_definition_snapshot.creation_timestamp","typeLabel":"integer"},"user_modified_timestamp":{"type":"integer","description":"Timestamp when the test case definition was last modified (milliseconds since epoch)","isRequired":true,"uniqueKey":"test_case_definition_snapshot.user_modified_timestamp","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"test_case_definition_snapshot","typeLabel":"object"},"creation_timestamp":{"type":"integer","description":"Timestamp when the test case job was created (milliseconds since epoch)","isRequired":true,"uniqueKey":"creation_timestamp","typeLabel":"integer"},"user_modified_timestamp":{"type":"integer","description":"Timestamp when the test case job was last modified (milliseconds since epoch)","isRequired":true,"uniqueKey":"user_modified_timestamp","typeLabel":"integer"},"transcript_snapshot":{"oneOf":[{"type":"object","description":"Snapshot of the transcript generated during test execution. Can be either ConversationFlowPlaygroundSnapshot or RetellLlmPlaygroundSnapshot","uniqueKey":"transcript_snapshot.oneOf.0","typeLabel":"object"},{"type":"null","description":"Snapshot of the transcript generated during test execution. Can be either ConversationFlowPlaygroundSnapshot or RetellLlmPlaygroundSnapshot","uniqueKey":"transcript_snapshot.oneOf.1","typeLabel":"null"}],"uniqueKey":"transcript_snapshot","typeLabel":"object | null"},"result_explanation":{"oneOf":[{"type":"string","description":"Explanation of the test result","uniqueKey":"result_explanation.oneOf.0","typeLabel":"string"},{"type":"null","description":"Explanation of the test result","uniqueKey":"result_explanation.oneOf.1","typeLabel":"null"}],"uniqueKey":"result_explanation","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"test_case_job_id":"\u003cstring>","status":"pending","test_case_definition_id":"\u003cstring>","test_case_definition_snapshot":{"name":"\u003cstring>","response_engine":{"type":"retell-llm","llm_id":"\u003cstring>","version":0},"user_prompt":"\u003cstring>","metrics":["\u003cstring>"],"dynamic_variables":{},"tool_mocks":[{"input_match_rule":{"type":"any"},"output":"\u003cstring>","tool_name":"\u003cstring>","node_id":"\u003cstring>","result":true}],"llm_model":"gpt-4.1","test_case_definition_id":"\u003cstring>","type":"simulation","creation_timestamp":123,"user_modified_timestamp":123},"creation_timestamp":123,"user_modified_timestamp":123,"transcript_snapshot":{},"result_explanation":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"7fc59bbf-f7ea-44db-899e-d57b4d3d576e":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Invalid request format, please check API reference.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Invalid request format, please check API reference."}}},"exampleType":"generated"}},"exampleType":"generated"},"cc379998-7928-4d94-8485-5ac6a86ce69b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"API key is missing or invalid.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"API key is missing or invalid."}}},"exampleType":"generated"}},"exampleType":"generated"},"73ebd2f3-008d-47b8-8626-4a1261695a9c":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"The requested resource was not found.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"The requested resource was not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"fe22ea16-d195-40f3-89f6-d94e38de64ec":{"description":"Too Many Requests","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"Account rate limited, please throttle your requests.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"Account rate limited, please throttle your requests."}}},"exampleType":"generated"}},"exampleType":"generated"},"c8cc1c58-b4ae-4800-8758-7227b17d4733":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["error"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","example":"An unexpected server error occurred.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"error","message":"An unexpected server error occurred."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"562dbd81-4dc1-41b7-a2ce-b4235fd9f37b":{"api_key":{"type":"http","scheme":"bearer","bearerFormat":"string","description":"Authentication header containing API key (find it in dashboard). The format is \"Bearer YOUR_API_KEY\"","scopes":[],"schemeName":"api_key"}}},"servers":{"714d602d-4888-4d5a-8a68-67611f5a5f79":{"url":"https://api.retellai.com","description":"The production server."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"string","description":"Authentication header containing API key (find it in dashboard). The format is \"Bearer YOUR_API_KEY\"","scopes":[],"schemeName":"api_key"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authentication header containing API key (find it in dashboard). The format is \"Bearer YOUR_API_KEY\"","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"api_key","name":"Authorization"}],"title":"api_key"}]},"originalFileLocation":"openapi-final.yaml"},"subdomain":"retellai","siteName":"Retell AI","title":"Get Test Run - Retell AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-26T22:55:00.419Z","originalFileLocation":"api-references/get-test-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=\"Get a test case job (test run) by ID\">\u003cmeta data-mint-head name=\"application-name\" content=\"Retell AI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_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/retellai/aRxZhiMifgkRJF_R/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Test Run - Retell AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a test case job (test run) by ID\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Retell AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retellai.com/api-references/get-test-run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://retellai.mintlify.site/_mintlify/api/og/v2?division=Test+Runs\u0026amp;title=Get+Test+Run\u0026amp;description=Get+a+test+case+job+%28test+run%29+by+ID\u0026amp;theme=2259d4172d4ae0cc61d9b63d\u0026amp;signature=05486a8b3051df7fd4e0416835ac029648ac62954065436f6455b387e5820234\">\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 Test Run - Retell AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a test case job (test run) by ID\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://retellai.mintlify.site/_mintlify/api/og/v2?division=Test+Runs\u0026amp;title=Get+Test+Run\u0026amp;description=Get+a+test+case+job+%28test+run%29+by+ID\u0026amp;theme=2259d4172d4ae0cc61d9b63d\u0026amp;signature=05486a8b3051df7fd4e0416835ac029648ac62954065436f6455b387e5820234\">\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/retellai/aRxZhiMifgkRJF_R/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Retell AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#606A78\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retellai.com/api-references/get-test-run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-references/get-test-run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.retellai.com/#organization\",\"name\":\"Retell AI\",\"url\":\"https://docs.retellai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/retellai/-E9UettTBfBiCBBS/images/docs-light.png?fit=max\u0026auto=format\u0026n=-E9UettTBfBiCBBS\u0026q=85\u0026s=64eb26a2d3cc9a67ee3ea0bfe086dd14\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.retellai.com#website\",\"name\":\"Retell AI\",\"url\":\"https://docs.retellai.com\",\"publisher\":{\"@id\":\"https://docs.retellai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.retellai.com/api-references/get-test-run#webpage\",\"url\":\"https://docs.retellai.com/api-references/get-test-run\",\"name\":\"Get Test Run\",\"description\":\"Get a test case job (test run) by ID\",\"dateModified\":\"2026-01-26T22:55:00.419Z\",\"isPartOf\":{\"@id\":\"https://docs.retellai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.retellai.com/api-references/get-test-run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.retellai.com/api-references/get-test-run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Retell AI\",\"item\":\"https://docs.retellai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Test Run\",\"item\":\"https://docs.retellai.com/api-references/get-test-run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.retellai.com/api-references/get-test-run#apireference\",\"headline\":\"Get Test Run\",\"name\":\"Get Test Run\",\"description\":\"Get a test case job (test run) by ID\",\"url\":\"https://docs.retellai.com/api-references/get-test-run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.retellai.com/api-references/get-test-run#webpage\"},\"dateModified\":\"2026-01-26T22:55:00.419Z\",\"publisher\":{\"@id\":\"https://docs.retellai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.retellai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Retell AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Retell AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-references/get-test-run.md","siteName":"Retell AI","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/general/introduction"}]},{"tab":"API Reference","icon":"code-xml","groups":[{"group":" ","pages":[{"title":"Retell AI API Reference","href":"/api-references/overview"}]},{"group":"Call","pages":[{"title":"Create Phone Call","openapi":"openapi-final post /v2/create-phone-call","href":"/api-references/create-phone-call"},{"title":"Create Web Call","openapi":"openapi-final post /v3/create-web-call","href":"/api-references/create-web-call"},{"title":"Get Call","openapi":"openapi-final get /v2/get-call/{call_id}","href":"/api-references/get-call"},{"title":"List Calls","openapi":"openapi-final post /v3/list-calls","href":"/api-references/list-calls"},{"title":"Update Call","openapi":"openapi-final patch /v2/update-call/{call_id}","href":"/api-references/update-call"},{"title":"Update Live Call","openapi":"openapi-final patch /v2/update-live-call/{call_id}","href":"/api-references/update-live-call"},{"title":"Monitor Call WebSocket","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/icons/wss-badge.svg","href":"/api-references/monitor-call-websocket"},{"title":"Rerun Call Analysis","openapi":"openapi-final put /rerun-call-analysis/{call_id}","href":"/api-references/rerun-call-analysis"},{"title":"Stop Call","openapi":"openapi-final post /v2/stop-call/{call_id}","href":"/api-references/stop-call"},{"title":"Delete Call","openapi":"openapi-final delete /v2/delete-call/{call_id}","href":"/api-references/delete-call"}]},{"group":"Chat","pages":[{"title":"Create Chat","openapi":"openapi-final post /create-chat","href":"/api-references/create-chat"},{"title":"Create Outbound SMS","openapi":"openapi-final post /create-sms-chat","href":"/api-references/create-sms-chat"},{"title":"Get Chat","openapi":"openapi-final get /get-chat/{chat_id}","href":"/api-references/get-chat"},{"title":"Create Chat Completion","openapi":"openapi-final post /create-chat-completion","href":"/api-references/create-chat-completion"},{"title":"List Chats","openapi":"openapi-final post /v3/list-chats","href":"/api-references/list-chats"},{"title":"Update Chat","openapi":"openapi-final patch /update-chat/{chat_id}","href":"/api-references/update-chat"},{"title":"Rerun Chat Analysis","openapi":"openapi-final put /rerun-chat-analysis/{chat_id}","href":"/api-references/rerun-chat-analysis"},{"title":"End Chat","openapi":"openapi-final patch /end-chat/{chat_id}","href":"/api-references/end-chat"},{"title":"Delete Chat","openapi":"openapi-final delete /delete-chat/{chat_id}","href":"/api-references/delete-chat"}]},{"group":"Playground","pages":[{"title":"Agent Playground Completion","openapi":"openapi-final post /agent-playground-completion/{agent_id}","href":"/api-references/agent-playground-completion"}]},{"group":"Phone Number","pages":[{"title":"Create Phone Number","openapi":"openapi-final post /create-phone-number","href":"/api-references/create-phone-number"},{"title":"Get Phone Number","openapi":"openapi-final get /get-phone-number/{phone_number}","href":"/api-references/get-phone-number"},{"title":"List Phone Numbers","openapi":"openapi-final post /v2/list-phone-numbers","href":"/api-references/list-phone-numbers"},{"title":"Update Phone Number","openapi":"openapi-final patch /update-phone-number/{phone_number}","href":"/api-references/update-phone-number"},{"title":"Delete Phone Number","openapi":"openapi-final delete /delete-phone-number/{phone_number}","href":"/api-references/delete-phone-number"}]},{"group":"Voice Agent","pages":[{"title":"Create Voice Agent","openapi":"openapi-final post /create-agent","href":"/api-references/create-agent"},{"title":"Get Voice Agent","openapi":"openapi-final get /get-agent/{agent_id}","href":"/api-references/get-agent"},{"title":"List Voice Agents","openapi":"openapi-final post /v2/list-agents","href":"/api-references/list-agents"},{"title":"Update Voice Agent","openapi":"openapi-final patch /update-agent/{agent_id}","href":"/api-references/update-agent"},{"title":"Delete Agent","openapi":"openapi-final delete /delete-agent/{agent_id}","href":"/api-references/delete-agent"},{"title":"Publish Agent","openapi":"openapi-final post /publish-agent-version/{agent_id}","href":"/api-references/publish-agent"},{"title":"Create Draft Agent Version","openapi":"openapi-final post /create-agent-version/{agent_id}","href":"/api-references/create-agent-version"},{"title":"Delete Agent Version","openapi":"openapi-final delete /delete-agent-version/{agent_id}","href":"/api-references/delete-agent-version"},{"title":"List Agent Versions","openapi":"openapi-final get /list-agent-versions/{agent_id}","href":"/api-references/list-agent-versions"}]},{"group":"Chat Agent","pages":[{"title":"Create Chat Agent","openapi":"openapi-final post /create-chat-agent","href":"/api-references/create-chat-agent"},{"title":"Get Chat Agent","openapi":"openapi-final get /get-chat-agent/{agent_id}","href":"/api-references/get-chat-agent"},{"title":"List Chat Agents","openapi":"openapi-final post /v2/list-agents","href":"/api-references/list-chat-agents"},{"title":"Update Chat Agent","openapi":"openapi-final patch /update-chat-agent/{agent_id}","href":"/api-references/update-chat-agent"},{"title":"Delete Chat Agent","openapi":"openapi-final delete /delete-chat-agent/{agent_id}","href":"/api-references/delete-chat-agent"},{"title":"Publish Chat Agent","openapi":"openapi-final post /publish-agent-version/{agent_id}","href":"/api-references/publish-chat-agent"},{"title":"Create Draft Chat Agent Version","openapi":"openapi-final post /create-agent-version/{agent_id}","href":"/api-references/create-chat-agent-version"},{"title":"Delete Chat Agent Version","openapi":"openapi-final delete /delete-agent-version/{agent_id}","href":"/api-references/delete-chat-agent-version"},{"title":"List Agent Versions","openapi":"openapi-final get /list-agent-versions/{agent_id}","href":"/api-references/list-agent-versions"}]},{"group":"Retell LLM Response Engine (for single / multi prompt agent)","pages":[{"title":"Create Retell LLM","openapi":"openapi-final post /create-retell-llm","href":"/api-references/create-retell-llm"},{"title":"Get Retell LLM","openapi":"openapi-final get /get-retell-llm/{llm_id}","href":"/api-references/get-retell-llm"},{"title":"List Retell LLMs","openapi":"openapi-final get /v2/list-retell-llms","href":"/api-references/list-retell-llms"},{"title":"Update Retell LLM","openapi":"openapi-final patch /update-retell-llm/{llm_id}","href":"/api-references/update-retell-llm"},{"title":"Delete Retell LLM","openapi":"openapi-final delete /delete-retell-llm/{llm_id}","href":"/api-references/delete-retell-llm"}]},{"group":"Conversation Flow Response Engine (for conversation flow agent)","pages":[{"title":"Create Conversation Flow","openapi":"openapi-final post /create-conversation-flow","href":"/api-references/create-conversation-flow"},{"title":"Get Conversation Flow","openapi":"openapi-final get /get-conversation-flow/{conversation_flow_id}","href":"/api-references/get-conversation-flow"},{"title":"List Conversation Flows","openapi":"openapi-final get /v2/list-conversation-flows","href":"/api-references/list-conversation-flows"},{"title":"Update Conversation Flow","openapi":"openapi-final patch /update-conversation-flow/{conversation_flow_id}","href":"/api-references/update-conversation-flow"},{"title":"Delete Conversation Flow","openapi":"openapi-final delete /delete-conversation-flow/{conversation_flow_id}","href":"/api-references/delete-conversation-flow"}]},{"group":"Conversation Flow Subflows","pages":[{"title":"Create Conversation Flow Subflow","openapi":"openapi-final post /create-conversation-flow-component","href":"/api-references/create-conversation-flow-component"},{"title":"Get Conversation Flow Subflow","openapi":"openapi-final get /get-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/get-conversation-flow-component"},{"title":"List Conversation Flow Subflows","openapi":"openapi-final get /v2/list-conversation-flow-components","href":"/api-references/list-conversation-flow-components"},{"title":"Update Conversation Flow Subflow","openapi":"openapi-final patch /update-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/update-conversation-flow-component"},{"title":"Delete Conversation Flow Subflow","openapi":"openapi-final delete /delete-conversation-flow-component/{conversation_flow_component_id}","href":"/api-references/delete-conversation-flow-component"}]},{"group":"MCP Tool","pages":[{"title":"Get MCP Tools","openapi":"openapi-final get /get-mcp-tools/{agent_id}","href":"/api-references/get-mcp-tools"}]},{"group":"Knowledge Base","pages":[{"title":"Create Knowledge Base","openapi":"openapi-final post /create-knowledge-base","href":"/api-references/create-knowledge-base"},{"title":"Get Knowledge Base","openapi":"openapi-final get /get-knowledge-base/{knowledge_base_id}","href":"/api-references/get-knowledge-base"},{"title":"List Knowledge Bases","openapi":"openapi-final get /list-knowledge-bases","href":"/api-references/list-knowledge-bases"},{"title":"Delete Knowledge Base","openapi":"openapi-final delete /delete-knowledge-base/{knowledge_base_id}","href":"/api-references/delete-knowledge-base"},{"title":"Add Knowledge Base Sources","openapi":"openapi-final post /add-knowledge-base-sources/{knowledge_base_id}","href":"/api-references/add-knowledge-base-sources"},{"title":"Delete Knowledge Base Source","openapi":"openapi-final delete /delete-knowledge-base-source/{knowledge_base_id}/source/{source_id}","href":"/api-references/delete-knowledge-base-source"}]},{"group":"Voice","pages":[{"title":"Add Voice","openapi":"openapi-final post /add-community-voice","href":"/api-references/add-voice"},{"title":"Clone Voice","openapi":"openapi-final post /clone-voice","href":"/api-references/clone-voice"},{"title":"Search Voice","openapi":"openapi-final post /search-community-voice","href":"/api-references/search-voice"},{"title":"Get Voice","openapi":"openapi-final get /get-voice/{voice_id}","href":"/api-references/get-voice"},{"title":"List Voices","openapi":"openapi-final get /list-voices","href":"/api-references/list-voices"}]},{"group":"Batch call","pages":[{"title":"Create Batch Call","openapi":"openapi-final post /create-batch-call","href":"/api-references/create-batch-call"}]},{"group":"Contact","pages":[{"title":"Create Contact","openapi":"openapi-final post /create-contact","href":"/api-references/create-contact"},{"title":"Get Contact","openapi":"openapi-final get /get-contact/{contact_id}","href":"/api-references/get-contact"},{"title":"Get Contact by Phone","openapi":"openapi-final get /get-contact-by-phone/{phone_number}","href":"/api-references/get-contact-by-phone"},{"title":"List Contacts","openapi":"openapi-final post /list-contacts","href":"/api-references/list-contacts"},{"title":"List Contact Conversations","openapi":"openapi-final get /list-contact-conversations/{contact_id}","href":"/api-references/list-contact-conversations"},{"title":"Update Contact","openapi":"openapi-final patch /update-contact/{contact_id}","href":"/api-references/update-contact"},{"title":"Delete Contact","openapi":"openapi-final delete /delete-contact/{contact_id}","href":"/api-references/delete-contact"},{"title":"Backfill Contact Analysis Data","openapi":"openapi-final post /backfill-contact-analysis-data","href":"/api-references/backfill-contact-analysis-data"},{"title":"Get Backfill Job Status","openapi":"openapi-final get /get-backfill-contact-job-status","href":"/api-references/get-backfill-contact-job-status"}]},{"group":"App","pages":[{"title":"Create App","openapi":"openapi-final post /create-app","href":"/api-references/create-app"},{"title":"Get App","openapi":"openapi-final get /get-app/{app_id}","href":"/api-references/get-app"},{"title":"List Apps","openapi":"openapi-final get /list-apps","href":"/api-references/list-apps"},{"title":"Update App","openapi":"openapi-final patch /update-app/{app_id}","href":"/api-references/update-app"},{"title":"Delete App","openapi":"openapi-final delete /delete-app/{app_id}","href":"/api-references/delete-app"},{"title":"List App Usages","openapi":"openapi-final get /list-app-usages/{app_id}","href":"/api-references/list-app-usages"},{"title":"Test App Auth","openapi":"openapi-final post /test-app-auth/{app_id}","href":"/api-references/test-app-auth"}]},{"group":"CRM","pages":[{"title":"Get CRM Config","openapi":"openapi-final get /get-crm-config","href":"/api-references/get-crm-config"},{"title":"Update CRM Config","openapi":"openapi-final post /update-crm-config","href":"/api-references/update-crm-config"},{"title":"Get CRM Schema","openapi":"openapi-final get /get-crm-schema","href":"/api-references/get-crm-schema"},{"title":"Run Sync Job","openapi":"openapi-final post /run-sync-job","href":"/api-references/run-sync-job"},{"title":"Get Sync Job Status","openapi":"openapi-final get /get-sync-job-status","href":"/api-references/get-sync-job-status"}]},{"group":"Test Case Definitions","pages":[{"title":"Create Test Case Definition","openapi":"openapi-final post /create-test-case-definition","href":"/api-references/create-test-case-definition"},{"title":"Get Test Case Definition","openapi":"openapi-final get /get-test-case-definition/{test_case_definition_id}","href":"/api-references/get-test-case-definition"},{"title":"List Test Case Definitions","openapi":"openapi-final get /v2/list-test-case-definitions","href":"/api-references/list-test-case-definitions"},{"title":"Update Test Case Definition","openapi":"openapi-final put /update-test-case-definition/{test_case_definition_id}","href":"/api-references/update-test-case-definition"},{"title":"Delete Test Case Definition","openapi":"openapi-final delete /delete-test-case-definition/{test_case_definition_id}","href":"/api-references/delete-test-case-definition"}]},{"group":"Batch Tests","pages":[{"title":"Create Batch Test","openapi":"openapi-final post /create-batch-test","href":"/api-references/create-batch-test"},{"title":"Get Batch Test","openapi":"openapi-final get /get-batch-test/{test_case_batch_job_id}","href":"/api-references/get-batch-test"},{"title":"List Batch Tests","openapi":"openapi-final get /v2/list-batch-tests","description":"List batch test jobs with pagination","href":"/api-references/list-batch-tests"}]},{"group":"Test Runs","pages":[{"title":"Get Test Run","openapi":"openapi-final get /get-test-run/{test_case_job_id}","href":"/api-references/get-test-run"},{"title":"List Test Runs","openapi":"openapi-final get /v2/list-test-runs/{test_case_batch_job_id}","description":"List test case jobs (test runs) for a batch test job with pagination","href":"/api-references/list-test-runs"}]},{"group":"Account","pages":[{"title":"Get Concurrency","openapi":"openapi-final get /get-concurrency","href":"/api-references/get-concurrency"},{"title":"List Export Requests","openapi":"openapi-final get /v2/list-export-requests","href":"/api-references/list-export-requests"}]},{"group":"Custom Telephony","pages":[{"title":"Import Phone Number","openapi":"openapi-final post /import-phone-number","href":"/api-references/import-phone-number"},{"title":"Register Phone Call","openapi":"openapi-final post /v2/register-phone-call","href":"/api-references/register-phone-call"}]},{"group":"Custom LLM","pages":[{"title":"LLM WebSocket","icon":"https://mintlify.s3.us-west-1.amazonaws.com/retellai/images/icons/wss-badge.svg","href":"/api-references/llm-websocket"}]}]},{"tab":"SDK","icon":"package","pages":[{"title":"SDK","href":"/get-started/sdk"}]},{"tab":"MCP","icon":"plug-zap","pages":[{"title":"MCP","href":"/get-started/mcp-server"}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/get-started/cli"}]},{"tab":"Deprecations","icon":"book-alert","pages":[{"title":"Deprecations","href":"/deprecation-notice/overview"}]}]},"basePath":"","title":"Get Test Run - Retell AI","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","Page-Cr9IwkK7.js","CodeSnippet-eoRjC4Le.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","getApiPlaygroundDisplay-CZyAPlR2.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}