SIsigmamind
Batch Runs

List Batch Runs

Changed on

Returns a paginated list of batch runs for the specified agent, sorted by most recently created first. Use page and size to navigate through results.

get/v1/batch-runs

Request

  • Base URL
    https://api.sigmamind.ai
  • Auth
    API key in header X-API-Key

Query parameters

agentIdstring required

Unique identifier of the agent whose batch runs are to be listed.

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of batch runs to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "batchId": "batch_s0OJu2JWR8R45Fai",
      "workspaceId": "org_V6eZ2zg8ziDx5pft",
      "agent": {
        "name": "New AI Agent",
        "agentId": "agent_D5D0p7TUs66TTAEAx",
        "status": "Live"
      },
      "createdDate": "2026-03-26T10:52:45.565905Z",
      "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
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}

Changes

  • 783c9e4c5126Revision changes
    • breaking

      the //// response's property type changed from string to array for status

  • 64c0435b10ebRevision changes
    • info

      added the optional property //// to the response with the status