Skip to main content
POST
Run Tests On The Agent

Headers

x-api-key
string | null

Your API key for programmatic access. Send it in the x-api-key header; you can create and manage keys from the Developers page.

Path Parameters

agent_id
string
required

The id of an agent. This is returned on agent creation.

Example:

"agent_3701k3ttaq12ewp8b7qv5rfyszkz"

Body

application/json
tests
SingleTestRunRequestModel · object[]
required

List of tests to run on the agent

Required array length: 1 - 5000 elements
agent_config_override
AdhocAgentConfigOverrideForTestRequestModel · object | null

Configuration overrides to use for testing. If not provided, the agent's default configuration will be used.

branch_id
string | null

ID of the branch to run the tests on. If not provided, the tests will be run on the agent default configuration.

repeat_count
integer
default:1

Number of times to run each test. When greater than 1, results are grouped and summarized.

Required range: 1 <= x <= 50

Response

Successful Response

id
string
required
test_runs
UnitTestRunResponseModel · object[]
required
agent_id
string | null
branch_id
string | null
created_at
integer
folder_id
string | null
repeat_count
integer
default:1
bucketing_status
enum<string> | null

None when repeat_count==1 (no bucketing). Otherwise tracks bucketing lifecycle.

Available options:
pending,
completed,
failed
result_groups
TestRunResultSummary · object[]