@vapi-ai/web 1.0.248 → 1.0.250

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 (7) hide show
  1. package/README.md +6 -2
  2. package/api.ts +822 -298
  3. package/dist/api.d.ts +663 -143
  4. package/dist/api.js +10 -0
  5. package/dist/vapi.d.ts +7 -1
  6. package/package.json +2 -1
  7. package/vapi.ts +9 -2
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
59
+ */
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
18
104
  */
19
- provider: "custom";
20
- /** These is the URL we'll POST during the conversation. */
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,77 @@ 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. */
236
- liveTranscriptsEnabled?: boolean;
347
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
348
+ clientMessages?: "function-call" | "transcript" | "hang";
349
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
350
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
351
+ /**
352
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
353
+ * @min 10
354
+ * @max 600
355
+ * @default null
356
+ */
357
+ silenceTimeoutSeconds?: number;
358
+ /**
359
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
360
+ * @min 0
361
+ * @max 10
362
+ * @default null
363
+ */
364
+ responseDelaySeconds?: number;
237
365
  }
238
366
  export interface Assistant {
239
367
  /**
240
368
  * This is the name of the assistant. This is just for your own reference.
241
369
  * @maxLength 100
370
+ * @default null
242
371
  */
243
372
  name?: string;
244
- /** These are the options for the assistant's transcriber. */
373
+ /**
374
+ * These are the options for the assistant's transcriber.
375
+ * @default null
376
+ */
245
377
  transcriber?: DeepgramTranscriber;
246
378
  /** These are the options for the assistant's LLM. */
247
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
379
+ model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | CustomLLMModel;
248
380
  /**
249
381
  * These are the options for the assistant's voice.
250
- * @default "jennifer-playht"
382
+ * @default {"provider":"playht","voiceId":"jennifer"}
251
383
  */
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;
384
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
253
385
  /**
254
386
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
255
387
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
388
+ * @default null
256
389
  */
257
390
  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
391
  /** This is the number to forward to if assistant runs into issues. */
259
392
  forwardingPhoneNumber?: string;
260
393
  /**
261
- * This is the first message that the assistant will say.
394
+ * 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
395
  *
263
396
  * If unspecified, it will wait for the user to speak.
264
397
  * @maxLength 1000
@@ -270,6 +403,7 @@ export interface Assistant {
270
403
  *
271
404
  * If unspecified, it will hang up.
272
405
  * @maxLength 1000
406
+ * @default null
273
407
  */
274
408
  voicemailMessage?: string;
275
409
  /**
@@ -277,18 +411,47 @@ export interface Assistant {
277
411
  *
278
412
  * If unspecified, it will hang up without saying anything.
279
413
  * @maxLength 400
414
+ * @default null
280
415
  */
281
416
  endCallMessage?: string;
282
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
417
+ /**
418
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
419
+ * @default null
420
+ */
283
421
  interruptionsEnabled?: boolean;
284
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
422
+ /**
423
+ * This sets whether the assistant's calls are recorded. Defaults to true.
424
+ * @default null
425
+ */
285
426
  recordingEnabled?: boolean;
286
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
427
+ /**
428
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
429
+ * @default null
430
+ */
287
431
  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. */
432
+ /**
433
+ * 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.
434
+ * @default null
435
+ */
289
436
  fillersEnabled?: boolean;
290
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
291
- liveTranscriptsEnabled?: boolean;
437
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
438
+ clientMessages?: "function-call" | "transcript" | "hang";
439
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
440
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
441
+ /**
442
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
443
+ * @min 10
444
+ * @max 600
445
+ * @default null
446
+ */
447
+ silenceTimeoutSeconds?: number;
448
+ /**
449
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
450
+ * @min 0
451
+ * @max 10
452
+ * @default null
453
+ */
454
+ responseDelaySeconds?: number;
292
455
  /** This is the unique identifier for the assistant. */
293
456
  id: string;
294
457
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -308,26 +471,31 @@ export interface UpdateAssistantDTO {
308
471
  /**
309
472
  * This is the name of the assistant. This is just for your own reference.
310
473
  * @maxLength 100
474
+ * @default null
311
475
  */
312
476
  name?: string;
313
- /** These are the options for the assistant's transcriber. */
477
+ /**
478
+ * These are the options for the assistant's transcriber.
479
+ * @default null
480
+ */
314
481
  transcriber?: DeepgramTranscriber;
315
482
  /** These are the options for the assistant's LLM. */
316
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
483
+ model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | CustomLLMModel;
317
484
  /**
318
485
  * These are the options for the assistant's voice.
319
- * @default "jennifer-playht"
486
+ * @default {"provider":"playht","voiceId":"jennifer"}
320
487
  */
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;
488
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
322
489
  /**
323
490
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
324
491
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
492
+ * @default null
325
493
  */
326
494
  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
495
  /** This is the number to forward to if assistant runs into issues. */
328
496
  forwardingPhoneNumber?: string;
329
497
  /**
330
- * This is the first message that the assistant will say.
498
+ * 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
499
  *
332
500
  * If unspecified, it will wait for the user to speak.
333
501
  * @maxLength 1000
@@ -339,6 +507,7 @@ export interface UpdateAssistantDTO {
339
507
  *
340
508
  * If unspecified, it will hang up.
341
509
  * @maxLength 1000
510
+ * @default null
342
511
  */
343
512
  voicemailMessage?: string;
344
513
  /**
@@ -346,18 +515,47 @@ export interface UpdateAssistantDTO {
346
515
  *
347
516
  * If unspecified, it will hang up without saying anything.
348
517
  * @maxLength 400
518
+ * @default null
349
519
  */
350
520
  endCallMessage?: string;
351
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
521
+ /**
522
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
523
+ * @default null
524
+ */
352
525
  interruptionsEnabled?: boolean;
353
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
526
+ /**
527
+ * This sets whether the assistant's calls are recorded. Defaults to true.
528
+ * @default null
529
+ */
354
530
  recordingEnabled?: boolean;
355
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
531
+ /**
532
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
533
+ * @default null
534
+ */
356
535
  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. */
536
+ /**
537
+ * 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.
538
+ * @default null
539
+ */
358
540
  fillersEnabled?: boolean;
359
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
360
- liveTranscriptsEnabled?: boolean;
541
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
542
+ clientMessages?: "function-call" | "transcript" | "hang";
543
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
544
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
545
+ /**
546
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
547
+ * @min 10
548
+ * @max 600
549
+ * @default null
550
+ */
551
+ silenceTimeoutSeconds?: number;
552
+ /**
553
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
554
+ * @min 0
555
+ * @max 10
556
+ * @default null
557
+ */
558
+ responseDelaySeconds?: number;
361
559
  }
362
560
  export interface CreateCustomerDTO {
363
561
  /** This is the number of the customer. */
@@ -393,7 +591,14 @@ export interface Call {
393
591
  /** This is the status of the call. */
394
592
  status?: "queued" | "ringing" | "in-progress" | "forwarding" | "ended";
395
593
  /** 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";
594
+ 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";
595
+ /**
596
+ * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
597
+ * @min 10
598
+ * @max 3600
599
+ * @default null
600
+ */
601
+ maxDurationSeconds?: number;
397
602
  /** This is the unique identifier for the call. */
398
603
  id: string;
399
604
  /** This is the unique identifier for the org that this call belongs to. */
@@ -470,6 +675,13 @@ export interface Call {
470
675
  phoneNumber?: ImportTwilioPhoneNumberDTO;
471
676
  }
472
677
  export interface CreateOutboundCallDTO {
678
+ /**
679
+ * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
680
+ * @min 10
681
+ * @max 3600
682
+ * @default null
683
+ */
684
+ maxDurationSeconds?: number;
473
685
  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
474
686
  assistantId?: string;
475
687
  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
@@ -544,10 +756,10 @@ export interface DeepgramCredential {
544
756
  */
545
757
  updatedAt: string;
546
758
  }
547
- export interface AzureOpenAICredential {
548
- provider: "azure-openai";
759
+ export interface ElevenLabsCredential {
760
+ provider: "11labs";
549
761
  /** This is not returned in the API. */
550
- openAIKey: string;
762
+ apiKey: string;
551
763
  /** This is the unique identifier for the credential. */
552
764
  id: string;
553
765
  /** This is the unique identifier for the org that this credential belongs to. */
@@ -562,10 +774,9 @@ export interface AzureOpenAICredential {
562
774
  * @format date-time
563
775
  */
564
776
  updatedAt: string;
565
- openAIEndpoint: string;
566
777
  }
567
- export interface ElevenLabsCredential {
568
- provider: "11labs";
778
+ export interface PlayHTCredential {
779
+ provider: "playht";
569
780
  /** This is not returned in the API. */
570
781
  apiKey: string;
571
782
  /** This is the unique identifier for the credential. */
@@ -582,9 +793,10 @@ export interface ElevenLabsCredential {
582
793
  * @format date-time
583
794
  */
584
795
  updatedAt: string;
796
+ userId: string;
585
797
  }
586
- export interface PlayHTCredential {
587
- provider: "playht";
798
+ export interface RimeAICredential {
799
+ provider: "rime-ai";
588
800
  /** This is not returned in the API. */
589
801
  apiKey: string;
590
802
  /** This is the unique identifier for the credential. */
@@ -601,10 +813,142 @@ export interface PlayHTCredential {
601
813
  * @format date-time
602
814
  */
603
815
  updatedAt: string;
604
- userId: string;
605
816
  }
606
- export interface RimeAICredential {
607
- provider: "rimeai";
817
+ export interface OpenAICredential {
818
+ provider: "openai";
819
+ /** This is not returned in the API. */
820
+ apiKey: string;
821
+ /** This is the unique identifier for the credential. */
822
+ id: string;
823
+ /** This is the unique identifier for the org that this credential belongs to. */
824
+ orgId: string;
825
+ /**
826
+ * This is the ISO 8601 date-time string of when the credential was created.
827
+ * @format date-time
828
+ */
829
+ createdAt: string;
830
+ /**
831
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
832
+ * @format date-time
833
+ */
834
+ updatedAt: string;
835
+ }
836
+ export interface TogetherAICredential {
837
+ provider: "together-ai";
838
+ /** This is not returned in the API. */
839
+ apiKey: string;
840
+ /** This is the unique identifier for the credential. */
841
+ id: string;
842
+ /** This is the unique identifier for the org that this credential belongs to. */
843
+ orgId: string;
844
+ /**
845
+ * This is the ISO 8601 date-time string of when the credential was created.
846
+ * @format date-time
847
+ */
848
+ createdAt: string;
849
+ /**
850
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
851
+ * @format date-time
852
+ */
853
+ updatedAt: string;
854
+ }
855
+ export interface AnyscaleCredential {
856
+ provider: "anyscale";
857
+ /** This is not returned in the API. */
858
+ apiKey: string;
859
+ /** This is the unique identifier for the credential. */
860
+ id: string;
861
+ /** This is the unique identifier for the org that this credential belongs to. */
862
+ orgId: string;
863
+ /**
864
+ * This is the ISO 8601 date-time string of when the credential was created.
865
+ * @format date-time
866
+ */
867
+ createdAt: string;
868
+ /**
869
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
870
+ * @format date-time
871
+ */
872
+ updatedAt: string;
873
+ }
874
+ export interface OpenRouterCredential {
875
+ provider: "openrouter";
876
+ /** This is not returned in the API. */
877
+ apiKey: string;
878
+ /** This is the unique identifier for the credential. */
879
+ id: string;
880
+ /** This is the unique identifier for the org that this credential belongs to. */
881
+ orgId: string;
882
+ /**
883
+ * This is the ISO 8601 date-time string of when the credential was created.
884
+ * @format date-time
885
+ */
886
+ createdAt: string;
887
+ /**
888
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
889
+ * @format date-time
890
+ */
891
+ updatedAt: string;
892
+ }
893
+ export interface PerplexityAICredential {
894
+ provider: "perplexity-ai";
895
+ /** This is not returned in the API. */
896
+ apiKey: string;
897
+ /** This is the unique identifier for the credential. */
898
+ id: string;
899
+ /** This is the unique identifier for the org that this credential belongs to. */
900
+ orgId: string;
901
+ /**
902
+ * This is the ISO 8601 date-time string of when the credential was created.
903
+ * @format date-time
904
+ */
905
+ createdAt: string;
906
+ /**
907
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
908
+ * @format date-time
909
+ */
910
+ updatedAt: string;
911
+ }
912
+ export interface DeepInfraCredential {
913
+ provider: "deepinfra";
914
+ /** This is not returned in the API. */
915
+ apiKey: string;
916
+ /** This is the unique identifier for the credential. */
917
+ id: string;
918
+ /** This is the unique identifier for the org that this credential belongs to. */
919
+ orgId: string;
920
+ /**
921
+ * This is the ISO 8601 date-time string of when the credential was created.
922
+ * @format date-time
923
+ */
924
+ createdAt: string;
925
+ /**
926
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
927
+ * @format date-time
928
+ */
929
+ updatedAt: string;
930
+ }
931
+ export interface CustomLLMCredential {
932
+ provider: "custom-llm";
933
+ /** This is not returned in the API. */
934
+ apiKey: string;
935
+ /** This is the unique identifier for the credential. */
936
+ id: string;
937
+ /** This is the unique identifier for the org that this credential belongs to. */
938
+ orgId: string;
939
+ /**
940
+ * This is the ISO 8601 date-time string of when the credential was created.
941
+ * @format date-time
942
+ */
943
+ createdAt: string;
944
+ /**
945
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
946
+ * @format date-time
947
+ */
948
+ updatedAt: string;
949
+ }
950
+ export interface RunpodCredential {
951
+ provider: "runpod";
608
952
  /** This is not returned in the API. */
609
953
  apiKey: string;
610
954
  /** This is the unique identifier for the credential. */
@@ -633,11 +977,40 @@ export interface CreateDeepgramCredentialDTO {
633
977
  /** This is not returned in the API. */
634
978
  apiKey: string;
635
979
  }
636
- export interface CreateAzureOpenAICredentialDTO {
637
- provider: "azure-openai";
980
+ export interface CreateOpenAICredentialDTO {
981
+ provider: "openai";
638
982
  /** This is not returned in the API. */
639
- openAIKey: string;
640
- openAIEndpoint: string;
983
+ apiKey: string;
984
+ }
985
+ export interface CreateTogetherAICredentialDTO {
986
+ provider: "together-ai";
987
+ /** This is not returned in the API. */
988
+ apiKey: string;
989
+ }
990
+ export interface CreateAnyscaleCredentialDTO {
991
+ provider: "anyscale";
992
+ /** This is not returned in the API. */
993
+ apiKey: string;
994
+ }
995
+ export interface CreateOpenRouterCredentialDTO {
996
+ provider: "openrouter";
997
+ /** This is not returned in the API. */
998
+ apiKey: string;
999
+ }
1000
+ export interface CreatePerplexityAICredentialDTO {
1001
+ provider: "perplexity-ai";
1002
+ /** This is not returned in the API. */
1003
+ apiKey: string;
1004
+ }
1005
+ export interface CreateDeepInfraCredentialDTO {
1006
+ provider: "deepinfra";
1007
+ /** This is not returned in the API. */
1008
+ apiKey: string;
1009
+ }
1010
+ export interface CreateCustomLLMCredentialDTO {
1011
+ provider: "custom-llm";
1012
+ /** This is not returned in the API. */
1013
+ apiKey: string;
641
1014
  }
642
1015
  export interface CreateElevenLabsCredentialDTO {
643
1016
  provider: "11labs";
@@ -651,7 +1024,12 @@ export interface CreatePlayHTCredentialDTO {
651
1024
  userId: string;
652
1025
  }
653
1026
  export interface CreateRimeAICredentialDTO {
654
- provider: "rimeai";
1027
+ provider: "rime-ai";
1028
+ /** This is not returned in the API. */
1029
+ apiKey: string;
1030
+ }
1031
+ export interface CreateRunpodCredentialDTO {
1032
+ provider: "runpod";
655
1033
  /** This is not returned in the API. */
656
1034
  apiKey: string;
657
1035
  }
@@ -666,11 +1044,40 @@ export interface UpdateDeepgramCredentialDTO {
666
1044
  /** This is not returned in the API. */
667
1045
  apiKey: string;
668
1046
  }
669
- export interface UpdateAzureOpenAICredentialDTO {
670
- provider: "azure-openai";
1047
+ export interface UpdateOpenAICredentialDTO {
1048
+ provider: "openai";
671
1049
  /** This is not returned in the API. */
672
- openAIKey: string;
673
- openAIEndpoint: string;
1050
+ apiKey: string;
1051
+ }
1052
+ export interface UpdateTogetherAICredentialDTO {
1053
+ provider: "together-ai";
1054
+ /** This is not returned in the API. */
1055
+ apiKey: string;
1056
+ }
1057
+ export interface UpdateAnyscaleCredentialDTO {
1058
+ provider: "anyscale";
1059
+ /** This is not returned in the API. */
1060
+ apiKey: string;
1061
+ }
1062
+ export interface UpdateOpenRouterCredentialDTO {
1063
+ provider: "openrouter";
1064
+ /** This is not returned in the API. */
1065
+ apiKey: string;
1066
+ }
1067
+ export interface UpdatePerplexityAICredentialDTO {
1068
+ provider: "perplexity-ai";
1069
+ /** This is not returned in the API. */
1070
+ apiKey: string;
1071
+ }
1072
+ export interface UpdateDeepInfraCredentialDTO {
1073
+ provider: "deepinfra";
1074
+ /** This is not returned in the API. */
1075
+ apiKey: string;
1076
+ }
1077
+ export interface UpdateCustomLLMCredentialDTO {
1078
+ provider: "custom-llm";
1079
+ /** This is not returned in the API. */
1080
+ apiKey: string;
674
1081
  }
675
1082
  export interface UpdateElevenLabsCredentialDTO {
676
1083
  provider: "11labs";
@@ -684,7 +1091,12 @@ export interface UpdatePlayHTCredentialDTO {
684
1091
  userId: string;
685
1092
  }
686
1093
  export interface UpdateRimeAICredentialDTO {
687
- provider: "rimeai";
1094
+ provider: "rime-ai";
1095
+ /** This is not returned in the API. */
1096
+ apiKey: string;
1097
+ }
1098
+ export interface UpdateRunpodCredentialDTO {
1099
+ provider: "runpod";
688
1100
  /** This is not returned in the API. */
689
1101
  apiKey: string;
690
1102
  }
@@ -878,6 +1290,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
878
1290
  * @secure
879
1291
  */
880
1292
  assistantControllerUpdate: (id: string, data: UpdateAssistantDTO, params?: RequestParams) => Promise<HttpResponse<Assistant, any>>;
1293
+ /**
1294
+ * No description
1295
+ *
1296
+ * @tags Assistants
1297
+ * @name AssistantControllerReplace
1298
+ * @summary Replace Assistant
1299
+ * @request PUT:/assistant/{id}
1300
+ * @secure
1301
+ */
1302
+ assistantControllerReplace: (id: string, data: UpdateAssistantDTO, params?: RequestParams) => Promise<HttpResponse<Assistant, any>>;
881
1303
  /**
882
1304
  * No description
883
1305
  *
@@ -946,26 +1368,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
946
1368
  } & CreateTwilioCredentialDTO) | ({
947
1369
  provider: "deepgram";
948
1370
  } & CreateDeepgramCredentialDTO) | ({
949
- provider: "azure-openai";
950
- } & CreateAzureOpenAICredentialDTO) | ({
1371
+ provider: "openai";
1372
+ } & CreateOpenAICredentialDTO) | ({
1373
+ provider: "together-ai";
1374
+ } & CreateTogetherAICredentialDTO) | ({
1375
+ provider: "anyscale";
1376
+ } & CreateAnyscaleCredentialDTO) | ({
1377
+ provider: "openrouter";
1378
+ } & CreateOpenRouterCredentialDTO) | ({
1379
+ provider: "perplexity-ai";
1380
+ } & CreatePerplexityAICredentialDTO) | ({
1381
+ provider: "deepinfra";
1382
+ } & CreateDeepInfraCredentialDTO) | ({
1383
+ provider: "custom-llm";
1384
+ } & CreateCustomLLMCredentialDTO) | ({
951
1385
  provider: "11labs";
952
1386
  } & CreateElevenLabsCredentialDTO) | ({
953
1387
  provider: "playht";
954
1388
  } & CreatePlayHTCredentialDTO) | ({
955
- provider: "rimeai";
956
- } & CreateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
1389
+ provider: "rime-ai";
1390
+ } & CreateRimeAICredentialDTO) | ({
1391
+ provider: "runpod";
1392
+ } & CreateRunpodCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
957
1393
  provider: "twilio";
958
1394
  } & TwilioCredential) | ({
959
1395
  provider: "deepgram";
960
1396
  } & DeepgramCredential) | ({
961
- provider: "azure-openai";
962
- } & AzureOpenAICredential) | ({
1397
+ provider: "openai";
1398
+ } & OpenAICredential) | ({
1399
+ provider: "together-ai";
1400
+ } & TogetherAICredential) | ({
1401
+ provider: "anyscale";
1402
+ } & AnyscaleCredential) | ({
1403
+ provider: "openrouter";
1404
+ } & OpenRouterCredential) | ({
1405
+ provider: "perplexity-ai";
1406
+ } & PerplexityAICredential) | ({
1407
+ provider: "deepinfra";
1408
+ } & DeepInfraCredential) | ({
1409
+ provider: "custom-llm";
1410
+ } & CustomLLMCredential) | ({
963
1411
  provider: "11labs";
964
1412
  } & ElevenLabsCredential) | ({
965
1413
  provider: "playht";
966
1414
  } & PlayHTCredential) | ({
967
- provider: "rimeai";
968
- } & RimeAICredential), any>>;
1415
+ provider: "rime-ai";
1416
+ } & RimeAICredential) | ({
1417
+ provider: "runpod";
1418
+ } & RunpodCredential), any>>;
969
1419
  /**
970
1420
  * No description
971
1421
  *
@@ -980,14 +1430,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
980
1430
  } & TwilioCredential) | ({
981
1431
  provider: "deepgram";
982
1432
  } & DeepgramCredential) | ({
983
- provider: "azure-openai";
984
- } & AzureOpenAICredential) | ({
1433
+ provider: "openai";
1434
+ } & OpenAICredential) | ({
1435
+ provider: "together-ai";
1436
+ } & TogetherAICredential) | ({
1437
+ provider: "anyscale";
1438
+ } & AnyscaleCredential) | ({
1439
+ provider: "openrouter";
1440
+ } & OpenRouterCredential) | ({
1441
+ provider: "perplexity-ai";
1442
+ } & PerplexityAICredential) | ({
1443
+ provider: "deepinfra";
1444
+ } & DeepInfraCredential) | ({
1445
+ provider: "custom-llm";
1446
+ } & CustomLLMCredential) | ({
985
1447
  provider: "11labs";
986
1448
  } & ElevenLabsCredential) | ({
987
1449
  provider: "playht";
988
1450
  } & PlayHTCredential) | ({
989
- provider: "rimeai";
990
- } & RimeAICredential))[], any>>;
1451
+ provider: "rime-ai";
1452
+ } & RimeAICredential) | ({
1453
+ provider: "runpod";
1454
+ } & RunpodCredential))[], any>>;
991
1455
  /**
992
1456
  * No description
993
1457
  *
@@ -1002,14 +1466,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1002
1466
  } & TwilioCredential) | ({
1003
1467
  provider: "deepgram";
1004
1468
  } & DeepgramCredential) | ({
1005
- provider: "azure-openai";
1006
- } & AzureOpenAICredential) | ({
1469
+ provider: "openai";
1470
+ } & OpenAICredential) | ({
1471
+ provider: "together-ai";
1472
+ } & TogetherAICredential) | ({
1473
+ provider: "anyscale";
1474
+ } & AnyscaleCredential) | ({
1475
+ provider: "openrouter";
1476
+ } & OpenRouterCredential) | ({
1477
+ provider: "perplexity-ai";
1478
+ } & PerplexityAICredential) | ({
1479
+ provider: "deepinfra";
1480
+ } & DeepInfraCredential) | ({
1481
+ provider: "custom-llm";
1482
+ } & CustomLLMCredential) | ({
1007
1483
  provider: "11labs";
1008
1484
  } & ElevenLabsCredential) | ({
1009
1485
  provider: "playht";
1010
1486
  } & PlayHTCredential) | ({
1011
- provider: "rimeai";
1012
- } & RimeAICredential), any>>;
1487
+ provider: "rime-ai";
1488
+ } & RimeAICredential) | ({
1489
+ provider: "runpod";
1490
+ } & RunpodCredential), any>>;
1013
1491
  /**
1014
1492
  * No description
1015
1493
  *
@@ -1024,26 +1502,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1024
1502
  } & UpdateTwilioCredentialDTO) | ({
1025
1503
  provider: "deepgram";
1026
1504
  } & UpdateDeepgramCredentialDTO) | ({
1027
- provider: "azure-openai";
1028
- } & UpdateAzureOpenAICredentialDTO) | ({
1505
+ provider: "openai";
1506
+ } & UpdateOpenAICredentialDTO) | ({
1507
+ provider: "together-ai";
1508
+ } & UpdateTogetherAICredentialDTO) | ({
1509
+ provider: "anyscale";
1510
+ } & UpdateAnyscaleCredentialDTO) | ({
1511
+ provider: "openrouter";
1512
+ } & UpdateOpenRouterCredentialDTO) | ({
1513
+ provider: "perplexity-ai";
1514
+ } & UpdatePerplexityAICredentialDTO) | ({
1515
+ provider: "deepinfra";
1516
+ } & UpdateDeepInfraCredentialDTO) | ({
1517
+ provider: "custom-llm";
1518
+ } & UpdateCustomLLMCredentialDTO) | ({
1029
1519
  provider: "11labs";
1030
1520
  } & UpdateElevenLabsCredentialDTO) | ({
1031
1521
  provider: "playht";
1032
1522
  } & UpdatePlayHTCredentialDTO) | ({
1033
- provider: "rimeai";
1034
- } & UpdateRimeAICredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
1523
+ provider: "rime-ai";
1524
+ } & UpdateRimeAICredentialDTO) | ({
1525
+ provider: "runpod";
1526
+ } & UpdateRunpodCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
1035
1527
  provider: "twilio";
1036
1528
  } & TwilioCredential) | ({
1037
1529
  provider: "deepgram";
1038
1530
  } & DeepgramCredential) | ({
1039
- provider: "azure-openai";
1040
- } & AzureOpenAICredential) | ({
1531
+ provider: "openai";
1532
+ } & OpenAICredential) | ({
1533
+ provider: "together-ai";
1534
+ } & TogetherAICredential) | ({
1535
+ provider: "anyscale";
1536
+ } & AnyscaleCredential) | ({
1537
+ provider: "openrouter";
1538
+ } & OpenRouterCredential) | ({
1539
+ provider: "perplexity-ai";
1540
+ } & PerplexityAICredential) | ({
1541
+ provider: "deepinfra";
1542
+ } & DeepInfraCredential) | ({
1543
+ provider: "custom-llm";
1544
+ } & CustomLLMCredential) | ({
1041
1545
  provider: "11labs";
1042
1546
  } & ElevenLabsCredential) | ({
1043
1547
  provider: "playht";
1044
1548
  } & PlayHTCredential) | ({
1045
- provider: "rimeai";
1046
- } & RimeAICredential), any>>;
1549
+ provider: "rime-ai";
1550
+ } & RimeAICredential) | ({
1551
+ provider: "runpod";
1552
+ } & RunpodCredential), any>>;
1047
1553
  /**
1048
1554
  * No description
1049
1555
  *
@@ -1058,14 +1564,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
1058
1564
  } & TwilioCredential) | ({
1059
1565
  provider: "deepgram";
1060
1566
  } & DeepgramCredential) | ({
1061
- provider: "azure-openai";
1062
- } & AzureOpenAICredential) | ({
1567
+ provider: "openai";
1568
+ } & OpenAICredential) | ({
1569
+ provider: "together-ai";
1570
+ } & TogetherAICredential) | ({
1571
+ provider: "anyscale";
1572
+ } & AnyscaleCredential) | ({
1573
+ provider: "openrouter";
1574
+ } & OpenRouterCredential) | ({
1575
+ provider: "perplexity-ai";
1576
+ } & PerplexityAICredential) | ({
1577
+ provider: "deepinfra";
1578
+ } & DeepInfraCredential) | ({
1579
+ provider: "custom-llm";
1580
+ } & CustomLLMCredential) | ({
1063
1581
  provider: "11labs";
1064
1582
  } & ElevenLabsCredential) | ({
1065
1583
  provider: "playht";
1066
1584
  } & PlayHTCredential) | ({
1067
- provider: "rimeai";
1068
- } & RimeAICredential), any>>;
1585
+ provider: "rime-ai";
1586
+ } & RimeAICredential) | ({
1587
+ provider: "runpod";
1588
+ } & RunpodCredential), any>>;
1069
1589
  };
1070
1590
  phoneNumber: {
1071
1591
  /**