@vapi-ai/web 1.0.266 → 1.1.0
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/.prettierrc +5 -0
- package/README.md +7 -2
- package/api.ts +915 -525
- package/dist/api.d.ts +511 -215
- package/dist/api.js +83 -73
- package/dist/vapi.d.ts +15 -11
- package/dist/vapi.js +29 -26
- package/package.json +3 -3
- package/update.sh +1 -1
- package/vapi.ts +60 -71
- package/dist/AtomicMediaSource.d.ts +0 -17
- package/dist/AtomicMediaSource.js +0 -78
- package/dist/player.d.ts +0 -10
- package/dist/player.js +0 -38
package/dist/api.d.ts
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
export interface DeepgramVoice {
|
|
2
2
|
/** This is the voice provider that will be used. */
|
|
3
|
-
provider:
|
|
3
|
+
provider: 'deepgram';
|
|
4
4
|
/** This is the provider-specific ID that will be used. */
|
|
5
|
-
voiceId:
|
|
5
|
+
voiceId: 'asteria' | 'luna' | 'hera' | 'athena' | 'varun' | 'leo' | 'perseus' | 'helios' | 'angus' | string;
|
|
6
6
|
}
|
|
7
7
|
export interface OpenAIMessage {
|
|
8
8
|
content: string | null;
|
|
9
|
-
role:
|
|
9
|
+
role: 'assistant' | 'function' | 'user' | 'system';
|
|
10
10
|
function_call?: object;
|
|
11
11
|
tool_calls?: object[];
|
|
12
12
|
}
|
|
13
13
|
export interface JsonSchema {
|
|
14
|
-
type:
|
|
14
|
+
type: 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
|
|
15
15
|
/** This is of type JsonSchema. However, Swagger doesn't support circular references. */
|
|
16
16
|
items?: object;
|
|
17
17
|
/** This is an array of type JsonSchema. However, Swagger doesn't support circular references. */
|
|
@@ -82,7 +82,7 @@ export interface JsonSchema {
|
|
|
82
82
|
}
|
|
83
83
|
export interface OpenAIFunctionParameters {
|
|
84
84
|
/** This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties. */
|
|
85
|
-
type:
|
|
85
|
+
type: 'object';
|
|
86
86
|
/**
|
|
87
87
|
* This provides a description of the properties required by the function.
|
|
88
88
|
* JSON Schema can be used to specify expectations for each property.
|
|
@@ -103,7 +103,10 @@ export interface OpenAIFunction {
|
|
|
103
103
|
name: string;
|
|
104
104
|
/** 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. */
|
|
105
105
|
async?: boolean;
|
|
106
|
-
/**
|
|
106
|
+
/**
|
|
107
|
+
* This is the description of what the function does, used by the AI to choose when and how to call the function.
|
|
108
|
+
* @maxLength 1000
|
|
109
|
+
*/
|
|
107
110
|
description?: string;
|
|
108
111
|
/**
|
|
109
112
|
* These are the parameters the functions accepts, described as a JSON Schema object.
|
|
@@ -117,7 +120,7 @@ export interface OpenAIFunction {
|
|
|
117
120
|
export interface TogetherAIModel {
|
|
118
121
|
/** This is the starting state for the conversation. */
|
|
119
122
|
messages?: OpenAIMessage[];
|
|
120
|
-
provider:
|
|
123
|
+
provider: 'together-ai';
|
|
121
124
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
122
125
|
model: string;
|
|
123
126
|
/**
|
|
@@ -138,7 +141,7 @@ export interface TogetherAIModel {
|
|
|
138
141
|
export interface AnyscaleModel {
|
|
139
142
|
/** This is the starting state for the conversation. */
|
|
140
143
|
messages?: OpenAIMessage[];
|
|
141
|
-
provider:
|
|
144
|
+
provider: 'anyscale';
|
|
142
145
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
143
146
|
model: string;
|
|
144
147
|
/**
|
|
@@ -159,7 +162,7 @@ export interface AnyscaleModel {
|
|
|
159
162
|
export interface OpenRouterModel {
|
|
160
163
|
/** This is the starting state for the conversation. */
|
|
161
164
|
messages?: OpenAIMessage[];
|
|
162
|
-
provider:
|
|
165
|
+
provider: 'openrouter';
|
|
163
166
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
164
167
|
model: string;
|
|
165
168
|
/**
|
|
@@ -180,7 +183,7 @@ export interface OpenRouterModel {
|
|
|
180
183
|
export interface PerplexityAIModel {
|
|
181
184
|
/** This is the starting state for the conversation. */
|
|
182
185
|
messages?: OpenAIMessage[];
|
|
183
|
-
provider:
|
|
186
|
+
provider: 'perplexity-ai';
|
|
184
187
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
185
188
|
model: string;
|
|
186
189
|
/**
|
|
@@ -201,7 +204,7 @@ export interface PerplexityAIModel {
|
|
|
201
204
|
export interface DeepInfraModel {
|
|
202
205
|
/** This is the starting state for the conversation. */
|
|
203
206
|
messages?: OpenAIMessage[];
|
|
204
|
-
provider:
|
|
207
|
+
provider: 'deepinfra';
|
|
205
208
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
206
209
|
model: string;
|
|
207
210
|
/**
|
|
@@ -223,9 +226,11 @@ export interface CustomLLMModel {
|
|
|
223
226
|
/** This is the starting state for the conversation. */
|
|
224
227
|
messages?: OpenAIMessage[];
|
|
225
228
|
/** 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. */
|
|
226
|
-
provider:
|
|
229
|
+
provider: 'custom-llm';
|
|
227
230
|
/** These is the URL we'll use for the OpenAI client's `baseURL`. Ex. https://openrouter.ai/api/v1 */
|
|
228
231
|
url: string;
|
|
232
|
+
/** This sets whether the call object is sent in requests to the custom provider. Default is true. */
|
|
233
|
+
urlRequestMetadataEnabled: boolean;
|
|
229
234
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
230
235
|
model: string;
|
|
231
236
|
/**
|
|
@@ -247,8 +252,8 @@ export interface GroqModel {
|
|
|
247
252
|
/** This is the starting state for the conversation. */
|
|
248
253
|
messages?: OpenAIMessage[];
|
|
249
254
|
/** The key of the model from the custom provider. Ex. cognitivecomputations/dolphin-mixtral-8x7b */
|
|
250
|
-
model:
|
|
251
|
-
provider:
|
|
255
|
+
model: 'mixtral-8x7b-32768';
|
|
256
|
+
provider: 'groq';
|
|
252
257
|
/**
|
|
253
258
|
* This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.
|
|
254
259
|
* @min 0
|
|
@@ -265,18 +270,30 @@ export interface GroqModel {
|
|
|
265
270
|
maxTokens?: number;
|
|
266
271
|
}
|
|
267
272
|
export interface DeepgramTranscriber {
|
|
268
|
-
/** This is the transcription provider that will be used.
|
|
269
|
-
provider:
|
|
273
|
+
/** This is the transcription provider that will be used. */
|
|
274
|
+
provider: 'deepgram';
|
|
270
275
|
/** This is the Deepgram model that will be used. A list of models can be found here: https://developers.deepgram.com/docs/models-languages-overview */
|
|
271
|
-
model?:
|
|
276
|
+
model?: 'nova-2' | 'nova-2-general' | 'nova-2-meeting' | 'nova-2-phonecall' | 'nova-2-finance' | 'nova-2-conversationalai' | 'nova-2-voicemail' | 'nova-2-video' | 'nova-2-medical' | 'nova-2-drivethru' | 'nova-2-automotive' | string;
|
|
277
|
+
/** This is the language that will be set for the transcription. The list of languages Deepgram supports can be found here: https://developers.deepgram.com/docs/models-languages-overview */
|
|
278
|
+
language?: 'cs' | 'da' | 'da-DK' | 'nl' | 'en' | 'en-US' | 'en-AU' | 'en-GB' | 'en-NZ' | 'en-IN' | 'nl-BE' | 'fr' | 'fr-CA' | 'de' | 'el' | 'hi' | 'hi-Latn' | 'id' | 'it' | 'ja' | 'ko' | 'ko-KR' | 'no' | 'pl' | 'pt' | 'pt-BR' | 'ru' | 'es' | 'es-419' | 'sv' | 'sv-SE' | 'tr' | 'uk';
|
|
272
279
|
/** These keywords are passed to the transcription model to help it pick up use-case specific words. Anything that may not be a common word, like your company name, should be added here. */
|
|
273
280
|
keywords?: string[];
|
|
274
281
|
}
|
|
282
|
+
export interface TalkscriberTranscriber {
|
|
283
|
+
/** This is the transcription provider that will be used. */
|
|
284
|
+
provider: 'talkscriber';
|
|
285
|
+
/** This is the model that will be used for the transcription. */
|
|
286
|
+
model?: 'whisper';
|
|
287
|
+
/** This is the language that will be set for the transcription. The list of languages Whisper supports can be found here: https://github.com/openai/whisper/blob/main/whisper/tokenizer.py */
|
|
288
|
+
language?: 'en' | 'zh' | 'de' | 'es' | 'ru' | 'ko' | 'fr' | 'ja' | 'pt' | 'tr' | 'pl' | 'ca' | 'nl' | 'ar' | 'sv' | 'it' | 'id' | 'hi' | 'fi' | 'vi' | 'he' | 'uk' | 'el' | 'ms' | 'cs' | 'ro' | 'da' | 'hu' | 'ta' | 'no' | 'th' | 'ur' | 'hr' | 'bg' | 'lt' | 'la' | 'mi' | 'ml' | 'cy' | 'sk' | 'te' | 'fa' | 'lv' | 'bn' | 'sr' | 'az' | 'sl' | 'kn' | 'et' | 'mk' | 'br' | 'eu' | 'is' | 'hy' | 'ne' | 'mn' | 'bs' | 'kk' | 'sq' | 'sw' | 'gl' | 'mr' | 'pa' | 'si' | 'km' | 'sn' | 'yo' | 'so' | 'af' | 'oc' | 'ka' | 'be' | 'tg' | 'sd' | 'gu' | 'am' | 'yi' | 'lo' | 'uz' | 'fo' | 'ht' | 'ps' | 'tk' | 'nn' | 'mt' | 'sa' | 'lb' | 'my' | 'bo' | 'tl' | 'mg' | 'as' | 'tt' | 'haw' | 'ln' | 'ha' | 'ba' | 'jw' | 'su' | 'yue';
|
|
289
|
+
/** This is the mode that will be used for Whisper. If 'transcribe' is selected, the audio will be transcribed in the language selected in 'language' field. If 'translate' is selected, the audio will be translated from language selected in 'language' field to English. Default is 'translate'. */
|
|
290
|
+
mode?: 'transcribe' | 'translate';
|
|
291
|
+
}
|
|
275
292
|
export interface ElevenLabsVoice {
|
|
276
293
|
/** This is the voice provider that will be used. */
|
|
277
|
-
provider:
|
|
294
|
+
provider: '11labs';
|
|
278
295
|
/** This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library. */
|
|
279
|
-
voiceId:
|
|
296
|
+
voiceId: 'burt' | 'marissa' | 'andrea' | 'sarah' | 'phillip' | 'steve' | 'joseph' | 'myra' | 'paula' | 'ryan' | 'drew' | 'paul' | 'mrb' | 'matilda' | 'mark' | string;
|
|
280
297
|
/**
|
|
281
298
|
* Defines the stability for voice settings.
|
|
282
299
|
* @min 0
|
|
@@ -310,14 +327,19 @@ export interface ElevenLabsVoice {
|
|
|
310
327
|
* @example 4
|
|
311
328
|
*/
|
|
312
329
|
optimizeStreamingLatency?: number;
|
|
330
|
+
/**
|
|
331
|
+
* This is the model that will be used. Defaults to 'eleven_multilingual_v2' if transcriber.language is non-English, otherwise 'eleven_turbo_v2'.
|
|
332
|
+
* @example "eleven_turbo_v2"
|
|
333
|
+
*/
|
|
334
|
+
model?: 'eleven_multilingual_v2' | 'eleven_turbo_v2';
|
|
313
335
|
}
|
|
314
336
|
export interface OpenAIModel {
|
|
315
337
|
/** This is the starting state for the conversation. */
|
|
316
338
|
messages?: OpenAIMessage[];
|
|
317
339
|
/** This is the provider that will be used for the model. */
|
|
318
|
-
provider:
|
|
340
|
+
provider: 'openai';
|
|
319
341
|
/** This is the OpenAI model that will be used. */
|
|
320
|
-
model:
|
|
342
|
+
model: 'gpt-4' | 'gpt-3.5-turbo';
|
|
321
343
|
/**
|
|
322
344
|
* This is the temperature that will be used for calls. Default is 0 to leverage caching for lower latency.
|
|
323
345
|
* @min 0
|
|
@@ -335,9 +357,9 @@ export interface OpenAIModel {
|
|
|
335
357
|
}
|
|
336
358
|
export interface PlayHTVoice {
|
|
337
359
|
/** This is the voice provider that will be used. */
|
|
338
|
-
provider:
|
|
360
|
+
provider: 'playht';
|
|
339
361
|
/** This is the provider-specific ID that will be used. */
|
|
340
|
-
voiceId:
|
|
362
|
+
voiceId: 'jennifer' | 'melissa' | 'will' | 'chris' | 'matt' | 'jack' | 'ruby' | 'davis' | 'donna' | 'michael' | string;
|
|
341
363
|
/**
|
|
342
364
|
* This is the speed multiplier that will be used.
|
|
343
365
|
* @min 0
|
|
@@ -356,7 +378,7 @@ export interface PlayHTVoice {
|
|
|
356
378
|
* An emotion to be applied to the speech.
|
|
357
379
|
* @example null
|
|
358
380
|
*/
|
|
359
|
-
emotion?:
|
|
381
|
+
emotion?: 'female_happy' | 'female_sad' | 'female_angry' | 'female_fearful' | 'female_disgust' | 'female_surprised' | 'male_happy' | 'male_sad' | 'male_angry' | 'male_fearful' | 'male_disgust' | 'male_surprised';
|
|
360
382
|
/**
|
|
361
383
|
* A number between 1 and 6. Use lower numbers to reduce how unique your chosen voice will be compared to other voices.
|
|
362
384
|
* @min 1
|
|
@@ -381,9 +403,9 @@ export interface PlayHTVoice {
|
|
|
381
403
|
}
|
|
382
404
|
export interface RimeAIVoice {
|
|
383
405
|
/** This is the voice provider that will be used. */
|
|
384
|
-
provider:
|
|
406
|
+
provider: 'rime-ai';
|
|
385
407
|
/** This is the provider-specific ID that will be used. */
|
|
386
|
-
voiceId:
|
|
408
|
+
voiceId: 'kai' | 'zion' | 'xavier' | 'marty' | 'hudson' | 'savannah' | 'colette' | 'daphne' | 'aurora' | 'nova' | string;
|
|
387
409
|
/**
|
|
388
410
|
* This is the speed multiplier that will be used.
|
|
389
411
|
* @min 0
|
|
@@ -393,9 +415,9 @@ export interface RimeAIVoice {
|
|
|
393
415
|
}
|
|
394
416
|
export interface OpenAIVoice {
|
|
395
417
|
/** This is the voice provider that will be used. */
|
|
396
|
-
provider:
|
|
418
|
+
provider: 'openai';
|
|
397
419
|
/** This is the provider-specific ID that will be used. */
|
|
398
|
-
voiceId:
|
|
420
|
+
voiceId: 'alloy' | 'echo' | 'fable' | 'onyx' | 'nova' | 'shimmer' | string;
|
|
399
421
|
/**
|
|
400
422
|
* This is the speed multiplier that will be used.
|
|
401
423
|
* @min 0.25
|
|
@@ -406,23 +428,37 @@ export interface OpenAIVoice {
|
|
|
406
428
|
}
|
|
407
429
|
export interface AzureVoice {
|
|
408
430
|
/** This is the voice provider that will be used. */
|
|
409
|
-
provider:
|
|
431
|
+
provider: 'azure';
|
|
410
432
|
/** This is the provider-specific ID that will be used. */
|
|
411
|
-
voiceId:
|
|
433
|
+
voiceId: 'andrew' | 'brian' | 'emma' | string;
|
|
434
|
+
}
|
|
435
|
+
export interface LMNTVoice {
|
|
436
|
+
/** This is the voice provider that will be used. */
|
|
437
|
+
provider: 'lmnt';
|
|
438
|
+
/** This is the provider-specific ID that will be used. */
|
|
439
|
+
voiceId: 'lily' | 'daniel' | string;
|
|
440
|
+
/**
|
|
441
|
+
* This is the speed multiplier that will be used.
|
|
442
|
+
* @min 0.25
|
|
443
|
+
* @max 2
|
|
444
|
+
* @example null
|
|
445
|
+
*/
|
|
446
|
+
speed?: number;
|
|
447
|
+
}
|
|
448
|
+
export interface ForwardingPhoneNumber {
|
|
449
|
+
number: string;
|
|
450
|
+
message?: string;
|
|
412
451
|
}
|
|
413
452
|
export interface CreateAssistantDTO {
|
|
453
|
+
/** These are the options for the assistant's transcriber. */
|
|
454
|
+
transcriber?: DeepgramTranscriber | TalkscriberTranscriber;
|
|
414
455
|
/** These are the options for the assistant's LLM. */
|
|
415
456
|
model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | GroqModel | CustomLLMModel;
|
|
416
457
|
/**
|
|
417
458
|
* These are the options for the assistant's voice.
|
|
418
459
|
* @default {"provider":"playht","voiceId":"jennifer"}
|
|
419
460
|
*/
|
|
420
|
-
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
|
|
421
|
-
/**
|
|
422
|
-
* This sets the spoken language of the user. The assistant will do its best to respond in the same language.
|
|
423
|
-
* When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
|
|
424
|
-
*/
|
|
425
|
-
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";
|
|
461
|
+
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice | LMNTVoice;
|
|
426
462
|
/**
|
|
427
463
|
* This is the number to forward to if assistant runs into issues.
|
|
428
464
|
* @example null
|
|
@@ -452,12 +488,12 @@ export interface CreateAssistantDTO {
|
|
|
452
488
|
* These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call', 'speech-update', 'metadata', 'conversation-update']
|
|
453
489
|
* @example ["transcript","hang","function-call","speech-update","metadata","conversation-update"]
|
|
454
490
|
*/
|
|
455
|
-
clientMessages?: (
|
|
491
|
+
clientMessages?: ('status-update' | 'speech-update' | 'transcript' | 'hang' | 'function-call' | 'metadata' | 'conversation-update')[];
|
|
456
492
|
/**
|
|
457
493
|
* These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call']
|
|
458
494
|
* @example ["end-of-call-report","status-update","hang","function-call"]
|
|
459
495
|
*/
|
|
460
|
-
serverMessages?: (
|
|
496
|
+
serverMessages?: ('status-update' | 'transcript' | 'hang' | 'function-call' | 'end-of-call-report' | 'conversation-update')[];
|
|
461
497
|
/**
|
|
462
498
|
* How many seconds of silence to wait before ending the call. Defaults to 30.
|
|
463
499
|
* @min 10
|
|
@@ -472,6 +508,20 @@ export interface CreateAssistantDTO {
|
|
|
472
508
|
* @example 0.4
|
|
473
509
|
*/
|
|
474
510
|
responseDelaySeconds?: number;
|
|
511
|
+
/**
|
|
512
|
+
* The minimum number of seconds to wait after punctuation before sending a request to the LLM. Defaults to 0.1.
|
|
513
|
+
* @min 0
|
|
514
|
+
* @max 3
|
|
515
|
+
* @example 0.1
|
|
516
|
+
*/
|
|
517
|
+
llmRequestDelaySeconds?: number;
|
|
518
|
+
/**
|
|
519
|
+
* The number of words to wait for before interrupting the assistant. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. Defaults to 2.
|
|
520
|
+
* @min 1
|
|
521
|
+
* @max 10
|
|
522
|
+
* @example 2
|
|
523
|
+
*/
|
|
524
|
+
numWordsToInterruptAssistant?: number;
|
|
475
525
|
/**
|
|
476
526
|
* This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
|
|
477
527
|
* @min 10
|
|
@@ -484,8 +534,8 @@ export interface CreateAssistantDTO {
|
|
|
484
534
|
* @maxLength 100
|
|
485
535
|
*/
|
|
486
536
|
name?: string;
|
|
487
|
-
/**
|
|
488
|
-
|
|
537
|
+
/** You can provide a set of phone numbers to forward to. You'll want to tell the assistant when to use each of these numbers in the system prompt. */
|
|
538
|
+
forwardingPhoneNumbers?: ForwardingPhoneNumber[];
|
|
489
539
|
/**
|
|
490
540
|
* This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
|
|
491
541
|
*
|
|
@@ -516,29 +566,26 @@ export interface CreateAssistantDTO {
|
|
|
516
566
|
*
|
|
517
567
|
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
518
568
|
*
|
|
519
|
-
* This overrides the serverUrl set on the org.
|
|
569
|
+
* This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl
|
|
520
570
|
*/
|
|
521
571
|
serverUrl?: string;
|
|
522
572
|
/**
|
|
523
573
|
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
524
574
|
*
|
|
525
|
-
*
|
|
575
|
+
* Same precendence logic as serverUrl.
|
|
526
576
|
*/
|
|
527
577
|
serverUrlSecret?: string;
|
|
528
578
|
}
|
|
529
579
|
export interface Assistant {
|
|
580
|
+
/** These are the options for the assistant's transcriber. */
|
|
581
|
+
transcriber?: DeepgramTranscriber | TalkscriberTranscriber;
|
|
530
582
|
/** These are the options for the assistant's LLM. */
|
|
531
583
|
model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | GroqModel | CustomLLMModel;
|
|
532
584
|
/**
|
|
533
585
|
* These are the options for the assistant's voice.
|
|
534
586
|
* @default {"provider":"playht","voiceId":"jennifer"}
|
|
535
587
|
*/
|
|
536
|
-
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
|
|
537
|
-
/**
|
|
538
|
-
* This sets the spoken language of the user. The assistant will do its best to respond in the same language.
|
|
539
|
-
* When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
|
|
540
|
-
*/
|
|
541
|
-
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";
|
|
588
|
+
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice | LMNTVoice;
|
|
542
589
|
/**
|
|
543
590
|
* This is the number to forward to if assistant runs into issues.
|
|
544
591
|
* @example null
|
|
@@ -568,12 +615,12 @@ export interface Assistant {
|
|
|
568
615
|
* These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call', 'speech-update', 'metadata', 'conversation-update']
|
|
569
616
|
* @example ["transcript","hang","function-call","speech-update","metadata","conversation-update"]
|
|
570
617
|
*/
|
|
571
|
-
clientMessages?: (
|
|
618
|
+
clientMessages?: ('status-update' | 'speech-update' | 'transcript' | 'hang' | 'function-call' | 'metadata' | 'conversation-update')[];
|
|
572
619
|
/**
|
|
573
620
|
* These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call']
|
|
574
621
|
* @example ["end-of-call-report","status-update","hang","function-call"]
|
|
575
622
|
*/
|
|
576
|
-
serverMessages?: (
|
|
623
|
+
serverMessages?: ('status-update' | 'transcript' | 'hang' | 'function-call' | 'end-of-call-report' | 'conversation-update')[];
|
|
577
624
|
/**
|
|
578
625
|
* How many seconds of silence to wait before ending the call. Defaults to 30.
|
|
579
626
|
* @min 10
|
|
@@ -588,6 +635,20 @@ export interface Assistant {
|
|
|
588
635
|
* @example 0.4
|
|
589
636
|
*/
|
|
590
637
|
responseDelaySeconds?: number;
|
|
638
|
+
/**
|
|
639
|
+
* The minimum number of seconds to wait after punctuation before sending a request to the LLM. Defaults to 0.1.
|
|
640
|
+
* @min 0
|
|
641
|
+
* @max 3
|
|
642
|
+
* @example 0.1
|
|
643
|
+
*/
|
|
644
|
+
llmRequestDelaySeconds?: number;
|
|
645
|
+
/**
|
|
646
|
+
* The number of words to wait for before interrupting the assistant. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. Defaults to 2.
|
|
647
|
+
* @min 1
|
|
648
|
+
* @max 10
|
|
649
|
+
* @example 2
|
|
650
|
+
*/
|
|
651
|
+
numWordsToInterruptAssistant?: number;
|
|
591
652
|
/**
|
|
592
653
|
* This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
|
|
593
654
|
* @min 10
|
|
@@ -600,8 +661,8 @@ export interface Assistant {
|
|
|
600
661
|
* @maxLength 100
|
|
601
662
|
*/
|
|
602
663
|
name?: string;
|
|
603
|
-
/**
|
|
604
|
-
|
|
664
|
+
/** You can provide a set of phone numbers to forward to. You'll want to tell the assistant when to use each of these numbers in the system prompt. */
|
|
665
|
+
forwardingPhoneNumbers?: ForwardingPhoneNumber[];
|
|
605
666
|
/**
|
|
606
667
|
* This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
|
|
607
668
|
*
|
|
@@ -632,13 +693,13 @@ export interface Assistant {
|
|
|
632
693
|
*
|
|
633
694
|
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
634
695
|
*
|
|
635
|
-
* This overrides the serverUrl set on the org.
|
|
696
|
+
* This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl
|
|
636
697
|
*/
|
|
637
698
|
serverUrl?: string;
|
|
638
699
|
/**
|
|
639
700
|
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
640
701
|
*
|
|
641
|
-
*
|
|
702
|
+
* Same precendence logic as serverUrl.
|
|
642
703
|
*/
|
|
643
704
|
serverUrlSecret?: string;
|
|
644
705
|
/** This is the unique identifier for the assistant. */
|
|
@@ -657,18 +718,15 @@ export interface Assistant {
|
|
|
657
718
|
updatedAt: string;
|
|
658
719
|
}
|
|
659
720
|
export interface UpdateAssistantDTO {
|
|
721
|
+
/** These are the options for the assistant's transcriber. */
|
|
722
|
+
transcriber?: DeepgramTranscriber | TalkscriberTranscriber;
|
|
660
723
|
/** These are the options for the assistant's LLM. */
|
|
661
724
|
model?: OpenAIModel | TogetherAIModel | AnyscaleModel | OpenRouterModel | PerplexityAIModel | DeepInfraModel | GroqModel | CustomLLMModel;
|
|
662
725
|
/**
|
|
663
726
|
* These are the options for the assistant's voice.
|
|
664
727
|
* @default {"provider":"playht","voiceId":"jennifer"}
|
|
665
728
|
*/
|
|
666
|
-
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice;
|
|
667
|
-
/**
|
|
668
|
-
* This sets the spoken language of the user. The assistant will do its best to respond in the same language.
|
|
669
|
-
* When using a language other than `en-*`, only `11labs` voices will pronounce the words correctly. There will also be ~1sec of additional latency.
|
|
670
|
-
*/
|
|
671
|
-
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";
|
|
729
|
+
voice?: AzureVoice | ElevenLabsVoice | PlayHTVoice | RimeAIVoice | DeepgramVoice | OpenAIVoice | LMNTVoice;
|
|
672
730
|
/**
|
|
673
731
|
* This is the number to forward to if assistant runs into issues.
|
|
674
732
|
* @example null
|
|
@@ -698,12 +756,12 @@ export interface UpdateAssistantDTO {
|
|
|
698
756
|
* These are the messages that will be sent to the Client SDKs. Default is ['transcript', 'hang', 'function-call', 'speech-update', 'metadata', 'conversation-update']
|
|
699
757
|
* @example ["transcript","hang","function-call","speech-update","metadata","conversation-update"]
|
|
700
758
|
*/
|
|
701
|
-
clientMessages?: (
|
|
759
|
+
clientMessages?: ('status-update' | 'speech-update' | 'transcript' | 'hang' | 'function-call' | 'metadata' | 'conversation-update')[];
|
|
702
760
|
/**
|
|
703
761
|
* These are the messages that will be sent to your Server URL. Default is ['end-of-call-report', 'status-update', 'hang', 'function-call']
|
|
704
762
|
* @example ["end-of-call-report","status-update","hang","function-call"]
|
|
705
763
|
*/
|
|
706
|
-
serverMessages?: (
|
|
764
|
+
serverMessages?: ('status-update' | 'transcript' | 'hang' | 'function-call' | 'end-of-call-report' | 'conversation-update')[];
|
|
707
765
|
/**
|
|
708
766
|
* How many seconds of silence to wait before ending the call. Defaults to 30.
|
|
709
767
|
* @min 10
|
|
@@ -718,6 +776,20 @@ export interface UpdateAssistantDTO {
|
|
|
718
776
|
* @example 0.4
|
|
719
777
|
*/
|
|
720
778
|
responseDelaySeconds?: number;
|
|
779
|
+
/**
|
|
780
|
+
* The minimum number of seconds to wait after punctuation before sending a request to the LLM. Defaults to 0.1.
|
|
781
|
+
* @min 0
|
|
782
|
+
* @max 3
|
|
783
|
+
* @example 0.1
|
|
784
|
+
*/
|
|
785
|
+
llmRequestDelaySeconds?: number;
|
|
786
|
+
/**
|
|
787
|
+
* The number of words to wait for before interrupting the assistant. Words like "stop", "actually", "no", etc. will always interrupt immediately regardless of this value. Words like "okay", "yeah", "right" will never interrupt. Defaults to 2.
|
|
788
|
+
* @min 1
|
|
789
|
+
* @max 10
|
|
790
|
+
* @example 2
|
|
791
|
+
*/
|
|
792
|
+
numWordsToInterruptAssistant?: number;
|
|
721
793
|
/**
|
|
722
794
|
* This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
|
|
723
795
|
* @min 10
|
|
@@ -730,8 +802,8 @@ export interface UpdateAssistantDTO {
|
|
|
730
802
|
* @maxLength 100
|
|
731
803
|
*/
|
|
732
804
|
name?: string;
|
|
733
|
-
/**
|
|
734
|
-
|
|
805
|
+
/** You can provide a set of phone numbers to forward to. You'll want to tell the assistant when to use each of these numbers in the system prompt. */
|
|
806
|
+
forwardingPhoneNumbers?: ForwardingPhoneNumber[];
|
|
735
807
|
/**
|
|
736
808
|
* This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).
|
|
737
809
|
*
|
|
@@ -762,13 +834,13 @@ export interface UpdateAssistantDTO {
|
|
|
762
834
|
*
|
|
763
835
|
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
764
836
|
*
|
|
765
|
-
* This overrides the serverUrl set on the org.
|
|
837
|
+
* This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl
|
|
766
838
|
*/
|
|
767
839
|
serverUrl?: string;
|
|
768
840
|
/**
|
|
769
841
|
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
770
842
|
*
|
|
771
|
-
*
|
|
843
|
+
* Same precendence logic as serverUrl.
|
|
772
844
|
*/
|
|
773
845
|
serverUrlSecret?: string;
|
|
774
846
|
}
|
|
@@ -804,14 +876,34 @@ export interface ImportTwilioPhoneNumberDTO {
|
|
|
804
876
|
* If this is not set, then the phone number will not handle incoming calls.
|
|
805
877
|
*/
|
|
806
878
|
assistantId?: string;
|
|
879
|
+
/**
|
|
880
|
+
* This is the server URL that will be used to handle this phone number.
|
|
881
|
+
*
|
|
882
|
+
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
883
|
+
*
|
|
884
|
+
* This overrides the serverUrl set on the org. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
885
|
+
*/
|
|
886
|
+
serverUrl?: string;
|
|
887
|
+
/**
|
|
888
|
+
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
889
|
+
*
|
|
890
|
+
* Same precendence logic as serverUrl.
|
|
891
|
+
*/
|
|
892
|
+
serverUrlSecret?: string;
|
|
807
893
|
}
|
|
808
894
|
export interface Call {
|
|
809
895
|
/** This is the type of call. */
|
|
810
|
-
type?:
|
|
896
|
+
type?: 'inboundPhoneCall' | 'outboundPhoneCall' | 'webCall';
|
|
897
|
+
/**
|
|
898
|
+
* This is the provider of the call.
|
|
899
|
+
*
|
|
900
|
+
* Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
|
901
|
+
*/
|
|
902
|
+
phoneCallProvider?: 'twilio' | 'vonage';
|
|
811
903
|
/** This is the status of the call. */
|
|
812
|
-
status?:
|
|
904
|
+
status?: 'queued' | 'ringing' | 'in-progress' | 'forwarding' | 'ended';
|
|
813
905
|
/** This is the explanation for how the call ended. */
|
|
814
|
-
endedReason?:
|
|
906
|
+
endedReason?: 'assistant-error' | 'assistant-not-found' | 'db-error' | 'no-server-available' | 'pipeline-error-extra-function-failed' | 'pipeline-error-first-message-failed' | 'pipeline-error-function-filler-failed' | 'pipeline-error-function-failed' | 'pipeline-error-openai-llm-failed' | 'pipeline-error-azure-openai-llm-failed' | 'pipeline-error-together-ai-llm-failed' | 'pipeline-error-anyscale-llm-failed' | 'pipeline-error-openrouter-llm-failed' | 'pipeline-error-perplexity-ai-llm-failed' | 'pipeline-error-deepinfra-llm-failed' | 'pipeline-error-runpod-llm-failed' | 'pipeline-error-groq-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-eleven-labs-quota-exceeded' | 'pipeline-error-playht-voice-failed' | 'pipeline-error-lmnt-voice-failed' | 'pipeline-error-azure-voice-failed' | 'pipeline-error-rime-ai-voice-failed' | 'pipeline-error-neets-voice-failed' | 'server-shutdown' | 'twilio-failed-to-connect-call' | 'unknown-error' | 'vonage-disconnected' | 'vonage-failed-to-connect-call' | 'assistant-ended-call' | 'assistant-said-end-call-phrase' | 'assistant-forwarded-call' | 'assistant-join-timed-out' | 'customer-busy' | 'customer-ended-call' | 'customer-did-not-answer' | 'customer-did-not-give-microphone-permission' | 'exceeded-max-duration' | 'manually-canceled' | 'phone-call-provider-closed-websocket' | 'pipeline-error-custom-llm-llm-failed' | 'silence-timed-out' | 'voicemail' | 'vonage-rejected';
|
|
815
907
|
/**
|
|
816
908
|
* This is the maximum number of seconds that the call will last. When the call reaches this duration, it will be ended.
|
|
817
909
|
* @min 10
|
|
@@ -858,17 +950,25 @@ export interface Call {
|
|
|
858
950
|
/** These are the messages that were spoken during the call. */
|
|
859
951
|
messages?: object[];
|
|
860
952
|
/**
|
|
861
|
-
*
|
|
953
|
+
* The ID of the call as provided by the phone number service. callSid in Twilio. conversationUuid in Vonage.
|
|
862
954
|
*
|
|
863
955
|
* Only relevant for `outboundPhoneCall` and `inboundPhoneCall` type.
|
|
864
956
|
*/
|
|
865
|
-
|
|
957
|
+
phoneCallProviderId?: string;
|
|
866
958
|
/**
|
|
867
959
|
* This is the URL of the call that the assistant will join.
|
|
868
960
|
*
|
|
869
961
|
* Only relevant for `webCall` type.
|
|
870
962
|
*/
|
|
871
963
|
webCallUrl?: string;
|
|
964
|
+
/**
|
|
965
|
+
* This is the SIP URI of the call that the assistant will join.
|
|
966
|
+
*
|
|
967
|
+
* Only relevant for `webCall` type.
|
|
968
|
+
*/
|
|
969
|
+
webCallSipUri?: string;
|
|
970
|
+
/** This is the phone number that the call was forwarded to. */
|
|
971
|
+
forwardedPhoneNumber?: string;
|
|
872
972
|
/** This is the assistant that will be used for the call. To use a transient assistant, use `assistant` instead. */
|
|
873
973
|
assistantId?: string;
|
|
874
974
|
/** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
|
|
@@ -944,11 +1044,13 @@ export interface CreateWebCallDTO {
|
|
|
944
1044
|
assistantId?: string;
|
|
945
1045
|
/** This is the assistant that will be used for the call. To use an existing assistant, use `assistantId` instead. */
|
|
946
1046
|
assistant?: CreateAssistantDTO;
|
|
1047
|
+
/** This will expose SIP URI you can use to connect to the call. Disabled by default. */
|
|
1048
|
+
sipEnabled?: boolean;
|
|
947
1049
|
/** This is the metadata associated with the call. */
|
|
948
1050
|
metadata?: object;
|
|
949
1051
|
}
|
|
950
1052
|
export interface TwilioCredential {
|
|
951
|
-
provider:
|
|
1053
|
+
provider: 'twilio';
|
|
952
1054
|
/** This is not returned in the API. */
|
|
953
1055
|
authToken: string;
|
|
954
1056
|
/** This is the unique identifier for the credential. */
|
|
@@ -968,7 +1070,7 @@ export interface TwilioCredential {
|
|
|
968
1070
|
accountSid: string;
|
|
969
1071
|
}
|
|
970
1072
|
export interface DeepgramCredential {
|
|
971
|
-
provider:
|
|
1073
|
+
provider: 'deepgram';
|
|
972
1074
|
/** This is not returned in the API. */
|
|
973
1075
|
apiKey: string;
|
|
974
1076
|
/** This is the unique identifier for the credential. */
|
|
@@ -987,7 +1089,7 @@ export interface DeepgramCredential {
|
|
|
987
1089
|
updatedAt: string;
|
|
988
1090
|
}
|
|
989
1091
|
export interface ElevenLabsCredential {
|
|
990
|
-
provider:
|
|
1092
|
+
provider: '11labs';
|
|
991
1093
|
/** This is not returned in the API. */
|
|
992
1094
|
apiKey: string;
|
|
993
1095
|
/** This is the unique identifier for the credential. */
|
|
@@ -1006,7 +1108,7 @@ export interface ElevenLabsCredential {
|
|
|
1006
1108
|
updatedAt: string;
|
|
1007
1109
|
}
|
|
1008
1110
|
export interface PlayHTCredential {
|
|
1009
|
-
provider:
|
|
1111
|
+
provider: 'playht';
|
|
1010
1112
|
/** This is not returned in the API. */
|
|
1011
1113
|
apiKey: string;
|
|
1012
1114
|
/** This is the unique identifier for the credential. */
|
|
@@ -1026,7 +1128,7 @@ export interface PlayHTCredential {
|
|
|
1026
1128
|
userId: string;
|
|
1027
1129
|
}
|
|
1028
1130
|
export interface RimeAICredential {
|
|
1029
|
-
provider:
|
|
1131
|
+
provider: 'rime-ai';
|
|
1030
1132
|
/** This is not returned in the API. */
|
|
1031
1133
|
apiKey: string;
|
|
1032
1134
|
/** This is the unique identifier for the credential. */
|
|
@@ -1045,7 +1147,7 @@ export interface RimeAICredential {
|
|
|
1045
1147
|
updatedAt: string;
|
|
1046
1148
|
}
|
|
1047
1149
|
export interface OpenAICredential {
|
|
1048
|
-
provider:
|
|
1150
|
+
provider: 'openai';
|
|
1049
1151
|
/** This is not returned in the API. */
|
|
1050
1152
|
apiKey: string;
|
|
1051
1153
|
/** This is the unique identifier for the credential. */
|
|
@@ -1064,7 +1166,7 @@ export interface OpenAICredential {
|
|
|
1064
1166
|
updatedAt: string;
|
|
1065
1167
|
}
|
|
1066
1168
|
export interface TogetherAICredential {
|
|
1067
|
-
provider:
|
|
1169
|
+
provider: 'together-ai';
|
|
1068
1170
|
/** This is not returned in the API. */
|
|
1069
1171
|
apiKey: string;
|
|
1070
1172
|
/** This is the unique identifier for the credential. */
|
|
@@ -1083,7 +1185,7 @@ export interface TogetherAICredential {
|
|
|
1083
1185
|
updatedAt: string;
|
|
1084
1186
|
}
|
|
1085
1187
|
export interface AnyscaleCredential {
|
|
1086
|
-
provider:
|
|
1188
|
+
provider: 'anyscale';
|
|
1087
1189
|
/** This is not returned in the API. */
|
|
1088
1190
|
apiKey: string;
|
|
1089
1191
|
/** This is the unique identifier for the credential. */
|
|
@@ -1102,7 +1204,7 @@ export interface AnyscaleCredential {
|
|
|
1102
1204
|
updatedAt: string;
|
|
1103
1205
|
}
|
|
1104
1206
|
export interface OpenRouterCredential {
|
|
1105
|
-
provider:
|
|
1207
|
+
provider: 'openrouter';
|
|
1106
1208
|
/** This is not returned in the API. */
|
|
1107
1209
|
apiKey: string;
|
|
1108
1210
|
/** This is the unique identifier for the credential. */
|
|
@@ -1121,7 +1223,7 @@ export interface OpenRouterCredential {
|
|
|
1121
1223
|
updatedAt: string;
|
|
1122
1224
|
}
|
|
1123
1225
|
export interface PerplexityAICredential {
|
|
1124
|
-
provider:
|
|
1226
|
+
provider: 'perplexity-ai';
|
|
1125
1227
|
/** This is not returned in the API. */
|
|
1126
1228
|
apiKey: string;
|
|
1127
1229
|
/** This is the unique identifier for the credential. */
|
|
@@ -1140,7 +1242,7 @@ export interface PerplexityAICredential {
|
|
|
1140
1242
|
updatedAt: string;
|
|
1141
1243
|
}
|
|
1142
1244
|
export interface DeepInfraCredential {
|
|
1143
|
-
provider:
|
|
1245
|
+
provider: 'deepinfra';
|
|
1144
1246
|
/** This is not returned in the API. */
|
|
1145
1247
|
apiKey: string;
|
|
1146
1248
|
/** This is the unique identifier for the credential. */
|
|
@@ -1159,7 +1261,7 @@ export interface DeepInfraCredential {
|
|
|
1159
1261
|
updatedAt: string;
|
|
1160
1262
|
}
|
|
1161
1263
|
export interface CustomLLMCredential {
|
|
1162
|
-
provider:
|
|
1264
|
+
provider: 'custom-llm';
|
|
1163
1265
|
/** This is not returned in the API. */
|
|
1164
1266
|
apiKey: string;
|
|
1165
1267
|
/** This is the unique identifier for the credential. */
|
|
@@ -1178,7 +1280,7 @@ export interface CustomLLMCredential {
|
|
|
1178
1280
|
updatedAt: string;
|
|
1179
1281
|
}
|
|
1180
1282
|
export interface RunpodCredential {
|
|
1181
|
-
provider:
|
|
1283
|
+
provider: 'runpod';
|
|
1182
1284
|
/** This is not returned in the API. */
|
|
1183
1285
|
apiKey: string;
|
|
1184
1286
|
/** This is the unique identifier for the credential. */
|
|
@@ -1196,140 +1298,213 @@ export interface RunpodCredential {
|
|
|
1196
1298
|
*/
|
|
1197
1299
|
updatedAt: string;
|
|
1198
1300
|
}
|
|
1301
|
+
export interface GroqCredential {
|
|
1302
|
+
provider: 'groq';
|
|
1303
|
+
/** This is not returned in the API. */
|
|
1304
|
+
apiKey: string;
|
|
1305
|
+
/** This is the unique identifier for the credential. */
|
|
1306
|
+
id: string;
|
|
1307
|
+
/** This is the unique identifier for the org that this credential belongs to. */
|
|
1308
|
+
orgId: string;
|
|
1309
|
+
/**
|
|
1310
|
+
* This is the ISO 8601 date-time string of when the credential was created.
|
|
1311
|
+
* @format date-time
|
|
1312
|
+
*/
|
|
1313
|
+
createdAt: string;
|
|
1314
|
+
/**
|
|
1315
|
+
* This is the ISO 8601 date-time string of when the assistant was last updated.
|
|
1316
|
+
* @format date-time
|
|
1317
|
+
*/
|
|
1318
|
+
updatedAt: string;
|
|
1319
|
+
}
|
|
1320
|
+
export interface VonageCredential {
|
|
1321
|
+
provider: 'vonage';
|
|
1322
|
+
/** This is not returned in the API. */
|
|
1323
|
+
apiSecret: string;
|
|
1324
|
+
/** This is the unique identifier for the credential. */
|
|
1325
|
+
id: string;
|
|
1326
|
+
/** This is the unique identifier for the org that this credential belongs to. */
|
|
1327
|
+
orgId: string;
|
|
1328
|
+
/**
|
|
1329
|
+
* This is the ISO 8601 date-time string of when the credential was created.
|
|
1330
|
+
* @format date-time
|
|
1331
|
+
*/
|
|
1332
|
+
createdAt: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* This is the ISO 8601 date-time string of when the assistant was last updated.
|
|
1335
|
+
* @format date-time
|
|
1336
|
+
*/
|
|
1337
|
+
updatedAt: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* This is the Vonage Application ID for the credential.
|
|
1340
|
+
*
|
|
1341
|
+
* Only relevant for Vonage credentials.
|
|
1342
|
+
*/
|
|
1343
|
+
vonageApplicationId: string;
|
|
1344
|
+
/**
|
|
1345
|
+
* This is the Vonage Application Private Key for the credential.
|
|
1346
|
+
*
|
|
1347
|
+
* Only relevant for Vonage credentials.
|
|
1348
|
+
*/
|
|
1349
|
+
vonageApplicationPrivateKey: string;
|
|
1350
|
+
apiKey: string;
|
|
1351
|
+
}
|
|
1199
1352
|
export interface CreateTwilioCredentialDTO {
|
|
1200
|
-
provider:
|
|
1353
|
+
provider: 'twilio';
|
|
1201
1354
|
/** This is not returned in the API. */
|
|
1202
1355
|
authToken: string;
|
|
1203
1356
|
accountSid: string;
|
|
1204
1357
|
}
|
|
1205
1358
|
export interface CreateDeepgramCredentialDTO {
|
|
1206
|
-
provider:
|
|
1359
|
+
provider: 'deepgram';
|
|
1207
1360
|
/** This is not returned in the API. */
|
|
1208
1361
|
apiKey: string;
|
|
1209
1362
|
}
|
|
1210
1363
|
export interface CreateOpenAICredentialDTO {
|
|
1211
|
-
provider:
|
|
1364
|
+
provider: 'openai';
|
|
1212
1365
|
/** This is not returned in the API. */
|
|
1213
1366
|
apiKey: string;
|
|
1214
1367
|
}
|
|
1215
1368
|
export interface CreateTogetherAICredentialDTO {
|
|
1216
|
-
provider:
|
|
1369
|
+
provider: 'together-ai';
|
|
1217
1370
|
/** This is not returned in the API. */
|
|
1218
1371
|
apiKey: string;
|
|
1219
1372
|
}
|
|
1220
1373
|
export interface CreateAnyscaleCredentialDTO {
|
|
1221
|
-
provider:
|
|
1374
|
+
provider: 'anyscale';
|
|
1222
1375
|
/** This is not returned in the API. */
|
|
1223
1376
|
apiKey: string;
|
|
1224
1377
|
}
|
|
1225
1378
|
export interface CreateOpenRouterCredentialDTO {
|
|
1226
|
-
provider:
|
|
1379
|
+
provider: 'openrouter';
|
|
1227
1380
|
/** This is not returned in the API. */
|
|
1228
1381
|
apiKey: string;
|
|
1229
1382
|
}
|
|
1230
1383
|
export interface CreatePerplexityAICredentialDTO {
|
|
1231
|
-
provider:
|
|
1384
|
+
provider: 'perplexity-ai';
|
|
1232
1385
|
/** This is not returned in the API. */
|
|
1233
1386
|
apiKey: string;
|
|
1234
1387
|
}
|
|
1235
1388
|
export interface CreateDeepInfraCredentialDTO {
|
|
1236
|
-
provider:
|
|
1389
|
+
provider: 'deepinfra';
|
|
1237
1390
|
/** This is not returned in the API. */
|
|
1238
1391
|
apiKey: string;
|
|
1239
1392
|
}
|
|
1240
1393
|
export interface CreateCustomLLMCredentialDTO {
|
|
1241
|
-
provider:
|
|
1394
|
+
provider: 'custom-llm';
|
|
1242
1395
|
/** This is not returned in the API. */
|
|
1243
1396
|
apiKey: string;
|
|
1244
1397
|
}
|
|
1245
1398
|
export interface CreateElevenLabsCredentialDTO {
|
|
1246
|
-
provider:
|
|
1399
|
+
provider: '11labs';
|
|
1247
1400
|
/** This is not returned in the API. */
|
|
1248
1401
|
apiKey: string;
|
|
1249
1402
|
}
|
|
1250
1403
|
export interface CreatePlayHTCredentialDTO {
|
|
1251
|
-
provider:
|
|
1404
|
+
provider: 'playht';
|
|
1252
1405
|
/** This is not returned in the API. */
|
|
1253
1406
|
apiKey: string;
|
|
1254
1407
|
userId: string;
|
|
1255
1408
|
}
|
|
1256
1409
|
export interface CreateRimeAICredentialDTO {
|
|
1257
|
-
provider:
|
|
1410
|
+
provider: 'rime-ai';
|
|
1258
1411
|
/** This is not returned in the API. */
|
|
1259
1412
|
apiKey: string;
|
|
1260
1413
|
}
|
|
1261
1414
|
export interface CreateRunpodCredentialDTO {
|
|
1262
|
-
provider:
|
|
1415
|
+
provider: 'runpod';
|
|
1416
|
+
/** This is not returned in the API. */
|
|
1417
|
+
apiKey: string;
|
|
1418
|
+
}
|
|
1419
|
+
export interface CreateGroqCredentialDTO {
|
|
1420
|
+
provider: 'groq';
|
|
1421
|
+
/** This is not returned in the API. */
|
|
1422
|
+
apiKey: string;
|
|
1423
|
+
}
|
|
1424
|
+
export interface CreateVonageCredentialDTO {
|
|
1425
|
+
provider: 'vonage';
|
|
1263
1426
|
/** This is not returned in the API. */
|
|
1427
|
+
apiSecret: string;
|
|
1264
1428
|
apiKey: string;
|
|
1265
1429
|
}
|
|
1266
1430
|
export interface UpdateTwilioCredentialDTO {
|
|
1267
|
-
provider:
|
|
1431
|
+
provider: 'twilio';
|
|
1268
1432
|
/** This is not returned in the API. */
|
|
1269
1433
|
authToken: string;
|
|
1270
1434
|
accountSid: string;
|
|
1271
1435
|
}
|
|
1272
1436
|
export interface UpdateDeepgramCredentialDTO {
|
|
1273
|
-
provider:
|
|
1437
|
+
provider: 'deepgram';
|
|
1274
1438
|
/** This is not returned in the API. */
|
|
1275
1439
|
apiKey: string;
|
|
1276
1440
|
}
|
|
1277
1441
|
export interface UpdateOpenAICredentialDTO {
|
|
1278
|
-
provider:
|
|
1442
|
+
provider: 'openai';
|
|
1279
1443
|
/** This is not returned in the API. */
|
|
1280
1444
|
apiKey: string;
|
|
1281
1445
|
}
|
|
1282
1446
|
export interface UpdateTogetherAICredentialDTO {
|
|
1283
|
-
provider:
|
|
1447
|
+
provider: 'together-ai';
|
|
1284
1448
|
/** This is not returned in the API. */
|
|
1285
1449
|
apiKey: string;
|
|
1286
1450
|
}
|
|
1287
1451
|
export interface UpdateAnyscaleCredentialDTO {
|
|
1288
|
-
provider:
|
|
1452
|
+
provider: 'anyscale';
|
|
1289
1453
|
/** This is not returned in the API. */
|
|
1290
1454
|
apiKey: string;
|
|
1291
1455
|
}
|
|
1292
1456
|
export interface UpdateOpenRouterCredentialDTO {
|
|
1293
|
-
provider:
|
|
1457
|
+
provider: 'openrouter';
|
|
1294
1458
|
/** This is not returned in the API. */
|
|
1295
1459
|
apiKey: string;
|
|
1296
1460
|
}
|
|
1297
1461
|
export interface UpdatePerplexityAICredentialDTO {
|
|
1298
|
-
provider:
|
|
1462
|
+
provider: 'perplexity-ai';
|
|
1299
1463
|
/** This is not returned in the API. */
|
|
1300
1464
|
apiKey: string;
|
|
1301
1465
|
}
|
|
1302
1466
|
export interface UpdateDeepInfraCredentialDTO {
|
|
1303
|
-
provider:
|
|
1467
|
+
provider: 'deepinfra';
|
|
1304
1468
|
/** This is not returned in the API. */
|
|
1305
1469
|
apiKey: string;
|
|
1306
1470
|
}
|
|
1307
1471
|
export interface UpdateCustomLLMCredentialDTO {
|
|
1308
|
-
provider:
|
|
1472
|
+
provider: 'custom-llm';
|
|
1309
1473
|
/** This is not returned in the API. */
|
|
1310
1474
|
apiKey: string;
|
|
1311
1475
|
}
|
|
1312
1476
|
export interface UpdateElevenLabsCredentialDTO {
|
|
1313
|
-
provider:
|
|
1477
|
+
provider: '11labs';
|
|
1314
1478
|
/** This is not returned in the API. */
|
|
1315
1479
|
apiKey: string;
|
|
1316
1480
|
}
|
|
1317
1481
|
export interface UpdatePlayHTCredentialDTO {
|
|
1318
|
-
provider:
|
|
1482
|
+
provider: 'playht';
|
|
1319
1483
|
/** This is not returned in the API. */
|
|
1320
1484
|
apiKey: string;
|
|
1321
1485
|
userId: string;
|
|
1322
1486
|
}
|
|
1323
1487
|
export interface UpdateRimeAICredentialDTO {
|
|
1324
|
-
provider:
|
|
1488
|
+
provider: 'rime-ai';
|
|
1325
1489
|
/** This is not returned in the API. */
|
|
1326
1490
|
apiKey: string;
|
|
1327
1491
|
}
|
|
1328
1492
|
export interface UpdateRunpodCredentialDTO {
|
|
1329
|
-
provider:
|
|
1493
|
+
provider: 'runpod';
|
|
1494
|
+
/** This is not returned in the API. */
|
|
1495
|
+
apiKey: string;
|
|
1496
|
+
}
|
|
1497
|
+
export interface UpdateGroqCredentialDTO {
|
|
1498
|
+
provider: 'groq';
|
|
1330
1499
|
/** This is not returned in the API. */
|
|
1331
1500
|
apiKey: string;
|
|
1332
1501
|
}
|
|
1502
|
+
export interface UpdateVonageCredentialDTO {
|
|
1503
|
+
provider: 'vonage';
|
|
1504
|
+
/** This is not returned in the API. */
|
|
1505
|
+
apiSecret: string;
|
|
1506
|
+
apiKey: string;
|
|
1507
|
+
}
|
|
1333
1508
|
export interface BuyPhoneNumberDTO {
|
|
1334
1509
|
/**
|
|
1335
1510
|
* This is the area code of the phone number to purchase.
|
|
@@ -1348,6 +1523,20 @@ export interface BuyPhoneNumberDTO {
|
|
|
1348
1523
|
* If this is not set, then the phone number will not handle incoming calls.
|
|
1349
1524
|
*/
|
|
1350
1525
|
assistantId?: string;
|
|
1526
|
+
/**
|
|
1527
|
+
* This is the server URL that will be used to handle this phone number.
|
|
1528
|
+
*
|
|
1529
|
+
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
1530
|
+
*
|
|
1531
|
+
* This overrides the serverUrl set on the org. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
1532
|
+
*/
|
|
1533
|
+
serverUrl?: string;
|
|
1534
|
+
/**
|
|
1535
|
+
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
1536
|
+
*
|
|
1537
|
+
* Same precendence logic as serverUrl.
|
|
1538
|
+
*/
|
|
1539
|
+
serverUrlSecret?: string;
|
|
1351
1540
|
}
|
|
1352
1541
|
export interface PhoneNumber {
|
|
1353
1542
|
/** This is the unique identifier for the phone number. */
|
|
@@ -1387,6 +1576,47 @@ export interface PhoneNumber {
|
|
|
1387
1576
|
* This is for numbers not bought on Vapi.
|
|
1388
1577
|
*/
|
|
1389
1578
|
twilioAuthToken?: string;
|
|
1579
|
+
/**
|
|
1580
|
+
* This is the credential that will be used to handle this phone number.
|
|
1581
|
+
*
|
|
1582
|
+
* This is for numbers not bought on Vapi.
|
|
1583
|
+
*/
|
|
1584
|
+
credentialId?: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* This is the name of the phone number. This is just for your own reference.
|
|
1587
|
+
* @maxLength 40
|
|
1588
|
+
*/
|
|
1589
|
+
name?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* This is the assistant that will be used for incoming calls to this phone number.
|
|
1592
|
+
*
|
|
1593
|
+
* If this is not set, then the phone number will not handle incoming calls.
|
|
1594
|
+
*/
|
|
1595
|
+
assistantId?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* This is the server URL that will be used to handle this phone number.
|
|
1598
|
+
*
|
|
1599
|
+
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
1600
|
+
*
|
|
1601
|
+
* This overrides the serverUrl set on the org. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
1602
|
+
*/
|
|
1603
|
+
serverUrl?: string;
|
|
1604
|
+
/**
|
|
1605
|
+
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
1606
|
+
*
|
|
1607
|
+
* Same precendence logic as serverUrl.
|
|
1608
|
+
*/
|
|
1609
|
+
serverUrlSecret?: string;
|
|
1610
|
+
}
|
|
1611
|
+
export interface ImportVonagePhoneNumberDTO {
|
|
1612
|
+
/** These are the digits of the phone number you own on your Vonage. */
|
|
1613
|
+
vonagePhoneNumber: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* This is the credential that will be used to handle this phone number.
|
|
1616
|
+
*
|
|
1617
|
+
* You can add the Vonage credentials in the Provider Keys page on the dashboard to get the credentialId.
|
|
1618
|
+
*/
|
|
1619
|
+
credentialId: string;
|
|
1390
1620
|
/**
|
|
1391
1621
|
* This is the name of the phone number. This is just for your own reference.
|
|
1392
1622
|
* @maxLength 40
|
|
@@ -1398,6 +1628,20 @@ export interface PhoneNumber {
|
|
|
1398
1628
|
* If this is not set, then the phone number will not handle incoming calls.
|
|
1399
1629
|
*/
|
|
1400
1630
|
assistantId?: string;
|
|
1631
|
+
/**
|
|
1632
|
+
* This is the server URL that will be used to handle this phone number.
|
|
1633
|
+
*
|
|
1634
|
+
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
1635
|
+
*
|
|
1636
|
+
* This overrides the serverUrl set on the org. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
1637
|
+
*/
|
|
1638
|
+
serverUrl?: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
1641
|
+
*
|
|
1642
|
+
* Same precendence logic as serverUrl.
|
|
1643
|
+
*/
|
|
1644
|
+
serverUrlSecret?: string;
|
|
1401
1645
|
}
|
|
1402
1646
|
export interface UpdatePhoneNumberDTO {
|
|
1403
1647
|
/**
|
|
@@ -1411,6 +1655,20 @@ export interface UpdatePhoneNumberDTO {
|
|
|
1411
1655
|
* If this is not set, then the phone number will not handle incoming calls.
|
|
1412
1656
|
*/
|
|
1413
1657
|
assistantId?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* This is the server URL that will be used to handle this phone number.
|
|
1660
|
+
*
|
|
1661
|
+
* All requests will be sent with the call object among other things relevant to that message. You can find more details in the Server URL documentation.
|
|
1662
|
+
*
|
|
1663
|
+
* This overrides the serverUrl set on the org. Order of precedence: assistant.serverUrl > phoneNumber.serverUrl > org.serverUrl.
|
|
1664
|
+
*/
|
|
1665
|
+
serverUrl?: string;
|
|
1666
|
+
/**
|
|
1667
|
+
* This is the secret you can set that Vapi will send with every request to your server. Will be sent as a header called x-vapi-secret.
|
|
1668
|
+
*
|
|
1669
|
+
* Same precendence logic as serverUrl.
|
|
1670
|
+
*/
|
|
1671
|
+
serverUrlSecret?: string;
|
|
1414
1672
|
}
|
|
1415
1673
|
export interface Metrics {
|
|
1416
1674
|
orgId: string;
|
|
@@ -1429,8 +1687,8 @@ export interface Metrics {
|
|
|
1429
1687
|
callCountDailyBreakdown: object;
|
|
1430
1688
|
}
|
|
1431
1689
|
export type QueryParamsType = Record<string | number, any>;
|
|
1432
|
-
export type ResponseFormat = keyof Omit<Body,
|
|
1433
|
-
export interface FullRequestParams extends Omit<RequestInit,
|
|
1690
|
+
export type ResponseFormat = keyof Omit<Body, 'body' | 'bodyUsed'>;
|
|
1691
|
+
export interface FullRequestParams extends Omit<RequestInit, 'body'> {
|
|
1434
1692
|
/** set parameter to `true` for call `securityWorker` for this request */
|
|
1435
1693
|
secure?: boolean;
|
|
1436
1694
|
/** request path */
|
|
@@ -1448,10 +1706,10 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
|
|
|
1448
1706
|
/** request cancellation token */
|
|
1449
1707
|
cancelToken?: CancelToken;
|
|
1450
1708
|
}
|
|
1451
|
-
export type RequestParams = Omit<FullRequestParams,
|
|
1709
|
+
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
|
|
1452
1710
|
export interface ApiConfig<SecurityDataType = unknown> {
|
|
1453
1711
|
baseUrl?: string;
|
|
1454
|
-
baseApiParams?: Omit<RequestParams,
|
|
1712
|
+
baseApiParams?: Omit<RequestParams, 'baseUrl' | 'cancelToken' | 'signal'>;
|
|
1455
1713
|
securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
|
|
1456
1714
|
customFetch?: typeof fetch;
|
|
1457
1715
|
}
|
|
@@ -1706,58 +1964,66 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1706
1964
|
* @secure
|
|
1707
1965
|
*/
|
|
1708
1966
|
credentialControllerCreate: (data: ({
|
|
1709
|
-
provider:
|
|
1967
|
+
provider: 'twilio';
|
|
1710
1968
|
} & CreateTwilioCredentialDTO) | ({
|
|
1711
|
-
provider:
|
|
1969
|
+
provider: 'deepgram';
|
|
1712
1970
|
} & CreateDeepgramCredentialDTO) | ({
|
|
1713
|
-
provider:
|
|
1971
|
+
provider: 'openai';
|
|
1714
1972
|
} & CreateOpenAICredentialDTO) | ({
|
|
1715
|
-
provider:
|
|
1973
|
+
provider: 'together-ai';
|
|
1716
1974
|
} & CreateTogetherAICredentialDTO) | ({
|
|
1717
|
-
provider:
|
|
1975
|
+
provider: 'anyscale';
|
|
1718
1976
|
} & CreateAnyscaleCredentialDTO) | ({
|
|
1719
|
-
provider:
|
|
1977
|
+
provider: 'openrouter';
|
|
1720
1978
|
} & CreateOpenRouterCredentialDTO) | ({
|
|
1721
|
-
provider:
|
|
1979
|
+
provider: 'perplexity-ai';
|
|
1722
1980
|
} & CreatePerplexityAICredentialDTO) | ({
|
|
1723
|
-
provider:
|
|
1981
|
+
provider: 'deepinfra';
|
|
1724
1982
|
} & CreateDeepInfraCredentialDTO) | ({
|
|
1725
|
-
provider:
|
|
1983
|
+
provider: 'custom-llm';
|
|
1726
1984
|
} & CreateCustomLLMCredentialDTO) | ({
|
|
1727
|
-
provider:
|
|
1985
|
+
provider: '11labs';
|
|
1728
1986
|
} & CreateElevenLabsCredentialDTO) | ({
|
|
1729
|
-
provider:
|
|
1987
|
+
provider: 'playht';
|
|
1730
1988
|
} & CreatePlayHTCredentialDTO) | ({
|
|
1731
|
-
provider:
|
|
1989
|
+
provider: 'rime-ai';
|
|
1732
1990
|
} & CreateRimeAICredentialDTO) | ({
|
|
1733
|
-
provider:
|
|
1734
|
-
} & CreateRunpodCredentialDTO)
|
|
1735
|
-
provider:
|
|
1991
|
+
provider: 'runpod';
|
|
1992
|
+
} & CreateRunpodCredentialDTO) | ({
|
|
1993
|
+
provider: 'groq';
|
|
1994
|
+
} & CreateGroqCredentialDTO) | ({
|
|
1995
|
+
provider: 'vonage';
|
|
1996
|
+
} & CreateVonageCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
|
|
1997
|
+
provider: 'twilio';
|
|
1736
1998
|
} & TwilioCredential) | ({
|
|
1737
|
-
provider:
|
|
1999
|
+
provider: 'deepgram';
|
|
1738
2000
|
} & DeepgramCredential) | ({
|
|
1739
|
-
provider:
|
|
2001
|
+
provider: 'openai';
|
|
1740
2002
|
} & OpenAICredential) | ({
|
|
1741
|
-
provider:
|
|
2003
|
+
provider: 'together-ai';
|
|
1742
2004
|
} & TogetherAICredential) | ({
|
|
1743
|
-
provider:
|
|
2005
|
+
provider: 'anyscale';
|
|
1744
2006
|
} & AnyscaleCredential) | ({
|
|
1745
|
-
provider:
|
|
2007
|
+
provider: 'openrouter';
|
|
1746
2008
|
} & OpenRouterCredential) | ({
|
|
1747
|
-
provider:
|
|
2009
|
+
provider: 'perplexity-ai';
|
|
1748
2010
|
} & PerplexityAICredential) | ({
|
|
1749
|
-
provider:
|
|
2011
|
+
provider: 'deepinfra';
|
|
1750
2012
|
} & DeepInfraCredential) | ({
|
|
1751
|
-
provider:
|
|
2013
|
+
provider: 'custom-llm';
|
|
1752
2014
|
} & CustomLLMCredential) | ({
|
|
1753
|
-
provider:
|
|
2015
|
+
provider: '11labs';
|
|
1754
2016
|
} & ElevenLabsCredential) | ({
|
|
1755
|
-
provider:
|
|
2017
|
+
provider: 'playht';
|
|
1756
2018
|
} & PlayHTCredential) | ({
|
|
1757
|
-
provider:
|
|
2019
|
+
provider: 'rime-ai';
|
|
1758
2020
|
} & RimeAICredential) | ({
|
|
1759
|
-
provider:
|
|
1760
|
-
} & RunpodCredential)
|
|
2021
|
+
provider: 'runpod';
|
|
2022
|
+
} & RunpodCredential) | ({
|
|
2023
|
+
provider: 'groq';
|
|
2024
|
+
} & GroqCredential) | ({
|
|
2025
|
+
provider: 'vonage';
|
|
2026
|
+
} & VonageCredential), any>>;
|
|
1761
2027
|
/**
|
|
1762
2028
|
* No description
|
|
1763
2029
|
*
|
|
@@ -1815,32 +2081,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1815
2081
|
*/
|
|
1816
2082
|
updatedAtLe?: string;
|
|
1817
2083
|
}, params?: RequestParams) => Promise<HttpResponse<(({
|
|
1818
|
-
provider:
|
|
2084
|
+
provider: 'twilio';
|
|
1819
2085
|
} & TwilioCredential) | ({
|
|
1820
|
-
provider:
|
|
2086
|
+
provider: 'deepgram';
|
|
1821
2087
|
} & DeepgramCredential) | ({
|
|
1822
|
-
provider:
|
|
2088
|
+
provider: 'openai';
|
|
1823
2089
|
} & OpenAICredential) | ({
|
|
1824
|
-
provider:
|
|
2090
|
+
provider: 'together-ai';
|
|
1825
2091
|
} & TogetherAICredential) | ({
|
|
1826
|
-
provider:
|
|
2092
|
+
provider: 'anyscale';
|
|
1827
2093
|
} & AnyscaleCredential) | ({
|
|
1828
|
-
provider:
|
|
2094
|
+
provider: 'openrouter';
|
|
1829
2095
|
} & OpenRouterCredential) | ({
|
|
1830
|
-
provider:
|
|
2096
|
+
provider: 'perplexity-ai';
|
|
1831
2097
|
} & PerplexityAICredential) | ({
|
|
1832
|
-
provider:
|
|
2098
|
+
provider: 'deepinfra';
|
|
1833
2099
|
} & DeepInfraCredential) | ({
|
|
1834
|
-
provider:
|
|
2100
|
+
provider: 'custom-llm';
|
|
1835
2101
|
} & CustomLLMCredential) | ({
|
|
1836
|
-
provider:
|
|
2102
|
+
provider: '11labs';
|
|
1837
2103
|
} & ElevenLabsCredential) | ({
|
|
1838
|
-
provider:
|
|
2104
|
+
provider: 'playht';
|
|
1839
2105
|
} & PlayHTCredential) | ({
|
|
1840
|
-
provider:
|
|
2106
|
+
provider: 'rime-ai';
|
|
1841
2107
|
} & RimeAICredential) | ({
|
|
1842
|
-
provider:
|
|
1843
|
-
} & RunpodCredential)
|
|
2108
|
+
provider: 'runpod';
|
|
2109
|
+
} & RunpodCredential) | ({
|
|
2110
|
+
provider: 'groq';
|
|
2111
|
+
} & GroqCredential) | ({
|
|
2112
|
+
provider: 'vonage';
|
|
2113
|
+
} & VonageCredential))[], any>>;
|
|
1844
2114
|
/**
|
|
1845
2115
|
* No description
|
|
1846
2116
|
*
|
|
@@ -1851,32 +2121,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1851
2121
|
* @secure
|
|
1852
2122
|
*/
|
|
1853
2123
|
credentialControllerFindOne: (id: string, params?: RequestParams) => Promise<HttpResponse<({
|
|
1854
|
-
provider:
|
|
2124
|
+
provider: 'twilio';
|
|
1855
2125
|
} & TwilioCredential) | ({
|
|
1856
|
-
provider:
|
|
2126
|
+
provider: 'deepgram';
|
|
1857
2127
|
} & DeepgramCredential) | ({
|
|
1858
|
-
provider:
|
|
2128
|
+
provider: 'openai';
|
|
1859
2129
|
} & OpenAICredential) | ({
|
|
1860
|
-
provider:
|
|
2130
|
+
provider: 'together-ai';
|
|
1861
2131
|
} & TogetherAICredential) | ({
|
|
1862
|
-
provider:
|
|
2132
|
+
provider: 'anyscale';
|
|
1863
2133
|
} & AnyscaleCredential) | ({
|
|
1864
|
-
provider:
|
|
2134
|
+
provider: 'openrouter';
|
|
1865
2135
|
} & OpenRouterCredential) | ({
|
|
1866
|
-
provider:
|
|
2136
|
+
provider: 'perplexity-ai';
|
|
1867
2137
|
} & PerplexityAICredential) | ({
|
|
1868
|
-
provider:
|
|
2138
|
+
provider: 'deepinfra';
|
|
1869
2139
|
} & DeepInfraCredential) | ({
|
|
1870
|
-
provider:
|
|
2140
|
+
provider: 'custom-llm';
|
|
1871
2141
|
} & CustomLLMCredential) | ({
|
|
1872
|
-
provider:
|
|
2142
|
+
provider: '11labs';
|
|
1873
2143
|
} & ElevenLabsCredential) | ({
|
|
1874
|
-
provider:
|
|
2144
|
+
provider: 'playht';
|
|
1875
2145
|
} & PlayHTCredential) | ({
|
|
1876
|
-
provider:
|
|
2146
|
+
provider: 'rime-ai';
|
|
1877
2147
|
} & RimeAICredential) | ({
|
|
1878
|
-
provider:
|
|
1879
|
-
} & RunpodCredential)
|
|
2148
|
+
provider: 'runpod';
|
|
2149
|
+
} & RunpodCredential) | ({
|
|
2150
|
+
provider: 'groq';
|
|
2151
|
+
} & GroqCredential) | ({
|
|
2152
|
+
provider: 'vonage';
|
|
2153
|
+
} & VonageCredential), any>>;
|
|
1880
2154
|
/**
|
|
1881
2155
|
* No description
|
|
1882
2156
|
*
|
|
@@ -1887,58 +2161,66 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1887
2161
|
* @secure
|
|
1888
2162
|
*/
|
|
1889
2163
|
credentialControllerUpdate: (id: string, data: ({
|
|
1890
|
-
provider:
|
|
2164
|
+
provider: 'twilio';
|
|
1891
2165
|
} & UpdateTwilioCredentialDTO) | ({
|
|
1892
|
-
provider:
|
|
2166
|
+
provider: 'deepgram';
|
|
1893
2167
|
} & UpdateDeepgramCredentialDTO) | ({
|
|
1894
|
-
provider:
|
|
2168
|
+
provider: 'openai';
|
|
1895
2169
|
} & UpdateOpenAICredentialDTO) | ({
|
|
1896
|
-
provider:
|
|
2170
|
+
provider: 'together-ai';
|
|
1897
2171
|
} & UpdateTogetherAICredentialDTO) | ({
|
|
1898
|
-
provider:
|
|
2172
|
+
provider: 'anyscale';
|
|
1899
2173
|
} & UpdateAnyscaleCredentialDTO) | ({
|
|
1900
|
-
provider:
|
|
2174
|
+
provider: 'openrouter';
|
|
1901
2175
|
} & UpdateOpenRouterCredentialDTO) | ({
|
|
1902
|
-
provider:
|
|
2176
|
+
provider: 'perplexity-ai';
|
|
1903
2177
|
} & UpdatePerplexityAICredentialDTO) | ({
|
|
1904
|
-
provider:
|
|
2178
|
+
provider: 'deepinfra';
|
|
1905
2179
|
} & UpdateDeepInfraCredentialDTO) | ({
|
|
1906
|
-
provider:
|
|
2180
|
+
provider: 'custom-llm';
|
|
1907
2181
|
} & UpdateCustomLLMCredentialDTO) | ({
|
|
1908
|
-
provider:
|
|
2182
|
+
provider: '11labs';
|
|
1909
2183
|
} & UpdateElevenLabsCredentialDTO) | ({
|
|
1910
|
-
provider:
|
|
2184
|
+
provider: 'playht';
|
|
1911
2185
|
} & UpdatePlayHTCredentialDTO) | ({
|
|
1912
|
-
provider:
|
|
2186
|
+
provider: 'rime-ai';
|
|
1913
2187
|
} & UpdateRimeAICredentialDTO) | ({
|
|
1914
|
-
provider:
|
|
1915
|
-
} & UpdateRunpodCredentialDTO)
|
|
1916
|
-
provider:
|
|
2188
|
+
provider: 'runpod';
|
|
2189
|
+
} & UpdateRunpodCredentialDTO) | ({
|
|
2190
|
+
provider: 'groq';
|
|
2191
|
+
} & UpdateGroqCredentialDTO) | ({
|
|
2192
|
+
provider: 'vonage';
|
|
2193
|
+
} & UpdateVonageCredentialDTO), params?: RequestParams) => Promise<HttpResponse<({
|
|
2194
|
+
provider: 'twilio';
|
|
1917
2195
|
} & TwilioCredential) | ({
|
|
1918
|
-
provider:
|
|
2196
|
+
provider: 'deepgram';
|
|
1919
2197
|
} & DeepgramCredential) | ({
|
|
1920
|
-
provider:
|
|
2198
|
+
provider: 'openai';
|
|
1921
2199
|
} & OpenAICredential) | ({
|
|
1922
|
-
provider:
|
|
2200
|
+
provider: 'together-ai';
|
|
1923
2201
|
} & TogetherAICredential) | ({
|
|
1924
|
-
provider:
|
|
2202
|
+
provider: 'anyscale';
|
|
1925
2203
|
} & AnyscaleCredential) | ({
|
|
1926
|
-
provider:
|
|
2204
|
+
provider: 'openrouter';
|
|
1927
2205
|
} & OpenRouterCredential) | ({
|
|
1928
|
-
provider:
|
|
2206
|
+
provider: 'perplexity-ai';
|
|
1929
2207
|
} & PerplexityAICredential) | ({
|
|
1930
|
-
provider:
|
|
2208
|
+
provider: 'deepinfra';
|
|
1931
2209
|
} & DeepInfraCredential) | ({
|
|
1932
|
-
provider:
|
|
2210
|
+
provider: 'custom-llm';
|
|
1933
2211
|
} & CustomLLMCredential) | ({
|
|
1934
|
-
provider:
|
|
2212
|
+
provider: '11labs';
|
|
1935
2213
|
} & ElevenLabsCredential) | ({
|
|
1936
|
-
provider:
|
|
2214
|
+
provider: 'playht';
|
|
1937
2215
|
} & PlayHTCredential) | ({
|
|
1938
|
-
provider:
|
|
2216
|
+
provider: 'rime-ai';
|
|
1939
2217
|
} & RimeAICredential) | ({
|
|
1940
|
-
provider:
|
|
1941
|
-
} & RunpodCredential)
|
|
2218
|
+
provider: 'runpod';
|
|
2219
|
+
} & RunpodCredential) | ({
|
|
2220
|
+
provider: 'groq';
|
|
2221
|
+
} & GroqCredential) | ({
|
|
2222
|
+
provider: 'vonage';
|
|
2223
|
+
} & VonageCredential), any>>;
|
|
1942
2224
|
/**
|
|
1943
2225
|
* No description
|
|
1944
2226
|
*
|
|
@@ -1949,32 +2231,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1949
2231
|
* @secure
|
|
1950
2232
|
*/
|
|
1951
2233
|
credentialControllerRemove: (id: string, params?: RequestParams) => Promise<HttpResponse<({
|
|
1952
|
-
provider:
|
|
2234
|
+
provider: 'twilio';
|
|
1953
2235
|
} & TwilioCredential) | ({
|
|
1954
|
-
provider:
|
|
2236
|
+
provider: 'deepgram';
|
|
1955
2237
|
} & DeepgramCredential) | ({
|
|
1956
|
-
provider:
|
|
2238
|
+
provider: 'openai';
|
|
1957
2239
|
} & OpenAICredential) | ({
|
|
1958
|
-
provider:
|
|
2240
|
+
provider: 'together-ai';
|
|
1959
2241
|
} & TogetherAICredential) | ({
|
|
1960
|
-
provider:
|
|
2242
|
+
provider: 'anyscale';
|
|
1961
2243
|
} & AnyscaleCredential) | ({
|
|
1962
|
-
provider:
|
|
2244
|
+
provider: 'openrouter';
|
|
1963
2245
|
} & OpenRouterCredential) | ({
|
|
1964
|
-
provider:
|
|
2246
|
+
provider: 'perplexity-ai';
|
|
1965
2247
|
} & PerplexityAICredential) | ({
|
|
1966
|
-
provider:
|
|
2248
|
+
provider: 'deepinfra';
|
|
1967
2249
|
} & DeepInfraCredential) | ({
|
|
1968
|
-
provider:
|
|
2250
|
+
provider: 'custom-llm';
|
|
1969
2251
|
} & CustomLLMCredential) | ({
|
|
1970
|
-
provider:
|
|
2252
|
+
provider: '11labs';
|
|
1971
2253
|
} & ElevenLabsCredential) | ({
|
|
1972
|
-
provider:
|
|
2254
|
+
provider: 'playht';
|
|
1973
2255
|
} & PlayHTCredential) | ({
|
|
1974
|
-
provider:
|
|
2256
|
+
provider: 'rime-ai';
|
|
1975
2257
|
} & RimeAICredential) | ({
|
|
1976
|
-
provider:
|
|
1977
|
-
} & RunpodCredential)
|
|
2258
|
+
provider: 'runpod';
|
|
2259
|
+
} & RunpodCredential) | ({
|
|
2260
|
+
provider: 'groq';
|
|
2261
|
+
} & GroqCredential) | ({
|
|
2262
|
+
provider: 'vonage';
|
|
2263
|
+
} & VonageCredential), any>>;
|
|
1978
2264
|
};
|
|
1979
2265
|
phoneNumber: {
|
|
1980
2266
|
/**
|
|
@@ -1991,12 +2277,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
1991
2277
|
* No description
|
|
1992
2278
|
*
|
|
1993
2279
|
* @tags Phone Numbers
|
|
1994
|
-
* @name
|
|
2280
|
+
* @name PhoneNumberControllerImportTwilio
|
|
1995
2281
|
* @summary Import Twilio Number
|
|
1996
|
-
* @request POST:/phone-number/import
|
|
2282
|
+
* @request POST:/phone-number/import/twilio
|
|
2283
|
+
* @secure
|
|
2284
|
+
*/
|
|
2285
|
+
phoneNumberControllerImportTwilio: (data: ImportTwilioPhoneNumberDTO, params?: RequestParams) => Promise<HttpResponse<PhoneNumber, any>>;
|
|
2286
|
+
/**
|
|
2287
|
+
* No description
|
|
2288
|
+
*
|
|
2289
|
+
* @tags Phone Numbers
|
|
2290
|
+
* @name PhoneNumberControllerImportVonage
|
|
2291
|
+
* @summary Import Vonage Number
|
|
2292
|
+
* @request POST:/phone-number/import/vonage
|
|
1997
2293
|
* @secure
|
|
1998
2294
|
*/
|
|
1999
|
-
|
|
2295
|
+
phoneNumberControllerImportVonage: (data: ImportVonagePhoneNumberDTO, params?: RequestParams) => Promise<HttpResponse<PhoneNumber, any>>;
|
|
2000
2296
|
/**
|
|
2001
2297
|
* No description
|
|
2002
2298
|
*
|