Skip to main content
POST
/
test-suites
/
{id}
/
tests
Create Test Case
curl --request POST \
  --url https://api.revring.ai/v1/test-suites/{id}/tests \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "script": "<string>",
  "scoringRubric": "<string>",
  "attemptsPerRun": 1,
  "variables": {}
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "testSuiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "script": "<string>",
    "scoringRubric": "<string>",
    "attemptsPerRun": 5,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "variables": {}
  }
}

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
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

Test case specific variables (override suite defaults)

Response

Test case created

​
data
object

A test case within a test suite