{
"error": "Unauthorized",
"message": "X-API-Key is missing or invalid",
"path": "/v1/batch-runs",
"status": 401,
"timestamp": "2026-11-06T02:42:43.947Z"
}
{
"error": "Forbidden",
"message": "Access denied for this resource",
"path": "/v1/batch-runs",
"status": 403,
"timestamp": "2026-11-06T02:42:43.947Z"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"path": "/v1/batch-runs",
"status": 404,
"timestamp": "2026-11-06T02:42:43.947Z"
}
{
"error": "Internal Server Error",
"message": "Unexpected server error",
"path": "/v1/batch-runs",
"status": 500,
"timestamp": "2026-11-06T02:42:43.947Z"
}
Get Batch Run
Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.
GET
/
v1
/
batch-runs
/
{batchId}
Get Batch Run
curl --request GET \ --url https://api.sigmamind.ai/v1/batch-runs/{batchId} \ --header 'X-API-Key: <api-key>'
Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.
Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SigmaMind AI","description":"Developer docs for SigmaMind AI. Build, test, and deploy AI agents that handle voice, chat, and email conversations for your contact center.","colors":{"primary":"#0F172A","light":"#F8FAFC","dark":"#1E293B"},"logo":{"light":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798","dark":"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/dark.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=37e6d9d7f667ee3761cc76b9ed758f6a","href":"https://www.sigmamind.ai"},"favicon":"https://mintcdn.com/sigmamindai/x8_xeWMetIJrwgEQ/favicon.svg?fit=max\u0026auto=format\u0026n=x8_xeWMetIJrwgEQ\u0026q=85\u0026s=dce3fc7f05848ac97179954ea0aac7a7","navbar":{"links":[{"href":"mailto:help@sigmamind.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.sigmamind.ai/auth/login"}},"footer":{"socials":{"x":"https://x.com/sigmamind_ai","linkedin":"https://www.linkedin.com/company/sigmamind-ai","website":"https://www.sigmamind.ai","youtube":"https://www.youtube.com/@SigmaMindAI"}},"seo":{"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-FS7QYGTFP5"},"gtm":{"tagId":"GTM-NN56PC2H"}},"errors":{"404":{"redirect":true}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"variables":{"BASE_URL":"https://api.sigmamind.ai"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sigmamindai","hasAudioNarration":false,"actualSubdomain":"sigmamindai","customDomains":["docs.sigmamind.ai"],"gitSource":{"type":"github","owner":"sigmamind-ai","repo":"docs","deployBranch":"dev-master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af44020e61bbc4648b97b1d","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"Documentation","count":94},{"language":"default","tag":"API Reference","count":77},{"language":"default","tag":"Build","count":37},{"language":"default","tag":"Deploy","count":14},{"language":"default","tag":"How to build conversational flow agents","count":12},{"language":"default","tag":"Tool Integrations","count":11},{"language":"default","tag":"How to build single prompt agents","count":8},{"language":"default","tag":"Add Basic Nodes","count":7},{"language":"default","tag":"How to Add tool","count":6},{"language":"default","tag":"CCAAS Integrations","count":6}]},"assistantConfig":{"enableStarterQuestions":true,"deflection":{"enabled":true,"email":"support@sigmamind.ai","showHelpButton":true}},"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":"llms-txt-v2","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}],"starterQuestions":[{"_id":"695fb83bba37df35a996e0a8","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I connect my app with a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:59:23.075Z","updatedAt":"2026-01-08T13:59:23.075Z","__v":0},{"_id":"695fb809ba37df35a996deb4","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How can I add a voice agent to my app or website?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:58:33.153Z","updatedAt":"2026-01-08T13:58:33.153Z","__v":0},{"_id":"695fb7adba37df35a996da58","deploymentId":"682c3c0be2b0b5676d6f71d1","questionText":"How do I set up a voice AI agent?","status":"active","generatedBy":"manual","createdAt":"2026-01-08T13:57:01.201Z","updatedAt":"2026-01-08T13:57:01.201Z","__v":0}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/batch-runs/get-batch-run","slug":"/api-reference/batch-runs/get-batch-run","pageMetadata":{"openapi":"get /v1/batch-runs/{batchId}","title":"Get Batch Run","description":"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.","href":"/api-reference/batch-runs/get-batch-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: \"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\"\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":{"config":{},"pageMetadata":{"openapi":"get /v1/batch-runs/{batchId}","title":"Get Batch Run","description":"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.","href":"/api-reference/batch-runs/get-batch-run"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Batch Runs"],"summary":"Get Batch Run","description":"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.","operationId":"getBatch","parameters":["3812c769-f20d-4f54-afb4-468ff66ed38f","ad39c2ef-4203-4c60-b5ef-0bbaf09eaf54"],"responses":{"200":"c98a3cbe-aff6-4b5c-83cc-5a373d9c017e","400":"fece1fa1-927c-41d8-8ed8-07d9b183962b","401":"f08e1fef-8ce4-4542-9760-5417acda1e9b","403":"96223ce7-310a-4c03-b61b-f04ac6ab0da3","404":"1915c3c9-cceb-44e4-aacc-393ebbc7ffca","500":"94caf92b-1f4b-49ef-896c-fa278ffd7c85"},"method":"get","type":"path","servers":["8e559e02-781a-40b4-9c1f-0150c00e3590"],"security":["942fdac5-677d-45bf-9a32-66b9441b7597"],"path":"/v1/batch-runs/{batchId}","baseUrlOptions":["https://api.sigmamind.ai"],"title":"Get Batch Run","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3812c769-f20d-4f54-afb4-468ff66ed38f":{"name":"batchId","in":"path","description":"The unique identifier of the batch run to retrieve.","required":true,"schema":{"type":"string","isRequired":true,"description":"The unique identifier of the batch run to retrieve.","uniqueKey":"","typeLabel":"string"},"example":"batch_KidCyVw5gJN87n5S"},"ad39c2ef-4203-4c60-b5ef-0bbaf09eaf54":{"name":"agentId","in":"query","description":"Unique identifier of the agent to which the batch run belongs.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the agent to which the batch run belongs.","uniqueKey":"","typeLabel":"string"},"example":"agent_IqmljBh8eSEGAqKd"}},"responses":{"c98a3cbe-aff6-4b5c-83cc-5a373d9c017e":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"batchId":{"type":"string","description":"The unique identifier of the batch run.","example":"batch_s0OJu2JWR8R45Fai","uniqueKey":"batchId","typeLabel":"string"},"workspaceId":{"type":"string","description":"The unique identifier of the workspace under which the batch run was created.","example":"org_V6eZ2zg8ziDx5pft","uniqueKey":"workspaceId","typeLabel":"string"},"agent":{"type":"object","properties":{"name":{"type":"string","description":"The display name of the assigned agent.","example":"New AI Agent","uniqueKey":"agent.name","typeLabel":"string"},"agentId":{"type":"string","description":"The unique identifier of the agent within the system.","example":"agent_D5D0p7TUs66TTAEAx","uniqueKey":"agent.agentId","typeLabel":"string"},"status":{"type":"string","description":"The current operational status of the agent.","example":"Live","enum":["Live","Testing","Disabled"],"uniqueKey":"agent.status","typeLabel":"enum\u003cstring>"}},"description":"Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.","uniqueKey":"agent","typeLabel":"object"},"createdDate":{"type":"string","description":"The UTC timestamp indicating when the batch run was created.","format":"date-time","example":"2026-03-26T10:52:45.565Z","uniqueKey":"createdDate","typeLabel":"string\u003cdate-time>"},"testCases":{"type":"array","description":"The list of test cases included in this batch run, along with their individual simulation results.","items":{"type":"object","properties":{"testCaseId":{"type":"string","description":"The unique identifier of the test case.","example":"tc_d17T6uReChpyfFeP","uniqueKey":"testCases.items.[INDEX].testCaseId","typeLabel":"string"},"label":{"type":"string","description":"A human-readable name or label for the test case, used to identify it in reports and dashboards.","example":"Angry Customer - Cancellation Flow","uniqueKey":"testCases.items.[INDEX].label","typeLabel":"string"},"agent":{"type":"object","properties":{"name":{"type":"string","description":"The display name of the assigned agent.","example":"New AI Agent","uniqueKey":"testCases.items.[INDEX].agent.name","typeLabel":"string"},"agentId":{"type":"string","description":"The unique identifier of the agent within the system.","example":"agent_D5D0p7TUs66TTAEAx","uniqueKey":"testCases.items.[INDEX].agent.agentId","typeLabel":"string"},"status":{"type":"string","description":"The current operational status of the agent.","example":"Live","enum":["Live","Testing","Disabled"],"uniqueKey":"testCases.items.[INDEX].agent.status","typeLabel":"enum\u003cstring>"}},"description":"Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.","uniqueKey":"testCases.items.[INDEX].agent","typeLabel":"object"},"workspaceId":{"type":"string","description":"The unique identifier of the workspace under which this test case was created.","example":"org_V6eZ2zg8ziDx5pft","uniqueKey":"testCases.items.[INDEX].workspaceId","typeLabel":"string"},"llmModel":{"type":"string","description":"The LLM model used to generate Agent responses during the simulation.","example":"gpt-5.6-luna","uniqueKey":"testCases.items.[INDEX].llmModel","typeLabel":"string"},"mockData":{"type":"array","description":"The list of mock variables and their simulated values that were used to substitute for real external data sources during the simulation.","example":[{"variableName":"customer_name","value":"John Doe"},{"variableName":"account_status","value":"active"}],"items":{"type":"object","properties":{"variableName":{"type":"string","description":"The name of the variable that was substituted with mock data during the simulation.","example":"user_name","uniqueKey":"testCases.items.[INDEX].mockData.items.[INDEX].variableName","typeLabel":"string"},"value":{"type":"string","description":"The simulated value that was assigned to the variable for the duration of the test run.","example":"John Doe","uniqueKey":"testCases.items.[INDEX].mockData.items.[INDEX].value","typeLabel":"string"}},"description":"The list of mock variables and their simulated values that were used to substitute for real external data sources during the simulation.","example":[{"variableName":"customer_name","value":"John Doe"},{"variableName":"account_status","value":"active"}],"uniqueKey":"testCases.items.[INDEX].mockData.items.[INDEX]","typeLabel":"object"},"uniqueKey":"testCases.items.[INDEX].mockData","typeLabel":"object[]"},"mockToolData":{"type":"array","description":"Bindings from agent tool aliases to mock tool responses. May include resolved mock name and statusCode for the UI.","example":[{"toolAlias":"get_order","mockToolDataId":"mock_dpKjqjKnY3z6gABF","name":"Success - Empty List","statusCode":200}],"items":{"required":["mockToolDataId","toolAlias"],"type":"object","properties":{"toolAlias":{"type":"string","description":"Tool alias on the agent that this mock should satisfy during simulation.","example":"get_order","isRequired":true,"uniqueKey":"testCases.items.[INDEX].mockToolData.items.[INDEX].toolAlias","typeLabel":"string"},"mockToolDataId":{"type":"string","description":"Public identifier of the mock tool data library record.","example":"mock_dpKjqjKnY3z6gABF","isRequired":true,"uniqueKey":"testCases.items.[INDEX].mockToolData.items.[INDEX].mockToolDataId","typeLabel":"string"},"name":{"type":"string","description":"Display name of the linked mock (resolved on read for the UI).","example":"Success - Empty List","uniqueKey":"testCases.items.[INDEX].mockToolData.items.[INDEX].name","typeLabel":"string"},"statusCode":{"type":"integer","description":"HTTP status code of the linked mock (resolved on read for the UI).","format":"int32","example":200,"uniqueKey":"testCases.items.[INDEX].mockToolData.items.[INDEX].statusCode","typeLabel":"integer\u003cint32>"}},"description":"Bindings from agent tool aliases to mock tool responses. May include resolved mock name and statusCode for the UI.","example":[{"toolAlias":"get_order","mockToolDataId":"mock_dpKjqjKnY3z6gABF","name":"Success - Empty List","statusCode":200}],"uniqueKey":"testCases.items.[INDEX].mockToolData.items.[INDEX]","typeLabel":"object"},"uniqueKey":"testCases.items.[INDEX].mockToolData","typeLabel":"object[]"},"userPrompt":{"type":"string","description":"The prompt that defined the persona and intent of the simulated user, driving the user-side messages throughout the conversation.","example":"You are an angry customer who wants to cancel your subscription.","uniqueKey":"testCases.items.[INDEX].userPrompt","typeLabel":"string"},"attempt":{"type":"integer","description":"The number of times this test case was configured to run as independent simulation attempts.","format":"int64","example":5,"uniqueKey":"testCases.items.[INDEX].attempt","typeLabel":"integer\u003cint64>"},"successCriteria":{"type":"array","description":"Ordered goals used to evaluate the agent after each simulation run.","example":["Agent was able to successfully look up the order.","Agent was able to successfully close the call."],"items":{"type":"string","example":"[\"Agent was able to successfully look up the order.\",\"Agent was able to successfully close the call.\"]","uniqueKey":"testCases.items.[INDEX].successCriteria.items.[INDEX]","typeLabel":"string"},"uniqueKey":"testCases.items.[INDEX].successCriteria","typeLabel":"string[]"}},"uniqueKey":"testCases.items.[INDEX]","typeLabel":"object"},"uniqueKey":"testCases","typeLabel":"object[]"},"successfulAttempts":{"type":"integer","description":"The total number of simulation attempts across all test cases in this batch run that were evaluated as successful.","format":"int64","example":4,"uniqueKey":"successfulAttempts","typeLabel":"integer\u003cint64>"},"failedAttempts":{"type":"integer","description":"The total number of simulation attempts across all test cases in this batch run that were evaluated as failed.","format":"int64","example":1,"uniqueKey":"failedAttempts","typeLabel":"integer\u003cint64>"},"totalAttempts":{"type":"integer","description":"The number of simulation attempts in this batch.","format":"int64","example":5,"uniqueKey":"totalAttempts","typeLabel":"integer\u003cint64>"}},"description":"List of items for the current page. Contains up to 'size' number of records.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"batchId":"batch_s0OJu2JWR8R45Fai","workspaceId":"org_V6eZ2zg8ziDx5pft","agent":{"name":"New AI Agent","agentId":"agent_D5D0p7TUs66TTAEAx","status":"Live"},"createdDate":"2026-03-26T10:52:45.565Z","testCases":[{"testCaseId":"tc_d17T6uReChpyfFeP","label":"Angry Customer - Cancellation Flow","agent":{"name":"New AI Agent","agentId":"agent_D5D0p7TUs66TTAEAx","status":"Live"},"workspaceId":"org_V6eZ2zg8ziDx5pft","llmModel":"gpt-5.6-luna","mockData":[{"variableName":"customer_name","value":"John Doe"},{"variableName":"account_status","value":"active"}],"mockToolData":[{"toolAlias":"get_order","mockToolDataId":"mock_dpKjqjKnY3z6gABF","name":"Success - Empty List","statusCode":200}],"userPrompt":"You are an angry customer who wants to cancel your subscription.","attempt":5,"successCriteria":["Agent was able to successfully look up the order.","Agent was able to successfully close the call."]}],"successfulAttempts":4,"failedAttempts":1,"totalAttempts":5}}},"exampleType":"generated"}},"exampleType":"generated"},"fece1fa1-927c-41d8-8ed8-07d9b183962b":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Bad Request","message":"Invalid request parameters","path":"/v1/batch-runs","status":400,"timestamp":"2026-11-06T02:42:43.947Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"f08e1fef-8ce4-4542-9760-5417acda1e9b":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Unauthorized","message":"X-API-Key is missing or invalid","path":"/v1/batch-runs","status":401,"timestamp":"2026-11-06T02:42:43.947Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"96223ce7-310a-4c03-b61b-f04ac6ab0da3":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Forbidden","message":"Access denied for this resource","path":"/v1/batch-runs","status":403,"timestamp":"2026-11-06T02:42:43.947Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"1915c3c9-cceb-44e4-aacc-393ebbc7ffca":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Not Found","message":"The requested resource was not found","path":"/v1/batch-runs","status":404,"timestamp":"2026-11-06T02:42:43.947Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"94caf92b-1f4b-49ef-896c-fa278ffd7c85":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"timestamp":{"type":"string","description":"Error timestamp in ISO format","format":"date-time","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"},"status":{"type":"integer","description":"HTTP status code","example":400,"uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"Error type or HTTP status message","example":"Bad Request","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","description":"Detailed error message","example":"Email is required","uniqueKey":"message","typeLabel":"string"},"path":{"type":"string","description":"Request path where error occurred","example":"/v1/users","uniqueKey":"path","typeLabel":"string"},"validationErrors":{"type":"object","description":"Field validation errors (if any)","example":"{\n \"email\": \"Email is required\",\n \"name\": \"Name is too short\"\n}","uniqueKey":"validationErrors","typeLabel":"object"}},"description":"Standard error response","uniqueKey":"","typeLabel":"object"},"examples":{"default":{"title":"default","value":{"error":"Internal Server Error","message":"Unexpected server error","path":"/v1/batch-runs","status":500,"timestamp":"2026-11-06T02:42:43.947Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"942fdac5-677d-45bf-9a32-66b9441b7597":{"apiKeyAuth":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"8e559e02-781a-40b4-9c1f-0150c00e3590":{"url":"https://api.sigmamind.ai","description":"SigmaMind AI Agent Builder APIs"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","name":"X-API-Key","in":"header","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"X-API-Key","type":"string","description":"Authenticate every request by passing your API key in the `X-API-Key` header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"X-API-Key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-docs.yaml"},"subdomain":"sigmamindai","siteName":"SigmaMind AI","title":"Get Batch Run - SigmaMind AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-14T10:49:35.526Z","originalFileLocation":"api-reference/batch-runs/get-batch-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=\"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SigmaMind 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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Batch Run - SigmaMind AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SigmaMind AI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sigmamindai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+Batch+Run\u0026amp;description=Retrieves+the+full+details+of+a+batch+run+by+batchId%2C+scoped+to+the+specified+agent.+Returns+overall+batch+status%2C+test+case+count%2C+pass%2Ffail+summary%2C+and+indiv\u0026amp;theme=fef818be99f9332d6af1a382\u0026amp;signature=64bf9fff981a4231fc0b5e3c7df712ce05145ae77de3a0c26e1508144d8b6c01\">\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 Batch Run - SigmaMind AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sigmamindai.mintlify.site/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Get+Batch+Run\u0026amp;description=Retrieves+the+full+details+of+a+batch+run+by+batchId%2C+scoped+to+the+specified+agent.+Returns+overall+batch+status%2C+test+case+count%2C+pass%2Ffail+summary%2C+and+indiv\u0026amp;theme=fef818be99f9332d6af1a382\u0026amp;signature=64bf9fff981a4231fc0b5e3c7df712ce05145ae77de3a0c26e1508144d8b6c01\">\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/sigmamindai/QkCWUi6da-GSENjq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SigmaMind AI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0F172A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-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/batch-runs/get-batch-run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sigmamind.ai/#organization\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sigmamindai/vxjJeTe45csRRZLq/logo/light.svg?fit=max\u0026auto=format\u0026n=vxjJeTe45csRRZLq\u0026q=85\u0026s=bc51a1190d0d56521defbdc28b2a0798\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sigmamind.ai#website\",\"name\":\"SigmaMind AI\",\"url\":\"https://docs.sigmamind.ai\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run#webpage\",\"url\":\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run\",\"name\":\"Get Batch Run\",\"description\":\"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\",\"dateModified\":\"2026-05-14T10:49:35.526Z\",\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"}},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run#apireference\",\"headline\":\"Get Batch Run\",\"name\":\"Get Batch Run\",\"description\":\"Retrieves the full details of a batch run by batchId, scoped to the specified agent. Returns overall batch status, test case count, pass/fail summary, and individual run results.\",\"url\":\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sigmamind.ai/api-reference/batch-runs/get-batch-run#webpage\"},\"dateModified\":\"2026-05-14T10:49:35.526Z\",\"publisher\":{\"@id\":\"https://docs.sigmamind.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sigmamind.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SigmaMind AI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"SigmaMind AI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/batch-runs/get-batch-run.md","siteName":"SigmaMind AI","nav":{"global":{"anchors":[{"anchor":"Documentation","icon":"book-open-cover","href":"https://docs.sigmamind.ai"},{"anchor":"Discord Community","icon":"discord","href":"https://www.discord.com/invite/jSWGcw5Wyx"}]},"tabs":[{"tab":"Documentation","icon":"book","pages":[{"group":"Get Started","expanded":true,"pages":[{"title":"Introduction","sidebarTitle":"Introduction","icon":"info","href":"/documentation/getting-started/introduction"},{"title":"Quick Start with AI Agents","sidebarTitle":"Quick Start","icon":"rocket","href":"/documentation/getting-started/quick-start"},{"title":"Templates","sidebarTitle":"Templates","icon":"notebook","href":"/documentation/getting-started/templates"},{"title":"Prompt Engineering Guide","icon":"square-list","href":"/documentation/getting-started/prompt-engineering-guide"}]},{"group":"Build","pages":[{"title":"AI Agents Overview","sidebarTitle":"Build Your Agent","icon":"eye","href":"/documentation/agents/overview"},{"group":"How to build single prompt agents","pages":[{"title":"Step 1: Write the main prompt","href":"/documentation/agents/single-prompt-agent/configure-main-prompt"},{"title":"Step 2: Set First Message (optional)","href":"/documentation/agents/single-prompt-agent/configure-welcome-message"},{"group":"How to Add tool","expanded":true,"pages":[{"title":"How to Add tool","icon":"toolbox","href":"/documentation/agents/single-prompt-agent/add-tool-calls"},{"title":"How to use Transfer Call","icon":"phone","href":"/transfer-call"},{"title":"End Call","icon":"circle-stop","href":"/end-call"},{"title":"Extract Dynamic Variables","icon":"brackets-curly","href":"/extract-dynamic-variable"},{"title":"Navigate IVR","icon":"grid-round","href":"/navigate-ivr"},{"title":"Add Integation Tool","icon":"arrows-left-right-to-line","href":"/add-integation-tool"}]}]},{"group":"How to build conversational flow agents","pages":[{"title":"Conversational Flow Agent","sidebarTitle":"Conversational Flow Agent","href":"/documentation/agents/agent-builder-overview"},{"group":"Add Basic Nodes","pages":[{"title":"Overview","href":"/documentation/agents/add-advance-nodes/overview"},{"title":"Start Trigger ","icon":"rocket-launch","href":"/documentation/agents/add-basic-nodes/trigger-node"},{"title":"Send Response Node","icon":"message-lines","href":"/documentation/agents/add-basic-nodes/response-node"},{"title":"Wait Node","icon":"pause","href":"/documentation/agents/add-basic-nodes/wait-node"},{"title":"Analyze Customer Message","icon":"robot","href":"/documentation/agents/add-basic-nodes/customer-intent-node"},{"title":"Branch Node","icon":"code-branch","href":"/documentation/agents/add-basic-nodes/branch-node"},{"title":"Jump Node","icon":"forward-fast","href":"/documentation/agents/add-advance-nodes/jump-node"}]},{"group":"Add Advance Nodes","pages":[{"title":"Tool Action","icon":"toolbox","href":"/documentation/agents/add-advance-nodes/app-action-node"},{"title":"Helpdesk Action","icon":"desktop","href":"/documentation/agents/add-advance-nodes/helpdesk-action-node"},{"title":"Voice Action","icon":"phone-arrow-down-left","href":"/documentation/agents/add-advance-nodes/voice-action"},{"title":"Extract Variables","icon":"brackets-curly","href":"/documentation/agents/add-advance-nodes/extract-variables"}]}]},{"title":"Basic Settings","sidebarTitle":"How to Configure Voice, Model \u0026 Conversation Setup","icon":"gear","hidden":true,"href":"/documentation/agents/settings/basic"},{"title":"Agent Settings Overview","sidebarTitle":"Introduction to Agent Settings","icon":"eye","href":"/documentation/agents/settings/overview"},{"title":"How to configure basic settings","icon":"gear","href":"/documentation/agents/single-prompt-agent/agent-settings"},{"title":"How to select voice of your agent","icon":"phone","href":"/documentation/agents/single-prompt-agent/how-to-select-voice-of-your-agent"},{"title":"How to select LLM Model","icon":"head-side-brain","href":"/documentation/agents/single-prompt-agent/how-to-select-llm-model"},{"title":"How to Select Language","icon":"language","href":"/documentation/agents/single-prompt-agent/how-to-select-language"},{"title":"How to Configure Who starts the conversation","icon":"phone-volume","href":"/documentation/agents/single-prompt-agent/untitled-page"},{"title":"Speech Settings","sidebarTitle":"How to Configure Speech, Interruptions \u0026 Call Behavior","icon":"speaker","href":"/documentation/agents/settings/speech"},{"title":"Model Settings","sidebarTitle":"How to Configure Global Instructions","icon":"apple-whole","href":"/documentation/agents/settings/model"},{"title":"Transcription Settings","icon":"language","href":"/documentation/agents/settings/transcription-settings"},{"title":"Call Settings","sidebarTitle":"Call Settings","icon":"phone","href":"/documentation/agents/settings/call"},{"title":"Dynamic variables","sidebarTitle":"How to use dynamic variables","icon":"file","href":"/documentation/agents/agent-variables"},{"title":"Post Conversation Analysis","sidebarTitle":"How to use Post-Conversation Analysis","icon":"chart-area","href":"/documentation/agents/settings/post-call-analysis"},{"title":"How to use SIP Custom Header","icon":"file-xls","href":"/documentation/agents/add-advance-nodes/howto-use-sip-custom-header"},{"group":"Webhooks","pages":[{"title":"Agent level Webhooks","sidebarTitle":" How to use Webhooks in SigmaMind","icon":"webhook","href":"/documentation/agents/agent-webhooks"},{"title":"Webhook Logs","icon":"file-lines","href":"/documentation/agents/webhook-logs"}]}]},{"group":"Tool Integrations","expanded":true,"pages":[{"title":"How to Access Tool Library ","sidebarTitle":"How to Access Tool Library ","icon":"eye","href":"/documentation/tools/overview"},{"title":"How to Configure Authentication","icon":"key","href":"/documentation/tools/authentication"},{"title":"How to Add New Integration","icon":"screwdriver-wrench","href":"/documentation/tools/add-a-custom-tool"},{"title":"How to Add New Tool","icon":"toolbox","href":"/documentation/tools/how-to-add-new-tool"},{"title":"Poku Labs","hidden":true,"href":"/documentation/tools/poku-labs"},{"title":"Cal.com","hidden":true,"href":"/documentation/tools/cal-com"},{"title":"Recharge","hidden":true,"href":"/documentation/tools/recharge"},{"title":"Shopify","hidden":true,"href":"/documentation/tools/shopify"},{"title":"Pipedrive","hidden":true,"href":"/documentation/tools/pipedrive"},{"title":"Stripe","hidden":true,"href":"/documentation/tools/stripe"},{"title":"Hubspot","hidden":true,"href":"/documentation/tools/hubspot"}]},{"group":"Test","pages":[{"title":"Playground Overview","sidebarTitle":"Test Your Agent","icon":"eye","href":"/documentation/playground/overview"},{"title":"Test Voice","icon":"microphone","href":"/documentation/playground/test-voice"},{"title":"Test Chat","hidden":true,"icon":"messages","href":"/documentation/playground/llm-playground"},{"group":"Run Simulations","hidden":true,"expanded":true,"pages":[{"title":"Create Test Cases","href":"/documentation/playground/test-simulations"},{"title":"Run Batch Simulations","href":"/documentation/playground/run-batch-simulations"},{"title":"Review Test Runs","href":"/documentation/playground/review-test-runs"}]}]},{"group":"Deploy","expanded":true,"pages":[{"title":"Phone Number Overview","sidebarTitle":"Overview","icon":"eye","href":"/documentation/phone-number/overview"},{"title":"Purchase Phone Number","sidebarTitle":"Purchase Phone Number","icon":"phone","href":"/documentation/phone-number/purchase-phone-number"},{"title":"Bring Your Own Number (BYO)","sidebarTitle":"Bring Your Own Number","icon":"phone","href":"/documentation/phone-number/bring-your-own-number"},{"title":"SIP Integration Overview","sidebarTitle":"SIP Integration Overview","icon":"eye","href":"/documentation/phone-number/sip-integration/overview"},{"title":"SIP Trunking","sidebarTitle":"SIP Trunking","icon":"phone-rotary","href":"/documentation/phone-number/sip-integration/sip-trunking"},{"title":"Connect via SIP Trunking with Twilio","sidebarTitle":"Twilio Integration","icon":"link","href":"/documentation/phone-number/sip-integration/providers/twilio"},{"title":"Connect via SIP Trunking with Telnyx","sidebarTitle":"Telnyx Integration","icon":"link","hidden":true,"href":"/documentation/phone-number/sip-integration/providers/telnyx"},{"group":"Calls","pages":[{"title":"Make Calls","icon":"phone-arrow-up-right","hidden":true,"href":"/documentation/calls/make-calls"},{"title":"Receive Calls","icon":"phone-arrow-down-left","href":"/documentation/calls/receive-calls"}]},{"group":"API Keys","expanded":true,"pages":[{"title":"Create API Keys","icon":"key","href":"/documentation/api-keys/overview"},{"title":"API Logs","icon":"clipboard-list","href":"/documentation/api-keys/api-logs"}]},{"group":"Outbound Campaigns","pages":[{"title":"Campaigns Overview","sidebarTitle":"Overview","icon":"eye","href":"/documentation/campaigns/overview"},{"title":"Create a Campaign","sidebarTitle":"Create Campaign","icon":"megaphone","href":"/documentation/campaigns/create-campaign-calls"},{"title":"Monitor Campaign Calls","sidebarTitle":"Monitor Campaign Calls","icon":"chart-bar","href":"/documentation/campaigns/monitor-campaign-calls"}]}]},{"group":"CCAAS Integrations","pages":[{"title":"Vicidial Integration Guide","hidden":true,"href":"/vicidial-integration"},{"title":"Amazon Connect","hidden":true,"href":"/amazon-connect"},{"title":"Vicidial Integration Guide","sidebarTitle":"Vicidial","href":"/vicidial-integration-guide"},{"title":"Five9 Integration Guide","sidebarTitle":"Five9","href":"/five9-integration-guide"},{"title":"Genesys","hidden":true,"href":"/genesys"},{"title":"NICE","hidden":true,"href":"/nice"}]},{"group":"Monitor","pages":[{"title":"Observe Overview","sidebarTitle":"Overview","icon":"eye","href":"/documentation/observe/overview"},{"title":"Calls Logs","icon":"phone","href":"/documentation/observe/monitor-calls"},{"title":"Chat logs","icon":"messages","href":"/documentation/observe/monitor-chats"},{"title":"Call Analytics","icon":"chart-mixed","href":"/documentation/observe/call-analytics"},{"title":"Chat Analytics","icon":"chart-line","href":"/documentation/observe/chat-analytics"},{"title":"Termination Reasons","icon":"circle-xmark","href":"/documentation/observe/termination-reasons"}]},{"group":"QA \u0026 Alerting","hidden":true,"pages":[{"title":"Set QA Rules","href":"/set-qa-rules"},{"title":"Review QA Issues","href":"/review-qa-issues"},{"title":"Set Escalation Rules","href":"/set-escalation-rules"},{"title":"Review Alerts","href":"/review-alerts"},{"title":"Set Notifiers","href":"/set-notifiers"},{"title":"Notifications","href":"/notifications"}]},{"group":"Systems","pages":[{"title":"Workspace","icon":"desktop","href":"/workspace"},{"title":"Manage Members","icon":"users","href":"/add-members"}]},{"group":"Billing","pages":[{"title":"International Calling \u0026 Fees","icon":"money-bill-1-wave","href":"/documentation/phone-number/international-calling-fees"},{"title":"Billing Logs","icon":"clipboard-list-check","href":"/billing-logs"}]}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Calls","pages":[{"openapi":"post /v1/calls","title":"Create Phone Call","href":"/api-reference/calls/create-phone-call"},{"openapi":"get /v1/calls/{callId}","title":"Get Phone Call","href":"/api-reference/calls/get-phone-call"},{"openapi":"get /v1/calls","title":"List Phone Calls","href":"/api-reference/calls/list-phone-calls"},{"openapi":"delete /v1/calls/{callId}","title":"Delete Phone Call","href":"/api-reference/calls/delete-phone-call"}]},{"group":"Chats","pages":[{"openapi":"post /v1/chats","title":"Create Chat","href":"/api-reference/chats/create-a-chat"},{"openapi":"post /v1/chats/response","title":"Chat Completion","href":"/api-reference/chats/chat-completion"},{"openapi":"get /v1/chats/{chatId}","title":"Get Chat","href":"/api-reference/chats/get-chat"},{"openapi":"get /v1/chats","title":"List Chats","href":"/api-reference/chats/list-chats"},{"openapi":"patch /v1/chats/{chatId}","title":"Update Chat","href":"/api-reference/chats/update-chat"},{"openapi":"patch /v1/chats/{chatId}/end-session","title":"End Chat","href":"/api-reference/chats/end-chat"}]},{"group":"Phone Numbers","pages":[{"openapi":"post /v1/phone-numbers","title":"Create Phone Number","href":"/api-reference/phone-numbers/create-phone-number"},{"openapi":"post /v1/phone-numbers/import","title":"Import Phone Number","href":"/api-reference/phone-numbers/import-phone-number"},{"openapi":"get /v1/phone-numbers/{phoneNumber}","title":"Get Phone Number","href":"/api-reference/phone-numbers/get-phone-number"},{"openapi":"get /v1/phone-numbers","title":"List Phone Numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"openapi":"patch /v1/phone-numbers/{phoneNumber}","title":"Update Phone Number","href":"/api-reference/phone-numbers/update-phone-number"},{"openapi":"delete /v1/phone-numbers/{phoneNumber}","title":"Delete Phone Number","href":"/api-reference/phone-numbers/delete-phone-number"}]},{"group":"Single Prompt Agents","pages":[{"openapi":"post /v1/agents","title":"Create Agent","href":"/api-reference/single-prompt-agents/create-agent"},{"openapi":"get /v1/agents/{agentId}","title":"Get Agent","href":"/api-reference/single-prompt-agents/get-agent"},{"openapi":"get /v1/agents","title":"List Agents","href":"/api-reference/single-prompt-agents/list-single-prompt-agents"},{"openapi":"patch /v1/agents/{agentId}","title":"Update Agent","href":"/api-reference/single-prompt-agents/update-agent"},{"openapi":"delete /v1/agents/{agentId}","title":"Delete Agent","href":"/api-reference/single-prompt-agents/delete-agent"}]},{"group":"Conversational Agents","pages":[{"openapi":"post /v1/conversational-agents","title":"Create conversational Agent","href":"/api-reference/conversational-agents/create-conversational-agent"},{"openapi":"get /v1/conversational-agents/{agentId}","title":"Get conversational Agent","href":"/api-reference/conversational-agents/get-conversational-agent"},{"openapi":"patch /v1/conversational-agents/{agentId}","title":"Update conversational Agent","href":"/api-reference/conversational-agents/update-conversational-agent"}]},{"group":"Campaigns","pages":[{"openapi":"post /v1/campaigns","title":"Create Campaign","href":"/api-reference/campaigns/create-campaign"},{"openapi":"get /v1/campaigns/{campaignId}","title":"Get Campaign","href":"/api-reference/campaigns/get-campaign"},{"openapi":"get /v1/campaigns","title":"List Campaigns","href":"/api-reference/campaigns/list-campaigns"},{"openapi":"patch /v1/campaigns/{campaignId}","title":"Update Campaign","href":"/api-reference/campaigns/update-campaign"},{"openapi":"delete /v1/campaigns/{campaignId}","title":"Delete Campaign","href":"/api-reference/campaigns/delete-campaign"}]},{"group":"Integrations","pages":[{"openapi":"post /v1/integrations","title":"Create Integration","href":"/api-reference/integrations/create-integration"},{"openapi":"get /v1/integrations/{integrationId}","title":"Get Integration","href":"/api-reference/integrations/get-integration"},{"openapi":"get /v1/integrations","title":"List Integrations","href":"/api-reference/integrations/list-integrations"},{"openapi":"patch /v1/integrations/{integrationId}","title":"Update Integration","href":"/api-reference/integrations/update-integration"},{"openapi":"delete /v1/integrations/{integrationId}","title":"Delete Integration","href":"/api-reference/integrations/delete-integration"}]},{"group":"Integration Auth","pages":[{"openapi":"post /v1/integrations/{integrationId}/auth","title":"Create Integration Auth","href":"/api-reference/integration-auth/create-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth/{authId}","title":"Get Integration Auth","href":"/api-reference/integration-auth/get-integration-auth"},{"openapi":"get /v1/integrations/{integrationId}/auth","title":"List Integration Auth","href":"/api-reference/integration-auth/list-integration-auth"},{"openapi":"patch /v1/integrations/{integrationId}/auth/{authId}","title":"Update Integration Auth","href":"/api-reference/integration-auth/update-integration-auth"},{"openapi":"delete /v1/integrations/{integrationId}/auth/{authId}","title":"Delete Integration Auth","href":"/api-reference/integration-auth/delete-integration-auth"}]},{"group":"Integration Tools","pages":[{"openapi":"post /v1/integrations/{integrationId}/tools","title":"Create Tool","href":"/api-reference/integration-tools/create-tool"},{"openapi":"post /v1/integrations/{integrationId}/tools/{toolId}/execute","title":"Execute Tool","href":"/api-reference/integration-tools/execute-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools/{toolId}","title":"Get Tool","href":"/api-reference/integration-tools/get-tool"},{"openapi":"get /v1/integrations/{integrationId}/tools","title":"List Tools","href":"/api-reference/integration-tools/list-tools"},{"openapi":"patch /v1/integrations/{integrationId}/tools/{toolId}","title":"Update Tool","href":"/api-reference/integration-tools/update-tool"},{"openapi":"delete /v1/integrations/{integrationId}/tools/{toolId}","title":"Delete Tool","href":"/api-reference/integration-tools/delete-tool"}]},{"group":"Mock Tool Data","pages":[{"openapi":"post /v1/mock-tool-data","title":"Create Mock Tool Data","href":"/api-reference/mock-tool-data/create-mock-tool-data"},{"openapi":"get /v1/mock-tool-data/{mockToolDataId}","title":"Get Mock Tool Data","href":"/api-reference/mock-tool-data/get-mock-tool-data"},{"openapi":"get /v1/mock-tool-data","title":"List Mock Tool Data","href":"/api-reference/mock-tool-data/list-mock-tool-data"},{"openapi":"patch /v1/mock-tool-data/{mockToolDataId}","title":"Update Mock Tool Data","href":"/api-reference/mock-tool-data/update-mock-tool-data"},{"openapi":"delete /v1/mock-tool-data/{mockToolDataId}","title":"Delete Mock Tool Data","href":"/api-reference/mock-tool-data/delete-mock-tool-data"}]},{"group":"Test Cases","pages":[{"openapi":"post /v1/test-cases","title":"Create Test Case","href":"/api-reference/test-cases/create-test-case"},{"openapi":"get /v1/test-cases/{testCaseId}","title":"Get Test Case","href":"/api-reference/test-cases/get-test-case"},{"openapi":"get /v1/test-cases","title":"List Test Cases","href":"/api-reference/test-cases/list-test-cases"},{"openapi":"patch /v1/test-cases/{testCaseId}","title":"Update Test Case","href":"/api-reference/test-cases/update-test-case"},{"openapi":"delete /v1/test-cases/{testCaseId}","title":"Delete Test Case","href":"/api-reference/test-cases/delete-test-case"}]},{"group":"Batch","pages":[{"openapi":"post /v1/batch-runs","title":"Create Batch Run","href":"/api-reference/batch/create-batch-run"},{"openapi":"get /v1/batch-runs/{batchId}","title":"Get Batch Run","href":"/api-reference/batch/get-batch-run"},{"openapi":"get /v1/batch-runs","title":"List Batch Runs","href":"/api-reference/batch/list-batch-runs"}]},{"group":"Test Runs","pages":[{"openapi":"get /v1/test-runs/{jobId}","title":"Get Test Run","href":"/api-reference/test-runs/get-test-run"},{"openapi":"get /v1/test-runs","title":"List Test Runs","href":"/api-reference/test-runs/list-test-runs"}]},{"group":"Webhooks","pages":[{"openapi":"post /v1/webhooks","title":"Create Webhook","href":"/api-reference/webhooks/create-webhook"},{"openapi":"get /v1/webhooks/{webhookId}","title":"Get Webhook","href":"/api-reference/webhooks/get-webhook"},{"openapi":"get /v1/webhooks","title":"List Webhooks","href":"/api-reference/webhooks/list-webhooks"},{"openapi":"delete /v1/webhooks/{webhookId}","title":"Delete Webhook","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"QA Rules","pages":[{"openapi":"post /v1/qa-rules","title":"Create QA Rule","href":"/api-reference/qa-rules/create-qa-rule"},{"openapi":"get /v1/qa-rules/{qaRuleId}","title":"Get QA Rule","href":"/api-reference/qa-rules/get-qa-rule"},{"openapi":"get /v1/qa-rules","title":"List QA Rules","href":"/api-reference/qa-rules/list-qa-rules"},{"openapi":"patch /v1/qa-rules/{qaRuleId}","title":"Update QA Rule","href":"/api-reference/qa-rules/update-qa-rule"},{"openapi":"delete /v1/qa-rules/{qaRuleId}","title":"Delete QA Rule","href":"/api-reference/qa-rules/delete-qa-rule"}]},{"group":"QA Issues","pages":[{"openapi":"get /v1/qa-issues/{qaIssueId}","title":"Get QA Issue","href":"/api-reference/qa-issues/get-qa-issue"},{"openapi":"get /v1/qa-issues","title":"List QA Issues","href":"/api-reference/qa-issues/list-qa-issues"}]},{"group":"Knowledge bases","pages":[{"openapi":"post /v1/knowledge-bases","title":"Create knowledge base","href":"/api-reference/knowledge-bases/create-knowledge-base"},{"openapi":"get /v1/knowledge-bases/{kbId}","title":"Get knowledge base","href":"/api-reference/knowledge-bases/get-knowledge-base-by-kbid"},{"openapi":"get /v1/knowledge-bases","title":"List knowledge bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"openapi":"patch /v1/knowledge-bases/{kbId}","title":"Update knowledge base","href":"/api-reference/knowledge-bases/update-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}","title":"Delete knowledge base","href":"/api-reference/knowledge-bases/delete-knowledge-base"},{"openapi":"delete /v1/knowledge-bases/{kbId}/documents/{documentId}","title":"Delete document","href":"/api-reference/knowledge-bases/delete-one-document-from-a-knowledge-base"}]}]},{"tab":"MCP","icon":"code-branch","groups":[{"group":"MCP","pages":[{"title":"MCP Tools Integration","sidebarTitle":"MCP Client","icon":"plug","hidden":true,"href":"/mcp/client"},{"title":"MCP Server","icon":"server","href":"/mcp/server"}]}]},{"tab":"Tutorials","icon":"video","hidden":true,"groups":[{"group":"Tutorials","pages":[{"title":"Tutorials","sidebarTitle":"Overview","icon":"eye","href":"/tutorials/agents/overview"}]}]}]},"basePath":"","title":"Get Batch Run - SigmaMind AI","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}