@vapi-ai/mcp-server 0.0.11 → 0.2.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/README.md +241 -104
- package/dist/knowledge/docs.d.ts +96 -0
- package/dist/knowledge/docs.d.ts.map +1 -0
- package/dist/knowledge/docs.js +16 -0
- package/dist/knowledge/skills.d.ts +28 -0
- package/dist/knowledge/skills.d.ts.map +1 -0
- package/dist/knowledge/skills.js +131 -0
- package/dist/schemas/assistant-openapi.d.ts +31 -0
- package/dist/schemas/assistant-openapi.d.ts.map +1 -0
- package/dist/schemas/assistant-openapi.js +87 -0
- package/dist/schemas/assistant-openapi.json +2341 -0
- package/dist/schemas/index.d.ts +161 -1181
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +99 -172
- package/dist/schemas/simulation-openapi.d.ts +9 -0
- package/dist/schemas/simulation-openapi.d.ts.map +1 -0
- package/dist/schemas/simulation-openapi.js +81 -0
- package/dist/schemas/simulation-openapi.json +27558 -0
- package/dist/schemas/simulation.d.ts +54 -0
- package/dist/schemas/simulation.d.ts.map +1 -0
- package/dist/schemas/simulation.js +76 -0
- package/dist/tools/annotations.d.ts +5 -0
- package/dist/tools/annotations.d.ts.map +1 -0
- package/dist/tools/annotations.js +14 -0
- package/dist/tools/api-schema.d.ts +4 -0
- package/dist/tools/api-schema.d.ts.map +1 -0
- package/dist/tools/api-schema.js +69 -0
- package/dist/tools/assistant.d.ts.map +1 -1
- package/dist/tools/assistant.js +33 -17
- package/dist/tools/call.d.ts.map +1 -1
- package/dist/tools/call.js +20 -11
- package/dist/tools/docs.d.ts +3 -0
- package/dist/tools/docs.d.ts.map +1 -0
- package/dist/tools/docs.js +27 -0
- package/dist/tools/index.d.ts.map +1 -1
- package/dist/tools/index.js +8 -0
- package/dist/tools/input-schema.d.ts +5 -0
- package/dist/tools/input-schema.d.ts.map +1 -0
- package/dist/tools/input-schema.js +59 -0
- package/dist/tools/list.d.ts +34 -0
- package/dist/tools/list.d.ts.map +1 -0
- package/dist/tools/list.js +47 -0
- package/dist/tools/phone-number.d.ts.map +1 -1
- package/dist/tools/phone-number.js +17 -10
- package/dist/tools/simulation.d.ts +4 -0
- package/dist/tools/simulation.d.ts.map +1 -0
- package/dist/tools/simulation.js +146 -0
- package/dist/tools/skills.d.ts +3 -0
- package/dist/tools/skills.d.ts.map +1 -0
- package/dist/tools/skills.js +31 -0
- package/dist/tools/tool.d.ts.map +1 -1
- package/dist/tools/tool.js +31 -14
- package/dist/tools/validation.d.ts +24 -0
- package/dist/tools/validation.d.ts.map +1 -0
- package/dist/tools/validation.js +94 -0
- package/dist/transformers/index.d.ts +3 -3
- package/dist/transformers/index.d.ts.map +1 -1
- package/dist/transformers/index.js +52 -31
- package/package.json +9 -6
|
@@ -0,0 +1,2341 @@
|
|
|
1
|
+
{
|
|
2
|
+
"source": {
|
|
3
|
+
"url": "https://api.vapi.ai/api-json",
|
|
4
|
+
"sha256": "588ea097c209bbb6f49a5f314979b04cd71df2355114cb32b9931e441b0153f8"
|
|
5
|
+
},
|
|
6
|
+
"name": {
|
|
7
|
+
"create": {
|
|
8
|
+
"type": "string",
|
|
9
|
+
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
|
|
10
|
+
"maxLength": 40
|
|
11
|
+
},
|
|
12
|
+
"update": {
|
|
13
|
+
"type": "string",
|
|
14
|
+
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
|
|
15
|
+
"maxLength": 40
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"voice": [
|
|
19
|
+
{
|
|
20
|
+
"name": "AzureVoice",
|
|
21
|
+
"required": [
|
|
22
|
+
"provider",
|
|
23
|
+
"voiceId"
|
|
24
|
+
],
|
|
25
|
+
"properties": {
|
|
26
|
+
"provider": {
|
|
27
|
+
"type": "string",
|
|
28
|
+
"description": "This is the voice provider that will be used.",
|
|
29
|
+
"enum": [
|
|
30
|
+
"azure"
|
|
31
|
+
]
|
|
32
|
+
},
|
|
33
|
+
"voiceId": {
|
|
34
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
35
|
+
"oneOf": [
|
|
36
|
+
{
|
|
37
|
+
"type": "string",
|
|
38
|
+
"enum": [
|
|
39
|
+
"andrew",
|
|
40
|
+
"brian",
|
|
41
|
+
"emma"
|
|
42
|
+
],
|
|
43
|
+
"title": "Preset Voice Options"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"type": "string",
|
|
47
|
+
"title": "Azure Voice ID"
|
|
48
|
+
}
|
|
49
|
+
]
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
},
|
|
53
|
+
{
|
|
54
|
+
"name": "CartesiaVoice",
|
|
55
|
+
"required": [
|
|
56
|
+
"provider",
|
|
57
|
+
"voiceId"
|
|
58
|
+
],
|
|
59
|
+
"properties": {
|
|
60
|
+
"provider": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"description": "This is the voice provider that will be used.",
|
|
63
|
+
"enum": [
|
|
64
|
+
"cartesia"
|
|
65
|
+
]
|
|
66
|
+
},
|
|
67
|
+
"voiceId": {
|
|
68
|
+
"type": "string",
|
|
69
|
+
"description": "The ID of the particular voice you want to use."
|
|
70
|
+
},
|
|
71
|
+
"model": {
|
|
72
|
+
"type": "string",
|
|
73
|
+
"description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
|
|
74
|
+
"enum": [
|
|
75
|
+
"sonic-3.5",
|
|
76
|
+
"sonic-3.5-2026-05-04",
|
|
77
|
+
"sonic-3.6",
|
|
78
|
+
"sonic-3.6-2026-08-27",
|
|
79
|
+
"sonic-3",
|
|
80
|
+
"sonic-3-2026-01-12",
|
|
81
|
+
"sonic-3-2025-10-27",
|
|
82
|
+
"sonic-2",
|
|
83
|
+
"sonic-2-2025-06-11",
|
|
84
|
+
"sonic-english",
|
|
85
|
+
"sonic-multilingual",
|
|
86
|
+
"sonic-preview",
|
|
87
|
+
"sonic"
|
|
88
|
+
],
|
|
89
|
+
"example": "sonic-3.5"
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
{
|
|
94
|
+
"name": "CustomVoice",
|
|
95
|
+
"required": [
|
|
96
|
+
"provider",
|
|
97
|
+
"server"
|
|
98
|
+
],
|
|
99
|
+
"properties": {
|
|
100
|
+
"provider": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"description": "This is the voice provider that will be used. Use `custom-voice` for providers that are not natively supported.",
|
|
103
|
+
"enum": [
|
|
104
|
+
"custom-voice"
|
|
105
|
+
]
|
|
106
|
+
},
|
|
107
|
+
"voiceId": {
|
|
108
|
+
"type": "string",
|
|
109
|
+
"description": "This is the provider-specific ID that will be used. This is passed in the voice request payload to identify the voice to use."
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"name": "DeepgramVoice",
|
|
115
|
+
"required": [
|
|
116
|
+
"provider",
|
|
117
|
+
"voiceId"
|
|
118
|
+
],
|
|
119
|
+
"properties": {
|
|
120
|
+
"provider": {
|
|
121
|
+
"type": "string",
|
|
122
|
+
"description": "This is the voice provider that will be used.",
|
|
123
|
+
"enum": [
|
|
124
|
+
"deepgram"
|
|
125
|
+
]
|
|
126
|
+
},
|
|
127
|
+
"voiceId": {
|
|
128
|
+
"type": "string",
|
|
129
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
130
|
+
"enum": [
|
|
131
|
+
"asteria",
|
|
132
|
+
"luna",
|
|
133
|
+
"stella",
|
|
134
|
+
"athena",
|
|
135
|
+
"hera",
|
|
136
|
+
"orion",
|
|
137
|
+
"arcas",
|
|
138
|
+
"perseus",
|
|
139
|
+
"angus",
|
|
140
|
+
"orpheus",
|
|
141
|
+
"helios",
|
|
142
|
+
"zeus",
|
|
143
|
+
"thalia",
|
|
144
|
+
"andromeda",
|
|
145
|
+
"helena",
|
|
146
|
+
"apollo",
|
|
147
|
+
"arcas",
|
|
148
|
+
"aries",
|
|
149
|
+
"amalthea",
|
|
150
|
+
"asteria",
|
|
151
|
+
"athena",
|
|
152
|
+
"atlas",
|
|
153
|
+
"aurora",
|
|
154
|
+
"callista",
|
|
155
|
+
"cora",
|
|
156
|
+
"cordelia",
|
|
157
|
+
"delia",
|
|
158
|
+
"draco",
|
|
159
|
+
"electra",
|
|
160
|
+
"harmonia",
|
|
161
|
+
"hera",
|
|
162
|
+
"hermes",
|
|
163
|
+
"hyperion",
|
|
164
|
+
"iris",
|
|
165
|
+
"janus",
|
|
166
|
+
"juno",
|
|
167
|
+
"jupiter",
|
|
168
|
+
"luna",
|
|
169
|
+
"mars",
|
|
170
|
+
"minerva",
|
|
171
|
+
"neptune",
|
|
172
|
+
"odysseus",
|
|
173
|
+
"ophelia",
|
|
174
|
+
"orion",
|
|
175
|
+
"orpheus",
|
|
176
|
+
"pandora",
|
|
177
|
+
"phoebe",
|
|
178
|
+
"pluto",
|
|
179
|
+
"saturn",
|
|
180
|
+
"selene",
|
|
181
|
+
"theia",
|
|
182
|
+
"vesta",
|
|
183
|
+
"zeus",
|
|
184
|
+
"celeste",
|
|
185
|
+
"estrella",
|
|
186
|
+
"nestor",
|
|
187
|
+
"sirio",
|
|
188
|
+
"carina",
|
|
189
|
+
"alvaro",
|
|
190
|
+
"diana",
|
|
191
|
+
"aquila",
|
|
192
|
+
"selena",
|
|
193
|
+
"javier",
|
|
194
|
+
"viktoria",
|
|
195
|
+
"kara",
|
|
196
|
+
"fabian",
|
|
197
|
+
"julius",
|
|
198
|
+
"lara",
|
|
199
|
+
"elara",
|
|
200
|
+
"aurelia",
|
|
201
|
+
"hannah",
|
|
202
|
+
"kit",
|
|
203
|
+
"alexis",
|
|
204
|
+
"cliff",
|
|
205
|
+
"sienna",
|
|
206
|
+
"cole",
|
|
207
|
+
"brooke",
|
|
208
|
+
"colin",
|
|
209
|
+
"gemma",
|
|
210
|
+
"haley",
|
|
211
|
+
"heather",
|
|
212
|
+
"miles",
|
|
213
|
+
"sean",
|
|
214
|
+
"bree",
|
|
215
|
+
"brittany",
|
|
216
|
+
"bruce",
|
|
217
|
+
"conor",
|
|
218
|
+
"donovan",
|
|
219
|
+
"drew",
|
|
220
|
+
"elise",
|
|
221
|
+
"jack",
|
|
222
|
+
"kai",
|
|
223
|
+
"kelsey",
|
|
224
|
+
"maeve",
|
|
225
|
+
"marcelo",
|
|
226
|
+
"marcus",
|
|
227
|
+
"meena",
|
|
228
|
+
"meghan",
|
|
229
|
+
"naveen",
|
|
230
|
+
"paige",
|
|
231
|
+
"priya",
|
|
232
|
+
"rufus",
|
|
233
|
+
"sharon",
|
|
234
|
+
"tanner",
|
|
235
|
+
"wade",
|
|
236
|
+
"wes"
|
|
237
|
+
],
|
|
238
|
+
"title": "This is the Deepgram Voice ID"
|
|
239
|
+
},
|
|
240
|
+
"model": {
|
|
241
|
+
"type": "string",
|
|
242
|
+
"description": "This is the model that will be used. Defaults to 'aura' when not specified.",
|
|
243
|
+
"enum": [
|
|
244
|
+
"aura",
|
|
245
|
+
"aura-2",
|
|
246
|
+
"flux"
|
|
247
|
+
],
|
|
248
|
+
"example": "aura-2"
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
},
|
|
252
|
+
{
|
|
253
|
+
"name": "ElevenLabsVoice",
|
|
254
|
+
"required": [
|
|
255
|
+
"provider",
|
|
256
|
+
"voiceId"
|
|
257
|
+
],
|
|
258
|
+
"properties": {
|
|
259
|
+
"provider": {
|
|
260
|
+
"type": "string",
|
|
261
|
+
"description": "This is the voice provider that will be used.",
|
|
262
|
+
"enum": [
|
|
263
|
+
"11labs"
|
|
264
|
+
]
|
|
265
|
+
},
|
|
266
|
+
"voiceId": {
|
|
267
|
+
"description": "This is the provider-specific ID that will be used. Ensure the Voice is present in your 11Labs Voice Library.",
|
|
268
|
+
"oneOf": [
|
|
269
|
+
{
|
|
270
|
+
"type": "string",
|
|
271
|
+
"enum": [
|
|
272
|
+
"burt",
|
|
273
|
+
"marissa",
|
|
274
|
+
"andrea",
|
|
275
|
+
"sarah",
|
|
276
|
+
"phillip",
|
|
277
|
+
"steve",
|
|
278
|
+
"joseph",
|
|
279
|
+
"myra",
|
|
280
|
+
"paula",
|
|
281
|
+
"ryan",
|
|
282
|
+
"drew",
|
|
283
|
+
"paul",
|
|
284
|
+
"mrb",
|
|
285
|
+
"matilda",
|
|
286
|
+
"mark"
|
|
287
|
+
],
|
|
288
|
+
"title": "Preset Voice Options"
|
|
289
|
+
},
|
|
290
|
+
{
|
|
291
|
+
"type": "string",
|
|
292
|
+
"title": "11Labs Voice ID"
|
|
293
|
+
}
|
|
294
|
+
]
|
|
295
|
+
},
|
|
296
|
+
"model": {
|
|
297
|
+
"type": "string",
|
|
298
|
+
"description": "This is the model that will be used. Defaults to 'eleven_turbo_v2' if not specified.",
|
|
299
|
+
"enum": [
|
|
300
|
+
"eleven_multilingual_v2",
|
|
301
|
+
"eleven_turbo_v2",
|
|
302
|
+
"eleven_turbo_v2_5",
|
|
303
|
+
"eleven_flash_v2",
|
|
304
|
+
"eleven_flash_v2_5",
|
|
305
|
+
"eleven_monolingual_v1",
|
|
306
|
+
"eleven_v3",
|
|
307
|
+
"eleven_v4_turbo",
|
|
308
|
+
"eleven_v3_conversational"
|
|
309
|
+
],
|
|
310
|
+
"example": "eleven_turbo_v2_5"
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
},
|
|
314
|
+
{
|
|
315
|
+
"name": "HumeVoice",
|
|
316
|
+
"required": [
|
|
317
|
+
"provider",
|
|
318
|
+
"voiceId"
|
|
319
|
+
],
|
|
320
|
+
"properties": {
|
|
321
|
+
"provider": {
|
|
322
|
+
"type": "string",
|
|
323
|
+
"description": "This is the voice provider that will be used.",
|
|
324
|
+
"enum": [
|
|
325
|
+
"hume"
|
|
326
|
+
]
|
|
327
|
+
},
|
|
328
|
+
"voiceId": {
|
|
329
|
+
"type": "string",
|
|
330
|
+
"description": "The ID of the particular voice you want to use."
|
|
331
|
+
},
|
|
332
|
+
"model": {
|
|
333
|
+
"type": "string",
|
|
334
|
+
"description": "This is the model that will be used.",
|
|
335
|
+
"enum": [
|
|
336
|
+
"octave",
|
|
337
|
+
"octave2"
|
|
338
|
+
],
|
|
339
|
+
"example": "octave2"
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "LMNTVoice",
|
|
345
|
+
"required": [
|
|
346
|
+
"provider",
|
|
347
|
+
"voiceId"
|
|
348
|
+
],
|
|
349
|
+
"properties": {
|
|
350
|
+
"provider": {
|
|
351
|
+
"type": "string",
|
|
352
|
+
"description": "This is the voice provider that will be used.",
|
|
353
|
+
"enum": [
|
|
354
|
+
"lmnt"
|
|
355
|
+
]
|
|
356
|
+
},
|
|
357
|
+
"voiceId": {
|
|
358
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
359
|
+
"oneOf": [
|
|
360
|
+
{
|
|
361
|
+
"type": "string",
|
|
362
|
+
"enum": [
|
|
363
|
+
"amy",
|
|
364
|
+
"ansel",
|
|
365
|
+
"autumn",
|
|
366
|
+
"ava",
|
|
367
|
+
"brandon",
|
|
368
|
+
"caleb",
|
|
369
|
+
"cassian",
|
|
370
|
+
"chloe",
|
|
371
|
+
"dalton",
|
|
372
|
+
"daniel",
|
|
373
|
+
"dustin",
|
|
374
|
+
"elowen",
|
|
375
|
+
"evander",
|
|
376
|
+
"huxley",
|
|
377
|
+
"james",
|
|
378
|
+
"juniper",
|
|
379
|
+
"kennedy",
|
|
380
|
+
"lauren",
|
|
381
|
+
"leah",
|
|
382
|
+
"lily",
|
|
383
|
+
"lucas",
|
|
384
|
+
"magnus",
|
|
385
|
+
"miles",
|
|
386
|
+
"morgan",
|
|
387
|
+
"natalie",
|
|
388
|
+
"nathan",
|
|
389
|
+
"noah",
|
|
390
|
+
"nyssa",
|
|
391
|
+
"oliver",
|
|
392
|
+
"paige",
|
|
393
|
+
"ryan",
|
|
394
|
+
"sadie",
|
|
395
|
+
"sophie",
|
|
396
|
+
"stella",
|
|
397
|
+
"terrence",
|
|
398
|
+
"tyler",
|
|
399
|
+
"vesper",
|
|
400
|
+
"violet",
|
|
401
|
+
"warrick",
|
|
402
|
+
"zain",
|
|
403
|
+
"zeke",
|
|
404
|
+
"zoe"
|
|
405
|
+
],
|
|
406
|
+
"title": "Preset Voice Options"
|
|
407
|
+
},
|
|
408
|
+
{
|
|
409
|
+
"type": "string",
|
|
410
|
+
"title": "LMNT Voice ID"
|
|
411
|
+
}
|
|
412
|
+
]
|
|
413
|
+
}
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
"name": "NeuphonicVoice",
|
|
418
|
+
"required": [
|
|
419
|
+
"provider",
|
|
420
|
+
"voiceId",
|
|
421
|
+
"language"
|
|
422
|
+
],
|
|
423
|
+
"properties": {
|
|
424
|
+
"provider": {
|
|
425
|
+
"type": "string",
|
|
426
|
+
"description": "This is the voice provider that will be used.",
|
|
427
|
+
"enum": [
|
|
428
|
+
"neuphonic"
|
|
429
|
+
]
|
|
430
|
+
},
|
|
431
|
+
"voiceId": {
|
|
432
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
433
|
+
"oneOf": [
|
|
434
|
+
{
|
|
435
|
+
"type": "string",
|
|
436
|
+
"enum": [],
|
|
437
|
+
"title": "Preset Voice Options"
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
"type": "string",
|
|
441
|
+
"title": "Neuphonic Voice ID"
|
|
442
|
+
}
|
|
443
|
+
]
|
|
444
|
+
},
|
|
445
|
+
"model": {
|
|
446
|
+
"type": "string",
|
|
447
|
+
"description": "This is the model that will be used. Defaults to 'neu_fast' if not specified.",
|
|
448
|
+
"enum": [
|
|
449
|
+
"neu_hq",
|
|
450
|
+
"neu_fast"
|
|
451
|
+
],
|
|
452
|
+
"example": "neu_fast"
|
|
453
|
+
}
|
|
454
|
+
}
|
|
455
|
+
},
|
|
456
|
+
{
|
|
457
|
+
"name": "OpenAIVoice",
|
|
458
|
+
"required": [
|
|
459
|
+
"provider",
|
|
460
|
+
"voiceId"
|
|
461
|
+
],
|
|
462
|
+
"properties": {
|
|
463
|
+
"provider": {
|
|
464
|
+
"type": "string",
|
|
465
|
+
"description": "This is the voice provider that will be used.",
|
|
466
|
+
"enum": [
|
|
467
|
+
"openai"
|
|
468
|
+
]
|
|
469
|
+
},
|
|
470
|
+
"voiceId": {
|
|
471
|
+
"description": "This is the provider-specific ID that will be used.\nVoice availability depends on the selected model: voices offered only by GPT-Live are rejected for other models.",
|
|
472
|
+
"anyOf": [
|
|
473
|
+
{
|
|
474
|
+
"type": "string",
|
|
475
|
+
"enum": [
|
|
476
|
+
"alloy",
|
|
477
|
+
"echo",
|
|
478
|
+
"fable",
|
|
479
|
+
"onyx",
|
|
480
|
+
"nova",
|
|
481
|
+
"shimmer",
|
|
482
|
+
"marin",
|
|
483
|
+
"cedar",
|
|
484
|
+
"ash",
|
|
485
|
+
"ballad",
|
|
486
|
+
"beacon",
|
|
487
|
+
"bossa",
|
|
488
|
+
"brise",
|
|
489
|
+
"cinder",
|
|
490
|
+
"coral",
|
|
491
|
+
"delta",
|
|
492
|
+
"flitz",
|
|
493
|
+
"gleam",
|
|
494
|
+
"harema",
|
|
495
|
+
"juni",
|
|
496
|
+
"meridian",
|
|
497
|
+
"nira",
|
|
498
|
+
"noeul",
|
|
499
|
+
"nuri",
|
|
500
|
+
"quartz",
|
|
501
|
+
"ripple",
|
|
502
|
+
"sage",
|
|
503
|
+
"shida",
|
|
504
|
+
"sillage",
|
|
505
|
+
"stone",
|
|
506
|
+
"tempo",
|
|
507
|
+
"verse",
|
|
508
|
+
"vesper",
|
|
509
|
+
"willow"
|
|
510
|
+
],
|
|
511
|
+
"title": "Preset Voice Options"
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
"type": "string",
|
|
515
|
+
"title": "OpenAI Voice ID"
|
|
516
|
+
}
|
|
517
|
+
]
|
|
518
|
+
},
|
|
519
|
+
"model": {
|
|
520
|
+
"type": "string",
|
|
521
|
+
"description": "This is the model that will be used for text-to-speech.",
|
|
522
|
+
"enum": [
|
|
523
|
+
"tts-1",
|
|
524
|
+
"tts-1-hd",
|
|
525
|
+
"gpt-4o-mini-tts"
|
|
526
|
+
]
|
|
527
|
+
}
|
|
528
|
+
}
|
|
529
|
+
},
|
|
530
|
+
{
|
|
531
|
+
"name": "PlayHTVoice",
|
|
532
|
+
"required": [
|
|
533
|
+
"provider",
|
|
534
|
+
"voiceId"
|
|
535
|
+
],
|
|
536
|
+
"properties": {
|
|
537
|
+
"provider": {
|
|
538
|
+
"type": "string",
|
|
539
|
+
"description": "This is the voice provider that will be used.",
|
|
540
|
+
"enum": [
|
|
541
|
+
"playht"
|
|
542
|
+
]
|
|
543
|
+
},
|
|
544
|
+
"voiceId": {
|
|
545
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
546
|
+
"oneOf": [
|
|
547
|
+
{
|
|
548
|
+
"type": "string",
|
|
549
|
+
"enum": [
|
|
550
|
+
"jennifer",
|
|
551
|
+
"melissa",
|
|
552
|
+
"will",
|
|
553
|
+
"chris",
|
|
554
|
+
"matt",
|
|
555
|
+
"jack",
|
|
556
|
+
"ruby",
|
|
557
|
+
"davis",
|
|
558
|
+
"donna",
|
|
559
|
+
"michael"
|
|
560
|
+
],
|
|
561
|
+
"title": "Preset Voice Options"
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
"type": "string",
|
|
565
|
+
"title": "PlayHT Voice ID"
|
|
566
|
+
}
|
|
567
|
+
]
|
|
568
|
+
},
|
|
569
|
+
"model": {
|
|
570
|
+
"type": "string",
|
|
571
|
+
"description": "Playht voice model/engine to use.",
|
|
572
|
+
"enum": [
|
|
573
|
+
"PlayHT2.0",
|
|
574
|
+
"PlayHT2.0-turbo",
|
|
575
|
+
"Play3.0-mini",
|
|
576
|
+
"PlayDialog"
|
|
577
|
+
]
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
},
|
|
581
|
+
{
|
|
582
|
+
"name": "WellSaidVoice",
|
|
583
|
+
"required": [
|
|
584
|
+
"provider",
|
|
585
|
+
"voiceId"
|
|
586
|
+
],
|
|
587
|
+
"properties": {
|
|
588
|
+
"provider": {
|
|
589
|
+
"type": "string",
|
|
590
|
+
"description": "This is the voice provider that will be used.",
|
|
591
|
+
"enum": [
|
|
592
|
+
"wellsaid"
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
"voiceId": {
|
|
596
|
+
"type": "string",
|
|
597
|
+
"description": "The WellSaid speaker ID to synthesize."
|
|
598
|
+
},
|
|
599
|
+
"model": {
|
|
600
|
+
"type": "string",
|
|
601
|
+
"description": "This is the model that will be used.",
|
|
602
|
+
"enum": [
|
|
603
|
+
"caruso",
|
|
604
|
+
"legacy"
|
|
605
|
+
]
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"name": "RimeAIVoice",
|
|
611
|
+
"required": [
|
|
612
|
+
"provider",
|
|
613
|
+
"voiceId"
|
|
614
|
+
],
|
|
615
|
+
"properties": {
|
|
616
|
+
"provider": {
|
|
617
|
+
"type": "string",
|
|
618
|
+
"description": "This is the voice provider that will be used.",
|
|
619
|
+
"enum": [
|
|
620
|
+
"rime-ai"
|
|
621
|
+
]
|
|
622
|
+
},
|
|
623
|
+
"voiceId": {
|
|
624
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
625
|
+
"oneOf": [
|
|
626
|
+
{
|
|
627
|
+
"type": "string",
|
|
628
|
+
"enum": [
|
|
629
|
+
"cove",
|
|
630
|
+
"moon",
|
|
631
|
+
"wildflower",
|
|
632
|
+
"eva",
|
|
633
|
+
"amber",
|
|
634
|
+
"maya",
|
|
635
|
+
"lagoon",
|
|
636
|
+
"breeze",
|
|
637
|
+
"helen",
|
|
638
|
+
"joy",
|
|
639
|
+
"marsh",
|
|
640
|
+
"creek",
|
|
641
|
+
"cedar",
|
|
642
|
+
"alpine",
|
|
643
|
+
"summit",
|
|
644
|
+
"nicholas",
|
|
645
|
+
"tyler",
|
|
646
|
+
"colin",
|
|
647
|
+
"hank",
|
|
648
|
+
"thunder",
|
|
649
|
+
"astra",
|
|
650
|
+
"eucalyptus",
|
|
651
|
+
"moraine",
|
|
652
|
+
"peak",
|
|
653
|
+
"tundra",
|
|
654
|
+
"mesa_extra",
|
|
655
|
+
"talon",
|
|
656
|
+
"marlu",
|
|
657
|
+
"glacier",
|
|
658
|
+
"falcon",
|
|
659
|
+
"luna",
|
|
660
|
+
"celeste",
|
|
661
|
+
"estelle",
|
|
662
|
+
"andromeda",
|
|
663
|
+
"esther",
|
|
664
|
+
"lyra",
|
|
665
|
+
"lintel",
|
|
666
|
+
"oculus",
|
|
667
|
+
"vespera",
|
|
668
|
+
"transom",
|
|
669
|
+
"bond",
|
|
670
|
+
"arcade",
|
|
671
|
+
"atrium",
|
|
672
|
+
"cupola",
|
|
673
|
+
"fern",
|
|
674
|
+
"sirius",
|
|
675
|
+
"orion",
|
|
676
|
+
"masonry",
|
|
677
|
+
"albion",
|
|
678
|
+
"parapet",
|
|
679
|
+
"clementine",
|
|
680
|
+
"walnut",
|
|
681
|
+
"eyre",
|
|
682
|
+
"bancroft",
|
|
683
|
+
"hesse",
|
|
684
|
+
"beatty",
|
|
685
|
+
"godfrey"
|
|
686
|
+
],
|
|
687
|
+
"title": "Suggested Voice Options",
|
|
688
|
+
"description": "Popular Rime AI voices across mist, mistv2, mistv3, arcana, and coda models. Any valid Rime AI voice ID is accepted, not just these suggestions."
|
|
689
|
+
},
|
|
690
|
+
{
|
|
691
|
+
"type": "string",
|
|
692
|
+
"title": "Any Rime AI Voice ID",
|
|
693
|
+
"description": "Any valid Rime AI voice ID. See https://docs.rime.ai/docs/voices for the full catalog."
|
|
694
|
+
}
|
|
695
|
+
]
|
|
696
|
+
},
|
|
697
|
+
"model": {
|
|
698
|
+
"type": "string",
|
|
699
|
+
"description": "This is the model that will be used. Defaults to 'arcana' when not specified.",
|
|
700
|
+
"enum": [
|
|
701
|
+
"arcana",
|
|
702
|
+
"coda",
|
|
703
|
+
"mistv2",
|
|
704
|
+
"mistv3",
|
|
705
|
+
"mist"
|
|
706
|
+
],
|
|
707
|
+
"example": "arcana"
|
|
708
|
+
}
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
"name": "SmallestAIVoice",
|
|
713
|
+
"required": [
|
|
714
|
+
"provider",
|
|
715
|
+
"voiceId"
|
|
716
|
+
],
|
|
717
|
+
"properties": {
|
|
718
|
+
"provider": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"description": "This is the voice provider that will be used.",
|
|
721
|
+
"enum": [
|
|
722
|
+
"smallest-ai"
|
|
723
|
+
]
|
|
724
|
+
},
|
|
725
|
+
"voiceId": {
|
|
726
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
727
|
+
"oneOf": [
|
|
728
|
+
{
|
|
729
|
+
"type": "string",
|
|
730
|
+
"enum": [
|
|
731
|
+
"emily",
|
|
732
|
+
"jasmine",
|
|
733
|
+
"arman",
|
|
734
|
+
"james",
|
|
735
|
+
"mithali",
|
|
736
|
+
"aravind",
|
|
737
|
+
"raj",
|
|
738
|
+
"diya",
|
|
739
|
+
"raman",
|
|
740
|
+
"ananya",
|
|
741
|
+
"isha",
|
|
742
|
+
"william",
|
|
743
|
+
"aarav",
|
|
744
|
+
"monika",
|
|
745
|
+
"niharika",
|
|
746
|
+
"deepika",
|
|
747
|
+
"raghav",
|
|
748
|
+
"kajal",
|
|
749
|
+
"radhika",
|
|
750
|
+
"mansi",
|
|
751
|
+
"nisha",
|
|
752
|
+
"saurabh",
|
|
753
|
+
"pooja",
|
|
754
|
+
"saina",
|
|
755
|
+
"sanya"
|
|
756
|
+
],
|
|
757
|
+
"title": "Preset Voice Options"
|
|
758
|
+
},
|
|
759
|
+
{
|
|
760
|
+
"type": "string",
|
|
761
|
+
"title": "Smallest AI Voice ID"
|
|
762
|
+
}
|
|
763
|
+
]
|
|
764
|
+
},
|
|
765
|
+
"model": {
|
|
766
|
+
"type": "string",
|
|
767
|
+
"description": "Smallest AI voice model to use. Defaults to 'lightning' when not specified.",
|
|
768
|
+
"enum": [
|
|
769
|
+
"lightning"
|
|
770
|
+
]
|
|
771
|
+
}
|
|
772
|
+
}
|
|
773
|
+
},
|
|
774
|
+
{
|
|
775
|
+
"name": "VapiVoice",
|
|
776
|
+
"required": [
|
|
777
|
+
"provider",
|
|
778
|
+
"voiceId"
|
|
779
|
+
],
|
|
780
|
+
"properties": {
|
|
781
|
+
"provider": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"description": "This is the voice provider that will be used.",
|
|
784
|
+
"enum": [
|
|
785
|
+
"vapi"
|
|
786
|
+
]
|
|
787
|
+
},
|
|
788
|
+
"voiceId": {
|
|
789
|
+
"type": "string",
|
|
790
|
+
"description": "The voice to use: a built-in Vapi voice name, or a cloned voice id (used with version 2).",
|
|
791
|
+
"example": "Clara"
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
},
|
|
795
|
+
{
|
|
796
|
+
"name": "SesameVoice",
|
|
797
|
+
"required": [
|
|
798
|
+
"provider",
|
|
799
|
+
"voiceId",
|
|
800
|
+
"model"
|
|
801
|
+
],
|
|
802
|
+
"properties": {
|
|
803
|
+
"provider": {
|
|
804
|
+
"type": "string",
|
|
805
|
+
"description": "This is the voice provider that will be used.",
|
|
806
|
+
"enum": [
|
|
807
|
+
"sesame"
|
|
808
|
+
]
|
|
809
|
+
},
|
|
810
|
+
"voiceId": {
|
|
811
|
+
"type": "string",
|
|
812
|
+
"description": "This is the provider-specific ID that will be used.",
|
|
813
|
+
"title": "Sesame Voice ID. This should be either a name (a built-in voice) or a UUID (a custom voice)."
|
|
814
|
+
},
|
|
815
|
+
"model": {
|
|
816
|
+
"type": "string",
|
|
817
|
+
"description": "This is the model that will be used.",
|
|
818
|
+
"enum": [
|
|
819
|
+
"csm-1b"
|
|
820
|
+
]
|
|
821
|
+
}
|
|
822
|
+
}
|
|
823
|
+
},
|
|
824
|
+
{
|
|
825
|
+
"name": "InworldVoice",
|
|
826
|
+
"required": [
|
|
827
|
+
"provider",
|
|
828
|
+
"voiceId"
|
|
829
|
+
],
|
|
830
|
+
"properties": {
|
|
831
|
+
"provider": {
|
|
832
|
+
"type": "string",
|
|
833
|
+
"description": "This is the voice provider that will be used.",
|
|
834
|
+
"enum": [
|
|
835
|
+
"inworld"
|
|
836
|
+
]
|
|
837
|
+
},
|
|
838
|
+
"voiceId": {
|
|
839
|
+
"type": "string",
|
|
840
|
+
"description": "Available voices by language:\n• en: Alex, Ashley, Craig, Deborah, Dennis, Edward, Elizabeth, Hades, Julia, Pixie, Mark, Olivia, Priya, Ronald, Sarah, Shaun, Theodore, Timothy, Wendy, Dominus, Hana, Clive, Carter, Blake, Luna\n• zh: Yichen, Xiaoyin, Xinyi, Jing\n• nl: Erik, Katrien, Lennart, Lore\n• fr: Alain, Hélène, Mathieu, Étienne\n• de: Johanna, Josef\n• it: Gianni, Orietta\n• ja: Asuka, Satoshi\n• ko: Hyunwoo, Minji, Seojun, Yoona\n• pl: Szymon, Wojciech\n• pt: Heitor, Maitê\n• es: Diego, Lupita, Miguel, Rafael\n• ru: Svetlana, Elena, Dmitry, Nikolai\n• hi: Riya, Manoj\n• he: Yael, Oren\n• ar: Nour, Omar",
|
|
841
|
+
"maxLength": 120,
|
|
842
|
+
"title": "Inworld Voice ID",
|
|
843
|
+
"enum": [
|
|
844
|
+
"Alex",
|
|
845
|
+
"Ashley",
|
|
846
|
+
"Craig",
|
|
847
|
+
"Deborah",
|
|
848
|
+
"Dennis",
|
|
849
|
+
"Edward",
|
|
850
|
+
"Elizabeth",
|
|
851
|
+
"Hades",
|
|
852
|
+
"Julia",
|
|
853
|
+
"Pixie",
|
|
854
|
+
"Mark",
|
|
855
|
+
"Olivia",
|
|
856
|
+
"Priya",
|
|
857
|
+
"Ronald",
|
|
858
|
+
"Sarah",
|
|
859
|
+
"Shaun",
|
|
860
|
+
"Theodore",
|
|
861
|
+
"Timothy",
|
|
862
|
+
"Wendy",
|
|
863
|
+
"Dominus",
|
|
864
|
+
"Hana",
|
|
865
|
+
"Clive",
|
|
866
|
+
"Carter",
|
|
867
|
+
"Blake",
|
|
868
|
+
"Luna",
|
|
869
|
+
"Yichen",
|
|
870
|
+
"Xiaoyin",
|
|
871
|
+
"Xinyi",
|
|
872
|
+
"Jing",
|
|
873
|
+
"Erik",
|
|
874
|
+
"Katrien",
|
|
875
|
+
"Lennart",
|
|
876
|
+
"Lore",
|
|
877
|
+
"Alain",
|
|
878
|
+
"Hélène",
|
|
879
|
+
"Mathieu",
|
|
880
|
+
"Étienne",
|
|
881
|
+
"Johanna",
|
|
882
|
+
"Josef",
|
|
883
|
+
"Gianni",
|
|
884
|
+
"Orietta",
|
|
885
|
+
"Asuka",
|
|
886
|
+
"Satoshi",
|
|
887
|
+
"Hyunwoo",
|
|
888
|
+
"Minji",
|
|
889
|
+
"Seojun",
|
|
890
|
+
"Yoona",
|
|
891
|
+
"Szymon",
|
|
892
|
+
"Wojciech",
|
|
893
|
+
"Heitor",
|
|
894
|
+
"Maitê",
|
|
895
|
+
"Diego",
|
|
896
|
+
"Lupita",
|
|
897
|
+
"Miguel",
|
|
898
|
+
"Rafael",
|
|
899
|
+
"Svetlana",
|
|
900
|
+
"Elena",
|
|
901
|
+
"Dmitry",
|
|
902
|
+
"Nikolai",
|
|
903
|
+
"Riya",
|
|
904
|
+
"Manoj",
|
|
905
|
+
"Yael",
|
|
906
|
+
"Oren",
|
|
907
|
+
"Nour",
|
|
908
|
+
"Omar"
|
|
909
|
+
],
|
|
910
|
+
"example": "Alex"
|
|
911
|
+
},
|
|
912
|
+
"model": {
|
|
913
|
+
"type": "string",
|
|
914
|
+
"description": "This is the model that will be used.",
|
|
915
|
+
"enum": [
|
|
916
|
+
"inworld-tts-1"
|
|
917
|
+
],
|
|
918
|
+
"default": "inworld-tts-1"
|
|
919
|
+
}
|
|
920
|
+
}
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
"name": "MinimaxVoice",
|
|
924
|
+
"required": [
|
|
925
|
+
"provider",
|
|
926
|
+
"voiceId"
|
|
927
|
+
],
|
|
928
|
+
"properties": {
|
|
929
|
+
"provider": {
|
|
930
|
+
"type": "string",
|
|
931
|
+
"description": "This is the voice provider that will be used.",
|
|
932
|
+
"enum": [
|
|
933
|
+
"minimax"
|
|
934
|
+
]
|
|
935
|
+
},
|
|
936
|
+
"voiceId": {
|
|
937
|
+
"type": "string",
|
|
938
|
+
"description": "This is the provider-specific ID that will be used. Use a voice from MINIMAX_PREDEFINED_VOICES or a custom cloned voice ID.",
|
|
939
|
+
"title": "This is the Minimax Voice ID"
|
|
940
|
+
},
|
|
941
|
+
"model": {
|
|
942
|
+
"type": "string",
|
|
943
|
+
"description": "This is the model that will be used. Options are 'speech-02-hd' and 'speech-02-turbo'.\nspeech-02-hd is optimized for high-fidelity applications like voiceovers and audiobooks.\nspeech-02-turbo is designed for real-time applications with low latency.\n\n@default \"speech-02-turbo\"",
|
|
944
|
+
"enum": [
|
|
945
|
+
"speech-02-hd",
|
|
946
|
+
"speech-02-turbo",
|
|
947
|
+
"speech-2.5-turbo-preview"
|
|
948
|
+
],
|
|
949
|
+
"example": "speech-02-turbo",
|
|
950
|
+
"default": "speech-02-turbo"
|
|
951
|
+
}
|
|
952
|
+
}
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
"name": "XaiVoice",
|
|
956
|
+
"required": [
|
|
957
|
+
"provider",
|
|
958
|
+
"voiceId"
|
|
959
|
+
],
|
|
960
|
+
"properties": {
|
|
961
|
+
"provider": {
|
|
962
|
+
"type": "string",
|
|
963
|
+
"description": "This is the voice provider that will be used.",
|
|
964
|
+
"enum": [
|
|
965
|
+
"xai"
|
|
966
|
+
]
|
|
967
|
+
},
|
|
968
|
+
"voiceId": {
|
|
969
|
+
"type": "string",
|
|
970
|
+
"description": "Built-in voices: eve, ara, rex, sal, leo. Cloned voice IDs are also accepted.",
|
|
971
|
+
"maxLength": 120,
|
|
972
|
+
"title": "xAI Voice ID",
|
|
973
|
+
"enum": [
|
|
974
|
+
"eve",
|
|
975
|
+
"ara",
|
|
976
|
+
"rex",
|
|
977
|
+
"sal",
|
|
978
|
+
"leo"
|
|
979
|
+
],
|
|
980
|
+
"example": "eve"
|
|
981
|
+
}
|
|
982
|
+
}
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"name": "MicrosoftVoice",
|
|
986
|
+
"required": [
|
|
987
|
+
"provider",
|
|
988
|
+
"voiceId"
|
|
989
|
+
],
|
|
990
|
+
"properties": {
|
|
991
|
+
"provider": {
|
|
992
|
+
"type": "string",
|
|
993
|
+
"description": "This is the voice provider that will be used.",
|
|
994
|
+
"enum": [
|
|
995
|
+
"microsoft"
|
|
996
|
+
]
|
|
997
|
+
},
|
|
998
|
+
"voiceId": {
|
|
999
|
+
"type": "string",
|
|
1000
|
+
"description": "MAI-Voice-2 voice ID. Built-in voices listed in enum.",
|
|
1001
|
+
"enum": [
|
|
1002
|
+
"de-DE-Klaus:MAI-Voice-2",
|
|
1003
|
+
"de-DE-Mia:MAI-Voice-2",
|
|
1004
|
+
"en-AU-Lisa:MAI-Voice-2",
|
|
1005
|
+
"en-US-Ethan:MAI-Voice-2",
|
|
1006
|
+
"en-US-Grant:MAI-Voice-2",
|
|
1007
|
+
"en-US-Harper:MAI-Voice-2",
|
|
1008
|
+
"en-US-Iris:MAI-Voice-2",
|
|
1009
|
+
"en-US-Jasper:MAI-Voice-2",
|
|
1010
|
+
"en-US-Olivia:MAI-Voice-2",
|
|
1011
|
+
"es-ES-Marta:MAI-Voice-2",
|
|
1012
|
+
"es-MX-Alejo:MAI-Voice-2",
|
|
1013
|
+
"es-MX-Valeria:MAI-Voice-2",
|
|
1014
|
+
"fr-FR-Marc:MAI-Voice-2",
|
|
1015
|
+
"fr-FR-Soleil:MAI-Voice-2",
|
|
1016
|
+
"hi-IN-Arjun:MAI-Voice-2",
|
|
1017
|
+
"hi-IN-Dhruv:MAI-Voice-2",
|
|
1018
|
+
"hi-IN-Kavya:MAI-Voice-2",
|
|
1019
|
+
"hi-IN-Priya:MAI-Voice-2",
|
|
1020
|
+
"hu-HU-Bence:MAI-Voice-2",
|
|
1021
|
+
"hu-HU-Levente:MAI-Voice-2",
|
|
1022
|
+
"hu-HU-Lilla:MAI-Voice-2",
|
|
1023
|
+
"hu-HU-Réka:MAI-Voice-2",
|
|
1024
|
+
"it-IT-Luca:MAI-Voice-2",
|
|
1025
|
+
"it-IT-Rosa:MAI-Voice-2",
|
|
1026
|
+
"ko-KR-Hana:MAI-Voice-2",
|
|
1027
|
+
"ko-KR-Junho:MAI-Voice-2",
|
|
1028
|
+
"nl-NL-Fleur:MAI-Voice-2",
|
|
1029
|
+
"nl-NL-Sander:MAI-Voice-2",
|
|
1030
|
+
"pt-BR-Caio:MAI-Voice-2",
|
|
1031
|
+
"pt-BR-Luana:MAI-Voice-2",
|
|
1032
|
+
"pt-BR-Pedro:MAI-Voice-2",
|
|
1033
|
+
"pt-BR-Rafael:MAI-Voice-2",
|
|
1034
|
+
"pt-PT-Rui:MAI-Voice-2",
|
|
1035
|
+
"ro-RO-Andrei:MAI-Voice-2",
|
|
1036
|
+
"ro-RO-Elena:MAI-Voice-2",
|
|
1037
|
+
"ro-RO-Ioana:MAI-Voice-2",
|
|
1038
|
+
"ro-RO-Radu:MAI-Voice-2",
|
|
1039
|
+
"ru-RU-Lev:MAI-Voice-2",
|
|
1040
|
+
"ru-RU-Masha:MAI-Voice-2",
|
|
1041
|
+
"th-TH-Krit:MAI-Voice-2",
|
|
1042
|
+
"th-TH-Nattapong:MAI-Voice-2",
|
|
1043
|
+
"tr-TR-Aydin:MAI-Voice-2",
|
|
1044
|
+
"tr-TR-Elif:MAI-Voice-2",
|
|
1045
|
+
"zh-CN-Bo:MAI-Voice-2",
|
|
1046
|
+
"zh-CN-Lan:MAI-Voice-2",
|
|
1047
|
+
"zh-CN-Mei:MAI-Voice-2"
|
|
1048
|
+
],
|
|
1049
|
+
"example": "en-US-Ethan:MAI-Voice-2"
|
|
1050
|
+
}
|
|
1051
|
+
}
|
|
1052
|
+
}
|
|
1053
|
+
],
|
|
1054
|
+
"transcriber": [
|
|
1055
|
+
{
|
|
1056
|
+
"name": "AssemblyAITranscriber",
|
|
1057
|
+
"required": [
|
|
1058
|
+
"provider"
|
|
1059
|
+
],
|
|
1060
|
+
"properties": {
|
|
1061
|
+
"provider": {
|
|
1062
|
+
"type": "string",
|
|
1063
|
+
"description": "This is the transcription provider that will be used.",
|
|
1064
|
+
"enum": [
|
|
1065
|
+
"assembly-ai"
|
|
1066
|
+
]
|
|
1067
|
+
}
|
|
1068
|
+
}
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"name": "AzureSpeechTranscriber",
|
|
1072
|
+
"required": [
|
|
1073
|
+
"provider"
|
|
1074
|
+
],
|
|
1075
|
+
"properties": {
|
|
1076
|
+
"provider": {
|
|
1077
|
+
"type": "string",
|
|
1078
|
+
"description": "This is the transcription provider that will be used.",
|
|
1079
|
+
"enum": [
|
|
1080
|
+
"azure"
|
|
1081
|
+
]
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
"name": "CustomTranscriber",
|
|
1087
|
+
"required": [
|
|
1088
|
+
"provider",
|
|
1089
|
+
"server"
|
|
1090
|
+
],
|
|
1091
|
+
"properties": {
|
|
1092
|
+
"provider": {
|
|
1093
|
+
"type": "string",
|
|
1094
|
+
"description": "This is the transcription provider that will be used. Use `custom-transcriber` for providers that are not natively supported.",
|
|
1095
|
+
"enum": [
|
|
1096
|
+
"custom-transcriber"
|
|
1097
|
+
]
|
|
1098
|
+
}
|
|
1099
|
+
}
|
|
1100
|
+
},
|
|
1101
|
+
{
|
|
1102
|
+
"name": "DeepgramTranscriber",
|
|
1103
|
+
"required": [
|
|
1104
|
+
"provider"
|
|
1105
|
+
],
|
|
1106
|
+
"properties": {
|
|
1107
|
+
"provider": {
|
|
1108
|
+
"type": "string",
|
|
1109
|
+
"description": "This is the transcription provider that will be used.",
|
|
1110
|
+
"enum": [
|
|
1111
|
+
"deepgram"
|
|
1112
|
+
]
|
|
1113
|
+
},
|
|
1114
|
+
"model": {
|
|
1115
|
+
"description": "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",
|
|
1116
|
+
"oneOf": [
|
|
1117
|
+
{
|
|
1118
|
+
"type": "string",
|
|
1119
|
+
"enum": [
|
|
1120
|
+
"nova-3",
|
|
1121
|
+
"nova-3-general",
|
|
1122
|
+
"nova-3-medical",
|
|
1123
|
+
"nova-3-pharma",
|
|
1124
|
+
"nova-2",
|
|
1125
|
+
"nova-2-general",
|
|
1126
|
+
"nova-2-meeting",
|
|
1127
|
+
"nova-2-phonecall",
|
|
1128
|
+
"nova-2-finance",
|
|
1129
|
+
"nova-2-conversationalai",
|
|
1130
|
+
"nova-2-voicemail",
|
|
1131
|
+
"nova-2-video",
|
|
1132
|
+
"nova-2-medical",
|
|
1133
|
+
"nova-2-drivethru",
|
|
1134
|
+
"nova-2-automotive",
|
|
1135
|
+
"nova",
|
|
1136
|
+
"nova-general",
|
|
1137
|
+
"nova-phonecall",
|
|
1138
|
+
"nova-medical",
|
|
1139
|
+
"enhanced",
|
|
1140
|
+
"enhanced-general",
|
|
1141
|
+
"enhanced-meeting",
|
|
1142
|
+
"enhanced-phonecall",
|
|
1143
|
+
"enhanced-finance",
|
|
1144
|
+
"base",
|
|
1145
|
+
"base-general",
|
|
1146
|
+
"base-meeting",
|
|
1147
|
+
"base-phonecall",
|
|
1148
|
+
"base-finance",
|
|
1149
|
+
"base-conversationalai",
|
|
1150
|
+
"base-voicemail",
|
|
1151
|
+
"base-video",
|
|
1152
|
+
"whisper",
|
|
1153
|
+
"flux-general-en",
|
|
1154
|
+
"flux-general-multi"
|
|
1155
|
+
]
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"type": "string"
|
|
1159
|
+
}
|
|
1160
|
+
]
|
|
1161
|
+
}
|
|
1162
|
+
}
|
|
1163
|
+
},
|
|
1164
|
+
{
|
|
1165
|
+
"name": "ElevenLabsTranscriber",
|
|
1166
|
+
"required": [
|
|
1167
|
+
"provider"
|
|
1168
|
+
],
|
|
1169
|
+
"properties": {
|
|
1170
|
+
"provider": {
|
|
1171
|
+
"type": "string",
|
|
1172
|
+
"description": "This is the transcription provider that will be used.",
|
|
1173
|
+
"enum": [
|
|
1174
|
+
"11labs"
|
|
1175
|
+
]
|
|
1176
|
+
},
|
|
1177
|
+
"model": {
|
|
1178
|
+
"description": "This is the model that will be used for the transcription.",
|
|
1179
|
+
"oneOf": [
|
|
1180
|
+
{
|
|
1181
|
+
"type": "string",
|
|
1182
|
+
"enum": [
|
|
1183
|
+
"scribe_v1",
|
|
1184
|
+
"scribe_v2",
|
|
1185
|
+
"scribe_v2_realtime"
|
|
1186
|
+
]
|
|
1187
|
+
}
|
|
1188
|
+
]
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
{
|
|
1193
|
+
"name": "GladiaTranscriber",
|
|
1194
|
+
"required": [
|
|
1195
|
+
"provider"
|
|
1196
|
+
],
|
|
1197
|
+
"properties": {
|
|
1198
|
+
"provider": {
|
|
1199
|
+
"type": "string",
|
|
1200
|
+
"description": "This is the transcription provider that will be used.",
|
|
1201
|
+
"enum": [
|
|
1202
|
+
"gladia"
|
|
1203
|
+
]
|
|
1204
|
+
},
|
|
1205
|
+
"model": {
|
|
1206
|
+
"description": "This is the Gladia model that will be used. Default is 'fast'",
|
|
1207
|
+
"oneOf": [
|
|
1208
|
+
{
|
|
1209
|
+
"type": "string",
|
|
1210
|
+
"enum": [
|
|
1211
|
+
"fast",
|
|
1212
|
+
"accurate",
|
|
1213
|
+
"solaria-1"
|
|
1214
|
+
]
|
|
1215
|
+
}
|
|
1216
|
+
]
|
|
1217
|
+
}
|
|
1218
|
+
}
|
|
1219
|
+
},
|
|
1220
|
+
{
|
|
1221
|
+
"name": "GoogleTranscriber",
|
|
1222
|
+
"required": [
|
|
1223
|
+
"provider"
|
|
1224
|
+
],
|
|
1225
|
+
"properties": {
|
|
1226
|
+
"provider": {
|
|
1227
|
+
"type": "string",
|
|
1228
|
+
"description": "This is the transcription provider that will be used.",
|
|
1229
|
+
"enum": [
|
|
1230
|
+
"google"
|
|
1231
|
+
]
|
|
1232
|
+
},
|
|
1233
|
+
"model": {
|
|
1234
|
+
"type": "string",
|
|
1235
|
+
"description": "This is the model that will be used for the transcription.",
|
|
1236
|
+
"enum": [
|
|
1237
|
+
"gemini-3.8-flash",
|
|
1238
|
+
"gemini-3.5-flash",
|
|
1239
|
+
"gemini-3.1-flash-lite",
|
|
1240
|
+
"gemini-3-flash-preview",
|
|
1241
|
+
"gemini-2.5-pro",
|
|
1242
|
+
"gemini-2.5-flash",
|
|
1243
|
+
"gemini-2.5-flash-lite",
|
|
1244
|
+
"gemini-2.0-flash-thinking-exp",
|
|
1245
|
+
"gemini-2.0-pro-exp-02-05",
|
|
1246
|
+
"gemini-2.0-flash",
|
|
1247
|
+
"gemini-2.0-flash-lite",
|
|
1248
|
+
"gemini-2.0-flash-exp",
|
|
1249
|
+
"gemini-2.0-flash-realtime-exp",
|
|
1250
|
+
"gemini-1.5-flash",
|
|
1251
|
+
"gemini-1.5-flash-002",
|
|
1252
|
+
"gemini-1.5-pro",
|
|
1253
|
+
"gemini-1.5-pro-002",
|
|
1254
|
+
"gemini-1.0-pro"
|
|
1255
|
+
]
|
|
1256
|
+
}
|
|
1257
|
+
}
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
"name": "SpeechmaticsTranscriber",
|
|
1261
|
+
"required": [
|
|
1262
|
+
"provider",
|
|
1263
|
+
"customVocabulary"
|
|
1264
|
+
],
|
|
1265
|
+
"properties": {
|
|
1266
|
+
"provider": {
|
|
1267
|
+
"type": "string",
|
|
1268
|
+
"description": "This is the transcription provider that will be used.",
|
|
1269
|
+
"enum": [
|
|
1270
|
+
"speechmatics"
|
|
1271
|
+
]
|
|
1272
|
+
},
|
|
1273
|
+
"model": {
|
|
1274
|
+
"type": "string",
|
|
1275
|
+
"description": "This is the model that will be used for the transcription.",
|
|
1276
|
+
"enum": [
|
|
1277
|
+
"default"
|
|
1278
|
+
]
|
|
1279
|
+
}
|
|
1280
|
+
}
|
|
1281
|
+
},
|
|
1282
|
+
{
|
|
1283
|
+
"name": "TalkscriberTranscriber",
|
|
1284
|
+
"required": [
|
|
1285
|
+
"provider"
|
|
1286
|
+
],
|
|
1287
|
+
"properties": {
|
|
1288
|
+
"provider": {
|
|
1289
|
+
"type": "string",
|
|
1290
|
+
"description": "This is the transcription provider that will be used.",
|
|
1291
|
+
"enum": [
|
|
1292
|
+
"talkscriber"
|
|
1293
|
+
]
|
|
1294
|
+
},
|
|
1295
|
+
"model": {
|
|
1296
|
+
"type": "string",
|
|
1297
|
+
"description": "This is the model that will be used for the transcription.",
|
|
1298
|
+
"enum": [
|
|
1299
|
+
"whisper"
|
|
1300
|
+
]
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
"name": "OpenAITranscriber",
|
|
1306
|
+
"required": [
|
|
1307
|
+
"provider",
|
|
1308
|
+
"model"
|
|
1309
|
+
],
|
|
1310
|
+
"properties": {
|
|
1311
|
+
"provider": {
|
|
1312
|
+
"type": "string",
|
|
1313
|
+
"description": "This is the transcription provider that will be used.",
|
|
1314
|
+
"enum": [
|
|
1315
|
+
"openai"
|
|
1316
|
+
]
|
|
1317
|
+
},
|
|
1318
|
+
"model": {
|
|
1319
|
+
"type": "string",
|
|
1320
|
+
"description": "This is the model that will be used for the transcription.\nDigit formatting can differ by model: `gpt-transcribe` may write spoken digit strings as words (for example, \"four seven two\"), where `gpt-4o-transcribe` and `gpt-4o-mini-transcribe` may write them as digits (\"472\"). Do not rely on either format.",
|
|
1321
|
+
"enum": [
|
|
1322
|
+
"gpt-4o-transcribe",
|
|
1323
|
+
"gpt-4o-mini-transcribe",
|
|
1324
|
+
"gpt-transcribe"
|
|
1325
|
+
]
|
|
1326
|
+
}
|
|
1327
|
+
}
|
|
1328
|
+
},
|
|
1329
|
+
{
|
|
1330
|
+
"name": "CartesiaTranscriber",
|
|
1331
|
+
"required": [
|
|
1332
|
+
"provider"
|
|
1333
|
+
],
|
|
1334
|
+
"properties": {
|
|
1335
|
+
"provider": {
|
|
1336
|
+
"type": "string",
|
|
1337
|
+
"enum": [
|
|
1338
|
+
"cartesia"
|
|
1339
|
+
]
|
|
1340
|
+
},
|
|
1341
|
+
"model": {
|
|
1342
|
+
"type": "string",
|
|
1343
|
+
"enum": [
|
|
1344
|
+
"ink-whisper",
|
|
1345
|
+
"ink-2"
|
|
1346
|
+
]
|
|
1347
|
+
}
|
|
1348
|
+
}
|
|
1349
|
+
},
|
|
1350
|
+
{
|
|
1351
|
+
"name": "SonioxTranscriber",
|
|
1352
|
+
"required": [
|
|
1353
|
+
"provider"
|
|
1354
|
+
],
|
|
1355
|
+
"properties": {
|
|
1356
|
+
"provider": {
|
|
1357
|
+
"type": "string",
|
|
1358
|
+
"enum": [
|
|
1359
|
+
"soniox"
|
|
1360
|
+
]
|
|
1361
|
+
},
|
|
1362
|
+
"model": {
|
|
1363
|
+
"type": "string",
|
|
1364
|
+
"enum": [
|
|
1365
|
+
"stt-rt-v4",
|
|
1366
|
+
"stt-rt-v5"
|
|
1367
|
+
],
|
|
1368
|
+
"description": "The Soniox model to use for transcription."
|
|
1369
|
+
}
|
|
1370
|
+
}
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"name": "XaiTranscriber",
|
|
1374
|
+
"required": [
|
|
1375
|
+
"provider"
|
|
1376
|
+
],
|
|
1377
|
+
"properties": {
|
|
1378
|
+
"provider": {
|
|
1379
|
+
"type": "string",
|
|
1380
|
+
"enum": [
|
|
1381
|
+
"xai"
|
|
1382
|
+
]
|
|
1383
|
+
},
|
|
1384
|
+
"model": {
|
|
1385
|
+
"type": "string",
|
|
1386
|
+
"description": "The xAI speech-to-text model to use. xAI currently exposes a single STT model — placeholder for future model selection.",
|
|
1387
|
+
"enum": [
|
|
1388
|
+
"default"
|
|
1389
|
+
]
|
|
1390
|
+
}
|
|
1391
|
+
}
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"name": "Reson8Transcriber",
|
|
1395
|
+
"required": [
|
|
1396
|
+
"provider"
|
|
1397
|
+
],
|
|
1398
|
+
"properties": {
|
|
1399
|
+
"provider": {
|
|
1400
|
+
"type": "string",
|
|
1401
|
+
"enum": [
|
|
1402
|
+
"reson8"
|
|
1403
|
+
]
|
|
1404
|
+
},
|
|
1405
|
+
"model": {
|
|
1406
|
+
"type": "string",
|
|
1407
|
+
"description": "The Reson8 speech-to-text endpoint to use. `turns` is Reson8's turn-detection endpoint.",
|
|
1408
|
+
"enum": [
|
|
1409
|
+
"turns"
|
|
1410
|
+
]
|
|
1411
|
+
}
|
|
1412
|
+
}
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
"name": "VapiTranscriber",
|
|
1416
|
+
"required": [
|
|
1417
|
+
"provider"
|
|
1418
|
+
],
|
|
1419
|
+
"properties": {
|
|
1420
|
+
"provider": {
|
|
1421
|
+
"type": "string",
|
|
1422
|
+
"enum": [
|
|
1423
|
+
"vapi"
|
|
1424
|
+
]
|
|
1425
|
+
}
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1428
|
+
],
|
|
1429
|
+
"llm": [
|
|
1430
|
+
{
|
|
1431
|
+
"name": "AnthropicModel",
|
|
1432
|
+
"required": [
|
|
1433
|
+
"model",
|
|
1434
|
+
"provider"
|
|
1435
|
+
],
|
|
1436
|
+
"properties": {
|
|
1437
|
+
"provider": {
|
|
1438
|
+
"type": "string",
|
|
1439
|
+
"description": "The provider identifier for Anthropic.",
|
|
1440
|
+
"enum": [
|
|
1441
|
+
"anthropic"
|
|
1442
|
+
]
|
|
1443
|
+
},
|
|
1444
|
+
"model": {
|
|
1445
|
+
"type": "string",
|
|
1446
|
+
"description": "The specific Anthropic/Claude model that will be used.",
|
|
1447
|
+
"enum": [
|
|
1448
|
+
"claude-3-opus-20240229",
|
|
1449
|
+
"claude-3-sonnet-20240229",
|
|
1450
|
+
"claude-3-haiku-20240307",
|
|
1451
|
+
"claude-3-5-sonnet-20240620",
|
|
1452
|
+
"claude-3-5-sonnet-20241022",
|
|
1453
|
+
"claude-3-5-haiku-20241022",
|
|
1454
|
+
"claude-3-7-sonnet-20250219",
|
|
1455
|
+
"claude-opus-4-20250514",
|
|
1456
|
+
"claude-opus-4-5-20251101",
|
|
1457
|
+
"claude-opus-4-6",
|
|
1458
|
+
"claude-sonnet-4-20250514",
|
|
1459
|
+
"claude-sonnet-4-5-20250929",
|
|
1460
|
+
"claude-sonnet-4-6",
|
|
1461
|
+
"claude-sonnet-5",
|
|
1462
|
+
"claude-haiku-4-5-20251001",
|
|
1463
|
+
"claude-haiku-5-5"
|
|
1464
|
+
]
|
|
1465
|
+
}
|
|
1466
|
+
}
|
|
1467
|
+
},
|
|
1468
|
+
{
|
|
1469
|
+
"name": "AnthropicBedrockModel",
|
|
1470
|
+
"required": [
|
|
1471
|
+
"provider",
|
|
1472
|
+
"model"
|
|
1473
|
+
],
|
|
1474
|
+
"properties": {
|
|
1475
|
+
"provider": {
|
|
1476
|
+
"type": "string",
|
|
1477
|
+
"description": "The provider identifier for Anthropic via AWS Bedrock.",
|
|
1478
|
+
"enum": [
|
|
1479
|
+
"anthropic-bedrock"
|
|
1480
|
+
]
|
|
1481
|
+
},
|
|
1482
|
+
"model": {
|
|
1483
|
+
"type": "string",
|
|
1484
|
+
"description": "The specific Anthropic/Claude model that will be used via Bedrock.",
|
|
1485
|
+
"enum": [
|
|
1486
|
+
"claude-3-opus-20240229",
|
|
1487
|
+
"claude-3-sonnet-20240229",
|
|
1488
|
+
"claude-3-haiku-20240307",
|
|
1489
|
+
"claude-3-5-sonnet-20240620",
|
|
1490
|
+
"claude-3-5-sonnet-20241022",
|
|
1491
|
+
"claude-3-5-haiku-20241022",
|
|
1492
|
+
"claude-3-7-sonnet-20250219",
|
|
1493
|
+
"claude-opus-4-20250514",
|
|
1494
|
+
"claude-opus-4-5-20251101",
|
|
1495
|
+
"claude-opus-4-6",
|
|
1496
|
+
"claude-sonnet-4-20250514",
|
|
1497
|
+
"claude-sonnet-4-5-20250929",
|
|
1498
|
+
"claude-sonnet-4-6",
|
|
1499
|
+
"claude-haiku-4-5-20251001",
|
|
1500
|
+
"claude-haiku-5-5",
|
|
1501
|
+
"global.anthropic.claude-haiku-4-5-20251001-v1:0"
|
|
1502
|
+
]
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
},
|
|
1506
|
+
{
|
|
1507
|
+
"name": "AnyscaleModel",
|
|
1508
|
+
"required": [
|
|
1509
|
+
"provider",
|
|
1510
|
+
"model"
|
|
1511
|
+
],
|
|
1512
|
+
"properties": {
|
|
1513
|
+
"provider": {
|
|
1514
|
+
"type": "string",
|
|
1515
|
+
"enum": [
|
|
1516
|
+
"anyscale"
|
|
1517
|
+
]
|
|
1518
|
+
},
|
|
1519
|
+
"model": {
|
|
1520
|
+
"type": "string",
|
|
1521
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1522
|
+
}
|
|
1523
|
+
}
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "CerebrasModel",
|
|
1527
|
+
"required": [
|
|
1528
|
+
"model",
|
|
1529
|
+
"provider"
|
|
1530
|
+
],
|
|
1531
|
+
"properties": {
|
|
1532
|
+
"provider": {
|
|
1533
|
+
"type": "string",
|
|
1534
|
+
"enum": [
|
|
1535
|
+
"cerebras"
|
|
1536
|
+
]
|
|
1537
|
+
},
|
|
1538
|
+
"model": {
|
|
1539
|
+
"type": "string",
|
|
1540
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1541
|
+
"enum": [
|
|
1542
|
+
"llama3.1-8b",
|
|
1543
|
+
"llama-3.3-70b"
|
|
1544
|
+
]
|
|
1545
|
+
}
|
|
1546
|
+
}
|
|
1547
|
+
},
|
|
1548
|
+
{
|
|
1549
|
+
"name": "CustomLLMModel",
|
|
1550
|
+
"required": [
|
|
1551
|
+
"provider",
|
|
1552
|
+
"url",
|
|
1553
|
+
"model"
|
|
1554
|
+
],
|
|
1555
|
+
"properties": {
|
|
1556
|
+
"provider": {
|
|
1557
|
+
"type": "string",
|
|
1558
|
+
"description": "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.",
|
|
1559
|
+
"enum": [
|
|
1560
|
+
"custom-llm"
|
|
1561
|
+
]
|
|
1562
|
+
},
|
|
1563
|
+
"model": {
|
|
1564
|
+
"type": "string",
|
|
1565
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1566
|
+
}
|
|
1567
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
{
|
|
1570
|
+
"name": "DeepInfraModel",
|
|
1571
|
+
"required": [
|
|
1572
|
+
"provider",
|
|
1573
|
+
"model"
|
|
1574
|
+
],
|
|
1575
|
+
"properties": {
|
|
1576
|
+
"provider": {
|
|
1577
|
+
"type": "string",
|
|
1578
|
+
"enum": [
|
|
1579
|
+
"deepinfra"
|
|
1580
|
+
]
|
|
1581
|
+
},
|
|
1582
|
+
"model": {
|
|
1583
|
+
"type": "string",
|
|
1584
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1585
|
+
}
|
|
1586
|
+
}
|
|
1587
|
+
},
|
|
1588
|
+
{
|
|
1589
|
+
"name": "DeepSeekModel",
|
|
1590
|
+
"required": [
|
|
1591
|
+
"model",
|
|
1592
|
+
"provider"
|
|
1593
|
+
],
|
|
1594
|
+
"properties": {
|
|
1595
|
+
"provider": {
|
|
1596
|
+
"type": "string",
|
|
1597
|
+
"enum": [
|
|
1598
|
+
"deep-seek"
|
|
1599
|
+
]
|
|
1600
|
+
},
|
|
1601
|
+
"model": {
|
|
1602
|
+
"type": "string",
|
|
1603
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1604
|
+
"enum": [
|
|
1605
|
+
"deepseek-chat",
|
|
1606
|
+
"deepseek-reasoner",
|
|
1607
|
+
"deepseek-flash",
|
|
1608
|
+
"deepseek-flash-thinking"
|
|
1609
|
+
]
|
|
1610
|
+
}
|
|
1611
|
+
}
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "GoogleModel",
|
|
1615
|
+
"required": [
|
|
1616
|
+
"model",
|
|
1617
|
+
"provider"
|
|
1618
|
+
],
|
|
1619
|
+
"properties": {
|
|
1620
|
+
"provider": {
|
|
1621
|
+
"type": "string",
|
|
1622
|
+
"enum": [
|
|
1623
|
+
"google"
|
|
1624
|
+
]
|
|
1625
|
+
},
|
|
1626
|
+
"model": {
|
|
1627
|
+
"type": "string",
|
|
1628
|
+
"description": "This is the Google model that will be used.",
|
|
1629
|
+
"enum": [
|
|
1630
|
+
"gemini-3.8-flash",
|
|
1631
|
+
"gemini-3.5-flash",
|
|
1632
|
+
"gemini-3.1-flash-lite",
|
|
1633
|
+
"gemini-3-flash-preview",
|
|
1634
|
+
"gemini-2.5-pro",
|
|
1635
|
+
"gemini-2.5-flash",
|
|
1636
|
+
"gemini-2.5-flash-lite",
|
|
1637
|
+
"gemini-2.0-flash-thinking-exp",
|
|
1638
|
+
"gemini-2.0-pro-exp-02-05",
|
|
1639
|
+
"gemini-2.0-flash",
|
|
1640
|
+
"gemini-2.0-flash-lite",
|
|
1641
|
+
"gemini-2.0-flash-exp",
|
|
1642
|
+
"gemini-2.0-flash-realtime-exp",
|
|
1643
|
+
"gemini-1.5-flash",
|
|
1644
|
+
"gemini-1.5-flash-002",
|
|
1645
|
+
"gemini-1.5-pro",
|
|
1646
|
+
"gemini-1.5-pro-002",
|
|
1647
|
+
"gemini-1.0-pro"
|
|
1648
|
+
]
|
|
1649
|
+
}
|
|
1650
|
+
}
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "GroqModel",
|
|
1654
|
+
"required": [
|
|
1655
|
+
"model",
|
|
1656
|
+
"provider"
|
|
1657
|
+
],
|
|
1658
|
+
"properties": {
|
|
1659
|
+
"provider": {
|
|
1660
|
+
"type": "string",
|
|
1661
|
+
"enum": [
|
|
1662
|
+
"groq"
|
|
1663
|
+
]
|
|
1664
|
+
},
|
|
1665
|
+
"model": {
|
|
1666
|
+
"type": "string",
|
|
1667
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1668
|
+
"enum": [
|
|
1669
|
+
"openai/gpt-oss-20b",
|
|
1670
|
+
"openai/gpt-oss-120b",
|
|
1671
|
+
"deepseek-r1-distill-llama-70b",
|
|
1672
|
+
"llama-3.3-70b-versatile",
|
|
1673
|
+
"llama-3.1-405b-reasoning",
|
|
1674
|
+
"llama-3.1-8b-instant",
|
|
1675
|
+
"llama3-8b-8192",
|
|
1676
|
+
"llama3-70b-8192",
|
|
1677
|
+
"gemma2-9b-it",
|
|
1678
|
+
"moonshotai/kimi-k2-instruct-0905",
|
|
1679
|
+
"meta-llama/llama-4-scout-17b-16e-instruct",
|
|
1680
|
+
"mistral-saba-24b",
|
|
1681
|
+
"compound-beta",
|
|
1682
|
+
"compound-beta-mini"
|
|
1683
|
+
]
|
|
1684
|
+
}
|
|
1685
|
+
}
|
|
1686
|
+
},
|
|
1687
|
+
{
|
|
1688
|
+
"name": "InflectionAIModel",
|
|
1689
|
+
"required": [
|
|
1690
|
+
"model",
|
|
1691
|
+
"provider"
|
|
1692
|
+
],
|
|
1693
|
+
"properties": {
|
|
1694
|
+
"provider": {
|
|
1695
|
+
"type": "string",
|
|
1696
|
+
"enum": [
|
|
1697
|
+
"inflection-ai"
|
|
1698
|
+
]
|
|
1699
|
+
},
|
|
1700
|
+
"model": {
|
|
1701
|
+
"type": "string",
|
|
1702
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1703
|
+
"enum": [
|
|
1704
|
+
"inflection_3_pi"
|
|
1705
|
+
]
|
|
1706
|
+
}
|
|
1707
|
+
}
|
|
1708
|
+
},
|
|
1709
|
+
{
|
|
1710
|
+
"name": "MinimaxLLMModel",
|
|
1711
|
+
"required": [
|
|
1712
|
+
"provider",
|
|
1713
|
+
"model"
|
|
1714
|
+
],
|
|
1715
|
+
"properties": {
|
|
1716
|
+
"provider": {
|
|
1717
|
+
"type": "string",
|
|
1718
|
+
"enum": [
|
|
1719
|
+
"minimax"
|
|
1720
|
+
]
|
|
1721
|
+
},
|
|
1722
|
+
"model": {
|
|
1723
|
+
"type": "string",
|
|
1724
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1725
|
+
"enum": [
|
|
1726
|
+
"MiniMax-M2.7"
|
|
1727
|
+
]
|
|
1728
|
+
}
|
|
1729
|
+
}
|
|
1730
|
+
},
|
|
1731
|
+
{
|
|
1732
|
+
"name": "OpenAIModel",
|
|
1733
|
+
"required": [
|
|
1734
|
+
"provider",
|
|
1735
|
+
"model"
|
|
1736
|
+
],
|
|
1737
|
+
"properties": {
|
|
1738
|
+
"provider": {
|
|
1739
|
+
"type": "string",
|
|
1740
|
+
"description": "This is the provider that will be used for the model.",
|
|
1741
|
+
"enum": [
|
|
1742
|
+
"openai"
|
|
1743
|
+
]
|
|
1744
|
+
},
|
|
1745
|
+
"model": {
|
|
1746
|
+
"type": "string",
|
|
1747
|
+
"description": "This is the OpenAI model that will be used.\nFor GPT-Live configuration and supported settings, see https://docs.vapi.ai/gpt-live/overview.\n\nWhen using Vapi OpenAI or your own Azure Credentials, you have the option to specify the region for the selected model. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest region that make sense.\nThis is helpful when you are required to comply with Data Residency rules. Learn more about Azure regions here https://azure.microsoft.com/en-us/explore/global-infrastructure/data-residency/.\n\n@default undefined",
|
|
1748
|
+
"enum": [
|
|
1749
|
+
"gpt-6-luna",
|
|
1750
|
+
"gpt-5.6-sol",
|
|
1751
|
+
"gpt-5.6-terra",
|
|
1752
|
+
"gpt-5.6-luna",
|
|
1753
|
+
"gpt-5.5",
|
|
1754
|
+
"chat-latest",
|
|
1755
|
+
"gpt-5.4",
|
|
1756
|
+
"gpt-5.4-mini",
|
|
1757
|
+
"gpt-5.4-nano",
|
|
1758
|
+
"gpt-5.2",
|
|
1759
|
+
"gpt-5.2-chat-latest",
|
|
1760
|
+
"gpt-5.1",
|
|
1761
|
+
"gpt-5.1-chat-latest",
|
|
1762
|
+
"gpt-5",
|
|
1763
|
+
"gpt-5-chat-latest",
|
|
1764
|
+
"gpt-5-mini",
|
|
1765
|
+
"gpt-5-nano",
|
|
1766
|
+
"gpt-4.1-2025-04-14",
|
|
1767
|
+
"gpt-4.1-mini-2025-04-14",
|
|
1768
|
+
"gpt-4.1-nano-2025-04-14",
|
|
1769
|
+
"gpt-4.1",
|
|
1770
|
+
"gpt-4.1-mini",
|
|
1771
|
+
"gpt-4.1-nano",
|
|
1772
|
+
"chatgpt-4o-latest",
|
|
1773
|
+
"o3",
|
|
1774
|
+
"o3-mini",
|
|
1775
|
+
"o4-mini",
|
|
1776
|
+
"o1-mini",
|
|
1777
|
+
"o1-mini-2024-09-12",
|
|
1778
|
+
"gpt-4o-realtime-preview-2024-10-01",
|
|
1779
|
+
"gpt-4o-realtime-preview-2024-12-17",
|
|
1780
|
+
"gpt-4o-mini-realtime-preview-2024-12-17",
|
|
1781
|
+
"gpt-realtime-2025-08-28",
|
|
1782
|
+
"gpt-realtime-mini-2025-12-15",
|
|
1783
|
+
"gpt-realtime-2",
|
|
1784
|
+
"gpt-4o-mini-2024-07-18",
|
|
1785
|
+
"gpt-4o-mini",
|
|
1786
|
+
"gpt-4o",
|
|
1787
|
+
"gpt-4o-2024-05-13",
|
|
1788
|
+
"gpt-4o-2024-08-06",
|
|
1789
|
+
"gpt-4o-2024-11-20",
|
|
1790
|
+
"gpt-4-turbo",
|
|
1791
|
+
"gpt-4-turbo-2024-04-09",
|
|
1792
|
+
"gpt-4-turbo-preview",
|
|
1793
|
+
"gpt-4-0125-preview",
|
|
1794
|
+
"gpt-4-1106-preview",
|
|
1795
|
+
"gpt-4",
|
|
1796
|
+
"gpt-4-0613",
|
|
1797
|
+
"gpt-3.5-turbo",
|
|
1798
|
+
"gpt-3.5-turbo-0125",
|
|
1799
|
+
"gpt-3.5-turbo-1106",
|
|
1800
|
+
"gpt-3.5-turbo-16k",
|
|
1801
|
+
"gpt-3.5-turbo-0613",
|
|
1802
|
+
"gpt-5.6-luna:westus3",
|
|
1803
|
+
"gpt-5.6-terra:westus3",
|
|
1804
|
+
"gpt-5.6-sol:westus3",
|
|
1805
|
+
"gpt-5.4:eastus2",
|
|
1806
|
+
"gpt-5.4:swedencentral",
|
|
1807
|
+
"gpt-5.4-mini:eastus2",
|
|
1808
|
+
"gpt-5.4-mini:swedencentral",
|
|
1809
|
+
"gpt-5.4-nano:eastus2",
|
|
1810
|
+
"gpt-5.4-nano:swedencentral",
|
|
1811
|
+
"gpt-5.2:eastus2",
|
|
1812
|
+
"gpt-5.2:swedencentral",
|
|
1813
|
+
"gpt-5.1:eastus2",
|
|
1814
|
+
"gpt-5.1:swedencentral",
|
|
1815
|
+
"gpt-5:eastus2",
|
|
1816
|
+
"gpt-5:swedencentral",
|
|
1817
|
+
"gpt-5:canadaeast",
|
|
1818
|
+
"gpt-5:eastus",
|
|
1819
|
+
"gpt-5:westeurope",
|
|
1820
|
+
"gpt-5:germanywestcentral",
|
|
1821
|
+
"gpt-5:polandcentral",
|
|
1822
|
+
"gpt-5:spaincentral",
|
|
1823
|
+
"gpt-5-mini:eastus2",
|
|
1824
|
+
"gpt-5-mini:swedencentral",
|
|
1825
|
+
"gpt-5-mini:westeurope",
|
|
1826
|
+
"gpt-5-mini:germanywestcentral",
|
|
1827
|
+
"gpt-5-mini:polandcentral",
|
|
1828
|
+
"gpt-5-mini:spaincentral",
|
|
1829
|
+
"gpt-5-nano:eastus2",
|
|
1830
|
+
"gpt-5-nano:swedencentral",
|
|
1831
|
+
"gpt-4.1-2025-04-14:westus",
|
|
1832
|
+
"gpt-4.1-2025-04-14:eastus2",
|
|
1833
|
+
"gpt-4.1-2025-04-14:eastus",
|
|
1834
|
+
"gpt-4.1-2025-04-14:westus3",
|
|
1835
|
+
"gpt-4.1-2025-04-14:northcentralus",
|
|
1836
|
+
"gpt-4.1-2025-04-14:southcentralus",
|
|
1837
|
+
"gpt-4.1-2025-04-14:westeurope",
|
|
1838
|
+
"gpt-4.1-2025-04-14:germanywestcentral",
|
|
1839
|
+
"gpt-4.1-2025-04-14:polandcentral",
|
|
1840
|
+
"gpt-4.1-2025-04-14:spaincentral",
|
|
1841
|
+
"gpt-4.1-mini-2025-04-14:westus",
|
|
1842
|
+
"gpt-4.1-mini-2025-04-14:eastus2",
|
|
1843
|
+
"gpt-4.1-mini-2025-04-14:eastus",
|
|
1844
|
+
"gpt-4.1-mini-2025-04-14:westus3",
|
|
1845
|
+
"gpt-4.1-mini-2025-04-14:northcentralus",
|
|
1846
|
+
"gpt-4.1-mini-2025-04-14:southcentralus",
|
|
1847
|
+
"gpt-4.1-mini-2025-04-14:westeurope",
|
|
1848
|
+
"gpt-4.1-mini-2025-04-14:germanywestcentral",
|
|
1849
|
+
"gpt-4.1-mini-2025-04-14:polandcentral",
|
|
1850
|
+
"gpt-4.1-mini-2025-04-14:spaincentral",
|
|
1851
|
+
"gpt-4.1-nano-2025-04-14:westus",
|
|
1852
|
+
"gpt-4.1-nano-2025-04-14:eastus2",
|
|
1853
|
+
"gpt-4.1-nano-2025-04-14:westus3",
|
|
1854
|
+
"gpt-4.1-nano-2025-04-14:northcentralus",
|
|
1855
|
+
"gpt-4.1-nano-2025-04-14:southcentralus",
|
|
1856
|
+
"gpt-4o-2024-11-20:swedencentral",
|
|
1857
|
+
"gpt-4o-2024-11-20:westus",
|
|
1858
|
+
"gpt-4o-2024-11-20:eastus2",
|
|
1859
|
+
"gpt-4o-2024-11-20:eastus",
|
|
1860
|
+
"gpt-4o-2024-11-20:westus3",
|
|
1861
|
+
"gpt-4o-2024-11-20:southcentralus",
|
|
1862
|
+
"gpt-4o-2024-11-20:westeurope",
|
|
1863
|
+
"gpt-4o-2024-11-20:germanywestcentral",
|
|
1864
|
+
"gpt-4o-2024-11-20:polandcentral",
|
|
1865
|
+
"gpt-4o-2024-11-20:spaincentral",
|
|
1866
|
+
"gpt-4o-2024-08-06:westus",
|
|
1867
|
+
"gpt-4o-2024-08-06:westus3",
|
|
1868
|
+
"gpt-4o-2024-08-06:eastus",
|
|
1869
|
+
"gpt-4o-2024-08-06:eastus2",
|
|
1870
|
+
"gpt-4o-2024-08-06:northcentralus",
|
|
1871
|
+
"gpt-4o-2024-08-06:southcentralus",
|
|
1872
|
+
"gpt-4o-mini-2024-07-18:westus",
|
|
1873
|
+
"gpt-4o-mini-2024-07-18:westus3",
|
|
1874
|
+
"gpt-4o-mini-2024-07-18:eastus",
|
|
1875
|
+
"gpt-4o-mini-2024-07-18:eastus2",
|
|
1876
|
+
"gpt-4o-mini-2024-07-18:northcentralus",
|
|
1877
|
+
"gpt-4o-mini-2024-07-18:southcentralus",
|
|
1878
|
+
"gpt-4o-2024-05-13:eastus2",
|
|
1879
|
+
"gpt-4o-2024-05-13:eastus",
|
|
1880
|
+
"gpt-4o-2024-05-13:northcentralus",
|
|
1881
|
+
"gpt-4o-2024-05-13:southcentralus",
|
|
1882
|
+
"gpt-4o-2024-05-13:westus3",
|
|
1883
|
+
"gpt-4o-2024-05-13:westus",
|
|
1884
|
+
"gpt-4-turbo-2024-04-09:eastus2",
|
|
1885
|
+
"gpt-4-0125-preview:eastus",
|
|
1886
|
+
"gpt-4-0125-preview:northcentralus",
|
|
1887
|
+
"gpt-4-0125-preview:southcentralus",
|
|
1888
|
+
"gpt-4-1106-preview:australiaeast",
|
|
1889
|
+
"gpt-4-1106-preview:canadaeast",
|
|
1890
|
+
"gpt-4-1106-preview:france",
|
|
1891
|
+
"gpt-4-1106-preview:india",
|
|
1892
|
+
"gpt-4-1106-preview:norway",
|
|
1893
|
+
"gpt-4-1106-preview:swedencentral",
|
|
1894
|
+
"gpt-4-1106-preview:uk",
|
|
1895
|
+
"gpt-4-1106-preview:westus",
|
|
1896
|
+
"gpt-4-1106-preview:westus3",
|
|
1897
|
+
"gpt-4-0613:canadaeast",
|
|
1898
|
+
"gpt-3.5-turbo-0125:canadaeast",
|
|
1899
|
+
"gpt-3.5-turbo-0125:northcentralus",
|
|
1900
|
+
"gpt-3.5-turbo-0125:southcentralus",
|
|
1901
|
+
"gpt-3.5-turbo-1106:canadaeast",
|
|
1902
|
+
"gpt-3.5-turbo-1106:westus",
|
|
1903
|
+
"gpt-4.1:australiaeast",
|
|
1904
|
+
"gpt-4o:australiaeast",
|
|
1905
|
+
"gpt-5.4-mini:australiaeast",
|
|
1906
|
+
"gpt-live-1"
|
|
1907
|
+
]
|
|
1908
|
+
}
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
{
|
|
1912
|
+
"name": "OpenRouterModel",
|
|
1913
|
+
"required": [
|
|
1914
|
+
"provider",
|
|
1915
|
+
"model"
|
|
1916
|
+
],
|
|
1917
|
+
"properties": {
|
|
1918
|
+
"provider": {
|
|
1919
|
+
"type": "string",
|
|
1920
|
+
"enum": [
|
|
1921
|
+
"openrouter"
|
|
1922
|
+
]
|
|
1923
|
+
},
|
|
1924
|
+
"model": {
|
|
1925
|
+
"type": "string",
|
|
1926
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1927
|
+
}
|
|
1928
|
+
}
|
|
1929
|
+
},
|
|
1930
|
+
{
|
|
1931
|
+
"name": "PerplexityAIModel",
|
|
1932
|
+
"required": [
|
|
1933
|
+
"provider",
|
|
1934
|
+
"model"
|
|
1935
|
+
],
|
|
1936
|
+
"properties": {
|
|
1937
|
+
"provider": {
|
|
1938
|
+
"type": "string",
|
|
1939
|
+
"enum": [
|
|
1940
|
+
"perplexity-ai"
|
|
1941
|
+
]
|
|
1942
|
+
},
|
|
1943
|
+
"model": {
|
|
1944
|
+
"type": "string",
|
|
1945
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1946
|
+
}
|
|
1947
|
+
}
|
|
1948
|
+
},
|
|
1949
|
+
{
|
|
1950
|
+
"name": "TogetherAIModel",
|
|
1951
|
+
"required": [
|
|
1952
|
+
"provider",
|
|
1953
|
+
"model"
|
|
1954
|
+
],
|
|
1955
|
+
"properties": {
|
|
1956
|
+
"provider": {
|
|
1957
|
+
"type": "string",
|
|
1958
|
+
"enum": [
|
|
1959
|
+
"together-ai"
|
|
1960
|
+
]
|
|
1961
|
+
},
|
|
1962
|
+
"model": {
|
|
1963
|
+
"type": "string",
|
|
1964
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b"
|
|
1965
|
+
}
|
|
1966
|
+
}
|
|
1967
|
+
},
|
|
1968
|
+
{
|
|
1969
|
+
"name": "XaiModel",
|
|
1970
|
+
"required": [
|
|
1971
|
+
"model",
|
|
1972
|
+
"provider"
|
|
1973
|
+
],
|
|
1974
|
+
"properties": {
|
|
1975
|
+
"provider": {
|
|
1976
|
+
"type": "string",
|
|
1977
|
+
"enum": [
|
|
1978
|
+
"xai"
|
|
1979
|
+
]
|
|
1980
|
+
},
|
|
1981
|
+
"model": {
|
|
1982
|
+
"type": "string",
|
|
1983
|
+
"description": "This is the name of the model. Ex. cognitivecomputations/dolphin-mixtral-8x7b",
|
|
1984
|
+
"enum": [
|
|
1985
|
+
"grok-beta",
|
|
1986
|
+
"grok-2",
|
|
1987
|
+
"grok-3",
|
|
1988
|
+
"grok-4-fast-reasoning",
|
|
1989
|
+
"grok-4-fast-non-reasoning",
|
|
1990
|
+
"grok-4.20-0309-reasoning",
|
|
1991
|
+
"grok-4.20-0309-non-reasoning",
|
|
1992
|
+
"grok-4.3"
|
|
1993
|
+
]
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
},
|
|
1997
|
+
{
|
|
1998
|
+
"name": "VapiModel",
|
|
1999
|
+
"required": [
|
|
2000
|
+
"provider"
|
|
2001
|
+
],
|
|
2002
|
+
"properties": {
|
|
2003
|
+
"provider": {
|
|
2004
|
+
"type": "string",
|
|
2005
|
+
"enum": [
|
|
2006
|
+
"vapi"
|
|
2007
|
+
]
|
|
2008
|
+
},
|
|
2009
|
+
"model": {
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"description": "White-label Vapi models are selected by `version`, not a model name, so\n`model` is optional here (the runtime already accepts a version-only Vapi\npayload). Overriding the required `ModelBase.model`: the declared type stays\n`string` to match the base (avoids TS2416) and the `= undefined!` initializer\nsatisfies TS2612 for the field override, while `@IsOptional` +\n`@ApiPropertyOptional` make validation and the generated OpenAPI schema treat\nit as optional (so `VapiModel.required` is `['provider']`)."
|
|
2012
|
+
}
|
|
2013
|
+
}
|
|
2014
|
+
}
|
|
2015
|
+
],
|
|
2016
|
+
"fields": {
|
|
2017
|
+
"firstMessage": {
|
|
2018
|
+
"type": "string",
|
|
2019
|
+
"description": "This is the first message that the assistant will say. This can also be a URL to a containerized audio file (mp3, wav, etc.).\n\nIf unspecified, assistant will wait for user to speak and use the model to respond once they speak.",
|
|
2020
|
+
"example": "Hello! How can I help you today?"
|
|
2021
|
+
},
|
|
2022
|
+
"firstMessageMode": {
|
|
2023
|
+
"type": "string",
|
|
2024
|
+
"description": "This is the mode for the first message. Default is 'assistant-speaks-first'.\n\nUse:\n- 'assistant-speaks-first' to have the assistant speak first.\n- 'assistant-waits-for-user' to have the assistant wait for the user to speak first.\n- 'assistant-speaks-first-with-model-generated-message' to have the assistant speak first with a message generated by the model based on the conversation state. (`assistant.model.messages` at call start, `call.messages` at squad transfer points).\n\n@default 'assistant-speaks-first'",
|
|
2025
|
+
"enum": [
|
|
2026
|
+
"assistant-speaks-first",
|
|
2027
|
+
"assistant-speaks-first-with-model-generated-message",
|
|
2028
|
+
"assistant-waits-for-user"
|
|
2029
|
+
],
|
|
2030
|
+
"example": "assistant-speaks-first"
|
|
2031
|
+
},
|
|
2032
|
+
"toolIds": {
|
|
2033
|
+
"description": "These are the tools that the assistant can use during the call. To use transient tools, use `tools`.\n\nBoth `tools` and `toolIds` can be used together.",
|
|
2034
|
+
"type": "array",
|
|
2035
|
+
"items": {
|
|
2036
|
+
"type": "string"
|
|
2037
|
+
}
|
|
2038
|
+
},
|
|
2039
|
+
"instructions": {
|
|
2040
|
+
"type": "string",
|
|
2041
|
+
"nullable": true,
|
|
2042
|
+
"maxLength": 100000000
|
|
2043
|
+
},
|
|
2044
|
+
"callAssistantId": {
|
|
2045
|
+
"type": "string",
|
|
2046
|
+
"description": "This is the assistant ID that will be used for the call. To use a transient assistant, use `assistant` instead.\n\nTo start a call with:\n- Assistant, use `assistantId` or `assistant`\n- Squad, use `squadId` or `squad`\n- Workflow, use `workflowId` or `workflow`"
|
|
2047
|
+
},
|
|
2048
|
+
"callPhoneNumberId": {
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"description": "This is the phone number that will be used for the call. To use a transient number, use `phoneNumber` instead.\n\nOnly relevant for `outboundPhoneCall` and `inboundPhoneCall` type."
|
|
2051
|
+
},
|
|
2052
|
+
"customerNumber": {
|
|
2053
|
+
"type": "string",
|
|
2054
|
+
"description": "This is the number of the customer.",
|
|
2055
|
+
"minLength": 3,
|
|
2056
|
+
"maxLength": 40
|
|
2057
|
+
},
|
|
2058
|
+
"scheduledAt": {
|
|
2059
|
+
"format": "date-time",
|
|
2060
|
+
"type": "string",
|
|
2061
|
+
"description": "This is the ISO 8601 date-time string of the earliest time the call can be scheduled."
|
|
2062
|
+
},
|
|
2063
|
+
"variableValues": {
|
|
2064
|
+
"type": "object",
|
|
2065
|
+
"description": "These are values that will be used to replace the template variables in the assistant messages and other text-based fields.\nThis uses LiquidJS syntax. https://liquidjs.com/tutorials/intro-to-liquid.html\n\nSo for example, `{{ name }}` will be replaced with the value of `name` in `variableValues`.\n`{{\"now\" | date: \"%b %d, %Y, %I:%M %p\", \"America/New_York\"}}` will be replaced with the current date and time in New York.\n Some VAPI reserved defaults:\n - *customer* - the customer object"
|
|
2066
|
+
},
|
|
2067
|
+
"functionName": {
|
|
2068
|
+
"type": "string",
|
|
2069
|
+
"description": "This is the the name of the function to be called.\n\nMust be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.",
|
|
2070
|
+
"maxLength": 64,
|
|
2071
|
+
"pattern": "/^[a-zA-Z0-9_-]{1,64}$/"
|
|
2072
|
+
},
|
|
2073
|
+
"functionDescription": {
|
|
2074
|
+
"type": "string",
|
|
2075
|
+
"description": "This is the description of what the function does, used by the AI to choose when and how to call the function."
|
|
2076
|
+
},
|
|
2077
|
+
"functionParameters": {
|
|
2078
|
+
"description": "These are the parameters the functions accepts, described as a JSON Schema object.\n\nSee the [OpenAI guide](https://platform.openai.com/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema) for documentation about the format.\n\nOmitting parameters defines a function with an empty parameter list.",
|
|
2079
|
+
"allOf": [
|
|
2080
|
+
{
|
|
2081
|
+
"$ref": "#/components/schemas/OpenAIFunctionParameters"
|
|
2082
|
+
}
|
|
2083
|
+
]
|
|
2084
|
+
},
|
|
2085
|
+
"serverUrl": {
|
|
2086
|
+
"type": "string",
|
|
2087
|
+
"description": "This is where the request will be sent."
|
|
2088
|
+
},
|
|
2089
|
+
"serverHeaders": {
|
|
2090
|
+
"type": "object",
|
|
2091
|
+
"description": "These are the headers to include in the request.\n\nEach key-value pair represents a header name and its value.\n\nNote: Specifying an Authorization header here will override the authorization provided by the `credentialId` (if provided). This is an anti-pattern and should be avoided outside of edge case scenarios."
|
|
2092
|
+
},
|
|
2093
|
+
"apiUrl": {
|
|
2094
|
+
"type": "string",
|
|
2095
|
+
"description": "This is where the request will be sent."
|
|
2096
|
+
},
|
|
2097
|
+
"apiMethod": {
|
|
2098
|
+
"type": "string",
|
|
2099
|
+
"enum": [
|
|
2100
|
+
"POST",
|
|
2101
|
+
"GET",
|
|
2102
|
+
"PUT",
|
|
2103
|
+
"PATCH",
|
|
2104
|
+
"DELETE"
|
|
2105
|
+
]
|
|
2106
|
+
},
|
|
2107
|
+
"apiBody": {
|
|
2108
|
+
"description": "This is the body of the request.",
|
|
2109
|
+
"allOf": [
|
|
2110
|
+
{
|
|
2111
|
+
"$ref": "#/components/schemas/JsonSchema"
|
|
2112
|
+
}
|
|
2113
|
+
]
|
|
2114
|
+
},
|
|
2115
|
+
"apiTimeout": {
|
|
2116
|
+
"type": "number",
|
|
2117
|
+
"description": "This is the timeout in seconds for the request. Defaults to 20 seconds.\n\n@default 20",
|
|
2118
|
+
"minimum": 1,
|
|
2119
|
+
"maximum": 300,
|
|
2120
|
+
"example": 20
|
|
2121
|
+
},
|
|
2122
|
+
"backoffType": {
|
|
2123
|
+
"type": "object",
|
|
2124
|
+
"description": "This is the type of backoff plan to use. Defaults to fixed.\n\n@default fixed",
|
|
2125
|
+
"enum": [
|
|
2126
|
+
"fixed",
|
|
2127
|
+
"exponential"
|
|
2128
|
+
],
|
|
2129
|
+
"example": "fixed"
|
|
2130
|
+
},
|
|
2131
|
+
"backoffMaxRetries": {
|
|
2132
|
+
"type": "number",
|
|
2133
|
+
"description": "This is the maximum number of retries to attempt if the request fails. Defaults to 0 (no retries).\n\n@default 0",
|
|
2134
|
+
"minimum": 0,
|
|
2135
|
+
"maximum": 10,
|
|
2136
|
+
"example": 0
|
|
2137
|
+
},
|
|
2138
|
+
"backoffDelay": {
|
|
2139
|
+
"type": "number",
|
|
2140
|
+
"description": "This is the base delay in seconds. For linear backoff, this is the delay between each retry. For exponential backoff, this is the initial delay.",
|
|
2141
|
+
"minimum": 0,
|
|
2142
|
+
"maximum": 10,
|
|
2143
|
+
"example": 1
|
|
2144
|
+
},
|
|
2145
|
+
"transferDestination": {
|
|
2146
|
+
"type": "object",
|
|
2147
|
+
"required": [
|
|
2148
|
+
"type",
|
|
2149
|
+
"number"
|
|
2150
|
+
],
|
|
2151
|
+
"properties": {
|
|
2152
|
+
"type": {
|
|
2153
|
+
"type": "string",
|
|
2154
|
+
"enum": [
|
|
2155
|
+
"number"
|
|
2156
|
+
]
|
|
2157
|
+
},
|
|
2158
|
+
"number": {
|
|
2159
|
+
"type": "string",
|
|
2160
|
+
"description": "This is the phone number to transfer the call to.",
|
|
2161
|
+
"minLength": 3,
|
|
2162
|
+
"maxLength": 40
|
|
2163
|
+
},
|
|
2164
|
+
"extension": {
|
|
2165
|
+
"type": "string",
|
|
2166
|
+
"description": "This is the extension to dial after transferring the call to the `number`.",
|
|
2167
|
+
"minLength": 1,
|
|
2168
|
+
"maxLength": 10
|
|
2169
|
+
},
|
|
2170
|
+
"callerId": {
|
|
2171
|
+
"type": "string",
|
|
2172
|
+
"description": "This is the caller ID to use when transferring the call to the `number`.\n\nUsage:\n- If not provided, the caller ID will be the number the call is coming **from**.\n Example: a customer with number +14151111111 calls in to and the assistant transfers out to +16470000000. +16470000000 will see +14151111111 as the caller.\n For inbound calls, the caller ID is the customer's number. For outbound calls, the caller ID is the phone number of the assistant.\n- To change this behavior, provide a `callerId`.\n- Set to '{{customer.number}}' to always use the customer's number as the caller ID.\n- Set to '{{phoneNumber.number}}' to always use the phone number of the assistant as the caller ID.\n- Set to any E164 number to always use that number as the caller ID. This needs to be a number that is owned or verified by your Transport provider like Twilio.\n\nNote: on Twilio, a caller who withheld their number has no caller ID the destination carrier will accept, so the assistant's phone number is presented instead and the transfer goes through. This applies when `callerId` is not provided and when it is set to '{{customer.number}}'.\n\nFor Twilio, you can read up more here: https://www.twilio.com/docs/voice/twiml/dial#callerid",
|
|
2173
|
+
"maxLength": 40
|
|
2174
|
+
},
|
|
2175
|
+
"description": {
|
|
2176
|
+
"type": "string",
|
|
2177
|
+
"description": "This is the description of the destination, used by the AI to choose when and how to transfer the call."
|
|
2178
|
+
}
|
|
2179
|
+
}
|
|
2180
|
+
},
|
|
2181
|
+
"toolType": {
|
|
2182
|
+
"oneOf": [
|
|
2183
|
+
{
|
|
2184
|
+
"type": "string",
|
|
2185
|
+
"enum": [
|
|
2186
|
+
"sms"
|
|
2187
|
+
],
|
|
2188
|
+
"description": "The type of tool. \"sms\" for Twilio SMS sending tool."
|
|
2189
|
+
},
|
|
2190
|
+
{
|
|
2191
|
+
"type": "string",
|
|
2192
|
+
"enum": [
|
|
2193
|
+
"transferCall"
|
|
2194
|
+
]
|
|
2195
|
+
},
|
|
2196
|
+
{
|
|
2197
|
+
"type": "string",
|
|
2198
|
+
"enum": [
|
|
2199
|
+
"function"
|
|
2200
|
+
],
|
|
2201
|
+
"description": "The type of tool. \"function\" for Function tool."
|
|
2202
|
+
},
|
|
2203
|
+
{
|
|
2204
|
+
"type": "string",
|
|
2205
|
+
"enum": [
|
|
2206
|
+
"apiRequest"
|
|
2207
|
+
],
|
|
2208
|
+
"description": "The type of tool. \"apiRequest\" for API request tool."
|
|
2209
|
+
}
|
|
2210
|
+
]
|
|
2211
|
+
},
|
|
2212
|
+
"assistantId": {
|
|
2213
|
+
"format": "uuid",
|
|
2214
|
+
"type": "string"
|
|
2215
|
+
},
|
|
2216
|
+
"callId": {
|
|
2217
|
+
"format": "uuid",
|
|
2218
|
+
"type": "string"
|
|
2219
|
+
},
|
|
2220
|
+
"phoneNumberId": {
|
|
2221
|
+
"format": "uuid",
|
|
2222
|
+
"type": "string"
|
|
2223
|
+
},
|
|
2224
|
+
"toolId": {
|
|
2225
|
+
"format": "uuid",
|
|
2226
|
+
"type": "string"
|
|
2227
|
+
}
|
|
2228
|
+
},
|
|
2229
|
+
"definitions": {
|
|
2230
|
+
"OpenAIFunctionParameters": {
|
|
2231
|
+
"type": "object",
|
|
2232
|
+
"properties": {
|
|
2233
|
+
"type": {
|
|
2234
|
+
"type": "string",
|
|
2235
|
+
"description": "This must be set to 'object'. It instructs the model to return a JSON object containing the function call properties.",
|
|
2236
|
+
"enum": [
|
|
2237
|
+
"object"
|
|
2238
|
+
]
|
|
2239
|
+
},
|
|
2240
|
+
"properties": {
|
|
2241
|
+
"type": "object",
|
|
2242
|
+
"description": "This provides a description of the properties required by the function.\nJSON Schema can be used to specify expectations for each property.\nRefer to [this doc](https://ajv.js.org/json-schema.html#json-data-type) for a comprehensive guide on JSON Schema.",
|
|
2243
|
+
"additionalProperties": {
|
|
2244
|
+
"$ref": "#/components/schemas/JsonSchema"
|
|
2245
|
+
}
|
|
2246
|
+
},
|
|
2247
|
+
"required": {
|
|
2248
|
+
"description": "This specifies the properties that are required by the function.",
|
|
2249
|
+
"type": "array",
|
|
2250
|
+
"items": {
|
|
2251
|
+
"type": "string"
|
|
2252
|
+
}
|
|
2253
|
+
}
|
|
2254
|
+
},
|
|
2255
|
+
"required": [
|
|
2256
|
+
"type",
|
|
2257
|
+
"properties"
|
|
2258
|
+
]
|
|
2259
|
+
},
|
|
2260
|
+
"JsonSchema": {
|
|
2261
|
+
"type": "object",
|
|
2262
|
+
"properties": {
|
|
2263
|
+
"type": {
|
|
2264
|
+
"type": "string",
|
|
2265
|
+
"description": "This is the type of output you'd like.\n\n`string`, `number`, `integer`, `boolean` are the primitive types and should be obvious.\n\n`array` and `object` are more interesting and quite powerful. They allow you to define nested structures.\n\nFor `array`, you can define the schema of the items in the array using the `items` property.\n\nFor `object`, you can define the properties of the object using the `properties` property.",
|
|
2266
|
+
"enum": [
|
|
2267
|
+
"string",
|
|
2268
|
+
"number",
|
|
2269
|
+
"integer",
|
|
2270
|
+
"boolean",
|
|
2271
|
+
"array",
|
|
2272
|
+
"object"
|
|
2273
|
+
]
|
|
2274
|
+
},
|
|
2275
|
+
"items": {
|
|
2276
|
+
"description": "This is required if the type is \"array\". This is the schema of the items in the array. This is a recursive reference to JsonSchema.",
|
|
2277
|
+
"allOf": [
|
|
2278
|
+
{
|
|
2279
|
+
"$ref": "#/components/schemas/JsonSchema"
|
|
2280
|
+
}
|
|
2281
|
+
]
|
|
2282
|
+
},
|
|
2283
|
+
"properties": {
|
|
2284
|
+
"type": "object",
|
|
2285
|
+
"description": "This is required if the type is \"object\". This specifies the properties of the object. This is a map of property names to JsonSchema objects.",
|
|
2286
|
+
"additionalProperties": {
|
|
2287
|
+
"$ref": "#/components/schemas/JsonSchema"
|
|
2288
|
+
}
|
|
2289
|
+
},
|
|
2290
|
+
"description": {
|
|
2291
|
+
"type": "string",
|
|
2292
|
+
"description": "This is the description to help the model understand what it needs to output."
|
|
2293
|
+
},
|
|
2294
|
+
"pattern": {
|
|
2295
|
+
"type": "string",
|
|
2296
|
+
"description": "This is the pattern of the string. This is a regex that will be used to validate the data in question. To use a common format, use the `format` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs#supported-properties"
|
|
2297
|
+
},
|
|
2298
|
+
"format": {
|
|
2299
|
+
"type": "string",
|
|
2300
|
+
"description": "This is the format of the string. To pass a regex, use the `pattern` property instead.\n\nOpenAI documentation: https://platform.openai.com/docs/guides/structured-outputs?api-mode=chat&type-restrictions=string-restrictions",
|
|
2301
|
+
"enum": [
|
|
2302
|
+
"date-time",
|
|
2303
|
+
"time",
|
|
2304
|
+
"date",
|
|
2305
|
+
"duration",
|
|
2306
|
+
"email",
|
|
2307
|
+
"hostname",
|
|
2308
|
+
"ipv4",
|
|
2309
|
+
"ipv6",
|
|
2310
|
+
"uuid"
|
|
2311
|
+
]
|
|
2312
|
+
},
|
|
2313
|
+
"required": {
|
|
2314
|
+
"description": "This is a list of properties that are required.\n\nThis only makes sense if the type is \"object\".",
|
|
2315
|
+
"type": "array",
|
|
2316
|
+
"items": {
|
|
2317
|
+
"type": "string"
|
|
2318
|
+
}
|
|
2319
|
+
},
|
|
2320
|
+
"enum": {
|
|
2321
|
+
"description": "This array specifies the allowed values that can be used to restrict the output of the model.",
|
|
2322
|
+
"type": "array",
|
|
2323
|
+
"items": {
|
|
2324
|
+
"type": "string"
|
|
2325
|
+
}
|
|
2326
|
+
},
|
|
2327
|
+
"title": {
|
|
2328
|
+
"type": "string",
|
|
2329
|
+
"description": "This is the title of the schema."
|
|
2330
|
+
}
|
|
2331
|
+
},
|
|
2332
|
+
"required": [
|
|
2333
|
+
"type"
|
|
2334
|
+
]
|
|
2335
|
+
}
|
|
2336
|
+
},
|
|
2337
|
+
"requiredToolConfigurations": [
|
|
2338
|
+
"apiRequest"
|
|
2339
|
+
],
|
|
2340
|
+
"functionRequiresName": true
|
|
2341
|
+
}
|