Skip to main content
POST
Create Test Case

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.

Path Parameters

id
string<uuid>
required

Test suite ID

Body

application/json
name
string
required

Test case name

Maximum string length: 128
script
string
required

Conversation script the tester follows

Maximum string length: 10000
scoringRubric
string
required

Criteria for evaluating the agent's responses

Maximum string length: 5000
attemptsPerRun
integer
default:1

Number of attempts per test run

Required range: 1 <= x <= 10
variables
object | null

Test case specific variables (override suite defaults)

toolMocks
object | null

Canned results for the agent's custom tools during this test (its entries win over the suite's), 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 case created

data
object

A test case within a test suite