Delete Test Suite Run

DELETE

https://api.vapi.ai/test-suite/:testSuiteId/run/:id

DELETE

/test-suite/:testSuiteId/run/:id

1 curl -X DELETE https://api.vapi.ai/test-suite/testSuiteId/run/id \
2      -H "Authorization: Bearer <token>"

Try it

200testSuiteRunControllerRemoveExample

1 {
2   "status": "queued",
3   "id": "foo",
4   "orgId": "foo",
5   "testSuiteId": "foo",
6   "createdAt": "foo",
7   "updatedAt": "foo",
8   "testResults": [
9     {
10       "test": {
11         "scorers": [
12           {
13             "type": "ai",
14             "rubric": "foo"
15           }
16         ],
17         "type": "voice",
18         "id": "foo",
19         "testSuiteId": "foo",
20         "orgId": "foo",
21         "createdAt": "foo",
22         "updatedAt": "foo",
23         "name": "foo",
24         "script": "foo",
25         "numAttempts": 42
26       },
27       "attempts": [
28         {
29           "scorerResults": [
30             {
31               "type": "ai",
32               "result": "pass",
33               "reasoning": "foo",
34               "rubric": "foo"
35             }
36           ],
37           "call": {
38             "artifact": {
39               "messages": [
40                 {
41                   "role": "foo",
42                   "message": "foo",
43                   "time": 42,
44                   "endTime": 42,
45                   "secondsFromStart": 42,
46                   "duration": 42
47                 }
48               ],
49               "messagesOpenAIFormatted": [
50                 {
51                   "role": "assistant",
52                   "content": "foo"
53                 }
54               ],
55               "recording": {
56                 "stereoUrl": "foo",
57                 "videoUrl": "foo",
58                 "videoRecordingStartDelaySeconds": 42,
59                 "mono": {}
60               },
61               "transcript": "foo",
62               "pcapUrl": "foo",
63               "nodes": [
64                 {
65                   "nodeName": "foo",
66                   "messages": [
67                     {}
68                   ],
69                   "variables": {}
70                 }
71               ],
72               "variables": {},
73               "recordingUrl": "foo",
74               "stereoRecordingUrl": "foo",
75               "videoRecordingUrl": "foo",
76               "videoRecordingStartDelaySeconds": 42
77             }
78           },
79           "callId": "foo",
80           "metadata": {
81             "sessionId": "foo"
82           }
83         }
84       ]
85     }
86   ],
87   "name": "foo"
88 }

Path parameters

testSuiteIdstringRequired

idstringRequired

Response

statusenum

This is the current status of the test suite run.

Allowed values:

idstring

This is the unique identifier for the test suite run.

orgIdstring

This is the unique identifier for the organization this run belongs to.

testSuiteIdstring

This is the unique identifier for the test suite this run belongs to.

createdAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the test suite run was created.

updatedAtstringformat: "date-time"

This is the ISO 8601 date-time string of when the test suite run was last updated.

testResultslist of objects

These are the results of the tests in this test suite run.

namestring or null<=80 characters

This is the name of the test suite run.

Path parameters

Headers

Response