Skip to main content
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>'
{
  "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-4o-mini",
      "mockData": [
        {
          "variableName": "customer_name",
          "value": "John Doe"
        },
        {
          "variableName": "account_status",
          "value": "active"
        }
      ],
      "userPrompt": "You are an angry customer who wants to cancel your subscription.",
      "attempt": 5,
      "successCriteria": "The agent should acknowledge the cancellation request, present retention alternatives, and confirm the cancellation if the customer insists."
    }
  ],
  "successfulAttempts": 4,
  "failedAttempts": 1,
  "totalAttempts": 5
}

Documentation Index

Fetch the complete documentation index at: https://docs.sigmamind.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

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.

Path Parameters

​
batchId
string
required

The unique identifier of the batch run to retrieve.

Query Parameters

​
agentId
string
required

Unique identifier of the agent to which the batch run belongs.

Response

OK

List of items for the current page. Contains up to 'size' number of records.

​
batchId
string

The unique identifier of the batch run.

Example:

"batch_s0OJu2JWR8R45Fai"

​
workspaceId
string

The unique identifier of the workspace under which the batch run was created.

Example:

"org_V6eZ2zg8ziDx5pft"

​
agent
object

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.

​
createdDate
string<date-time>

The UTC timestamp indicating when the batch run was created.

Example:

"2026-03-26T10:52:45.565Z"

​
testCases
object[]

The list of test cases included in this batch run, along with their individual simulation results.

​
successfulAttempts
integer<int64>

The total number of simulation attempts across all test cases in this batch run that were evaluated as successful.

Example:

4

​
failedAttempts
integer<int64>

The total number of simulation attempts across all test cases in this batch run that were evaluated as failed.

Example:

1

​
totalAttempts
integer<int64>

The total number of simulation attempts executed across all test cases in this batch run.

Example:

5