Update Test Suite Run

Path parameters

testSuiteIdstringRequired

idstringRequired

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringOptional<=80 characters

This is the name of the test suite run.

Response

statusenum

Allowed values: queuedin-progresscompleted

This is the current status of the test suite run.

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.

createdAtdatetime

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

updatedAtdatetime

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.

namestringOptional<=80 characters

This is the name of the test suite run.

1 curl -X PATCH https://api.vapi.ai/test-suite/testSuiteId/run/id \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "status": "queued", 3 "id": "id", 4 "orgId": "orgId", 5 "testSuiteId": "testSuiteId", 6 "createdAt": "2024-01-15T09:30:00Z", 7 "updatedAt": "2024-01-15T09:30:00Z", 8 "testResults": [ 9 { 10 "test": { 11 "scorers": [ 12 { 13 "type": "ai", 14 "rubric": "rubric" 15 } 16 ], 17 "id": "id", 18 "testSuiteId": "testSuiteId", 19 "orgId": "orgId", 20 "createdAt": "2024-01-15T09:30:00Z", 21 "updatedAt": "2024-01-15T09:30:00Z", 22 "script": "script" 23 }, 24 "attempts": [ 25 { 26 "scorerResults": [ 27 { 28 "type": "ai", 29 "result": "pass", 30 "reasoning": "reasoning", 31 "rubric": "rubric" 32 } 33 ], 34 "call": { 35 "artifact": {} 36 } 37 } 38 ] 39 } 40 ], 41 "name": "name" 42 }

1	curl -X PATCH https://api.vapi.ai/test-suite/testSuiteId/run/id \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"status": "queued",
3	"id": "id",
4	"orgId": "orgId",
5	"testSuiteId": "testSuiteId",
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"testResults": [
9	{
10	"test": {
11	"scorers": [
12	{
13	"type": "ai",
14	"rubric": "rubric"
15	}
16	],
17	"id": "id",
18	"testSuiteId": "testSuiteId",
19	"orgId": "orgId",
20	"createdAt": "2024-01-15T09:30:00Z",
21	"updatedAt": "2024-01-15T09:30:00Z",
22	"script": "script"
23	},
24	"attempts": [
25	{
26	"scorerResults": [
27	{
28	"type": "ai",
29	"result": "pass",
30	"reasoning": "reasoning",
31	"rubric": "rubric"
32	}
33	],
34	"call": {
35	"artifact": {}
36	}
37	}
38	]
39	}
40	],
41	"name": "name"
42	}