@vapi-ai/web 2.3.5 → 2.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api.ts +828 -68
- package/dist/api.d.ts +393 -58
- package/dist/api.js +2 -2
- package/dist/vapi.d.ts +2 -1
- package/dist/vapi.js +2 -1
- package/package.json +1 -1
- package/vapi.ts +4 -1
package/api.ts
CHANGED
|
@@ -41,6 +41,8 @@ export interface CostBreakdown {
|
|
|
41
41
|
tts?: number;
|
|
42
42
|
/** This is the cost of Vapi. */
|
|
43
43
|
vapi?: number;
|
|
44
|
+
/** This is the cost of chat interactions. */
|
|
45
|
+
chat?: number;
|
|
44
46
|
/** This is the total cost of the call. */
|
|
45
47
|
total?: number;
|
|
46
48
|
/** This is the LLM prompt tokens used for the call. */
|
|
@@ -262,6 +264,7 @@ export interface FallbackTranscriberPlan {
|
|
|
262
264
|
| FallbackTalkscriberTranscriber
|
|
263
265
|
| FallbackSpeechmaticsTranscriber
|
|
264
266
|
| FallbackOpenAITranscriber
|
|
267
|
+
| FallbackCartesiaTranscriber
|
|
265
268
|
)[];
|
|
266
269
|
}
|
|
267
270
|
|
|
@@ -286,6 +289,36 @@ export interface AssemblyAITranscriber {
|
|
|
286
289
|
* @example false
|
|
287
290
|
*/
|
|
288
291
|
enableUniversalStreamingApi?: boolean;
|
|
292
|
+
/**
|
|
293
|
+
* @min 0
|
|
294
|
+
* @max 1
|
|
295
|
+
* @example 0.7
|
|
296
|
+
*/
|
|
297
|
+
endOfTurnConfidenceThreshold?: number;
|
|
298
|
+
/**
|
|
299
|
+
* The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.
|
|
300
|
+
*
|
|
301
|
+
* @default 160
|
|
302
|
+
* @min 0
|
|
303
|
+
* @example 160
|
|
304
|
+
*/
|
|
305
|
+
minEndOfTurnSilenceWhenConfident?: number;
|
|
306
|
+
/**
|
|
307
|
+
* The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.
|
|
308
|
+
*
|
|
309
|
+
* @default 160
|
|
310
|
+
* @min 0
|
|
311
|
+
* @example 160
|
|
312
|
+
*/
|
|
313
|
+
wordFinalizationMaxWaitTime?: number;
|
|
314
|
+
/**
|
|
315
|
+
* The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.
|
|
316
|
+
*
|
|
317
|
+
* @default 400
|
|
318
|
+
* @min 0
|
|
319
|
+
* @example 400
|
|
320
|
+
*/
|
|
321
|
+
maxTurnSilence?: number;
|
|
289
322
|
/** The WebSocket URL that the transcriber connects to. */
|
|
290
323
|
realtimeUrl?: string;
|
|
291
324
|
/** Add up to 2500 characters of custom vocabulary. */
|
|
@@ -453,6 +486,199 @@ export interface AzureSpeechTranscriber {
|
|
|
453
486
|
fallbackPlan?: FallbackTranscriberPlan;
|
|
454
487
|
}
|
|
455
488
|
|
|
489
|
+
export interface CartesiaTranscriber {
|
|
490
|
+
provider: 'cartesia';
|
|
491
|
+
model?: 'ink-whisper';
|
|
492
|
+
language?:
|
|
493
|
+
| 'aa'
|
|
494
|
+
| 'ab'
|
|
495
|
+
| 'ae'
|
|
496
|
+
| 'af'
|
|
497
|
+
| 'ak'
|
|
498
|
+
| 'am'
|
|
499
|
+
| 'an'
|
|
500
|
+
| 'ar'
|
|
501
|
+
| 'as'
|
|
502
|
+
| 'av'
|
|
503
|
+
| 'ay'
|
|
504
|
+
| 'az'
|
|
505
|
+
| 'ba'
|
|
506
|
+
| 'be'
|
|
507
|
+
| 'bg'
|
|
508
|
+
| 'bh'
|
|
509
|
+
| 'bi'
|
|
510
|
+
| 'bm'
|
|
511
|
+
| 'bn'
|
|
512
|
+
| 'bo'
|
|
513
|
+
| 'br'
|
|
514
|
+
| 'bs'
|
|
515
|
+
| 'ca'
|
|
516
|
+
| 'ce'
|
|
517
|
+
| 'ch'
|
|
518
|
+
| 'co'
|
|
519
|
+
| 'cr'
|
|
520
|
+
| 'cs'
|
|
521
|
+
| 'cu'
|
|
522
|
+
| 'cv'
|
|
523
|
+
| 'cy'
|
|
524
|
+
| 'da'
|
|
525
|
+
| 'de'
|
|
526
|
+
| 'dv'
|
|
527
|
+
| 'dz'
|
|
528
|
+
| 'ee'
|
|
529
|
+
| 'el'
|
|
530
|
+
| 'en'
|
|
531
|
+
| 'eo'
|
|
532
|
+
| 'es'
|
|
533
|
+
| 'et'
|
|
534
|
+
| 'eu'
|
|
535
|
+
| 'fa'
|
|
536
|
+
| 'ff'
|
|
537
|
+
| 'fi'
|
|
538
|
+
| 'fj'
|
|
539
|
+
| 'fo'
|
|
540
|
+
| 'fr'
|
|
541
|
+
| 'fy'
|
|
542
|
+
| 'ga'
|
|
543
|
+
| 'gd'
|
|
544
|
+
| 'gl'
|
|
545
|
+
| 'gn'
|
|
546
|
+
| 'gu'
|
|
547
|
+
| 'gv'
|
|
548
|
+
| 'ha'
|
|
549
|
+
| 'he'
|
|
550
|
+
| 'hi'
|
|
551
|
+
| 'ho'
|
|
552
|
+
| 'hr'
|
|
553
|
+
| 'ht'
|
|
554
|
+
| 'hu'
|
|
555
|
+
| 'hy'
|
|
556
|
+
| 'hz'
|
|
557
|
+
| 'ia'
|
|
558
|
+
| 'id'
|
|
559
|
+
| 'ie'
|
|
560
|
+
| 'ig'
|
|
561
|
+
| 'ii'
|
|
562
|
+
| 'ik'
|
|
563
|
+
| 'io'
|
|
564
|
+
| 'is'
|
|
565
|
+
| 'it'
|
|
566
|
+
| 'iu'
|
|
567
|
+
| 'ja'
|
|
568
|
+
| 'jv'
|
|
569
|
+
| 'ka'
|
|
570
|
+
| 'kg'
|
|
571
|
+
| 'ki'
|
|
572
|
+
| 'kj'
|
|
573
|
+
| 'kk'
|
|
574
|
+
| 'kl'
|
|
575
|
+
| 'km'
|
|
576
|
+
| 'kn'
|
|
577
|
+
| 'ko'
|
|
578
|
+
| 'kr'
|
|
579
|
+
| 'ks'
|
|
580
|
+
| 'ku'
|
|
581
|
+
| 'kv'
|
|
582
|
+
| 'kw'
|
|
583
|
+
| 'ky'
|
|
584
|
+
| 'la'
|
|
585
|
+
| 'lb'
|
|
586
|
+
| 'lg'
|
|
587
|
+
| 'li'
|
|
588
|
+
| 'ln'
|
|
589
|
+
| 'lo'
|
|
590
|
+
| 'lt'
|
|
591
|
+
| 'lu'
|
|
592
|
+
| 'lv'
|
|
593
|
+
| 'mg'
|
|
594
|
+
| 'mh'
|
|
595
|
+
| 'mi'
|
|
596
|
+
| 'mk'
|
|
597
|
+
| 'ml'
|
|
598
|
+
| 'mn'
|
|
599
|
+
| 'mr'
|
|
600
|
+
| 'ms'
|
|
601
|
+
| 'mt'
|
|
602
|
+
| 'my'
|
|
603
|
+
| 'na'
|
|
604
|
+
| 'nb'
|
|
605
|
+
| 'nd'
|
|
606
|
+
| 'ne'
|
|
607
|
+
| 'ng'
|
|
608
|
+
| 'nl'
|
|
609
|
+
| 'nn'
|
|
610
|
+
| 'no'
|
|
611
|
+
| 'nr'
|
|
612
|
+
| 'nv'
|
|
613
|
+
| 'ny'
|
|
614
|
+
| 'oc'
|
|
615
|
+
| 'oj'
|
|
616
|
+
| 'om'
|
|
617
|
+
| 'or'
|
|
618
|
+
| 'os'
|
|
619
|
+
| 'pa'
|
|
620
|
+
| 'pi'
|
|
621
|
+
| 'pl'
|
|
622
|
+
| 'ps'
|
|
623
|
+
| 'pt'
|
|
624
|
+
| 'qu'
|
|
625
|
+
| 'rm'
|
|
626
|
+
| 'rn'
|
|
627
|
+
| 'ro'
|
|
628
|
+
| 'ru'
|
|
629
|
+
| 'rw'
|
|
630
|
+
| 'sa'
|
|
631
|
+
| 'sc'
|
|
632
|
+
| 'sd'
|
|
633
|
+
| 'se'
|
|
634
|
+
| 'sg'
|
|
635
|
+
| 'si'
|
|
636
|
+
| 'sk'
|
|
637
|
+
| 'sl'
|
|
638
|
+
| 'sm'
|
|
639
|
+
| 'sn'
|
|
640
|
+
| 'so'
|
|
641
|
+
| 'sq'
|
|
642
|
+
| 'sr'
|
|
643
|
+
| 'ss'
|
|
644
|
+
| 'st'
|
|
645
|
+
| 'su'
|
|
646
|
+
| 'sv'
|
|
647
|
+
| 'sw'
|
|
648
|
+
| 'ta'
|
|
649
|
+
| 'te'
|
|
650
|
+
| 'tg'
|
|
651
|
+
| 'th'
|
|
652
|
+
| 'ti'
|
|
653
|
+
| 'tk'
|
|
654
|
+
| 'tl'
|
|
655
|
+
| 'tn'
|
|
656
|
+
| 'to'
|
|
657
|
+
| 'tr'
|
|
658
|
+
| 'ts'
|
|
659
|
+
| 'tt'
|
|
660
|
+
| 'tw'
|
|
661
|
+
| 'ty'
|
|
662
|
+
| 'ug'
|
|
663
|
+
| 'uk'
|
|
664
|
+
| 'ur'
|
|
665
|
+
| 'uz'
|
|
666
|
+
| 've'
|
|
667
|
+
| 'vi'
|
|
668
|
+
| 'vo'
|
|
669
|
+
| 'wa'
|
|
670
|
+
| 'wo'
|
|
671
|
+
| 'xh'
|
|
672
|
+
| 'yi'
|
|
673
|
+
| 'yue'
|
|
674
|
+
| 'yo'
|
|
675
|
+
| 'za'
|
|
676
|
+
| 'zh'
|
|
677
|
+
| 'zu';
|
|
678
|
+
/** This is the plan for voice provider fallbacks in the event that the primary voice provider fails. */
|
|
679
|
+
fallbackPlan?: FallbackTranscriberPlan;
|
|
680
|
+
}
|
|
681
|
+
|
|
456
682
|
export interface BackoffPlan {
|
|
457
683
|
/**
|
|
458
684
|
* This is the type of backoff plan to use. Defaults to fixed.
|
|
@@ -1523,6 +1749,36 @@ export interface FallbackAssemblyAITranscriber {
|
|
|
1523
1749
|
* @example false
|
|
1524
1750
|
*/
|
|
1525
1751
|
enableUniversalStreamingApi?: boolean;
|
|
1752
|
+
/**
|
|
1753
|
+
* @min 0
|
|
1754
|
+
* @max 1
|
|
1755
|
+
* @example 0.7
|
|
1756
|
+
*/
|
|
1757
|
+
endOfTurnConfidenceThreshold?: number;
|
|
1758
|
+
/**
|
|
1759
|
+
* The minimum amount of silence in milliseconds required to detect end of turn when confident. Only used when `enableUniversalStreamingApi` is true.
|
|
1760
|
+
*
|
|
1761
|
+
* @default 160
|
|
1762
|
+
* @min 0
|
|
1763
|
+
* @example 160
|
|
1764
|
+
*/
|
|
1765
|
+
minEndOfTurnSilenceWhenConfident?: number;
|
|
1766
|
+
/**
|
|
1767
|
+
* The maximum wait time for word finalization. Only used when `enableUniversalStreamingApi` is true.
|
|
1768
|
+
*
|
|
1769
|
+
* @default 160
|
|
1770
|
+
* @min 0
|
|
1771
|
+
* @example 160
|
|
1772
|
+
*/
|
|
1773
|
+
wordFinalizationMaxWaitTime?: number;
|
|
1774
|
+
/**
|
|
1775
|
+
* The maximum amount of silence in milliseconds allowed in a turn before end of turn is triggered. Only used when `enableUniversalStreamingApi` is true.
|
|
1776
|
+
*
|
|
1777
|
+
* @default 400
|
|
1778
|
+
* @min 0
|
|
1779
|
+
* @example 400
|
|
1780
|
+
*/
|
|
1781
|
+
maxTurnSilence?: number;
|
|
1526
1782
|
/** The WebSocket URL that the transcriber connects to. */
|
|
1527
1783
|
realtimeUrl?: string;
|
|
1528
1784
|
/** Add up to 2500 characters of custom vocabulary. */
|
|
@@ -1686,6 +1942,197 @@ export interface FallbackAzureSpeechTranscriber {
|
|
|
1686
1942
|
| 'zu-ZA';
|
|
1687
1943
|
}
|
|
1688
1944
|
|
|
1945
|
+
export interface FallbackCartesiaTranscriber {
|
|
1946
|
+
provider: 'cartesia';
|
|
1947
|
+
model?: 'ink-whisper';
|
|
1948
|
+
language?:
|
|
1949
|
+
| 'aa'
|
|
1950
|
+
| 'ab'
|
|
1951
|
+
| 'ae'
|
|
1952
|
+
| 'af'
|
|
1953
|
+
| 'ak'
|
|
1954
|
+
| 'am'
|
|
1955
|
+
| 'an'
|
|
1956
|
+
| 'ar'
|
|
1957
|
+
| 'as'
|
|
1958
|
+
| 'av'
|
|
1959
|
+
| 'ay'
|
|
1960
|
+
| 'az'
|
|
1961
|
+
| 'ba'
|
|
1962
|
+
| 'be'
|
|
1963
|
+
| 'bg'
|
|
1964
|
+
| 'bh'
|
|
1965
|
+
| 'bi'
|
|
1966
|
+
| 'bm'
|
|
1967
|
+
| 'bn'
|
|
1968
|
+
| 'bo'
|
|
1969
|
+
| 'br'
|
|
1970
|
+
| 'bs'
|
|
1971
|
+
| 'ca'
|
|
1972
|
+
| 'ce'
|
|
1973
|
+
| 'ch'
|
|
1974
|
+
| 'co'
|
|
1975
|
+
| 'cr'
|
|
1976
|
+
| 'cs'
|
|
1977
|
+
| 'cu'
|
|
1978
|
+
| 'cv'
|
|
1979
|
+
| 'cy'
|
|
1980
|
+
| 'da'
|
|
1981
|
+
| 'de'
|
|
1982
|
+
| 'dv'
|
|
1983
|
+
| 'dz'
|
|
1984
|
+
| 'ee'
|
|
1985
|
+
| 'el'
|
|
1986
|
+
| 'en'
|
|
1987
|
+
| 'eo'
|
|
1988
|
+
| 'es'
|
|
1989
|
+
| 'et'
|
|
1990
|
+
| 'eu'
|
|
1991
|
+
| 'fa'
|
|
1992
|
+
| 'ff'
|
|
1993
|
+
| 'fi'
|
|
1994
|
+
| 'fj'
|
|
1995
|
+
| 'fo'
|
|
1996
|
+
| 'fr'
|
|
1997
|
+
| 'fy'
|
|
1998
|
+
| 'ga'
|
|
1999
|
+
| 'gd'
|
|
2000
|
+
| 'gl'
|
|
2001
|
+
| 'gn'
|
|
2002
|
+
| 'gu'
|
|
2003
|
+
| 'gv'
|
|
2004
|
+
| 'ha'
|
|
2005
|
+
| 'he'
|
|
2006
|
+
| 'hi'
|
|
2007
|
+
| 'ho'
|
|
2008
|
+
| 'hr'
|
|
2009
|
+
| 'ht'
|
|
2010
|
+
| 'hu'
|
|
2011
|
+
| 'hy'
|
|
2012
|
+
| 'hz'
|
|
2013
|
+
| 'ia'
|
|
2014
|
+
| 'id'
|
|
2015
|
+
| 'ie'
|
|
2016
|
+
| 'ig'
|
|
2017
|
+
| 'ii'
|
|
2018
|
+
| 'ik'
|
|
2019
|
+
| 'io'
|
|
2020
|
+
| 'is'
|
|
2021
|
+
| 'it'
|
|
2022
|
+
| 'iu'
|
|
2023
|
+
| 'ja'
|
|
2024
|
+
| 'jv'
|
|
2025
|
+
| 'ka'
|
|
2026
|
+
| 'kg'
|
|
2027
|
+
| 'ki'
|
|
2028
|
+
| 'kj'
|
|
2029
|
+
| 'kk'
|
|
2030
|
+
| 'kl'
|
|
2031
|
+
| 'km'
|
|
2032
|
+
| 'kn'
|
|
2033
|
+
| 'ko'
|
|
2034
|
+
| 'kr'
|
|
2035
|
+
| 'ks'
|
|
2036
|
+
| 'ku'
|
|
2037
|
+
| 'kv'
|
|
2038
|
+
| 'kw'
|
|
2039
|
+
| 'ky'
|
|
2040
|
+
| 'la'
|
|
2041
|
+
| 'lb'
|
|
2042
|
+
| 'lg'
|
|
2043
|
+
| 'li'
|
|
2044
|
+
| 'ln'
|
|
2045
|
+
| 'lo'
|
|
2046
|
+
| 'lt'
|
|
2047
|
+
| 'lu'
|
|
2048
|
+
| 'lv'
|
|
2049
|
+
| 'mg'
|
|
2050
|
+
| 'mh'
|
|
2051
|
+
| 'mi'
|
|
2052
|
+
| 'mk'
|
|
2053
|
+
| 'ml'
|
|
2054
|
+
| 'mn'
|
|
2055
|
+
| 'mr'
|
|
2056
|
+
| 'ms'
|
|
2057
|
+
| 'mt'
|
|
2058
|
+
| 'my'
|
|
2059
|
+
| 'na'
|
|
2060
|
+
| 'nb'
|
|
2061
|
+
| 'nd'
|
|
2062
|
+
| 'ne'
|
|
2063
|
+
| 'ng'
|
|
2064
|
+
| 'nl'
|
|
2065
|
+
| 'nn'
|
|
2066
|
+
| 'no'
|
|
2067
|
+
| 'nr'
|
|
2068
|
+
| 'nv'
|
|
2069
|
+
| 'ny'
|
|
2070
|
+
| 'oc'
|
|
2071
|
+
| 'oj'
|
|
2072
|
+
| 'om'
|
|
2073
|
+
| 'or'
|
|
2074
|
+
| 'os'
|
|
2075
|
+
| 'pa'
|
|
2076
|
+
| 'pi'
|
|
2077
|
+
| 'pl'
|
|
2078
|
+
| 'ps'
|
|
2079
|
+
| 'pt'
|
|
2080
|
+
| 'qu'
|
|
2081
|
+
| 'rm'
|
|
2082
|
+
| 'rn'
|
|
2083
|
+
| 'ro'
|
|
2084
|
+
| 'ru'
|
|
2085
|
+
| 'rw'
|
|
2086
|
+
| 'sa'
|
|
2087
|
+
| 'sc'
|
|
2088
|
+
| 'sd'
|
|
2089
|
+
| 'se'
|
|
2090
|
+
| 'sg'
|
|
2091
|
+
| 'si'
|
|
2092
|
+
| 'sk'
|
|
2093
|
+
| 'sl'
|
|
2094
|
+
| 'sm'
|
|
2095
|
+
| 'sn'
|
|
2096
|
+
| 'so'
|
|
2097
|
+
| 'sq'
|
|
2098
|
+
| 'sr'
|
|
2099
|
+
| 'ss'
|
|
2100
|
+
| 'st'
|
|
2101
|
+
| 'su'
|
|
2102
|
+
| 'sv'
|
|
2103
|
+
| 'sw'
|
|
2104
|
+
| 'ta'
|
|
2105
|
+
| 'te'
|
|
2106
|
+
| 'tg'
|
|
2107
|
+
| 'th'
|
|
2108
|
+
| 'ti'
|
|
2109
|
+
| 'tk'
|
|
2110
|
+
| 'tl'
|
|
2111
|
+
| 'tn'
|
|
2112
|
+
| 'to'
|
|
2113
|
+
| 'tr'
|
|
2114
|
+
| 'ts'
|
|
2115
|
+
| 'tt'
|
|
2116
|
+
| 'tw'
|
|
2117
|
+
| 'ty'
|
|
2118
|
+
| 'ug'
|
|
2119
|
+
| 'uk'
|
|
2120
|
+
| 'ur'
|
|
2121
|
+
| 'uz'
|
|
2122
|
+
| 've'
|
|
2123
|
+
| 'vi'
|
|
2124
|
+
| 'vo'
|
|
2125
|
+
| 'wa'
|
|
2126
|
+
| 'wo'
|
|
2127
|
+
| 'xh'
|
|
2128
|
+
| 'yi'
|
|
2129
|
+
| 'yue'
|
|
2130
|
+
| 'yo'
|
|
2131
|
+
| 'za'
|
|
2132
|
+
| 'zh'
|
|
2133
|
+
| 'zu';
|
|
2134
|
+
}
|
|
2135
|
+
|
|
1689
2136
|
export interface FallbackCustomTranscriber {
|
|
1690
2137
|
/** This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported. */
|
|
1691
2138
|
provider: 'custom-transcriber';
|
|
@@ -5460,7 +5907,10 @@ export interface GlobalNodePlan {
|
|
|
5460
5907
|
enterCondition?: string;
|
|
5461
5908
|
}
|
|
5462
5909
|
|
|
5463
|
-
export
|
|
5910
|
+
export interface VariableExtractionPlan {
|
|
5911
|
+
/** This is the schema of parameters we want to extract from the response */
|
|
5912
|
+
schema?: JsonSchema;
|
|
5913
|
+
}
|
|
5464
5914
|
|
|
5465
5915
|
export interface ConversationNode {
|
|
5466
5916
|
/**
|
|
@@ -5487,7 +5937,8 @@ export interface ConversationNode {
|
|
|
5487
5937
|
| GoogleTranscriber
|
|
5488
5938
|
| SpeechmaticsTranscriber
|
|
5489
5939
|
| TalkscriberTranscriber
|
|
5490
|
-
| OpenAITranscriber
|
|
5940
|
+
| OpenAITranscriber
|
|
5941
|
+
| CartesiaTranscriber;
|
|
5491
5942
|
/** These are the options for the assistant's voice. */
|
|
5492
5943
|
voice?:
|
|
5493
5944
|
| AzureVoice
|
|
@@ -5571,18 +6022,8 @@ export interface AIEdgeCondition {
|
|
|
5571
6022
|
prompt: string;
|
|
5572
6023
|
}
|
|
5573
6024
|
|
|
5574
|
-
export interface LogicEdgeCondition {
|
|
5575
|
-
type: 'logic';
|
|
5576
|
-
/** @maxLength 1000 */
|
|
5577
|
-
liquid: string;
|
|
5578
|
-
}
|
|
5579
|
-
|
|
5580
|
-
export interface FailedEdgeCondition {
|
|
5581
|
-
type: 'failed';
|
|
5582
|
-
}
|
|
5583
|
-
|
|
5584
6025
|
export interface Edge {
|
|
5585
|
-
condition?: AIEdgeCondition
|
|
6026
|
+
condition?: AIEdgeCondition;
|
|
5586
6027
|
/** @maxLength 80 */
|
|
5587
6028
|
from: string;
|
|
5588
6029
|
/** @maxLength 80 */
|
|
@@ -5593,12 +6034,22 @@ export interface Edge {
|
|
|
5593
6034
|
|
|
5594
6035
|
export interface WorkflowUserEditable {
|
|
5595
6036
|
nodes: (ConversationNode | ToolNode)[];
|
|
5596
|
-
model?: WorkflowOpenAIModel | WorkflowAnthropicModel;
|
|
5597
6037
|
/** @maxLength 80 */
|
|
5598
6038
|
name: string;
|
|
5599
6039
|
edges: Edge[];
|
|
5600
6040
|
/** @maxLength 5000 */
|
|
5601
6041
|
globalPrompt?: string;
|
|
6042
|
+
/**
|
|
6043
|
+
* This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
|
|
6044
|
+
*
|
|
6045
|
+
* The order of precedence is:
|
|
6046
|
+
*
|
|
6047
|
+
* 1. tool.server
|
|
6048
|
+
* 2. workflow.server / assistant.server
|
|
6049
|
+
* 3. phoneNumber.server
|
|
6050
|
+
* 4. org.server
|
|
6051
|
+
*/
|
|
6052
|
+
server?: Server;
|
|
5602
6053
|
}
|
|
5603
6054
|
|
|
5604
6055
|
export interface VapiModel {
|
|
@@ -7653,6 +8104,76 @@ export interface TransportConfigurationTwilio {
|
|
|
7653
8104
|
recordingChannels?: 'mono' | 'dual';
|
|
7654
8105
|
}
|
|
7655
8106
|
|
|
8107
|
+
export interface SmartDenoisingPlan {
|
|
8108
|
+
/**
|
|
8109
|
+
* Whether smart denoising using Krisp is enabled.
|
|
8110
|
+
* @default false
|
|
8111
|
+
*/
|
|
8112
|
+
enabled?: boolean;
|
|
8113
|
+
}
|
|
8114
|
+
|
|
8115
|
+
export interface FourierDenoisingPlan {
|
|
8116
|
+
/**
|
|
8117
|
+
* Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected.
|
|
8118
|
+
* @default false
|
|
8119
|
+
*/
|
|
8120
|
+
enabled?: boolean;
|
|
8121
|
+
/**
|
|
8122
|
+
* Whether automatic media detection is enabled. When enabled, the filter will automatically
|
|
8123
|
+
* detect consistent background TV/music/radio and switch to more aggressive filtering settings.
|
|
8124
|
+
* Only applies when enabled is true.
|
|
8125
|
+
* @default true
|
|
8126
|
+
* @example true
|
|
8127
|
+
*/
|
|
8128
|
+
mediaDetectionEnabled?: boolean;
|
|
8129
|
+
/**
|
|
8130
|
+
* Static threshold in dB used as fallback when no baseline is established.
|
|
8131
|
+
* @min -80
|
|
8132
|
+
* @max 0
|
|
8133
|
+
* @default -35
|
|
8134
|
+
* @example -35
|
|
8135
|
+
*/
|
|
8136
|
+
staticThreshold?: number;
|
|
8137
|
+
/**
|
|
8138
|
+
* How far below the rolling baseline to filter audio, in dB.
|
|
8139
|
+
* Lower values (e.g., -10) are more aggressive, higher values (e.g., -20) are more conservative.
|
|
8140
|
+
* @min -30
|
|
8141
|
+
* @max -5
|
|
8142
|
+
* @default -15
|
|
8143
|
+
* @example -15
|
|
8144
|
+
*/
|
|
8145
|
+
baselineOffsetDb?: number;
|
|
8146
|
+
/**
|
|
8147
|
+
* Rolling window size in milliseconds for calculating the audio baseline.
|
|
8148
|
+
* Larger windows adapt more slowly but are more stable.
|
|
8149
|
+
* @min 1000
|
|
8150
|
+
* @max 30000
|
|
8151
|
+
* @default 3000
|
|
8152
|
+
* @example 3000
|
|
8153
|
+
*/
|
|
8154
|
+
windowSizeMs?: number;
|
|
8155
|
+
/**
|
|
8156
|
+
* Percentile to use for baseline calculation (1-99).
|
|
8157
|
+
* Higher percentiles (e.g., 85) focus on louder speech, lower percentiles (e.g., 50) include quieter speech.
|
|
8158
|
+
* @min 1
|
|
8159
|
+
* @max 99
|
|
8160
|
+
* @default 85
|
|
8161
|
+
* @example 85
|
|
8162
|
+
*/
|
|
8163
|
+
baselinePercentile?: number;
|
|
8164
|
+
}
|
|
8165
|
+
|
|
8166
|
+
export interface BackgroundSpeechDenoisingPlan {
|
|
8167
|
+
/** Whether smart denoising using Krisp is enabled. */
|
|
8168
|
+
smartDenoisingPlan?: SmartDenoisingPlan;
|
|
8169
|
+
/**
|
|
8170
|
+
* Whether Fourier denoising is enabled. Note that this is experimental and may not work as expected.
|
|
8171
|
+
*
|
|
8172
|
+
* This can be combined with smart denoising, and will be run afterwards.
|
|
8173
|
+
*/
|
|
8174
|
+
fourierDenoisingPlan?: FourierDenoisingPlan;
|
|
8175
|
+
}
|
|
8176
|
+
|
|
7656
8177
|
export interface CreateAnthropicCredentialDTO {
|
|
7657
8178
|
provider: 'anthropic';
|
|
7658
8179
|
/**
|
|
@@ -7744,6 +8265,11 @@ export interface CreateAzureCredentialDTO {
|
|
|
7744
8265
|
* @maxLength 10000
|
|
7745
8266
|
*/
|
|
7746
8267
|
apiKey?: string;
|
|
8268
|
+
/**
|
|
8269
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
8270
|
+
* @min 1
|
|
8271
|
+
*/
|
|
8272
|
+
fallbackIndex?: number;
|
|
7747
8273
|
/** This is the bucket plan that can be provided to store call artifacts in Azure Blob Storage. */
|
|
7748
8274
|
bucketPlan?: AzureBlobStorageBucketPlan;
|
|
7749
8275
|
/**
|
|
@@ -7950,6 +8476,11 @@ export interface CreateCloudflareCredentialDTO {
|
|
|
7950
8476
|
apiKey?: string;
|
|
7951
8477
|
/** Cloudflare Account Email. */
|
|
7952
8478
|
accountEmail?: string;
|
|
8479
|
+
/**
|
|
8480
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
8481
|
+
* @min 1
|
|
8482
|
+
*/
|
|
8483
|
+
fallbackIndex?: number;
|
|
7953
8484
|
/** This is the bucket plan that can be provided to store call artifacts in R2 */
|
|
7954
8485
|
bucketPlan?: CloudflareR2BucketPlan;
|
|
7955
8486
|
/**
|
|
@@ -8117,6 +8648,11 @@ export interface BucketPlan {
|
|
|
8117
8648
|
|
|
8118
8649
|
export interface CreateGcpCredentialDTO {
|
|
8119
8650
|
provider: 'gcp';
|
|
8651
|
+
/**
|
|
8652
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
8653
|
+
* @min 1
|
|
8654
|
+
*/
|
|
8655
|
+
fallbackIndex?: number;
|
|
8120
8656
|
/**
|
|
8121
8657
|
* This is the GCP key. This is the JSON that can be generated in the Google Cloud Console at https://console.cloud.google.com/iam-admin/serviceaccounts/details/<service-account-id>/keys.
|
|
8122
8658
|
*
|
|
@@ -8299,6 +8835,11 @@ export interface CreateS3CredentialDTO {
|
|
|
8299
8835
|
s3BucketName: string;
|
|
8300
8836
|
/** The path prefix for the uploaded recording. Ex. "recordings/" */
|
|
8301
8837
|
s3PathPrefix: string;
|
|
8838
|
+
/**
|
|
8839
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
8840
|
+
* @min 1
|
|
8841
|
+
*/
|
|
8842
|
+
fallbackIndex?: number;
|
|
8302
8843
|
/**
|
|
8303
8844
|
* This is the name of credential. This is just for your reference.
|
|
8304
8845
|
* @minLength 1
|
|
@@ -8364,6 +8905,11 @@ export interface SupabaseBucketPlan {
|
|
|
8364
8905
|
export interface CreateSupabaseCredentialDTO {
|
|
8365
8906
|
/** This is for supabase storage. */
|
|
8366
8907
|
provider: 'supabase';
|
|
8908
|
+
/**
|
|
8909
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
8910
|
+
* @min 1
|
|
8911
|
+
*/
|
|
8912
|
+
fallbackIndex?: number;
|
|
8367
8913
|
bucketPlan?: SupabaseBucketPlan;
|
|
8368
8914
|
/**
|
|
8369
8915
|
* This is the name of credential. This is just for your reference.
|
|
@@ -9389,7 +9935,8 @@ export interface CreateAssistantDTO {
|
|
|
9389
9935
|
| GoogleTranscriber
|
|
9390
9936
|
| SpeechmaticsTranscriber
|
|
9391
9937
|
| TalkscriberTranscriber
|
|
9392
|
-
| OpenAITranscriber
|
|
9938
|
+
| OpenAITranscriber
|
|
9939
|
+
| CartesiaTranscriber;
|
|
9393
9940
|
/** These are the options for the assistant's LLM. */
|
|
9394
9941
|
model?:
|
|
9395
9942
|
| AnthropicModel
|
|
@@ -9524,14 +10071,7 @@ export interface CreateAssistantDTO {
|
|
|
9524
10071
|
* You can also provide a custom sound by providing a URL to an audio file.
|
|
9525
10072
|
*/
|
|
9526
10073
|
backgroundSound?: 'off' | 'office' | string;
|
|
9527
|
-
/**
|
|
9528
|
-
* This enables filtering of noise and background speech while the user is talking.
|
|
9529
|
-
*
|
|
9530
|
-
* Default `false` while in beta.
|
|
9531
|
-
*
|
|
9532
|
-
* @default false
|
|
9533
|
-
* @example false
|
|
9534
|
-
*/
|
|
10074
|
+
/** @example false */
|
|
9535
10075
|
backgroundDenoisingEnabled?: boolean;
|
|
9536
10076
|
/**
|
|
9537
10077
|
* This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
|
|
@@ -9728,6 +10268,20 @@ export interface CreateAssistantDTO {
|
|
|
9728
10268
|
compliancePlan?: CompliancePlan;
|
|
9729
10269
|
/** This is for metadata you want to store on the assistant. */
|
|
9730
10270
|
metadata?: object;
|
|
10271
|
+
/**
|
|
10272
|
+
* This enables filtering of noise and background speech while the user is talking.
|
|
10273
|
+
*
|
|
10274
|
+
* Features:
|
|
10275
|
+
* - Smart denoising using Krisp
|
|
10276
|
+
* - Fourier denoising
|
|
10277
|
+
*
|
|
10278
|
+
* Smart denoising can be combined with or used independently of Fourier denoising.
|
|
10279
|
+
*
|
|
10280
|
+
* Order of precedence:
|
|
10281
|
+
* - Smart denoising
|
|
10282
|
+
* - Fourier denoising
|
|
10283
|
+
*/
|
|
10284
|
+
backgroundSpeechDenoisingPlan?: BackgroundSpeechDenoisingPlan;
|
|
9731
10285
|
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
|
|
9732
10286
|
analysisPlan?: AnalysisPlan;
|
|
9733
10287
|
/**
|
|
@@ -9799,7 +10353,8 @@ export interface AssistantOverrides {
|
|
|
9799
10353
|
| GoogleTranscriber
|
|
9800
10354
|
| SpeechmaticsTranscriber
|
|
9801
10355
|
| TalkscriberTranscriber
|
|
9802
|
-
| OpenAITranscriber
|
|
10356
|
+
| OpenAITranscriber
|
|
10357
|
+
| CartesiaTranscriber;
|
|
9803
10358
|
/** These are the options for the assistant's LLM. */
|
|
9804
10359
|
model?:
|
|
9805
10360
|
| AnthropicModel
|
|
@@ -9934,14 +10489,7 @@ export interface AssistantOverrides {
|
|
|
9934
10489
|
* You can also provide a custom sound by providing a URL to an audio file.
|
|
9935
10490
|
*/
|
|
9936
10491
|
backgroundSound?: 'off' | 'office' | string;
|
|
9937
|
-
/**
|
|
9938
|
-
* This enables filtering of noise and background speech while the user is talking.
|
|
9939
|
-
*
|
|
9940
|
-
* Default `false` while in beta.
|
|
9941
|
-
*
|
|
9942
|
-
* @default false
|
|
9943
|
-
* @example false
|
|
9944
|
-
*/
|
|
10492
|
+
/** @example false */
|
|
9945
10493
|
backgroundDenoisingEnabled?: boolean;
|
|
9946
10494
|
/**
|
|
9947
10495
|
* This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
|
|
@@ -10148,6 +10696,20 @@ export interface AssistantOverrides {
|
|
|
10148
10696
|
compliancePlan?: CompliancePlan;
|
|
10149
10697
|
/** This is for metadata you want to store on the assistant. */
|
|
10150
10698
|
metadata?: object;
|
|
10699
|
+
/**
|
|
10700
|
+
* This enables filtering of noise and background speech while the user is talking.
|
|
10701
|
+
*
|
|
10702
|
+
* Features:
|
|
10703
|
+
* - Smart denoising using Krisp
|
|
10704
|
+
* - Fourier denoising
|
|
10705
|
+
*
|
|
10706
|
+
* Smart denoising can be combined with or used independently of Fourier denoising.
|
|
10707
|
+
*
|
|
10708
|
+
* Order of precedence:
|
|
10709
|
+
* - Smart denoising
|
|
10710
|
+
* - Fourier denoising
|
|
10711
|
+
*/
|
|
10712
|
+
backgroundSpeechDenoisingPlan?: BackgroundSpeechDenoisingPlan;
|
|
10151
10713
|
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
|
|
10152
10714
|
analysisPlan?: AnalysisPlan;
|
|
10153
10715
|
/**
|
|
@@ -10241,12 +10803,22 @@ export interface CreateSquadDTO {
|
|
|
10241
10803
|
|
|
10242
10804
|
export interface CreateWorkflowDTO {
|
|
10243
10805
|
nodes: (ConversationNode | ToolNode)[];
|
|
10244
|
-
model?: WorkflowOpenAIModel | WorkflowAnthropicModel;
|
|
10245
10806
|
/** @maxLength 80 */
|
|
10246
10807
|
name: string;
|
|
10247
10808
|
edges: Edge[];
|
|
10248
10809
|
/** @maxLength 5000 */
|
|
10249
10810
|
globalPrompt?: string;
|
|
10811
|
+
/**
|
|
10812
|
+
* This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
|
|
10813
|
+
*
|
|
10814
|
+
* The order of precedence is:
|
|
10815
|
+
*
|
|
10816
|
+
* 1. tool.server
|
|
10817
|
+
* 2. workflow.server / assistant.server
|
|
10818
|
+
* 3. phoneNumber.server
|
|
10819
|
+
* 4. org.server
|
|
10820
|
+
*/
|
|
10821
|
+
server?: Server;
|
|
10250
10822
|
}
|
|
10251
10823
|
|
|
10252
10824
|
export interface WorkflowOverrides {
|
|
@@ -10453,8 +11025,9 @@ export interface Call {
|
|
|
10453
11025
|
| 'assistant-request-returned-invalid-assistant'
|
|
10454
11026
|
| 'assistant-request-returned-no-assistant'
|
|
10455
11027
|
| 'assistant-request-returned-forwarding-phone-number'
|
|
10456
|
-
| 'call
|
|
10457
|
-
| 'call.start.error-get-
|
|
11028
|
+
| 'scheduled-call-deleted'
|
|
11029
|
+
| 'call.start.error-vapifault-get-org'
|
|
11030
|
+
| 'call.start.error-vapifault-get-subscription'
|
|
10458
11031
|
| 'call.start.error-get-assistant'
|
|
10459
11032
|
| 'call.start.error-get-phone-number'
|
|
10460
11033
|
| 'call.start.error-get-customer'
|
|
@@ -10462,6 +11035,11 @@ export interface Call {
|
|
|
10462
11035
|
| 'call.start.error-vapi-number-international'
|
|
10463
11036
|
| 'call.start.error-vapi-number-outbound-daily-limit'
|
|
10464
11037
|
| 'call.start.error-get-transport'
|
|
11038
|
+
| 'call.start.error-subscription-wallet-does-not-exist'
|
|
11039
|
+
| 'call.start.error-subscription-frozen'
|
|
11040
|
+
| 'call.start.error-subscription-insufficient-credits'
|
|
11041
|
+
| 'call.start.error-subscription-upgrade-failed'
|
|
11042
|
+
| 'call.start.error-subscription-concurrency-limit-reached'
|
|
10465
11043
|
| 'assistant-not-valid'
|
|
10466
11044
|
| 'database-error'
|
|
10467
11045
|
| 'assistant-not-found'
|
|
@@ -10529,7 +11107,6 @@ export interface Call {
|
|
|
10529
11107
|
| 'call.in-progress.error-vapifault-azure-speech-transcriber-failed'
|
|
10530
11108
|
| 'call.in-progress.error-pipeline-no-available-llm-model'
|
|
10531
11109
|
| 'worker-shutdown'
|
|
10532
|
-
| 'unknown-error'
|
|
10533
11110
|
| 'vonage-disconnected'
|
|
10534
11111
|
| 'vonage-failed-to-connect-call'
|
|
10535
11112
|
| 'vonage-completed'
|
|
@@ -10540,6 +11117,8 @@ export interface Call {
|
|
|
10540
11117
|
| 'call.in-progress.error-vapifault-transport-connected-but-call-not-active'
|
|
10541
11118
|
| 'call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing'
|
|
10542
11119
|
| 'call.in-progress.error-vapifault-worker-died'
|
|
11120
|
+
| 'call.in-progress.twilio-completed-call'
|
|
11121
|
+
| 'call.in-progress.sip-completed-call'
|
|
10543
11122
|
| 'call.in-progress.error-vapifault-openai-llm-failed'
|
|
10544
11123
|
| 'call.in-progress.error-vapifault-azure-openai-llm-failed'
|
|
10545
11124
|
| 'call.in-progress.error-vapifault-groq-llm-failed'
|
|
@@ -10549,6 +11128,7 @@ export interface Call {
|
|
|
10549
11128
|
| 'call.in-progress.error-vapifault-inflection-ai-llm-failed'
|
|
10550
11129
|
| 'call.in-progress.error-vapifault-cerebras-llm-failed'
|
|
10551
11130
|
| 'call.in-progress.error-vapifault-deep-seek-llm-failed'
|
|
11131
|
+
| 'call.in-progress.error-vapifault-chat-pipeline-failed-to-start'
|
|
10552
11132
|
| 'pipeline-error-openai-400-bad-request-validation-failed'
|
|
10553
11133
|
| 'pipeline-error-openai-401-unauthorized'
|
|
10554
11134
|
| 'pipeline-error-openai-401-incorrect-api-key'
|
|
@@ -10816,6 +11396,7 @@ export interface Call {
|
|
|
10816
11396
|
| 'pipeline-error-cartesia-socket-hang-up'
|
|
10817
11397
|
| 'pipeline-error-cartesia-requested-payment'
|
|
10818
11398
|
| 'pipeline-error-cartesia-500-server-error'
|
|
11399
|
+
| 'pipeline-error-cartesia-502-server-error'
|
|
10819
11400
|
| 'pipeline-error-cartesia-503-server-error'
|
|
10820
11401
|
| 'pipeline-error-cartesia-522-server-error'
|
|
10821
11402
|
| 'call.in-progress.error-vapifault-cartesia-socket-hang-up'
|
|
@@ -10836,6 +11417,7 @@ export interface Call {
|
|
|
10836
11417
|
| 'pipeline-error-eleven-labs-invalid-api-key'
|
|
10837
11418
|
| 'pipeline-error-eleven-labs-invalid-voice-samples'
|
|
10838
11419
|
| 'pipeline-error-eleven-labs-voice-disabled-by-owner'
|
|
11420
|
+
| 'pipeline-error-eleven-labs-vapi-voice-disabled-by-owner'
|
|
10839
11421
|
| 'pipeline-error-eleven-labs-blocked-account-in-probation'
|
|
10840
11422
|
| 'pipeline-error-eleven-labs-blocked-content-against-their-policy'
|
|
10841
11423
|
| 'pipeline-error-eleven-labs-missing-samples-for-voice-clone'
|
|
@@ -10844,6 +11426,7 @@ export interface Call {
|
|
|
10844
11426
|
| 'pipeline-error-eleven-labs-max-character-limit-exceeded'
|
|
10845
11427
|
| 'pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
10846
11428
|
| 'pipeline-error-eleven-labs-500-server-error'
|
|
11429
|
+
| 'pipeline-error-eleven-labs-503-server-error'
|
|
10847
11430
|
| 'call.in-progress.error-vapifault-eleven-labs-voice-not-found'
|
|
10848
11431
|
| 'call.in-progress.error-vapifault-eleven-labs-quota-exceeded'
|
|
10849
11432
|
| 'call.in-progress.error-vapifault-eleven-labs-unauthorized-access'
|
|
@@ -10865,6 +11448,7 @@ export interface Call {
|
|
|
10865
11448
|
| 'call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded'
|
|
10866
11449
|
| 'call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
10867
11450
|
| 'call.in-progress.error-providerfault-eleven-labs-500-server-error'
|
|
11451
|
+
| 'call.in-progress.error-providerfault-eleven-labs-503-server-error'
|
|
10868
11452
|
| 'pipeline-error-playht-request-timed-out'
|
|
10869
11453
|
| 'pipeline-error-playht-invalid-voice'
|
|
10870
11454
|
| 'pipeline-error-playht-unexpected-error'
|
|
@@ -10918,6 +11502,7 @@ export interface Call {
|
|
|
10918
11502
|
| 'assistant-forwarded-call'
|
|
10919
11503
|
| 'assistant-join-timed-out'
|
|
10920
11504
|
| 'call.in-progress.error-assistant-did-not-receive-customer-audio'
|
|
11505
|
+
| 'call.in-progress.error-transfer-failed'
|
|
10921
11506
|
| 'customer-busy'
|
|
10922
11507
|
| 'customer-ended-call'
|
|
10923
11508
|
| 'customer-did-not-answer'
|
|
@@ -10935,6 +11520,8 @@ export interface Call {
|
|
|
10935
11520
|
| 'call.in-progress.error-sip-outbound-call-failed-to-connect'
|
|
10936
11521
|
| 'call.ringing.hook-executed-say'
|
|
10937
11522
|
| 'call.ringing.hook-executed-transfer'
|
|
11523
|
+
| 'call.ringing.sip-inbound-caller-hungup-before-call-connect'
|
|
11524
|
+
| 'call.ringing.error-sip-inbound-call-failed-to-connect'
|
|
10938
11525
|
| 'twilio-failed-to-connect-call'
|
|
10939
11526
|
| 'twilio-reported-customer-misdialed'
|
|
10940
11527
|
| 'vonage-rejected'
|
|
@@ -11542,6 +12129,10 @@ export interface Chat {
|
|
|
11542
12129
|
* @format date-time
|
|
11543
12130
|
*/
|
|
11544
12131
|
updatedAt: string;
|
|
12132
|
+
/** These are the costs of individual components of the chat in USD. */
|
|
12133
|
+
costs?: (ModelCost | ChatCost)[];
|
|
12134
|
+
/** This is the cost of the chat in USD. */
|
|
12135
|
+
cost?: number;
|
|
11545
12136
|
}
|
|
11546
12137
|
|
|
11547
12138
|
export interface CreateChatDTO {
|
|
@@ -11995,7 +12586,8 @@ export interface Assistant {
|
|
|
11995
12586
|
| GoogleTranscriber
|
|
11996
12587
|
| SpeechmaticsTranscriber
|
|
11997
12588
|
| TalkscriberTranscriber
|
|
11998
|
-
| OpenAITranscriber
|
|
12589
|
+
| OpenAITranscriber
|
|
12590
|
+
| CartesiaTranscriber;
|
|
11999
12591
|
/** These are the options for the assistant's LLM. */
|
|
12000
12592
|
model?:
|
|
12001
12593
|
| AnthropicModel
|
|
@@ -12130,14 +12722,7 @@ export interface Assistant {
|
|
|
12130
12722
|
* You can also provide a custom sound by providing a URL to an audio file.
|
|
12131
12723
|
*/
|
|
12132
12724
|
backgroundSound?: 'off' | 'office' | string;
|
|
12133
|
-
/**
|
|
12134
|
-
* This enables filtering of noise and background speech while the user is talking.
|
|
12135
|
-
*
|
|
12136
|
-
* Default `false` while in beta.
|
|
12137
|
-
*
|
|
12138
|
-
* @default false
|
|
12139
|
-
* @example false
|
|
12140
|
-
*/
|
|
12725
|
+
/** @example false */
|
|
12141
12726
|
backgroundDenoisingEnabled?: boolean;
|
|
12142
12727
|
/**
|
|
12143
12728
|
* This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
|
|
@@ -12334,6 +12919,20 @@ export interface Assistant {
|
|
|
12334
12919
|
compliancePlan?: CompliancePlan;
|
|
12335
12920
|
/** This is for metadata you want to store on the assistant. */
|
|
12336
12921
|
metadata?: object;
|
|
12922
|
+
/**
|
|
12923
|
+
* This enables filtering of noise and background speech while the user is talking.
|
|
12924
|
+
*
|
|
12925
|
+
* Features:
|
|
12926
|
+
* - Smart denoising using Krisp
|
|
12927
|
+
* - Fourier denoising
|
|
12928
|
+
*
|
|
12929
|
+
* Smart denoising can be combined with or used independently of Fourier denoising.
|
|
12930
|
+
*
|
|
12931
|
+
* Order of precedence:
|
|
12932
|
+
* - Smart denoising
|
|
12933
|
+
* - Fourier denoising
|
|
12934
|
+
*/
|
|
12935
|
+
backgroundSpeechDenoisingPlan?: BackgroundSpeechDenoisingPlan;
|
|
12337
12936
|
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
|
|
12338
12937
|
analysisPlan?: AnalysisPlan;
|
|
12339
12938
|
/**
|
|
@@ -12430,7 +13029,8 @@ export interface UpdateAssistantDTO {
|
|
|
12430
13029
|
| GoogleTranscriber
|
|
12431
13030
|
| SpeechmaticsTranscriber
|
|
12432
13031
|
| TalkscriberTranscriber
|
|
12433
|
-
| OpenAITranscriber
|
|
13032
|
+
| OpenAITranscriber
|
|
13033
|
+
| CartesiaTranscriber;
|
|
12434
13034
|
/** These are the options for the assistant's LLM. */
|
|
12435
13035
|
model?:
|
|
12436
13036
|
| AnthropicModel
|
|
@@ -12565,14 +13165,7 @@ export interface UpdateAssistantDTO {
|
|
|
12565
13165
|
* You can also provide a custom sound by providing a URL to an audio file.
|
|
12566
13166
|
*/
|
|
12567
13167
|
backgroundSound?: 'off' | 'office' | string;
|
|
12568
|
-
/**
|
|
12569
|
-
* This enables filtering of noise and background speech while the user is talking.
|
|
12570
|
-
*
|
|
12571
|
-
* Default `false` while in beta.
|
|
12572
|
-
*
|
|
12573
|
-
* @default false
|
|
12574
|
-
* @example false
|
|
12575
|
-
*/
|
|
13168
|
+
/** @example false */
|
|
12576
13169
|
backgroundDenoisingEnabled?: boolean;
|
|
12577
13170
|
/**
|
|
12578
13171
|
* This determines whether the model's output is used in conversation history rather than the transcription of assistant's speech.
|
|
@@ -12769,6 +13362,20 @@ export interface UpdateAssistantDTO {
|
|
|
12769
13362
|
compliancePlan?: CompliancePlan;
|
|
12770
13363
|
/** This is for metadata you want to store on the assistant. */
|
|
12771
13364
|
metadata?: object;
|
|
13365
|
+
/**
|
|
13366
|
+
* This enables filtering of noise and background speech while the user is talking.
|
|
13367
|
+
*
|
|
13368
|
+
* Features:
|
|
13369
|
+
* - Smart denoising using Krisp
|
|
13370
|
+
* - Fourier denoising
|
|
13371
|
+
*
|
|
13372
|
+
* Smart denoising can be combined with or used independently of Fourier denoising.
|
|
13373
|
+
*
|
|
13374
|
+
* Order of precedence:
|
|
13375
|
+
* - Smart denoising
|
|
13376
|
+
* - Fourier denoising
|
|
13377
|
+
*/
|
|
13378
|
+
backgroundSpeechDenoisingPlan?: BackgroundSpeechDenoisingPlan;
|
|
12772
13379
|
/** This is the plan for analysis of assistant's calls. Stored in `call.analysis`. */
|
|
12773
13380
|
analysisPlan?: AnalysisPlan;
|
|
12774
13381
|
/**
|
|
@@ -14747,7 +15354,10 @@ export interface CreateApiRequestToolDTO {
|
|
|
14747
15354
|
timeoutSeconds?: number;
|
|
14748
15355
|
/**
|
|
14749
15356
|
* This is the name of the tool. This will be passed to the model.
|
|
15357
|
+
*
|
|
15358
|
+
* Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 40.
|
|
14750
15359
|
* @maxLength 40
|
|
15360
|
+
* @pattern /^[a-zA-Z0-9_-]{1,40}$/
|
|
14751
15361
|
*/
|
|
14752
15362
|
name?: string;
|
|
14753
15363
|
/**
|
|
@@ -14767,6 +15377,8 @@ export interface CreateApiRequestToolDTO {
|
|
|
14767
15377
|
* @default undefined (the request will not be retried)
|
|
14768
15378
|
*/
|
|
14769
15379
|
backoffPlan?: BackoffPlan;
|
|
15380
|
+
/** This is the plan that controls the variable extraction from the tool's response. */
|
|
15381
|
+
variableExtractionPlan?: VariableExtractionPlan;
|
|
14770
15382
|
/**
|
|
14771
15383
|
* This is the function definition of the tool.
|
|
14772
15384
|
*
|
|
@@ -15649,7 +16261,6 @@ export interface TrieveKnowledgeBaseImport {
|
|
|
15649
16261
|
|
|
15650
16262
|
export interface Workflow {
|
|
15651
16263
|
nodes: (ConversationNode | ToolNode)[];
|
|
15652
|
-
model?: WorkflowOpenAIModel | WorkflowAnthropicModel;
|
|
15653
16264
|
id: string;
|
|
15654
16265
|
orgId: string;
|
|
15655
16266
|
/** @format date-time */
|
|
@@ -15661,16 +16272,37 @@ export interface Workflow {
|
|
|
15661
16272
|
edges: Edge[];
|
|
15662
16273
|
/** @maxLength 5000 */
|
|
15663
16274
|
globalPrompt?: string;
|
|
16275
|
+
/**
|
|
16276
|
+
* This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
|
|
16277
|
+
*
|
|
16278
|
+
* The order of precedence is:
|
|
16279
|
+
*
|
|
16280
|
+
* 1. tool.server
|
|
16281
|
+
* 2. workflow.server / assistant.server
|
|
16282
|
+
* 3. phoneNumber.server
|
|
16283
|
+
* 4. org.server
|
|
16284
|
+
*/
|
|
16285
|
+
server?: Server;
|
|
15664
16286
|
}
|
|
15665
16287
|
|
|
15666
16288
|
export interface UpdateWorkflowDTO {
|
|
15667
16289
|
nodes?: (ConversationNode | ToolNode)[];
|
|
15668
|
-
model?: WorkflowOpenAIModel | WorkflowAnthropicModel;
|
|
15669
16290
|
/** @maxLength 80 */
|
|
15670
16291
|
name?: string;
|
|
15671
16292
|
edges?: Edge[];
|
|
15672
16293
|
/** @maxLength 5000 */
|
|
15673
16294
|
globalPrompt?: string;
|
|
16295
|
+
/**
|
|
16296
|
+
* This is where Vapi will send webhooks. You can find all webhooks available along with their shape in ServerMessage schema.
|
|
16297
|
+
*
|
|
16298
|
+
* The order of precedence is:
|
|
16299
|
+
*
|
|
16300
|
+
* 1. tool.server
|
|
16301
|
+
* 2. workflow.server / assistant.server
|
|
16302
|
+
* 3. phoneNumber.server
|
|
16303
|
+
* 4. org.server
|
|
16304
|
+
*/
|
|
16305
|
+
server?: Server;
|
|
15674
16306
|
}
|
|
15675
16307
|
|
|
15676
16308
|
export interface Squad {
|
|
@@ -16937,6 +17569,11 @@ export interface AzureCredential {
|
|
|
16937
17569
|
* @maxLength 10000
|
|
16938
17570
|
*/
|
|
16939
17571
|
apiKey?: string;
|
|
17572
|
+
/**
|
|
17573
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
17574
|
+
* @min 1
|
|
17575
|
+
*/
|
|
17576
|
+
fallbackIndex?: number;
|
|
16940
17577
|
/** This is the unique identifier for the credential. */
|
|
16941
17578
|
id: string;
|
|
16942
17579
|
/** This is the unique identifier for the org that this credential belongs to. */
|
|
@@ -17142,6 +17779,11 @@ export interface CloudflareCredential {
|
|
|
17142
17779
|
apiKey?: string;
|
|
17143
17780
|
/** Cloudflare Account Email. */
|
|
17144
17781
|
accountEmail?: string;
|
|
17782
|
+
/**
|
|
17783
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
17784
|
+
* @min 1
|
|
17785
|
+
*/
|
|
17786
|
+
fallbackIndex?: number;
|
|
17145
17787
|
/** This is the unique identifier for the credential. */
|
|
17146
17788
|
id: string;
|
|
17147
17789
|
/** This is the unique identifier for the org that this credential belongs to. */
|
|
@@ -17322,6 +17964,11 @@ export interface ElevenLabsCredential {
|
|
|
17322
17964
|
|
|
17323
17965
|
export interface GcpCredential {
|
|
17324
17966
|
provider: 'gcp';
|
|
17967
|
+
/**
|
|
17968
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
17969
|
+
* @min 1
|
|
17970
|
+
*/
|
|
17971
|
+
fallbackIndex?: number;
|
|
17325
17972
|
/** This is the unique identifier for the credential. */
|
|
17326
17973
|
id: string;
|
|
17327
17974
|
/** This is the unique identifier for the org that this credential belongs to. */
|
|
@@ -17830,6 +18477,11 @@ export interface S3Credential {
|
|
|
17830
18477
|
s3BucketName: string;
|
|
17831
18478
|
/** The path prefix for the uploaded recording. Ex. "recordings/" */
|
|
17832
18479
|
s3PathPrefix: string;
|
|
18480
|
+
/**
|
|
18481
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
18482
|
+
* @min 1
|
|
18483
|
+
*/
|
|
18484
|
+
fallbackIndex?: number;
|
|
17833
18485
|
/** This is the unique identifier for the credential. */
|
|
17834
18486
|
id: string;
|
|
17835
18487
|
/** This is the unique identifier for the org that this credential belongs to. */
|
|
@@ -17907,6 +18559,11 @@ export interface SpeechmaticsCredential {
|
|
|
17907
18559
|
export interface SupabaseCredential {
|
|
17908
18560
|
/** This is for supabase storage. */
|
|
17909
18561
|
provider: 'supabase';
|
|
18562
|
+
/**
|
|
18563
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
18564
|
+
* @min 1
|
|
18565
|
+
*/
|
|
18566
|
+
fallbackIndex?: number;
|
|
17910
18567
|
/** This is the unique identifier for the credential. */
|
|
17911
18568
|
id: string;
|
|
17912
18569
|
/** This is the unique identifier for the org that this credential belongs to. */
|
|
@@ -18459,6 +19116,11 @@ export interface UpdateAzureCredentialDTO {
|
|
|
18459
19116
|
* @maxLength 10000
|
|
18460
19117
|
*/
|
|
18461
19118
|
apiKey?: string;
|
|
19119
|
+
/**
|
|
19120
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
19121
|
+
* @min 1
|
|
19122
|
+
*/
|
|
19123
|
+
fallbackIndex?: number;
|
|
18462
19124
|
/**
|
|
18463
19125
|
* This is the name of credential. This is just for your reference.
|
|
18464
19126
|
* @minLength 1
|
|
@@ -18587,6 +19249,11 @@ export interface UpdateCloudflareCredentialDTO {
|
|
|
18587
19249
|
apiKey?: string;
|
|
18588
19250
|
/** Cloudflare Account Email. */
|
|
18589
19251
|
accountEmail?: string;
|
|
19252
|
+
/**
|
|
19253
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
19254
|
+
* @min 1
|
|
19255
|
+
*/
|
|
19256
|
+
fallbackIndex?: number;
|
|
18590
19257
|
/**
|
|
18591
19258
|
* This is the name of credential. This is just for your reference.
|
|
18592
19259
|
* @minLength 1
|
|
@@ -18663,6 +19330,11 @@ export interface UpdateElevenLabsCredentialDTO {
|
|
|
18663
19330
|
}
|
|
18664
19331
|
|
|
18665
19332
|
export interface UpdateGcpCredentialDTO {
|
|
19333
|
+
/**
|
|
19334
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
19335
|
+
* @min 1
|
|
19336
|
+
*/
|
|
19337
|
+
fallbackIndex?: number;
|
|
18666
19338
|
/**
|
|
18667
19339
|
* This is the name of credential. This is just for your reference.
|
|
18668
19340
|
* @minLength 1
|
|
@@ -18898,6 +19570,11 @@ export interface UpdateS3CredentialDTO {
|
|
|
18898
19570
|
s3BucketName?: string;
|
|
18899
19571
|
/** The path prefix for the uploaded recording. Ex. "recordings/" */
|
|
18900
19572
|
s3PathPrefix?: string;
|
|
19573
|
+
/**
|
|
19574
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
19575
|
+
* @min 1
|
|
19576
|
+
*/
|
|
19577
|
+
fallbackIndex?: number;
|
|
18901
19578
|
/**
|
|
18902
19579
|
* This is the name of credential. This is just for your reference.
|
|
18903
19580
|
* @minLength 1
|
|
@@ -18929,6 +19606,11 @@ export interface UpdateSpeechmaticsCredentialDTO {
|
|
|
18929
19606
|
}
|
|
18930
19607
|
|
|
18931
19608
|
export interface UpdateSupabaseCredentialDTO {
|
|
19609
|
+
/**
|
|
19610
|
+
* This is the order in which this storage provider is tried during upload retries. Lower numbers are tried first in increasing order.
|
|
19611
|
+
* @min 1
|
|
19612
|
+
*/
|
|
19613
|
+
fallbackIndex?: number;
|
|
18932
19614
|
/**
|
|
18933
19615
|
* This is the name of credential. This is just for your reference.
|
|
18934
19616
|
* @minLength 1
|
|
@@ -19836,6 +20518,8 @@ export interface ServerMessageAssistantRequest {
|
|
|
19836
20518
|
customer?: CreateCustomerDTO;
|
|
19837
20519
|
/** This is the call that the message is associated with. */
|
|
19838
20520
|
call?: Call;
|
|
20521
|
+
/** This is the chat object. */
|
|
20522
|
+
chat?: Chat;
|
|
19839
20523
|
}
|
|
19840
20524
|
|
|
19841
20525
|
export interface ServerMessageConversationUpdate {
|
|
@@ -19866,6 +20550,8 @@ export interface ServerMessageConversationUpdate {
|
|
|
19866
20550
|
customer?: CreateCustomerDTO;
|
|
19867
20551
|
/** This is the call that the message is associated with. */
|
|
19868
20552
|
call?: Call;
|
|
20553
|
+
/** This is the chat object. */
|
|
20554
|
+
chat?: Chat;
|
|
19869
20555
|
}
|
|
19870
20556
|
|
|
19871
20557
|
export interface ServerMessageEndOfCallReport {
|
|
@@ -19887,8 +20573,9 @@ export interface ServerMessageEndOfCallReport {
|
|
|
19887
20573
|
| 'assistant-request-returned-invalid-assistant'
|
|
19888
20574
|
| 'assistant-request-returned-no-assistant'
|
|
19889
20575
|
| 'assistant-request-returned-forwarding-phone-number'
|
|
19890
|
-
| 'call
|
|
19891
|
-
| 'call.start.error-get-
|
|
20576
|
+
| 'scheduled-call-deleted'
|
|
20577
|
+
| 'call.start.error-vapifault-get-org'
|
|
20578
|
+
| 'call.start.error-vapifault-get-subscription'
|
|
19892
20579
|
| 'call.start.error-get-assistant'
|
|
19893
20580
|
| 'call.start.error-get-phone-number'
|
|
19894
20581
|
| 'call.start.error-get-customer'
|
|
@@ -19896,6 +20583,11 @@ export interface ServerMessageEndOfCallReport {
|
|
|
19896
20583
|
| 'call.start.error-vapi-number-international'
|
|
19897
20584
|
| 'call.start.error-vapi-number-outbound-daily-limit'
|
|
19898
20585
|
| 'call.start.error-get-transport'
|
|
20586
|
+
| 'call.start.error-subscription-wallet-does-not-exist'
|
|
20587
|
+
| 'call.start.error-subscription-frozen'
|
|
20588
|
+
| 'call.start.error-subscription-insufficient-credits'
|
|
20589
|
+
| 'call.start.error-subscription-upgrade-failed'
|
|
20590
|
+
| 'call.start.error-subscription-concurrency-limit-reached'
|
|
19899
20591
|
| 'assistant-not-valid'
|
|
19900
20592
|
| 'database-error'
|
|
19901
20593
|
| 'assistant-not-found'
|
|
@@ -19963,7 +20655,6 @@ export interface ServerMessageEndOfCallReport {
|
|
|
19963
20655
|
| 'call.in-progress.error-vapifault-azure-speech-transcriber-failed'
|
|
19964
20656
|
| 'call.in-progress.error-pipeline-no-available-llm-model'
|
|
19965
20657
|
| 'worker-shutdown'
|
|
19966
|
-
| 'unknown-error'
|
|
19967
20658
|
| 'vonage-disconnected'
|
|
19968
20659
|
| 'vonage-failed-to-connect-call'
|
|
19969
20660
|
| 'vonage-completed'
|
|
@@ -19974,6 +20665,8 @@ export interface ServerMessageEndOfCallReport {
|
|
|
19974
20665
|
| 'call.in-progress.error-vapifault-transport-connected-but-call-not-active'
|
|
19975
20666
|
| 'call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing'
|
|
19976
20667
|
| 'call.in-progress.error-vapifault-worker-died'
|
|
20668
|
+
| 'call.in-progress.twilio-completed-call'
|
|
20669
|
+
| 'call.in-progress.sip-completed-call'
|
|
19977
20670
|
| 'call.in-progress.error-vapifault-openai-llm-failed'
|
|
19978
20671
|
| 'call.in-progress.error-vapifault-azure-openai-llm-failed'
|
|
19979
20672
|
| 'call.in-progress.error-vapifault-groq-llm-failed'
|
|
@@ -19983,6 +20676,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
19983
20676
|
| 'call.in-progress.error-vapifault-inflection-ai-llm-failed'
|
|
19984
20677
|
| 'call.in-progress.error-vapifault-cerebras-llm-failed'
|
|
19985
20678
|
| 'call.in-progress.error-vapifault-deep-seek-llm-failed'
|
|
20679
|
+
| 'call.in-progress.error-vapifault-chat-pipeline-failed-to-start'
|
|
19986
20680
|
| 'pipeline-error-openai-400-bad-request-validation-failed'
|
|
19987
20681
|
| 'pipeline-error-openai-401-unauthorized'
|
|
19988
20682
|
| 'pipeline-error-openai-401-incorrect-api-key'
|
|
@@ -20250,6 +20944,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20250
20944
|
| 'pipeline-error-cartesia-socket-hang-up'
|
|
20251
20945
|
| 'pipeline-error-cartesia-requested-payment'
|
|
20252
20946
|
| 'pipeline-error-cartesia-500-server-error'
|
|
20947
|
+
| 'pipeline-error-cartesia-502-server-error'
|
|
20253
20948
|
| 'pipeline-error-cartesia-503-server-error'
|
|
20254
20949
|
| 'pipeline-error-cartesia-522-server-error'
|
|
20255
20950
|
| 'call.in-progress.error-vapifault-cartesia-socket-hang-up'
|
|
@@ -20270,6 +20965,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20270
20965
|
| 'pipeline-error-eleven-labs-invalid-api-key'
|
|
20271
20966
|
| 'pipeline-error-eleven-labs-invalid-voice-samples'
|
|
20272
20967
|
| 'pipeline-error-eleven-labs-voice-disabled-by-owner'
|
|
20968
|
+
| 'pipeline-error-eleven-labs-vapi-voice-disabled-by-owner'
|
|
20273
20969
|
| 'pipeline-error-eleven-labs-blocked-account-in-probation'
|
|
20274
20970
|
| 'pipeline-error-eleven-labs-blocked-content-against-their-policy'
|
|
20275
20971
|
| 'pipeline-error-eleven-labs-missing-samples-for-voice-clone'
|
|
@@ -20278,6 +20974,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20278
20974
|
| 'pipeline-error-eleven-labs-max-character-limit-exceeded'
|
|
20279
20975
|
| 'pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
20280
20976
|
| 'pipeline-error-eleven-labs-500-server-error'
|
|
20977
|
+
| 'pipeline-error-eleven-labs-503-server-error'
|
|
20281
20978
|
| 'call.in-progress.error-vapifault-eleven-labs-voice-not-found'
|
|
20282
20979
|
| 'call.in-progress.error-vapifault-eleven-labs-quota-exceeded'
|
|
20283
20980
|
| 'call.in-progress.error-vapifault-eleven-labs-unauthorized-access'
|
|
@@ -20299,6 +20996,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20299
20996
|
| 'call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded'
|
|
20300
20997
|
| 'call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
20301
20998
|
| 'call.in-progress.error-providerfault-eleven-labs-500-server-error'
|
|
20999
|
+
| 'call.in-progress.error-providerfault-eleven-labs-503-server-error'
|
|
20302
21000
|
| 'pipeline-error-playht-request-timed-out'
|
|
20303
21001
|
| 'pipeline-error-playht-invalid-voice'
|
|
20304
21002
|
| 'pipeline-error-playht-unexpected-error'
|
|
@@ -20352,6 +21050,7 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20352
21050
|
| 'assistant-forwarded-call'
|
|
20353
21051
|
| 'assistant-join-timed-out'
|
|
20354
21052
|
| 'call.in-progress.error-assistant-did-not-receive-customer-audio'
|
|
21053
|
+
| 'call.in-progress.error-transfer-failed'
|
|
20355
21054
|
| 'customer-busy'
|
|
20356
21055
|
| 'customer-ended-call'
|
|
20357
21056
|
| 'customer-did-not-answer'
|
|
@@ -20369,6 +21068,8 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20369
21068
|
| 'call.in-progress.error-sip-outbound-call-failed-to-connect'
|
|
20370
21069
|
| 'call.ringing.hook-executed-say'
|
|
20371
21070
|
| 'call.ringing.hook-executed-transfer'
|
|
21071
|
+
| 'call.ringing.sip-inbound-caller-hungup-before-call-connect'
|
|
21072
|
+
| 'call.ringing.error-sip-inbound-call-failed-to-connect'
|
|
20372
21073
|
| 'twilio-failed-to-connect-call'
|
|
20373
21074
|
| 'twilio-reported-customer-misdialed'
|
|
20374
21075
|
| 'vonage-rejected'
|
|
@@ -20396,6 +21097,8 @@ export interface ServerMessageEndOfCallReport {
|
|
|
20396
21097
|
customer?: CreateCustomerDTO;
|
|
20397
21098
|
/** This is the call that the message is associated with. */
|
|
20398
21099
|
call?: Call;
|
|
21100
|
+
/** This is the chat object. */
|
|
21101
|
+
chat?: Chat;
|
|
20399
21102
|
/** This is the analysis of the call. This can also be found at `call.analysis` on GET /call/:id. */
|
|
20400
21103
|
analysis: Analysis;
|
|
20401
21104
|
/**
|
|
@@ -20440,6 +21143,8 @@ export interface ServerMessageHang {
|
|
|
20440
21143
|
customer?: CreateCustomerDTO;
|
|
20441
21144
|
/** This is the call that the message is associated with. */
|
|
20442
21145
|
call?: Call;
|
|
21146
|
+
/** This is the chat object. */
|
|
21147
|
+
chat?: Chat;
|
|
20443
21148
|
}
|
|
20444
21149
|
|
|
20445
21150
|
export interface ServerMessageKnowledgeBaseRequest {
|
|
@@ -20470,6 +21175,8 @@ export interface ServerMessageKnowledgeBaseRequest {
|
|
|
20470
21175
|
customer?: CreateCustomerDTO;
|
|
20471
21176
|
/** This is the call that the message is associated with. */
|
|
20472
21177
|
call?: Call;
|
|
21178
|
+
/** This is the chat object. */
|
|
21179
|
+
chat?: Chat;
|
|
20473
21180
|
}
|
|
20474
21181
|
|
|
20475
21182
|
export interface ServerMessageModelOutput {
|
|
@@ -20496,6 +21203,8 @@ export interface ServerMessageModelOutput {
|
|
|
20496
21203
|
customer?: CreateCustomerDTO;
|
|
20497
21204
|
/** This is the call that the message is associated with. */
|
|
20498
21205
|
call?: Call;
|
|
21206
|
+
/** This is the chat object. */
|
|
21207
|
+
chat?: Chat;
|
|
20499
21208
|
/** This is the output of the model. It can be a token or tool call. */
|
|
20500
21209
|
output: object;
|
|
20501
21210
|
}
|
|
@@ -20532,6 +21241,8 @@ export interface ServerMessagePhoneCallControl {
|
|
|
20532
21241
|
customer?: CreateCustomerDTO;
|
|
20533
21242
|
/** This is the call that the message is associated with. */
|
|
20534
21243
|
call?: Call;
|
|
21244
|
+
/** This is the chat object. */
|
|
21245
|
+
chat?: Chat;
|
|
20535
21246
|
}
|
|
20536
21247
|
|
|
20537
21248
|
export interface ServerMessageSpeechUpdate {
|
|
@@ -20564,6 +21275,8 @@ export interface ServerMessageSpeechUpdate {
|
|
|
20564
21275
|
customer?: CreateCustomerDTO;
|
|
20565
21276
|
/** This is the call that the message is associated with. */
|
|
20566
21277
|
call?: Call;
|
|
21278
|
+
/** This is the chat object. */
|
|
21279
|
+
chat?: Chat;
|
|
20567
21280
|
}
|
|
20568
21281
|
|
|
20569
21282
|
export interface ServerMessageStatusUpdate {
|
|
@@ -20587,8 +21300,9 @@ export interface ServerMessageStatusUpdate {
|
|
|
20587
21300
|
| 'assistant-request-returned-invalid-assistant'
|
|
20588
21301
|
| 'assistant-request-returned-no-assistant'
|
|
20589
21302
|
| 'assistant-request-returned-forwarding-phone-number'
|
|
20590
|
-
| 'call
|
|
20591
|
-
| 'call.start.error-get-
|
|
21303
|
+
| 'scheduled-call-deleted'
|
|
21304
|
+
| 'call.start.error-vapifault-get-org'
|
|
21305
|
+
| 'call.start.error-vapifault-get-subscription'
|
|
20592
21306
|
| 'call.start.error-get-assistant'
|
|
20593
21307
|
| 'call.start.error-get-phone-number'
|
|
20594
21308
|
| 'call.start.error-get-customer'
|
|
@@ -20596,6 +21310,11 @@ export interface ServerMessageStatusUpdate {
|
|
|
20596
21310
|
| 'call.start.error-vapi-number-international'
|
|
20597
21311
|
| 'call.start.error-vapi-number-outbound-daily-limit'
|
|
20598
21312
|
| 'call.start.error-get-transport'
|
|
21313
|
+
| 'call.start.error-subscription-wallet-does-not-exist'
|
|
21314
|
+
| 'call.start.error-subscription-frozen'
|
|
21315
|
+
| 'call.start.error-subscription-insufficient-credits'
|
|
21316
|
+
| 'call.start.error-subscription-upgrade-failed'
|
|
21317
|
+
| 'call.start.error-subscription-concurrency-limit-reached'
|
|
20599
21318
|
| 'assistant-not-valid'
|
|
20600
21319
|
| 'database-error'
|
|
20601
21320
|
| 'assistant-not-found'
|
|
@@ -20663,7 +21382,6 @@ export interface ServerMessageStatusUpdate {
|
|
|
20663
21382
|
| 'call.in-progress.error-vapifault-azure-speech-transcriber-failed'
|
|
20664
21383
|
| 'call.in-progress.error-pipeline-no-available-llm-model'
|
|
20665
21384
|
| 'worker-shutdown'
|
|
20666
|
-
| 'unknown-error'
|
|
20667
21385
|
| 'vonage-disconnected'
|
|
20668
21386
|
| 'vonage-failed-to-connect-call'
|
|
20669
21387
|
| 'vonage-completed'
|
|
@@ -20674,6 +21392,8 @@ export interface ServerMessageStatusUpdate {
|
|
|
20674
21392
|
| 'call.in-progress.error-vapifault-transport-connected-but-call-not-active'
|
|
20675
21393
|
| 'call.in-progress.error-vapifault-call-started-but-connection-to-transport-missing'
|
|
20676
21394
|
| 'call.in-progress.error-vapifault-worker-died'
|
|
21395
|
+
| 'call.in-progress.twilio-completed-call'
|
|
21396
|
+
| 'call.in-progress.sip-completed-call'
|
|
20677
21397
|
| 'call.in-progress.error-vapifault-openai-llm-failed'
|
|
20678
21398
|
| 'call.in-progress.error-vapifault-azure-openai-llm-failed'
|
|
20679
21399
|
| 'call.in-progress.error-vapifault-groq-llm-failed'
|
|
@@ -20683,6 +21403,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
20683
21403
|
| 'call.in-progress.error-vapifault-inflection-ai-llm-failed'
|
|
20684
21404
|
| 'call.in-progress.error-vapifault-cerebras-llm-failed'
|
|
20685
21405
|
| 'call.in-progress.error-vapifault-deep-seek-llm-failed'
|
|
21406
|
+
| 'call.in-progress.error-vapifault-chat-pipeline-failed-to-start'
|
|
20686
21407
|
| 'pipeline-error-openai-400-bad-request-validation-failed'
|
|
20687
21408
|
| 'pipeline-error-openai-401-unauthorized'
|
|
20688
21409
|
| 'pipeline-error-openai-401-incorrect-api-key'
|
|
@@ -20950,6 +21671,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
20950
21671
|
| 'pipeline-error-cartesia-socket-hang-up'
|
|
20951
21672
|
| 'pipeline-error-cartesia-requested-payment'
|
|
20952
21673
|
| 'pipeline-error-cartesia-500-server-error'
|
|
21674
|
+
| 'pipeline-error-cartesia-502-server-error'
|
|
20953
21675
|
| 'pipeline-error-cartesia-503-server-error'
|
|
20954
21676
|
| 'pipeline-error-cartesia-522-server-error'
|
|
20955
21677
|
| 'call.in-progress.error-vapifault-cartesia-socket-hang-up'
|
|
@@ -20970,6 +21692,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
20970
21692
|
| 'pipeline-error-eleven-labs-invalid-api-key'
|
|
20971
21693
|
| 'pipeline-error-eleven-labs-invalid-voice-samples'
|
|
20972
21694
|
| 'pipeline-error-eleven-labs-voice-disabled-by-owner'
|
|
21695
|
+
| 'pipeline-error-eleven-labs-vapi-voice-disabled-by-owner'
|
|
20973
21696
|
| 'pipeline-error-eleven-labs-blocked-account-in-probation'
|
|
20974
21697
|
| 'pipeline-error-eleven-labs-blocked-content-against-their-policy'
|
|
20975
21698
|
| 'pipeline-error-eleven-labs-missing-samples-for-voice-clone'
|
|
@@ -20978,6 +21701,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
20978
21701
|
| 'pipeline-error-eleven-labs-max-character-limit-exceeded'
|
|
20979
21702
|
| 'pipeline-error-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
20980
21703
|
| 'pipeline-error-eleven-labs-500-server-error'
|
|
21704
|
+
| 'pipeline-error-eleven-labs-503-server-error'
|
|
20981
21705
|
| 'call.in-progress.error-vapifault-eleven-labs-voice-not-found'
|
|
20982
21706
|
| 'call.in-progress.error-vapifault-eleven-labs-quota-exceeded'
|
|
20983
21707
|
| 'call.in-progress.error-vapifault-eleven-labs-unauthorized-access'
|
|
@@ -20999,6 +21723,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
20999
21723
|
| 'call.in-progress.error-vapifault-eleven-labs-max-character-limit-exceeded'
|
|
21000
21724
|
| 'call.in-progress.error-vapifault-eleven-labs-blocked-voice-potentially-against-terms-of-service-and-awaiting-verification'
|
|
21001
21725
|
| 'call.in-progress.error-providerfault-eleven-labs-500-server-error'
|
|
21726
|
+
| 'call.in-progress.error-providerfault-eleven-labs-503-server-error'
|
|
21002
21727
|
| 'pipeline-error-playht-request-timed-out'
|
|
21003
21728
|
| 'pipeline-error-playht-invalid-voice'
|
|
21004
21729
|
| 'pipeline-error-playht-unexpected-error'
|
|
@@ -21052,6 +21777,7 @@ export interface ServerMessageStatusUpdate {
|
|
|
21052
21777
|
| 'assistant-forwarded-call'
|
|
21053
21778
|
| 'assistant-join-timed-out'
|
|
21054
21779
|
| 'call.in-progress.error-assistant-did-not-receive-customer-audio'
|
|
21780
|
+
| 'call.in-progress.error-transfer-failed'
|
|
21055
21781
|
| 'customer-busy'
|
|
21056
21782
|
| 'customer-ended-call'
|
|
21057
21783
|
| 'customer-did-not-answer'
|
|
@@ -21069,6 +21795,8 @@ export interface ServerMessageStatusUpdate {
|
|
|
21069
21795
|
| 'call.in-progress.error-sip-outbound-call-failed-to-connect'
|
|
21070
21796
|
| 'call.ringing.hook-executed-say'
|
|
21071
21797
|
| 'call.ringing.hook-executed-transfer'
|
|
21798
|
+
| 'call.ringing.sip-inbound-caller-hungup-before-call-connect'
|
|
21799
|
+
| 'call.ringing.error-sip-inbound-call-failed-to-connect'
|
|
21072
21800
|
| 'twilio-failed-to-connect-call'
|
|
21073
21801
|
| 'twilio-reported-customer-misdialed'
|
|
21074
21802
|
| 'vonage-rejected'
|
|
@@ -21093,6 +21821,8 @@ export interface ServerMessageStatusUpdate {
|
|
|
21093
21821
|
customer?: CreateCustomerDTO;
|
|
21094
21822
|
/** This is the call that the message is associated with. */
|
|
21095
21823
|
call?: Call;
|
|
21824
|
+
/** This is the chat object. */
|
|
21825
|
+
chat?: Chat;
|
|
21096
21826
|
/** This is the transcript of the call. This is only sent if the status is "forwarding". */
|
|
21097
21827
|
transcript?: string;
|
|
21098
21828
|
/** This is the summary of the call. This is only sent if the status is "forwarding". */
|
|
@@ -21139,6 +21869,8 @@ export interface ServerMessageToolCalls {
|
|
|
21139
21869
|
customer?: CreateCustomerDTO;
|
|
21140
21870
|
/** This is the call that the message is associated with. */
|
|
21141
21871
|
call?: Call;
|
|
21872
|
+
/** This is the chat object. */
|
|
21873
|
+
chat?: Chat;
|
|
21142
21874
|
/** This is the list of tool calls that the model is requesting. */
|
|
21143
21875
|
toolCallList: ToolCall[];
|
|
21144
21876
|
}
|
|
@@ -21167,6 +21899,8 @@ export interface ServerMessageTransferDestinationRequest {
|
|
|
21167
21899
|
customer?: CreateCustomerDTO;
|
|
21168
21900
|
/** This is the call that the message is associated with. */
|
|
21169
21901
|
call?: Call;
|
|
21902
|
+
/** This is the chat object. */
|
|
21903
|
+
chat?: Chat;
|
|
21170
21904
|
}
|
|
21171
21905
|
|
|
21172
21906
|
export interface ServerMessageTransferUpdate {
|
|
@@ -21195,6 +21929,8 @@ export interface ServerMessageTransferUpdate {
|
|
|
21195
21929
|
customer?: CreateCustomerDTO;
|
|
21196
21930
|
/** This is the call that the message is associated with. */
|
|
21197
21931
|
call?: Call;
|
|
21932
|
+
/** This is the chat object. */
|
|
21933
|
+
chat?: Chat;
|
|
21198
21934
|
/** This is the assistant that the call is being transferred to. This is only sent if `destination.type` is "assistant". */
|
|
21199
21935
|
toAssistant?: CreateAssistantDTO;
|
|
21200
21936
|
/** This is the assistant that the call is being transferred from. This is only sent if `destination.type` is "assistant". */
|
|
@@ -21229,6 +21965,8 @@ export interface ServerMessageTranscript {
|
|
|
21229
21965
|
customer?: CreateCustomerDTO;
|
|
21230
21966
|
/** This is the call that the message is associated with. */
|
|
21231
21967
|
call?: Call;
|
|
21968
|
+
/** This is the chat object. */
|
|
21969
|
+
chat?: Chat;
|
|
21232
21970
|
/** This is the role for which the transcript is for. */
|
|
21233
21971
|
role: 'assistant' | 'user';
|
|
21234
21972
|
/** This is the type of the transcript. */
|
|
@@ -21261,6 +21999,8 @@ export interface ServerMessageUserInterrupted {
|
|
|
21261
21999
|
customer?: CreateCustomerDTO;
|
|
21262
22000
|
/** This is the call that the message is associated with. */
|
|
21263
22001
|
call?: Call;
|
|
22002
|
+
/** This is the chat object. */
|
|
22003
|
+
chat?: Chat;
|
|
21264
22004
|
}
|
|
21265
22005
|
|
|
21266
22006
|
export interface ServerMessageLanguageChangeDetected {
|
|
@@ -21287,6 +22027,8 @@ export interface ServerMessageLanguageChangeDetected {
|
|
|
21287
22027
|
customer?: CreateCustomerDTO;
|
|
21288
22028
|
/** This is the call that the message is associated with. */
|
|
21289
22029
|
call?: Call;
|
|
22030
|
+
/** This is the chat object. */
|
|
22031
|
+
chat?: Chat;
|
|
21290
22032
|
/** This is the language the transcriber is switched to. */
|
|
21291
22033
|
language: string;
|
|
21292
22034
|
}
|
|
@@ -21315,6 +22057,8 @@ export interface ServerMessageVoiceInput {
|
|
|
21315
22057
|
customer?: CreateCustomerDTO;
|
|
21316
22058
|
/** This is the call that the message is associated with. */
|
|
21317
22059
|
call?: Call;
|
|
22060
|
+
/** This is the chat object. */
|
|
22061
|
+
chat?: Chat;
|
|
21318
22062
|
/** This is the voice input content */
|
|
21319
22063
|
input: string;
|
|
21320
22064
|
}
|
|
@@ -21366,6 +22110,8 @@ export interface ServerMessageVoiceRequest {
|
|
|
21366
22110
|
customer?: CreateCustomerDTO;
|
|
21367
22111
|
/** This is the call that the message is associated with. */
|
|
21368
22112
|
call?: Call;
|
|
22113
|
+
/** This is the chat object. */
|
|
22114
|
+
chat?: Chat;
|
|
21369
22115
|
/** This is the text to be synthesized. */
|
|
21370
22116
|
text: string;
|
|
21371
22117
|
/** This is the sample rate to be synthesized. */
|
|
@@ -21616,11 +22362,18 @@ export interface ClientInboundMessageControl {
|
|
|
21616
22362
|
export interface ClientInboundMessageSay {
|
|
21617
22363
|
/** This is the type of the message. Send "say" message to make the assistant say something. */
|
|
21618
22364
|
type?: 'say';
|
|
22365
|
+
/**
|
|
22366
|
+
* This is the flag for whether the message should replace existing assistant speech.
|
|
22367
|
+
*
|
|
22368
|
+
* @default false
|
|
22369
|
+
* @default false
|
|
22370
|
+
*/
|
|
22371
|
+
interruptAssistantEnabled?: boolean;
|
|
21619
22372
|
/** This is the content to say. */
|
|
21620
22373
|
content?: string;
|
|
21621
22374
|
/** This is the flag to end call after content is spoken. */
|
|
21622
22375
|
endCallAfterSpoken?: boolean;
|
|
21623
|
-
/** This is the flag for whether the message is interruptible. */
|
|
22376
|
+
/** This is the flag for whether the message is interruptible by the user. */
|
|
21624
22377
|
interruptionsEnabled?: boolean;
|
|
21625
22378
|
}
|
|
21626
22379
|
|
|
@@ -21828,6 +22581,13 @@ export interface KnowledgeBaseCost {
|
|
|
21828
22581
|
cost: number;
|
|
21829
22582
|
}
|
|
21830
22583
|
|
|
22584
|
+
export interface ChatCost {
|
|
22585
|
+
/** This is the type of cost, always 'chat' for this class. */
|
|
22586
|
+
type: 'chat';
|
|
22587
|
+
/** This is the cost of the component in USD. */
|
|
22588
|
+
cost: number;
|
|
22589
|
+
}
|
|
22590
|
+
|
|
21831
22591
|
export interface FunctionToolWithToolCall {
|
|
21832
22592
|
/**
|
|
21833
22593
|
* These are the messages that will be spoken to the user as the tool is running.
|
|
@@ -27436,12 +28196,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
27436
28196
|
* No description
|
|
27437
28197
|
*
|
|
27438
28198
|
* @tags Credentials
|
|
27439
|
-
* @name
|
|
28199
|
+
* @name CredentialControllerCredentialActionTrigger
|
|
27440
28200
|
* @summary Trigger a credential action
|
|
27441
28201
|
* @request POST:/credential/trigger
|
|
27442
28202
|
* @secure
|
|
27443
28203
|
*/
|
|
27444
|
-
|
|
28204
|
+
credentialControllerCredentialActionTrigger: (
|
|
27445
28205
|
data: CredentialActionRequest,
|
|
27446
28206
|
params: RequestParams = {},
|
|
27447
28207
|
) =>
|
|
@@ -27849,7 +28609,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
27849
28609
|
},
|
|
27850
28610
|
params: RequestParams = {},
|
|
27851
28611
|
) =>
|
|
27852
|
-
this.request<
|
|
28612
|
+
this.request<SbcConfiguration, any>({
|
|
27853
28613
|
path: `/${provider}/workflows`,
|
|
27854
28614
|
method: 'GET',
|
|
27855
28615
|
query: query,
|
|
@@ -27871,7 +28631,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
27871
28631
|
workflowId: string,
|
|
27872
28632
|
params: RequestParams = {},
|
|
27873
28633
|
) =>
|
|
27874
|
-
this.request<
|
|
28634
|
+
this.request<SbcConfiguration, any>({
|
|
27875
28635
|
path: `/${provider}/workflows/${workflowId}/hooks`,
|
|
27876
28636
|
method: 'GET',
|
|
27877
28637
|
secure: true,
|
|
@@ -27888,7 +28648,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
|
|
|
27888
28648
|
* @secure
|
|
27889
28649
|
*/
|
|
27890
28650
|
providerControllerGetLocations: (provider: 'make' | 'ghl', params: RequestParams = {}) =>
|
|
27891
|
-
this.request<
|
|
28651
|
+
this.request<SbcConfiguration, any>({
|
|
27892
28652
|
path: `/${provider}/locations`,
|
|
27893
28653
|
method: 'GET',
|
|
27894
28654
|
secure: true,
|