@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.
package/api.ts CHANGED
@@ -15,24 +15,132 @@ export interface DeepgramVoice {
15
15
  *
16
16
  * Pro Voices: `11labs`, `playht`, `openai`
17
17
  *
18
- * Basic Voices: `rimeai`, `deepgram`
18
+ * Basic Voices: `rime-ai`, `deepgram`
19
19
  */
20
20
  provider: "deepgram";
21
21
  /** This is the provider-specific ID that will be used. */
22
- voiceId: string;
22
+ voiceId: "aurora" | "asteria" | "artemis" | "andromeda" | "stella" | "orion" | "atlas" | string;
23
23
  }
24
24
 
25
- export interface CustomModel {
25
+ export interface OpenAIFunction {
26
26
  /**
27
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
27
+ * This is the the name of the function to be called.
28
+ *
29
+ * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
30
+ * @maxLength 64
31
+ */
32
+ name: string;
33
+ /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
34
+ async?: boolean;
35
+ /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
36
+ description?: string;
37
+ /**
38
+ * These are the parameters the functions accepts, described as a JSON Schema object.
39
+ *
40
+ * See the [OpenAI guide](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.
28
41
  *
29
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
42
+ * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
43
+ */
44
+ parameters: object;
45
+ }
46
+
47
+ export interface TogetherAIModel {
48
+ provider: "together-ai";
49
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
50
+ model: string;
51
+ /** This sets the objective and understanding for the assistant. */
52
+ systemPrompt?: string;
53
+ /**
54
+ * This is the temperature that will be used for calls. Default is 1.
55
+ * @min 0
56
+ * @max 2
57
+ */
58
+ temperature?: number;
59
+ /** These are the functions that the assistant can execute during the call. */
60
+ functions?: OpenAIFunction[];
61
+ }
62
+
63
+ export interface AnyscaleModel {
64
+ provider: "anyscale";
65
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
66
+ model: string;
67
+ /** This sets the objective and understanding for the assistant. */
68
+ systemPrompt?: string;
69
+ /**
70
+ * This is the temperature that will be used for calls. Default is 1.
71
+ * @min 0
72
+ * @max 2
73
+ */
74
+ temperature?: number;
75
+ /** These are the functions that the assistant can execute during the call. */
76
+ functions?: OpenAIFunction[];
77
+ }
78
+
79
+ export interface OpenRouterModel {
80
+ provider: "openrouter";
81
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
82
+ model: string;
83
+ /** This sets the objective and understanding for the assistant. */
84
+ systemPrompt?: string;
85
+ /**
86
+ * This is the temperature that will be used for calls. Default is 1.
87
+ * @min 0
88
+ * @max 2
89
+ */
90
+ temperature?: number;
91
+ /** These are the functions that the assistant can execute during the call. */
92
+ functions?: OpenAIFunction[];
93
+ }
94
+
95
+ export interface PerplexityAIModel {
96
+ provider: "perplexity-ai";
97
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
98
+ model: string;
99
+ /** This sets the objective and understanding for the assistant. */
100
+ systemPrompt?: string;
101
+ /**
102
+ * This is the temperature that will be used for calls. Default is 1.
103
+ * @min 0
104
+ * @max 2
30
105
  */
31
- provider: "custom";
32
- /** These is the URL we'll POST during the conversation. */
106
+ temperature?: number;
107
+ /** These are the functions that the assistant can execute during the call. */
108
+ functions?: OpenAIFunction[];
109
+ }
110
+
111
+ export interface DeepInfraModel {
112
+ provider: "deepinfra";
113
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
114
+ model: string;
115
+ /** This sets the objective and understanding for the assistant. */
116
+ systemPrompt?: string;
117
+ /**
118
+ * This is the temperature that will be used for calls. Default is 1.
119
+ * @min 0
120
+ * @max 2
121
+ */
122
+ temperature?: number;
123
+ /** These are the functions that the assistant can execute during the call. */
124
+ functions?: OpenAIFunction[];
125
+ }
126
+
127
+ export interface CustomLLMModel {
128
+ /** This is the provider that will be used for the model. Any service, including your own server, that is compatible with the OpenAI API can be used. */
129
+ provider: "custom-llm";
130
+ /** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */
33
131
  url: string;
132
+ /** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
133
+ model: string;
34
134
  /** This sets the objective and understanding for the assistant. */
35
135
  systemPrompt?: string;
136
+ /**
137
+ * This is the temperature that will be used for calls. Default is 1.
138
+ * @min 0
139
+ * @max 2
140
+ */
141
+ temperature?: number;
142
+ /** These are the functions that the assistant can execute during the call. */
143
+ functions?: OpenAIFunction[];
36
144
  }
37
145
 
38
146
  export interface DeepgramTranscriber {
@@ -63,68 +171,60 @@ export interface ElevenLabsVoice {
63
171
  *
64
172
  * Pro Voices: `11labs`, `playht`
65
173
  *
66
- * Basic Voices: `rimeai`, `deepgram`
174
+ * Basic Voices: `rime-ai`, `deepgram`
67
175
  */
68
176
  provider: "11labs";
69
- /** Defines the stability for voice settings. */
177
+ /** This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library. */
178
+ voiceId:
179
+ | "burt"
180
+ | "andrea"
181
+ | "phillip"
182
+ | "steve"
183
+ | "joseph"
184
+ | "myra"
185
+ | "paula"
186
+ | "ryan"
187
+ | "drew"
188
+ | "paul"
189
+ | "mrb"
190
+ | "matilda"
191
+ | "mark"
192
+ | string;
193
+ /**
194
+ * Defines the stability for voice settings.
195
+ * @min 0
196
+ * @max 1
197
+ * @default null
198
+ */
70
199
  stability?: number;
71
- /** Defines the similarity boost for voice settings. */
200
+ /**
201
+ * Defines the similarity boost for voice settings.
202
+ * @min 0
203
+ * @max 1
204
+ * @default null
205
+ */
72
206
  similarityBoost?: number;
73
- /** Defines the style for voice settings. */
74
- style?: boolean;
75
- /** Defines the use speaker boost for voice settings. */
76
- useSpeakerBoost?: boolean;
77
- /** This is the provider-specific ID that will be used. */
78
- voiceId: string;
79
- }
80
-
81
- export interface OpenAIFunctionParameterProperty {
82
- type: "string" | "number" | "boolean";
83
- enum?: string[];
84
- description?: string;
85
- }
86
-
87
- export interface OpenAIFunctionParameters {
88
- type: "object";
89
- properties: Record<string, OpenAIFunctionParameterProperty>;
90
- required?: string[];
91
- }
92
-
93
- export interface OpenAIFunction {
94
207
  /**
95
- * This is the the name of the function to be called.
96
- *
97
- * Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
98
- * @maxLength 64
208
+ * Defines the style for voice settings.
209
+ * @default null
99
210
  */
100
- name: string;
101
- /** Setting async: true will cause the function to be called asynchronously, meaning that the Assistant will not wait for the function to return before continuing. */
102
- async?: boolean;
103
- /** This is the description of what the function does, used by the AI to choose when and how to call the function. */
104
- description?: string;
211
+ style?: boolean;
105
212
  /**
106
- * These are the parameters the functions accepts, described as a JSON Schema object.
107
- *
108
- * See the [OpenAI guide](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.
109
- *
110
- * To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.
213
+ * Defines the use speaker boost for voice settings.
214
+ * @default null
111
215
  */
112
- parameters: OpenAIFunctionParameters;
216
+ useSpeakerBoost?: boolean;
113
217
  }
114
218
 
115
219
  export interface OpenAIModel {
116
- /**
117
- * This is the provider that will be used for the model. Currently, only OpenAI and Custom LLM URLs are supported.
118
- *
119
- * If you have your own LLM, you can use the URL of your LLM endpoint here.
120
- */
220
+ /** This is the provider that will be used for the model. */
121
221
  provider: "openai";
122
222
  /** This is the OpenAI model that will be used. */
123
223
  model: "gpt-4" | "gpt-3.5-turbo";
124
224
  /** This sets the objective and understanding for the assistant. */
125
225
  systemPrompt?: string;
126
226
  /**
127
- * This is the temperature that will be used for OpenAI calls.
227
+ * This is the temperature that will be used for calls. Default is 1.
128
228
  * @min 0
129
229
  * @max 2
130
230
  */
@@ -139,43 +239,62 @@ export interface PlayHTVoice {
139
239
  *
140
240
  * Pro Voices: `11labs`, `playht`, `openai`
141
241
  *
142
- * Basic Voices: `rimeai`, `deepgram`
242
+ * Basic Voices: `rime-ai`, `deepgram`
143
243
  */
144
244
  provider: "playht";
245
+ /** This is the provider-specific ID that will be used. */
246
+ voiceId:
247
+ | "jennifer"
248
+ | "melissa"
249
+ | "will"
250
+ | "chris"
251
+ | "matt"
252
+ | "jack"
253
+ | "ruby"
254
+ | "davis"
255
+ | "donna"
256
+ | "michael"
257
+ | string;
145
258
  /**
146
259
  * This is the speed multiplier that will be used.
147
260
  * @min 0
148
261
  * @max 5
262
+ * @default null
149
263
  */
150
264
  speed?: number;
151
265
  /**
152
266
  * A floating point number between 0, inclusive, and 2, inclusive. If equal to null or not provided, the model's default temperature will be used. The temperature parameter controls variance. Lower temperatures result in more predictable results, higher temperatures allow each run to vary more, so the voice may sound less like the baseline voice.
153
267
  * @min 0.1
154
268
  * @max 2
269
+ * @default null
155
270
  */
156
271
  temperature?: number;
157
- /** An emotion to be applied to the speech. */
272
+ /**
273
+ * An emotion to be applied to the speech.
274
+ * @default null
275
+ */
158
276
  emotion?: "female_happy" | "female_sad" | "female_angry" | "female_fearful" | "female_disgust" | "female_surprised";
159
277
  /**
160
278
  * A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
161
279
  * @min 1
162
280
  * @max 6
281
+ * @default null
163
282
  */
164
283
  voiceGuidance?: number;
165
284
  /**
166
285
  * A number between 1 and 30. Use lower numbers to to reduce how strong your chosen emotion will be. Higher numbers will create a very emotional performance.
167
286
  * @min 1
168
287
  * @max 30
288
+ * @default null
169
289
  */
170
290
  styleGuidance?: number;
171
291
  /**
172
292
  * A number between 1 and 2. This number influences how closely the generated speech adheres to the input text. Use lower values to create more fluid speech, but with a higher chance of deviating from the input text. Higher numbers will make the generated speech more accurate to the input text, ensuring that the words spoken align closely with the provided text.
173
293
  * @min 1
174
294
  * @max 2
295
+ * @default null
175
296
  */
176
297
  textGuidance?: number;
177
- /** This is the provider-specific ID that will be used. */
178
- voiceId: string;
179
298
  }
180
299
 
181
300
  export interface RimeAIVoice {
@@ -184,16 +303,28 @@ export interface RimeAIVoice {
184
303
  *
185
304
  * Pro Voices: `11labs`, `playht`, `openai`
186
305
  *
187
- * Basic Voices: `rimeai`, `deepgram`
306
+ * Basic Voices: `rime-ai`, `deepgram`
188
307
  */
189
- provider: "rimeai";
308
+ provider: "rime-ai";
309
+ /** This is the provider-specific ID that will be used. */
310
+ voiceId:
311
+ | "kai"
312
+ | "zion"
313
+ | "xavier"
314
+ | "marty"
315
+ | "hudson"
316
+ | "savannah"
317
+ | "colette"
318
+ | "daphne"
319
+ | "aurora"
320
+ | "nova"
321
+ | string;
190
322
  /**
191
323
  * This is the speed multiplier that will be used.
192
324
  * @min 0
325
+ * @default null
193
326
  */
194
327
  speed?: number;
195
- /** This is the provider-specific ID that will be used. */
196
- voiceId: string;
197
328
  }
198
329
 
199
330
  export interface OpenAIVoice {
@@ -202,87 +333,50 @@ export interface OpenAIVoice {
202
333
  *
203
334
  * Pro Voices: `11labs`, `playht`, `openai`
204
335
  *
205
- * Basic Voices: `rimeai`, `deepgram`
336
+ * Basic Voices: `rime-ai`, `deepgram`
206
337
  */
207
338
  provider: "openai";
339
+ /** This is the provider-specific ID that will be used. */
340
+ voiceId: "alloy" | "echo" | "fable" | "onyx" | "nova" | "shimmer" | string;
208
341
  /**
209
342
  * This is the speed multiplier that will be used.
210
343
  * @min 0.25
211
344
  * @max 4
345
+ * @default null
212
346
  */
213
347
  speed?: number;
214
- /** This is the provider-specific ID that will be used. */
215
- voiceId: string;
216
348
  }
217
349
 
218
350
  export interface CreateAssistantDTO {
219
351
  /**
220
352
  * This is the name of the assistant. This is just for your own reference.
221
353
  * @maxLength 100
354
+ * @default null
222
355
  */
223
356
  name?: string;
224
- /** These are the options for the assistant's transcriber. */
357
+ /**
358
+ * These are the options for the assistant's transcriber.
359
+ * @default null
360
+ */
225
361
  transcriber?: DeepgramTranscriber;
226
362
  /** These are the options for the assistant's LLM. */
227
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
363
+ model?:
364
+ | OpenAIModel
365
+ | TogetherAIModel
366
+ | AnyscaleModel
367
+ | OpenRouterModel
368
+ | PerplexityAIModel
369
+ | DeepInfraModel
370
+ | CustomLLMModel;
228
371
  /**
229
372
  * These are the options for the assistant's voice.
230
- * @default "jennifer-playht"
231
- */
232
- voice?:
233
- | "jennifer-playht"
234
- | "melissa-playht"
235
- | "will-playht"
236
- | "chris-playht"
237
- | "matt-playht"
238
- | "jack-playht"
239
- | "ruby-playht"
240
- | "davis-playht"
241
- | "donna-playht"
242
- | "michael-playht"
243
- | "burt-11labs"
244
- | "andrea-11labs"
245
- | "phillip-11labs"
246
- | "steve-11labs"
247
- | "joseph-11labs"
248
- | "myra-11labs"
249
- | "paula-11labs"
250
- | "ryan-11labs"
251
- | "drew-11labs"
252
- | "paul-11labs"
253
- | "mrb-11labs"
254
- | "matilda-11labs"
255
- | "kai-rimeai"
256
- | "zion-rimeai"
257
- | "xavier-rimeai"
258
- | "marty-rimeai"
259
- | "hudson-rimeai"
260
- | "savannah-rimeai"
261
- | "colette-rimeai"
262
- | "daphne-rimeai"
263
- | "aurora-rimeai"
264
- | "nova-rimeai"
265
- | "aurora-deepgram"
266
- | "asteria-deepgram"
267
- | "artemis-deepgram"
268
- | "andromeda-deepgram"
269
- | "stella-deepgram"
270
- | "orion-deepgram"
271
- | "atlas-deepgram"
272
- | "alloy-openai"
273
- | "echo-openai"
274
- | "fable-openai"
275
- | "onyx-openai"
276
- | "nova-openai"
277
- | "shimmer-openai"
278
- | ElevenLabsVoice
279
- | PlayHTVoice
280
- | RimeAIVoice
281
- | DeepgramVoice
282
- | OpenAIVoice;
373
+ * @default {"provider":"playht","voiceId":"jennifer"}
374
+ */
375
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
283
376
  /**
284
377
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
285
378
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
379
+ * @default null
286
380
  */
287
381
  language?:
288
382
  | "en"
@@ -303,7 +397,7 @@ export interface CreateAssistantDTO {
303
397
  /** This is the number to forward to if assistant runs into issues. */
304
398
  forwardingPhoneNumber?: string;
305
399
  /**
306
- * This is the first message that the assistant will say.
400
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
307
401
  *
308
402
  * If unspecified, it will wait for the user to speak.
309
403
  * @maxLength 1000
@@ -315,6 +409,7 @@ export interface CreateAssistantDTO {
315
409
  *
316
410
  * If unspecified, it will hang up.
317
411
  * @maxLength 1000
412
+ * @default null
318
413
  */
319
414
  voicemailMessage?: string;
320
415
  /**
@@ -322,88 +417,79 @@ export interface CreateAssistantDTO {
322
417
  *
323
418
  * If unspecified, it will hang up without saying anything.
324
419
  * @maxLength 400
420
+ * @default null
325
421
  */
326
422
  endCallMessage?: string;
327
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
423
+ /**
424
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
425
+ * @default null
426
+ */
328
427
  interruptionsEnabled?: boolean;
329
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
428
+ /**
429
+ * This sets whether the assistant's calls are recorded. Defaults to true.
430
+ * @default null
431
+ */
330
432
  recordingEnabled?: boolean;
331
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
433
+ /**
434
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
435
+ * @default null
436
+ */
332
437
  endCallFunctionEnabled?: boolean;
333
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
438
+ /**
439
+ * This sets whether the assistant will use fillers like Well..., Okay cool..., etc. This will modify your prompt slightly, which could result in differing completions. Defaults to false.
440
+ * @default null
441
+ */
334
442
  fillersEnabled?: boolean;
335
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
336
- liveTranscriptsEnabled?: boolean;
443
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
444
+ clientMessages?: "function-call" | "transcript" | "hang";
445
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
446
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
447
+ /**
448
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
449
+ * @min 10
450
+ * @max 600
451
+ * @default null
452
+ */
453
+ silenceTimeoutSeconds?: number;
454
+ /**
455
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
456
+ * @min 0
457
+ * @max 10
458
+ * @default null
459
+ */
460
+ responseDelaySeconds?: number;
337
461
  }
338
462
 
339
463
  export interface Assistant {
340
464
  /**
341
465
  * This is the name of the assistant. This is just for your own reference.
342
466
  * @maxLength 100
467
+ * @default null
343
468
  */
344
469
  name?: string;
345
- /** These are the options for the assistant's transcriber. */
470
+ /**
471
+ * These are the options for the assistant's transcriber.
472
+ * @default null
473
+ */
346
474
  transcriber?: DeepgramTranscriber;
347
475
  /** These are the options for the assistant's LLM. */
348
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
476
+ model?:
477
+ | OpenAIModel
478
+ | TogetherAIModel
479
+ | AnyscaleModel
480
+ | OpenRouterModel
481
+ | PerplexityAIModel
482
+ | DeepInfraModel
483
+ | CustomLLMModel;
349
484
  /**
350
485
  * These are the options for the assistant's voice.
351
- * @default "jennifer-playht"
352
- */
353
- voice?:
354
- | "jennifer-playht"
355
- | "melissa-playht"
356
- | "will-playht"
357
- | "chris-playht"
358
- | "matt-playht"
359
- | "jack-playht"
360
- | "ruby-playht"
361
- | "davis-playht"
362
- | "donna-playht"
363
- | "michael-playht"
364
- | "burt-11labs"
365
- | "andrea-11labs"
366
- | "phillip-11labs"
367
- | "steve-11labs"
368
- | "joseph-11labs"
369
- | "myra-11labs"
370
- | "paula-11labs"
371
- | "ryan-11labs"
372
- | "drew-11labs"
373
- | "paul-11labs"
374
- | "mrb-11labs"
375
- | "matilda-11labs"
376
- | "kai-rimeai"
377
- | "zion-rimeai"
378
- | "xavier-rimeai"
379
- | "marty-rimeai"
380
- | "hudson-rimeai"
381
- | "savannah-rimeai"
382
- | "colette-rimeai"
383
- | "daphne-rimeai"
384
- | "aurora-rimeai"
385
- | "nova-rimeai"
386
- | "aurora-deepgram"
387
- | "asteria-deepgram"
388
- | "artemis-deepgram"
389
- | "andromeda-deepgram"
390
- | "stella-deepgram"
391
- | "orion-deepgram"
392
- | "atlas-deepgram"
393
- | "alloy-openai"
394
- | "echo-openai"
395
- | "fable-openai"
396
- | "onyx-openai"
397
- | "nova-openai"
398
- | "shimmer-openai"
399
- | ElevenLabsVoice
400
- | PlayHTVoice
401
- | RimeAIVoice
402
- | DeepgramVoice
403
- | OpenAIVoice;
486
+ * @default {"provider":"playht","voiceId":"jennifer"}
487
+ */
488
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
404
489
  /**
405
490
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
406
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
407
493
  */
408
494
  language?:
409
495
  | "en"
@@ -424,7 +510,7 @@ export interface Assistant {
424
510
  /** This is the number to forward to if assistant runs into issues. */
425
511
  forwardingPhoneNumber?: string;
426
512
  /**
427
- * This is the first message that the assistant will say.
513
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
428
514
  *
429
515
  * If unspecified, it will wait for the user to speak.
430
516
  * @maxLength 1000
@@ -436,6 +522,7 @@ export interface Assistant {
436
522
  *
437
523
  * If unspecified, it will hang up.
438
524
  * @maxLength 1000
525
+ * @default null
439
526
  */
440
527
  voicemailMessage?: string;
441
528
  /**
@@ -443,18 +530,47 @@ export interface Assistant {
443
530
  *
444
531
  * If unspecified, it will hang up without saying anything.
445
532
  * @maxLength 400
533
+ * @default null
446
534
  */
447
535
  endCallMessage?: string;
448
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
536
+ /**
537
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
538
+ * @default null
539
+ */
449
540
  interruptionsEnabled?: boolean;
450
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
541
+ /**
542
+ * This sets whether the assistant's calls are recorded. Defaults to true.
543
+ * @default null
544
+ */
451
545
  recordingEnabled?: boolean;
452
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
546
+ /**
547
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
548
+ * @default null
549
+ */
453
550
  endCallFunctionEnabled?: boolean;
454
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
551
+ /**
552
+ * 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.
553
+ * @default null
554
+ */
455
555
  fillersEnabled?: boolean;
456
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
457
- liveTranscriptsEnabled?: boolean;
556
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
557
+ clientMessages?: "function-call" | "transcript" | "hang";
558
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
559
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
560
+ /**
561
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
562
+ * @min 10
563
+ * @max 600
564
+ * @default null
565
+ */
566
+ silenceTimeoutSeconds?: number;
567
+ /**
568
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
569
+ * @min 0
570
+ * @max 10
571
+ * @default null
572
+ */
573
+ responseDelaySeconds?: number;
458
574
  /** This is the unique identifier for the assistant. */
459
575
  id: string;
460
576
  /** This is the unique identifier for the org that this assistant belongs to. */
@@ -475,70 +591,32 @@ export interface UpdateAssistantDTO {
475
591
  /**
476
592
  * This is the name of the assistant. This is just for your own reference.
477
593
  * @maxLength 100
594
+ * @default null
478
595
  */
479
596
  name?: string;
480
- /** These are the options for the assistant's transcriber. */
597
+ /**
598
+ * These are the options for the assistant's transcriber.
599
+ * @default null
600
+ */
481
601
  transcriber?: DeepgramTranscriber;
482
602
  /** These are the options for the assistant's LLM. */
483
- model?: "gpt-4" | "gpt-3.5-turbo" | "custom" | OpenAIModel | CustomModel;
603
+ model?:
604
+ | OpenAIModel
605
+ | TogetherAIModel
606
+ | AnyscaleModel
607
+ | OpenRouterModel
608
+ | PerplexityAIModel
609
+ | DeepInfraModel
610
+ | CustomLLMModel;
484
611
  /**
485
612
  * These are the options for the assistant's voice.
486
- * @default "jennifer-playht"
487
- */
488
- voice?:
489
- | "jennifer-playht"
490
- | "melissa-playht"
491
- | "will-playht"
492
- | "chris-playht"
493
- | "matt-playht"
494
- | "jack-playht"
495
- | "ruby-playht"
496
- | "davis-playht"
497
- | "donna-playht"
498
- | "michael-playht"
499
- | "burt-11labs"
500
- | "andrea-11labs"
501
- | "phillip-11labs"
502
- | "steve-11labs"
503
- | "joseph-11labs"
504
- | "myra-11labs"
505
- | "paula-11labs"
506
- | "ryan-11labs"
507
- | "drew-11labs"
508
- | "paul-11labs"
509
- | "mrb-11labs"
510
- | "matilda-11labs"
511
- | "kai-rimeai"
512
- | "zion-rimeai"
513
- | "xavier-rimeai"
514
- | "marty-rimeai"
515
- | "hudson-rimeai"
516
- | "savannah-rimeai"
517
- | "colette-rimeai"
518
- | "daphne-rimeai"
519
- | "aurora-rimeai"
520
- | "nova-rimeai"
521
- | "aurora-deepgram"
522
- | "asteria-deepgram"
523
- | "artemis-deepgram"
524
- | "andromeda-deepgram"
525
- | "stella-deepgram"
526
- | "orion-deepgram"
527
- | "atlas-deepgram"
528
- | "alloy-openai"
529
- | "echo-openai"
530
- | "fable-openai"
531
- | "onyx-openai"
532
- | "nova-openai"
533
- | "shimmer-openai"
534
- | ElevenLabsVoice
535
- | PlayHTVoice
536
- | RimeAIVoice
537
- | DeepgramVoice
538
- | OpenAIVoice;
613
+ * @default {"provider":"playht","voiceId":"jennifer"}
614
+ */
615
+ voice?: ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
539
616
  /**
540
617
  * This sets the spoken language of the user. The assistant will do its best to respond in the same language.
541
618
  * When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
619
+ * @default null
542
620
  */
543
621
  language?:
544
622
  | "en"
@@ -559,7 +637,7 @@ export interface UpdateAssistantDTO {
559
637
  /** This is the number to forward to if assistant runs into issues. */
560
638
  forwardingPhoneNumber?: string;
561
639
  /**
562
- * This is the first message that the assistant will say.
640
+ * This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
563
641
  *
564
642
  * If unspecified, it will wait for the user to speak.
565
643
  * @maxLength 1000
@@ -571,6 +649,7 @@ export interface UpdateAssistantDTO {
571
649
  *
572
650
  * If unspecified, it will hang up.
573
651
  * @maxLength 1000
652
+ * @default null
574
653
  */
575
654
  voicemailMessage?: string;
576
655
  /**
@@ -578,18 +657,47 @@ export interface UpdateAssistantDTO {
578
657
  *
579
658
  * If unspecified, it will hang up without saying anything.
580
659
  * @maxLength 400
660
+ * @default null
581
661
  */
582
662
  endCallMessage?: string;
583
- /** This sets whether the user can interrupt the assistant while it's speaking. Defaults to true. */
663
+ /**
664
+ * This sets whether the user can interrupt the assistant while it's speaking. Defaults to true.
665
+ * @default null
666
+ */
584
667
  interruptionsEnabled?: boolean;
585
- /** This sets whether the assistant's calls are recorded. Defaults to true. */
668
+ /**
669
+ * This sets whether the assistant's calls are recorded. Defaults to true.
670
+ * @default null
671
+ */
586
672
  recordingEnabled?: boolean;
587
- /** This sets whether the assistant will be able to hang up the call. Defaults to false. */
673
+ /**
674
+ * This sets whether the assistant will be able to hang up the call. Defaults to false.
675
+ * @default null
676
+ */
588
677
  endCallFunctionEnabled?: boolean;
589
- /** This sets whether the assistant will use fillers like Well..., Okay cool..., etc. Defaults to true when using gpt-4. Else, defaults to false. */
678
+ /**
679
+ * 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.
680
+ * @default null
681
+ */
590
682
  fillersEnabled?: boolean;
591
- /** This sets whether the assistant will send live transcriptions to the Server URL and/or Vapi clients. */
592
- liveTranscriptsEnabled?: boolean;
683
+ /** These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call'] */
684
+ clientMessages?: "function-call" | "transcript" | "hang";
685
+ /** These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call'] */
686
+ serverMessages?: "end-of-call-report" | "function-call" | "status-update" | "transcript" | "hang";
687
+ /**
688
+ * How many seconds of silence to wait before ending the call. Defaults to 30.
689
+ * @min 10
690
+ * @max 600
691
+ * @default null
692
+ */
693
+ silenceTimeoutSeconds?: number;
694
+ /**
695
+ * The minimum number of seconds after user speech to wait before the assistant starts speaking. Defaults to 0.4.
696
+ * @min 0
697
+ * @max 10
698
+ * @default null
699
+ */
700
+ responseDelaySeconds?: number;
593
701
  }
594
702
 
595
703
  export interface CreateCustomerDTO {
@@ -634,19 +742,40 @@ export interface Call {
634
742
  | "assistant-forwarded-call"
635
743
  | "assistant-join-timed-out"
636
744
  | "assistant-not-found"
637
- | "manually-canceled"
638
745
  | "customer-busy"
639
746
  | "customer-ended-call"
640
747
  | "customer-did-not-answer"
641
748
  | "db-error"
642
749
  | "exceeded-max-duration"
750
+ | "manually-canceled"
643
751
  | "no-server-available"
752
+ | "pipeline-error-custom-llm-response-was-invalid"
753
+ | "pipeline-error-custom-llm-request-failed"
754
+ | "pipeline-error-extra-function-failed"
755
+ | "pipeline-error-first-message-failed"
756
+ | "pipeline-error-function-filler-failed"
757
+ | "pipeline-error-function-failed"
758
+ | "pipeline-error-llm-failed"
759
+ | "pipeline-error-openai-voice-failed"
760
+ | "pipeline-error-deepgram-transcriber-failed"
761
+ | "pipeline-error-deepgram-voice-failed"
762
+ | "pipeline-error-eleven-labs-voice-failed"
763
+ | "pipeline-error-eleven-labs-voice-not-found"
764
+ | "pipeline-error-playht-voice-failed"
765
+ | "pipeline-error-rime-ai-voice-failed"
644
766
  | "server-shutdown"
645
767
  | "silence-timed-out"
646
768
  | "twilio-failed-to-connect-call"
647
769
  | "twilio-closed-websocket"
648
770
  | "unknown-error"
649
771
  | "voicemail";
772
+ /**
773
+ * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
774
+ * @min 10
775
+ * @max 3600
776
+ * @default null
777
+ */
778
+ maxDurationSeconds?: number;
650
779
  /** This is the unique identifier for the call. */
651
780
  id: string;
652
781
  /** This is the unique identifier for the org that this call belongs to. */
@@ -724,6 +853,13 @@ export interface Call {
724
853
  }
725
854
 
726
855
  export interface CreateOutboundCallDTO {
856
+ /**
857
+ * This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
858
+ * @min 10
859
+ * @max 3600
860
+ * @default null
861
+ */
862
+ maxDurationSeconds?: number;
727
863
  /** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
728
864
  assistantId?: string;
729
865
  /** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
@@ -802,10 +938,10 @@ export interface DeepgramCredential {
802
938
  updatedAt: string;
803
939
  }
804
940
 
805
- export interface AzureOpenAICredential {
806
- provider: "azure-openai";
941
+ export interface ElevenLabsCredential {
942
+ provider: "11labs";
807
943
  /** This is not returned in the API. */
808
- openAIKey: string;
944
+ apiKey: string;
809
945
  /** This is the unique identifier for the credential. */
810
946
  id: string;
811
947
  /** This is the unique identifier for the org that this credential belongs to. */
@@ -820,11 +956,10 @@ export interface AzureOpenAICredential {
820
956
  * @format date-time
821
957
  */
822
958
  updatedAt: string;
823
- openAIEndpoint: string;
824
959
  }
825
960
 
826
- export interface ElevenLabsCredential {
827
- provider: "11labs";
961
+ export interface PlayHTCredential {
962
+ provider: "playht";
828
963
  /** This is not returned in the API. */
829
964
  apiKey: string;
830
965
  /** This is the unique identifier for the credential. */
@@ -841,10 +976,11 @@ export interface ElevenLabsCredential {
841
976
  * @format date-time
842
977
  */
843
978
  updatedAt: string;
979
+ userId: string;
844
980
  }
845
981
 
846
- export interface PlayHTCredential {
847
- provider: "playht";
982
+ export interface RimeAICredential {
983
+ provider: "rime-ai";
848
984
  /** This is not returned in the API. */
849
985
  apiKey: string;
850
986
  /** This is the unique identifier for the credential. */
@@ -861,11 +997,150 @@ export interface PlayHTCredential {
861
997
  * @format date-time
862
998
  */
863
999
  updatedAt: string;
864
- userId: string;
865
1000
  }
866
1001
 
867
- export interface RimeAICredential {
868
- provider: "rimeai";
1002
+ export interface OpenAICredential {
1003
+ provider: "openai";
1004
+ /** This is not returned in the API. */
1005
+ apiKey: string;
1006
+ /** This is the unique identifier for the credential. */
1007
+ id: string;
1008
+ /** This is the unique identifier for the org that this credential belongs to. */
1009
+ orgId: string;
1010
+ /**
1011
+ * This is the ISO 8601 date-time string of when the credential was created.
1012
+ * @format date-time
1013
+ */
1014
+ createdAt: string;
1015
+ /**
1016
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1017
+ * @format date-time
1018
+ */
1019
+ updatedAt: string;
1020
+ }
1021
+
1022
+ export interface TogetherAICredential {
1023
+ provider: "together-ai";
1024
+ /** This is not returned in the API. */
1025
+ apiKey: string;
1026
+ /** This is the unique identifier for the credential. */
1027
+ id: string;
1028
+ /** This is the unique identifier for the org that this credential belongs to. */
1029
+ orgId: string;
1030
+ /**
1031
+ * This is the ISO 8601 date-time string of when the credential was created.
1032
+ * @format date-time
1033
+ */
1034
+ createdAt: string;
1035
+ /**
1036
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1037
+ * @format date-time
1038
+ */
1039
+ updatedAt: string;
1040
+ }
1041
+
1042
+ export interface AnyscaleCredential {
1043
+ provider: "anyscale";
1044
+ /** This is not returned in the API. */
1045
+ apiKey: string;
1046
+ /** This is the unique identifier for the credential. */
1047
+ id: string;
1048
+ /** This is the unique identifier for the org that this credential belongs to. */
1049
+ orgId: string;
1050
+ /**
1051
+ * This is the ISO 8601 date-time string of when the credential was created.
1052
+ * @format date-time
1053
+ */
1054
+ createdAt: string;
1055
+ /**
1056
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1057
+ * @format date-time
1058
+ */
1059
+ updatedAt: string;
1060
+ }
1061
+
1062
+ export interface OpenRouterCredential {
1063
+ provider: "openrouter";
1064
+ /** This is not returned in the API. */
1065
+ apiKey: string;
1066
+ /** This is the unique identifier for the credential. */
1067
+ id: string;
1068
+ /** This is the unique identifier for the org that this credential belongs to. */
1069
+ orgId: string;
1070
+ /**
1071
+ * This is the ISO 8601 date-time string of when the credential was created.
1072
+ * @format date-time
1073
+ */
1074
+ createdAt: string;
1075
+ /**
1076
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1077
+ * @format date-time
1078
+ */
1079
+ updatedAt: string;
1080
+ }
1081
+
1082
+ export interface PerplexityAICredential {
1083
+ provider: "perplexity-ai";
1084
+ /** This is not returned in the API. */
1085
+ apiKey: string;
1086
+ /** This is the unique identifier for the credential. */
1087
+ id: string;
1088
+ /** This is the unique identifier for the org that this credential belongs to. */
1089
+ orgId: string;
1090
+ /**
1091
+ * This is the ISO 8601 date-time string of when the credential was created.
1092
+ * @format date-time
1093
+ */
1094
+ createdAt: string;
1095
+ /**
1096
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1097
+ * @format date-time
1098
+ */
1099
+ updatedAt: string;
1100
+ }
1101
+
1102
+ export interface DeepInfraCredential {
1103
+ provider: "deepinfra";
1104
+ /** This is not returned in the API. */
1105
+ apiKey: string;
1106
+ /** This is the unique identifier for the credential. */
1107
+ id: string;
1108
+ /** This is the unique identifier for the org that this credential belongs to. */
1109
+ orgId: string;
1110
+ /**
1111
+ * This is the ISO 8601 date-time string of when the credential was created.
1112
+ * @format date-time
1113
+ */
1114
+ createdAt: string;
1115
+ /**
1116
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1117
+ * @format date-time
1118
+ */
1119
+ updatedAt: string;
1120
+ }
1121
+
1122
+ export interface CustomLLMCredential {
1123
+ provider: "custom-llm";
1124
+ /** This is not returned in the API. */
1125
+ apiKey: string;
1126
+ /** This is the unique identifier for the credential. */
1127
+ id: string;
1128
+ /** This is the unique identifier for the org that this credential belongs to. */
1129
+ orgId: string;
1130
+ /**
1131
+ * This is the ISO 8601 date-time string of when the credential was created.
1132
+ * @format date-time
1133
+ */
1134
+ createdAt: string;
1135
+ /**
1136
+ * This is the ISO 8601 date-time string of when the assistant was last updated.
1137
+ * @format date-time
1138
+ */
1139
+ updatedAt: string;
1140
+ }
1141
+
1142
+ export interface RunpodCredential {
1143
+ provider: "runpod";
869
1144
  /** This is not returned in the API. */
870
1145
  apiKey: string;
871
1146
  /** This is the unique identifier for the credential. */
@@ -897,11 +1172,46 @@ export interface CreateDeepgramCredentialDTO {
897
1172
  apiKey: string;
898
1173
  }
899
1174
 
900
- export interface CreateAzureOpenAICredentialDTO {
901
- provider: "azure-openai";
1175
+ export interface CreateOpenAICredentialDTO {
1176
+ provider: "openai";
1177
+ /** This is not returned in the API. */
1178
+ apiKey: string;
1179
+ }
1180
+
1181
+ export interface CreateTogetherAICredentialDTO {
1182
+ provider: "together-ai";
1183
+ /** This is not returned in the API. */
1184
+ apiKey: string;
1185
+ }
1186
+
1187
+ export interface CreateAnyscaleCredentialDTO {
1188
+ provider: "anyscale";
1189
+ /** This is not returned in the API. */
1190
+ apiKey: string;
1191
+ }
1192
+
1193
+ export interface CreateOpenRouterCredentialDTO {
1194
+ provider: "openrouter";
902
1195
  /** This is not returned in the API. */
903
- openAIKey: string;
904
- openAIEndpoint: string;
1196
+ apiKey: string;
1197
+ }
1198
+
1199
+ export interface CreatePerplexityAICredentialDTO {
1200
+ provider: "perplexity-ai";
1201
+ /** This is not returned in the API. */
1202
+ apiKey: string;
1203
+ }
1204
+
1205
+ export interface CreateDeepInfraCredentialDTO {
1206
+ provider: "deepinfra";
1207
+ /** This is not returned in the API. */
1208
+ apiKey: string;
1209
+ }
1210
+
1211
+ export interface CreateCustomLLMCredentialDTO {
1212
+ provider: "custom-llm";
1213
+ /** This is not returned in the API. */
1214
+ apiKey: string;
905
1215
  }
906
1216
 
907
1217
  export interface CreateElevenLabsCredentialDTO {
@@ -918,7 +1228,13 @@ export interface CreatePlayHTCredentialDTO {
918
1228
  }
919
1229
 
920
1230
  export interface CreateRimeAICredentialDTO {
921
- provider: "rimeai";
1231
+ provider: "rime-ai";
1232
+ /** This is not returned in the API. */
1233
+ apiKey: string;
1234
+ }
1235
+
1236
+ export interface CreateRunpodCredentialDTO {
1237
+ provider: "runpod";
922
1238
  /** This is not returned in the API. */
923
1239
  apiKey: string;
924
1240
  }
@@ -936,11 +1252,46 @@ export interface UpdateDeepgramCredentialDTO {
936
1252
  apiKey: string;
937
1253
  }
938
1254
 
939
- export interface UpdateAzureOpenAICredentialDTO {
940
- provider: "azure-openai";
1255
+ export interface UpdateOpenAICredentialDTO {
1256
+ provider: "openai";
1257
+ /** This is not returned in the API. */
1258
+ apiKey: string;
1259
+ }
1260
+
1261
+ export interface UpdateTogetherAICredentialDTO {
1262
+ provider: "together-ai";
1263
+ /** This is not returned in the API. */
1264
+ apiKey: string;
1265
+ }
1266
+
1267
+ export interface UpdateAnyscaleCredentialDTO {
1268
+ provider: "anyscale";
1269
+ /** This is not returned in the API. */
1270
+ apiKey: string;
1271
+ }
1272
+
1273
+ export interface UpdateOpenRouterCredentialDTO {
1274
+ provider: "openrouter";
1275
+ /** This is not returned in the API. */
1276
+ apiKey: string;
1277
+ }
1278
+
1279
+ export interface UpdatePerplexityAICredentialDTO {
1280
+ provider: "perplexity-ai";
1281
+ /** This is not returned in the API. */
1282
+ apiKey: string;
1283
+ }
1284
+
1285
+ export interface UpdateDeepInfraCredentialDTO {
1286
+ provider: "deepinfra";
1287
+ /** This is not returned in the API. */
1288
+ apiKey: string;
1289
+ }
1290
+
1291
+ export interface UpdateCustomLLMCredentialDTO {
1292
+ provider: "custom-llm";
941
1293
  /** This is not returned in the API. */
942
- openAIKey: string;
943
- openAIEndpoint: string;
1294
+ apiKey: string;
944
1295
  }
945
1296
 
946
1297
  export interface UpdateElevenLabsCredentialDTO {
@@ -957,7 +1308,13 @@ export interface UpdatePlayHTCredentialDTO {
957
1308
  }
958
1309
 
959
1310
  export interface UpdateRimeAICredentialDTO {
960
- provider: "rimeai";
1311
+ provider: "rime-ai";
1312
+ /** This is not returned in the API. */
1313
+ apiKey: string;
1314
+ }
1315
+
1316
+ export interface UpdateRunpodCredentialDTO {
1317
+ provider: "runpod";
961
1318
  /** This is not returned in the API. */
962
1319
  apiKey: string;
963
1320
  }
@@ -1343,6 +1700,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1343
1700
  ...params,
1344
1701
  }),
1345
1702
 
1703
+ /**
1704
+ * No description
1705
+ *
1706
+ * @tags Assistants
1707
+ * @name AssistantControllerReplace
1708
+ * @summary Replace Assistant
1709
+ * @request PUT:/assistant/{id}
1710
+ * @secure
1711
+ */
1712
+ assistantControllerReplace: (id: string, data: UpdateAssistantDTO, params: RequestParams = {}) =>
1713
+ this.request<Assistant, any>({
1714
+ path: `/assistant/${id}`,
1715
+ method: "PUT",
1716
+ body: data,
1717
+ secure: true,
1718
+ type: ContentType.Json,
1719
+ format: "json",
1720
+ ...params,
1721
+ }),
1722
+
1346
1723
  /**
1347
1724
  * No description
1348
1725
  *
@@ -1457,8 +1834,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1457
1834
  provider: "deepgram";
1458
1835
  } & CreateDeepgramCredentialDTO)
1459
1836
  | ({
1460
- provider: "azure-openai";
1461
- } & CreateAzureOpenAICredentialDTO)
1837
+ provider: "openai";
1838
+ } & CreateOpenAICredentialDTO)
1839
+ | ({
1840
+ provider: "together-ai";
1841
+ } & CreateTogetherAICredentialDTO)
1842
+ | ({
1843
+ provider: "anyscale";
1844
+ } & CreateAnyscaleCredentialDTO)
1845
+ | ({
1846
+ provider: "openrouter";
1847
+ } & CreateOpenRouterCredentialDTO)
1848
+ | ({
1849
+ provider: "perplexity-ai";
1850
+ } & CreatePerplexityAICredentialDTO)
1851
+ | ({
1852
+ provider: "deepinfra";
1853
+ } & CreateDeepInfraCredentialDTO)
1854
+ | ({
1855
+ provider: "custom-llm";
1856
+ } & CreateCustomLLMCredentialDTO)
1462
1857
  | ({
1463
1858
  provider: "11labs";
1464
1859
  } & CreateElevenLabsCredentialDTO)
@@ -1466,8 +1861,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1466
1861
  provider: "playht";
1467
1862
  } & CreatePlayHTCredentialDTO)
1468
1863
  | ({
1469
- provider: "rimeai";
1470
- } & CreateRimeAICredentialDTO),
1864
+ provider: "rime-ai";
1865
+ } & CreateRimeAICredentialDTO)
1866
+ | ({
1867
+ provider: "runpod";
1868
+ } & CreateRunpodCredentialDTO),
1471
1869
  params: RequestParams = {},
1472
1870
  ) =>
1473
1871
  this.request<
@@ -1478,8 +1876,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1478
1876
  provider: "deepgram";
1479
1877
  } & DeepgramCredential)
1480
1878
  | ({
1481
- provider: "azure-openai";
1482
- } & AzureOpenAICredential)
1879
+ provider: "openai";
1880
+ } & OpenAICredential)
1881
+ | ({
1882
+ provider: "together-ai";
1883
+ } & TogetherAICredential)
1884
+ | ({
1885
+ provider: "anyscale";
1886
+ } & AnyscaleCredential)
1887
+ | ({
1888
+ provider: "openrouter";
1889
+ } & OpenRouterCredential)
1890
+ | ({
1891
+ provider: "perplexity-ai";
1892
+ } & PerplexityAICredential)
1893
+ | ({
1894
+ provider: "deepinfra";
1895
+ } & DeepInfraCredential)
1896
+ | ({
1897
+ provider: "custom-llm";
1898
+ } & CustomLLMCredential)
1483
1899
  | ({
1484
1900
  provider: "11labs";
1485
1901
  } & ElevenLabsCredential)
@@ -1487,8 +1903,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1487
1903
  provider: "playht";
1488
1904
  } & PlayHTCredential)
1489
1905
  | ({
1490
- provider: "rimeai";
1491
- } & RimeAICredential),
1906
+ provider: "rime-ai";
1907
+ } & RimeAICredential)
1908
+ | ({
1909
+ provider: "runpod";
1910
+ } & RunpodCredential),
1492
1911
  any
1493
1912
  >({
1494
1913
  path: `/credential`,
@@ -1519,8 +1938,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1519
1938
  provider: "deepgram";
1520
1939
  } & DeepgramCredential)
1521
1940
  | ({
1522
- provider: "azure-openai";
1523
- } & AzureOpenAICredential)
1941
+ provider: "openai";
1942
+ } & OpenAICredential)
1943
+ | ({
1944
+ provider: "together-ai";
1945
+ } & TogetherAICredential)
1946
+ | ({
1947
+ provider: "anyscale";
1948
+ } & AnyscaleCredential)
1949
+ | ({
1950
+ provider: "openrouter";
1951
+ } & OpenRouterCredential)
1952
+ | ({
1953
+ provider: "perplexity-ai";
1954
+ } & PerplexityAICredential)
1955
+ | ({
1956
+ provider: "deepinfra";
1957
+ } & DeepInfraCredential)
1958
+ | ({
1959
+ provider: "custom-llm";
1960
+ } & CustomLLMCredential)
1524
1961
  | ({
1525
1962
  provider: "11labs";
1526
1963
  } & ElevenLabsCredential)
@@ -1528,8 +1965,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1528
1965
  provider: "playht";
1529
1966
  } & PlayHTCredential)
1530
1967
  | ({
1531
- provider: "rimeai";
1968
+ provider: "rime-ai";
1532
1969
  } & RimeAICredential)
1970
+ | ({
1971
+ provider: "runpod";
1972
+ } & RunpodCredential)
1533
1973
  )[],
1534
1974
  any
1535
1975
  >({
@@ -1558,8 +1998,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1558
1998
  provider: "deepgram";
1559
1999
  } & DeepgramCredential)
1560
2000
  | ({
1561
- provider: "azure-openai";
1562
- } & AzureOpenAICredential)
2001
+ provider: "openai";
2002
+ } & OpenAICredential)
2003
+ | ({
2004
+ provider: "together-ai";
2005
+ } & TogetherAICredential)
2006
+ | ({
2007
+ provider: "anyscale";
2008
+ } & AnyscaleCredential)
2009
+ | ({
2010
+ provider: "openrouter";
2011
+ } & OpenRouterCredential)
2012
+ | ({
2013
+ provider: "perplexity-ai";
2014
+ } & PerplexityAICredential)
2015
+ | ({
2016
+ provider: "deepinfra";
2017
+ } & DeepInfraCredential)
2018
+ | ({
2019
+ provider: "custom-llm";
2020
+ } & CustomLLMCredential)
1563
2021
  | ({
1564
2022
  provider: "11labs";
1565
2023
  } & ElevenLabsCredential)
@@ -1567,8 +2025,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1567
2025
  provider: "playht";
1568
2026
  } & PlayHTCredential)
1569
2027
  | ({
1570
- provider: "rimeai";
1571
- } & RimeAICredential),
2028
+ provider: "rime-ai";
2029
+ } & RimeAICredential)
2030
+ | ({
2031
+ provider: "runpod";
2032
+ } & RunpodCredential),
1572
2033
  any
1573
2034
  >({
1574
2035
  path: `/credential/${id}`,
@@ -1597,8 +2058,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1597
2058
  provider: "deepgram";
1598
2059
  } & UpdateDeepgramCredentialDTO)
1599
2060
  | ({
1600
- provider: "azure-openai";
1601
- } & UpdateAzureOpenAICredentialDTO)
2061
+ provider: "openai";
2062
+ } & UpdateOpenAICredentialDTO)
2063
+ | ({
2064
+ provider: "together-ai";
2065
+ } & UpdateTogetherAICredentialDTO)
2066
+ | ({
2067
+ provider: "anyscale";
2068
+ } & UpdateAnyscaleCredentialDTO)
2069
+ | ({
2070
+ provider: "openrouter";
2071
+ } & UpdateOpenRouterCredentialDTO)
2072
+ | ({
2073
+ provider: "perplexity-ai";
2074
+ } & UpdatePerplexityAICredentialDTO)
2075
+ | ({
2076
+ provider: "deepinfra";
2077
+ } & UpdateDeepInfraCredentialDTO)
2078
+ | ({
2079
+ provider: "custom-llm";
2080
+ } & UpdateCustomLLMCredentialDTO)
1602
2081
  | ({
1603
2082
  provider: "11labs";
1604
2083
  } & UpdateElevenLabsCredentialDTO)
@@ -1606,8 +2085,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1606
2085
  provider: "playht";
1607
2086
  } & UpdatePlayHTCredentialDTO)
1608
2087
  | ({
1609
- provider: "rimeai";
1610
- } & UpdateRimeAICredentialDTO),
2088
+ provider: "rime-ai";
2089
+ } & UpdateRimeAICredentialDTO)
2090
+ | ({
2091
+ provider: "runpod";
2092
+ } & UpdateRunpodCredentialDTO),
1611
2093
  params: RequestParams = {},
1612
2094
  ) =>
1613
2095
  this.request<
@@ -1618,8 +2100,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1618
2100
  provider: "deepgram";
1619
2101
  } & DeepgramCredential)
1620
2102
  | ({
1621
- provider: "azure-openai";
1622
- } & AzureOpenAICredential)
2103
+ provider: "openai";
2104
+ } & OpenAICredential)
2105
+ | ({
2106
+ provider: "together-ai";
2107
+ } & TogetherAICredential)
2108
+ | ({
2109
+ provider: "anyscale";
2110
+ } & AnyscaleCredential)
2111
+ | ({
2112
+ provider: "openrouter";
2113
+ } & OpenRouterCredential)
2114
+ | ({
2115
+ provider: "perplexity-ai";
2116
+ } & PerplexityAICredential)
2117
+ | ({
2118
+ provider: "deepinfra";
2119
+ } & DeepInfraCredential)
2120
+ | ({
2121
+ provider: "custom-llm";
2122
+ } & CustomLLMCredential)
1623
2123
  | ({
1624
2124
  provider: "11labs";
1625
2125
  } & ElevenLabsCredential)
@@ -1627,8 +2127,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1627
2127
  provider: "playht";
1628
2128
  } & PlayHTCredential)
1629
2129
  | ({
1630
- provider: "rimeai";
1631
- } & RimeAICredential),
2130
+ provider: "rime-ai";
2131
+ } & RimeAICredential)
2132
+ | ({
2133
+ provider: "runpod";
2134
+ } & RunpodCredential),
1632
2135
  any
1633
2136
  >({
1634
2137
  path: `/credential/${id}`,
@@ -1658,8 +2161,26 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1658
2161
  provider: "deepgram";
1659
2162
  } & DeepgramCredential)
1660
2163
  | ({
1661
- provider: "azure-openai";
1662
- } & AzureOpenAICredential)
2164
+ provider: "openai";
2165
+ } & OpenAICredential)
2166
+ | ({
2167
+ provider: "together-ai";
2168
+ } & TogetherAICredential)
2169
+ | ({
2170
+ provider: "anyscale";
2171
+ } & AnyscaleCredential)
2172
+ | ({
2173
+ provider: "openrouter";
2174
+ } & OpenRouterCredential)
2175
+ | ({
2176
+ provider: "perplexity-ai";
2177
+ } & PerplexityAICredential)
2178
+ | ({
2179
+ provider: "deepinfra";
2180
+ } & DeepInfraCredential)
2181
+ | ({
2182
+ provider: "custom-llm";
2183
+ } & CustomLLMCredential)
1663
2184
  | ({
1664
2185
  provider: "11labs";
1665
2186
  } & ElevenLabsCredential)
@@ -1667,8 +2188,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
1667
2188
  provider: "playht";
1668
2189
  } & PlayHTCredential)
1669
2190
  | ({
1670
- provider: "rimeai";
1671
- } & RimeAICredential),
2191
+ provider: "rime-ai";
2192
+ } & RimeAICredential)
2193
+ | ({
2194
+ provider: "runpod";
2195
+ } & RunpodCredential),
1672
2196
  any
1673
2197
  >({
1674
2198
  path: `/credential/${id}`,