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. A key is either full access or read-only; a read-only key is refused with 403 read_only_key on any request that creates, changes or deletes.

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

toolMocks
object | null

Canned results for the agent's custom tools during every test in this suite, keyed by tool name: { "": { "response": , "status"?: <HTTP status, default 200> } }. A mocked tool is not called; its response reaches the agent exactly as the webhook's body would, and a non-2xx status means the tool's response variables are not saved. A test case's entries win over the suite. Up to 50 tools; null clears. Transcript rows of mocked calls carry mocked: true and httpStatus.

Response

Test suite created

data
object

Test suite for evaluating agent performance