List Assistants

GET

https://api.vapi.ai/assistant

GET

/assistant

1 from vapi import Vapi
2 
3 client = Vapi(
4     token="YOUR_TOKEN",
5 )
6 client.assistants.list()

Try it

200Retrieved

1 [
2   {
3     "id": "string",
4     "orgId": "string",
5     "createdAt": "2024-01-15T09:30:00Z",
6     "updatedAt": "2024-01-15T09:30:00Z",
7     "transcriber": {
8       "provider": "assembly-ai",
9       "language": "en",
10       "confidenceThreshold": 0.4,
11       "formatTurns": true,
12       "endOfTurnConfidenceThreshold": 0.7,
13       "minEndOfTurnSilenceWhenConfident": 160,
14       "wordFinalizationMaxWaitTime": 160,
15       "maxTurnSilence": 400,
16       "realtimeUrl": "string",
17       "wordBoost": [
18         "string"
19       ],
20       "endUtteranceSilenceThreshold": 1.1,
21       "disablePartialTranscripts": true,
22       "fallbackPlan": {
23         "transcribers": [
24           {
25             "provider": "assembly-ai",
26             "language": "en",
27             "confidenceThreshold": 0.4,
28             "formatTurns": true,
29             "endOfTurnConfidenceThreshold": 0.7,
30             "minEndOfTurnSilenceWhenConfident": 160,
31             "wordFinalizationMaxWaitTime": 160,
32             "maxTurnSilence": 400,
33             "realtimeUrl": "string",
34             "wordBoost": [
35               "string"
36             ],
37             "endUtteranceSilenceThreshold": 1.1,
38             "disablePartialTranscripts": true
39           }
40         ]
41       }
42     },
43     "model": {
44       "messages": [
45         {
46           "content": "string",
47           "role": "assistant"
48         }
49       ],
50       "tools": [
51         {
52           "messages": [
53             {
54               "contents": [
55                 {
56                   "type": "text",
57                   "text": "string",
58                   "language": "aa"
59                 }
60               ],
61               "type": "request-start",
62               "blocking": false,
63               "content": "string",
64               "conditions": [
65                 {
66                   "operator": "eq",
67                   "param": "string",
68                   "value": "string"
69                 }
70               ]
71             }
72           ],
73           "type": "apiRequest",
74           "method": "POST",
75           "timeoutSeconds": 20,
76           "credentialId": "550e8400-e29b-41d4-a716-446655440000",
77           "name": "string",
78           "description": "string",
79           "url": "string",
80           "body": {
81             "type": "string",
82             "items": {},
83             "properties": {},
84             "description": "string",
85             "pattern": "string",
86             "format": "date-time",
87             "required": [
88               "string"
89             ],
90             "enum": [
91               "string"
92             ],
93             "title": "string"
94           },
95           "headers": {
96             "type": "string",
97             "items": {},
98             "properties": {},
99             "description": "string",
100             "pattern": "string",
101             "format": "date-time",
102             "required": [
103               "string"
104             ],
105             "enum": [
106               "string"
107             ],
108             "title": "string"
109           },
110           "backoffPlan": {
111             "type": "fixed",
112             "maxRetries": 0,
113             "baseDelaySeconds": 1,
114             "excludedStatusCodes": [
115               400,
116               401,
117               403,
118               404
119             ]
120           },
121           "variableExtractionPlan": {
122             "schema": {
123               "type": "string",
124               "items": {},
125               "properties": {},
126               "description": "string",
127               "pattern": "string",
128               "format": "date-time",
129               "required": [
130                 "string"
131               ],
132               "enum": [
133                 "string"
134               ],
135               "title": "string"
136             },
137             "aliases": [
138               {
139                 "key": "string",
140                 "value": "string"
141               }
142             ]
143           },
144           "rejectionPlan": {
145             "conditions": [
146               {
147                 "type": "regex",
148                 "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words",
149                 "target": {
150                   "role": "user",
151                   "position": -1
152                 },
153                 "negate": "true - Reject if user hasn\"t said goodbye: { regex: \"\\\\b(bye|goodbye)\\\\b\", negate: true }"
154               }
155             ]
156           }
157         }
158       ],
159       "toolIds": [
160         "string"
161       ],
162       "knowledgeBase": {
163         "provider": "custom-knowledge-base",
164         "server": {
165           "timeoutSeconds": 20,
166           "credentialId": "550e8400-e29b-41d4-a716-446655440000",
167           "url": "string",
168           "headers": {},
169           "backoffPlan": {
170             "type": "fixed",
171             "maxRetries": 0,
172             "baseDelaySeconds": 1,
173             "excludedStatusCodes": [
174               400,
175               401,
176               403,
177               404
178             ]
179           }
180         }
181       },
182       "model": "claude-3-opus-20240229",
183       "provider": "anthropic",
184       "thinking": {
185         "type": "enabled",
186         "budgetTokens": 1.1
187       },
188       "temperature": 1.1,
189       "maxTokens": 1.1,
190       "emotionRecognitionEnabled": true,
191       "numFastTurns": 1.1
192     },
193     "voice": {
194       "cachingEnabled": true,
195       "provider": "azure",
196       "voiceId": "andrew",
197       "chunkPlan": {
198         "enabled": true,
199         "minCharacters": 30,
200         "punctuationBoundaries": "。",
201         "formatPlan": {
202           "enabled": true,
203           "numberToDigitsCutoff": 2025,
204           "replacements": [
205             {
206               "type": "exact",
207               "replaceAllEnabled": false,
208               "key": "string",
209               "value": "string"
210             }
211           ],
212           "formattersEnabled": "markdown"
213         }
214       },
215       "speed": 1.1,
216       "fallbackPlan": {
217         "voices": [
218           {
219             "cachingEnabled": true,
220             "provider": "azure",
221             "voiceId": "andrew",
222             "speed": 1.1,
223             "chunkPlan": {
224               "enabled": true,
225               "minCharacters": 30,
226               "punctuationBoundaries": "。",
227               "formatPlan": {
228                 "enabled": true,
229                 "numberToDigitsCutoff": 2025,
230                 "replacements": [
231                   {
232                     "type": {},
233                     "replaceAllEnabled": {},
234                     "key": {},
235                     "value": {}
236                   }
237                 ],
238                 "formattersEnabled": "markdown"
239               }
240             },
241             "oneOf": null
242           }
243         ]
244       }
245     },
246     "firstMessage": "Hello! How can I help you today?",
247     "firstMessageInterruptionsEnabled": false,
248     "firstMessageMode": "assistant-speaks-first",
249     "voicemailDetection": {
250       "beepMaxAwaitSeconds": 30,
251       "provider": "google",
252       "backoffPlan": {
253         "startAtSeconds": 5,
254         "frequencySeconds": 5,
255         "maxRetries": 6
256       },
257       "type": "audio"
258     },
259     "clientMessages": "conversation-update",
260     "serverMessages": "conversation-update",
261     "maxDurationSeconds": 600,
262     "backgroundSound": "off",
263     "modelOutputInMessagesEnabled": false,
264     "transportConfigurations": [
265       {
266         "provider": "twilio",
267         "timeout": 60,
268         "record": false,
269         "recordingChannels": "mono"
270       }
271     ],
272     "observabilityPlan": {
273       "provider": "langfuse",
274       "tags": [
275         "string"
276       ],
277       "metadata": {}
278     },
279     "credentials": [
280       {
281         "provider": "anthropic",
282         "apiKey": "string",
283         "name": "string"
284       }
285     ],
286     "hooks": [
287       {
288         "on": "call.ending",
289         "do": [
290           {
291             "type": "tool",
292             "tool": {
293               "messages": [
294                 {
295                   "contents": [
296                     {
297                       "type": "text",
298                       "text": "string",
299                       "language": "aa"
300                     }
301                   ],
302                   "type": "request-start",
303                   "blocking": false,
304                   "content": "string",
305                   "conditions": [
306                     {
307                       "operator": "eq",
308                       "param": "string",
309                       "value": "string"
310                     }
311                   ]
312                 }
313               ],
314               "type": "apiRequest",
315               "method": "POST",
316               "timeoutSeconds": 20,
317               "credentialId": "550e8400-e29b-41d4-a716-446655440000",
318               "name": "string",
319               "description": "string",
320               "url": "string",
321               "body": {
322                 "type": "string",
323                 "items": {},
324                 "properties": {},
325                 "description": "string",
326                 "pattern": "string",
327                 "format": "date-time",
328                 "required": [
329                   "string"
330                 ],
331                 "enum": [
332                   "string"
333                 ],
334                 "title": "string"
335               },
336               "headers": {
337                 "type": "string",
338                 "items": {},
339                 "properties": {},
340                 "description": "string",
341                 "pattern": "string",
342                 "format": "date-time",
343                 "required": [
344                   "string"
345                 ],
346                 "enum": [
347                   "string"
348                 ],
349                 "title": "string"
350               },
351               "backoffPlan": {
352                 "type": "fixed",
353                 "maxRetries": 0,
354                 "baseDelaySeconds": 1,
355                 "excludedStatusCodes": [
356                   400,
357                   401,
358                   403,
359                   404
360                 ]
361               },
362               "variableExtractionPlan": {
363                 "schema": {
364                   "type": "string",
365                   "items": {},
366                   "properties": {},
367                   "description": "string",
368                   "pattern": "string",
369                   "format": "date-time",
370                   "required": [
371                     "string"
372                   ],
373                   "enum": [
374                     "string"
375                   ],
376                   "title": "string"
377                 },
378                 "aliases": [
379                   {
380                     "key": "string",
381                     "value": "string"
382                   }
383                 ]
384               },
385               "rejectionPlan": {
386                 "conditions": [
387                   {
388                     "type": "regex",
389                     "regex": "\\\\b(cancel|stop|wait)\\\\b - Matches whole words",
390                     "target": {
391                       "role": {},
392                       "position": {}
393                     },
394                     "negate": "true - Reject if user hasn\"t said goodbye: { regex: \"\\\\b(bye|goodbye)\\\\b\", negate: true }"
395                   }
396                 ]
397               }
398             },
399             "toolId": "string"
400           }
401         ],
402         "filters": [
403           {
404             "type": "oneOf",
405             "key": "string",
406             "oneOf": [
407               "string"
408             ]
409           }
410         ]
411       }
412     ],
413     "name": "string",
414     "voicemailMessage": "string",
415     "endCallMessage": "string",
416     "endCallPhrases": [
417       "string"
418     ],
419     "compliancePlan": {
420       "hipaaEnabled": {
421         "hipaaEnabled": false
422       },
423       "pciEnabled": {
424         "pciEnabled": false
425       },
426       "securityFilterPlan": {
427         "enabled": false,
428         "filters": [
429           {}
430         ],
431         "mode": "sanitize",
432         "replacementText": "[FILTERED]"
433       },
434       "recordingConsentPlan": {
435         "message": "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.",
436         "voice": {
437           "cachingEnabled": true,
438           "provider": "azure",
439           "voiceId": "andrew",
440           "chunkPlan": {
441             "enabled": true,
442             "minCharacters": 30,
443             "punctuationBoundaries": "。",
444             "formatPlan": {
445               "enabled": true,
446               "numberToDigitsCutoff": 2025,
447               "replacements": [
448                 {
449                   "type": "exact",
450                   "replaceAllEnabled": false,
451                   "key": "string",
452                   "value": "string"
453                 }
454               ],
455               "formattersEnabled": "markdown"
456             }
457           },
458           "speed": 1.1,
459           "fallbackPlan": {
460             "voices": [
461               {
462                 "cachingEnabled": true,
463                 "provider": "azure",
464                 "voiceId": "andrew",
465                 "speed": 1.1,
466                 "chunkPlan": {
467                   "enabled": true,
468                   "minCharacters": 30,
469                   "punctuationBoundaries": "。",
470                   "formatPlan": {}
471                 },
472                 "oneOf": null
473               }
474             ]
475           }
476         },
477         "type": "hang-up-to-decline",
478         "waitSeconds": 2
479       }
480     },
481     "metadata": {},
482     "backgroundSpeechDenoisingPlan": {
483       "smartDenoisingPlan": {
484         "enabled": false
485       },
486       "fourierDenoisingPlan": {
487         "enabled": false,
488         "mediaDetectionEnabled": true,
489         "staticThreshold": -35,
490         "baselineOffsetDb": -15,
491         "windowSizeMs": 3000,
492         "baselinePercentile": 85
493       }
494     },
495     "analysisPlan": {
496       "minMessagesThreshold": 1.1,
497       "summaryPlan": {
498         "messages": [
499           {}
500         ],
501         "enabled": true,
502         "timeoutSeconds": 1.1
503       },
504       "structuredDataPlan": {
505         "messages": [
506           {}
507         ],
508         "enabled": true,
509         "schema": {
510           "type": "string",
511           "items": {},
512           "properties": {},
513           "description": "string",
514           "pattern": "string",
515           "format": "date-time",
516           "required": [
517             "string"
518           ],
519           "enum": [
520             "string"
521           ],
522           "title": "string"
523         },
524         "timeoutSeconds": 1.1
525       },
526       "structuredDataMultiPlan": [
527         {
528           "key": "string",
529           "plan": {
530             "messages": [
531               {}
532             ],
533             "enabled": true,
534             "schema": {
535               "type": "string",
536               "items": {},
537               "properties": {},
538               "description": "string",
539               "pattern": "string",
540               "format": "date-time",
541               "required": [
542                 "string"
543               ],
544               "enum": [
545                 "string"
546               ],
547               "title": "string"
548             },
549             "timeoutSeconds": 1.1
550           }
551         }
552       ],
553       "successEvaluationPlan": {
554         "rubric": "NumericScale",
555         "messages": [
556           {}
557         ],
558         "enabled": true,
559         "timeoutSeconds": 1.1
560       },
561       "outcomeIds": [
562         "string"
563       ]
564     },
565     "artifactPlan": {
566       "recordingEnabled": true,
567       "recordingFormat": "wav;l16",
568       "recordingUseCustomStorageEnabled": true,
569       "videoRecordingEnabled": false,
570       "pcapEnabled": true,
571       "pcapS3PathPrefix": "/pcaps",
572       "pcapUseCustomStorageEnabled": true,
573       "loggingEnabled": true,
574       "loggingUseCustomStorageEnabled": true,
575       "transcriptPlan": {
576         "enabled": true,
577         "assistantName": "string",
578         "userName": "string"
579       },
580       "recordingPath": "string",
581       "structuredOutputIds": [
582         "string"
583       ],
584       "loggingPath": "string"
585     },
586     "startSpeakingPlan": {
587       "waitSeconds": 0.4,
588       "smartEndpointingPlan": {
589         "provider": "vapi"
590       },
591       "customEndpointingRules": [
592         {
593           "type": "assistant",
594           "regex": "string",
595           "regexOptions": [
596             {
597               "type": "ignore-case",
598               "enabled": true
599             }
600           ],
601           "timeoutSeconds": 1.1
602         }
603       ],
604       "transcriptionEndpointingPlan": {
605         "onPunctuationSeconds": 0.1,
606         "onNoPunctuationSeconds": 1.5,
607         "onNumberSeconds": 0.5
608       },
609       "smartEndpointingEnabled": false
610     },
611     "stopSpeakingPlan": {
612       "numWords": 0,
613       "voiceSeconds": 0.2,
614       "backoffSeconds": 1,
615       "acknowledgementPhrases": [
616         "i understand",
617         "i see",
618         "i got it",
619         "i hear you",
620         "im listening",
621         "im with you",
622         "right",
623         "okay",
624         "ok",
625         "sure",
626         "alright",
627         "got it",
628         "understood",
629         "yeah",
630         "yes",
631         "uh-huh",
632         "mm-hmm",
633         "gotcha",
634         "mhmm",
635         "ah",
636         "yeah okay",
637         "yeah sure"
638       ],
639       "interruptionPhrases": [
640         "stop",
641         "shut",
642         "up",
643         "enough",
644         "quiet",
645         "silence",
646         "but",
647         "dont",
648         "not",
649         "no",
650         "hold",
651         "wait",
652         "cut",
653         "pause",
654         "nope",
655         "nah",
656         "nevermind",
657         "never",
658         "bad",
659         "actually"
660       ]
661     },
662     "monitorPlan": {
663       "listenEnabled": false,
664       "listenAuthenticationEnabled": false,
665       "controlEnabled": false,
666       "controlAuthenticationEnabled": false
667     },
668     "credentialIds": [
669       "string"
670     ],
671     "server": {
672       "timeoutSeconds": 20,
673       "credentialId": "550e8400-e29b-41d4-a716-446655440000",
674       "url": "string",
675       "headers": {},
676       "backoffPlan": {
677         "type": "fixed",
678         "maxRetries": 0,
679         "baseDelaySeconds": 1,
680         "excludedStatusCodes": [
681           400,
682           401,
683           403,
684           404
685         ]
686       }
687     },
688     "keypadInputPlan": {
689       "enabled": true,
690       "timeoutSeconds": 1.1,
691       "delimiters": "#"
692     }
693   }
694 ]

Query parameters

limitdoubleOptional>=0<=1000

This is the maximum number of items to return. Defaults to 100.

createdAtGtstringOptionalformat: "date-time"

This will return items where the createdAt is greater than the specified value.

createdAtLtstringOptionalformat: "date-time"

This will return items where the createdAt is less than the specified value.

createdAtGestringOptionalformat: "date-time"

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestringOptionalformat: "date-time"

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstringOptionalformat: "date-time"

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstringOptionalformat: "date-time"

This will return items where the updatedAt is less than the specified value.

updatedAtGestringOptionalformat: "date-time"

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestringOptionalformat: "date-time"

This will return items where the updatedAt is less than or equal to the specified value.

Response

idstring

This is the unique identifier for the assistant.

orgIdstring

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

createdAtstringformat: "date-time"

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

updatedAtstringformat: "date-time"

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

transcriberobject or null

These are the options for the assistant's transcriber.

modelobject or null

These are the options for the assistant's LLM.

voiceobject or null

These are the options for the assistant's voice.

firstMessagestring or null

This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).

If unspecified, assistant will wait for user to speak and use the model to respond once they speak.

firstMessageInterruptionsEnabledboolean or nullDefaults to false

firstMessageModeenum or null

This is the mode for the first message. Default is ‘assistant-speaks-first’.

Use:

‘assistant-speaks-first’ to have the assistant speak first.
‘assistant-waits-for-user’ to have the assistant wait for the user to speak first.
‘assistant-speaks-first-with-model-generated-message’ to have the assistant speak first with a message generated by the model based on the conversation state. (assistant.model.messages at call start, call.messages at squad transfer points).

@default ‘assistant-speaks-first’

Allowed values:

voicemailDetectionobject or null

These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool]. This uses Twilio’s built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached. You can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.

clientMessagesenum or null

These are the messages that will be sent to your Client SDKs. Default is conversation-update,function-call,hang,model-output,speech-update,status-update,transfer-update,transcript,tool-calls,user-interrupted,voice-input,workflow.node.started. You can check the shape of the messages in ClientMessage schema.

serverMessagesenum or null

These are the messages that will be sent to your Server URL. Default is conversation-update,end-of-call-report,function-call,hang,speech-update,status-update,tool-calls,transfer-destination-request,handoff-destination-request,user-interrupted. You can check the shape of the messages in ServerMessage schema.

maxDurationSecondsdouble or null>=10<=43200

This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended. @default 600 (10 minutes)

backgroundSoundenum or string or null

This is the background sound in the call. Default for phone calls is 'office' and default for web calls is 'off'. You can also provide a custom sound by providing a URL to an audio file.

modelOutputInMessagesEnabledboolean or null

This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech. Default `false` while in beta. @default false

transportConfigurationslist of objects or null

These are the configurations to be passed to the transport providers of assistant's calls, like Twilio. You can store multiple configurations for different transport providers. For a call, only the configuration matching the call transport provider is used.

observabilityPlanobject or null

This is the plan for observability of assistant's calls. Currently, only Langfuse is supported.

credentialslist of objects or null

These are dynamic credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can supplement an additional credentials using this. Dynamic credentials override existing credentials.

hookslist of objects or null

This is a set of actions that will be performed on certain events.

namestring or null<=40 characters

This is the name of the assistant. This is required when you want to transfer between assistants in a call.

voicemailMessagestring or null<=1000 characters

This is the message that the assistant will say if the call is forwarded to voicemail. If unspecified, it will hang up.

endCallMessagestring or null<=1000 characters

This is the message that the assistant will say if it ends the call. If unspecified, it will hang up without saying anything.

endCallPhraseslist of strings or null

This list contains phrases that, if spoken by the assistant, will trigger the call to be hung up. Case insensitive.

compliancePlanobject or null

metadataobject or null

This is for metadata you want to store on the assistant.

backgroundSpeechDenoisingPlanobject or null

This enables filtering of noise and background speech while the user is talking. Features: - Smart denoising using Krisp - Fourier denoising Smart denoising can be combined with or used independently of Fourier denoising. Order of precedence: - Smart denoising - Fourier denoising

analysisPlanobject or null

This is the plan for analysis of assistant's calls. Stored in `call.analysis`.

artifactPlanobject or null

This is the plan for artifacts generated during assistant's calls. Stored in `call.artifact`.

startSpeakingPlanobject or null

This is the plan for when the assistant should start talking. You should configure this if you're running into these issues: - The assistant is too slow to start talking after the customer is done speaking. - The assistant is too fast to start talking after the customer is done speaking. - The assistant is so fast that it's actually interrupting the customer.

stopSpeakingPlanobject or null

This is the plan for when assistant should stop talking on customer interruption. You should configure this if you're running into these issues: - The assistant is too slow to recognize customer's interruption. - The assistant is too fast to recognize customer's interruption. - The assistant is getting interrupted by phrases that are just acknowledgments. - The assistant is getting interrupted by background noises. - The assistant is not properly stopping -- it starts talking right after getting interrupted.

monitorPlanobject or null

This is the plan for real-time monitoring of the assistant's calls. Usage: - To enable live listening of the assistant's calls, set `monitorPlan.listenEnabled` to `true`. - To enable live control of the assistant's calls, set `monitorPlan.controlEnabled` to `true`.

credentialIdslist of strings or null

These are the credentials that will be used for the assistant calls. By default, all the credentials are available for use in the call but you can provide a subset using this.

serverobject or null

This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema. The order of precedence is: 1. assistant.server.url 2. phoneNumber.serverUrl 3. org.serverUrl

keypadInputPlanobject or null

1	from vapi import Vapi
2
3	client = Vapi(
4	token="YOUR_TOKEN",
5	)
6	client.assistants.list()

1	[
2	{
3	"id": "string",
4	"orgId": "string",
5	"createdAt": "2024-01-15T09:30:00Z",
6	"updatedAt": "2024-01-15T09:30:00Z",
7	"transcriber": {
8	"provider": "assembly-ai",
9	"language": "en",
10	"confidenceThreshold": 0.4,
11	"formatTurns": true,
12	"endOfTurnConfidenceThreshold": 0.7,
13	"minEndOfTurnSilenceWhenConfident": 160,
14	"wordFinalizationMaxWaitTime": 160,
15	"maxTurnSilence": 400,
16	"realtimeUrl": "string",
17	"wordBoost": [
18	"string"
19	],
20	"endUtteranceSilenceThreshold": 1.1,
21	"disablePartialTranscripts": true,
22	"fallbackPlan": {
23	"transcribers": [
24	{
25	"provider": "assembly-ai",
26	"language": "en",
27	"confidenceThreshold": 0.4,
28	"formatTurns": true,
29	"endOfTurnConfidenceThreshold": 0.7,
30	"minEndOfTurnSilenceWhenConfident": 160,
31	"wordFinalizationMaxWaitTime": 160,
32	"maxTurnSilence": 400,
33	"realtimeUrl": "string",
34	"wordBoost": [
35	"string"
36	],
37	"endUtteranceSilenceThreshold": 1.1,
38	"disablePartialTranscripts": true
39	}
40	]
41	}
42	},
43	"model": {
44	"messages": [
45	{
46	"content": "string",
47	"role": "assistant"
48	}
49	],
50	"tools": [
51	{
52	"messages": [
53	{
54	"contents": [
55	{
56	"type": "text",
57	"text": "string",
58	"language": "aa"
59	}
60	],
61	"type": "request-start",
62	"blocking": false,
63	"content": "string",
64	"conditions": [
65	{
66	"operator": "eq",
67	"param": "string",
68	"value": "string"
69	}
70	]
71	}
72	],
73	"type": "apiRequest",
74	"method": "POST",
75	"timeoutSeconds": 20,
76	"credentialId": "550e8400-e29b-41d4-a716-446655440000",
77	"name": "string",
78	"description": "string",
79	"url": "string",
80	"body": {
81	"type": "string",
82	"items": {},
83	"properties": {},
84	"description": "string",
85	"pattern": "string",
86	"format": "date-time",
87	"required": [
88	"string"
89	],
90	"enum": [
91	"string"
92	],
93	"title": "string"
94	},
95	"headers": {
96	"type": "string",
97	"items": {},
98	"properties": {},
99	"description": "string",
100	"pattern": "string",
101	"format": "date-time",
102	"required": [
103	"string"
104	],
105	"enum": [
106	"string"
107	],
108	"title": "string"
109	},
110	"backoffPlan": {
111	"type": "fixed",
112	"maxRetries": 0,
113	"baseDelaySeconds": 1,
114	"excludedStatusCodes": [
115	400,
116	401,
117	403,
118	404
119	]
120	},
121	"variableExtractionPlan": {
122	"schema": {
123	"type": "string",
124	"items": {},
125	"properties": {},
126	"description": "string",
127	"pattern": "string",
128	"format": "date-time",
129	"required": [
130	"string"
131	],
132	"enum": [
133	"string"
134	],
135	"title": "string"
136	},
137	"aliases": [
138	{
139	"key": "string",
140	"value": "string"
141	}
142	]
143	},
144	"rejectionPlan": {
145	"conditions": [
146	{
147	"type": "regex",
148	"regex": "\\\\b(cancel\|stop\|wait)\\\\b - Matches whole words",
149	"target": {
150	"role": "user",
151	"position": -1
152	},
153	"negate": "true - Reject if user hasn\"t said goodbye: { regex: \"\\\\b(bye\|goodbye)\\\\b\", negate: true }"
154	}
155	]
156	}
157	}
158	],
159	"toolIds": [
160	"string"
161	],
162	"knowledgeBase": {
163	"provider": "custom-knowledge-base",
164	"server": {
165	"timeoutSeconds": 20,
166	"credentialId": "550e8400-e29b-41d4-a716-446655440000",
167	"url": "string",
168	"headers": {},
169	"backoffPlan": {
170	"type": "fixed",
171	"maxRetries": 0,
172	"baseDelaySeconds": 1,
173	"excludedStatusCodes": [
174	400,
175	401,
176	403,
177	404
178	]
179	}
180	}
181	},
182	"model": "claude-3-opus-20240229",
183	"provider": "anthropic",
184	"thinking": {
185	"type": "enabled",
186	"budgetTokens": 1.1
187	},
188	"temperature": 1.1,
189	"maxTokens": 1.1,
190	"emotionRecognitionEnabled": true,
191	"numFastTurns": 1.1
192	},
193	"voice": {
194	"cachingEnabled": true,
195	"provider": "azure",
196	"voiceId": "andrew",
197	"chunkPlan": {
198	"enabled": true,
199	"minCharacters": 30,
200	"punctuationBoundaries": "。",
201	"formatPlan": {
202	"enabled": true,
203	"numberToDigitsCutoff": 2025,
204	"replacements": [
205	{
206	"type": "exact",
207	"replaceAllEnabled": false,
208	"key": "string",
209	"value": "string"
210	}
211	],
212	"formattersEnabled": "markdown"
213	}
214	},
215	"speed": 1.1,
216	"fallbackPlan": {
217	"voices": [
218	{
219	"cachingEnabled": true,
220	"provider": "azure",
221	"voiceId": "andrew",
222	"speed": 1.1,
223	"chunkPlan": {
224	"enabled": true,
225	"minCharacters": 30,
226	"punctuationBoundaries": "。",
227	"formatPlan": {
228	"enabled": true,
229	"numberToDigitsCutoff": 2025,
230	"replacements": [
231	{
232	"type": {},
233	"replaceAllEnabled": {},
234	"key": {},
235	"value": {}
236	}
237	],
238	"formattersEnabled": "markdown"
239	}
240	},
241	"oneOf": null
242	}
243	]
244	}
245	},
246	"firstMessage": "Hello! How can I help you today?",
247	"firstMessageInterruptionsEnabled": false,
248	"firstMessageMode": "assistant-speaks-first",
249	"voicemailDetection": {
250	"beepMaxAwaitSeconds": 30,
251	"provider": "google",
252	"backoffPlan": {
253	"startAtSeconds": 5,
254	"frequencySeconds": 5,
255	"maxRetries": 6
256	},
257	"type": "audio"
258	},
259	"clientMessages": "conversation-update",
260	"serverMessages": "conversation-update",
261	"maxDurationSeconds": 600,
262	"backgroundSound": "off",
263	"modelOutputInMessagesEnabled": false,
264	"transportConfigurations": [
265	{
266	"provider": "twilio",
267	"timeout": 60,
268	"record": false,
269	"recordingChannels": "mono"
270	}
271	],
272	"observabilityPlan": {
273	"provider": "langfuse",
274	"tags": [
275	"string"
276	],
277	"metadata": {}
278	},
279	"credentials": [
280	{
281	"provider": "anthropic",
282	"apiKey": "string",
283	"name": "string"
284	}
285	],
286	"hooks": [
287	{
288	"on": "call.ending",
289	"do": [
290	{
291	"type": "tool",
292	"tool": {
293	"messages": [
294	{
295	"contents": [
296	{
297	"type": "text",
298	"text": "string",
299	"language": "aa"
300	}
301	],
302	"type": "request-start",
303	"blocking": false,
304	"content": "string",
305	"conditions": [
306	{
307	"operator": "eq",
308	"param": "string",
309	"value": "string"
310	}
311	]
312	}
313	],
314	"type": "apiRequest",
315	"method": "POST",
316	"timeoutSeconds": 20,
317	"credentialId": "550e8400-e29b-41d4-a716-446655440000",
318	"name": "string",
319	"description": "string",
320	"url": "string",
321	"body": {
322	"type": "string",
323	"items": {},
324	"properties": {},
325	"description": "string",
326	"pattern": "string",
327	"format": "date-time",
328	"required": [
329	"string"
330	],
331	"enum": [
332	"string"
333	],
334	"title": "string"
335	},
336	"headers": {
337	"type": "string",
338	"items": {},
339	"properties": {},
340	"description": "string",
341	"pattern": "string",
342	"format": "date-time",
343	"required": [
344	"string"
345	],
346	"enum": [
347	"string"
348	],
349	"title": "string"
350	},
351	"backoffPlan": {
352	"type": "fixed",
353	"maxRetries": 0,
354	"baseDelaySeconds": 1,
355	"excludedStatusCodes": [
356	400,
357	401,
358	403,
359	404
360	]
361	},
362	"variableExtractionPlan": {
363	"schema": {
364	"type": "string",
365	"items": {},
366	"properties": {},
367	"description": "string",
368	"pattern": "string",
369	"format": "date-time",
370	"required": [
371	"string"
372	],
373	"enum": [
374	"string"
375	],
376	"title": "string"
377	},
378	"aliases": [
379	{
380	"key": "string",
381	"value": "string"
382	}
383	]
384	},
385	"rejectionPlan": {
386	"conditions": [
387	{
388	"type": "regex",
389	"regex": "\\\\b(cancel\|stop\|wait)\\\\b - Matches whole words",
390	"target": {
391	"role": {},
392	"position": {}
393	},
394	"negate": "true - Reject if user hasn\"t said goodbye: { regex: \"\\\\b(bye\|goodbye)\\\\b\", negate: true }"
395	}
396	]
397	}
398	},
399	"toolId": "string"
400	}
401	],
402	"filters": [
403	{
404	"type": "oneOf",
405	"key": "string",
406	"oneOf": [
407	"string"
408	]
409	}
410	]
411	}
412	],
413	"name": "string",
414	"voicemailMessage": "string",
415	"endCallMessage": "string",
416	"endCallPhrases": [
417	"string"
418	],
419	"compliancePlan": {
420	"hipaaEnabled": {
421	"hipaaEnabled": false
422	},
423	"pciEnabled": {
424	"pciEnabled": false
425	},
426	"securityFilterPlan": {
427	"enabled": false,
428	"filters": [
429	{}
430	],
431	"mode": "sanitize",
432	"replacementText": "[FILTERED]"
433	},
434	"recordingConsentPlan": {
435	"message": "For quality purposes, this call may be recorded. Please stay on the line if you agree or end the call if you do not consent.",
436	"voice": {
437	"cachingEnabled": true,
438	"provider": "azure",
439	"voiceId": "andrew",
440	"chunkPlan": {
441	"enabled": true,
442	"minCharacters": 30,
443	"punctuationBoundaries": "。",
444	"formatPlan": {
445	"enabled": true,
446	"numberToDigitsCutoff": 2025,
447	"replacements": [
448	{
449	"type": "exact",
450	"replaceAllEnabled": false,
451	"key": "string",
452	"value": "string"
453	}
454	],
455	"formattersEnabled": "markdown"
456	}
457	},
458	"speed": 1.1,
459	"fallbackPlan": {
460	"voices": [
461	{
462	"cachingEnabled": true,
463	"provider": "azure",
464	"voiceId": "andrew",
465	"speed": 1.1,
466	"chunkPlan": {
467	"enabled": true,
468	"minCharacters": 30,
469	"punctuationBoundaries": "。",
470	"formatPlan": {}
471	},
472	"oneOf": null
473	}
474	]
475	}
476	},
477	"type": "hang-up-to-decline",
478	"waitSeconds": 2
479	}
480	},
481	"metadata": {},
482	"backgroundSpeechDenoisingPlan": {
483	"smartDenoisingPlan": {
484	"enabled": false
485	},
486	"fourierDenoisingPlan": {
487	"enabled": false,
488	"mediaDetectionEnabled": true,
489	"staticThreshold": -35,
490	"baselineOffsetDb": -15,
491	"windowSizeMs": 3000,
492	"baselinePercentile": 85
493	}
494	},
495	"analysisPlan": {
496	"minMessagesThreshold": 1.1,
497	"summaryPlan": {
498	"messages": [
499	{}
500	],
501	"enabled": true,
502	"timeoutSeconds": 1.1
503	},
504	"structuredDataPlan": {
505	"messages": [
506	{}
507	],
508	"enabled": true,
509	"schema": {
510	"type": "string",
511	"items": {},
512	"properties": {},
513	"description": "string",
514	"pattern": "string",
515	"format": "date-time",
516	"required": [
517	"string"
518	],
519	"enum": [
520	"string"
521	],
522	"title": "string"
523	},
524	"timeoutSeconds": 1.1
525	},
526	"structuredDataMultiPlan": [
527	{
528	"key": "string",
529	"plan": {
530	"messages": [
531	{}
532	],
533	"enabled": true,
534	"schema": {
535	"type": "string",
536	"items": {},
537	"properties": {},
538	"description": "string",
539	"pattern": "string",
540	"format": "date-time",
541	"required": [
542	"string"
543	],
544	"enum": [
545	"string"
546	],
547	"title": "string"
548	},
549	"timeoutSeconds": 1.1
550	}
551	}
552	],
553	"successEvaluationPlan": {
554	"rubric": "NumericScale",
555	"messages": [
556	{}
557	],
558	"enabled": true,
559	"timeoutSeconds": 1.1
560	},
561	"outcomeIds": [
562	"string"
563	]
564	},
565	"artifactPlan": {
566	"recordingEnabled": true,
567	"recordingFormat": "wav;l16",
568	"recordingUseCustomStorageEnabled": true,
569	"videoRecordingEnabled": false,
570	"pcapEnabled": true,
571	"pcapS3PathPrefix": "/pcaps",
572	"pcapUseCustomStorageEnabled": true,
573	"loggingEnabled": true,
574	"loggingUseCustomStorageEnabled": true,
575	"transcriptPlan": {
576	"enabled": true,
577	"assistantName": "string",
578	"userName": "string"
579	},
580	"recordingPath": "string",
581	"structuredOutputIds": [
582	"string"
583	],
584	"loggingPath": "string"
585	},
586	"startSpeakingPlan": {
587	"waitSeconds": 0.4,
588	"smartEndpointingPlan": {
589	"provider": "vapi"
590	},
591	"customEndpointingRules": [
592	{
593	"type": "assistant",
594	"regex": "string",
595	"regexOptions": [
596	{
597	"type": "ignore-case",
598	"enabled": true
599	}
600	],
601	"timeoutSeconds": 1.1
602	}
603	],
604	"transcriptionEndpointingPlan": {
605	"onPunctuationSeconds": 0.1,
606	"onNoPunctuationSeconds": 1.5,
607	"onNumberSeconds": 0.5
608	},
609	"smartEndpointingEnabled": false
610	},
611	"stopSpeakingPlan": {
612	"numWords": 0,
613	"voiceSeconds": 0.2,
614	"backoffSeconds": 1,
615	"acknowledgementPhrases": [
616	"i understand",
617	"i see",
618	"i got it",
619	"i hear you",
620	"im listening",
621	"im with you",
622	"right",
623	"okay",
624	"ok",
625	"sure",
626	"alright",
627	"got it",
628	"understood",
629	"yeah",
630	"yes",
631	"uh-huh",
632	"mm-hmm",
633	"gotcha",
634	"mhmm",
635	"ah",
636	"yeah okay",
637	"yeah sure"
638	],
639	"interruptionPhrases": [
640	"stop",
641	"shut",
642	"up",
643	"enough",
644	"quiet",
645	"silence",
646	"but",
647	"dont",
648	"not",
649	"no",
650	"hold",
651	"wait",
652	"cut",
653	"pause",
654	"nope",
655	"nah",
656	"nevermind",
657	"never",
658	"bad",
659	"actually"
660	]
661	},
662	"monitorPlan": {
663	"listenEnabled": false,
664	"listenAuthenticationEnabled": false,
665	"controlEnabled": false,
666	"controlAuthenticationEnabled": false
667	},
668	"credentialIds": [
669	"string"
670	],
671	"server": {
672	"timeoutSeconds": 20,
673	"credentialId": "550e8400-e29b-41d4-a716-446655440000",
674	"url": "string",
675	"headers": {},
676	"backoffPlan": {
677	"type": "fixed",
678	"maxRetries": 0,
679	"baseDelaySeconds": 1,
680	"excludedStatusCodes": [
681	400,
682	401,
683	403,
684	404
685	]
686	}
687	},
688	"keypadInputPlan": {
689	"enabled": true,
690	"timeoutSeconds": 1.1,
691	"delimiters": "#"
692	}
693	}
694	]

Headers

Query parameters

Response