@vapi-ai/web 1.0.235 → 1.0.237

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 CHANGED
@@ -9,15 +9,15 @@
9
9
  * ---------------------------------------------------------------
10
10
  */
11
11
 
12
- export interface BetaVoice {
12
+ export interface DeepgramVoice {
13
13
  /**
14
14
  * This is the voice provider that will be used.
15
15
  *
16
- * Pro Voices: `11labs`, `playht`
16
+ * Pro Voices: `11labs`, `playht`, `openai`
17
17
  *
18
- * Basic Voices: `rimeai`, `beta`
18
+ * Basic Voices: `rimeai`, `deepgram`
19
19
  */
20
- provider: "beta";
20
+ provider: "deepgram";
21
21
  /** This is the provider-specific ID that will be used. */
22
22
  voiceId: string;
23
23
  }
@@ -63,9 +63,17 @@ export interface ElevenLabsVoice {
63
63
  *
64
64
  * Pro Voices: `11labs`, `playht`
65
65
  *
66
- * Basic Voices: `rimeai`, `beta`
66
+ * Basic Voices: `rimeai`, `deepgram`
67
67
  */
68
68
  provider: "11labs";
69
+ /** Defines the stability for voice settings. */
70
+ stability?: number;
71
+ /** Defines the similarity boost for voice settings. */
72
+ similarityBoost?: number;
73
+ /** Defines the style for voice settings. */
74
+ style?: boolean;
75
+ /** Defines the use speaker boost for voice settings. */
76
+ useSpeakerBoost?: boolean;
69
77
  /** This is the provider-specific ID that will be used. */
70
78
  voiceId: string;
71
79
  }
@@ -129,11 +137,43 @@ export interface PlayHTVoice {
129
137
  /**
130
138
  * This is the voice provider that will be used.
131
139
  *
132
- * Pro Voices: `11labs`, `playht`
140
+ * Pro Voices: `11labs`, `playht`, `openai`
133
141
  *
134
- * Basic Voices: `rimeai`, `beta`
142
+ * Basic Voices: `rimeai`, `deepgram`
135
143
  */
136
144
  provider: "playht";
145
+ /**
146
+ * This is the speed multiplier that will be used.
147
+ * @min 0
148
+ * @max 5
149
+ */
150
+ speed?: number;
151
+ /**
152
+ * A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.
153
+ * @min 0.1
154
+ * @max 2
155
+ */
156
+ temperature?: number;
157
+ /** An emotion to be applied to the speech. */
158
+ emotion?: "female_happy" | "female_sad" | "female_angry" | "female_fearful" | "female_disgust" | "female_surprised";
159
+ /**
160
+ * A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
161
+ * @min 1
162
+ * @max 6
163
+ */
164
+ voiceGuidance?: number;
165
+ /**
166
+ * A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
167
+ * @min 1
168
+ * @max 30
169
+ */
170
+ styleGuidance?: number;
171
+ /**
172
+ * A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.
173
+ * @min 1
174
+ * @max 2
175
+ */
176
+ textGuidance?: number;
137
177
  /** This is the provider-specific ID that will be used. */
138
178
  voiceId: string;
139
179
  }
@@ -142,11 +182,35 @@ export interface RimeAIVoice {
142
182
  /**
143
183
  * This is the voice provider that will be used.
144
184
  *
145
- * Pro Voices: `11labs`, `playht`
185
+ * Pro Voices: `11labs`, `playht`, `openai`
146
186
  *
147
- * Basic Voices: `rimeai`, `beta`
187
+ * Basic Voices: `rimeai`, `deepgram`
148
188
  */
149
189
  provider: "rimeai";
190
+ /**
191
+ * This is the speed multiplier that will be used.
192
+ * @min 0
193
+ */
194
+ speed?: number;
195
+ /** This is the provider-specific ID that will be used. */
196
+ voiceId: string;
197
+ }
198
+
199
+ export interface OpenAIVoice {
200
+ /**
201
+ * This is the voice provider that will be used.
202
+ *
203
+ * Pro Voices: `11labs`, `playht`, `openai`
204
+ *
205
+ * Basic Voices: `rimeai`, `deepgram`
206
+ */
207
+ provider: "openai";
208
+ /**
209
+ * This is the speed multiplier that will be used.
210
+ * @min 0.25
211
+ * @max 4
212
+ */
213
+ speed?: number;
150
214
  /** This is the provider-specific ID that will be used. */
151
215
  voiceId: string;
152
216
  }
@@ -160,7 +224,7 @@ export interface CreateAssistantDTO {
160
224
  /** These are the options for the assistant's transcriber. */
161
225
  transcriber?: DeepgramTranscriber;
162
226
  /** These are the options for the assistant's LLM. */
163
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
227
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
164
228
  /**
165
229
  * These are the options for the assistant's voice.
166
230
  * @default "jennifer-playht"
@@ -198,18 +262,24 @@ export interface CreateAssistantDTO {
198
262
  | "daphne-rimeai"
199
263
  | "aurora-rimeai"
200
264
  | "nova-rimeai"
201
- | "apollo-beta"
202
- | "orion-beta"
203
- | "aurora-beta"
204
- | "asteria-beta"
205
- | "stella-beta"
206
- | "artemis-beta"
207
- | "andromeda-beta"
208
- | "atlas-beta"
265
+ | "aurora-deepgram"
266
+ | "asteria-deepgram"
267
+ | "artemis-deepgram"
268
+ | "andromeda-deepgram"
269
+ | "stella-deepgram"
270
+ | "orion-deepgram"
271
+ | "atlas-deepgram"
272
+ | "alloy-openai"
273
+ | "echo-openai"
274
+ | "fable-openai"
275
+ | "onyx-openai"
276
+ | "nova-openai"
277
+ | "shimmer-openai"
209
278
  | ElevenLabsVoice
210
279
  | PlayHTVoice
211
280
  | RimeAIVoice
212
- | BetaVoice;
281
+ | DeepgramVoice
282
+ | OpenAIVoice;
213
283
  /**
214
284
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
215
285
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -262,6 +332,8 @@ export interface CreateAssistantDTO {
262
332
  endCallFunctionEnabled?: boolean;
263
333
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
264
334
  fillersEnabled?: boolean;
335
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
336
+ liveTranscriptsEnabled?: boolean;
265
337
  }
266
338
 
267
339
  export interface Assistant {
@@ -273,7 +345,7 @@ export interface Assistant {
273
345
  /** These are the options for the assistant's transcriber. */
274
346
  transcriber?: DeepgramTranscriber;
275
347
  /** These are the options for the assistant's LLM. */
276
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
348
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
277
349
  /**
278
350
  * These are the options for the assistant's voice.
279
351
  * @default "jennifer-playht"
@@ -311,18 +383,24 @@ export interface Assistant {
311
383
  | "daphne-rimeai"
312
384
  | "aurora-rimeai"
313
385
  | "nova-rimeai"
314
- | "apollo-beta"
315
- | "orion-beta"
316
- | "aurora-beta"
317
- | "asteria-beta"
318
- | "stella-beta"
319
- | "artemis-beta"
320
- | "andromeda-beta"
321
- | "atlas-beta"
386
+ | "aurora-deepgram"
387
+ | "asteria-deepgram"
388
+ | "artemis-deepgram"
389
+ | "andromeda-deepgram"
390
+ | "stella-deepgram"
391
+ | "orion-deepgram"
392
+ | "atlas-deepgram"
393
+ | "alloy-openai"
394
+ | "echo-openai"
395
+ | "fable-openai"
396
+ | "onyx-openai"
397
+ | "nova-openai"
398
+ | "shimmer-openai"
322
399
  | ElevenLabsVoice
323
400
  | PlayHTVoice
324
401
  | RimeAIVoice
325
- | BetaVoice;
402
+ | DeepgramVoice
403
+ | OpenAIVoice;
326
404
  /**
327
405
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
328
406
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -375,6 +453,8 @@ export interface Assistant {
375
453
  endCallFunctionEnabled?: boolean;
376
454
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
377
455
  fillersEnabled?: boolean;
456
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
457
+ liveTranscriptsEnabled?: boolean;
378
458
  /** This is the unique identifier for the assistant. */
379
459
  id: string;
380
460
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -400,7 +480,7 @@ export interface UpdateAssistantDTO {
400
480
  /** These are the options for the assistant's transcriber. */
401
481
  transcriber?: DeepgramTranscriber;
402
482
  /** These are the options for the assistant's LLM. */
403
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
483
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
404
484
  /**
405
485
  * These are the options for the assistant's voice.
406
486
  * @default "jennifer-playht"
@@ -438,18 +518,24 @@ export interface UpdateAssistantDTO {
438
518
  | "daphne-rimeai"
439
519
  | "aurora-rimeai"
440
520
  | "nova-rimeai"
441
- | "apollo-beta"
442
- | "orion-beta"
443
- | "aurora-beta"
444
- | "asteria-beta"
445
- | "stella-beta"
446
- | "artemis-beta"
447
- | "andromeda-beta"
448
- | "atlas-beta"
521
+ | "aurora-deepgram"
522
+ | "asteria-deepgram"
523
+ | "artemis-deepgram"
524
+ | "andromeda-deepgram"
525
+ | "stella-deepgram"
526
+ | "orion-deepgram"
527
+ | "atlas-deepgram"
528
+ | "alloy-openai"
529
+ | "echo-openai"
530
+ | "fable-openai"
531
+ | "onyx-openai"
532
+ | "nova-openai"
533
+ | "shimmer-openai"
449
534
  | ElevenLabsVoice
450
535
  | PlayHTVoice
451
536
  | RimeAIVoice
452
- | BetaVoice;
537
+ | DeepgramVoice
538
+ | OpenAIVoice;
453
539
  /**
454
540
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
455
541
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -502,6 +588,8 @@ export interface UpdateAssistantDTO {
502
588
  endCallFunctionEnabled?: boolean;
503
589
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
504
590
  fillersEnabled?: boolean;
591
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
592
+ liveTranscriptsEnabled?: boolean;
505
593
  }
506
594
 
507
595
  export interface CreateCustomerDTO {
@@ -591,6 +679,8 @@ export interface Call {
591
679
  recordingUrl?: string;
592
680
  /** This is the summary of the call. */
593
681
  summary?: string;
682
+ /** These are the messages that were spoken during the call. */
683
+ messages?: object[];
594
684
  /**
595
685
  * This is the callSid of the phone call.
596
686
  *
@@ -671,111 +761,207 @@ export interface CreateWebCallDTO {
671
761
  assistant?: CreateAssistantDTO;
672
762
  }
673
763
 
764
+ export interface TwilioCredential {
765
+ provider: "twilio";
766
+ /** This is not returned in the API. */
767
+ authToken: string;
768
+ /** This is the unique identifier for the credential. */
769
+ id: string;
770
+ /** This is the unique identifier for the org that this credential belongs to. */
771
+ orgId: string;
772
+ /**
773
+ * This is the ISO 8601 date-time string of when the credential was created.
774
+ * @format date-time
775
+ */
776
+ createdAt: string;
777
+ /**
778
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
779
+ * @format date-time
780
+ */
781
+ updatedAt: string;
782
+ accountSid: string;
783
+ }
784
+
785
+ export interface DeepgramCredential {
786
+ provider: "deepgram";
787
+ /** This is not returned in the API. */
788
+ apiKey: string;
789
+ /** This is the unique identifier for the credential. */
790
+ id: string;
791
+ /** This is the unique identifier for the org that this credential belongs to. */
792
+ orgId: string;
793
+ /**
794
+ * This is the ISO 8601 date-time string of when the credential was created.
795
+ * @format date-time
796
+ */
797
+ createdAt: string;
798
+ /**
799
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
800
+ * @format date-time
801
+ */
802
+ updatedAt: string;
803
+ }
804
+
805
+ export interface AzureOpenAICredential {
806
+ provider: "azure-openai";
807
+ /** This is not returned in the API. */
808
+ openAIKey: string;
809
+ /** This is the unique identifier for the credential. */
810
+ id: string;
811
+ /** This is the unique identifier for the org that this credential belongs to. */
812
+ orgId: string;
813
+ /**
814
+ * This is the ISO 8601 date-time string of when the credential was created.
815
+ * @format date-time
816
+ */
817
+ createdAt: string;
818
+ /**
819
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
820
+ * @format date-time
821
+ */
822
+ updatedAt: string;
823
+ openAIEndpoint: string;
824
+ }
825
+
826
+ export interface ElevenLabsCredential {
827
+ provider: "11labs";
828
+ /** This is not returned in the API. */
829
+ apiKey: string;
830
+ /** This is the unique identifier for the credential. */
831
+ id: string;
832
+ /** This is the unique identifier for the org that this credential belongs to. */
833
+ orgId: string;
834
+ /**
835
+ * This is the ISO 8601 date-time string of when the credential was created.
836
+ * @format date-time
837
+ */
838
+ createdAt: string;
839
+ /**
840
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
841
+ * @format date-time
842
+ */
843
+ updatedAt: string;
844
+ }
845
+
846
+ export interface PlayHTCredential {
847
+ provider: "playht";
848
+ /** This is not returned in the API. */
849
+ apiKey: string;
850
+ /** This is the unique identifier for the credential. */
851
+ id: string;
852
+ /** This is the unique identifier for the org that this credential belongs to. */
853
+ orgId: string;
854
+ /**
855
+ * This is the ISO 8601 date-time string of when the credential was created.
856
+ * @format date-time
857
+ */
858
+ createdAt: string;
859
+ /**
860
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
861
+ * @format date-time
862
+ */
863
+ updatedAt: string;
864
+ userId: string;
865
+ }
866
+
867
+ export interface RimeAICredential {
868
+ provider: "rimeai";
869
+ /** This is not returned in the API. */
870
+ apiKey: string;
871
+ /** This is the unique identifier for the credential. */
872
+ id: string;
873
+ /** This is the unique identifier for the org that this credential belongs to. */
874
+ orgId: string;
875
+ /**
876
+ * This is the ISO 8601 date-time string of when the credential was created.
877
+ * @format date-time
878
+ */
879
+ createdAt: string;
880
+ /**
881
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
882
+ * @format date-time
883
+ */
884
+ updatedAt: string;
885
+ }
886
+
674
887
  export interface CreateTwilioCredentialDTO {
675
888
  provider: "twilio";
676
- /** This is hidden in the API responses. */
889
+ /** This is not returned in the API. */
677
890
  authToken: string;
678
891
  accountSid: string;
679
892
  }
680
893
 
681
894
  export interface CreateDeepgramCredentialDTO {
682
895
  provider: "deepgram";
683
- /** This is hidden in the API responses. */
896
+ /** This is not returned in the API. */
684
897
  apiKey: string;
685
898
  }
686
899
 
687
- export interface CreateAzureCredentialDTO {
900
+ export interface CreateAzureOpenAICredentialDTO {
688
901
  provider: "azure-openai";
689
- /** This is hidden in the API responses. */
902
+ /** This is not returned in the API. */
690
903
  openAIKey: string;
691
904
  openAIEndpoint: string;
692
905
  }
693
906
 
694
907
  export interface CreateElevenLabsCredentialDTO {
695
908
  provider: "11labs";
696
- /** This is hidden in the API responses. */
909
+ /** This is not returned in the API. */
697
910
  apiKey: string;
698
911
  }
699
912
 
700
913
  export interface CreatePlayHTCredentialDTO {
701
914
  provider: "playht";
702
- /** This is hidden in the API responses. */
915
+ /** This is not returned in the API. */
703
916
  apiKey: string;
704
917
  userId: string;
705
918
  }
706
919
 
707
920
  export interface CreateRimeAICredentialDTO {
708
921
  provider: "rimeai";
709
- /** This is hidden in the API responses. */
922
+ /** This is not returned in the API. */
710
923
  apiKey: string;
711
924
  }
712
925
 
713
926
  export interface UpdateTwilioCredentialDTO {
714
927
  provider: "twilio";
715
- /** This is hidden in the API responses. */
928
+ /** This is not returned in the API. */
716
929
  authToken: string;
717
930
  accountSid: string;
718
931
  }
719
932
 
720
933
  export interface UpdateDeepgramCredentialDTO {
721
934
  provider: "deepgram";
722
- /** This is hidden in the API responses. */
935
+ /** This is not returned in the API. */
723
936
  apiKey: string;
724
937
  }
725
938
 
726
- export interface UpdateAzureCredentialDTO {
939
+ export interface UpdateAzureOpenAICredentialDTO {
727
940
  provider: "azure-openai";
728
- /** This is hidden in the API responses. */
941
+ /** This is not returned in the API. */
729
942
  openAIKey: string;
730
943
  openAIEndpoint: string;
731
944
  }
732
945
 
733
946
  export interface UpdateElevenLabsCredentialDTO {
734
947
  provider: "11labs";
735
- /** This is hidden in the API responses. */
948
+ /** This is not returned in the API. */
736
949
  apiKey: string;
737
950
  }
738
951
 
739
952
  export interface UpdatePlayHTCredentialDTO {
740
953
  provider: "playht";
741
- /** This is hidden in the API responses. */
954
+ /** This is not returned in the API. */
742
955
  apiKey: string;
743
956
  userId: string;
744
957
  }
745
958
 
746
959
  export interface UpdateRimeAICredentialDTO {
747
960
  provider: "rimeai";
748
- /** This is hidden in the API responses. */
961
+ /** This is not returned in the API. */
749
962
  apiKey: string;
750
963
  }
751
964
 
752
- export interface Credential {
753
- /** This is hidden in the API responses. */
754
- authToken?: string;
755
- /** This is hidden in the API responses. */
756
- apiKey?: string;
757
- /** This is hidden in the API responses. */
758
- openAIKey?: string;
759
- provider: "twilio" | "deepgram" | "azure-openai" | "11labs" | "playht" | "rimeai";
760
- /** This is the unique identifier for the credential. */
761
- id: string;
762
- /** This is the unique identifier for the org that this credential belongs to. */
763
- orgId: string;
764
- /**
765
- * This is the ISO 8601 date-time string of when the credential was created.
766
- * @format date-time
767
- */
768
- createdAt: string;
769
- /**
770
- * This is the ISO 8601 date-time string of when the assistant was last updated.
771
- * @format date-time
772
- */
773
- updatedAt: string;
774
- accountSid?: string;
775
- openAIEndpoint?: string;
776
- userId?: string;
777
- }
778
-
779
965
  export interface BuyPhoneNumberDTO {
780
966
  /**
781
967
  * This is the area code of the phone number to purchase.
@@ -1272,7 +1458,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1272
1458
  } & CreateDeepgramCredentialDTO)
1273
1459
  | ({
1274
1460
  provider: "azure-openai";
1275
- } & CreateAzureCredentialDTO)
1461
+ } & CreateAzureOpenAICredentialDTO)
1276
1462
  | ({
1277
1463
  provider: "11labs";
1278
1464
  } & CreateElevenLabsCredentialDTO)
@@ -1284,7 +1470,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1284
1470
  } & CreateRimeAICredentialDTO),
1285
1471
  params: RequestParams = {},
1286
1472
  ) =>
1287
- this.request<Credential, any>({
1473
+ this.request<
1474
+ | ({
1475
+ provider: "twilio";
1476
+ } & TwilioCredential)
1477
+ | ({
1478
+ provider: "deepgram";
1479
+ } & DeepgramCredential)
1480
+ | ({
1481
+ provider: "azure-openai";
1482
+ } & AzureOpenAICredential)
1483
+ | ({
1484
+ provider: "11labs";
1485
+ } & ElevenLabsCredential)
1486
+ | ({
1487
+ provider: "playht";
1488
+ } & PlayHTCredential)
1489
+ | ({
1490
+ provider: "rimeai";
1491
+ } & RimeAICredential),
1492
+ any
1493
+ >({
1288
1494
  path: `/credential`,
1289
1495
  method: "POST",
1290
1496
  body: data,
@@ -1304,7 +1510,29 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1304
1510
  * @secure
1305
1511
  */
1306
1512
  credentialControllerFindAll: (params: RequestParams = {}) =>
1307
- this.request<Credential[], any>({
1513
+ this.request<
1514
+ (
1515
+ | ({
1516
+ provider: "twilio";
1517
+ } & TwilioCredential)
1518
+ | ({
1519
+ provider: "deepgram";
1520
+ } & DeepgramCredential)
1521
+ | ({
1522
+ provider: "azure-openai";
1523
+ } & AzureOpenAICredential)
1524
+ | ({
1525
+ provider: "11labs";
1526
+ } & ElevenLabsCredential)
1527
+ | ({
1528
+ provider: "playht";
1529
+ } & PlayHTCredential)
1530
+ | ({
1531
+ provider: "rimeai";
1532
+ } & RimeAICredential)
1533
+ )[],
1534
+ any
1535
+ >({
1308
1536
  path: `/credential`,
1309
1537
  method: "GET",
1310
1538
  secure: true,
@@ -1322,7 +1550,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1322
1550
  * @secure
1323
1551
  */
1324
1552
  credentialControllerFindOne: (id: string, params: RequestParams = {}) =>
1325
- this.request<Credential, any>({
1553
+ this.request<
1554
+ | ({
1555
+ provider: "twilio";
1556
+ } & TwilioCredential)
1557
+ | ({
1558
+ provider: "deepgram";
1559
+ } & DeepgramCredential)
1560
+ | ({
1561
+ provider: "azure-openai";
1562
+ } & AzureOpenAICredential)
1563
+ | ({
1564
+ provider: "11labs";
1565
+ } & ElevenLabsCredential)
1566
+ | ({
1567
+ provider: "playht";
1568
+ } & PlayHTCredential)
1569
+ | ({
1570
+ provider: "rimeai";
1571
+ } & RimeAICredential),
1572
+ any
1573
+ >({
1326
1574
  path: `/credential/${id}`,
1327
1575
  method: "GET",
1328
1576
  secure: true,
@@ -1350,7 +1598,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1350
1598
  } & UpdateDeepgramCredentialDTO)
1351
1599
  | ({
1352
1600
  provider: "azure-openai";
1353
- } & UpdateAzureCredentialDTO)
1601
+ } & UpdateAzureOpenAICredentialDTO)
1354
1602
  | ({
1355
1603
  provider: "11labs";
1356
1604
  } & UpdateElevenLabsCredentialDTO)
@@ -1362,7 +1610,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1362
1610
  } & UpdateRimeAICredentialDTO),
1363
1611
  params: RequestParams = {},
1364
1612
  ) =>
1365
- this.request<Credential, any>({
1613
+ this.request<
1614
+ | ({
1615
+ provider: "twilio";
1616
+ } & TwilioCredential)
1617
+ | ({
1618
+ provider: "deepgram";
1619
+ } & DeepgramCredential)
1620
+ | ({
1621
+ provider: "azure-openai";
1622
+ } & AzureOpenAICredential)
1623
+ | ({
1624
+ provider: "11labs";
1625
+ } & ElevenLabsCredential)
1626
+ | ({
1627
+ provider: "playht";
1628
+ } & PlayHTCredential)
1629
+ | ({
1630
+ provider: "rimeai";
1631
+ } & RimeAICredential),
1632
+ any
1633
+ >({
1366
1634
  path: `/credential/${id}`,
1367
1635
  method: "PUT",
1368
1636
  body: data,
@@ -1382,7 +1650,27 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1382
1650
  * @secure
1383
1651
  */
1384
1652
  credentialControllerRemove: (id: string, params: RequestParams = {}) =>
1385
- this.request<Credential, any>({
1653
+ this.request<
1654
+ | ({
1655
+ provider: "twilio";
1656
+ } & TwilioCredential)
1657
+ | ({
1658
+ provider: "deepgram";
1659
+ } & DeepgramCredential)
1660
+ | ({
1661
+ provider: "azure-openai";
1662
+ } & AzureOpenAICredential)
1663
+ | ({
1664
+ provider: "11labs";
1665
+ } & ElevenLabsCredential)
1666
+ | ({
1667
+ provider: "playht";
1668
+ } & PlayHTCredential)
1669
+ | ({
1670
+ provider: "rimeai";
1671
+ } & RimeAICredential),
1672
+ any
1673
+ >({
1386
1674
  path: `/credential/${id}`,
1387
1675
  method: "DELETE",
1388
1676
  secure: true,
package/dist/api.d.ts CHANGED
@@ -1,12 +1,12 @@
1
- export interface BetaVoice {
1
+ export interface DeepgramVoice {
2
2
  /**
3
3
  * This is the voice provider that will be used.
4
4
  *
5
- * Pro Voices: `11labs`, `playht`
5
+ * Pro Voices: `11labs`, `playht`, `openai`
6
6
  *
7
- * Basic Voices: `rimeai`, `beta`
7
+ * Basic Voices: `rimeai`, `deepgram`
8
8
  */
9
- provider: "beta";
9
+ provider: "deepgram";
10
10
  /** This is the provider-specific ID that will be used. */
11
11
  voiceId: string;
12
12
  }
@@ -36,9 +36,17 @@ export interface ElevenLabsVoice {
36
36
  *
37
37
  * Pro Voices: `11labs`, `playht`
38
38
  *
39
- * Basic Voices: `rimeai`, `beta`
39
+ * Basic Voices: `rimeai`, `deepgram`
40
40
  */
41
41
  provider: "11labs";
42
+ /** Defines the stability for voice settings. */
43
+ stability?: number;
44
+ /** Defines the similarity boost for voice settings. */
45
+ similarityBoost?: number;
46
+ /** Defines the style for voice settings. */
47
+ style?: boolean;
48
+ /** Defines the use speaker boost for voice settings. */
49
+ useSpeakerBoost?: boolean;
42
50
  /** This is the provider-specific ID that will be used. */
43
51
  voiceId: string;
44
52
  }
@@ -97,11 +105,43 @@ export interface PlayHTVoice {
97
105
  /**
98
106
  * This is the voice provider that will be used.
99
107
  *
100
- * Pro Voices: `11labs`, `playht`
108
+ * Pro Voices: `11labs`, `playht`, `openai`
101
109
  *
102
- * Basic Voices: `rimeai`, `beta`
110
+ * Basic Voices: `rimeai`, `deepgram`
103
111
  */
104
112
  provider: "playht";
113
+ /**
114
+ * This is the speed multiplier that will be used.
115
+ * @min 0
116
+ * @max 5
117
+ */
118
+ speed?: number;
119
+ /**
120
+ * A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.
121
+ * @min 0.1
122
+ * @max 2
123
+ */
124
+ temperature?: number;
125
+ /** An emotion to be applied to the speech. */
126
+ emotion?: "female_happy" | "female_sad" | "female_angry" | "female_fearful" | "female_disgust" | "female_surprised";
127
+ /**
128
+ * A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
129
+ * @min 1
130
+ * @max 6
131
+ */
132
+ voiceGuidance?: number;
133
+ /**
134
+ * A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
135
+ * @min 1
136
+ * @max 30
137
+ */
138
+ styleGuidance?: number;
139
+ /**
140
+ * A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.
141
+ * @min 1
142
+ * @max 2
143
+ */
144
+ textGuidance?: number;
105
145
  /** This is the provider-specific ID that will be used. */
106
146
  voiceId: string;
107
147
  }
@@ -109,11 +149,34 @@ export interface RimeAIVoice {
109
149
  /**
110
150
  * This is the voice provider that will be used.
111
151
  *
112
- * Pro Voices: `11labs`, `playht`
152
+ * Pro Voices: `11labs`, `playht`, `openai`
113
153
  *
114
- * Basic Voices: `rimeai`, `beta`
154
+ * Basic Voices: `rimeai`, `deepgram`
115
155
  */
116
156
  provider: "rimeai";
157
+ /**
158
+ * This is the speed multiplier that will be used.
159
+ * @min 0
160
+ */
161
+ speed?: number;
162
+ /** This is the provider-specific ID that will be used. */
163
+ voiceId: string;
164
+ }
165
+ export interface OpenAIVoice {
166
+ /**
167
+ * This is the voice provider that will be used.
168
+ *
169
+ * Pro Voices: `11labs`, `playht`, `openai`
170
+ *
171
+ * Basic Voices: `rimeai`, `deepgram`
172
+ */
173
+ provider: "openai";
174
+ /**
175
+ * This is the speed multiplier that will be used.
176
+ * @min 0.25
177
+ * @max 4
178
+ */
179
+ speed?: number;
117
180
  /** This is the provider-specific ID that will be used. */
118
181
  voiceId: string;
119
182
  }
@@ -126,12 +189,12 @@ export interface CreateAssistantDTO {
126
189
  /** These are the options for the assistant's transcriber. */
127
190
  transcriber?: DeepgramTranscriber;
128
191
  /** These are the options for the assistant's LLM. */
129
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
192
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
130
193
  /**
131
194
  * These are the options for the assistant's voice.
132
195
  * @default "jennifer-playht"
133
196
  */
134
- 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" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | BetaVoice;
197
+ 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" | "aurora-deepgram" | "asteria-deepgram" | "artemis-deepgram" | "andromeda-deepgram" | "stella-deepgram" | "orion-deepgram" | "atlas-deepgram" | "alloy-openai" | "echo-openai" | "fable-openai" | "onyx-openai" | "nova-openai" | "shimmer-openai" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
135
198
  /**
136
199
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
137
200
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -169,6 +232,8 @@ export interface CreateAssistantDTO {
169
232
  endCallFunctionEnabled?: boolean;
170
233
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
171
234
  fillersEnabled?: boolean;
235
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
236
+ liveTranscriptsEnabled?: boolean;
172
237
  }
173
238
  export interface Assistant {
174
239
  /**
@@ -179,12 +244,12 @@ export interface Assistant {
179
244
  /** These are the options for the assistant's transcriber. */
180
245
  transcriber?: DeepgramTranscriber;
181
246
  /** These are the options for the assistant's LLM. */
182
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
247
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
183
248
  /**
184
249
  * These are the options for the assistant's voice.
185
250
  * @default "jennifer-playht"
186
251
  */
187
- 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" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | BetaVoice;
252
+ 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" | "aurora-deepgram" | "asteria-deepgram" | "artemis-deepgram" | "andromeda-deepgram" | "stella-deepgram" | "orion-deepgram" | "atlas-deepgram" | "alloy-openai" | "echo-openai" | "fable-openai" | "onyx-openai" | "nova-openai" | "shimmer-openai" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
188
253
  /**
189
254
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
190
255
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -222,6 +287,8 @@ export interface Assistant {
222
287
  endCallFunctionEnabled?: boolean;
223
288
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
224
289
  fillersEnabled?: boolean;
290
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
291
+ liveTranscriptsEnabled?: boolean;
225
292
  /** This is the unique identifier for the assistant. */
226
293
  id: string;
227
294
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -246,12 +313,12 @@ export interface UpdateAssistantDTO {
246
313
  /** These are the options for the assistant's transcriber. */
247
314
  transcriber?: DeepgramTranscriber;
248
315
  /** These are the options for the assistant's LLM. */
249
- model?: "0" | "1" | "2" | OpenAIModel | CustomModel;
316
+ model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
250
317
  /**
251
318
  * These are the options for the assistant's voice.
252
319
  * @default "jennifer-playht"
253
320
  */
254
- 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" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | BetaVoice;
321
+ 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" | "aurora-deepgram" | "asteria-deepgram" | "artemis-deepgram" | "andromeda-deepgram" | "stella-deepgram" | "orion-deepgram" | "atlas-deepgram" | "alloy-openai" | "echo-openai" | "fable-openai" | "onyx-openai" | "nova-openai" | "shimmer-openai" | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
255
322
  /**
256
323
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
257
324
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
@@ -289,6 +356,8 @@ export interface UpdateAssistantDTO {
289
356
  endCallFunctionEnabled?: boolean;
290
357
  /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
291
358
  fillersEnabled?: boolean;
359
+ /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
360
+ liveTranscriptsEnabled?: boolean;
292
361
  }
293
362
  export interface CreateCustomerDTO {
294
363
  /** This is the number of the customer. */
@@ -357,6 +426,8 @@ export interface Call {
357
426
  recordingUrl?: string;
358
427
  /** This is the summary of the call. */
359
428
  summary?: string;
429
+ /** These are the messages that were spoken during the call. */
430
+ messages?: object[];
360
431
  /**
361
432
  * This is the callSid of the phone call.
362
433
  *
@@ -434,98 +505,189 @@ export interface CreateWebCallDTO {
434
505
  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
435
506
  assistant?: CreateAssistantDTO;
436
507
  }
508
+ export interface TwilioCredential {
509
+ provider: "twilio";
510
+ /** This is not returned in the API. */
511
+ authToken: string;
512
+ /** This is the unique identifier for the credential. */
513
+ id: string;
514
+ /** This is the unique identifier for the org that this credential belongs to. */
515
+ orgId: string;
516
+ /**
517
+ * This is the ISO 8601 date-time string of when the credential was created.
518
+ * @format date-time
519
+ */
520
+ createdAt: string;
521
+ /**
522
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
523
+ * @format date-time
524
+ */
525
+ updatedAt: string;
526
+ accountSid: string;
527
+ }
528
+ export interface DeepgramCredential {
529
+ provider: "deepgram";
530
+ /** This is not returned in the API. */
531
+ apiKey: string;
532
+ /** This is the unique identifier for the credential. */
533
+ id: string;
534
+ /** This is the unique identifier for the org that this credential belongs to. */
535
+ orgId: string;
536
+ /**
537
+ * This is the ISO 8601 date-time string of when the credential was created.
538
+ * @format date-time
539
+ */
540
+ createdAt: string;
541
+ /**
542
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
543
+ * @format date-time
544
+ */
545
+ updatedAt: string;
546
+ }
547
+ export interface AzureOpenAICredential {
548
+ provider: "azure-openai";
549
+ /** This is not returned in the API. */
550
+ openAIKey: string;
551
+ /** This is the unique identifier for the credential. */
552
+ id: string;
553
+ /** This is the unique identifier for the org that this credential belongs to. */
554
+ orgId: string;
555
+ /**
556
+ * This is the ISO 8601 date-time string of when the credential was created.
557
+ * @format date-time
558
+ */
559
+ createdAt: string;
560
+ /**
561
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
562
+ * @format date-time
563
+ */
564
+ updatedAt: string;
565
+ openAIEndpoint: string;
566
+ }
567
+ export interface ElevenLabsCredential {
568
+ provider: "11labs";
569
+ /** This is not returned in the API. */
570
+ apiKey: string;
571
+ /** This is the unique identifier for the credential. */
572
+ id: string;
573
+ /** This is the unique identifier for the org that this credential belongs to. */
574
+ orgId: string;
575
+ /**
576
+ * This is the ISO 8601 date-time string of when the credential was created.
577
+ * @format date-time
578
+ */
579
+ createdAt: string;
580
+ /**
581
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
582
+ * @format date-time
583
+ */
584
+ updatedAt: string;
585
+ }
586
+ export interface PlayHTCredential {
587
+ provider: "playht";
588
+ /** This is not returned in the API. */
589
+ apiKey: string;
590
+ /** This is the unique identifier for the credential. */
591
+ id: string;
592
+ /** This is the unique identifier for the org that this credential belongs to. */
593
+ orgId: string;
594
+ /**
595
+ * This is the ISO 8601 date-time string of when the credential was created.
596
+ * @format date-time
597
+ */
598
+ createdAt: string;
599
+ /**
600
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
601
+ * @format date-time
602
+ */
603
+ updatedAt: string;
604
+ userId: string;
605
+ }
606
+ export interface RimeAICredential {
607
+ provider: "rimeai";
608
+ /** This is not returned in the API. */
609
+ apiKey: string;
610
+ /** This is the unique identifier for the credential. */
611
+ id: string;
612
+ /** This is the unique identifier for the org that this credential belongs to. */
613
+ orgId: string;
614
+ /**
615
+ * This is the ISO 8601 date-time string of when the credential was created.
616
+ * @format date-time
617
+ */
618
+ createdAt: string;
619
+ /**
620
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
621
+ * @format date-time
622
+ */
623
+ updatedAt: string;
624
+ }
437
625
  export interface CreateTwilioCredentialDTO {
438
626
  provider: "twilio";
439
- /** This is hidden in the API responses. */
627
+ /** This is not returned in the API. */
440
628
  authToken: string;
441
629
  accountSid: string;
442
630
  }
443
631
  export interface CreateDeepgramCredentialDTO {
444
632
  provider: "deepgram";
445
- /** This is hidden in the API responses. */
633
+ /** This is not returned in the API. */
446
634
  apiKey: string;
447
635
  }
448
- export interface CreateAzureCredentialDTO {
636
+ export interface CreateAzureOpenAICredentialDTO {
449
637
  provider: "azure-openai";
450
- /** This is hidden in the API responses. */
638
+ /** This is not returned in the API. */
451
639
  openAIKey: string;
452
640
  openAIEndpoint: string;
453
641
  }
454
642
  export interface CreateElevenLabsCredentialDTO {
455
643
  provider: "11labs";
456
- /** This is hidden in the API responses. */
644
+ /** This is not returned in the API. */
457
645
  apiKey: string;
458
646
  }
459
647
  export interface CreatePlayHTCredentialDTO {
460
648
  provider: "playht";
461
- /** This is hidden in the API responses. */
649
+ /** This is not returned in the API. */
462
650
  apiKey: string;
463
651
  userId: string;
464
652
  }
465
653
  export interface CreateRimeAICredentialDTO {
466
654
  provider: "rimeai";
467
- /** This is hidden in the API responses. */
655
+ /** This is not returned in the API. */
468
656
  apiKey: string;
469
657
  }
470
658
  export interface UpdateTwilioCredentialDTO {
471
659
  provider: "twilio";
472
- /** This is hidden in the API responses. */
660
+ /** This is not returned in the API. */
473
661
  authToken: string;
474
662
  accountSid: string;
475
663
  }
476
664
  export interface UpdateDeepgramCredentialDTO {
477
665
  provider: "deepgram";
478
- /** This is hidden in the API responses. */
666
+ /** This is not returned in the API. */
479
667
  apiKey: string;
480
668
  }
481
- export interface UpdateAzureCredentialDTO {
669
+ export interface UpdateAzureOpenAICredentialDTO {
482
670
  provider: "azure-openai";
483
- /** This is hidden in the API responses. */
671
+ /** This is not returned in the API. */
484
672
  openAIKey: string;
485
673
  openAIEndpoint: string;
486
674
  }
487
675
  export interface UpdateElevenLabsCredentialDTO {
488
676
  provider: "11labs";
489
- /** This is hidden in the API responses. */
677
+ /** This is not returned in the API. */
490
678
  apiKey: string;
491
679
  }
492
680
  export interface UpdatePlayHTCredentialDTO {
493
681
  provider: "playht";
494
- /** This is hidden in the API responses. */
682
+ /** This is not returned in the API. */
495
683
  apiKey: string;
496
684
  userId: string;
497
685
  }
498
686
  export interface UpdateRimeAICredentialDTO {
499
687
  provider: "rimeai";
500
- /** This is hidden in the API responses. */
688
+ /** This is not returned in the API. */
501
689
  apiKey: string;
502
690
  }
503
- export interface Credential {
504
- /** This is hidden in the API responses. */
505
- authToken?: string;
506
- /** This is hidden in the API responses. */
507
- apiKey?: string;
508
- /** This is hidden in the API responses. */
509
- openAIKey?: string;
510
- provider: "twilio" | "deepgram" | "azure-openai" | "11labs" | "playht" | "rimeai";
511
- /** This is the unique identifier for the credential. */
512
- id: string;
513
- /** This is the unique identifier for the org that this credential belongs to. */
514
- orgId: string;
515
- /**
516
- * This is the ISO 8601 date-time string of when the credential was created.
517
- * @format date-time
518
- */
519
- createdAt: string;
520
- /**
521
- * This is the ISO 8601 date-time string of when the assistant was last updated.
522
- * @format date-time
523
- */
524
- updatedAt: string;
525
- accountSid?: string;
526
- openAIEndpoint?: string;
527
- userId?: string;
528
- }
529
691
  export interface BuyPhoneNumberDTO {
530
692
  /**
531
693
  * This is the area code of the phone number to purchase.
@@ -785,13 +947,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
785
947
  provider: "deepgram";
786
948
  } & CreateDeepgramCredentialDTO) | ({
787
949
  provider: "azure-openai";
788
- } & CreateAzureCredentialDTO) | ({
950
+ } & CreateAzureOpenAICredentialDTO) | ({
789
951
  provider: "11labs";
790
952
  } & CreateElevenLabsCredentialDTO) | ({
791
953
  provider: "playht";
792
954
  } & CreatePlayHTCredentialDTO) | ({
793
955
  provider: "rimeai";
794
- } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
956
+ } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
957
+ provider: "twilio";
958
+ } & TwilioCredential) | ({
959
+ provider: "deepgram";
960
+ } & DeepgramCredential) | ({
961
+ provider: "azure-openai";
962
+ } & AzureOpenAICredential) | ({
963
+ provider: "11labs";
964
+ } & ElevenLabsCredential) | ({
965
+ provider: "playht";
966
+ } & PlayHTCredential) | ({
967
+ provider: "rimeai";
968
+ } & RimeAICredential), any>>;
795
969
  /**
796
970
  * No description
797
971
  *
@@ -801,7 +975,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
801
975
  * @request GET:/credential
802
976
  * @secure
803
977
  */
804
- credentialControllerFindAll: (params?: RequestParams) => Promise<HttpResponse<Credential[], any>>;
978
+ credentialControllerFindAll: (params?: RequestParams) => Promise<HttpResponse<(({
979
+ provider: "twilio";
980
+ } & TwilioCredential) | ({
981
+ provider: "deepgram";
982
+ } & DeepgramCredential) | ({
983
+ provider: "azure-openai";
984
+ } & AzureOpenAICredential) | ({
985
+ provider: "11labs";
986
+ } & ElevenLabsCredential) | ({
987
+ provider: "playht";
988
+ } & PlayHTCredential) | ({
989
+ provider: "rimeai";
990
+ } & RimeAICredential))[], any>>;
805
991
  /**
806
992
  * No description
807
993
  *
@@ -811,7 +997,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
811
997
  * @request GET:/credential/{id}
812
998
  * @secure
813
999
  */
814
- credentialControllerFindOne: (id: string, params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
1000
+ credentialControllerFindOne: (id: string, params?: RequestParams) => Promise<HttpResponse<({
1001
+ provider: "twilio";
1002
+ } & TwilioCredential) | ({
1003
+ provider: "deepgram";
1004
+ } & DeepgramCredential) | ({
1005
+ provider: "azure-openai";
1006
+ } & AzureOpenAICredential) | ({
1007
+ provider: "11labs";
1008
+ } & ElevenLabsCredential) | ({
1009
+ provider: "playht";
1010
+ } & PlayHTCredential) | ({
1011
+ provider: "rimeai";
1012
+ } & RimeAICredential), any>>;
815
1013
  /**
816
1014
  * No description
817
1015
  *
@@ -827,13 +1025,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
827
1025
  provider: "deepgram";
828
1026
  } & UpdateDeepgramCredentialDTO) | ({
829
1027
  provider: "azure-openai";
830
- } & UpdateAzureCredentialDTO) | ({
1028
+ } & UpdateAzureOpenAICredentialDTO) | ({
831
1029
  provider: "11labs";
832
1030
  } & UpdateElevenLabsCredentialDTO) | ({
833
1031
  provider: "playht";
834
1032
  } & UpdatePlayHTCredentialDTO) | ({
835
1033
  provider: "rimeai";
836
- } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
1034
+ } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
1035
+ provider: "twilio";
1036
+ } & TwilioCredential) | ({
1037
+ provider: "deepgram";
1038
+ } & DeepgramCredential) | ({
1039
+ provider: "azure-openai";
1040
+ } & AzureOpenAICredential) | ({
1041
+ provider: "11labs";
1042
+ } & ElevenLabsCredential) | ({
1043
+ provider: "playht";
1044
+ } & PlayHTCredential) | ({
1045
+ provider: "rimeai";
1046
+ } & RimeAICredential), any>>;
837
1047
  /**
838
1048
  * No description
839
1049
  *
@@ -843,7 +1053,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
843
1053
  * @request DELETE:/credential/{id}
844
1054
  * @secure
845
1055
  */
846
- credentialControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<Credential, any>>;
1056
+ credentialControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<({
1057
+ provider: "twilio";
1058
+ } & TwilioCredential) | ({
1059
+ provider: "deepgram";
1060
+ } & DeepgramCredential) | ({
1061
+ provider: "azure-openai";
1062
+ } & AzureOpenAICredential) | ({
1063
+ provider: "11labs";
1064
+ } & ElevenLabsCredential) | ({
1065
+ provider: "playht";
1066
+ } & PlayHTCredential) | ({
1067
+ provider: "rimeai";
1068
+ } & RimeAICredential), any>>;
847
1069
  };
848
1070
  phoneNumber: {
849
1071
  /**
package/dist/vapi.js CHANGED
@@ -139,7 +139,6 @@ class Vapi extends VapiEventEmitter {
139
139
  });
140
140
  this.call.startRemoteParticipantsAudioLevelObserver(100);
141
141
  this.call.on("remote-participants-audio-level", (e) => this.handleRemoteParticipantsAudioLevel(e));
142
- console.log("yo");
143
142
  this.call.on("app-message", (e) => this.onAppMessage(e));
144
143
  this.call.updateInputSettings({
145
144
  audio: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vapi-ai/web",
3
- "version": "1.0.235",
3
+ "version": "1.0.237",
4
4
  "description": "",
5
5
  "main": "dist/vapi.js",
6
6
  "types": "dist/vapi.d.ts",
package/vapi.ts CHANGED
@@ -174,7 +174,6 @@ export default class Vapi extends VapiEventEmitter {
174
174
  this.call.on("remote-participants-audio-level", (e) =>
175
175
  this.handleRemoteParticipantsAudioLevel(e)
176
176
  );
177
- console.log("yo");
178
177
  this.call.on("app-message", (e) => this.onAppMessage(e));
179
178
 
180
179
  this.call.updateInputSettings({