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": "Demo Agent",
    "agentId": "mJzLaPEo425lieb9",
    "status": "Testing"
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "testCases": [
    {
      "testCaseId": "tc_d17T6uReChpyfFeP",
      "agent": {
        "name": "Demo Agent",
        "agentId": "mJzLaPEo425lieb9",
        "status": "Testing"
      },
      "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 his subscription. ",
      "attempt": 5,
      "successCriteria": "Agent should acknowledge the request, offer alternatives, and confirm cancellation if the user insists."
    }
  ],
  "successfulAttempts": 4,
  "failedAttempts": 1,
  "totalAttempts": 5
}

Authorizations

X-API-Key
string
header
required

API Key is required in header. You can find it in the settings

Path Parameters

batchId
string
required

A unique identifier for the batch.

Query Parameters

agentId
string
required

A unique identifier for the agent to which the batch belongs.

Response

OK

batchId
string

Unique identity for a batch

Example:

"batch_s0OJu2JWR8R45Fai"

workspaceId
string

Workspace to which the user belongs

Example:

"org_V6eZ2zg8ziDx5pft"

agent
object

Assigned agent for current campaign

Example:
{
"name": "Demo Agent",
"agentId": "mJzLaPEo425lieb9",
"status": "Testing"
}
createdDate
string<date-time>

Timestamp when the batch was created

testCases
object[]

List of test cases being run by the batch

successfulAttempts
integer<int64>

Total attempts which were successful in the batch run

Example:

4

failedAttempts
integer<int64>

Total attempts which failed in the batch run

Example:

1

totalAttempts
integer<int64>

Total attempts in the batch

Example:

5