SIsigmamind
Batch Runs

Create Batch Run

Changed on

Triggers a new batch run by executing one test case the requested number of times against the selected agent. Returns the created batch including its batchId, which is required for subsequent get and list test-run calls.

post/v1/batch-runs

Request

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

Request body

agentIdstring required

The unique identifier of the agent against which the test case will be executed.

testCaseIdstring required

The test case executed by this batch. A batch runs exactly one test case.

attemptinteger

How many times this batch runs the test case. When omitted, the batch uses the attempt on the test case.

Example request

{
  "agentId": "agent_D5D0p7TUs66TTAEAx",
  "testCaseId": "tc_xeeXG5hX9dl0VFNt",
  "attempt": 5
}

Response

Created

batchIdstring

The unique identifier of the newly created 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.

Example response

{
  "batchId": "batch_s0OJu2JWR8R45Fai",
  "workspaceId": "org_V6eZ2zg8ziDx5pft",
  "agent": {
    "name": "New AI Agent",
    "agentId": "agent_D5D0p7TUs66TTAEAx",
    "status": "Live"
  },
  "createdDate": "2026-03-26T10:52:45.565905Z"
}

Changes

  • 783c9e4c5126Revision changes
    • breaking

      added the new required request property

    • warning

      removed the request property

    • info

      added the new optional request property