Get Test Suite

GET

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

GET

/test-suite/:id

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

Try it

200Retrieved

1 {
2   "id": "id",
3   "orgId": "orgId",
4   "createdAt": "2024-01-15T09:30:00Z",
5   "updatedAt": "2024-01-15T09:30:00Z",
6   "name": "name",
7   "testerPlan": {
8     "assistant": {
9       "transcriber": {
10         "provider": "assembly-ai"
11       },
12       "model": {
13         "provider": "anyscale",
14         "model": "model"
15       },
16       "voice": {
17         "provider": "azure",
18         "voiceId": "andrew"
19       },
20       "firstMessage": "Hello! How can I help you today?",
21       "firstMessageInterruptionsEnabled": true,
22       "firstMessageMode": "assistant-speaks-first",
23       "voicemailDetection": {
24         "provider": "google",
25         "voicemailExpectedDurationSeconds": 1.1
26       },
27       "clientMessages": [
28         "conversation-update",
29         "function-call",
30         "hang",
31         "model-output",
32         "speech-update",
33         "status-update",
34         "transfer-update",
35         "transcript",
36         "tool-calls",
37         "user-interrupted",
38         "voice-input",
39         "workflow.node.started"
40       ],
41       "serverMessages": [
42         "conversation-update",
43         "end-of-call-report",
44         "function-call",
45         "hang",
46         "speech-update",
47         "status-update",
48         "tool-calls",
49         "transfer-destination-request",
50         "user-interrupted"
51       ],
52       "silenceTimeoutSeconds": 30,
53       "maxDurationSeconds": 600,
54       "backgroundSound": "off",
55       "backgroundDenoisingEnabled": false,
56       "modelOutputInMessagesEnabled": false,
57       "transportConfigurations": [
58         {
59           "provider": "twilio",
60           "timeout": 60,
61           "record": false
62         }
63       ],
64       "observabilityPlan": {
65         "provider": "langfuse",
66         "tags": [
67           "tags"
68         ]
69       },
70       "credentials": [
71         {
72           "provider": "11labs",
73           "apiKey": "apiKey"
74         }
75       ],
76       "name": "name",
77       "voicemailMessage": "voicemailMessage",
78       "endCallMessage": "endCallMessage",
79       "endCallPhrases": [
80         "endCallPhrases"
81       ],
82       "metadata": {
83         "key": "value"
84       },
85       "artifactPlan": {
86         "recordingEnabled": true,
87         "videoRecordingEnabled": false,
88         "pcapEnabled": true,
89         "pcapS3PathPrefix": "/pcaps"
90       },
91       "startSpeakingPlan": {
92         "waitSeconds": 0.4,
93         "smartEndpointingEnabled": {
94           "key": "value"
95         }
96       },
97       "stopSpeakingPlan": {
98         "numWords": 0,
99         "voiceSeconds": 0.2,
100         "backoffSeconds": 1
101       },
102       "monitorPlan": {
103         "listenEnabled": false,
104         "controlEnabled": false
105       },
106       "credentialIds": [
107         "credentialIds"
108       ],
109       "server": {
110         "url": "url",
111         "timeoutSeconds": 20,
112         "backoffPlan": {
113           "maxRetries": 0,
114           "type": {
115             "key": "value"
116           },
117           "baseDelaySeconds": 1
118         }
119       },
120       "hooks": [
121         {
122           "on": "call.ending",
123           "do": [
124             {}
125           ]
126         }
127       ]
128     },
129     "assistantId": "assistantId",
130     "assistantOverrides": {
131       "transcriber": {
132         "provider": "assembly-ai"
133       },
134       "model": {
135         "provider": "anyscale",
136         "model": "model"
137       },
138       "voice": {
139         "provider": "azure",
140         "voiceId": "andrew"
141       },
142       "firstMessage": "Hello! How can I help you today?",
143       "firstMessageInterruptionsEnabled": true,
144       "firstMessageMode": "assistant-speaks-first",
145       "voicemailDetection": {
146         "provider": "google",
147         "voicemailExpectedDurationSeconds": 1.1
148       },
149       "clientMessages": [
150         "conversation-update",
151         "function-call",
152         "hang",
153         "model-output",
154         "speech-update",
155         "status-update",
156         "transfer-update",
157         "transcript",
158         "tool-calls",
159         "user-interrupted",
160         "voice-input",
161         "workflow.node.started"
162       ],
163       "serverMessages": [
164         "conversation-update",
165         "end-of-call-report",
166         "function-call",
167         "hang",
168         "speech-update",
169         "status-update",
170         "tool-calls",
171         "transfer-destination-request",
172         "user-interrupted"
173       ],
174       "silenceTimeoutSeconds": 30,
175       "maxDurationSeconds": 600,
176       "backgroundSound": "off",
177       "backgroundDenoisingEnabled": false,
178       "modelOutputInMessagesEnabled": false,
179       "transportConfigurations": [
180         {
181           "provider": "twilio",
182           "timeout": 60,
183           "record": false
184         }
185       ],
186       "observabilityPlan": {
187         "provider": "langfuse",
188         "tags": [
189           "tags"
190         ]
191       },
192       "credentials": [
193         {
194           "provider": "11labs",
195           "apiKey": "apiKey"
196         }
197       ],
198       "variableValues": {
199         "key": "value"
200       },
201       "name": "name",
202       "voicemailMessage": "voicemailMessage",
203       "endCallMessage": "endCallMessage",
204       "endCallPhrases": [
205         "endCallPhrases"
206       ],
207       "metadata": {
208         "key": "value"
209       },
210       "artifactPlan": {
211         "recordingEnabled": true,
212         "videoRecordingEnabled": false,
213         "pcapEnabled": true,
214         "pcapS3PathPrefix": "/pcaps"
215       },
216       "startSpeakingPlan": {
217         "waitSeconds": 0.4,
218         "smartEndpointingEnabled": {
219           "key": "value"
220         }
221       },
222       "stopSpeakingPlan": {
223         "numWords": 0,
224         "voiceSeconds": 0.2,
225         "backoffSeconds": 1
226       },
227       "monitorPlan": {
228         "listenEnabled": false,
229         "controlEnabled": false
230       },
231       "credentialIds": [
232         "credentialIds"
233       ],
234       "server": {
235         "url": "url",
236         "timeoutSeconds": 20,
237         "backoffPlan": {
238           "maxRetries": 0,
239           "type": {
240             "key": "value"
241           },
242           "baseDelaySeconds": 1
243         }
244       },
245       "hooks": [
246         {
247           "on": "call.ending",
248           "do": [
249             {}
250           ]
251         }
252       ]
253     }
254   },
255   "targetPlan": {
256     "phoneNumberId": "phoneNumberId",
257     "phoneNumber": {
258       "provider": "test-suite",
259       "number": "number"
260     }
261   },
262   "phoneNumberId": "phoneNumberId"
263 }

Path parameters

idstringRequired

Response

idstring

This is the unique identifier for the test suite.

orgIdstring

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

createdAtdatetime

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

updatedAtdatetime

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

namestringOptional<=80 characters

This is the name of the test suite.

testerPlanobjectOptional

Override the default tester plan by providing custom assistant configuration for the test agent.

We recommend only using this if you are confident, as we have already set sensible defaults on the tester plan.

targetPlanobjectOptional

These are the configuration for the assistant / phone number that is being tested.

phoneNumberIdstringOptionalDeprecated

This is the phone number ID associated with this test suite.

Path parameters

Headers

Response