@vapi-ai/web 1.0.248 → 1.0.249

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 +708 -289
  2. package/dist/api.d.ts +568 -133
  3. package/package.json +1 -1
package/api.ts CHANGED
@@ -15,24 +15,132 @@ export interface DeepgramVoice {
15
15
  *
16
16
  * Pro Voices: `11labs`, `playht`, `openai`
17
17
  *
18
- * Basic Voices: `rimeai`, `deepgram`
18
+ * Basic Voices: `rime-ai`, `deepgram`
19
19
  */
20
20
  provider: "deepgram";
21
21
  /** This is the provider-specific ID that will be used. */
22
- voiceId: string;
22
+ voiceId: "aurora" | "asteria" | "artemis" | "andromeda" | "stella" | "orion" | "atlas" | string;
23
23
  }
24
24
 
25
- export interface CustomModel {
25
+ export interface OpenAIFunction {
26
26
  /**
27
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
27
+ * This is the the name of the function to be called.
28
+ *
29
+ * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
30
+ * @maxLength 64
31
+ */
32
+ name: string;
33
+ /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
34
+ async?: boolean;
35
+ /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
36
+ description?: string;
37
+ /**
38
+ * These are the parameters the functions accepts, described as a JSON Schema object.
28
39
  *
29
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
40
+ * See the [OpenAI guide](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.
41
+ *
42
+ * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
43
+ */
44
+ parameters: object;
45
+ }
46
+
47
+ export interface TogetherAIModel {
48
+ provider: "together-ai";
49
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
50
+ model: string;
51
+ /** This sets the objective and understanding for the assistant. */
52
+ systemPrompt?: string;
53
+ /**
54
+ * This is the temperature that will be used for calls. Default is 1.
55
+ * @min 0
56
+ * @max 2
57
+ */
58
+ temperature?: number;
59
+ /** These are the functions that the assistant can execute during the call. */
60
+ functions?: OpenAIFunction[];
61
+ }
62
+
63
+ export interface AnyscaleModel {
64
+ provider: "anyscale";
65
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
66
+ model: string;
67
+ /** This sets the objective and understanding for the assistant. */
68
+ systemPrompt?: string;
69
+ /**
70
+ * This is the temperature that will be used for calls. Default is 1.
71
+ * @min 0
72
+ * @max 2
30
73
  */
31
- provider: "custom";
32
- /** These is the URL we'll POST during the conversation. */
74
+ temperature?: number;
75
+ /** These are the functions that the assistant can execute during the call. */
76
+ functions?: OpenAIFunction[];
77
+ }
78
+
79
+ export interface OpenRouterModel {
80
+ provider: "openrouter";
81
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
82
+ model: string;
83
+ /** This sets the objective and understanding for the assistant. */
84
+ systemPrompt?: string;
85
+ /**
86
+ * This is the temperature that will be used for calls. Default is 1.
87
+ * @min 0
88
+ * @max 2
89
+ */
90
+ temperature?: number;
91
+ /** These are the functions that the assistant can execute during the call. */
92
+ functions?: OpenAIFunction[];
93
+ }
94
+
95
+ export interface PerplexityAIModel {
96
+ provider: "perplexity-ai";
97
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
98
+ model: string;
99
+ /** This sets the objective and understanding for the assistant. */
100
+ systemPrompt?: string;
101
+ /**
102
+ * This is the temperature that will be used for calls. Default is 1.
103
+ * @min 0
104
+ * @max 2
105
+ */
106
+ temperature?: number;
107
+ /** These are the functions that the assistant can execute during the call. */
108
+ functions?: OpenAIFunction[];
109
+ }
110
+
111
+ export interface DeepInfraModel {
112
+ provider: "deepinfra";
113
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
114
+ model: string;
115
+ /** This sets the objective and understanding for the assistant. */
116
+ systemPrompt?: string;
117
+ /**
118
+ * This is the temperature that will be used for calls. Default is 1.
119
+ * @min 0
120
+ * @max 2
121
+ */
122
+ temperature?: number;
123
+ /** These are the functions that the assistant can execute during the call. */
124
+ functions?: OpenAIFunction[];
125
+ }
126
+
127
+ export interface CustomLLMModel {
128
+ /** This is the provider that will be used for the model. Any service, including your own server, that is compatible with the OpenAI API can be used. */
129
+ provider: "custom-llm";
130
+ /** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */
33
131
  url: string;
132
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
133
+ model: string;
34
134
  /** This sets the objective and understanding for the assistant. */
35
135
  systemPrompt?: string;
136
+ /**
137
+ * This is the temperature that will be used for calls. Default is 1.
138
+ * @min 0
139
+ * @max 2
140
+ */
141
+ temperature?: number;
142
+ /** These are the functions that the assistant can execute during the call. */
143
+ functions?: OpenAIFunction[];
36
144
  }
37
145
 
38
146
  export interface DeepgramTranscriber {
@@ -63,68 +171,60 @@ export interface ElevenLabsVoice {
63
171
  *
64
172
  * Pro Voices: `11labs`, `playht`
65
173
  *
66
- * Basic Voices: `rimeai`, `deepgram`
174
+ * Basic Voices: `rime-ai`, `deepgram`
67
175
  */
68
176
  provider: "11labs";
69
- /** Defines the stability for voice settings. */
177
+ /** This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library. */
178
+ voiceId:
179
+ | "burt"
180
+ | "andrea"
181
+ | "phillip"
182
+ | "steve"
183
+ | "joseph"
184
+ | "myra"
185
+ | "paula"
186
+ | "ryan"
187
+ | "drew"
188
+ | "paul"
189
+ | "mrb"
190
+ | "matilda"
191
+ | "mark"
192
+ | string;
193
+ /**
194
+ * Defines the stability for voice settings.
195
+ * @min 0
196
+ * @max 1
197
+ * @default null
198
+ */
70
199
  stability?: number;
71
- /** Defines the similarity boost for voice settings. */
200
+ /**
201
+ * Defines the similarity boost for voice settings.
202
+ * @min 0
203
+ * @max 1
204
+ * @default null
205
+ */
72
206
  similarityBoost?: number;
73
- /** Defines the style for voice settings. */
74
- style?: boolean;
75
- /** Defines the use speaker boost for voice settings. */
76
- useSpeakerBoost?: boolean;
77
- /** This is the provider-specific ID that will be used. */
78
- voiceId: string;
79
- }
80
-
81
- export interface OpenAIFunctionParameterProperty {
82
- type: "string" | "number" | "boolean";
83
- enum?: string[];
84
- description?: string;
85
- }
86
-
87
- export interface OpenAIFunctionParameters {
88
- type: "object";
89
- properties: Record<string, OpenAIFunctionParameterProperty>;
90
- required?: string[];
91
- }
92
-
93
- export interface OpenAIFunction {
94
207
  /**
95
- * This is the the name of the function to be called.
96
- *
97
- * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
98
- * @maxLength 64
208
+ * Defines the style for voice settings.
209
+ * @default null
99
210
  */
100
- name: string;
101
- /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
102
- async?: boolean;
103
- /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
104
- description?: string;
211
+ style?: boolean;
105
212
  /**
106
- * These are the parameters the functions accepts, described as a JSON Schema object.
107
- *
108
- * See the [OpenAI guide](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.
109
- *
110
- * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
213
+ * Defines the use speaker boost for voice settings.
214
+ * @default null
111
215
  */
112
- parameters: OpenAIFunctionParameters;
216
+ useSpeakerBoost?: boolean;
113
217
  }
114
218
 
115
219
  export interface OpenAIModel {
116
- /**
117
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
118
- *
119
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
120
- */
220
+ /** This is the provider that will be used for the model. */
121
221
  provider: "openai";
122
222
  /** This is the OpenAI model that will be used. */
123
223
  model: "gpt-4" | "gpt-3.5-turbo";
124
224
  /** This sets the objective and understanding for the assistant. */
125
225
  systemPrompt?: string;
126
226
  /**
127
- * This is the temperature that will be used for OpenAI calls.
227
+ * This is the temperature that will be used for calls. Default is 1.
128
228
  * @min 0
129
229
  * @max 2
130
230
  */
@@ -139,43 +239,62 @@ export interface PlayHTVoice {
139
239
  *
140
240
  * Pro Voices: `11labs`, `playht`, `openai`
141
241
  *
142
- * Basic Voices: `rimeai`, `deepgram`
242
+ * Basic Voices: `rime-ai`, `deepgram`
143
243
  */
144
244
  provider: "playht";
245
+ /** This is the provider-specific ID that will be used. */
246
+ voiceId:
247
+ | "jennifer"
248
+ | "melissa"
249
+ | "will"
250
+ | "chris"
251
+ | "matt"
252
+ | "jack"
253
+ | "ruby"
254
+ | "davis"
255
+ | "donna"
256
+ | "michael"
257
+ | string;
145
258
  /**
146
259
  * This is the speed multiplier that will be used.
147
260
  * @min 0
148
261
  * @max 5
262
+ * @default null
149
263
  */
150
264
  speed?: number;
151
265
  /**
152
266
  * 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
267
  * @min 0.1
154
268
  * @max 2
269
+ * @default null
155
270
  */
156
271
  temperature?: number;
157
- /** An emotion to be applied to the speech. */
272
+ /**
273
+ * An emotion to be applied to the speech.
274
+ * @default null
275
+ */
158
276
  emotion?: "female_happy" | "female_sad" | "female_angry" | "female_fearful" | "female_disgust" | "female_surprised";
159
277
  /**
160
278
  * A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
161
279
  * @min 1
162
280
  * @max 6
281
+ * @default null
163
282
  */
164
283
  voiceGuidance?: number;
165
284
  /**
166
285
  * 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
286
  * @min 1
168
287
  * @max 30
288
+ * @default null
169
289
  */
170
290
  styleGuidance?: number;
171
291
  /**
172
292
  * 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
293
  * @min 1
174
294
  * @max 2
295
+ * @default null
175
296
  */
176
297
  textGuidance?: number;
177
- /** This is the provider-specific ID that will be used. */
178
- voiceId: string;
179
298
  }
180
299
 
181
300
  export interface RimeAIVoice {
@@ -184,16 +303,28 @@ export interface RimeAIVoice {
184
303
  *
185
304
  * Pro Voices: `11labs`, `playht`, `openai`
186
305
  *
187
- * Basic Voices: `rimeai`, `deepgram`
306
+ * Basic Voices: `rime-ai`, `deepgram`
188
307
  */
189
- provider: "rimeai";
308
+ provider: "rime-ai";
309
+ /** This is the provider-specific ID that will be used. */
310
+ voiceId:
311
+ | "kai"
312
+ | "zion"
313
+ | "xavier"
314
+ | "marty"
315
+ | "hudson"
316
+ | "savannah"
317
+ | "colette"
318
+ | "daphne"
319
+ | "aurora"
320
+ | "nova"
321
+ | string;
190
322
  /**
191
323
  * This is the speed multiplier that will be used.
192
324
  * @min 0
325
+ * @default null
193
326
  */
194
327
  speed?: number;
195
- /** This is the provider-specific ID that will be used. */
196
- voiceId: string;
197
328
  }
198
329
 
199
330
  export interface OpenAIVoice {
@@ -202,87 +333,50 @@ export interface OpenAIVoice {
202
333
  *
203
334
  * Pro Voices: `11labs`, `playht`, `openai`
204
335
  *
205
- * Basic Voices: `rimeai`, `deepgram`
336
+ * Basic Voices: `rime-ai`, `deepgram`
206
337
  */
207
338
  provider: "openai";
339
+ /** This is the provider-specific ID that will be used. */
340
+ voiceId: "alloy" | "echo" | "fable" | "onyx" | "nova" | "shimmer" | string;
208
341
  /**
209
342
  * This is the speed multiplier that will be used.
210
343
  * @min 0.25
211
344
  * @max 4
345
+ * @default null
212
346
  */
213
347
  speed?: number;
214
- /** This is the provider-specific ID that will be used. */
215
- voiceId: string;
216
348
  }
217
349
 
218
350
  export interface CreateAssistantDTO {
219
351
  /**
220
352
  * This is the name of the assistant. This is just for your own reference.
221
353
  * @maxLength 100
354
+ * @default null
222
355
  */
223
356
  name?: string;
224
- /** These are the options for the assistant's transcriber. */
357
+ /**
358
+ * These are the options for the assistant's transcriber.
359
+ * @default null
360
+ */
225
361
  transcriber?: DeepgramTranscriber;
226
362
  /** These are the options for the assistant's LLM. */
227
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
363
+ model?:
364
+ | OpenAIModel
365
+ | TogetherAIModel
366
+ | AnyscaleModel
367
+ | OpenRouterModel
368
+ | PerplexityAIModel
369
+ | DeepInfraModel
370
+ | CustomLLMModel;
228
371
  /**
229
372
  * These are the options for the assistant's voice.
230
- * @default "jennifer-playht"
231
- */
232
- voice?:
233
- | "jennifer-playht"
234
- | "melissa-playht"
235
- | "will-playht"
236
- | "chris-playht"
237
- | "matt-playht"
238
- | "jack-playht"
239
- | "ruby-playht"
240
- | "davis-playht"
241
- | "donna-playht"
242
- | "michael-playht"
243
- | "burt-11labs"
244
- | "andrea-11labs"
245
- | "phillip-11labs"
246
- | "steve-11labs"
247
- | "joseph-11labs"
248
- | "myra-11labs"
249
- | "paula-11labs"
250
- | "ryan-11labs"
251
- | "drew-11labs"
252
- | "paul-11labs"
253
- | "mrb-11labs"
254
- | "matilda-11labs"
255
- | "kai-rimeai"
256
- | "zion-rimeai"
257
- | "xavier-rimeai"
258
- | "marty-rimeai"
259
- | "hudson-rimeai"
260
- | "savannah-rimeai"
261
- | "colette-rimeai"
262
- | "daphne-rimeai"
263
- | "aurora-rimeai"
264
- | "nova-rimeai"
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"
278
- | ElevenLabsVoice
279
- | PlayHTVoice
280
- | RimeAIVoice
281
- | DeepgramVoice
282
- | OpenAIVoice;
373
+ * @default {"provider":"playht","voiceId":"jennifer"}
374
+ */
375
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
283
376
  /**
284
377
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
285
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
+ * @default null
286
380
  */
287
381
  language?:
288
382
  | "en"
@@ -303,7 +397,7 @@ export interface CreateAssistantDTO {
303
397
  /** This is the number to forward to if assistant runs into issues. */
304
398
  forwardingPhoneNumber?: string;
305
399
  /**
306
- * This is the first message that the assistant will say.
400
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
307
401
  *
308
402
  * If unspecified, it will wait for the user to speak.
309
403
  * @maxLength 1000
@@ -315,6 +409,7 @@ export interface CreateAssistantDTO {
315
409
  *
316
410
  * If unspecified, it will hang up.
317
411
  * @maxLength 1000
412
+ * @default null
318
413
  */
319
414
  voicemailMessage?: string;
320
415
  /**
@@ -322,88 +417,73 @@ export interface CreateAssistantDTO {
322
417
  *
323
418
  * If unspecified, it will hang up without saying anything.
324
419
  * @maxLength 400
420
+ * @default null
325
421
  */
326
422
  endCallMessage?: string;
327
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
423
+ /**
424
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
425
+ * @default null
426
+ */
328
427
  interruptionsEnabled?: boolean;
329
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
428
+ /**
429
+ * This sets whether the assistant's calls are recorded. Defaults to true.
430
+ * @default null
431
+ */
330
432
  recordingEnabled?: boolean;
331
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
433
+ /**
434
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
435
+ * @default null
436
+ */
332
437
  endCallFunctionEnabled?: boolean;
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. */
438
+ /**
439
+ * This sets whether the assistant will use fillers like Well..., Okay cool..., etc. This will modify your prompt slightly, which could result in differing completions. Defaults to false.
440
+ * @default null
441
+ */
334
442
  fillersEnabled?: boolean;
335
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
443
+ /**
444
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
445
+ * @default null
446
+ */
336
447
  liveTranscriptsEnabled?: boolean;
448
+ /**
449
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
450
+ * @min 10
451
+ * @max 600
452
+ * @default null
453
+ */
454
+ silenceTimeoutSeconds?: number;
337
455
  }
338
456
 
339
457
  export interface Assistant {
340
458
  /**
341
459
  * This is the name of the assistant. This is just for your own reference.
342
460
  * @maxLength 100
461
+ * @default null
343
462
  */
344
463
  name?: string;
345
- /** These are the options for the assistant's transcriber. */
464
+ /**
465
+ * These are the options for the assistant's transcriber.
466
+ * @default null
467
+ */
346
468
  transcriber?: DeepgramTranscriber;
347
469
  /** These are the options for the assistant's LLM. */
348
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
470
+ model?:
471
+ | OpenAIModel
472
+ | TogetherAIModel
473
+ | AnyscaleModel
474
+ | OpenRouterModel
475
+ | PerplexityAIModel
476
+ | DeepInfraModel
477
+ | CustomLLMModel;
349
478
  /**
350
479
  * These are the options for the assistant's voice.
351
- * @default "jennifer-playht"
352
- */
353
- voice?:
354
- | "jennifer-playht"
355
- | "melissa-playht"
356
- | "will-playht"
357
- | "chris-playht"
358
- | "matt-playht"
359
- | "jack-playht"
360
- | "ruby-playht"
361
- | "davis-playht"
362
- | "donna-playht"
363
- | "michael-playht"
364
- | "burt-11labs"
365
- | "andrea-11labs"
366
- | "phillip-11labs"
367
- | "steve-11labs"
368
- | "joseph-11labs"
369
- | "myra-11labs"
370
- | "paula-11labs"
371
- | "ryan-11labs"
372
- | "drew-11labs"
373
- | "paul-11labs"
374
- | "mrb-11labs"
375
- | "matilda-11labs"
376
- | "kai-rimeai"
377
- | "zion-rimeai"
378
- | "xavier-rimeai"
379
- | "marty-rimeai"
380
- | "hudson-rimeai"
381
- | "savannah-rimeai"
382
- | "colette-rimeai"
383
- | "daphne-rimeai"
384
- | "aurora-rimeai"
385
- | "nova-rimeai"
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"
399
- | ElevenLabsVoice
400
- | PlayHTVoice
401
- | RimeAIVoice
402
- | DeepgramVoice
403
- | OpenAIVoice;
480
+ * @default {"provider":"playht","voiceId":"jennifer"}
481
+ */
482
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
404
483
  /**
405
484
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
406
485
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
486
+ * @default null
407
487
  */
408
488
  language?:
409
489
  | "en"
@@ -424,7 +504,7 @@ export interface Assistant {
424
504
  /** This is the number to forward to if assistant runs into issues. */
425
505
  forwardingPhoneNumber?: string;
426
506
  /**
427
- * This is the first message that the assistant will say.
507
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
428
508
  *
429
509
  * If unspecified, it will wait for the user to speak.
430
510
  * @maxLength 1000
@@ -436,6 +516,7 @@ export interface Assistant {
436
516
  *
437
517
  * If unspecified, it will hang up.
438
518
  * @maxLength 1000
519
+ * @default null
439
520
  */
440
521
  voicemailMessage?: string;
441
522
  /**
@@ -443,18 +524,41 @@ export interface Assistant {
443
524
  *
444
525
  * If unspecified, it will hang up without saying anything.
445
526
  * @maxLength 400
527
+ * @default null
446
528
  */
447
529
  endCallMessage?: string;
448
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
530
+ /**
531
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
532
+ * @default null
533
+ */
449
534
  interruptionsEnabled?: boolean;
450
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
535
+ /**
536
+ * This sets whether the assistant's calls are recorded. Defaults to true.
537
+ * @default null
538
+ */
451
539
  recordingEnabled?: boolean;
452
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
540
+ /**
541
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
542
+ * @default null
543
+ */
453
544
  endCallFunctionEnabled?: boolean;
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. */
545
+ /**
546
+ * This sets whether the assistant will use fillers like Well..., Okay cool..., etc. This will modify your prompt slightly, which could result in differing completions. Defaults to false.
547
+ * @default null
548
+ */
455
549
  fillersEnabled?: boolean;
456
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
550
+ /**
551
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
552
+ * @default null
553
+ */
457
554
  liveTranscriptsEnabled?: boolean;
555
+ /**
556
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
557
+ * @min 10
558
+ * @max 600
559
+ * @default null
560
+ */
561
+ silenceTimeoutSeconds?: number;
458
562
  /** This is the unique identifier for the assistant. */
459
563
  id: string;
460
564
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -475,70 +579,32 @@ export interface UpdateAssistantDTO {
475
579
  /**
476
580
  * This is the name of the assistant. This is just for your own reference.
477
581
  * @maxLength 100
582
+ * @default null
478
583
  */
479
584
  name?: string;
480
- /** These are the options for the assistant's transcriber. */
585
+ /**
586
+ * These are the options for the assistant's transcriber.
587
+ * @default null
588
+ */
481
589
  transcriber?: DeepgramTranscriber;
482
590
  /** These are the options for the assistant's LLM. */
483
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
591
+ model?:
592
+ | OpenAIModel
593
+ | TogetherAIModel
594
+ | AnyscaleModel
595
+ | OpenRouterModel
596
+ | PerplexityAIModel
597
+ | DeepInfraModel
598
+ | CustomLLMModel;
484
599
  /**
485
600
  * These are the options for the assistant's voice.
486
- * @default "jennifer-playht"
487
- */
488
- voice?:
489
- | "jennifer-playht"
490
- | "melissa-playht"
491
- | "will-playht"
492
- | "chris-playht"
493
- | "matt-playht"
494
- | "jack-playht"
495
- | "ruby-playht"
496
- | "davis-playht"
497
- | "donna-playht"
498
- | "michael-playht"
499
- | "burt-11labs"
500
- | "andrea-11labs"
501
- | "phillip-11labs"
502
- | "steve-11labs"
503
- | "joseph-11labs"
504
- | "myra-11labs"
505
- | "paula-11labs"
506
- | "ryan-11labs"
507
- | "drew-11labs"
508
- | "paul-11labs"
509
- | "mrb-11labs"
510
- | "matilda-11labs"
511
- | "kai-rimeai"
512
- | "zion-rimeai"
513
- | "xavier-rimeai"
514
- | "marty-rimeai"
515
- | "hudson-rimeai"
516
- | "savannah-rimeai"
517
- | "colette-rimeai"
518
- | "daphne-rimeai"
519
- | "aurora-rimeai"
520
- | "nova-rimeai"
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"
534
- | ElevenLabsVoice
535
- | PlayHTVoice
536
- | RimeAIVoice
537
- | DeepgramVoice
538
- | OpenAIVoice;
601
+ * @default {"provider":"playht","voiceId":"jennifer"}
602
+ */
603
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
539
604
  /**
540
605
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
541
606
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
607
+ * @default null
542
608
  */
543
609
  language?:
544
610
  | "en"
@@ -559,7 +625,7 @@ export interface UpdateAssistantDTO {
559
625
  /** This is the number to forward to if assistant runs into issues. */
560
626
  forwardingPhoneNumber?: string;
561
627
  /**
562
- * This is the first message that the assistant will say.
628
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
563
629
  *
564
630
  * If unspecified, it will wait for the user to speak.
565
631
  * @maxLength 1000
@@ -571,6 +637,7 @@ export interface UpdateAssistantDTO {
571
637
  *
572
638
  * If unspecified, it will hang up.
573
639
  * @maxLength 1000
640
+ * @default null
574
641
  */
575
642
  voicemailMessage?: string;
576
643
  /**
@@ -578,18 +645,41 @@ export interface UpdateAssistantDTO {
578
645
  *
579
646
  * If unspecified, it will hang up without saying anything.
580
647
  * @maxLength 400
648
+ * @default null
581
649
  */
582
650
  endCallMessage?: string;
583
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
651
+ /**
652
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
653
+ * @default null
654
+ */
584
655
  interruptionsEnabled?: boolean;
585
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
656
+ /**
657
+ * This sets whether the assistant's calls are recorded. Defaults to true.
658
+ * @default null
659
+ */
586
660
  recordingEnabled?: boolean;
587
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
661
+ /**
662
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
663
+ * @default null
664
+ */
588
665
  endCallFunctionEnabled?: boolean;
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. */
666
+ /**
667
+ * This sets whether the assistant will use fillers like Well..., Okay cool..., etc. This will modify your prompt slightly, which could result in differing completions. Defaults to false.
668
+ * @default null
669
+ */
590
670
  fillersEnabled?: boolean;
591
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
671
+ /**
672
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
673
+ * @default null
674
+ */
592
675
  liveTranscriptsEnabled?: boolean;
676
+ /**
677
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
678
+ * @min 10
679
+ * @max 600
680
+ * @default null
681
+ */
682
+ silenceTimeoutSeconds?: number;
593
683
  }
594
684
 
595
685
  export interface CreateCustomerDTO {
@@ -634,13 +724,27 @@ export interface Call {
634
724
  | "assistant-forwarded-call"
635
725
  | "assistant-join-timed-out"
636
726
  | "assistant-not-found"
637
- | "manually-canceled"
638
727
  | "customer-busy"
639
728
  | "customer-ended-call"
640
729
  | "customer-did-not-answer"
641
730
  | "db-error"
642
731
  | "exceeded-max-duration"
732
+ | "manually-canceled"
643
733
  | "no-server-available"
734
+ | "pipeline-error-custom-llm-response-was-invalid"
735
+ | "pipeline-error-custom-llm-request-failed"
736
+ | "pipeline-error-extra-function-failed"
737
+ | "pipeline-error-first-message-failed"
738
+ | "pipeline-error-function-filler-failed"
739
+ | "pipeline-error-function-failed"
740
+ | "pipeline-error-llm-failed"
741
+ | "pipeline-error-openai-voice-failed"
742
+ | "pipeline-error-deepgram-transcriber-failed"
743
+ | "pipeline-error-deepgram-voice-failed"
744
+ | "pipeline-error-eleven-labs-voice-failed"
745
+ | "pipeline-error-eleven-labs-voice-not-found"
746
+ | "pipeline-error-playht-voice-failed"
747
+ | "pipeline-error-rime-ai-voice-failed"
644
748
  | "server-shutdown"
645
749
  | "silence-timed-out"
646
750
  | "twilio-failed-to-connect-call"
@@ -802,10 +906,10 @@ export interface DeepgramCredential {
802
906
  updatedAt: string;
803
907
  }
804
908
 
805
- export interface AzureOpenAICredential {
806
- provider: "azure-openai";
909
+ export interface ElevenLabsCredential {
910
+ provider: "11labs";
807
911
  /** This is not returned in the API. */
808
- openAIKey: string;
912
+ apiKey: string;
809
913
  /** This is the unique identifier for the credential. */
810
914
  id: string;
811
915
  /** This is the unique identifier for the org that this credential belongs to. */
@@ -820,11 +924,10 @@ export interface AzureOpenAICredential {
820
924
  * @format date-time
821
925
  */
822
926
  updatedAt: string;
823
- openAIEndpoint: string;
824
927
  }
825
928
 
826
- export interface ElevenLabsCredential {
827
- provider: "11labs";
929
+ export interface PlayHTCredential {
930
+ provider: "playht";
828
931
  /** This is not returned in the API. */
829
932
  apiKey: string;
830
933
  /** This is the unique identifier for the credential. */
@@ -841,10 +944,11 @@ export interface ElevenLabsCredential {
841
944
  * @format date-time
842
945
  */
843
946
  updatedAt: string;
947
+ userId: string;
844
948
  }
845
949
 
846
- export interface PlayHTCredential {
847
- provider: "playht";
950
+ export interface RimeAICredential {
951
+ provider: "rime-ai";
848
952
  /** This is not returned in the API. */
849
953
  apiKey: string;
850
954
  /** This is the unique identifier for the credential. */
@@ -861,11 +965,130 @@ export interface PlayHTCredential {
861
965
  * @format date-time
862
966
  */
863
967
  updatedAt: string;
864
- userId: string;
865
968
  }
866
969
 
867
- export interface RimeAICredential {
868
- provider: "rimeai";
970
+ export interface OpenAICredential {
971
+ provider: "openai";
972
+ /** This is not returned in the API. */
973
+ apiKey: string;
974
+ /** This is the unique identifier for the credential. */
975
+ id: string;
976
+ /** This is the unique identifier for the org that this credential belongs to. */
977
+ orgId: string;
978
+ /**
979
+ * This is the ISO 8601 date-time string of when the credential was created.
980
+ * @format date-time
981
+ */
982
+ createdAt: string;
983
+ /**
984
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
985
+ * @format date-time
986
+ */
987
+ updatedAt: string;
988
+ }
989
+
990
+ export interface TogetherAICredential {
991
+ provider: "together-ai";
992
+ /** This is not returned in the API. */
993
+ apiKey: string;
994
+ /** This is the unique identifier for the credential. */
995
+ id: string;
996
+ /** This is the unique identifier for the org that this credential belongs to. */
997
+ orgId: string;
998
+ /**
999
+ * This is the ISO 8601 date-time string of when the credential was created.
1000
+ * @format date-time
1001
+ */
1002
+ createdAt: string;
1003
+ /**
1004
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1005
+ * @format date-time
1006
+ */
1007
+ updatedAt: string;
1008
+ }
1009
+
1010
+ export interface AnyscaleCredential {
1011
+ provider: "anyscale";
1012
+ /** This is not returned in the API. */
1013
+ apiKey: string;
1014
+ /** This is the unique identifier for the credential. */
1015
+ id: string;
1016
+ /** This is the unique identifier for the org that this credential belongs to. */
1017
+ orgId: string;
1018
+ /**
1019
+ * This is the ISO 8601 date-time string of when the credential was created.
1020
+ * @format date-time
1021
+ */
1022
+ createdAt: string;
1023
+ /**
1024
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1025
+ * @format date-time
1026
+ */
1027
+ updatedAt: string;
1028
+ }
1029
+
1030
+ export interface OpenRouterCredential {
1031
+ provider: "openrouter";
1032
+ /** This is not returned in the API. */
1033
+ apiKey: string;
1034
+ /** This is the unique identifier for the credential. */
1035
+ id: string;
1036
+ /** This is the unique identifier for the org that this credential belongs to. */
1037
+ orgId: string;
1038
+ /**
1039
+ * This is the ISO 8601 date-time string of when the credential was created.
1040
+ * @format date-time
1041
+ */
1042
+ createdAt: string;
1043
+ /**
1044
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1045
+ * @format date-time
1046
+ */
1047
+ updatedAt: string;
1048
+ }
1049
+
1050
+ export interface PerplexityAICredential {
1051
+ provider: "perplexity-ai";
1052
+ /** This is not returned in the API. */
1053
+ apiKey: string;
1054
+ /** This is the unique identifier for the credential. */
1055
+ id: string;
1056
+ /** This is the unique identifier for the org that this credential belongs to. */
1057
+ orgId: string;
1058
+ /**
1059
+ * This is the ISO 8601 date-time string of when the credential was created.
1060
+ * @format date-time
1061
+ */
1062
+ createdAt: string;
1063
+ /**
1064
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1065
+ * @format date-time
1066
+ */
1067
+ updatedAt: string;
1068
+ }
1069
+
1070
+ export interface DeepInfraCredential {
1071
+ provider: "deepinfra";
1072
+ /** This is not returned in the API. */
1073
+ apiKey: string;
1074
+ /** This is the unique identifier for the credential. */
1075
+ id: string;
1076
+ /** This is the unique identifier for the org that this credential belongs to. */
1077
+ orgId: string;
1078
+ /**
1079
+ * This is the ISO 8601 date-time string of when the credential was created.
1080
+ * @format date-time
1081
+ */
1082
+ createdAt: string;
1083
+ /**
1084
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1085
+ * @format date-time
1086
+ */
1087
+ updatedAt: string;
1088
+ }
1089
+
1090
+ export interface CustomLLMCredential {
1091
+ provider: "custom-llm";
869
1092
  /** This is not returned in the API. */
870
1093
  apiKey: string;
871
1094
  /** This is the unique identifier for the credential. */
@@ -897,11 +1120,46 @@ export interface CreateDeepgramCredentialDTO {
897
1120
  apiKey: string;
898
1121
  }
899
1122
 
900
- export interface CreateAzureOpenAICredentialDTO {
901
- provider: "azure-openai";
1123
+ export interface CreateOpenAICredentialDTO {
1124
+ provider: "openai";
902
1125
  /** This is not returned in the API. */
903
- openAIKey: string;
904
- openAIEndpoint: string;
1126
+ apiKey: string;
1127
+ }
1128
+
1129
+ export interface CreateTogetherAICredentialDTO {
1130
+ provider: "together-ai";
1131
+ /** This is not returned in the API. */
1132
+ apiKey: string;
1133
+ }
1134
+
1135
+ export interface CreateAnyscaleCredentialDTO {
1136
+ provider: "anyscale";
1137
+ /** This is not returned in the API. */
1138
+ apiKey: string;
1139
+ }
1140
+
1141
+ export interface CreateOpenRouterCredentialDTO {
1142
+ provider: "openrouter";
1143
+ /** This is not returned in the API. */
1144
+ apiKey: string;
1145
+ }
1146
+
1147
+ export interface CreatePerplexityAICredentialDTO {
1148
+ provider: "perplexity-ai";
1149
+ /** This is not returned in the API. */
1150
+ apiKey: string;
1151
+ }
1152
+
1153
+ export interface CreateDeepInfraCredentialDTO {
1154
+ provider: "deepinfra";
1155
+ /** This is not returned in the API. */
1156
+ apiKey: string;
1157
+ }
1158
+
1159
+ export interface CreateCustomLLMCredentialDTO {
1160
+ provider: "custom-llm";
1161
+ /** This is not returned in the API. */
1162
+ apiKey: string;
905
1163
  }
906
1164
 
907
1165
  export interface CreateElevenLabsCredentialDTO {
@@ -918,7 +1176,7 @@ export interface CreatePlayHTCredentialDTO {
918
1176
  }
919
1177
 
920
1178
  export interface CreateRimeAICredentialDTO {
921
- provider: "rimeai";
1179
+ provider: "rime-ai";
922
1180
  /** This is not returned in the API. */
923
1181
  apiKey: string;
924
1182
  }
@@ -936,11 +1194,46 @@ export interface UpdateDeepgramCredentialDTO {
936
1194
  apiKey: string;
937
1195
  }
938
1196
 
939
- export interface UpdateAzureOpenAICredentialDTO {
940
- provider: "azure-openai";
1197
+ export interface UpdateOpenAICredentialDTO {
1198
+ provider: "openai";
1199
+ /** This is not returned in the API. */
1200
+ apiKey: string;
1201
+ }
1202
+
1203
+ export interface UpdateTogetherAICredentialDTO {
1204
+ provider: "together-ai";
1205
+ /** This is not returned in the API. */
1206
+ apiKey: string;
1207
+ }
1208
+
1209
+ export interface UpdateAnyscaleCredentialDTO {
1210
+ provider: "anyscale";
1211
+ /** This is not returned in the API. */
1212
+ apiKey: string;
1213
+ }
1214
+
1215
+ export interface UpdateOpenRouterCredentialDTO {
1216
+ provider: "openrouter";
1217
+ /** This is not returned in the API. */
1218
+ apiKey: string;
1219
+ }
1220
+
1221
+ export interface UpdatePerplexityAICredentialDTO {
1222
+ provider: "perplexity-ai";
1223
+ /** This is not returned in the API. */
1224
+ apiKey: string;
1225
+ }
1226
+
1227
+ export interface UpdateDeepInfraCredentialDTO {
1228
+ provider: "deepinfra";
941
1229
  /** This is not returned in the API. */
942
- openAIKey: string;
943
- openAIEndpoint: string;
1230
+ apiKey: string;
1231
+ }
1232
+
1233
+ export interface UpdateCustomLLMCredentialDTO {
1234
+ provider: "custom-llm";
1235
+ /** This is not returned in the API. */
1236
+ apiKey: string;
944
1237
  }
945
1238
 
946
1239
  export interface UpdateElevenLabsCredentialDTO {
@@ -957,7 +1250,7 @@ export interface UpdatePlayHTCredentialDTO {
957
1250
  }
958
1251
 
959
1252
  export interface UpdateRimeAICredentialDTO {
960
- provider: "rimeai";
1253
+ provider: "rime-ai";
961
1254
  /** This is not returned in the API. */
962
1255
  apiKey: string;
963
1256
  }
@@ -1457,8 +1750,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1457
1750
  provider: "deepgram";
1458
1751
  } & CreateDeepgramCredentialDTO)
1459
1752
  | ({
1460
- provider: "azure-openai";
1461
- } & CreateAzureOpenAICredentialDTO)
1753
+ provider: "openai";
1754
+ } & CreateOpenAICredentialDTO)
1755
+ | ({
1756
+ provider: "together-ai";
1757
+ } & CreateTogetherAICredentialDTO)
1758
+ | ({
1759
+ provider: "anyscale";
1760
+ } & CreateAnyscaleCredentialDTO)
1761
+ | ({
1762
+ provider: "openrouter";
1763
+ } & CreateOpenRouterCredentialDTO)
1764
+ | ({
1765
+ provider: "perplexity-ai";
1766
+ } & CreatePerplexityAICredentialDTO)
1767
+ | ({
1768
+ provider: "deepinfra";
1769
+ } & CreateDeepInfraCredentialDTO)
1770
+ | ({
1771
+ provider: "custom-llm";
1772
+ } & CreateCustomLLMCredentialDTO)
1462
1773
  | ({
1463
1774
  provider: "11labs";
1464
1775
  } & CreateElevenLabsCredentialDTO)
@@ -1466,7 +1777,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1466
1777
  provider: "playht";
1467
1778
  } & CreatePlayHTCredentialDTO)
1468
1779
  | ({
1469
- provider: "rimeai";
1780
+ provider: "rime-ai";
1470
1781
  } & CreateRimeAICredentialDTO),
1471
1782
  params: RequestParams = {},
1472
1783
  ) =>
@@ -1478,8 +1789,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1478
1789
  provider: "deepgram";
1479
1790
  } & DeepgramCredential)
1480
1791
  | ({
1481
- provider: "azure-openai";
1482
- } & AzureOpenAICredential)
1792
+ provider: "openai";
1793
+ } & OpenAICredential)
1794
+ | ({
1795
+ provider: "together-ai";
1796
+ } & TogetherAICredential)
1797
+ | ({
1798
+ provider: "anyscale";
1799
+ } & AnyscaleCredential)
1800
+ | ({
1801
+ provider: "openrouter";
1802
+ } & OpenRouterCredential)
1803
+ | ({
1804
+ provider: "perplexity-ai";
1805
+ } & PerplexityAICredential)
1806
+ | ({
1807
+ provider: "deepinfra";
1808
+ } & DeepInfraCredential)
1809
+ | ({
1810
+ provider: "custom-llm";
1811
+ } & CustomLLMCredential)
1483
1812
  | ({
1484
1813
  provider: "11labs";
1485
1814
  } & ElevenLabsCredential)
@@ -1487,7 +1816,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1487
1816
  provider: "playht";
1488
1817
  } & PlayHTCredential)
1489
1818
  | ({
1490
- provider: "rimeai";
1819
+ provider: "rime-ai";
1491
1820
  } & RimeAICredential),
1492
1821
  any
1493
1822
  >({
@@ -1519,8 +1848,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1519
1848
  provider: "deepgram";
1520
1849
  } & DeepgramCredential)
1521
1850
  | ({
1522
- provider: "azure-openai";
1523
- } & AzureOpenAICredential)
1851
+ provider: "openai";
1852
+ } & OpenAICredential)
1853
+ | ({
1854
+ provider: "together-ai";
1855
+ } & TogetherAICredential)
1856
+ | ({
1857
+ provider: "anyscale";
1858
+ } & AnyscaleCredential)
1859
+ | ({
1860
+ provider: "openrouter";
1861
+ } & OpenRouterCredential)
1862
+ | ({
1863
+ provider: "perplexity-ai";
1864
+ } & PerplexityAICredential)
1865
+ | ({
1866
+ provider: "deepinfra";
1867
+ } & DeepInfraCredential)
1868
+ | ({
1869
+ provider: "custom-llm";
1870
+ } & CustomLLMCredential)
1524
1871
  | ({
1525
1872
  provider: "11labs";
1526
1873
  } & ElevenLabsCredential)
@@ -1528,7 +1875,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1528
1875
  provider: "playht";
1529
1876
  } & PlayHTCredential)
1530
1877
  | ({
1531
- provider: "rimeai";
1878
+ provider: "rime-ai";
1532
1879
  } & RimeAICredential)
1533
1880
  )[],
1534
1881
  any
@@ -1558,8 +1905,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1558
1905
  provider: "deepgram";
1559
1906
  } & DeepgramCredential)
1560
1907
  | ({
1561
- provider: "azure-openai";
1562
- } & AzureOpenAICredential)
1908
+ provider: "openai";
1909
+ } & OpenAICredential)
1910
+ | ({
1911
+ provider: "together-ai";
1912
+ } & TogetherAICredential)
1913
+ | ({
1914
+ provider: "anyscale";
1915
+ } & AnyscaleCredential)
1916
+ | ({
1917
+ provider: "openrouter";
1918
+ } & OpenRouterCredential)
1919
+ | ({
1920
+ provider: "perplexity-ai";
1921
+ } & PerplexityAICredential)
1922
+ | ({
1923
+ provider: "deepinfra";
1924
+ } & DeepInfraCredential)
1925
+ | ({
1926
+ provider: "custom-llm";
1927
+ } & CustomLLMCredential)
1563
1928
  | ({
1564
1929
  provider: "11labs";
1565
1930
  } & ElevenLabsCredential)
@@ -1567,7 +1932,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1567
1932
  provider: "playht";
1568
1933
  } & PlayHTCredential)
1569
1934
  | ({
1570
- provider: "rimeai";
1935
+ provider: "rime-ai";
1571
1936
  } & RimeAICredential),
1572
1937
  any
1573
1938
  >({
@@ -1597,8 +1962,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1597
1962
  provider: "deepgram";
1598
1963
  } & UpdateDeepgramCredentialDTO)
1599
1964
  | ({
1600
- provider: "azure-openai";
1601
- } & UpdateAzureOpenAICredentialDTO)
1965
+ provider: "openai";
1966
+ } & UpdateOpenAICredentialDTO)
1967
+ | ({
1968
+ provider: "together-ai";
1969
+ } & UpdateTogetherAICredentialDTO)
1970
+ | ({
1971
+ provider: "anyscale";
1972
+ } & UpdateAnyscaleCredentialDTO)
1973
+ | ({
1974
+ provider: "openrouter";
1975
+ } & UpdateOpenRouterCredentialDTO)
1976
+ | ({
1977
+ provider: "perplexity-ai";
1978
+ } & UpdatePerplexityAICredentialDTO)
1979
+ | ({
1980
+ provider: "deepinfra";
1981
+ } & UpdateDeepInfraCredentialDTO)
1982
+ | ({
1983
+ provider: "custom-llm";
1984
+ } & UpdateCustomLLMCredentialDTO)
1602
1985
  | ({
1603
1986
  provider: "11labs";
1604
1987
  } & UpdateElevenLabsCredentialDTO)
@@ -1606,7 +1989,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1606
1989
  provider: "playht";
1607
1990
  } & UpdatePlayHTCredentialDTO)
1608
1991
  | ({
1609
- provider: "rimeai";
1992
+ provider: "rime-ai";
1610
1993
  } & UpdateRimeAICredentialDTO),
1611
1994
  params: RequestParams = {},
1612
1995
  ) =>
@@ -1618,8 +2001,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1618
2001
  provider: "deepgram";
1619
2002
  } & DeepgramCredential)
1620
2003
  | ({
1621
- provider: "azure-openai";
1622
- } & AzureOpenAICredential)
2004
+ provider: "openai";
2005
+ } & OpenAICredential)
2006
+ | ({
2007
+ provider: "together-ai";
2008
+ } & TogetherAICredential)
2009
+ | ({
2010
+ provider: "anyscale";
2011
+ } & AnyscaleCredential)
2012
+ | ({
2013
+ provider: "openrouter";
2014
+ } & OpenRouterCredential)
2015
+ | ({
2016
+ provider: "perplexity-ai";
2017
+ } & PerplexityAICredential)
2018
+ | ({
2019
+ provider: "deepinfra";
2020
+ } & DeepInfraCredential)
2021
+ | ({
2022
+ provider: "custom-llm";
2023
+ } & CustomLLMCredential)
1623
2024
  | ({
1624
2025
  provider: "11labs";
1625
2026
  } & ElevenLabsCredential)
@@ -1627,7 +2028,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1627
2028
  provider: "playht";
1628
2029
  } & PlayHTCredential)
1629
2030
  | ({
1630
- provider: "rimeai";
2031
+ provider: "rime-ai";
1631
2032
  } & RimeAICredential),
1632
2033
  any
1633
2034
  >({
@@ -1658,8 +2059,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1658
2059
  provider: "deepgram";
1659
2060
  } & DeepgramCredential)
1660
2061
  | ({
1661
- provider: "azure-openai";
1662
- } & AzureOpenAICredential)
2062
+ provider: "openai";
2063
+ } & OpenAICredential)
2064
+ | ({
2065
+ provider: "together-ai";
2066
+ } & TogetherAICredential)
2067
+ | ({
2068
+ provider: "anyscale";
2069
+ } & AnyscaleCredential)
2070
+ | ({
2071
+ provider: "openrouter";
2072
+ } & OpenRouterCredential)
2073
+ | ({
2074
+ provider: "perplexity-ai";
2075
+ } & PerplexityAICredential)
2076
+ | ({
2077
+ provider: "deepinfra";
2078
+ } & DeepInfraCredential)
2079
+ | ({
2080
+ provider: "custom-llm";
2081
+ } & CustomLLMCredential)
1663
2082
  | ({
1664
2083
  provider: "11labs";
1665
2084
  } & ElevenLabsCredential)
@@ -1667,7 +2086,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1667
2086
  provider: "playht";
1668
2087
  } & PlayHTCredential)
1669
2088
  | ({
1670
- provider: "rimeai";
2089
+ provider: "rime-ai";
1671
2090
  } & RimeAICredential),
1672
2091
  any
1673
2092
  >({