@vapi-ai/web 1.0.226 → 1.0.228

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.
Files changed (3) hide show
  1. package/api.ts +48 -15
  2. package/dist/api.d.ts +15 -15
  3. package/package.json +1 -1
package/api.ts CHANGED
@@ -57,10 +57,13 @@ export interface CreateAssistantDTO {
57
57
  | "jennifer-playht"
58
58
  | "melissa-playht"
59
59
  | "will-playht"
60
+ | "chris-playht"
61
+ | "matt-playht"
60
62
  | "jack-playht"
61
63
  | "ruby-playht"
62
64
  | "davis-playht"
63
65
  | "donna-playht"
66
+ | "michael-playht"
64
67
  | "burt-11labs"
65
68
  | "andrea-11labs"
66
69
  | "phillip-11labs"
@@ -82,7 +85,15 @@ export interface CreateAssistantDTO {
82
85
  | "colette-rimeai"
83
86
  | "daphne-rimeai"
84
87
  | "aurora-rimeai"
85
- | "nova-rimeai";
88
+ | "nova-rimeai"
89
+ | "apollo-beta"
90
+ | "orion-beta"
91
+ | "aurora-beta"
92
+ | "asteria-beta"
93
+ | "stella-beta"
94
+ | "artemis-beta"
95
+ | "andromeda-beta"
96
+ | "atlas-beta";
86
97
  /**
87
98
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
88
99
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -105,7 +116,7 @@ export interface CreateAssistantDTO {
105
116
  | "es-419";
106
117
  /**
107
118
  * This is the name of the assistant. This is just for your own reference.
108
- * @maxLength 40
119
+ * @maxLength 100
109
120
  */
110
121
  name?: string;
111
122
  /** This sets the objective and understanding for the assistant. */
@@ -115,7 +126,7 @@ export interface CreateAssistantDTO {
115
126
  /**
116
127
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
117
128
  *
118
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
129
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
119
130
  */
120
131
  callbackUrl?: string;
121
132
  /**
@@ -146,11 +157,11 @@ export interface CreateAssistantDTO {
146
157
  voicemailMessage?: string;
147
158
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
148
159
  interruptionsEnabled?: boolean;
149
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
160
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
150
161
  recordingEnabled?: boolean;
151
162
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
152
163
  endCallFunctionEnabled?: boolean;
153
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
164
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
154
165
  fillersEnabled?: boolean;
155
166
  }
156
167
 
@@ -325,10 +336,13 @@ export interface Assistant {
325
336
  | "jennifer-playht"
326
337
  | "melissa-playht"
327
338
  | "will-playht"
339
+ | "chris-playht"
340
+ | "matt-playht"
328
341
  | "jack-playht"
329
342
  | "ruby-playht"
330
343
  | "davis-playht"
331
344
  | "donna-playht"
345
+ | "michael-playht"
332
346
  | "burt-11labs"
333
347
  | "andrea-11labs"
334
348
  | "phillip-11labs"
@@ -350,7 +364,15 @@ export interface Assistant {
350
364
  | "colette-rimeai"
351
365
  | "daphne-rimeai"
352
366
  | "aurora-rimeai"
353
- | "nova-rimeai";
367
+ | "nova-rimeai"
368
+ | "apollo-beta"
369
+ | "orion-beta"
370
+ | "aurora-beta"
371
+ | "asteria-beta"
372
+ | "stella-beta"
373
+ | "artemis-beta"
374
+ | "andromeda-beta"
375
+ | "atlas-beta";
354
376
  /**
355
377
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
356
378
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -373,7 +395,7 @@ export interface Assistant {
373
395
  | "es-419";
374
396
  /**
375
397
  * This is the name of the assistant. This is just for your own reference.
376
- * @maxLength 40
398
+ * @maxLength 100
377
399
  */
378
400
  name?: string;
379
401
  /** This sets the objective and understanding for the assistant. */
@@ -383,7 +405,7 @@ export interface Assistant {
383
405
  /**
384
406
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
385
407
  *
386
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
408
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
387
409
  */
388
410
  callbackUrl?: string;
389
411
  /**
@@ -414,11 +436,11 @@ export interface Assistant {
414
436
  voicemailMessage?: string;
415
437
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
416
438
  interruptionsEnabled?: boolean;
417
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
439
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
418
440
  recordingEnabled?: boolean;
419
441
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
420
442
  endCallFunctionEnabled?: boolean;
421
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
443
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
422
444
  fillersEnabled?: boolean;
423
445
  /** This is the unique identifier for the assistant. */
424
446
  id: string;
@@ -450,10 +472,13 @@ export interface UpdateAssistantDTO {
450
472
  | "jennifer-playht"
451
473
  | "melissa-playht"
452
474
  | "will-playht"
475
+ | "chris-playht"
476
+ | "matt-playht"
453
477
  | "jack-playht"
454
478
  | "ruby-playht"
455
479
  | "davis-playht"
456
480
  | "donna-playht"
481
+ | "michael-playht"
457
482
  | "burt-11labs"
458
483
  | "andrea-11labs"
459
484
  | "phillip-11labs"
@@ -475,7 +500,15 @@ export interface UpdateAssistantDTO {
475
500
  | "colette-rimeai"
476
501
  | "daphne-rimeai"
477
502
  | "aurora-rimeai"
478
- | "nova-rimeai";
503
+ | "nova-rimeai"
504
+ | "apollo-beta"
505
+ | "orion-beta"
506
+ | "aurora-beta"
507
+ | "asteria-beta"
508
+ | "stella-beta"
509
+ | "artemis-beta"
510
+ | "andromeda-beta"
511
+ | "atlas-beta";
479
512
  /**
480
513
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
481
514
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -498,7 +531,7 @@ export interface UpdateAssistantDTO {
498
531
  | "es-419";
499
532
  /**
500
533
  * This is the name of the assistant. This is just for your own reference.
501
- * @maxLength 40
534
+ * @maxLength 100
502
535
  */
503
536
  name?: string;
504
537
  /** This sets the objective and understanding for the assistant. */
@@ -508,7 +541,7 @@ export interface UpdateAssistantDTO {
508
541
  /**
509
542
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
510
543
  *
511
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
544
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
512
545
  */
513
546
  callbackUrl?: string;
514
547
  /**
@@ -539,11 +572,11 @@ export interface UpdateAssistantDTO {
539
572
  voicemailMessage?: string;
540
573
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
541
574
  interruptionsEnabled?: boolean;
542
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
575
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
543
576
  recordingEnabled?: boolean;
544
577
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
545
578
  endCallFunctionEnabled?: boolean;
546
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
579
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
547
580
  fillersEnabled?: boolean;
548
581
  }
549
582
 
package/dist/api.d.ts CHANGED
@@ -39,7 +39,7 @@ export interface CreateAssistantDTO {
39
39
  *
40
40
  * Basic Voices: `*-rimeai`
41
41
  */
42
- voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
42
+ voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-beta" | "atlas-beta";
43
43
  /**
44
44
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
45
45
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -47,7 +47,7 @@ export interface CreateAssistantDTO {
47
47
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
48
48
  /**
49
49
  * This is the name of the assistant. This is just for your own reference.
50
- * @maxLength 40
50
+ * @maxLength 100
51
51
  */
52
52
  name?: string;
53
53
  /** This sets the objective and understanding for the assistant. */
@@ -57,7 +57,7 @@ export interface CreateAssistantDTO {
57
57
  /**
58
58
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
59
59
  *
60
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
60
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
61
61
  */
62
62
  callbackUrl?: string;
63
63
  /**
@@ -88,11 +88,11 @@ export interface CreateAssistantDTO {
88
88
  voicemailMessage?: string;
89
89
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
90
90
  interruptionsEnabled?: boolean;
91
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
91
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
92
92
  recordingEnabled?: boolean;
93
93
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
94
94
  endCallFunctionEnabled?: boolean;
95
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
95
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
96
96
  fillersEnabled?: boolean;
97
97
  }
98
98
  export interface CreateCustomerDTO {
@@ -257,7 +257,7 @@ export interface Assistant {
257
257
  *
258
258
  * Basic Voices: `*-rimeai`
259
259
  */
260
- voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
260
+ voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-beta" | "atlas-beta";
261
261
  /**
262
262
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
263
263
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -265,7 +265,7 @@ export interface Assistant {
265
265
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
266
266
  /**
267
267
  * This is the name of the assistant. This is just for your own reference.
268
- * @maxLength 40
268
+ * @maxLength 100
269
269
  */
270
270
  name?: string;
271
271
  /** This sets the objective and understanding for the assistant. */
@@ -275,7 +275,7 @@ export interface Assistant {
275
275
  /**
276
276
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
277
277
  *
278
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
278
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
279
279
  */
280
280
  callbackUrl?: string;
281
281
  /**
@@ -306,11 +306,11 @@ export interface Assistant {
306
306
  voicemailMessage?: string;
307
307
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
308
308
  interruptionsEnabled?: boolean;
309
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
309
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
310
310
  recordingEnabled?: boolean;
311
311
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
312
312
  endCallFunctionEnabled?: boolean;
313
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
313
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
314
314
  fillersEnabled?: boolean;
315
315
  /** This is the unique identifier for the assistant. */
316
316
  id: string;
@@ -337,7 +337,7 @@ export interface UpdateAssistantDTO {
337
337
  *
338
338
  * Basic Voices: `*-rimeai`
339
339
  */
340
- voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai";
340
+ voice?: "jennifer-playht" | "melissa-playht" | "will-playht" | "chris-playht" | "matt-playht" | "jack-playht" | "ruby-playht" | "davis-playht" | "donna-playht" | "michael-playht" | "burt-11labs" | "andrea-11labs" | "phillip-11labs" | "steve-11labs" | "joseph-11labs" | "myra-11labs" | "paula-11labs" | "ryan-11labs" | "drew-11labs" | "paul-11labs" | "mrb-11labs" | "matilda-11labs" | "kai-rimeai" | "zion-rimeai" | "xavier-rimeai" | "marty-rimeai" | "hudson-rimeai" | "savannah-rimeai" | "colette-rimeai" | "daphne-rimeai" | "aurora-rimeai" | "nova-rimeai" | "apollo-beta" | "orion-beta" | "aurora-beta" | "asteria-beta" | "stella-beta" | "artemis-beta" | "andromeda-beta" | "atlas-beta";
341
341
  /**
342
342
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
343
343
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -345,7 +345,7 @@ export interface UpdateAssistantDTO {
345
345
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
346
346
  /**
347
347
  * This is the name of the assistant. This is just for your own reference.
348
- * @maxLength 40
348
+ * @maxLength 100
349
349
  */
350
350
  name?: string;
351
351
  /** This sets the objective and understanding for the assistant. */
@@ -355,7 +355,7 @@ export interface UpdateAssistantDTO {
355
355
  /**
356
356
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
357
357
  *
358
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
358
+ * All requests will be sent with the `call` object among other things relevant to that callback. You can find more details in the Function Calling documentation.
359
359
  */
360
360
  callbackUrl?: string;
361
361
  /**
@@ -386,11 +386,11 @@ export interface UpdateAssistantDTO {
386
386
  voicemailMessage?: string;
387
387
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
388
388
  interruptionsEnabled?: boolean;
389
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
389
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
390
390
  recordingEnabled?: boolean;
391
391
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
392
392
  endCallFunctionEnabled?: boolean;
393
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
393
+ /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
394
394
  fillersEnabled?: boolean;
395
395
  }
396
396
  export interface BuyPhoneNumberDTO {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vapi-ai/web",
3
- "version": "1.0.226",
3
+ "version": "1.0.228",
4
4
  "description": "",
5
5
  "main": "dist/vapi.js",
6
6
  "types": "dist/vapi.d.ts",