@vapi-ai/web 1.0.227 → 1.0.229

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 (4) hide show
  1. package/api.ts +47 -17
  2. package/dist/api.d.ts +22 -16
  3. package/dist/api.js +2 -2
  4. 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,12 +157,14 @@ 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;
166
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
167
+ keywords?: string[];
158
168
  }
159
169
 
160
170
  export interface CreateCustomerDTO {
@@ -356,7 +366,15 @@ export interface Assistant {
356
366
  | "colette-rimeai"
357
367
  | "daphne-rimeai"
358
368
  | "aurora-rimeai"
359
- | "nova-rimeai";
369
+ | "nova-rimeai"
370
+ | "apollo-beta"
371
+ | "orion-beta"
372
+ | "aurora-beta"
373
+ | "asteria-beta"
374
+ | "stella-beta"
375
+ | "artemis-beta"
376
+ | "andromeda-beta"
377
+ | "atlas-beta";
360
378
  /**
361
379
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
362
380
  * 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 +397,7 @@ export interface Assistant {
379
397
  | "es-419";
380
398
  /**
381
399
  * This is the name of the assistant. This is just for your own reference.
382
- * @maxLength 40
400
+ * @maxLength 100
383
401
  */
384
402
  name?: string;
385
403
  /** This sets the objective and understanding for the assistant. */
@@ -389,7 +407,7 @@ export interface Assistant {
389
407
  /**
390
408
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
391
409
  *
392
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
410
+ * 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
411
  */
394
412
  callbackUrl?: string;
395
413
  /**
@@ -420,12 +438,14 @@ export interface Assistant {
420
438
  voicemailMessage?: string;
421
439
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
422
440
  interruptionsEnabled?: boolean;
423
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
441
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
424
442
  recordingEnabled?: boolean;
425
443
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
426
444
  endCallFunctionEnabled?: boolean;
427
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
445
+ /** 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
446
  fillersEnabled?: boolean;
447
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
448
+ keywords?: string[];
429
449
  /** This is the unique identifier for the assistant. */
430
450
  id: string;
431
451
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -484,7 +504,15 @@ export interface UpdateAssistantDTO {
484
504
  | "colette-rimeai"
485
505
  | "daphne-rimeai"
486
506
  | "aurora-rimeai"
487
- | "nova-rimeai";
507
+ | "nova-rimeai"
508
+ | "apollo-beta"
509
+ | "orion-beta"
510
+ | "aurora-beta"
511
+ | "asteria-beta"
512
+ | "stella-beta"
513
+ | "artemis-beta"
514
+ | "andromeda-beta"
515
+ | "atlas-beta";
488
516
  /**
489
517
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
490
518
  * 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 +535,7 @@ export interface UpdateAssistantDTO {
507
535
  | "es-419";
508
536
  /**
509
537
  * This is the name of the assistant. This is just for your own reference.
510
- * @maxLength 40
538
+ * @maxLength 100
511
539
  */
512
540
  name?: string;
513
541
  /** This sets the objective and understanding for the assistant. */
@@ -517,7 +545,7 @@ export interface UpdateAssistantDTO {
517
545
  /**
518
546
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
519
547
  *
520
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
548
+ * 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
549
  */
522
550
  callbackUrl?: string;
523
551
  /**
@@ -548,12 +576,14 @@ export interface UpdateAssistantDTO {
548
576
  voicemailMessage?: string;
549
577
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
550
578
  interruptionsEnabled?: boolean;
551
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
579
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
552
580
  recordingEnabled?: boolean;
553
581
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
554
582
  endCallFunctionEnabled?: boolean;
555
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
583
+ /** 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
584
  fillersEnabled?: boolean;
585
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
586
+ keywords?: string[];
557
587
  }
558
588
 
559
589
  export interface BuyPhoneNumberDTO {
@@ -687,7 +717,7 @@ export enum ContentType {
687
717
  }
688
718
 
689
719
  export class HttpClient<SecurityDataType = unknown> {
690
- public baseUrl: string = "https://api.vapi.ai";
720
+ public baseUrl: string = "https://hugely-stirred-krill.ngrok-free.app";
691
721
  private securityData: SecurityDataType | null = null;
692
722
  private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
693
723
  private abortControllers = new Map<CancelToken, AbortController>();
@@ -854,7 +884,7 @@ export class HttpClient<SecurityDataType = unknown> {
854
884
  /**
855
885
  * @title Vapi API
856
886
  * @version 1.0
857
- * @baseUrl https://api.vapi.ai
887
+ * @baseUrl https://hugely-stirred-krill.ngrok-free.app
858
888
  * @contact
859
889
  *
860
890
  * API for building voice assistants
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,12 +88,14 @@ 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
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
98
+ keywords?: string[];
97
99
  }
98
100
  export interface CreateCustomerDTO {
99
101
  /** This is the number of the customer. */
@@ -257,7 +259,7 @@ export interface Assistant {
257
259
  *
258
260
  * Basic Voices: `*-rimeai`
259
261
  */
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";
262
+ 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
263
  /**
262
264
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
263
265
  * 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 +267,7 @@ export interface Assistant {
265
267
  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
268
  /**
267
269
  * This is the name of the assistant. This is just for your own reference.
268
- * @maxLength 40
270
+ * @maxLength 100
269
271
  */
270
272
  name?: string;
271
273
  /** This sets the objective and understanding for the assistant. */
@@ -275,7 +277,7 @@ export interface Assistant {
275
277
  /**
276
278
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
277
279
  *
278
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
280
+ * 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
281
  */
280
282
  callbackUrl?: string;
281
283
  /**
@@ -306,12 +308,14 @@ export interface Assistant {
306
308
  voicemailMessage?: string;
307
309
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
308
310
  interruptionsEnabled?: boolean;
309
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
311
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
310
312
  recordingEnabled?: boolean;
311
313
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
312
314
  endCallFunctionEnabled?: boolean;
313
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
315
+ /** 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
316
  fillersEnabled?: boolean;
317
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
318
+ keywords?: string[];
315
319
  /** This is the unique identifier for the assistant. */
316
320
  id: string;
317
321
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -337,7 +341,7 @@ export interface UpdateAssistantDTO {
337
341
  *
338
342
  * Basic Voices: `*-rimeai`
339
343
  */
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";
344
+ 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
345
  /**
342
346
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
343
347
  * 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 +349,7 @@ export interface UpdateAssistantDTO {
345
349
  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
350
  /**
347
351
  * This is the name of the assistant. This is just for your own reference.
348
- * @maxLength 40
352
+ * @maxLength 100
349
353
  */
350
354
  name?: string;
351
355
  /** This sets the objective and understanding for the assistant. */
@@ -355,7 +359,7 @@ export interface UpdateAssistantDTO {
355
359
  /**
356
360
  * This is the URL Vapi will send GET / POST requests for retrieving context, function calling, and end-of-call reports.
357
361
  *
358
- * All requests will be sent with customerPhoneNumber and all the assistant parameters. You can find more details in the Function Calling documentation.
362
+ * 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
363
  */
360
364
  callbackUrl?: string;
361
365
  /**
@@ -386,12 +390,14 @@ export interface UpdateAssistantDTO {
386
390
  voicemailMessage?: string;
387
391
  /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
388
392
  interruptionsEnabled?: boolean;
389
- /** This sets whether calls are recorded for the assistant. Defaults to true. */
393
+ /** This sets whether the assistant's calls are recorded. Defaults to true. */
390
394
  recordingEnabled?: boolean;
391
395
  /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
392
396
  endCallFunctionEnabled?: boolean;
393
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. */
397
+ /** 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
398
  fillersEnabled?: boolean;
399
+ /** These keywords are passed to the transcription model to help it pick up use-case specific words. */
400
+ keywords?: string[];
395
401
  }
396
402
  export interface BuyPhoneNumberDTO {
397
403
  /**
@@ -536,7 +542,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
536
542
  /**
537
543
  * @title Vapi API
538
544
  * @version 1.0
539
- * @baseUrl https://api.vapi.ai
545
+ * @baseUrl https://hugely-stirred-krill.ngrok-free.app
540
546
  * @contact
541
547
  *
542
548
  * API for building voice assistants
package/dist/api.js CHANGED
@@ -40,7 +40,7 @@ var ContentType;
40
40
  })(ContentType || (exports.ContentType = ContentType = {}));
41
41
  class HttpClient {
42
42
  constructor(apiConfig = {}) {
43
- this.baseUrl = "https://api.vapi.ai";
43
+ this.baseUrl = "https://hugely-stirred-krill.ngrok-free.app";
44
44
  this.securityData = null;
45
45
  this.abortControllers = new Map();
46
46
  this.customFetch = (...fetchParams) => fetch(...fetchParams);
@@ -156,7 +156,7 @@ exports.HttpClient = HttpClient;
156
156
  /**
157
157
  * @title Vapi API
158
158
  * @version 1.0
159
- * @baseUrl https://api.vapi.ai
159
+ * @baseUrl https://hugely-stirred-krill.ngrok-free.app
160
160
  * @contact
161
161
  *
162
162
  * API for building voice assistants
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.229",
4
4
  "description": "",
5
5
  "main": "dist/vapi.js",
6
6
  "types": "dist/vapi.d.ts",