@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/dist/api.d.ts CHANGED
@@ -4,23 +4,125 @@ export interface DeepgramVoice {
4
4
  *
5
5
  * Pro Voices: `11labs`, `playht`, `openai`
6
6
  *
7
- * Basic Voices: `rimeai`, `deepgram`
7
+ * Basic Voices: `rime-ai`, `deepgram`
8
8
  */
9
9
  provider: "deepgram";
10
10
  /** This is the provider-specific ID that will be used. */
11
- voiceId: string;
11
+ voiceId: "aurora" | "asteria" | "artemis" | "andromeda" | "stella" | "orion" | "atlas" | string;
12
12
  }
13
- export interface CustomModel {
13
+ export interface OpenAIFunction {
14
+ /**
15
+ * This is the the name of the function to be called.
16
+ *
17
+ * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
18
+ * @maxLength 64
19
+ */
20
+ name: string;
21
+ /** 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. */
22
+ async?: boolean;
23
+ /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
24
+ description?: string;
14
25
  /**
15
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
26
+ * These are the parameters the functions accepts, described as a JSON Schema object.
27
+ *
28
+ * 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.
16
29
  *
17
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
30
+ * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
31
+ */
32
+ parameters: object;
33
+ }
34
+ export interface TogetherAIModel {
35
+ provider: "together-ai";
36
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
37
+ model: string;
38
+ /** This sets the objective and understanding for the assistant. */
39
+ systemPrompt?: string;
40
+ /**
41
+ * This is the temperature that will be used for calls. Default is 1.
42
+ * @min 0
43
+ * @max 2
44
+ */
45
+ temperature?: number;
46
+ /** These are the functions that the assistant can execute during the call. */
47
+ functions?: OpenAIFunction[];
48
+ }
49
+ export interface AnyscaleModel {
50
+ provider: "anyscale";
51
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
52
+ model: string;
53
+ /** This sets the objective and understanding for the assistant. */
54
+ systemPrompt?: string;
55
+ /**
56
+ * This is the temperature that will be used for calls. Default is 1.
57
+ * @min 0
58
+ * @max 2
18
59
  */
19
- provider: "custom";
20
- /** These is the URL we'll POST during the conversation. */
60
+ temperature?: number;
61
+ /** These are the functions that the assistant can execute during the call. */
62
+ functions?: OpenAIFunction[];
63
+ }
64
+ export interface OpenRouterModel {
65
+ provider: "openrouter";
66
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
67
+ model: string;
68
+ /** This sets the objective and understanding for the assistant. */
69
+ systemPrompt?: string;
70
+ /**
71
+ * This is the temperature that will be used for calls. Default is 1.
72
+ * @min 0
73
+ * @max 2
74
+ */
75
+ temperature?: number;
76
+ /** These are the functions that the assistant can execute during the call. */
77
+ functions?: OpenAIFunction[];
78
+ }
79
+ export interface PerplexityAIModel {
80
+ provider: "perplexity-ai";
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
+ export interface DeepInfraModel {
95
+ provider: "deepinfra";
96
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
97
+ model: string;
98
+ /** This sets the objective and understanding for the assistant. */
99
+ systemPrompt?: string;
100
+ /**
101
+ * This is the temperature that will be used for calls. Default is 1.
102
+ * @min 0
103
+ * @max 2
104
+ */
105
+ temperature?: number;
106
+ /** These are the functions that the assistant can execute during the call. */
107
+ functions?: OpenAIFunction[];
108
+ }
109
+ export interface CustomLLMModel {
110
+ /** 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. */
111
+ provider: "custom-llm";
112
+ /** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */
21
113
  url: string;
114
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
115
+ model: string;
22
116
  /** This sets the objective and understanding for the assistant. */
23
117
  systemPrompt?: string;
118
+ /**
119
+ * This is the temperature that will be used for calls. Default is 1.
120
+ * @min 0
121
+ * @max 2
122
+ */
123
+ temperature?: number;
124
+ /** These are the functions that the assistant can execute during the call. */
125
+ functions?: OpenAIFunction[];
24
126
  }
25
127
  export interface DeepgramTranscriber {
26
128
  /** This is the transcription provider that will be used. Currently, only Deepgram is supported. */
@@ -36,64 +138,45 @@ export interface ElevenLabsVoice {
36
138
  *
37
139
  * Pro Voices: `11labs`, `playht`
38
140
  *
39
- * Basic Voices: `rimeai`, `deepgram`
141
+ * Basic Voices: `rime-ai`, `deepgram`
40
142
  */
41
143
  provider: "11labs";
42
- /** Defines the stability for voice settings. */
144
+ /** This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library. */
145
+ voiceId: "burt" | "andrea" | "phillip" | "steve" | "joseph" | "myra" | "paula" | "ryan" | "drew" | "paul" | "mrb" | "matilda" | "mark" | string;
146
+ /**
147
+ * Defines the stability for voice settings.
148
+ * @min 0
149
+ * @max 1
150
+ * @default null
151
+ */
43
152
  stability?: number;
44
- /** Defines the similarity boost for voice settings. */
153
+ /**
154
+ * Defines the similarity boost for voice settings.
155
+ * @min 0
156
+ * @max 1
157
+ * @default null
158
+ */
45
159
  similarityBoost?: number;
46
- /** Defines the style for voice settings. */
47
- style?: boolean;
48
- /** Defines the use speaker boost for voice settings. */
49
- useSpeakerBoost?: boolean;
50
- /** This is the provider-specific ID that will be used. */
51
- voiceId: string;
52
- }
53
- export interface OpenAIFunctionParameterProperty {
54
- type: "string" | "number" | "boolean";
55
- enum?: string[];
56
- description?: string;
57
- }
58
- export interface OpenAIFunctionParameters {
59
- type: "object";
60
- properties: Record<string, OpenAIFunctionParameterProperty>;
61
- required?: string[];
62
- }
63
- export interface OpenAIFunction {
64
160
  /**
65
- * This is the the name of the function to be called.
66
- *
67
- * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
68
- * @maxLength 64
161
+ * Defines the style for voice settings.
162
+ * @default null
69
163
  */
70
- name: string;
71
- /** 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. */
72
- async?: boolean;
73
- /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
74
- description?: string;
164
+ style?: boolean;
75
165
  /**
76
- * These are the parameters the functions accepts, described as a JSON Schema object.
77
- *
78
- * 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.
79
- *
80
- * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
166
+ * Defines the use speaker boost for voice settings.
167
+ * @default null
81
168
  */
82
- parameters: OpenAIFunctionParameters;
169
+ useSpeakerBoost?: boolean;
83
170
  }
84
171
  export interface OpenAIModel {
85
- /**
86
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
87
- *
88
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
89
- */
172
+ /** This is the provider that will be used for the model. */
90
173
  provider: "openai";
91
174
  /** This is the OpenAI model that will be used. */
92
175
  model: "gpt-4" | "gpt-3.5-turbo";
93
176
  /** This sets the objective and understanding for the assistant. */
94
177
  systemPrompt?: string;
95
178
  /**
96
- * This is the temperature that will be used for OpenAI calls.
179
+ * This is the temperature that will be used for calls. Default is 1.
97
180
  * @min 0
98
181
  * @max 2
99
182
  */
@@ -107,43 +190,51 @@ export interface PlayHTVoice {
107
190
  *
108
191
  * Pro Voices: `11labs`, `playht`, `openai`
109
192
  *
110
- * Basic Voices: `rimeai`, `deepgram`
193
+ * Basic Voices: `rime-ai`, `deepgram`
111
194
  */
112
195
  provider: "playht";
196
+ /** This is the provider-specific ID that will be used. */
197
+ voiceId: "jennifer" | "melissa" | "will" | "chris" | "matt" | "jack" | "ruby" | "davis" | "donna" | "michael" | string;
113
198
  /**
114
199
  * This is the speed multiplier that will be used.
115
200
  * @min 0
116
201
  * @max 5
202
+ * @default null
117
203
  */
118
204
  speed?: number;
119
205
  /**
120
206
  * 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
207
  * @min 0.1
122
208
  * @max 2
209
+ * @default null
123
210
  */
124
211
  temperature?: number;
125
- /** An emotion to be applied to the speech. */
212
+ /**
213
+ * An emotion to be applied to the speech.
214
+ * @default null
215
+ */
126
216
  emotion?: "female_happy" | "female_sad" | "female_angry" | "female_fearful" | "female_disgust" | "female_surprised";
127
217
  /**
128
218
  * A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
129
219
  * @min 1
130
220
  * @max 6
221
+ * @default null
131
222
  */
132
223
  voiceGuidance?: number;
133
224
  /**
134
225
  * 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
226
  * @min 1
136
227
  * @max 30
228
+ * @default null
137
229
  */
138
230
  styleGuidance?: number;
139
231
  /**
140
232
  * 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
233
  * @min 1
142
234
  * @max 2
235
+ * @default null
143
236
  */
144
237
  textGuidance?: number;
145
- /** This is the provider-specific ID that will be used. */
146
- voiceId: string;
147
238
  }
148
239
  export interface RimeAIVoice {
149
240
  /**
@@ -151,16 +242,17 @@ export interface RimeAIVoice {
151
242
  *
152
243
  * Pro Voices: `11labs`, `playht`, `openai`
153
244
  *
154
- * Basic Voices: `rimeai`, `deepgram`
245
+ * Basic Voices: `rime-ai`, `deepgram`
155
246
  */
156
- provider: "rimeai";
247
+ provider: "rime-ai";
248
+ /** This is the provider-specific ID that will be used. */
249
+ voiceId: "kai" | "zion" | "xavier" | "marty" | "hudson" | "savannah" | "colette" | "daphne" | "aurora" | "nova" | string;
157
250
  /**
158
251
  * This is the speed multiplier that will be used.
159
252
  * @min 0
253
+ * @default null
160
254
  */
161
255
  speed?: number;
162
- /** This is the provider-specific ID that will be used. */
163
- voiceId: string;
164
256
  }
165
257
  export interface OpenAIVoice {
166
258
  /**
@@ -168,42 +260,48 @@ export interface OpenAIVoice {
168
260
  *
169
261
  * Pro Voices: `11labs`, `playht`, `openai`
170
262
  *
171
- * Basic Voices: `rimeai`, `deepgram`
263
+ * Basic Voices: `rime-ai`, `deepgram`
172
264
  */
173
265
  provider: "openai";
266
+ /** This is the provider-specific ID that will be used. */
267
+ voiceId: "alloy" | "echo" | "fable" | "onyx" | "nova" | "shimmer" | string;
174
268
  /**
175
269
  * This is the speed multiplier that will be used.
176
270
  * @min 0.25
177
271
  * @max 4
272
+ * @default null
178
273
  */
179
274
  speed?: number;
180
- /** This is the provider-specific ID that will be used. */
181
- voiceId: string;
182
275
  }
183
276
  export interface CreateAssistantDTO {
184
277
  /**
185
278
  * This is the name of the assistant. This is just for your own reference.
186
279
  * @maxLength 100
280
+ * @default null
187
281
  */
188
282
  name?: string;
189
- /** These are the options for the assistant's transcriber. */
283
+ /**
284
+ * These are the options for the assistant's transcriber.
285
+ * @default null
286
+ */
190
287
  transcriber?: DeepgramTranscriber;
191
288
  /** These are the options for the assistant's LLM. */
192
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
289
+ model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | CustomLLMModel;
193
290
  /**
194
291
  * These are the options for the assistant's voice.
195
- * @default "jennifer-playht"
292
+ * @default {"provider":"playht","voiceId":"jennifer"}
196
293
  */
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;
294
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
198
295
  /**
199
296
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
200
297
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
298
+ * @default null
201
299
  */
202
300
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
203
301
  /** This is the number to forward to if assistant runs into issues. */
204
302
  forwardingPhoneNumber?: string;
205
303
  /**
206
- * This is the first message that the assistant will say.
304
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
207
305
  *
208
306
  * If unspecified, it will wait for the user to speak.
209
307
  * @maxLength 1000
@@ -215,6 +313,7 @@ export interface CreateAssistantDTO {
215
313
  *
216
314
  * If unspecified, it will hang up.
217
315
  * @maxLength 1000
316
+ * @default null
218
317
  */
219
318
  voicemailMessage?: string;
220
319
  /**
@@ -222,43 +321,71 @@ export interface CreateAssistantDTO {
222
321
  *
223
322
  * If unspecified, it will hang up without saying anything.
224
323
  * @maxLength 400
324
+ * @default null
225
325
  */
226
326
  endCallMessage?: string;
227
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
327
+ /**
328
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
329
+ * @default null
330
+ */
228
331
  interruptionsEnabled?: boolean;
229
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
332
+ /**
333
+ * This sets whether the assistant's calls are recorded. Defaults to true.
334
+ * @default null
335
+ */
230
336
  recordingEnabled?: boolean;
231
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
337
+ /**
338
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
339
+ * @default null
340
+ */
232
341
  endCallFunctionEnabled?: boolean;
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. */
342
+ /**
343
+ * 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.
344
+ * @default null
345
+ */
234
346
  fillersEnabled?: boolean;
235
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
347
+ /**
348
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
349
+ * @default null
350
+ */
236
351
  liveTranscriptsEnabled?: boolean;
352
+ /**
353
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
354
+ * @min 10
355
+ * @max 600
356
+ * @default null
357
+ */
358
+ silenceTimeoutSeconds?: number;
237
359
  }
238
360
  export interface Assistant {
239
361
  /**
240
362
  * This is the name of the assistant. This is just for your own reference.
241
363
  * @maxLength 100
364
+ * @default null
242
365
  */
243
366
  name?: string;
244
- /** These are the options for the assistant's transcriber. */
367
+ /**
368
+ * These are the options for the assistant's transcriber.
369
+ * @default null
370
+ */
245
371
  transcriber?: DeepgramTranscriber;
246
372
  /** These are the options for the assistant's LLM. */
247
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
373
+ model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | CustomLLMModel;
248
374
  /**
249
375
  * These are the options for the assistant's voice.
250
- * @default "jennifer-playht"
376
+ * @default {"provider":"playht","voiceId":"jennifer"}
251
377
  */
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;
378
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
253
379
  /**
254
380
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
255
381
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
382
+ * @default null
256
383
  */
257
384
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
258
385
  /** This is the number to forward to if assistant runs into issues. */
259
386
  forwardingPhoneNumber?: string;
260
387
  /**
261
- * This is the first message that the assistant will say.
388
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
262
389
  *
263
390
  * If unspecified, it will wait for the user to speak.
264
391
  * @maxLength 1000
@@ -270,6 +397,7 @@ export interface Assistant {
270
397
  *
271
398
  * If unspecified, it will hang up.
272
399
  * @maxLength 1000
400
+ * @default null
273
401
  */
274
402
  voicemailMessage?: string;
275
403
  /**
@@ -277,18 +405,41 @@ export interface Assistant {
277
405
  *
278
406
  * If unspecified, it will hang up without saying anything.
279
407
  * @maxLength 400
408
+ * @default null
280
409
  */
281
410
  endCallMessage?: string;
282
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
411
+ /**
412
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
413
+ * @default null
414
+ */
283
415
  interruptionsEnabled?: boolean;
284
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
416
+ /**
417
+ * This sets whether the assistant's calls are recorded. Defaults to true.
418
+ * @default null
419
+ */
285
420
  recordingEnabled?: boolean;
286
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
421
+ /**
422
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
423
+ * @default null
424
+ */
287
425
  endCallFunctionEnabled?: boolean;
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. */
426
+ /**
427
+ * 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.
428
+ * @default null
429
+ */
289
430
  fillersEnabled?: boolean;
290
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
431
+ /**
432
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
433
+ * @default null
434
+ */
291
435
  liveTranscriptsEnabled?: boolean;
436
+ /**
437
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
438
+ * @min 10
439
+ * @max 600
440
+ * @default null
441
+ */
442
+ silenceTimeoutSeconds?: number;
292
443
  /** This is the unique identifier for the assistant. */
293
444
  id: string;
294
445
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -308,26 +459,31 @@ export interface UpdateAssistantDTO {
308
459
  /**
309
460
  * This is the name of the assistant. This is just for your own reference.
310
461
  * @maxLength 100
462
+ * @default null
311
463
  */
312
464
  name?: string;
313
- /** These are the options for the assistant's transcriber. */
465
+ /**
466
+ * These are the options for the assistant's transcriber.
467
+ * @default null
468
+ */
314
469
  transcriber?: DeepgramTranscriber;
315
470
  /** These are the options for the assistant's LLM. */
316
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
471
+ model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | CustomLLMModel;
317
472
  /**
318
473
  * These are the options for the assistant's voice.
319
- * @default "jennifer-playht"
474
+ * @default {"provider":"playht","voiceId":"jennifer"}
320
475
  */
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;
476
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
322
477
  /**
323
478
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
324
479
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
480
+ * @default null
325
481
  */
326
482
  language?: "en" | "en-US" | "en-AU" | "en-GB" | "en-NZ" | "en-IN" | "fr" | "fr-CA" | "de" | "hi" | "hi-Latn" | "pt" | "pt-BR" | "es" | "es-419";
327
483
  /** This is the number to forward to if assistant runs into issues. */
328
484
  forwardingPhoneNumber?: string;
329
485
  /**
330
- * This is the first message that the assistant will say.
486
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
331
487
  *
332
488
  * If unspecified, it will wait for the user to speak.
333
489
  * @maxLength 1000
@@ -339,6 +495,7 @@ export interface UpdateAssistantDTO {
339
495
  *
340
496
  * If unspecified, it will hang up.
341
497
  * @maxLength 1000
498
+ * @default null
342
499
  */
343
500
  voicemailMessage?: string;
344
501
  /**
@@ -346,18 +503,41 @@ export interface UpdateAssistantDTO {
346
503
  *
347
504
  * If unspecified, it will hang up without saying anything.
348
505
  * @maxLength 400
506
+ * @default null
349
507
  */
350
508
  endCallMessage?: string;
351
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
509
+ /**
510
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
511
+ * @default null
512
+ */
352
513
  interruptionsEnabled?: boolean;
353
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
514
+ /**
515
+ * This sets whether the assistant's calls are recorded. Defaults to true.
516
+ * @default null
517
+ */
354
518
  recordingEnabled?: boolean;
355
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
519
+ /**
520
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
521
+ * @default null
522
+ */
356
523
  endCallFunctionEnabled?: boolean;
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. */
524
+ /**
525
+ * 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.
526
+ * @default null
527
+ */
358
528
  fillersEnabled?: boolean;
359
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
529
+ /**
530
+ * This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients.
531
+ * @default null
532
+ */
360
533
  liveTranscriptsEnabled?: boolean;
534
+ /**
535
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
536
+ * @min 10
537
+ * @max 600
538
+ * @default null
539
+ */
540
+ silenceTimeoutSeconds?: number;
361
541
  }
362
542
  export interface CreateCustomerDTO {
363
543
  /** This is the number of the customer. */
@@ -393,7 +573,7 @@ export interface Call {
393
573
  /** This is the status of the call. */
394
574
  status?: "queued" | "ringing" | "in-progress" | "forwarding" | "ended";
395
575
  /** This is the explanation for how the call ended. */
396
- endedReason?: "assistant-ended-call" | "assistant-error" | "assistant-forwarded-call" | "assistant-join-timed-out" | "assistant-not-found" | "manually-canceled" | "customer-busy" | "customer-ended-call" | "customer-did-not-answer" | "db-error" | "exceeded-max-duration" | "no-server-available" | "server-shutdown" | "silence-timed-out" | "twilio-failed-to-connect-call" | "twilio-closed-websocket" | "unknown-error" | "voicemail";
576
+ endedReason?: "assistant-ended-call" | "assistant-error" | "assistant-forwarded-call" | "assistant-join-timed-out" | "assistant-not-found" | "customer-busy" | "customer-ended-call" | "customer-did-not-answer" | "db-error" | "exceeded-max-duration" | "manually-canceled" | "no-server-available" | "pipeline-error-custom-llm-response-was-invalid" | "pipeline-error-custom-llm-request-failed" | "pipeline-error-extra-function-failed" | "pipeline-error-first-message-failed" | "pipeline-error-function-filler-failed" | "pipeline-error-function-failed" | "pipeline-error-llm-failed" | "pipeline-error-openai-voice-failed" | "pipeline-error-deepgram-transcriber-failed" | "pipeline-error-deepgram-voice-failed" | "pipeline-error-eleven-labs-voice-failed" | "pipeline-error-eleven-labs-voice-not-found" | "pipeline-error-playht-voice-failed" | "pipeline-error-rime-ai-voice-failed" | "server-shutdown" | "silence-timed-out" | "twilio-failed-to-connect-call" | "twilio-closed-websocket" | "unknown-error" | "voicemail";
397
577
  /** This is the unique identifier for the call. */
398
578
  id: string;
399
579
  /** This is the unique identifier for the org that this call belongs to. */
@@ -544,10 +724,10 @@ export interface DeepgramCredential {
544
724
  */
545
725
  updatedAt: string;
546
726
  }
547
- export interface AzureOpenAICredential {
548
- provider: "azure-openai";
727
+ export interface ElevenLabsCredential {
728
+ provider: "11labs";
549
729
  /** This is not returned in the API. */
550
- openAIKey: string;
730
+ apiKey: string;
551
731
  /** This is the unique identifier for the credential. */
552
732
  id: string;
553
733
  /** This is the unique identifier for the org that this credential belongs to. */
@@ -562,10 +742,9 @@ export interface AzureOpenAICredential {
562
742
  * @format date-time
563
743
  */
564
744
  updatedAt: string;
565
- openAIEndpoint: string;
566
745
  }
567
- export interface ElevenLabsCredential {
568
- provider: "11labs";
746
+ export interface PlayHTCredential {
747
+ provider: "playht";
569
748
  /** This is not returned in the API. */
570
749
  apiKey: string;
571
750
  /** This is the unique identifier for the credential. */
@@ -582,9 +761,10 @@ export interface ElevenLabsCredential {
582
761
  * @format date-time
583
762
  */
584
763
  updatedAt: string;
764
+ userId: string;
585
765
  }
586
- export interface PlayHTCredential {
587
- provider: "playht";
766
+ export interface RimeAICredential {
767
+ provider: "rime-ai";
588
768
  /** This is not returned in the API. */
589
769
  apiKey: string;
590
770
  /** This is the unique identifier for the credential. */
@@ -601,10 +781,123 @@ export interface PlayHTCredential {
601
781
  * @format date-time
602
782
  */
603
783
  updatedAt: string;
604
- userId: string;
605
784
  }
606
- export interface RimeAICredential {
607
- provider: "rimeai";
785
+ export interface OpenAICredential {
786
+ provider: "openai";
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
+ export interface TogetherAICredential {
805
+ provider: "together-ai";
806
+ /** This is not returned in the API. */
807
+ apiKey: string;
808
+ /** This is the unique identifier for the credential. */
809
+ id: string;
810
+ /** This is the unique identifier for the org that this credential belongs to. */
811
+ orgId: string;
812
+ /**
813
+ * This is the ISO 8601 date-time string of when the credential was created.
814
+ * @format date-time
815
+ */
816
+ createdAt: string;
817
+ /**
818
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
819
+ * @format date-time
820
+ */
821
+ updatedAt: string;
822
+ }
823
+ export interface AnyscaleCredential {
824
+ provider: "anyscale";
825
+ /** This is not returned in the API. */
826
+ apiKey: string;
827
+ /** This is the unique identifier for the credential. */
828
+ id: string;
829
+ /** This is the unique identifier for the org that this credential belongs to. */
830
+ orgId: string;
831
+ /**
832
+ * This is the ISO 8601 date-time string of when the credential was created.
833
+ * @format date-time
834
+ */
835
+ createdAt: string;
836
+ /**
837
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
838
+ * @format date-time
839
+ */
840
+ updatedAt: string;
841
+ }
842
+ export interface OpenRouterCredential {
843
+ provider: "openrouter";
844
+ /** This is not returned in the API. */
845
+ apiKey: string;
846
+ /** This is the unique identifier for the credential. */
847
+ id: string;
848
+ /** This is the unique identifier for the org that this credential belongs to. */
849
+ orgId: string;
850
+ /**
851
+ * This is the ISO 8601 date-time string of when the credential was created.
852
+ * @format date-time
853
+ */
854
+ createdAt: string;
855
+ /**
856
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
857
+ * @format date-time
858
+ */
859
+ updatedAt: string;
860
+ }
861
+ export interface PerplexityAICredential {
862
+ provider: "perplexity-ai";
863
+ /** This is not returned in the API. */
864
+ apiKey: string;
865
+ /** This is the unique identifier for the credential. */
866
+ id: string;
867
+ /** This is the unique identifier for the org that this credential belongs to. */
868
+ orgId: string;
869
+ /**
870
+ * This is the ISO 8601 date-time string of when the credential was created.
871
+ * @format date-time
872
+ */
873
+ createdAt: string;
874
+ /**
875
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
876
+ * @format date-time
877
+ */
878
+ updatedAt: string;
879
+ }
880
+ export interface DeepInfraCredential {
881
+ provider: "deepinfra";
882
+ /** This is not returned in the API. */
883
+ apiKey: string;
884
+ /** This is the unique identifier for the credential. */
885
+ id: string;
886
+ /** This is the unique identifier for the org that this credential belongs to. */
887
+ orgId: string;
888
+ /**
889
+ * This is the ISO 8601 date-time string of when the credential was created.
890
+ * @format date-time
891
+ */
892
+ createdAt: string;
893
+ /**
894
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
895
+ * @format date-time
896
+ */
897
+ updatedAt: string;
898
+ }
899
+ export interface CustomLLMCredential {
900
+ provider: "custom-llm";
608
901
  /** This is not returned in the API. */
609
902
  apiKey: string;
610
903
  /** This is the unique identifier for the credential. */
@@ -633,11 +926,40 @@ export interface CreateDeepgramCredentialDTO {
633
926
  /** This is not returned in the API. */
634
927
  apiKey: string;
635
928
  }
636
- export interface CreateAzureOpenAICredentialDTO {
637
- provider: "azure-openai";
929
+ export interface CreateOpenAICredentialDTO {
930
+ provider: "openai";
931
+ /** This is not returned in the API. */
932
+ apiKey: string;
933
+ }
934
+ export interface CreateTogetherAICredentialDTO {
935
+ provider: "together-ai";
936
+ /** This is not returned in the API. */
937
+ apiKey: string;
938
+ }
939
+ export interface CreateAnyscaleCredentialDTO {
940
+ provider: "anyscale";
941
+ /** This is not returned in the API. */
942
+ apiKey: string;
943
+ }
944
+ export interface CreateOpenRouterCredentialDTO {
945
+ provider: "openrouter";
946
+ /** This is not returned in the API. */
947
+ apiKey: string;
948
+ }
949
+ export interface CreatePerplexityAICredentialDTO {
950
+ provider: "perplexity-ai";
951
+ /** This is not returned in the API. */
952
+ apiKey: string;
953
+ }
954
+ export interface CreateDeepInfraCredentialDTO {
955
+ provider: "deepinfra";
638
956
  /** This is not returned in the API. */
639
- openAIKey: string;
640
- openAIEndpoint: string;
957
+ apiKey: string;
958
+ }
959
+ export interface CreateCustomLLMCredentialDTO {
960
+ provider: "custom-llm";
961
+ /** This is not returned in the API. */
962
+ apiKey: string;
641
963
  }
642
964
  export interface CreateElevenLabsCredentialDTO {
643
965
  provider: "11labs";
@@ -651,7 +973,7 @@ export interface CreatePlayHTCredentialDTO {
651
973
  userId: string;
652
974
  }
653
975
  export interface CreateRimeAICredentialDTO {
654
- provider: "rimeai";
976
+ provider: "rime-ai";
655
977
  /** This is not returned in the API. */
656
978
  apiKey: string;
657
979
  }
@@ -666,11 +988,40 @@ export interface UpdateDeepgramCredentialDTO {
666
988
  /** This is not returned in the API. */
667
989
  apiKey: string;
668
990
  }
669
- export interface UpdateAzureOpenAICredentialDTO {
670
- provider: "azure-openai";
991
+ export interface UpdateOpenAICredentialDTO {
992
+ provider: "openai";
671
993
  /** This is not returned in the API. */
672
- openAIKey: string;
673
- openAIEndpoint: string;
994
+ apiKey: string;
995
+ }
996
+ export interface UpdateTogetherAICredentialDTO {
997
+ provider: "together-ai";
998
+ /** This is not returned in the API. */
999
+ apiKey: string;
1000
+ }
1001
+ export interface UpdateAnyscaleCredentialDTO {
1002
+ provider: "anyscale";
1003
+ /** This is not returned in the API. */
1004
+ apiKey: string;
1005
+ }
1006
+ export interface UpdateOpenRouterCredentialDTO {
1007
+ provider: "openrouter";
1008
+ /** This is not returned in the API. */
1009
+ apiKey: string;
1010
+ }
1011
+ export interface UpdatePerplexityAICredentialDTO {
1012
+ provider: "perplexity-ai";
1013
+ /** This is not returned in the API. */
1014
+ apiKey: string;
1015
+ }
1016
+ export interface UpdateDeepInfraCredentialDTO {
1017
+ provider: "deepinfra";
1018
+ /** This is not returned in the API. */
1019
+ apiKey: string;
1020
+ }
1021
+ export interface UpdateCustomLLMCredentialDTO {
1022
+ provider: "custom-llm";
1023
+ /** This is not returned in the API. */
1024
+ apiKey: string;
674
1025
  }
675
1026
  export interface UpdateElevenLabsCredentialDTO {
676
1027
  provider: "11labs";
@@ -684,7 +1035,7 @@ export interface UpdatePlayHTCredentialDTO {
684
1035
  userId: string;
685
1036
  }
686
1037
  export interface UpdateRimeAICredentialDTO {
687
- provider: "rimeai";
1038
+ provider: "rime-ai";
688
1039
  /** This is not returned in the API. */
689
1040
  apiKey: string;
690
1041
  }
@@ -946,25 +1297,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
946
1297
  } & CreateTwilioCredentialDTO) | ({
947
1298
  provider: "deepgram";
948
1299
  } & CreateDeepgramCredentialDTO) | ({
949
- provider: "azure-openai";
950
- } & CreateAzureOpenAICredentialDTO) | ({
1300
+ provider: "openai";
1301
+ } & CreateOpenAICredentialDTO) | ({
1302
+ provider: "together-ai";
1303
+ } & CreateTogetherAICredentialDTO) | ({
1304
+ provider: "anyscale";
1305
+ } & CreateAnyscaleCredentialDTO) | ({
1306
+ provider: "openrouter";
1307
+ } & CreateOpenRouterCredentialDTO) | ({
1308
+ provider: "perplexity-ai";
1309
+ } & CreatePerplexityAICredentialDTO) | ({
1310
+ provider: "deepinfra";
1311
+ } & CreateDeepInfraCredentialDTO) | ({
1312
+ provider: "custom-llm";
1313
+ } & CreateCustomLLMCredentialDTO) | ({
951
1314
  provider: "11labs";
952
1315
  } & CreateElevenLabsCredentialDTO) | ({
953
1316
  provider: "playht";
954
1317
  } & CreatePlayHTCredentialDTO) | ({
955
- provider: "rimeai";
1318
+ provider: "rime-ai";
956
1319
  } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
957
1320
  provider: "twilio";
958
1321
  } & TwilioCredential) | ({
959
1322
  provider: "deepgram";
960
1323
  } & DeepgramCredential) | ({
961
- provider: "azure-openai";
962
- } & AzureOpenAICredential) | ({
1324
+ provider: "openai";
1325
+ } & OpenAICredential) | ({
1326
+ provider: "together-ai";
1327
+ } & TogetherAICredential) | ({
1328
+ provider: "anyscale";
1329
+ } & AnyscaleCredential) | ({
1330
+ provider: "openrouter";
1331
+ } & OpenRouterCredential) | ({
1332
+ provider: "perplexity-ai";
1333
+ } & PerplexityAICredential) | ({
1334
+ provider: "deepinfra";
1335
+ } & DeepInfraCredential) | ({
1336
+ provider: "custom-llm";
1337
+ } & CustomLLMCredential) | ({
963
1338
  provider: "11labs";
964
1339
  } & ElevenLabsCredential) | ({
965
1340
  provider: "playht";
966
1341
  } & PlayHTCredential) | ({
967
- provider: "rimeai";
1342
+ provider: "rime-ai";
968
1343
  } & RimeAICredential), any>>;
969
1344
  /**
970
1345
  * No description
@@ -980,13 +1355,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
980
1355
  } & TwilioCredential) | ({
981
1356
  provider: "deepgram";
982
1357
  } & DeepgramCredential) | ({
983
- provider: "azure-openai";
984
- } & AzureOpenAICredential) | ({
1358
+ provider: "openai";
1359
+ } & OpenAICredential) | ({
1360
+ provider: "together-ai";
1361
+ } & TogetherAICredential) | ({
1362
+ provider: "anyscale";
1363
+ } & AnyscaleCredential) | ({
1364
+ provider: "openrouter";
1365
+ } & OpenRouterCredential) | ({
1366
+ provider: "perplexity-ai";
1367
+ } & PerplexityAICredential) | ({
1368
+ provider: "deepinfra";
1369
+ } & DeepInfraCredential) | ({
1370
+ provider: "custom-llm";
1371
+ } & CustomLLMCredential) | ({
985
1372
  provider: "11labs";
986
1373
  } & ElevenLabsCredential) | ({
987
1374
  provider: "playht";
988
1375
  } & PlayHTCredential) | ({
989
- provider: "rimeai";
1376
+ provider: "rime-ai";
990
1377
  } & RimeAICredential))[], any>>;
991
1378
  /**
992
1379
  * No description
@@ -1002,13 +1389,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1002
1389
  } & TwilioCredential) | ({
1003
1390
  provider: "deepgram";
1004
1391
  } & DeepgramCredential) | ({
1005
- provider: "azure-openai";
1006
- } & AzureOpenAICredential) | ({
1392
+ provider: "openai";
1393
+ } & OpenAICredential) | ({
1394
+ provider: "together-ai";
1395
+ } & TogetherAICredential) | ({
1396
+ provider: "anyscale";
1397
+ } & AnyscaleCredential) | ({
1398
+ provider: "openrouter";
1399
+ } & OpenRouterCredential) | ({
1400
+ provider: "perplexity-ai";
1401
+ } & PerplexityAICredential) | ({
1402
+ provider: "deepinfra";
1403
+ } & DeepInfraCredential) | ({
1404
+ provider: "custom-llm";
1405
+ } & CustomLLMCredential) | ({
1007
1406
  provider: "11labs";
1008
1407
  } & ElevenLabsCredential) | ({
1009
1408
  provider: "playht";
1010
1409
  } & PlayHTCredential) | ({
1011
- provider: "rimeai";
1410
+ provider: "rime-ai";
1012
1411
  } & RimeAICredential), any>>;
1013
1412
  /**
1014
1413
  * No description
@@ -1024,25 +1423,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1024
1423
  } & UpdateTwilioCredentialDTO) | ({
1025
1424
  provider: "deepgram";
1026
1425
  } & UpdateDeepgramCredentialDTO) | ({
1027
- provider: "azure-openai";
1028
- } & UpdateAzureOpenAICredentialDTO) | ({
1426
+ provider: "openai";
1427
+ } & UpdateOpenAICredentialDTO) | ({
1428
+ provider: "together-ai";
1429
+ } & UpdateTogetherAICredentialDTO) | ({
1430
+ provider: "anyscale";
1431
+ } & UpdateAnyscaleCredentialDTO) | ({
1432
+ provider: "openrouter";
1433
+ } & UpdateOpenRouterCredentialDTO) | ({
1434
+ provider: "perplexity-ai";
1435
+ } & UpdatePerplexityAICredentialDTO) | ({
1436
+ provider: "deepinfra";
1437
+ } & UpdateDeepInfraCredentialDTO) | ({
1438
+ provider: "custom-llm";
1439
+ } & UpdateCustomLLMCredentialDTO) | ({
1029
1440
  provider: "11labs";
1030
1441
  } & UpdateElevenLabsCredentialDTO) | ({
1031
1442
  provider: "playht";
1032
1443
  } & UpdatePlayHTCredentialDTO) | ({
1033
- provider: "rimeai";
1444
+ provider: "rime-ai";
1034
1445
  } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
1035
1446
  provider: "twilio";
1036
1447
  } & TwilioCredential) | ({
1037
1448
  provider: "deepgram";
1038
1449
  } & DeepgramCredential) | ({
1039
- provider: "azure-openai";
1040
- } & AzureOpenAICredential) | ({
1450
+ provider: "openai";
1451
+ } & OpenAICredential) | ({
1452
+ provider: "together-ai";
1453
+ } & TogetherAICredential) | ({
1454
+ provider: "anyscale";
1455
+ } & AnyscaleCredential) | ({
1456
+ provider: "openrouter";
1457
+ } & OpenRouterCredential) | ({
1458
+ provider: "perplexity-ai";
1459
+ } & PerplexityAICredential) | ({
1460
+ provider: "deepinfra";
1461
+ } & DeepInfraCredential) | ({
1462
+ provider: "custom-llm";
1463
+ } & CustomLLMCredential) | ({
1041
1464
  provider: "11labs";
1042
1465
  } & ElevenLabsCredential) | ({
1043
1466
  provider: "playht";
1044
1467
  } & PlayHTCredential) | ({
1045
- provider: "rimeai";
1468
+ provider: "rime-ai";
1046
1469
  } & RimeAICredential), any>>;
1047
1470
  /**
1048
1471
  * No description
@@ -1058,13 +1481,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1058
1481
  } & TwilioCredential) | ({
1059
1482
  provider: "deepgram";
1060
1483
  } & DeepgramCredential) | ({
1061
- provider: "azure-openai";
1062
- } & AzureOpenAICredential) | ({
1484
+ provider: "openai";
1485
+ } & OpenAICredential) | ({
1486
+ provider: "together-ai";
1487
+ } & TogetherAICredential) | ({
1488
+ provider: "anyscale";
1489
+ } & AnyscaleCredential) | ({
1490
+ provider: "openrouter";
1491
+ } & OpenRouterCredential) | ({
1492
+ provider: "perplexity-ai";
1493
+ } & PerplexityAICredential) | ({
1494
+ provider: "deepinfra";
1495
+ } & DeepInfraCredential) | ({
1496
+ provider: "custom-llm";
1497
+ } & CustomLLMCredential) | ({
1063
1498
  provider: "11labs";
1064
1499
  } & ElevenLabsCredential) | ({
1065
1500
  provider: "playht";
1066
1501
  } & PlayHTCredential) | ({
1067
- provider: "rimeai";
1502
+ provider: "rime-ai";
1068
1503
  } & RimeAICredential), any>>;
1069
1504
  };
1070
1505
  phoneNumber: {