Skip to main content
POST
Create Batch Run

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 against which the test case will be executed.

Example:

"agent_D5D0p7TUs66TTAEAx"

testCaseId
string
required

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

Example:

"tc_xeeXG5hX9dl0VFNt"

attempt
integer<int64>

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

Required range: x >= 1
Example:

5

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"