Skip to main content
POST
Create Test Suite

Authorizations

x-api-key
string
header
required

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

Body

application/json
name
string
required

Test suite name

Maximum string length: 128
targetAgentId
string
required

ID of the agent to test

testMode
enum<string>

How this suite's tests run. 'chat' (default): fast text conversation against the agent's call configuration. 'voice': full simulated phone call. 'sms' / 'web_chat': simulated text conversation against the agent's SMS or web chat setup (its channel prompt, knowledge, and tools).

Available options:
chat,
voice,
sms,
web_chat
testerAgentId
string | null

ID of a custom tester agent (optional)

maxConcurrency
integer | null

Maximum concurrent test calls

Required range: 2 <= x <= 100
defaultVariables
object | null

Default variables for all test cases

Response

Test suite created

data
object

Test suite for evaluating agent performance