Skip to main content
POST
/
test-suites
/
{id}
/
runs
Start Test Run
curl --request POST \
  --url https://api.revring.ai/v1/test-suites/{id}/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "testSuiteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "totalTests": 123,
    "passedTests": 123,
    "failedTests": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "attempts": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "testCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "testCaseName": "<string>",
        "attemptNumber": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "callId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "inboundCallId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "reasoning": "<string>",
        "transcript": [
          {}
        ],
        "startedAt": "2023-11-07T05:31:56Z",
        "completedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.revring.ai/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

Test run started

​
data
object

A test run execution