Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
Batch Runs

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}

Path parameters

batchIdstring required

The unique identifier of the batch run to retrieve.

Query parameters

agentIdstring required

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

Response

OK

batchIdstring

The unique identifier of the batch run.

workspaceIdstring

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

createdDatestring date-time

The UTC timestamp indicating when the batch run was created.

successfulAttemptsinteger

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

failedAttemptsinteger

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

totalAttemptsinteger

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

Example response

{
  "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
}