@vapi-ai/web 1.0.227 → 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 +39 -15
  2. package/dist/api.d.ts +15 -15
  3. package/package.json +1 -1
package/api.ts CHANGED
@@ -85,7 +85,15 @@ export interface CreateAssistantDTO {
85
85
  | "colette-rimeai"
86
86
  | "daphne-rimeai"
87
87
  | "aurora-rimeai"
88
- | "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";
89
97
  /**
90
98
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
91
99
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -108,7 +116,7 @@ export interface CreateAssistantDTO {
108
116
  | "es-419";
109
117
  /**
110
118
  * This is the name of the assistant. This is just for your own reference.
111
- * @maxLength 40
119
+ * @maxLength 100
112
120
  */
113
121
  name?: string;
114
122
  /** This sets the objective and understanding for the assistant. */
@@ -118,7 +126,7 @@ export interface CreateAssistantDTO {
118
126
  /**
119
127
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
120
128
  *
121
- * 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.
122
130
  */
123
131
  callbackUrl?: string;
124
132
  /**
@@ -149,11 +157,11 @@ export interface CreateAssistantDTO {
149
157
  voicemailMessage?: string;
150
158
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
151
159
  interruptionsEnabled?: boolean;
152
- /** 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. */
153
161
  recordingEnabled?: boolean;
154
162
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
155
163
  endCallFunctionEnabled?: boolean;
156
- /** 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. */
157
165
  fillersEnabled?: boolean;
158
166
  }
159
167
 
@@ -356,7 +364,15 @@ export interface Assistant {
356
364
  | "colette-rimeai"
357
365
  | "daphne-rimeai"
358
366
  | "aurora-rimeai"
359
- | "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";
360
376
  /**
361
377
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
362
378
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -379,7 +395,7 @@ export interface Assistant {
379
395
  | "es-419";
380
396
  /**
381
397
  * This is the name of the assistant. This is just for your own reference.
382
- * @maxLength 40
398
+ * @maxLength 100
383
399
  */
384
400
  name?: string;
385
401
  /** This sets the objective and understanding for the assistant. */
@@ -389,7 +405,7 @@ export interface Assistant {
389
405
  /**
390
406
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
391
407
  *
392
- * 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.
393
409
  */
394
410
  callbackUrl?: string;
395
411
  /**
@@ -420,11 +436,11 @@ export interface Assistant {
420
436
  voicemailMessage?: string;
421
437
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
422
438
  interruptionsEnabled?: boolean;
423
- /** 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. */
424
440
  recordingEnabled?: boolean;
425
441
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
426
442
  endCallFunctionEnabled?: boolean;
427
- /** 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. */
428
444
  fillersEnabled?: boolean;
429
445
  /** This is the unique identifier for the assistant. */
430
446
  id: string;
@@ -484,7 +500,15 @@ export interface UpdateAssistantDTO {
484
500
  | "colette-rimeai"
485
501
  | "daphne-rimeai"
486
502
  | "aurora-rimeai"
487
- | "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";
488
512
  /**
489
513
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
490
514
  * When using a language other than `en-*`, only `*-11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -507,7 +531,7 @@ export interface UpdateAssistantDTO {
507
531
  | "es-419";
508
532
  /**
509
533
  * This is the name of the assistant. This is just for your own reference.
510
- * @maxLength 40
534
+ * @maxLength 100
511
535
  */
512
536
  name?: string;
513
537
  /** This sets the objective and understanding for the assistant. */
@@ -517,7 +541,7 @@ export interface UpdateAssistantDTO {
517
541
  /**
518
542
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
519
543
  *
520
- * 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.
521
545
  */
522
546
  callbackUrl?: string;
523
547
  /**
@@ -548,11 +572,11 @@ export interface UpdateAssistantDTO {
548
572
  voicemailMessage?: string;
549
573
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
550
574
  interruptionsEnabled?: boolean;
551
- /** 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. */
552
576
  recordingEnabled?: boolean;
553
577
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
554
578
  endCallFunctionEnabled?: boolean;
555
- /** 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. */
556
580
  fillersEnabled?: boolean;
557
581
  }
558
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" | "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";
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" | "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";
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" | "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";
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.227",
3
+ "version": "1.0.228",
4
4
  "description": "",
5
5
  "main": "dist/vapi.js",
6
6
  "types": "dist/vapi.d.ts",