Skip to main content
POST
/
v1
/
batch-runs
Create Batch Run
curl --request POST \
  --url https://api.sigmamind.ai/v1/batch-runs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "agentId": "D5D0p7TUs66TTAEAx",
  "testCases": [
    "tc_xeeXG5hX9dl0VFNt",
    "tc_aQqGZoMIPbU5MXHV"
  ]
}
'
{
  "batchId": "batch_s0OJu2JWR8R45Fai",
  "workspaceId": "org_V6eZ2zg8ziDx5pft",
  "agent": {
    "name": "New AI Agent",
    "agentId": "agent_D5D0p7TUs66TTAEAx",
    "status": "Live"
  },
  "createdDate": "2026-03-26T10:52:45.565Z"
}

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.

Body

application/json
​
agentId
string
required

The unique identifier of the Agent that will respond across all test cases in the batch simulation.

Example:

"D5D0p7TUs66TTAEAx"

​
testCases
string[]
required

A list of test case IDs to be executed together in a single batch run. Each test case will be simulated independently against the specified Agent.

A list of test case IDs to be executed together in a single batch run. Each test case will be simulated independently against the specified Agent.

Example:
[
  "tc_xeeXG5hX9dl0VFNt",
  "tc_aQqGZoMIPbU5MXHV"
]

Response

Created

​
batchId
string

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