Skip to main content
POST
Start Test Run

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Path Parameters

id
string<uuid>
required

Test suite ID

Body

application/json
name
string

Test run name (optional, auto-generated if omitted)

Maximum string length: 128
mode
enum<string>

Override the suite's test type for this run only. Omit to use the suite's configured type.

Available options:
chat,
voice,
sms,
web_chat
testCaseIds
string[]

Run only these test cases instead of the entire suite (for example, to re-run just the tests that failed). Omit to run the whole suite. IDs that do not belong to the suite are ignored; if none match, the request is rejected.

environment
string

Which version of the target agent to test. Omit for the saved draft (test before you publish). production tests the published version; any other name tests that environment (400 environment_not_found if it does not exist). See Versions and Publishing

Pattern: ^[a-z][a-z0-9-]{0,31}$
variables
object

Variable overrides for this run only. Merged over the suite's defaultVariables and each test case's variables (run values win) for every attempt, then rendered into the agent's prompt exactly as on a real call. Use this to supply values at the moment you start a run without editing the suite or its tests.

Response

Test run started

data
object

A test run execution