@upon-ai/sdk 0.0.0-stage → 0.1.1
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/LICENSE +21 -0
- package/README.md +59 -2
- package/dist/client.d.ts +11 -0
- package/dist/client.js +194 -0
- package/dist/errors.d.ts +8 -0
- package/dist/errors.js +13 -0
- package/dist/index.d.ts +83 -0
- package/dist/index.js +82 -0
- package/dist/metadata.d.ts +1936 -0
- package/dist/metadata.js +2142 -0
- package/dist/schema.d.ts +4887 -0
- package/dist/schema.js +1 -0
- package/dist/types.d.ts +52 -0
- package/dist/types.js +1 -0
- package/dist/version.d.ts +1 -0
- package/dist/version.js +1 -0
- package/package.json +41 -4
package/dist/schema.d.ts
ADDED
|
@@ -0,0 +1,4887 @@
|
|
|
1
|
+
export interface paths {
|
|
2
|
+
"/api/v1/llms": {
|
|
3
|
+
parameters: {
|
|
4
|
+
query?: never;
|
|
5
|
+
header?: never;
|
|
6
|
+
path?: never;
|
|
7
|
+
cookie?: never;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* List LLMs
|
|
11
|
+
* @description Enumerate the UponAI LLM configurations available to a workspace. Results are returned newest first.
|
|
12
|
+
*/
|
|
13
|
+
get: operations["listLlms"];
|
|
14
|
+
put?: never;
|
|
15
|
+
/**
|
|
16
|
+
* Create LLM
|
|
17
|
+
* @description Provision a new UponAI large language model configuration.
|
|
18
|
+
*/
|
|
19
|
+
post: operations["createLlm"];
|
|
20
|
+
delete?: never;
|
|
21
|
+
options?: never;
|
|
22
|
+
head?: never;
|
|
23
|
+
patch?: never;
|
|
24
|
+
trace?: never;
|
|
25
|
+
};
|
|
26
|
+
"/api/v1/llms/{llmId}": {
|
|
27
|
+
parameters: {
|
|
28
|
+
query?: never;
|
|
29
|
+
header?: never;
|
|
30
|
+
path: {
|
|
31
|
+
/** @description LLM identifier. */
|
|
32
|
+
llmId: components["parameters"]["LlmIdPath"];
|
|
33
|
+
};
|
|
34
|
+
cookie?: never;
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Get LLM
|
|
38
|
+
* @description Retrieve the latest or a specific version of an LLM configuration.
|
|
39
|
+
*/
|
|
40
|
+
get: operations["getLlm"];
|
|
41
|
+
put?: never;
|
|
42
|
+
post?: never;
|
|
43
|
+
/**
|
|
44
|
+
* Delete LLM
|
|
45
|
+
* @description Permanently delete an LLM configuration and its versions.
|
|
46
|
+
*/
|
|
47
|
+
delete: operations["deleteLlm"];
|
|
48
|
+
options?: never;
|
|
49
|
+
head?: never;
|
|
50
|
+
/**
|
|
51
|
+
* Update LLM
|
|
52
|
+
* @description Apply partial updates to an existing LLM configuration.
|
|
53
|
+
*/
|
|
54
|
+
patch: operations["updateLlm"];
|
|
55
|
+
trace?: never;
|
|
56
|
+
};
|
|
57
|
+
"/api/v1/agents": {
|
|
58
|
+
parameters: {
|
|
59
|
+
query?: never;
|
|
60
|
+
header?: never;
|
|
61
|
+
path?: never;
|
|
62
|
+
cookie?: never;
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* List agents
|
|
66
|
+
* @description List agents created inside a workspace.
|
|
67
|
+
*/
|
|
68
|
+
get: operations["listAgents"];
|
|
69
|
+
put?: never;
|
|
70
|
+
/**
|
|
71
|
+
* Create agent
|
|
72
|
+
* @description Create a new UponAI agent for use in calls and web sessions.
|
|
73
|
+
*/
|
|
74
|
+
post: operations["createAgent"];
|
|
75
|
+
delete?: never;
|
|
76
|
+
options?: never;
|
|
77
|
+
head?: never;
|
|
78
|
+
patch?: never;
|
|
79
|
+
trace?: never;
|
|
80
|
+
};
|
|
81
|
+
"/api/v1/agents/{agentId}": {
|
|
82
|
+
parameters: {
|
|
83
|
+
query?: never;
|
|
84
|
+
header?: never;
|
|
85
|
+
path: {
|
|
86
|
+
/** @description Agent identifier. */
|
|
87
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
88
|
+
};
|
|
89
|
+
cookie?: never;
|
|
90
|
+
};
|
|
91
|
+
/**
|
|
92
|
+
* Get agent
|
|
93
|
+
* @description Retrieve the active configuration or a historical version of an agent.
|
|
94
|
+
*/
|
|
95
|
+
get: operations["getAgent"];
|
|
96
|
+
put?: never;
|
|
97
|
+
post?: never;
|
|
98
|
+
/**
|
|
99
|
+
* Delete agent
|
|
100
|
+
* @description Permanently remove an agent and all saved versions.
|
|
101
|
+
*/
|
|
102
|
+
delete: operations["deleteAgent"];
|
|
103
|
+
options?: never;
|
|
104
|
+
head?: never;
|
|
105
|
+
/**
|
|
106
|
+
* Update agent
|
|
107
|
+
* @description Apply partial updates to an existing agent configuration.
|
|
108
|
+
*/
|
|
109
|
+
patch: operations["updateAgent"];
|
|
110
|
+
trace?: never;
|
|
111
|
+
};
|
|
112
|
+
"/api/v1/agents/{agentId}/versions": {
|
|
113
|
+
parameters: {
|
|
114
|
+
query?: never;
|
|
115
|
+
header?: never;
|
|
116
|
+
path: {
|
|
117
|
+
/** @description Agent identifier. */
|
|
118
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
119
|
+
};
|
|
120
|
+
cookie?: never;
|
|
121
|
+
};
|
|
122
|
+
/**
|
|
123
|
+
* List agent versions
|
|
124
|
+
* @description Review the revision history for an agent.
|
|
125
|
+
*/
|
|
126
|
+
get: operations["listAgentVersions"];
|
|
127
|
+
put?: never;
|
|
128
|
+
/**
|
|
129
|
+
* Create agent draft version
|
|
130
|
+
* @description Create a new editable draft from an existing agent version.
|
|
131
|
+
*/
|
|
132
|
+
post: operations["createAgentDraftVersion"];
|
|
133
|
+
delete?: never;
|
|
134
|
+
options?: never;
|
|
135
|
+
head?: never;
|
|
136
|
+
patch?: never;
|
|
137
|
+
trace?: never;
|
|
138
|
+
};
|
|
139
|
+
"/api/v1/agents/{agentId}/versions/{version}/publish": {
|
|
140
|
+
parameters: {
|
|
141
|
+
query?: never;
|
|
142
|
+
header?: never;
|
|
143
|
+
path: {
|
|
144
|
+
/** @description Agent identifier. */
|
|
145
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
146
|
+
/** @description Specific agent version. */
|
|
147
|
+
version: components["parameters"]["VersionPath"];
|
|
148
|
+
};
|
|
149
|
+
cookie?: never;
|
|
150
|
+
};
|
|
151
|
+
get?: never;
|
|
152
|
+
put?: never;
|
|
153
|
+
/**
|
|
154
|
+
* Publish agent version
|
|
155
|
+
* @description Publish one existing draft version in place.
|
|
156
|
+
*/
|
|
157
|
+
post: operations["publishAgentVersion"];
|
|
158
|
+
delete?: never;
|
|
159
|
+
options?: never;
|
|
160
|
+
head?: never;
|
|
161
|
+
patch?: never;
|
|
162
|
+
trace?: never;
|
|
163
|
+
};
|
|
164
|
+
"/api/v1/agents/{agentId}/versions/{version}": {
|
|
165
|
+
parameters: {
|
|
166
|
+
query?: never;
|
|
167
|
+
header?: never;
|
|
168
|
+
path: {
|
|
169
|
+
/** @description Agent identifier. */
|
|
170
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
171
|
+
/** @description Specific agent version. */
|
|
172
|
+
version: components["parameters"]["VersionPath"];
|
|
173
|
+
};
|
|
174
|
+
cookie?: never;
|
|
175
|
+
};
|
|
176
|
+
get?: never;
|
|
177
|
+
put?: never;
|
|
178
|
+
post?: never;
|
|
179
|
+
/**
|
|
180
|
+
* Delete agent version
|
|
181
|
+
* @description Delete one specific agent version.
|
|
182
|
+
*/
|
|
183
|
+
delete: operations["deleteAgentVersion"];
|
|
184
|
+
options?: never;
|
|
185
|
+
head?: never;
|
|
186
|
+
patch?: never;
|
|
187
|
+
trace?: never;
|
|
188
|
+
};
|
|
189
|
+
"/api/v1/chat-agents": {
|
|
190
|
+
parameters: {
|
|
191
|
+
query?: never;
|
|
192
|
+
header?: never;
|
|
193
|
+
path?: never;
|
|
194
|
+
cookie?: never;
|
|
195
|
+
};
|
|
196
|
+
/**
|
|
197
|
+
* List chat agents
|
|
198
|
+
* @description List chat agents created inside a workspace.
|
|
199
|
+
*/
|
|
200
|
+
get: operations["listChatAgents"];
|
|
201
|
+
put?: never;
|
|
202
|
+
/**
|
|
203
|
+
* Create chat agent
|
|
204
|
+
* @description Create a new UponAI chat agent for browser and messaging use cases.
|
|
205
|
+
*/
|
|
206
|
+
post: operations["createChatAgent"];
|
|
207
|
+
delete?: never;
|
|
208
|
+
options?: never;
|
|
209
|
+
head?: never;
|
|
210
|
+
patch?: never;
|
|
211
|
+
trace?: never;
|
|
212
|
+
};
|
|
213
|
+
"/api/v1/chat-agents/{agentId}": {
|
|
214
|
+
parameters: {
|
|
215
|
+
query?: never;
|
|
216
|
+
header?: never;
|
|
217
|
+
path: {
|
|
218
|
+
/** @description Agent identifier. */
|
|
219
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
220
|
+
};
|
|
221
|
+
cookie?: never;
|
|
222
|
+
};
|
|
223
|
+
/**
|
|
224
|
+
* Get chat agent
|
|
225
|
+
* @description Retrieve the active configuration or a historical version of a chat agent.
|
|
226
|
+
*/
|
|
227
|
+
get: operations["getChatAgent"];
|
|
228
|
+
put?: never;
|
|
229
|
+
post?: never;
|
|
230
|
+
/**
|
|
231
|
+
* Delete chat agent
|
|
232
|
+
* @description Permanently remove a chat agent and all saved versions.
|
|
233
|
+
*/
|
|
234
|
+
delete: operations["deleteChatAgent"];
|
|
235
|
+
options?: never;
|
|
236
|
+
head?: never;
|
|
237
|
+
/**
|
|
238
|
+
* Update chat agent
|
|
239
|
+
* @description Apply partial updates to an existing chat agent configuration.
|
|
240
|
+
*/
|
|
241
|
+
patch: operations["updateChatAgent"];
|
|
242
|
+
trace?: never;
|
|
243
|
+
};
|
|
244
|
+
"/api/v1/chat-agents/{agentId}/versions": {
|
|
245
|
+
parameters: {
|
|
246
|
+
query?: never;
|
|
247
|
+
header?: never;
|
|
248
|
+
path: {
|
|
249
|
+
/** @description Agent identifier. */
|
|
250
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
251
|
+
};
|
|
252
|
+
cookie?: never;
|
|
253
|
+
};
|
|
254
|
+
/**
|
|
255
|
+
* List chat agent versions
|
|
256
|
+
* @description Review the revision history for a chat agent.
|
|
257
|
+
*/
|
|
258
|
+
get: operations["listChatAgentVersions"];
|
|
259
|
+
put?: never;
|
|
260
|
+
/**
|
|
261
|
+
* Create chat agent draft version
|
|
262
|
+
* @description Create a new editable draft from an existing chat agent version.
|
|
263
|
+
*/
|
|
264
|
+
post: operations["createChatAgentDraftVersion"];
|
|
265
|
+
delete?: never;
|
|
266
|
+
options?: never;
|
|
267
|
+
head?: never;
|
|
268
|
+
patch?: never;
|
|
269
|
+
trace?: never;
|
|
270
|
+
};
|
|
271
|
+
"/api/v1/chat-agents/{agentId}/versions/{version}/publish": {
|
|
272
|
+
parameters: {
|
|
273
|
+
query?: never;
|
|
274
|
+
header?: never;
|
|
275
|
+
path: {
|
|
276
|
+
/** @description Agent identifier. */
|
|
277
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
278
|
+
/** @description Specific agent version. */
|
|
279
|
+
version: components["parameters"]["VersionPath"];
|
|
280
|
+
};
|
|
281
|
+
cookie?: never;
|
|
282
|
+
};
|
|
283
|
+
get?: never;
|
|
284
|
+
put?: never;
|
|
285
|
+
/**
|
|
286
|
+
* Publish chat agent version
|
|
287
|
+
* @description Publish one existing chat agent draft version in place.
|
|
288
|
+
*/
|
|
289
|
+
post: operations["publishChatAgentVersion"];
|
|
290
|
+
delete?: never;
|
|
291
|
+
options?: never;
|
|
292
|
+
head?: never;
|
|
293
|
+
patch?: never;
|
|
294
|
+
trace?: never;
|
|
295
|
+
};
|
|
296
|
+
"/api/v1/chat-agents/{agentId}/versions/{version}": {
|
|
297
|
+
parameters: {
|
|
298
|
+
query?: never;
|
|
299
|
+
header?: never;
|
|
300
|
+
path: {
|
|
301
|
+
/** @description Agent identifier. */
|
|
302
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
303
|
+
/** @description Specific agent version. */
|
|
304
|
+
version: components["parameters"]["VersionPath"];
|
|
305
|
+
};
|
|
306
|
+
cookie?: never;
|
|
307
|
+
};
|
|
308
|
+
get?: never;
|
|
309
|
+
put?: never;
|
|
310
|
+
post?: never;
|
|
311
|
+
/**
|
|
312
|
+
* Delete chat agent version
|
|
313
|
+
* @description Delete one specific chat agent version.
|
|
314
|
+
*/
|
|
315
|
+
delete: operations["deleteChatAgentVersion"];
|
|
316
|
+
options?: never;
|
|
317
|
+
head?: never;
|
|
318
|
+
patch?: never;
|
|
319
|
+
trace?: never;
|
|
320
|
+
};
|
|
321
|
+
"/api/v1/chat-agents/{agentId}/publish": {
|
|
322
|
+
parameters: {
|
|
323
|
+
query?: never;
|
|
324
|
+
header?: never;
|
|
325
|
+
path: {
|
|
326
|
+
/** @description Agent identifier. */
|
|
327
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
328
|
+
};
|
|
329
|
+
cookie?: never;
|
|
330
|
+
};
|
|
331
|
+
get?: never;
|
|
332
|
+
put?: never;
|
|
333
|
+
/**
|
|
334
|
+
* Publish chat agent version (legacy path)
|
|
335
|
+
* @deprecated
|
|
336
|
+
* @description Deprecated compatibility path. Publish the explicit version supplied in the request body.
|
|
337
|
+
*/
|
|
338
|
+
post: operations["publishChatAgentVersionFiltered"];
|
|
339
|
+
delete?: never;
|
|
340
|
+
options?: never;
|
|
341
|
+
head?: never;
|
|
342
|
+
patch?: never;
|
|
343
|
+
trace?: never;
|
|
344
|
+
};
|
|
345
|
+
"/api/v1/chats": {
|
|
346
|
+
parameters: {
|
|
347
|
+
query?: never;
|
|
348
|
+
header?: never;
|
|
349
|
+
path?: never;
|
|
350
|
+
cookie?: never;
|
|
351
|
+
};
|
|
352
|
+
/**
|
|
353
|
+
* List chats
|
|
354
|
+
* @description List chats for a workspace, newest first by default.
|
|
355
|
+
*/
|
|
356
|
+
get: operations["listChats"];
|
|
357
|
+
put?: never;
|
|
358
|
+
/**
|
|
359
|
+
* Create chat
|
|
360
|
+
* @description Start a new live chat session backed by a chat agent.
|
|
361
|
+
*/
|
|
362
|
+
post: operations["createChat"];
|
|
363
|
+
delete?: never;
|
|
364
|
+
options?: never;
|
|
365
|
+
head?: never;
|
|
366
|
+
patch?: never;
|
|
367
|
+
trace?: never;
|
|
368
|
+
};
|
|
369
|
+
"/api/v1/chats/outbound-sms": {
|
|
370
|
+
parameters: {
|
|
371
|
+
query?: never;
|
|
372
|
+
header?: never;
|
|
373
|
+
path?: never;
|
|
374
|
+
cookie?: never;
|
|
375
|
+
};
|
|
376
|
+
get?: never;
|
|
377
|
+
put?: never;
|
|
378
|
+
/**
|
|
379
|
+
* Create outbound SMS chat
|
|
380
|
+
* @description Start an outbound SMS chat session for a workspace.
|
|
381
|
+
*/
|
|
382
|
+
post: operations["createOutboundSmsChat"];
|
|
383
|
+
delete?: never;
|
|
384
|
+
options?: never;
|
|
385
|
+
head?: never;
|
|
386
|
+
patch?: never;
|
|
387
|
+
trace?: never;
|
|
388
|
+
};
|
|
389
|
+
"/api/v1/chats/{chatId}": {
|
|
390
|
+
parameters: {
|
|
391
|
+
query?: never;
|
|
392
|
+
header?: never;
|
|
393
|
+
path: {
|
|
394
|
+
/** @description Chat identifier. */
|
|
395
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
396
|
+
};
|
|
397
|
+
cookie?: never;
|
|
398
|
+
};
|
|
399
|
+
/**
|
|
400
|
+
* Get chat
|
|
401
|
+
* @description Retrieve details for a specific chat session.
|
|
402
|
+
*/
|
|
403
|
+
get: operations["getChat"];
|
|
404
|
+
put?: never;
|
|
405
|
+
post?: never;
|
|
406
|
+
delete?: never;
|
|
407
|
+
options?: never;
|
|
408
|
+
head?: never;
|
|
409
|
+
/**
|
|
410
|
+
* Update chat
|
|
411
|
+
* @description Update metadata, custom attributes, or dynamic-variable overrides for an existing chat.
|
|
412
|
+
*/
|
|
413
|
+
patch: operations["updateChat"];
|
|
414
|
+
trace?: never;
|
|
415
|
+
};
|
|
416
|
+
"/api/v1/chats/{chatId}/completions": {
|
|
417
|
+
parameters: {
|
|
418
|
+
query?: never;
|
|
419
|
+
header?: never;
|
|
420
|
+
path: {
|
|
421
|
+
/** @description Chat identifier. */
|
|
422
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
423
|
+
};
|
|
424
|
+
cookie?: never;
|
|
425
|
+
};
|
|
426
|
+
get?: never;
|
|
427
|
+
put?: never;
|
|
428
|
+
/**
|
|
429
|
+
* Create chat completion
|
|
430
|
+
* @description Send a user message into an existing chat and receive the assistant response messages.
|
|
431
|
+
*/
|
|
432
|
+
post: operations["createChatCompletion"];
|
|
433
|
+
delete?: never;
|
|
434
|
+
options?: never;
|
|
435
|
+
head?: never;
|
|
436
|
+
patch?: never;
|
|
437
|
+
trace?: never;
|
|
438
|
+
};
|
|
439
|
+
"/api/v1/chats/{chatId}/end": {
|
|
440
|
+
parameters: {
|
|
441
|
+
query?: never;
|
|
442
|
+
header?: never;
|
|
443
|
+
path: {
|
|
444
|
+
/** @description Chat identifier. */
|
|
445
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
446
|
+
};
|
|
447
|
+
cookie?: never;
|
|
448
|
+
};
|
|
449
|
+
get?: never;
|
|
450
|
+
put?: never;
|
|
451
|
+
/**
|
|
452
|
+
* End chat
|
|
453
|
+
* @description Mark a chat as completed and close the session.
|
|
454
|
+
*/
|
|
455
|
+
post: operations["endChat"];
|
|
456
|
+
delete?: never;
|
|
457
|
+
options?: never;
|
|
458
|
+
head?: never;
|
|
459
|
+
patch?: never;
|
|
460
|
+
trace?: never;
|
|
461
|
+
};
|
|
462
|
+
"/api/v1/chat-widgets": {
|
|
463
|
+
parameters: {
|
|
464
|
+
query?: never;
|
|
465
|
+
header?: never;
|
|
466
|
+
path?: never;
|
|
467
|
+
cookie?: never;
|
|
468
|
+
};
|
|
469
|
+
/**
|
|
470
|
+
* List chat widgets
|
|
471
|
+
* @description List embeddable website chat widget configurations for a workspace.
|
|
472
|
+
*/
|
|
473
|
+
get: operations["listChatWidgets"];
|
|
474
|
+
put?: never;
|
|
475
|
+
/**
|
|
476
|
+
* Create chat widget
|
|
477
|
+
* @description Create a public widget key and embed configuration for a website chat widget. The returned `embedScript` is the snippet to place on the customer's website. Browser traffic uses the widget public key and calls UponAI runtime endpoints; provider credentials and provider URLs are never exposed to the website.
|
|
478
|
+
*/
|
|
479
|
+
post: operations["createChatWidget"];
|
|
480
|
+
delete?: never;
|
|
481
|
+
options?: never;
|
|
482
|
+
head?: never;
|
|
483
|
+
patch?: never;
|
|
484
|
+
trace?: never;
|
|
485
|
+
};
|
|
486
|
+
"/api/v1/chat-widgets/{widgetId}": {
|
|
487
|
+
parameters: {
|
|
488
|
+
query?: never;
|
|
489
|
+
header?: never;
|
|
490
|
+
path: {
|
|
491
|
+
/** @description Chat widget configuration identifier. */
|
|
492
|
+
widgetId: components["parameters"]["WidgetIdPath"];
|
|
493
|
+
};
|
|
494
|
+
cookie?: never;
|
|
495
|
+
};
|
|
496
|
+
/**
|
|
497
|
+
* Get chat widget
|
|
498
|
+
* @description Retrieve a website chat widget configuration and its embed script.
|
|
499
|
+
*/
|
|
500
|
+
get: operations["getChatWidget"];
|
|
501
|
+
put?: never;
|
|
502
|
+
post?: never;
|
|
503
|
+
delete?: never;
|
|
504
|
+
options?: never;
|
|
505
|
+
head?: never;
|
|
506
|
+
/**
|
|
507
|
+
* Update chat widget
|
|
508
|
+
* @description Update styling, allowed origins, assigned chat agent, or enabled state for a website widget.
|
|
509
|
+
*/
|
|
510
|
+
patch: operations["updateChatWidget"];
|
|
511
|
+
trace?: never;
|
|
512
|
+
};
|
|
513
|
+
"/api/v1/chat-widgets/{widgetId}/regenerate-key": {
|
|
514
|
+
parameters: {
|
|
515
|
+
query?: never;
|
|
516
|
+
header?: never;
|
|
517
|
+
path: {
|
|
518
|
+
/** @description Chat widget configuration identifier. */
|
|
519
|
+
widgetId: components["parameters"]["WidgetIdPath"];
|
|
520
|
+
};
|
|
521
|
+
cookie?: never;
|
|
522
|
+
};
|
|
523
|
+
get?: never;
|
|
524
|
+
put?: never;
|
|
525
|
+
/**
|
|
526
|
+
* Regenerate widget key
|
|
527
|
+
* @description Rotate the public widget key. Existing website embeds using the old key will stop working until the script tag is updated with the returned `embedScript`.
|
|
528
|
+
*/
|
|
529
|
+
post: operations["regenerateWidgetKey"];
|
|
530
|
+
delete?: never;
|
|
531
|
+
options?: never;
|
|
532
|
+
head?: never;
|
|
533
|
+
patch?: never;
|
|
534
|
+
trace?: never;
|
|
535
|
+
};
|
|
536
|
+
"/api/v1/conversation-flows": {
|
|
537
|
+
parameters: {
|
|
538
|
+
query?: never;
|
|
539
|
+
header?: never;
|
|
540
|
+
path?: never;
|
|
541
|
+
cookie?: never;
|
|
542
|
+
};
|
|
543
|
+
/**
|
|
544
|
+
* List conversation flows
|
|
545
|
+
* @description Enumerate conversation flows for the workspace.
|
|
546
|
+
*/
|
|
547
|
+
get: operations["listConversationFlows"];
|
|
548
|
+
put?: never;
|
|
549
|
+
/**
|
|
550
|
+
* Create conversation flow
|
|
551
|
+
* @description Compose a reusable flow graph for agents to attach to.
|
|
552
|
+
*/
|
|
553
|
+
post: operations["createConversationFlow"];
|
|
554
|
+
delete?: never;
|
|
555
|
+
options?: never;
|
|
556
|
+
head?: never;
|
|
557
|
+
patch?: never;
|
|
558
|
+
trace?: never;
|
|
559
|
+
};
|
|
560
|
+
"/api/v1/conversation-flows/{conversationFlowId}": {
|
|
561
|
+
parameters: {
|
|
562
|
+
query?: never;
|
|
563
|
+
header?: never;
|
|
564
|
+
path: {
|
|
565
|
+
/** @description Conversation flow identifier. */
|
|
566
|
+
conversationFlowId: components["parameters"]["ConversationFlowIdPath"];
|
|
567
|
+
};
|
|
568
|
+
cookie?: never;
|
|
569
|
+
};
|
|
570
|
+
/**
|
|
571
|
+
* Get conversation flow
|
|
572
|
+
* @description Retrieve the latest or a specific version of a conversation flow.
|
|
573
|
+
*/
|
|
574
|
+
get: operations["getConversationFlow"];
|
|
575
|
+
put?: never;
|
|
576
|
+
post?: never;
|
|
577
|
+
/**
|
|
578
|
+
* Delete conversation flow
|
|
579
|
+
* @description Remove a conversation flow and its versions.
|
|
580
|
+
*/
|
|
581
|
+
delete: operations["deleteConversationFlow"];
|
|
582
|
+
options?: never;
|
|
583
|
+
head?: never;
|
|
584
|
+
/**
|
|
585
|
+
* Update conversation flow
|
|
586
|
+
* @description Apply partial updates to a conversation flow.
|
|
587
|
+
*/
|
|
588
|
+
patch: operations["updateConversationFlow"];
|
|
589
|
+
trace?: never;
|
|
590
|
+
};
|
|
591
|
+
"/api/v1/knowledge-bases": {
|
|
592
|
+
parameters: {
|
|
593
|
+
query?: never;
|
|
594
|
+
header?: never;
|
|
595
|
+
path?: never;
|
|
596
|
+
cookie?: never;
|
|
597
|
+
};
|
|
598
|
+
/**
|
|
599
|
+
* List knowledge bases
|
|
600
|
+
* @description Enumerate knowledge bases available to the workspace.
|
|
601
|
+
*/
|
|
602
|
+
get: operations["listKnowledgeBases"];
|
|
603
|
+
put?: never;
|
|
604
|
+
/**
|
|
605
|
+
* Create knowledge base
|
|
606
|
+
* @description Create a knowledge base and ingest documents, URLs, or free-form text for grounded responses. URL auto-refresh and chunking controls are supported when needed.
|
|
607
|
+
*/
|
|
608
|
+
post: operations["createKnowledgeBase"];
|
|
609
|
+
delete?: never;
|
|
610
|
+
options?: never;
|
|
611
|
+
head?: never;
|
|
612
|
+
patch?: never;
|
|
613
|
+
trace?: never;
|
|
614
|
+
};
|
|
615
|
+
"/api/v1/knowledge-bases/{knowledgeBaseId}": {
|
|
616
|
+
parameters: {
|
|
617
|
+
query?: never;
|
|
618
|
+
header?: never;
|
|
619
|
+
path: {
|
|
620
|
+
/** @description Knowledge base identifier. */
|
|
621
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
622
|
+
};
|
|
623
|
+
cookie?: never;
|
|
624
|
+
};
|
|
625
|
+
/**
|
|
626
|
+
* Get knowledge base
|
|
627
|
+
* @description Retrieve knowledge base metadata and ingestion status.
|
|
628
|
+
*/
|
|
629
|
+
get: operations["getKnowledgeBase"];
|
|
630
|
+
put?: never;
|
|
631
|
+
post?: never;
|
|
632
|
+
/**
|
|
633
|
+
* Delete knowledge base
|
|
634
|
+
* @description Permanently remove a knowledge base and its sources.
|
|
635
|
+
*/
|
|
636
|
+
delete: operations["deleteKnowledgeBase"];
|
|
637
|
+
options?: never;
|
|
638
|
+
head?: never;
|
|
639
|
+
patch?: never;
|
|
640
|
+
trace?: never;
|
|
641
|
+
};
|
|
642
|
+
"/api/v1/knowledge-bases/{knowledgeBaseId}/sources": {
|
|
643
|
+
parameters: {
|
|
644
|
+
query?: never;
|
|
645
|
+
header?: never;
|
|
646
|
+
path: {
|
|
647
|
+
/** @description Knowledge base identifier. */
|
|
648
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
649
|
+
};
|
|
650
|
+
cookie?: never;
|
|
651
|
+
};
|
|
652
|
+
get?: never;
|
|
653
|
+
put?: never;
|
|
654
|
+
/**
|
|
655
|
+
* Add knowledge base sources
|
|
656
|
+
* @description Append new source material to an existing knowledge base.
|
|
657
|
+
*/
|
|
658
|
+
post: operations["addKnowledgeBaseSources"];
|
|
659
|
+
delete?: never;
|
|
660
|
+
options?: never;
|
|
661
|
+
head?: never;
|
|
662
|
+
patch?: never;
|
|
663
|
+
trace?: never;
|
|
664
|
+
};
|
|
665
|
+
"/api/v1/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}": {
|
|
666
|
+
parameters: {
|
|
667
|
+
query?: never;
|
|
668
|
+
header?: never;
|
|
669
|
+
path: {
|
|
670
|
+
/** @description Knowledge base identifier. */
|
|
671
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
672
|
+
/** @description Knowledge base source identifier. */
|
|
673
|
+
sourceId: components["parameters"]["SourceIdPath"];
|
|
674
|
+
};
|
|
675
|
+
cookie?: never;
|
|
676
|
+
};
|
|
677
|
+
get?: never;
|
|
678
|
+
put?: never;
|
|
679
|
+
post?: never;
|
|
680
|
+
/**
|
|
681
|
+
* Delete knowledge base source
|
|
682
|
+
* @description Remove a specific source entry from a knowledge base.
|
|
683
|
+
*/
|
|
684
|
+
delete: operations["deleteKnowledgeBaseSource"];
|
|
685
|
+
options?: never;
|
|
686
|
+
head?: never;
|
|
687
|
+
patch?: never;
|
|
688
|
+
trace?: never;
|
|
689
|
+
};
|
|
690
|
+
"/api/v1/voices": {
|
|
691
|
+
parameters: {
|
|
692
|
+
query?: never;
|
|
693
|
+
header?: never;
|
|
694
|
+
path?: never;
|
|
695
|
+
cookie?: never;
|
|
696
|
+
};
|
|
697
|
+
/**
|
|
698
|
+
* List voices
|
|
699
|
+
* @description Explore the UponAI voice catalog available to a workspace.
|
|
700
|
+
*/
|
|
701
|
+
get: operations["listVoices"];
|
|
702
|
+
put?: never;
|
|
703
|
+
post?: never;
|
|
704
|
+
delete?: never;
|
|
705
|
+
options?: never;
|
|
706
|
+
head?: never;
|
|
707
|
+
patch?: never;
|
|
708
|
+
trace?: never;
|
|
709
|
+
};
|
|
710
|
+
"/api/v1/voices/search": {
|
|
711
|
+
parameters: {
|
|
712
|
+
query?: never;
|
|
713
|
+
header?: never;
|
|
714
|
+
path?: never;
|
|
715
|
+
cookie?: never;
|
|
716
|
+
};
|
|
717
|
+
get?: never;
|
|
718
|
+
put?: never;
|
|
719
|
+
/**
|
|
720
|
+
* Search community voices
|
|
721
|
+
* @description Search provider voice catalogs for community voices.
|
|
722
|
+
*/
|
|
723
|
+
post: operations["searchCommunityVoices"];
|
|
724
|
+
delete?: never;
|
|
725
|
+
options?: never;
|
|
726
|
+
head?: never;
|
|
727
|
+
patch?: never;
|
|
728
|
+
trace?: never;
|
|
729
|
+
};
|
|
730
|
+
"/api/v1/voices/community": {
|
|
731
|
+
parameters: {
|
|
732
|
+
query?: never;
|
|
733
|
+
header?: never;
|
|
734
|
+
path?: never;
|
|
735
|
+
cookie?: never;
|
|
736
|
+
};
|
|
737
|
+
get?: never;
|
|
738
|
+
put?: never;
|
|
739
|
+
/**
|
|
740
|
+
* Add community voice
|
|
741
|
+
* @description Add a provider community voice into the workspace library.
|
|
742
|
+
*/
|
|
743
|
+
post: operations["addCommunityVoice"];
|
|
744
|
+
delete?: never;
|
|
745
|
+
options?: never;
|
|
746
|
+
head?: never;
|
|
747
|
+
patch?: never;
|
|
748
|
+
trace?: never;
|
|
749
|
+
};
|
|
750
|
+
"/api/v1/voices/clone": {
|
|
751
|
+
parameters: {
|
|
752
|
+
query?: never;
|
|
753
|
+
header?: never;
|
|
754
|
+
path?: never;
|
|
755
|
+
cookie?: never;
|
|
756
|
+
};
|
|
757
|
+
get?: never;
|
|
758
|
+
put?: never;
|
|
759
|
+
/**
|
|
760
|
+
* Clone voice
|
|
761
|
+
* @description Clone a custom voice from uploaded source audio files.
|
|
762
|
+
*/
|
|
763
|
+
post: operations["cloneVoice"];
|
|
764
|
+
delete?: never;
|
|
765
|
+
options?: never;
|
|
766
|
+
head?: never;
|
|
767
|
+
patch?: never;
|
|
768
|
+
trace?: never;
|
|
769
|
+
};
|
|
770
|
+
"/api/v1/voices/{voiceId}": {
|
|
771
|
+
parameters: {
|
|
772
|
+
query?: never;
|
|
773
|
+
header?: never;
|
|
774
|
+
path: {
|
|
775
|
+
/** @description Voice identifier. */
|
|
776
|
+
voiceId: components["parameters"]["VoiceIdPath"];
|
|
777
|
+
};
|
|
778
|
+
cookie?: never;
|
|
779
|
+
};
|
|
780
|
+
/**
|
|
781
|
+
* Get voice
|
|
782
|
+
* @description Retrieve metadata for a specific voice.
|
|
783
|
+
*/
|
|
784
|
+
get: operations["getVoice"];
|
|
785
|
+
put?: never;
|
|
786
|
+
post?: never;
|
|
787
|
+
delete?: never;
|
|
788
|
+
options?: never;
|
|
789
|
+
head?: never;
|
|
790
|
+
patch?: never;
|
|
791
|
+
trace?: never;
|
|
792
|
+
};
|
|
793
|
+
"/api/v1/voices/{voiceId}/sample": {
|
|
794
|
+
parameters: {
|
|
795
|
+
query?: never;
|
|
796
|
+
header?: never;
|
|
797
|
+
path: {
|
|
798
|
+
/** @description Voice identifier. */
|
|
799
|
+
voiceId: components["parameters"]["VoiceIdPath"];
|
|
800
|
+
};
|
|
801
|
+
cookie?: never;
|
|
802
|
+
};
|
|
803
|
+
/**
|
|
804
|
+
* Stream voice sample
|
|
805
|
+
* @description Stream an MPEG sample to preview the voice.
|
|
806
|
+
*/
|
|
807
|
+
get: operations["streamVoiceSample"];
|
|
808
|
+
put?: never;
|
|
809
|
+
post?: never;
|
|
810
|
+
delete?: never;
|
|
811
|
+
options?: never;
|
|
812
|
+
head?: never;
|
|
813
|
+
patch?: never;
|
|
814
|
+
trace?: never;
|
|
815
|
+
};
|
|
816
|
+
"/api/v1/test-case-definitions": {
|
|
817
|
+
parameters: {
|
|
818
|
+
query?: never;
|
|
819
|
+
header?: never;
|
|
820
|
+
path?: never;
|
|
821
|
+
cookie?: never;
|
|
822
|
+
};
|
|
823
|
+
/**
|
|
824
|
+
* List test case definitions
|
|
825
|
+
* @description List test case definitions for a target response engine.
|
|
826
|
+
*/
|
|
827
|
+
get: operations["listTestCaseDefinitions"];
|
|
828
|
+
put?: never;
|
|
829
|
+
/**
|
|
830
|
+
* Create test case definition
|
|
831
|
+
* @description Create a simulation test case definition for a response engine.
|
|
832
|
+
*/
|
|
833
|
+
post: operations["createTestCaseDefinition"];
|
|
834
|
+
delete?: never;
|
|
835
|
+
options?: never;
|
|
836
|
+
head?: never;
|
|
837
|
+
patch?: never;
|
|
838
|
+
trace?: never;
|
|
839
|
+
};
|
|
840
|
+
"/api/v1/batch-tests": {
|
|
841
|
+
parameters: {
|
|
842
|
+
query?: never;
|
|
843
|
+
header?: never;
|
|
844
|
+
path?: never;
|
|
845
|
+
cookie?: never;
|
|
846
|
+
};
|
|
847
|
+
/**
|
|
848
|
+
* List batch tests
|
|
849
|
+
* @description List simulation batch jobs for a target response engine.
|
|
850
|
+
*/
|
|
851
|
+
get: operations["listBatchTests"];
|
|
852
|
+
put?: never;
|
|
853
|
+
/**
|
|
854
|
+
* Create batch test
|
|
855
|
+
* @description Run one or more saved simulation test case definitions against a response engine.
|
|
856
|
+
*/
|
|
857
|
+
post: operations["createBatchTest"];
|
|
858
|
+
delete?: never;
|
|
859
|
+
options?: never;
|
|
860
|
+
head?: never;
|
|
861
|
+
patch?: never;
|
|
862
|
+
trace?: never;
|
|
863
|
+
};
|
|
864
|
+
"/api/v1/batch-tests/{testCaseBatchJobId}": {
|
|
865
|
+
parameters: {
|
|
866
|
+
query?: never;
|
|
867
|
+
header?: never;
|
|
868
|
+
path: {
|
|
869
|
+
/** @description Test run batch identifier. */
|
|
870
|
+
testCaseBatchJobId: components["parameters"]["TestCaseBatchJobIdPath"];
|
|
871
|
+
};
|
|
872
|
+
cookie?: never;
|
|
873
|
+
};
|
|
874
|
+
/**
|
|
875
|
+
* Get batch test
|
|
876
|
+
* @description Retrieve a simulation batch job by ID.
|
|
877
|
+
*/
|
|
878
|
+
get: operations["getBatchTest"];
|
|
879
|
+
put?: never;
|
|
880
|
+
post?: never;
|
|
881
|
+
delete?: never;
|
|
882
|
+
options?: never;
|
|
883
|
+
head?: never;
|
|
884
|
+
patch?: never;
|
|
885
|
+
trace?: never;
|
|
886
|
+
};
|
|
887
|
+
"/api/v1/test-case-definitions/{testCaseDefinitionId}": {
|
|
888
|
+
parameters: {
|
|
889
|
+
query?: never;
|
|
890
|
+
header?: never;
|
|
891
|
+
path: {
|
|
892
|
+
/** @description Test case definition identifier. */
|
|
893
|
+
testCaseDefinitionId: components["parameters"]["TestCaseDefinitionIdPath"];
|
|
894
|
+
};
|
|
895
|
+
cookie?: never;
|
|
896
|
+
};
|
|
897
|
+
/**
|
|
898
|
+
* Get test case definition
|
|
899
|
+
* @description Retrieve a single test case definition.
|
|
900
|
+
*/
|
|
901
|
+
get: operations["getTestCaseDefinition"];
|
|
902
|
+
/**
|
|
903
|
+
* Update test case definition
|
|
904
|
+
* @description Update an existing test case definition.
|
|
905
|
+
*/
|
|
906
|
+
put: operations["updateTestCaseDefinition"];
|
|
907
|
+
post?: never;
|
|
908
|
+
/**
|
|
909
|
+
* Delete test case definition
|
|
910
|
+
* @description Delete an existing test case definition.
|
|
911
|
+
*/
|
|
912
|
+
delete: operations["deleteTestCaseDefinition"];
|
|
913
|
+
options?: never;
|
|
914
|
+
head?: never;
|
|
915
|
+
patch?: never;
|
|
916
|
+
trace?: never;
|
|
917
|
+
};
|
|
918
|
+
"/api/v1/test-runs/{testCaseJobId}": {
|
|
919
|
+
parameters: {
|
|
920
|
+
query?: never;
|
|
921
|
+
header?: never;
|
|
922
|
+
path: {
|
|
923
|
+
/** @description Test run job identifier. */
|
|
924
|
+
testCaseJobId: components["parameters"]["TestCaseJobIdPath"];
|
|
925
|
+
};
|
|
926
|
+
cookie?: never;
|
|
927
|
+
};
|
|
928
|
+
/**
|
|
929
|
+
* Get test run
|
|
930
|
+
* @description Retrieve a single test run result by job ID.
|
|
931
|
+
*/
|
|
932
|
+
get: operations["getTestRun"];
|
|
933
|
+
put?: never;
|
|
934
|
+
post?: never;
|
|
935
|
+
delete?: never;
|
|
936
|
+
options?: never;
|
|
937
|
+
head?: never;
|
|
938
|
+
patch?: never;
|
|
939
|
+
trace?: never;
|
|
940
|
+
};
|
|
941
|
+
"/api/v1/test-runs/batches/{testCaseBatchJobId}": {
|
|
942
|
+
parameters: {
|
|
943
|
+
query?: never;
|
|
944
|
+
header?: never;
|
|
945
|
+
path: {
|
|
946
|
+
/** @description Test run batch identifier. */
|
|
947
|
+
testCaseBatchJobId: components["parameters"]["TestCaseBatchJobIdPath"];
|
|
948
|
+
};
|
|
949
|
+
cookie?: never;
|
|
950
|
+
};
|
|
951
|
+
/**
|
|
952
|
+
* List test runs by batch
|
|
953
|
+
* @description List all test runs associated with a batch job.
|
|
954
|
+
*/
|
|
955
|
+
get: operations["listTestRunsByBatch"];
|
|
956
|
+
put?: never;
|
|
957
|
+
post?: never;
|
|
958
|
+
delete?: never;
|
|
959
|
+
options?: never;
|
|
960
|
+
head?: never;
|
|
961
|
+
patch?: never;
|
|
962
|
+
trace?: never;
|
|
963
|
+
};
|
|
964
|
+
"/api/v1/concurrency": {
|
|
965
|
+
parameters: {
|
|
966
|
+
query?: never;
|
|
967
|
+
header?: never;
|
|
968
|
+
path?: never;
|
|
969
|
+
cookie?: never;
|
|
970
|
+
};
|
|
971
|
+
/**
|
|
972
|
+
* Get concurrency
|
|
973
|
+
* @description Retrieve concurrency limits and current usage for the account.
|
|
974
|
+
*/
|
|
975
|
+
get: operations["getConcurrency"];
|
|
976
|
+
put?: never;
|
|
977
|
+
post?: never;
|
|
978
|
+
delete?: never;
|
|
979
|
+
options?: never;
|
|
980
|
+
head?: never;
|
|
981
|
+
patch?: never;
|
|
982
|
+
trace?: never;
|
|
983
|
+
};
|
|
984
|
+
"/api/v1/workspaces": {
|
|
985
|
+
parameters: {
|
|
986
|
+
query?: never;
|
|
987
|
+
header?: never;
|
|
988
|
+
path?: never;
|
|
989
|
+
cookie?: never;
|
|
990
|
+
};
|
|
991
|
+
/**
|
|
992
|
+
* List workspaces
|
|
993
|
+
* @description List the workspaces accessible to the bearer token. Use this endpoint to discover the workspaceId required by workspace-scoped endpoints.
|
|
994
|
+
*/
|
|
995
|
+
get: operations["listWorkspaces"];
|
|
996
|
+
put?: never;
|
|
997
|
+
post?: never;
|
|
998
|
+
delete?: never;
|
|
999
|
+
options?: never;
|
|
1000
|
+
head?: never;
|
|
1001
|
+
patch?: never;
|
|
1002
|
+
trace?: never;
|
|
1003
|
+
};
|
|
1004
|
+
"/api/v1/calls/initiate": {
|
|
1005
|
+
parameters: {
|
|
1006
|
+
query?: never;
|
|
1007
|
+
header?: never;
|
|
1008
|
+
path?: never;
|
|
1009
|
+
cookie?: never;
|
|
1010
|
+
};
|
|
1011
|
+
get?: never;
|
|
1012
|
+
put?: never;
|
|
1013
|
+
/**
|
|
1014
|
+
* Create phone call
|
|
1015
|
+
* @description Initiate a PSTN phone call via UponAI infrastructure. The workspace is inferred from the unique agentId. You may still send workspaceId for backward compatibility. Native-transfer workspaces expose the full per-call override surface, including agentOverride, overrideAgentVersion, customSipHeaders, and ignoreE164Validation.
|
|
1016
|
+
*/
|
|
1017
|
+
post: operations["createPhoneCall"];
|
|
1018
|
+
delete?: never;
|
|
1019
|
+
options?: never;
|
|
1020
|
+
head?: never;
|
|
1021
|
+
patch?: never;
|
|
1022
|
+
trace?: never;
|
|
1023
|
+
};
|
|
1024
|
+
"/api/v1/calls/web": {
|
|
1025
|
+
parameters: {
|
|
1026
|
+
query?: never;
|
|
1027
|
+
header?: never;
|
|
1028
|
+
path?: never;
|
|
1029
|
+
cookie?: never;
|
|
1030
|
+
};
|
|
1031
|
+
get?: never;
|
|
1032
|
+
put?: never;
|
|
1033
|
+
/**
|
|
1034
|
+
* Create web call
|
|
1035
|
+
* @description Start a browser based call session powered by an UponAI agent. The workspace is inferred from the unique agentId. You may still send workspaceId for backward compatibility.
|
|
1036
|
+
*/
|
|
1037
|
+
post: operations["createWebCall"];
|
|
1038
|
+
delete?: never;
|
|
1039
|
+
options?: never;
|
|
1040
|
+
head?: never;
|
|
1041
|
+
patch?: never;
|
|
1042
|
+
trace?: never;
|
|
1043
|
+
};
|
|
1044
|
+
"/api/v1/calls": {
|
|
1045
|
+
parameters: {
|
|
1046
|
+
query?: never;
|
|
1047
|
+
header?: never;
|
|
1048
|
+
path?: never;
|
|
1049
|
+
cookie?: never;
|
|
1050
|
+
};
|
|
1051
|
+
/**
|
|
1052
|
+
* List calls
|
|
1053
|
+
* @deprecated
|
|
1054
|
+
* @description Deprecated. List calls with optional workspace, agent, status, and date filters from local call history. Use POST /api/v1/calls/list for the current cursor-compatible listing contract.
|
|
1055
|
+
*/
|
|
1056
|
+
get: operations["listCalls"];
|
|
1057
|
+
put?: never;
|
|
1058
|
+
post?: never;
|
|
1059
|
+
delete?: never;
|
|
1060
|
+
options?: never;
|
|
1061
|
+
head?: never;
|
|
1062
|
+
patch?: never;
|
|
1063
|
+
trace?: never;
|
|
1064
|
+
};
|
|
1065
|
+
"/api/v1/calls/list": {
|
|
1066
|
+
parameters: {
|
|
1067
|
+
query?: never;
|
|
1068
|
+
header?: never;
|
|
1069
|
+
path?: never;
|
|
1070
|
+
cookie?: never;
|
|
1071
|
+
};
|
|
1072
|
+
get?: never;
|
|
1073
|
+
put?: never;
|
|
1074
|
+
/**
|
|
1075
|
+
* List calls
|
|
1076
|
+
* @description List calls from local call history with the current unified pagination envelope. The response returns `items`, `has_more`, and `pagination_key`; send the returned pagination key in the next request to continue. You may include workspaceId to scope the query to one accessible workspace.
|
|
1077
|
+
*/
|
|
1078
|
+
post: operations["listCallsFiltered"];
|
|
1079
|
+
delete?: never;
|
|
1080
|
+
options?: never;
|
|
1081
|
+
head?: never;
|
|
1082
|
+
patch?: never;
|
|
1083
|
+
trace?: never;
|
|
1084
|
+
};
|
|
1085
|
+
"/api/v1/calls/history": {
|
|
1086
|
+
parameters: {
|
|
1087
|
+
query?: never;
|
|
1088
|
+
header?: never;
|
|
1089
|
+
path?: never;
|
|
1090
|
+
cookie?: never;
|
|
1091
|
+
};
|
|
1092
|
+
/**
|
|
1093
|
+
* Fetch call history
|
|
1094
|
+
* @description Return paginated call history for a single workspace, including agent and workspace metadata plus optional search and date filters.
|
|
1095
|
+
*/
|
|
1096
|
+
get: operations["fetchCallHistory"];
|
|
1097
|
+
put?: never;
|
|
1098
|
+
post?: never;
|
|
1099
|
+
delete?: never;
|
|
1100
|
+
options?: never;
|
|
1101
|
+
head?: never;
|
|
1102
|
+
patch?: never;
|
|
1103
|
+
trace?: never;
|
|
1104
|
+
};
|
|
1105
|
+
"/api/v1/calls/{callId}": {
|
|
1106
|
+
parameters: {
|
|
1107
|
+
query?: never;
|
|
1108
|
+
header?: never;
|
|
1109
|
+
path: {
|
|
1110
|
+
/** @description Call identifier or SID. */
|
|
1111
|
+
callId: components["parameters"]["CallIdPath"];
|
|
1112
|
+
};
|
|
1113
|
+
cookie?: never;
|
|
1114
|
+
};
|
|
1115
|
+
/**
|
|
1116
|
+
* Get call
|
|
1117
|
+
* @description Retrieve details for a specific call.
|
|
1118
|
+
*/
|
|
1119
|
+
get: operations["getCall"];
|
|
1120
|
+
put?: never;
|
|
1121
|
+
post?: never;
|
|
1122
|
+
delete?: never;
|
|
1123
|
+
options?: never;
|
|
1124
|
+
head?: never;
|
|
1125
|
+
/**
|
|
1126
|
+
* Update call
|
|
1127
|
+
* @description Update stored metadata or opt out of sensitive data storage. The API infers workspace from stored call data when available; workspaceId remains an optional backward-compatible fallback.
|
|
1128
|
+
*/
|
|
1129
|
+
patch: operations["updateCall"];
|
|
1130
|
+
trace?: never;
|
|
1131
|
+
};
|
|
1132
|
+
"/api/v1/calls/{callId}/end": {
|
|
1133
|
+
parameters: {
|
|
1134
|
+
query?: never;
|
|
1135
|
+
header?: never;
|
|
1136
|
+
path: {
|
|
1137
|
+
/** @description Call identifier or SID. */
|
|
1138
|
+
callId: components["parameters"]["CallIdPath"];
|
|
1139
|
+
};
|
|
1140
|
+
cookie?: never;
|
|
1141
|
+
};
|
|
1142
|
+
get?: never;
|
|
1143
|
+
put?: never;
|
|
1144
|
+
/**
|
|
1145
|
+
* End live call
|
|
1146
|
+
* @description Immediately ends an active voice or web call. If the call is already stored in call history, the workspace is inferred from that record; otherwise provide workspaceId in the request body so the action can be scoped to the correct workspace.
|
|
1147
|
+
*/
|
|
1148
|
+
post: operations["endLiveCall"];
|
|
1149
|
+
delete?: never;
|
|
1150
|
+
options?: never;
|
|
1151
|
+
head?: never;
|
|
1152
|
+
patch?: never;
|
|
1153
|
+
trace?: never;
|
|
1154
|
+
};
|
|
1155
|
+
"/api/v1/calls/{callId}/live": {
|
|
1156
|
+
parameters: {
|
|
1157
|
+
query?: never;
|
|
1158
|
+
header?: never;
|
|
1159
|
+
path: {
|
|
1160
|
+
/** @description Call identifier or SID. */
|
|
1161
|
+
callId: components["parameters"]["CallIdPath"];
|
|
1162
|
+
};
|
|
1163
|
+
cookie?: never;
|
|
1164
|
+
};
|
|
1165
|
+
get?: never;
|
|
1166
|
+
put?: never;
|
|
1167
|
+
post?: never;
|
|
1168
|
+
delete?: never;
|
|
1169
|
+
options?: never;
|
|
1170
|
+
head?: never;
|
|
1171
|
+
/**
|
|
1172
|
+
* Update live call
|
|
1173
|
+
* @description Applies runtime changes to an active call. You can override dynamic variables, metadata, and data storage setting, inject additional context, request a fresh agent response, and start or stop a listen-only audio stream while the call is in progress. These changes take effect immediately; metadata and data storage setting changes are also persisted to the call record. CamelCase and snake_case request field names are both accepted.
|
|
1174
|
+
*/
|
|
1175
|
+
patch: operations["updateLiveCall"];
|
|
1176
|
+
trace?: never;
|
|
1177
|
+
};
|
|
1178
|
+
"/api/v1/calls/{callId}/analysis/rerun": {
|
|
1179
|
+
parameters: {
|
|
1180
|
+
query?: never;
|
|
1181
|
+
header?: never;
|
|
1182
|
+
path: {
|
|
1183
|
+
/** @description Call identifier or SID. */
|
|
1184
|
+
callId: components["parameters"]["CallIdPath"];
|
|
1185
|
+
};
|
|
1186
|
+
cookie?: never;
|
|
1187
|
+
};
|
|
1188
|
+
get?: never;
|
|
1189
|
+
/**
|
|
1190
|
+
* Rerun call analysis
|
|
1191
|
+
* @description Reprocess post-call analysis for a completed call. If the call is already stored in call history, the workspace is inferred from that record; otherwise provide workspaceId in the request body.
|
|
1192
|
+
*/
|
|
1193
|
+
put: operations["rerunCallAnalysis"];
|
|
1194
|
+
post?: never;
|
|
1195
|
+
delete?: never;
|
|
1196
|
+
options?: never;
|
|
1197
|
+
head?: never;
|
|
1198
|
+
patch?: never;
|
|
1199
|
+
trace?: never;
|
|
1200
|
+
};
|
|
1201
|
+
}
|
|
1202
|
+
export type webhooks = Record<string, never>;
|
|
1203
|
+
export interface components {
|
|
1204
|
+
schemas: {
|
|
1205
|
+
LlmSummary: {
|
|
1206
|
+
llm_id: string;
|
|
1207
|
+
display_name: string;
|
|
1208
|
+
version: number;
|
|
1209
|
+
};
|
|
1210
|
+
CreateLlmRequest: {
|
|
1211
|
+
workspaceId: number;
|
|
1212
|
+
display_name: string;
|
|
1213
|
+
model?: string;
|
|
1214
|
+
/** @description Speech-to-speech model. Set either `model` or `s2s_model`, not both. */
|
|
1215
|
+
s2s_model?: string | null;
|
|
1216
|
+
general_prompt?: string;
|
|
1217
|
+
begin_message?: string | null;
|
|
1218
|
+
/** @enum {string} */
|
|
1219
|
+
start_speaker?: "user" | "agent";
|
|
1220
|
+
begin_after_user_silence_ms?: number | null;
|
|
1221
|
+
responsiveness?: string;
|
|
1222
|
+
model_temperature?: number;
|
|
1223
|
+
model_high_priority?: boolean;
|
|
1224
|
+
tool_call_strict_mode?: boolean;
|
|
1225
|
+
knowledge_base_ids?: string[];
|
|
1226
|
+
kb_config?: {
|
|
1227
|
+
[key: string]: unknown;
|
|
1228
|
+
};
|
|
1229
|
+
general_tools?: components["schemas"]["LlmTool"][];
|
|
1230
|
+
states?: components["schemas"]["LlmState"][];
|
|
1231
|
+
starting_state?: string | null;
|
|
1232
|
+
default_dynamic_variables?: {
|
|
1233
|
+
[key: string]: string;
|
|
1234
|
+
};
|
|
1235
|
+
mcps?: components["schemas"]["McpConnection"][];
|
|
1236
|
+
/** @description Optional LLM version number. */
|
|
1237
|
+
version?: number;
|
|
1238
|
+
} & {
|
|
1239
|
+
[key: string]: unknown;
|
|
1240
|
+
};
|
|
1241
|
+
LlmTool: components["schemas"]["TransferCallTool"] | components["schemas"]["EndCallTool"] | components["schemas"]["BridgeTransferTool"] | components["schemas"]["CancelTransferTool"] | components["schemas"]["CustomFunctionTool"] | components["schemas"]["Tool"];
|
|
1242
|
+
TransferCallTool: {
|
|
1243
|
+
/**
|
|
1244
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1245
|
+
* @enum {string}
|
|
1246
|
+
*/
|
|
1247
|
+
type: "TransferCallTool";
|
|
1248
|
+
/** @example transfer_to_support */
|
|
1249
|
+
name: string;
|
|
1250
|
+
/** @description Prompt-style description that tells the LLM when to call this transfer tool. */
|
|
1251
|
+
description?: string;
|
|
1252
|
+
transfer_destination: components["schemas"]["TransferDestination"];
|
|
1253
|
+
transfer_option: components["schemas"]["TransferOption"];
|
|
1254
|
+
/** @description Disable E.164 validation for internal or custom telephony destinations. */
|
|
1255
|
+
ignore_e164_validation?: boolean;
|
|
1256
|
+
/**
|
|
1257
|
+
* @description SIP headers sent with the outbound transfer leg.
|
|
1258
|
+
* @example {
|
|
1259
|
+
* "x-department": "support"
|
|
1260
|
+
* }
|
|
1261
|
+
*/
|
|
1262
|
+
custom_sip_headers?: {
|
|
1263
|
+
[key: string]: string;
|
|
1264
|
+
};
|
|
1265
|
+
speak_during_execution?: boolean;
|
|
1266
|
+
execution_message_description?: string;
|
|
1267
|
+
/** @enum {string} */
|
|
1268
|
+
execution_message_type?: "prompt" | "static_text";
|
|
1269
|
+
};
|
|
1270
|
+
TransferDestination: components["schemas"]["TransferDestinationPredefined"] | components["schemas"]["TransferDestinationInferred"];
|
|
1271
|
+
TransferDestinationPredefined: {
|
|
1272
|
+
/** @enum {string} */
|
|
1273
|
+
type: "predefined";
|
|
1274
|
+
/**
|
|
1275
|
+
* @description E.164 number, internal extension, or dynamic variable such as `{{transfer_destination}}`.
|
|
1276
|
+
* @example +18885551212
|
|
1277
|
+
*/
|
|
1278
|
+
number?: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* @description SIP URI destination for SIP transfers.
|
|
1281
|
+
* @example sip:support@pbx.example.com
|
|
1282
|
+
*/
|
|
1283
|
+
sip_uri?: string;
|
|
1284
|
+
/**
|
|
1285
|
+
* @description DTMF extension to dial after the main transfer connects.
|
|
1286
|
+
* @example 1234
|
|
1287
|
+
*/
|
|
1288
|
+
extension?: string;
|
|
1289
|
+
};
|
|
1290
|
+
TransferDestinationInferred: {
|
|
1291
|
+
/** @enum {string} */
|
|
1292
|
+
type: "inferred";
|
|
1293
|
+
/**
|
|
1294
|
+
* @description Prompt used with the global prompt and transcript to infer the transfer destination.
|
|
1295
|
+
* @example Transfer to billing at +18885550111 or sales at +18885550112 based on the user's request.
|
|
1296
|
+
*/
|
|
1297
|
+
prompt: string;
|
|
1298
|
+
};
|
|
1299
|
+
TransferOption: components["schemas"]["TransferOptionColdTransfer"] | components["schemas"]["TransferOptionWarmTransfer"] | components["schemas"]["TransferOptionAgenticWarmTransfer"];
|
|
1300
|
+
TransferOptionColdTransfer: {
|
|
1301
|
+
/** @enum {string} */
|
|
1302
|
+
type: "cold_transfer";
|
|
1303
|
+
/**
|
|
1304
|
+
* @description Use SIP INVITE for a new outbound leg, or SIP REFER to ask the carrier/PBX to transfer the call.
|
|
1305
|
+
* @default sip_invite
|
|
1306
|
+
* @enum {string}
|
|
1307
|
+
*/
|
|
1308
|
+
cold_transfer_mode: "sip_invite" | "sip_refer";
|
|
1309
|
+
/** @description Show the original caller as caller ID when supported. Applies to SIP INVITE transfers. */
|
|
1310
|
+
show_transferee_as_caller?: boolean;
|
|
1311
|
+
transfer_ring_duration_ms?: number;
|
|
1312
|
+
};
|
|
1313
|
+
TransferOptionWarmTransfer: {
|
|
1314
|
+
/** @enum {string} */
|
|
1315
|
+
type: "warm_transfer";
|
|
1316
|
+
show_transferee_as_caller?: boolean;
|
|
1317
|
+
/** @description Milliseconds to wait for human detection before treating the transfer as failed. */
|
|
1318
|
+
agent_detection_timeout_ms?: number;
|
|
1319
|
+
transfer_ring_duration_ms?: number;
|
|
1320
|
+
/** @enum {string} */
|
|
1321
|
+
on_hold_music?: "none" | "relaxing_sound" | "uplifting_beats" | "ringtone";
|
|
1322
|
+
public_handoff_option?: components["schemas"]["WarmTransferHandoffOption"];
|
|
1323
|
+
private_handoff_option?: components["schemas"]["WarmTransferHandoffOption"];
|
|
1324
|
+
ivr_option?: components["schemas"]["WarmTransferPrompt"];
|
|
1325
|
+
opt_out_human_detection?: boolean;
|
|
1326
|
+
/** @default true */
|
|
1327
|
+
enable_bridge_audio_cue: boolean;
|
|
1328
|
+
};
|
|
1329
|
+
WarmTransferHandoffOption: components["schemas"]["WarmTransferPrompt"] | components["schemas"]["WarmTransferStaticMessage"];
|
|
1330
|
+
WarmTransferPrompt: {
|
|
1331
|
+
/** @enum {string} */
|
|
1332
|
+
type: "prompt";
|
|
1333
|
+
prompt: string;
|
|
1334
|
+
};
|
|
1335
|
+
WarmTransferStaticMessage: {
|
|
1336
|
+
/** @enum {string} */
|
|
1337
|
+
type: "static_message";
|
|
1338
|
+
message: string;
|
|
1339
|
+
};
|
|
1340
|
+
TransferOptionAgenticWarmTransfer: {
|
|
1341
|
+
/** @enum {string} */
|
|
1342
|
+
type: "agentic_warm_transfer";
|
|
1343
|
+
show_transferee_as_caller?: boolean;
|
|
1344
|
+
/** @enum {string} */
|
|
1345
|
+
on_hold_music?: "none" | "relaxing_sound" | "uplifting_beats" | "ringtone";
|
|
1346
|
+
transfer_ring_duration_ms?: number;
|
|
1347
|
+
public_handoff_option?: components["schemas"]["WarmTransferHandoffOption"];
|
|
1348
|
+
agentic_transfer_config: {
|
|
1349
|
+
transfer_agent: {
|
|
1350
|
+
agent_id: string;
|
|
1351
|
+
/** @default 0 */
|
|
1352
|
+
agent_version: number;
|
|
1353
|
+
};
|
|
1354
|
+
/** @default 30000 */
|
|
1355
|
+
transfer_timeout_ms: number;
|
|
1356
|
+
/**
|
|
1357
|
+
* @default cancel_transfer
|
|
1358
|
+
* @enum {string}
|
|
1359
|
+
*/
|
|
1360
|
+
action_on_timeout: "cancel_transfer" | "bridge_transfer";
|
|
1361
|
+
};
|
|
1362
|
+
/** @default true */
|
|
1363
|
+
enable_bridge_audio_cue: boolean;
|
|
1364
|
+
};
|
|
1365
|
+
EndCallTool: {
|
|
1366
|
+
/**
|
|
1367
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1368
|
+
* @enum {string}
|
|
1369
|
+
*/
|
|
1370
|
+
type: "EndCallTool";
|
|
1371
|
+
name: string;
|
|
1372
|
+
description?: string;
|
|
1373
|
+
speak_during_execution?: boolean;
|
|
1374
|
+
execution_message_description?: string;
|
|
1375
|
+
/** @enum {string} */
|
|
1376
|
+
execution_message_type?: "prompt" | "static_text";
|
|
1377
|
+
};
|
|
1378
|
+
BridgeTransferTool: {
|
|
1379
|
+
/**
|
|
1380
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1381
|
+
* @enum {string}
|
|
1382
|
+
*/
|
|
1383
|
+
type: "BridgeTransferTool";
|
|
1384
|
+
/** @default bridge_transfer */
|
|
1385
|
+
name: string;
|
|
1386
|
+
description?: string;
|
|
1387
|
+
};
|
|
1388
|
+
CancelTransferTool: {
|
|
1389
|
+
/**
|
|
1390
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1391
|
+
* @enum {string}
|
|
1392
|
+
*/
|
|
1393
|
+
type: "CancelTransferTool";
|
|
1394
|
+
/** @default cancel_transfer */
|
|
1395
|
+
name: string;
|
|
1396
|
+
description?: string;
|
|
1397
|
+
};
|
|
1398
|
+
CustomFunctionTool: {
|
|
1399
|
+
/**
|
|
1400
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1401
|
+
* @enum {string}
|
|
1402
|
+
*/
|
|
1403
|
+
type: "CustomFunctionTool";
|
|
1404
|
+
name: string;
|
|
1405
|
+
description?: string;
|
|
1406
|
+
/** Format: uri */
|
|
1407
|
+
url?: string;
|
|
1408
|
+
/** @enum {string} */
|
|
1409
|
+
method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
|
|
1410
|
+
headers?: {
|
|
1411
|
+
[key: string]: string;
|
|
1412
|
+
};
|
|
1413
|
+
parameters?: {
|
|
1414
|
+
[key: string]: unknown;
|
|
1415
|
+
};
|
|
1416
|
+
};
|
|
1417
|
+
Tool: {
|
|
1418
|
+
name: string;
|
|
1419
|
+
description?: string;
|
|
1420
|
+
/**
|
|
1421
|
+
* @description discriminator enum property added by openapi-typescript
|
|
1422
|
+
* @enum {string}
|
|
1423
|
+
*/
|
|
1424
|
+
type: "Tool";
|
|
1425
|
+
};
|
|
1426
|
+
LlmState: {
|
|
1427
|
+
name: string;
|
|
1428
|
+
state_prompt?: string;
|
|
1429
|
+
edges?: components["schemas"]["LlmStateEdge"][];
|
|
1430
|
+
tools?: components["schemas"]["LlmTool"][];
|
|
1431
|
+
};
|
|
1432
|
+
LlmStateEdge: {
|
|
1433
|
+
destination_state_name: string;
|
|
1434
|
+
description: string;
|
|
1435
|
+
};
|
|
1436
|
+
McpConnection: {
|
|
1437
|
+
name: string;
|
|
1438
|
+
/** Format: uri */
|
|
1439
|
+
url: string;
|
|
1440
|
+
headers?: {
|
|
1441
|
+
[key: string]: string;
|
|
1442
|
+
};
|
|
1443
|
+
query_params?: {
|
|
1444
|
+
[key: string]: string;
|
|
1445
|
+
};
|
|
1446
|
+
timeout_ms?: number;
|
|
1447
|
+
};
|
|
1448
|
+
Llm: components["schemas"]["LlmSummary"] & ({
|
|
1449
|
+
model?: string;
|
|
1450
|
+
s2s_model?: string | null;
|
|
1451
|
+
general_prompt?: string | null;
|
|
1452
|
+
begin_message?: string | null;
|
|
1453
|
+
responsiveness?: string | null;
|
|
1454
|
+
general_tools?: components["schemas"]["LlmTool"][];
|
|
1455
|
+
states?: components["schemas"]["LlmState"][];
|
|
1456
|
+
starting_state?: string | null;
|
|
1457
|
+
/** Format: date-time */
|
|
1458
|
+
updated_at?: string | null;
|
|
1459
|
+
} & {
|
|
1460
|
+
[key: string]: unknown;
|
|
1461
|
+
});
|
|
1462
|
+
UpdateLlmRequest: {
|
|
1463
|
+
workspaceId: number;
|
|
1464
|
+
general_prompt?: string | null;
|
|
1465
|
+
begin_message?: string | null;
|
|
1466
|
+
responsiveness?: string;
|
|
1467
|
+
model?: string;
|
|
1468
|
+
/** @description Speech-to-speech model. Set either `model` or `s2s_model`, not both. */
|
|
1469
|
+
s2s_model?: string | null;
|
|
1470
|
+
/** @enum {string} */
|
|
1471
|
+
start_speaker?: "user" | "agent";
|
|
1472
|
+
begin_after_user_silence_ms?: number | null;
|
|
1473
|
+
model_temperature?: number;
|
|
1474
|
+
model_high_priority?: boolean;
|
|
1475
|
+
tool_call_strict_mode?: boolean;
|
|
1476
|
+
knowledge_base_ids?: string[];
|
|
1477
|
+
kb_config?: {
|
|
1478
|
+
[key: string]: unknown;
|
|
1479
|
+
};
|
|
1480
|
+
general_tools?: components["schemas"]["LlmTool"][];
|
|
1481
|
+
states?: components["schemas"]["LlmState"][];
|
|
1482
|
+
starting_state?: string | null;
|
|
1483
|
+
default_dynamic_variables?: {
|
|
1484
|
+
[key: string]: string;
|
|
1485
|
+
};
|
|
1486
|
+
mcps?: components["schemas"]["McpConnection"][];
|
|
1487
|
+
/** @description Optional LLM version number when included in the update body. To target an existing version, use the `version` query parameter. */
|
|
1488
|
+
version?: number;
|
|
1489
|
+
} & {
|
|
1490
|
+
[key: string]: unknown;
|
|
1491
|
+
};
|
|
1492
|
+
AgentSummary: {
|
|
1493
|
+
agent_id: string;
|
|
1494
|
+
agent_name?: string;
|
|
1495
|
+
version: number;
|
|
1496
|
+
};
|
|
1497
|
+
CreateAgentRequest: {
|
|
1498
|
+
workspaceId: number;
|
|
1499
|
+
agent_name: string;
|
|
1500
|
+
voice_id: string;
|
|
1501
|
+
voice_model?: components["schemas"]["VoiceModel"];
|
|
1502
|
+
fallback_voice_ids?: string[] | null;
|
|
1503
|
+
/** @default en-US */
|
|
1504
|
+
language: string;
|
|
1505
|
+
response_engine: components["schemas"]["ResponseEngine"];
|
|
1506
|
+
/** Format: uri */
|
|
1507
|
+
webhook_url?: string | null;
|
|
1508
|
+
webhook_events?: string[];
|
|
1509
|
+
webhook_timeout_ms?: number;
|
|
1510
|
+
response_threshold?: number;
|
|
1511
|
+
interruption_sensitivity?: number;
|
|
1512
|
+
ambient_sound?: string;
|
|
1513
|
+
ambient_sound_volume?: number;
|
|
1514
|
+
responsiveness?: number;
|
|
1515
|
+
enable_dynamic_responsiveness?: boolean;
|
|
1516
|
+
voice_temperature?: number;
|
|
1517
|
+
voice_speed?: number;
|
|
1518
|
+
enable_dynamic_voice_speed?: boolean;
|
|
1519
|
+
volume?: number;
|
|
1520
|
+
voice_emotion?: string | null;
|
|
1521
|
+
/** @description Enables expressive voice tags for supported voices. */
|
|
1522
|
+
enable_expressive_mode?: boolean;
|
|
1523
|
+
expressive_emotion_tags?: string[];
|
|
1524
|
+
expressive_mode_prompt?: string | null;
|
|
1525
|
+
/** @enum {string} */
|
|
1526
|
+
denoising_mode?: "noise-cancellation" | "noise-and-background-speech-cancellation";
|
|
1527
|
+
/** @enum {string} */
|
|
1528
|
+
stt_mode?: "fast" | "accurate" | "custom";
|
|
1529
|
+
custom_stt_config?: components["schemas"]["CustomSttConfig"];
|
|
1530
|
+
/** @enum {string} */
|
|
1531
|
+
vocab_specialization?: "general" | "medical";
|
|
1532
|
+
boosted_keywords?: string[];
|
|
1533
|
+
handbook_config?: {
|
|
1534
|
+
[key: string]: unknown;
|
|
1535
|
+
};
|
|
1536
|
+
max_call_duration_ms?: number;
|
|
1537
|
+
end_call_after_silence_ms?: number;
|
|
1538
|
+
} & {
|
|
1539
|
+
[key: string]: unknown;
|
|
1540
|
+
};
|
|
1541
|
+
/**
|
|
1542
|
+
* @description Voice synthesis model for the selected voice. When omitted or set to auto for an ElevenLabs voice, new agents default to `eleven_turbo_v2`.
|
|
1543
|
+
* @enum {string|null}
|
|
1544
|
+
*/
|
|
1545
|
+
VoiceModel: "eleven_turbo_v2" | "eleven_flash_v2" | "eleven_turbo_v2_5" | "eleven_flash_v2_5" | "eleven_multilingual_v2" | "eleven_v3" | "sonic-3" | "sonic-3-latest" | "sonic-3.5" | "tts-1" | "gpt-4o-mini-tts" | "speech-02-turbo" | "speech-2.8-turbo" | "s1" | "s2-pro" | "s2.1-pro" | "auto" | null;
|
|
1546
|
+
ResponseEngine: {
|
|
1547
|
+
type: string;
|
|
1548
|
+
llm_id?: string;
|
|
1549
|
+
};
|
|
1550
|
+
CustomSttConfig: ({
|
|
1551
|
+
/**
|
|
1552
|
+
* @description Realtime transcription provider used when stt_mode is custom.
|
|
1553
|
+
* @enum {string}
|
|
1554
|
+
*/
|
|
1555
|
+
provider?: "deepgram" | "azure" | "soniox" | "assemblyai";
|
|
1556
|
+
/** @description Endpointing delay in milliseconds for the selected provider. */
|
|
1557
|
+
endpointing_ms?: number;
|
|
1558
|
+
} & {
|
|
1559
|
+
[key: string]: unknown;
|
|
1560
|
+
}) | null;
|
|
1561
|
+
Agent: components["schemas"]["AgentSummary"] & ({
|
|
1562
|
+
voice_id?: string;
|
|
1563
|
+
voice_model?: components["schemas"]["VoiceModel"];
|
|
1564
|
+
fallback_voice_ids?: string[] | null;
|
|
1565
|
+
language?: string | null;
|
|
1566
|
+
response_engine?: components["schemas"]["ResponseEngine"];
|
|
1567
|
+
/** Format: uri */
|
|
1568
|
+
webhook_url?: string | null;
|
|
1569
|
+
webhook_events?: string[];
|
|
1570
|
+
webhook_timeout_ms?: number | null;
|
|
1571
|
+
response_threshold?: number | null;
|
|
1572
|
+
interruption_sensitivity?: number | null;
|
|
1573
|
+
ambient_sound?: string | null;
|
|
1574
|
+
ambient_sound_volume?: number | null;
|
|
1575
|
+
responsiveness?: number | null;
|
|
1576
|
+
enable_dynamic_responsiveness?: boolean | null;
|
|
1577
|
+
voice_temperature?: number | null;
|
|
1578
|
+
voice_speed?: number | null;
|
|
1579
|
+
enable_dynamic_voice_speed?: boolean | null;
|
|
1580
|
+
volume?: number | null;
|
|
1581
|
+
voice_emotion?: string | null;
|
|
1582
|
+
enable_expressive_mode?: boolean | null;
|
|
1583
|
+
expressive_emotion_tags?: string[] | null;
|
|
1584
|
+
expressive_mode_prompt?: string | null;
|
|
1585
|
+
denoising_mode?: string | null;
|
|
1586
|
+
/** @enum {string|null} */
|
|
1587
|
+
stt_mode?: "fast" | "accurate" | "custom" | null;
|
|
1588
|
+
custom_stt_config?: components["schemas"]["CustomSttConfig"];
|
|
1589
|
+
vocab_specialization?: string | null;
|
|
1590
|
+
boosted_keywords?: string[] | null;
|
|
1591
|
+
handbook_config?: {
|
|
1592
|
+
[key: string]: unknown;
|
|
1593
|
+
} | null;
|
|
1594
|
+
max_call_duration_ms?: number | null;
|
|
1595
|
+
end_call_after_silence_ms?: number | null;
|
|
1596
|
+
/** Format: date-time */
|
|
1597
|
+
created_at?: string | null;
|
|
1598
|
+
/** Format: date-time */
|
|
1599
|
+
updated_at?: string | null;
|
|
1600
|
+
} & {
|
|
1601
|
+
[key: string]: unknown;
|
|
1602
|
+
});
|
|
1603
|
+
UpdateAgentRequest: {
|
|
1604
|
+
workspaceId: number;
|
|
1605
|
+
agent_name?: string;
|
|
1606
|
+
voice_id?: string;
|
|
1607
|
+
voice_model?: components["schemas"]["VoiceModel"];
|
|
1608
|
+
fallback_voice_ids?: string[] | null;
|
|
1609
|
+
language?: string;
|
|
1610
|
+
response_engine?: components["schemas"]["ResponseEngine"];
|
|
1611
|
+
interruption_sensitivity?: number;
|
|
1612
|
+
max_call_duration_ms?: number;
|
|
1613
|
+
responsiveness?: number;
|
|
1614
|
+
enable_dynamic_responsiveness?: boolean;
|
|
1615
|
+
voice_temperature?: number;
|
|
1616
|
+
voice_speed?: number;
|
|
1617
|
+
enable_dynamic_voice_speed?: boolean;
|
|
1618
|
+
volume?: number;
|
|
1619
|
+
voice_emotion?: string | null;
|
|
1620
|
+
enable_expressive_mode?: boolean;
|
|
1621
|
+
expressive_emotion_tags?: string[];
|
|
1622
|
+
expressive_mode_prompt?: string | null;
|
|
1623
|
+
/** @enum {string} */
|
|
1624
|
+
denoising_mode?: "noise-cancellation" | "noise-and-background-speech-cancellation";
|
|
1625
|
+
/** @enum {string} */
|
|
1626
|
+
stt_mode?: "fast" | "accurate" | "custom";
|
|
1627
|
+
custom_stt_config?: components["schemas"]["CustomSttConfig"];
|
|
1628
|
+
/** @enum {string} */
|
|
1629
|
+
vocab_specialization?: "general" | "medical";
|
|
1630
|
+
boosted_keywords?: string[];
|
|
1631
|
+
handbook_config?: {
|
|
1632
|
+
[key: string]: unknown;
|
|
1633
|
+
};
|
|
1634
|
+
end_call_after_silence_ms?: number;
|
|
1635
|
+
} & {
|
|
1636
|
+
[key: string]: unknown;
|
|
1637
|
+
};
|
|
1638
|
+
AgentVersion: {
|
|
1639
|
+
agent_id: string;
|
|
1640
|
+
version: number;
|
|
1641
|
+
base_version?: number | null;
|
|
1642
|
+
is_published?: boolean;
|
|
1643
|
+
version_title?: string | null;
|
|
1644
|
+
version_description?: string | null;
|
|
1645
|
+
/** Format: date-time */
|
|
1646
|
+
updated_at?: string;
|
|
1647
|
+
};
|
|
1648
|
+
CreateAgentVersionRequest: {
|
|
1649
|
+
workspaceId: number;
|
|
1650
|
+
/** @description Existing version used as the base for the new draft. */
|
|
1651
|
+
baseVersion: number;
|
|
1652
|
+
};
|
|
1653
|
+
PublishAgentVersionRequest: {
|
|
1654
|
+
workspaceId: number;
|
|
1655
|
+
/** @description Optional title stored on the published version. */
|
|
1656
|
+
versionTitle?: string;
|
|
1657
|
+
/** @description Optional description stored on the published version. */
|
|
1658
|
+
versionDescription?: string;
|
|
1659
|
+
};
|
|
1660
|
+
ChatAgentListResponse: components["schemas"]["ChatAgentSummary"][] | components["schemas"]["ChatAgentListEnvelope"];
|
|
1661
|
+
ChatAgentSummary: components["schemas"]["ChatAgentVersion"] & {
|
|
1662
|
+
agent_name?: string;
|
|
1663
|
+
response_engine?: components["schemas"]["ChatResponseEngine"];
|
|
1664
|
+
auto_close_message?: string | null;
|
|
1665
|
+
is_public?: boolean | null;
|
|
1666
|
+
};
|
|
1667
|
+
ChatAgentVersion: {
|
|
1668
|
+
agent_id: string;
|
|
1669
|
+
version: number;
|
|
1670
|
+
base_version?: number | null;
|
|
1671
|
+
is_published?: boolean;
|
|
1672
|
+
version_title?: string | null;
|
|
1673
|
+
version_description?: string | null;
|
|
1674
|
+
/** Format: date-time */
|
|
1675
|
+
updated_at?: string | null;
|
|
1676
|
+
};
|
|
1677
|
+
ChatResponseEngine: {
|
|
1678
|
+
/** @enum {string} */
|
|
1679
|
+
type: "uponai-llm" | "uponai-custom-llm";
|
|
1680
|
+
llm_id?: string | null;
|
|
1681
|
+
};
|
|
1682
|
+
ChatAgentListEnvelope: {
|
|
1683
|
+
data?: components["schemas"]["ChatAgentSummary"][];
|
|
1684
|
+
pagination_key?: string | null;
|
|
1685
|
+
pagination_key_version?: number | null;
|
|
1686
|
+
};
|
|
1687
|
+
CreateChatAgentRequest: {
|
|
1688
|
+
workspaceId: number;
|
|
1689
|
+
agent_name: string;
|
|
1690
|
+
response_engine: components["schemas"]["ChatResponseEngine"];
|
|
1691
|
+
auto_close_message?: string | null;
|
|
1692
|
+
end_chat_after_silence_ms?: number;
|
|
1693
|
+
timezone?: string;
|
|
1694
|
+
/** Format: uri */
|
|
1695
|
+
webhook_url?: string | null;
|
|
1696
|
+
webhook_events?: string[];
|
|
1697
|
+
webhook_timeout_ms?: number;
|
|
1698
|
+
/** @enum {string} */
|
|
1699
|
+
data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only";
|
|
1700
|
+
data_storage_retention_days?: number;
|
|
1701
|
+
post_chat_analysis_data?: components["schemas"]["ChatAgentAnalysisField"][];
|
|
1702
|
+
post_chat_analysis_model?: string;
|
|
1703
|
+
pii_config?: {
|
|
1704
|
+
[key: string]: unknown;
|
|
1705
|
+
};
|
|
1706
|
+
guardrail_config?: {
|
|
1707
|
+
[key: string]: unknown;
|
|
1708
|
+
};
|
|
1709
|
+
handbook_config?: {
|
|
1710
|
+
[key: string]: unknown;
|
|
1711
|
+
};
|
|
1712
|
+
is_public?: boolean;
|
|
1713
|
+
uponai_dynamic_variables?: {
|
|
1714
|
+
[key: string]: string;
|
|
1715
|
+
};
|
|
1716
|
+
};
|
|
1717
|
+
ChatAgentAnalysisField: {
|
|
1718
|
+
/** @example chat_summary */
|
|
1719
|
+
type: string;
|
|
1720
|
+
/** @example summary */
|
|
1721
|
+
name: string;
|
|
1722
|
+
/** @example Short summary of the completed chat. */
|
|
1723
|
+
description?: string | null;
|
|
1724
|
+
prompt?: string | null;
|
|
1725
|
+
};
|
|
1726
|
+
ChatAgent: components["schemas"]["ChatAgentSummary"] & {
|
|
1727
|
+
end_chat_after_silence_ms?: number | null;
|
|
1728
|
+
timezone?: string | null;
|
|
1729
|
+
/** Format: uri */
|
|
1730
|
+
webhook_url?: string | null;
|
|
1731
|
+
webhook_events?: string[];
|
|
1732
|
+
webhook_timeout_ms?: number | null;
|
|
1733
|
+
/** @enum {string|null} */
|
|
1734
|
+
data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only" | null;
|
|
1735
|
+
data_storage_retention_days?: number | null;
|
|
1736
|
+
post_chat_analysis_data?: components["schemas"]["ChatAgentAnalysisField"][];
|
|
1737
|
+
post_chat_analysis_model?: string | null;
|
|
1738
|
+
pii_config?: {
|
|
1739
|
+
[key: string]: unknown;
|
|
1740
|
+
} | null;
|
|
1741
|
+
guardrail_config?: {
|
|
1742
|
+
[key: string]: unknown;
|
|
1743
|
+
} | null;
|
|
1744
|
+
handbook_config?: {
|
|
1745
|
+
[key: string]: unknown;
|
|
1746
|
+
} | null;
|
|
1747
|
+
override_agent_id?: string | null;
|
|
1748
|
+
uponai_dynamic_variables?: {
|
|
1749
|
+
[key: string]: string;
|
|
1750
|
+
};
|
|
1751
|
+
/** Format: date-time */
|
|
1752
|
+
created_at?: string | null;
|
|
1753
|
+
/** Format: date-time */
|
|
1754
|
+
updated_at?: string | null;
|
|
1755
|
+
};
|
|
1756
|
+
UpdateChatAgentRequest: {
|
|
1757
|
+
workspaceId: number;
|
|
1758
|
+
agent_name?: string;
|
|
1759
|
+
response_engine?: components["schemas"]["ChatResponseEngine"];
|
|
1760
|
+
auto_close_message?: string | null;
|
|
1761
|
+
end_chat_after_silence_ms?: number;
|
|
1762
|
+
timezone?: string;
|
|
1763
|
+
/** Format: uri */
|
|
1764
|
+
webhook_url?: string | null;
|
|
1765
|
+
webhook_events?: string[];
|
|
1766
|
+
webhook_timeout_ms?: number;
|
|
1767
|
+
/** @enum {string} */
|
|
1768
|
+
data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only";
|
|
1769
|
+
data_storage_retention_days?: number;
|
|
1770
|
+
post_chat_analysis_data?: components["schemas"]["ChatAgentAnalysisField"][];
|
|
1771
|
+
post_chat_analysis_model?: string;
|
|
1772
|
+
pii_config?: {
|
|
1773
|
+
[key: string]: unknown;
|
|
1774
|
+
};
|
|
1775
|
+
guardrail_config?: {
|
|
1776
|
+
[key: string]: unknown;
|
|
1777
|
+
};
|
|
1778
|
+
handbook_config?: {
|
|
1779
|
+
[key: string]: unknown;
|
|
1780
|
+
};
|
|
1781
|
+
is_public?: boolean;
|
|
1782
|
+
uponai_dynamic_variables?: {
|
|
1783
|
+
[key: string]: string;
|
|
1784
|
+
};
|
|
1785
|
+
};
|
|
1786
|
+
ChatAgentVersionListResponse: components["schemas"]["ChatAgentVersion"][] | {
|
|
1787
|
+
data?: components["schemas"]["ChatAgentVersion"][];
|
|
1788
|
+
};
|
|
1789
|
+
ChatListResponse: components["schemas"]["Chat"][] | components["schemas"]["ChatListEnvelope"];
|
|
1790
|
+
Chat: {
|
|
1791
|
+
chatId: string;
|
|
1792
|
+
agentId: string;
|
|
1793
|
+
version?: number | null;
|
|
1794
|
+
status: string;
|
|
1795
|
+
/** @example web_chat */
|
|
1796
|
+
type?: string | null;
|
|
1797
|
+
metadata?: {
|
|
1798
|
+
[key: string]: unknown;
|
|
1799
|
+
} | null;
|
|
1800
|
+
customAttributes?: {
|
|
1801
|
+
[key: string]: unknown;
|
|
1802
|
+
};
|
|
1803
|
+
/** Format: date-time */
|
|
1804
|
+
startedAt?: string | null;
|
|
1805
|
+
/** Format: date-time */
|
|
1806
|
+
endedAt?: string | null;
|
|
1807
|
+
transcript?: string | null;
|
|
1808
|
+
messages: components["schemas"]["ChatMessage"][];
|
|
1809
|
+
chatCost?: {
|
|
1810
|
+
[key: string]: unknown;
|
|
1811
|
+
} | null;
|
|
1812
|
+
chatAnalysis?: {
|
|
1813
|
+
[key: string]: unknown;
|
|
1814
|
+
} | null;
|
|
1815
|
+
collectedDynamicVariables?: {
|
|
1816
|
+
[key: string]: unknown;
|
|
1817
|
+
};
|
|
1818
|
+
uponai_dynamic_variables?: {
|
|
1819
|
+
[key: string]: unknown;
|
|
1820
|
+
};
|
|
1821
|
+
overrideDynamicVariables?: {
|
|
1822
|
+
[key: string]: unknown;
|
|
1823
|
+
} | null;
|
|
1824
|
+
};
|
|
1825
|
+
ChatMessage: {
|
|
1826
|
+
/** @example assistant */
|
|
1827
|
+
role: string;
|
|
1828
|
+
/** @example I can help with pricing and onboarding. */
|
|
1829
|
+
content?: string | null;
|
|
1830
|
+
name?: string | null;
|
|
1831
|
+
tool_calls?: {
|
|
1832
|
+
[key: string]: unknown;
|
|
1833
|
+
}[];
|
|
1834
|
+
};
|
|
1835
|
+
ChatListEnvelope: {
|
|
1836
|
+
data?: components["schemas"]["Chat"][];
|
|
1837
|
+
pagination_key?: string | null;
|
|
1838
|
+
};
|
|
1839
|
+
CreateChatRequest: {
|
|
1840
|
+
workspaceId: number;
|
|
1841
|
+
agent_id: string;
|
|
1842
|
+
metadata?: {
|
|
1843
|
+
[key: string]: unknown;
|
|
1844
|
+
};
|
|
1845
|
+
uponai_dynamic_variables?: {
|
|
1846
|
+
[key: string]: string;
|
|
1847
|
+
};
|
|
1848
|
+
};
|
|
1849
|
+
CreateOutboundSmsChatRequest: components["schemas"]["CreateChatRequest"] & {
|
|
1850
|
+
/** @example +14155550100 */
|
|
1851
|
+
from_number: string;
|
|
1852
|
+
/** @example +14155550199 */
|
|
1853
|
+
to_number: string;
|
|
1854
|
+
};
|
|
1855
|
+
UpdateChatRequest: {
|
|
1856
|
+
workspaceId: number;
|
|
1857
|
+
metadata?: {
|
|
1858
|
+
[key: string]: unknown;
|
|
1859
|
+
};
|
|
1860
|
+
custom_attributes?: {
|
|
1861
|
+
[key: string]: unknown;
|
|
1862
|
+
};
|
|
1863
|
+
override_dynamic_variables?: {
|
|
1864
|
+
[key: string]: unknown;
|
|
1865
|
+
};
|
|
1866
|
+
};
|
|
1867
|
+
CreateChatCompletionRequest: {
|
|
1868
|
+
workspaceId: number;
|
|
1869
|
+
content: string;
|
|
1870
|
+
};
|
|
1871
|
+
ChatCompletionResponse: {
|
|
1872
|
+
messages: components["schemas"]["ChatMessage"][];
|
|
1873
|
+
};
|
|
1874
|
+
ChatWidgetConfig: {
|
|
1875
|
+
id: number;
|
|
1876
|
+
/**
|
|
1877
|
+
* @description Public key used by the embeddable browser script.
|
|
1878
|
+
* @example upon_widget_7d41a8d0c84f4d1fbf8ad4f1
|
|
1879
|
+
*/
|
|
1880
|
+
publicKey: string;
|
|
1881
|
+
workspaceId: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* @description Chat agent that powers this widget.
|
|
1884
|
+
* @example chat_agent_01hzk4q6dr3n0d4qzpw9z6gth6
|
|
1885
|
+
*/
|
|
1886
|
+
agentId: string;
|
|
1887
|
+
/** @description Optional fixed chat agent version. Null uses the latest published version. */
|
|
1888
|
+
agentVersion?: number | null;
|
|
1889
|
+
/** @example How can we help? */
|
|
1890
|
+
title: string;
|
|
1891
|
+
/** Format: uri */
|
|
1892
|
+
logoUrl?: string | null;
|
|
1893
|
+
/** @example #071a3e */
|
|
1894
|
+
themeColor: string;
|
|
1895
|
+
/** @example #2563eb */
|
|
1896
|
+
componentColor: string;
|
|
1897
|
+
/** @example Need help? */
|
|
1898
|
+
fabText?: string;
|
|
1899
|
+
/** @example Support */
|
|
1900
|
+
botName?: string;
|
|
1901
|
+
/** @example Questions? We are here. */
|
|
1902
|
+
popupMessage?: string | null;
|
|
1903
|
+
showAiPopup?: boolean;
|
|
1904
|
+
/** @description Seconds to wait before showing the popup prompt. */
|
|
1905
|
+
showAiPopupTime?: number;
|
|
1906
|
+
autoOpen?: boolean;
|
|
1907
|
+
/** @description Website origins allowed to load and use this widget. Empty allows any origin; use exact origins such as https://example.com for production embeds. */
|
|
1908
|
+
allowedOrigins?: string[];
|
|
1909
|
+
metadata?: {
|
|
1910
|
+
[key: string]: unknown;
|
|
1911
|
+
};
|
|
1912
|
+
isEnabled?: boolean;
|
|
1913
|
+
/**
|
|
1914
|
+
* @description Complete script tag to paste into a website.
|
|
1915
|
+
* @example <script src="https://api.upon-ai.com/js/upon-chat-widget.js" data-public-key="upon_widget_7d41a8d0c84f4d1fbf8ad4f1" async></script>
|
|
1916
|
+
*/
|
|
1917
|
+
embedScript: string;
|
|
1918
|
+
};
|
|
1919
|
+
CreateChatWidgetRequest: {
|
|
1920
|
+
workspaceId: number;
|
|
1921
|
+
/** @description Chat agent that powers the widget. */
|
|
1922
|
+
agentId: string;
|
|
1923
|
+
agentVersion?: number | null;
|
|
1924
|
+
/** @default Chat */
|
|
1925
|
+
title: string;
|
|
1926
|
+
/** Format: uri */
|
|
1927
|
+
logoUrl?: string | null;
|
|
1928
|
+
/**
|
|
1929
|
+
* @description Shorthand that sets both themeColor and componentColor when specific colors are omitted.
|
|
1930
|
+
* @example #2563eb
|
|
1931
|
+
*/
|
|
1932
|
+
color?: string;
|
|
1933
|
+
/** @default #071a3e */
|
|
1934
|
+
themeColor: string;
|
|
1935
|
+
/** @default #3E6AEF */
|
|
1936
|
+
componentColor: string;
|
|
1937
|
+
/** @default Need support? */
|
|
1938
|
+
fabText: string;
|
|
1939
|
+
/** @default AI Assistant */
|
|
1940
|
+
botName: string;
|
|
1941
|
+
popupMessage?: string | null;
|
|
1942
|
+
/** @default true */
|
|
1943
|
+
showAiPopup: boolean;
|
|
1944
|
+
/** @default 5 */
|
|
1945
|
+
showAiPopupTime: number;
|
|
1946
|
+
/** @default false */
|
|
1947
|
+
autoOpen: boolean;
|
|
1948
|
+
allowedOrigins?: string[];
|
|
1949
|
+
metadata?: {
|
|
1950
|
+
[key: string]: unknown;
|
|
1951
|
+
};
|
|
1952
|
+
};
|
|
1953
|
+
UpdateChatWidgetRequest: {
|
|
1954
|
+
/** @description Chat agent that powers the widget. */
|
|
1955
|
+
agentId?: string;
|
|
1956
|
+
agentVersion?: number | null;
|
|
1957
|
+
title?: string;
|
|
1958
|
+
/** Format: uri */
|
|
1959
|
+
logoUrl?: string | null;
|
|
1960
|
+
/** @description Shorthand that sets both themeColor and componentColor when specific colors are omitted. */
|
|
1961
|
+
color?: string;
|
|
1962
|
+
themeColor?: string;
|
|
1963
|
+
componentColor?: string;
|
|
1964
|
+
fabText?: string;
|
|
1965
|
+
botName?: string;
|
|
1966
|
+
popupMessage?: string | null;
|
|
1967
|
+
showAiPopup?: boolean;
|
|
1968
|
+
showAiPopupTime?: number;
|
|
1969
|
+
autoOpen?: boolean;
|
|
1970
|
+
allowedOrigins?: string[];
|
|
1971
|
+
metadata?: {
|
|
1972
|
+
[key: string]: unknown;
|
|
1973
|
+
};
|
|
1974
|
+
isEnabled?: boolean;
|
|
1975
|
+
};
|
|
1976
|
+
ConversationFlowSummary: {
|
|
1977
|
+
conversation_flow_id: string;
|
|
1978
|
+
version: number;
|
|
1979
|
+
start_speaker?: string | null;
|
|
1980
|
+
};
|
|
1981
|
+
CreateConversationFlowRequest: {
|
|
1982
|
+
workspaceId: number;
|
|
1983
|
+
global_prompt?: string;
|
|
1984
|
+
start_speaker: string;
|
|
1985
|
+
model_choice?: components["schemas"]["ModelChoice"];
|
|
1986
|
+
nodes: components["schemas"]["ConversationNode"][];
|
|
1987
|
+
};
|
|
1988
|
+
ModelChoice: {
|
|
1989
|
+
type: string;
|
|
1990
|
+
model?: string;
|
|
1991
|
+
};
|
|
1992
|
+
ConversationNode: {
|
|
1993
|
+
id: string;
|
|
1994
|
+
type: string;
|
|
1995
|
+
instruction?: components["schemas"]["Instruction"];
|
|
1996
|
+
edges?: components["schemas"]["ConversationEdge"][];
|
|
1997
|
+
};
|
|
1998
|
+
Instruction: {
|
|
1999
|
+
type: string;
|
|
2000
|
+
text?: string;
|
|
2001
|
+
};
|
|
2002
|
+
ConversationEdge: {
|
|
2003
|
+
id: string;
|
|
2004
|
+
transition_condition: {
|
|
2005
|
+
type: string;
|
|
2006
|
+
prompt?: string;
|
|
2007
|
+
};
|
|
2008
|
+
destination_node_id: string;
|
|
2009
|
+
};
|
|
2010
|
+
ConversationFlow: components["schemas"]["ConversationFlowSummary"] & {
|
|
2011
|
+
workspaceId?: number | null;
|
|
2012
|
+
global_prompt?: string | null;
|
|
2013
|
+
start_speaker?: string | null;
|
|
2014
|
+
model_choice?: components["schemas"]["ModelChoice"];
|
|
2015
|
+
nodes?: components["schemas"]["ConversationNode"][];
|
|
2016
|
+
};
|
|
2017
|
+
UpdateConversationFlowRequest: {
|
|
2018
|
+
workspaceId: number;
|
|
2019
|
+
global_prompt?: string;
|
|
2020
|
+
model_choice?: components["schemas"]["ModelChoice"];
|
|
2021
|
+
nodes?: components["schemas"]["ConversationNode"][];
|
|
2022
|
+
};
|
|
2023
|
+
KnowledgeBaseSummary: {
|
|
2024
|
+
/** @example knowledge_base_17c5db1600cea2b4 */
|
|
2025
|
+
knowledgeBaseId: string;
|
|
2026
|
+
/** @example Customer Support FAQ */
|
|
2027
|
+
name: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* @example processing
|
|
2030
|
+
* @enum {string}
|
|
2031
|
+
*/
|
|
2032
|
+
status: "pending" | "processing" | "ready" | "failed";
|
|
2033
|
+
};
|
|
2034
|
+
CreateKnowledgeBaseRequest: {
|
|
2035
|
+
workspaceId: number;
|
|
2036
|
+
name: string;
|
|
2037
|
+
/** @example Grounding material for customer support. */
|
|
2038
|
+
description?: string;
|
|
2039
|
+
/**
|
|
2040
|
+
* @description Automatically refresh URL-based sources on the provider cadence.
|
|
2041
|
+
* @example false
|
|
2042
|
+
*/
|
|
2043
|
+
enableAutoRefresh?: boolean;
|
|
2044
|
+
/** @example 2000 */
|
|
2045
|
+
maxChunkSize?: number;
|
|
2046
|
+
/** @example 400 */
|
|
2047
|
+
minChunkSize?: number;
|
|
2048
|
+
sources?: components["schemas"]["KnowledgeBaseSourceInput"][];
|
|
2049
|
+
};
|
|
2050
|
+
KnowledgeBaseSourceInput: {
|
|
2051
|
+
/** @enum {string} */
|
|
2052
|
+
type: "text" | "url" | "document";
|
|
2053
|
+
/** @example We issue refunds within 30 days of purchase. */
|
|
2054
|
+
text?: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* @description Optional display title for text sources. If omitted, one is generated automatically.
|
|
2057
|
+
* @example Refund Policy
|
|
2058
|
+
*/
|
|
2059
|
+
title?: string;
|
|
2060
|
+
/**
|
|
2061
|
+
* Format: uri
|
|
2062
|
+
* @example https://example.com/help/refunds
|
|
2063
|
+
*/
|
|
2064
|
+
url?: string;
|
|
2065
|
+
/** @example handbook.pdf */
|
|
2066
|
+
filename?: string;
|
|
2067
|
+
/** @example application/pdf */
|
|
2068
|
+
contentType?: string;
|
|
2069
|
+
/**
|
|
2070
|
+
* @description Base64-encoded file contents for document sources.
|
|
2071
|
+
* @example JVBERi0xLjQKJcfs...
|
|
2072
|
+
*/
|
|
2073
|
+
base64?: string;
|
|
2074
|
+
};
|
|
2075
|
+
KnowledgeBase: components["schemas"]["KnowledgeBaseSummary"] & {
|
|
2076
|
+
/** @example Grounding material for support agents. */
|
|
2077
|
+
description?: string | null;
|
|
2078
|
+
sources?: components["schemas"]["KnowledgeBaseSource"][];
|
|
2079
|
+
/** @example 58 */
|
|
2080
|
+
workspaceId?: number | null;
|
|
2081
|
+
/** @example false */
|
|
2082
|
+
enableAutoRefresh?: boolean;
|
|
2083
|
+
/** @example 1773937556128 */
|
|
2084
|
+
lastRefreshedTimestamp?: number | null;
|
|
2085
|
+
/** @example 2000 */
|
|
2086
|
+
maxChunkSize?: number | null;
|
|
2087
|
+
/** @example 400 */
|
|
2088
|
+
minChunkSize?: number | null;
|
|
2089
|
+
/**
|
|
2090
|
+
* Format: date-time
|
|
2091
|
+
* @example 2026-03-19T13:25:56.128Z
|
|
2092
|
+
*/
|
|
2093
|
+
createdAt?: string | null;
|
|
2094
|
+
/**
|
|
2095
|
+
* Format: date-time
|
|
2096
|
+
* @example 2026-03-19T13:26:12.512Z
|
|
2097
|
+
*/
|
|
2098
|
+
updatedAt?: string | null;
|
|
2099
|
+
};
|
|
2100
|
+
KnowledgeBaseSource: components["schemas"]["KnowledgeBaseSourceDocument"] | components["schemas"]["KnowledgeBaseSourceText"] | components["schemas"]["KnowledgeBaseSourceUrl"];
|
|
2101
|
+
KnowledgeBaseSourceDocument: {
|
|
2102
|
+
/** @example kb_source_35e085a611328bd3 */
|
|
2103
|
+
source_id: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* @example document
|
|
2106
|
+
* @enum {string}
|
|
2107
|
+
*/
|
|
2108
|
+
type: "document";
|
|
2109
|
+
/** @example benefits-guide.pdf */
|
|
2110
|
+
filename?: string | null;
|
|
2111
|
+
/** @example https://cdn.example.com/knowledge-bases/benefits-guide.pdf */
|
|
2112
|
+
file_url?: string | null;
|
|
2113
|
+
/** @example 482311 */
|
|
2114
|
+
file_size?: number | null;
|
|
2115
|
+
};
|
|
2116
|
+
KnowledgeBaseSourceText: {
|
|
2117
|
+
/** @example kb_source_41f4dfd2f142bf07 */
|
|
2118
|
+
source_id: string;
|
|
2119
|
+
/**
|
|
2120
|
+
* @example text
|
|
2121
|
+
* @enum {string}
|
|
2122
|
+
*/
|
|
2123
|
+
type: "text";
|
|
2124
|
+
/** @example Refund Policy */
|
|
2125
|
+
title?: string | null;
|
|
2126
|
+
/** @example https://cdn.example.com/knowledge-bases/refund-policy.txt */
|
|
2127
|
+
content_url?: string | null;
|
|
2128
|
+
};
|
|
2129
|
+
KnowledgeBaseSourceUrl: {
|
|
2130
|
+
/** @example kb_source_803751f5c87eab66 */
|
|
2131
|
+
source_id: string;
|
|
2132
|
+
/**
|
|
2133
|
+
* @example url
|
|
2134
|
+
* @enum {string}
|
|
2135
|
+
*/
|
|
2136
|
+
type: "url";
|
|
2137
|
+
/**
|
|
2138
|
+
* Format: uri
|
|
2139
|
+
* @example https://metro-ride.com/careers/
|
|
2140
|
+
*/
|
|
2141
|
+
url?: string;
|
|
2142
|
+
};
|
|
2143
|
+
AddKnowledgeBaseSourcesRequest: {
|
|
2144
|
+
/** @example 58 */
|
|
2145
|
+
workspaceId: number;
|
|
2146
|
+
sources: components["schemas"]["KnowledgeBaseSourceInput"][];
|
|
2147
|
+
};
|
|
2148
|
+
Voice: {
|
|
2149
|
+
voiceId: string;
|
|
2150
|
+
name: string;
|
|
2151
|
+
gender?: string;
|
|
2152
|
+
language?: string;
|
|
2153
|
+
accent?: string;
|
|
2154
|
+
description?: string;
|
|
2155
|
+
provider?: string | null;
|
|
2156
|
+
/** Format: uri */
|
|
2157
|
+
previewUrl?: string;
|
|
2158
|
+
/** Format: uri */
|
|
2159
|
+
playbackOverrideUrl?: string | null;
|
|
2160
|
+
tags?: string[];
|
|
2161
|
+
/** Format: date-time */
|
|
2162
|
+
createdAt?: string | null;
|
|
2163
|
+
/** Format: date-time */
|
|
2164
|
+
updatedAt?: string | null;
|
|
2165
|
+
};
|
|
2166
|
+
SearchCommunityVoiceRequest: {
|
|
2167
|
+
workspaceId: number;
|
|
2168
|
+
/** @enum {string} */
|
|
2169
|
+
voiceProvider?: "elevenlabs" | "cartesia" | "minimax";
|
|
2170
|
+
searchQuery: string;
|
|
2171
|
+
};
|
|
2172
|
+
SearchCommunityVoiceResponse: {
|
|
2173
|
+
voices: components["schemas"]["SearchCommunityVoiceItem"][];
|
|
2174
|
+
};
|
|
2175
|
+
SearchCommunityVoiceItem: {
|
|
2176
|
+
providerVoiceId?: string;
|
|
2177
|
+
name?: string;
|
|
2178
|
+
description?: string | null;
|
|
2179
|
+
publicUserId?: string | null;
|
|
2180
|
+
/** @enum {string|null} */
|
|
2181
|
+
voiceProvider?: "elevenlabs" | "cartesia" | "minimax" | null;
|
|
2182
|
+
};
|
|
2183
|
+
AddCommunityVoiceRequest: {
|
|
2184
|
+
workspaceId: number;
|
|
2185
|
+
/**
|
|
2186
|
+
* @default elevenlabs
|
|
2187
|
+
* @enum {string}
|
|
2188
|
+
*/
|
|
2189
|
+
voiceProvider: "elevenlabs" | "cartesia" | "minimax";
|
|
2190
|
+
providerVoiceId: string;
|
|
2191
|
+
voiceName: string;
|
|
2192
|
+
publicUserId?: string | null;
|
|
2193
|
+
};
|
|
2194
|
+
CloneVoiceRequest: {
|
|
2195
|
+
workspaceId: number;
|
|
2196
|
+
/**
|
|
2197
|
+
* @default elevenlabs
|
|
2198
|
+
* @enum {string}
|
|
2199
|
+
*/
|
|
2200
|
+
voiceProvider: "elevenlabs" | "cartesia" | "minimax";
|
|
2201
|
+
voiceName: string;
|
|
2202
|
+
files: string[];
|
|
2203
|
+
};
|
|
2204
|
+
TestCaseDefinition: components["schemas"]["TestCaseDefinitionInput"] & {
|
|
2205
|
+
test_case_definition_id: string;
|
|
2206
|
+
type?: string;
|
|
2207
|
+
creation_timestamp?: number;
|
|
2208
|
+
user_modified_timestamp?: number;
|
|
2209
|
+
};
|
|
2210
|
+
TestCaseDefinitionInput: {
|
|
2211
|
+
name?: string;
|
|
2212
|
+
response_engine?: components["schemas"]["TestResponseEngine"];
|
|
2213
|
+
user_prompt?: string;
|
|
2214
|
+
metrics?: string[];
|
|
2215
|
+
dynamic_variables?: {
|
|
2216
|
+
[key: string]: string;
|
|
2217
|
+
};
|
|
2218
|
+
tool_mocks?: {
|
|
2219
|
+
[key: string]: unknown;
|
|
2220
|
+
}[];
|
|
2221
|
+
llm_model?: string | null;
|
|
2222
|
+
};
|
|
2223
|
+
TestResponseEngine: {
|
|
2224
|
+
/** @enum {string} */
|
|
2225
|
+
type: "llm" | "conversation-flow";
|
|
2226
|
+
llm_id?: string | null;
|
|
2227
|
+
conversation_flow_id?: string | null;
|
|
2228
|
+
version?: number | null;
|
|
2229
|
+
};
|
|
2230
|
+
CreateTestCaseDefinitionRequest: components["schemas"]["TestCaseDefinitionInput"] & {
|
|
2231
|
+
workspaceId: number;
|
|
2232
|
+
};
|
|
2233
|
+
BatchTest: {
|
|
2234
|
+
test_case_batch_job_id: string;
|
|
2235
|
+
/** @enum {string} */
|
|
2236
|
+
status: "in_progress" | "complete";
|
|
2237
|
+
response_engine?: components["schemas"]["TestResponseEngine"];
|
|
2238
|
+
pass_count?: number;
|
|
2239
|
+
fail_count?: number;
|
|
2240
|
+
error_count?: number;
|
|
2241
|
+
total_count?: number;
|
|
2242
|
+
creation_timestamp?: number;
|
|
2243
|
+
user_modified_timestamp?: number;
|
|
2244
|
+
};
|
|
2245
|
+
CreateBatchTestRequest: {
|
|
2246
|
+
workspaceId: number;
|
|
2247
|
+
response_engine: components["schemas"]["TestResponseEngine"];
|
|
2248
|
+
test_case_definition_ids: string[];
|
|
2249
|
+
};
|
|
2250
|
+
UpdateTestCaseDefinitionRequest: components["schemas"]["TestCaseDefinitionInput"] & {
|
|
2251
|
+
workspaceId: number;
|
|
2252
|
+
};
|
|
2253
|
+
TestRun: {
|
|
2254
|
+
test_case_job_id: string;
|
|
2255
|
+
status: string;
|
|
2256
|
+
test_case_definition_id?: string;
|
|
2257
|
+
test_case_definition_snapshot?: components["schemas"]["TestCaseDefinition"];
|
|
2258
|
+
transcript_snapshot?: {
|
|
2259
|
+
[key: string]: unknown;
|
|
2260
|
+
} | null;
|
|
2261
|
+
result_explanation?: string | null;
|
|
2262
|
+
creation_timestamp?: number;
|
|
2263
|
+
user_modified_timestamp?: number;
|
|
2264
|
+
};
|
|
2265
|
+
Concurrency: {
|
|
2266
|
+
maxConcurrent: number;
|
|
2267
|
+
currentUsage: number;
|
|
2268
|
+
purchasedConcurrency?: number;
|
|
2269
|
+
concurrencyPurchaseLimit?: number;
|
|
2270
|
+
};
|
|
2271
|
+
WorkspaceSummary: {
|
|
2272
|
+
id: number;
|
|
2273
|
+
name: string;
|
|
2274
|
+
accountSid?: string | null;
|
|
2275
|
+
accountPath?: string | null;
|
|
2276
|
+
nativeTransferEnabled: boolean;
|
|
2277
|
+
};
|
|
2278
|
+
/** @description Unknown top-level fields return HTTP 400 before a call is created. Supply dynamic variables using the documented field, with string values only. */
|
|
2279
|
+
CreatePhoneCallRequest: {
|
|
2280
|
+
/** @description Unique agent identifier. The owning workspace is inferred from this value. */
|
|
2281
|
+
agentId: string;
|
|
2282
|
+
/** @description Optional backward-compatible workspace hint. If supplied, it must match the workspace that owns agentId. */
|
|
2283
|
+
workspaceId?: number;
|
|
2284
|
+
/** @description Caller identifier. For native-transfer workspaces this may be an imported number, extension, or platform-side pseudo DID when ignoreE164Validation is enabled. */
|
|
2285
|
+
fromNumber: string;
|
|
2286
|
+
/** @description Destination identifier to dial. Standard phone calls should use E.164; native-transfer workspaces can also use configured extensions or pseudo numbers when ignoreE164Validation is enabled. */
|
|
2287
|
+
toNumber: string;
|
|
2288
|
+
customerName?: string;
|
|
2289
|
+
carrierName?: string;
|
|
2290
|
+
trunkName?: string;
|
|
2291
|
+
/** @description Optional SIP From display-name override. The selected fromNumber remains the actual caller ID/user part for native-transfer calls. */
|
|
2292
|
+
overrideCid?: string;
|
|
2293
|
+
/**
|
|
2294
|
+
* @description Native-transfer only. Format applied to the caller ID before the outbound leg is dialed.
|
|
2295
|
+
* @enum {string}
|
|
2296
|
+
*/
|
|
2297
|
+
callerIdFormat?: "10-digit" | "11-digit" | "e164";
|
|
2298
|
+
/**
|
|
2299
|
+
* @description Native-transfer only. Format applied to the destination number before the outbound leg is dialed.
|
|
2300
|
+
* @enum {string}
|
|
2301
|
+
*/
|
|
2302
|
+
toNumberFormat?: "10-digit" | "11-digit" | "e164";
|
|
2303
|
+
/** @description Native-transfer only. Overrides the agent version for this specific call. */
|
|
2304
|
+
overrideAgentVersion?: number;
|
|
2305
|
+
agentOverride?: components["schemas"]["CallAgentOverrideRequest"];
|
|
2306
|
+
/** @description Optional custom caller identifier used when fromNumber is set to custom. This may be a configured non-E.164 identifier on supported trunk-based workspaces. */
|
|
2307
|
+
customFromNumber?: string;
|
|
2308
|
+
/**
|
|
2309
|
+
* Format: uri
|
|
2310
|
+
* @description Per-call destination for branded call_started, call_ended, and call_analyzed events.
|
|
2311
|
+
*/
|
|
2312
|
+
customStatusHookUrl?: string;
|
|
2313
|
+
metadata?: {
|
|
2314
|
+
[key: string]: string;
|
|
2315
|
+
};
|
|
2316
|
+
/** @description Native-transfer only. Additional SIP headers merged into the outbound call request. */
|
|
2317
|
+
customSipHeaders?: {
|
|
2318
|
+
[key: string]: string;
|
|
2319
|
+
};
|
|
2320
|
+
/** @description Native-transfer only. Disables E.164 validation so imported pseudo DIDs, extensions, and other custom telephony identifiers can be used. The platform may also enable this automatically when needed on supported workspaces. */
|
|
2321
|
+
ignoreE164Validation?: boolean;
|
|
2322
|
+
/** @description Dynamic variables with string values only (including empty strings). CamelCase variable containers are not supported. */
|
|
2323
|
+
uponai_dynamic_variables?: {
|
|
2324
|
+
[key: string]: string;
|
|
2325
|
+
};
|
|
2326
|
+
/** @description Alias for overrideAgentVersion. */
|
|
2327
|
+
override_agent_version?: number;
|
|
2328
|
+
agent_override?: components["schemas"]["CallAgentOverrideRequest"];
|
|
2329
|
+
/** @description Alias for customSipHeaders. */
|
|
2330
|
+
custom_sip_headers?: {
|
|
2331
|
+
[key: string]: string;
|
|
2332
|
+
};
|
|
2333
|
+
/** @description Alias for ignoreE164Validation. */
|
|
2334
|
+
ignore_e164_validation?: boolean;
|
|
2335
|
+
};
|
|
2336
|
+
CallAgentOverrideRequest: {
|
|
2337
|
+
agent?: components["schemas"]["CallAgentConfigOverride"];
|
|
2338
|
+
llm?: components["schemas"]["CallLlmOverride"];
|
|
2339
|
+
conversationFlow?: components["schemas"]["CallConversationFlowOverride"];
|
|
2340
|
+
};
|
|
2341
|
+
CallAgentConfigOverride: {
|
|
2342
|
+
agentName?: string;
|
|
2343
|
+
versionDescription?: string;
|
|
2344
|
+
voiceId?: string;
|
|
2345
|
+
responseEngine?: {
|
|
2346
|
+
[key: string]: unknown;
|
|
2347
|
+
};
|
|
2348
|
+
responseThreshold?: number;
|
|
2349
|
+
interruptionSensitivity?: string;
|
|
2350
|
+
ambientSound?: string;
|
|
2351
|
+
responsiveness?: string;
|
|
2352
|
+
maxCallDurationMs?: number;
|
|
2353
|
+
beginMessageDelayMs?: number;
|
|
2354
|
+
} & {
|
|
2355
|
+
[key: string]: unknown;
|
|
2356
|
+
};
|
|
2357
|
+
CallLlmOverride: {
|
|
2358
|
+
model?: string;
|
|
2359
|
+
s2sModel?: string;
|
|
2360
|
+
modelTemperature?: number;
|
|
2361
|
+
modelHighPriority?: boolean;
|
|
2362
|
+
toolCallStrictMode?: boolean;
|
|
2363
|
+
knowledgeBaseIds?: string[];
|
|
2364
|
+
kbConfig?: {
|
|
2365
|
+
[key: string]: unknown;
|
|
2366
|
+
};
|
|
2367
|
+
/** @enum {string} */
|
|
2368
|
+
startSpeaker?: "user" | "agent";
|
|
2369
|
+
beginAfterUserSilenceMs?: number;
|
|
2370
|
+
beginMessage?: string;
|
|
2371
|
+
} & {
|
|
2372
|
+
[key: string]: unknown;
|
|
2373
|
+
};
|
|
2374
|
+
CallConversationFlowOverride: {
|
|
2375
|
+
modelChoice?: components["schemas"]["ModelChoice"];
|
|
2376
|
+
modelTemperature?: number;
|
|
2377
|
+
toolCallStrictMode?: boolean;
|
|
2378
|
+
knowledgeBaseIds?: string[];
|
|
2379
|
+
kbConfig?: {
|
|
2380
|
+
[key: string]: unknown;
|
|
2381
|
+
};
|
|
2382
|
+
/** @enum {string} */
|
|
2383
|
+
startSpeaker?: "user" | "agent";
|
|
2384
|
+
beginAfterUserSilenceMs?: number;
|
|
2385
|
+
} & {
|
|
2386
|
+
[key: string]: unknown;
|
|
2387
|
+
};
|
|
2388
|
+
CreatePhoneCallResponse: {
|
|
2389
|
+
success?: boolean;
|
|
2390
|
+
call_sid?: string;
|
|
2391
|
+
call?: components["schemas"]["CallDetail"];
|
|
2392
|
+
};
|
|
2393
|
+
CallDetail: {
|
|
2394
|
+
success?: boolean;
|
|
2395
|
+
call?: components["schemas"]["CallRecord"];
|
|
2396
|
+
} & {
|
|
2397
|
+
[key: string]: unknown;
|
|
2398
|
+
};
|
|
2399
|
+
CallRecord: {
|
|
2400
|
+
callId?: string;
|
|
2401
|
+
callType?: string;
|
|
2402
|
+
status?: string;
|
|
2403
|
+
agentId?: string;
|
|
2404
|
+
agentVersion?: number;
|
|
2405
|
+
metadata?: {
|
|
2406
|
+
[key: string]: string;
|
|
2407
|
+
};
|
|
2408
|
+
optOutSensitiveDataStorage?: boolean;
|
|
2409
|
+
accessToken?: string | null;
|
|
2410
|
+
/** Format: date-time */
|
|
2411
|
+
expiresAt?: string | null;
|
|
2412
|
+
/** Format: uri */
|
|
2413
|
+
webCallUrl?: string | null;
|
|
2414
|
+
uponai_dynamic_variables?: {
|
|
2415
|
+
[key: string]: string;
|
|
2416
|
+
};
|
|
2417
|
+
};
|
|
2418
|
+
CreateWebCallRequest: {
|
|
2419
|
+
/** @description Optional backward-compatible workspace hint. If supplied, it must match the workspace that owns agentId. */
|
|
2420
|
+
workspaceId?: number;
|
|
2421
|
+
/** @description Unique agent identifier. The owning workspace is inferred from this value. */
|
|
2422
|
+
agentId: string;
|
|
2423
|
+
agentVersion?: number;
|
|
2424
|
+
metadata?: {
|
|
2425
|
+
[key: string]: string;
|
|
2426
|
+
};
|
|
2427
|
+
uponai_dynamic_variables?: {
|
|
2428
|
+
[key: string]: string;
|
|
2429
|
+
};
|
|
2430
|
+
};
|
|
2431
|
+
WebCall: {
|
|
2432
|
+
callId: string;
|
|
2433
|
+
callType?: string;
|
|
2434
|
+
status: string;
|
|
2435
|
+
agentId?: string;
|
|
2436
|
+
agentVersion?: number;
|
|
2437
|
+
metadata?: {
|
|
2438
|
+
[key: string]: string;
|
|
2439
|
+
};
|
|
2440
|
+
optOutSensitiveDataStorage?: boolean;
|
|
2441
|
+
accessToken?: string | null;
|
|
2442
|
+
/** Format: date-time */
|
|
2443
|
+
expiresAt?: string | null;
|
|
2444
|
+
/** Format: uri */
|
|
2445
|
+
webCallUrl?: string | null;
|
|
2446
|
+
uponai_dynamic_variables?: {
|
|
2447
|
+
[key: string]: string;
|
|
2448
|
+
};
|
|
2449
|
+
};
|
|
2450
|
+
CallList: {
|
|
2451
|
+
success: boolean;
|
|
2452
|
+
calls: components["schemas"]["CallRecord"][];
|
|
2453
|
+
total?: number;
|
|
2454
|
+
pages?: number;
|
|
2455
|
+
currentPage?: number;
|
|
2456
|
+
};
|
|
2457
|
+
V3ListCallsRequest: {
|
|
2458
|
+
/** @description Optional branded extension to scope results to one accessible workspace. */
|
|
2459
|
+
workspaceId?: number;
|
|
2460
|
+
filter_criteria?: components["schemas"]["CallFilter"];
|
|
2461
|
+
/**
|
|
2462
|
+
* @description Sort calls by start timestamp.
|
|
2463
|
+
* @default descending
|
|
2464
|
+
* @enum {string}
|
|
2465
|
+
*/
|
|
2466
|
+
sort_order: "ascending" | "descending";
|
|
2467
|
+
/**
|
|
2468
|
+
* @description Maximum number of calls to return.
|
|
2469
|
+
* @default 50
|
|
2470
|
+
*/
|
|
2471
|
+
limit: number;
|
|
2472
|
+
/**
|
|
2473
|
+
* @description Number of records to skip for pagination.
|
|
2474
|
+
* @default 0
|
|
2475
|
+
*/
|
|
2476
|
+
skip: number;
|
|
2477
|
+
/** @description Pagination key from the previous response. */
|
|
2478
|
+
pagination_key?: string;
|
|
2479
|
+
/**
|
|
2480
|
+
* @description Whether to include the total count of matching calls.
|
|
2481
|
+
* @default false
|
|
2482
|
+
*/
|
|
2483
|
+
include_total: boolean;
|
|
2484
|
+
};
|
|
2485
|
+
/** @description Filter criteria for calls. All provided conditions are combined with AND. */
|
|
2486
|
+
CallFilter: {
|
|
2487
|
+
/** @description Agent filters are combined with OR. */
|
|
2488
|
+
agent?: components["schemas"]["AgentFilter"][];
|
|
2489
|
+
call_id?: components["schemas"]["StringFilter"] | components["schemas"]["EnumFilter"];
|
|
2490
|
+
batch_call_id?: components["schemas"]["StringFilter"];
|
|
2491
|
+
call_status?: components["schemas"]["EnumFilter"];
|
|
2492
|
+
in_voicemail?: components["schemas"]["BooleanFilter"];
|
|
2493
|
+
disconnection_reason?: components["schemas"]["EnumFilter"];
|
|
2494
|
+
from_number?: components["schemas"]["StringFilter"];
|
|
2495
|
+
to_number?: components["schemas"]["StringFilter"];
|
|
2496
|
+
call_type?: components["schemas"]["EnumFilter"];
|
|
2497
|
+
direction?: components["schemas"]["EnumFilter"];
|
|
2498
|
+
user_sentiment?: components["schemas"]["EnumFilter"];
|
|
2499
|
+
data_storage_setting?: components["schemas"]["EnumFilter"];
|
|
2500
|
+
call_successful?: components["schemas"]["BooleanFilter"];
|
|
2501
|
+
start_timestamp?: components["schemas"]["NumberFilter"] | components["schemas"]["RangeFilter"];
|
|
2502
|
+
end_timestamp?: components["schemas"]["NumberFilter"] | components["schemas"]["RangeFilter"];
|
|
2503
|
+
duration_ms?: components["schemas"]["NumberFilter"] | components["schemas"]["RangeFilter"];
|
|
2504
|
+
combined_cost?: components["schemas"]["NumberFilter"] | components["schemas"]["RangeFilter"];
|
|
2505
|
+
};
|
|
2506
|
+
AgentFilter: {
|
|
2507
|
+
agent_id: string;
|
|
2508
|
+
version?: number[];
|
|
2509
|
+
};
|
|
2510
|
+
StringFilter: {
|
|
2511
|
+
/** @enum {string} */
|
|
2512
|
+
type: "string";
|
|
2513
|
+
/**
|
|
2514
|
+
* @description Equal, not equal, starts with, ends with, or contains.
|
|
2515
|
+
* @enum {string}
|
|
2516
|
+
*/
|
|
2517
|
+
op: "eq" | "ne" | "sw" | "ew" | "co";
|
|
2518
|
+
value: string;
|
|
2519
|
+
};
|
|
2520
|
+
EnumFilter: {
|
|
2521
|
+
/** @enum {string} */
|
|
2522
|
+
type: "enum";
|
|
2523
|
+
/** @enum {string} */
|
|
2524
|
+
op: "in";
|
|
2525
|
+
value: string[];
|
|
2526
|
+
};
|
|
2527
|
+
BooleanFilter: {
|
|
2528
|
+
/** @enum {string} */
|
|
2529
|
+
type: "boolean";
|
|
2530
|
+
/** @enum {string} */
|
|
2531
|
+
op: "eq";
|
|
2532
|
+
value: boolean;
|
|
2533
|
+
};
|
|
2534
|
+
NumberFilter: {
|
|
2535
|
+
/** @enum {string} */
|
|
2536
|
+
type: "number";
|
|
2537
|
+
/** @enum {string} */
|
|
2538
|
+
op: "eq" | "ne" | "gt" | "ge" | "lt" | "le";
|
|
2539
|
+
value: number;
|
|
2540
|
+
};
|
|
2541
|
+
RangeFilter: {
|
|
2542
|
+
/** @enum {string} */
|
|
2543
|
+
type: "range";
|
|
2544
|
+
/** @enum {string} */
|
|
2545
|
+
op: "bt";
|
|
2546
|
+
value: number[];
|
|
2547
|
+
};
|
|
2548
|
+
V3ListCallsResponse: {
|
|
2549
|
+
items: components["schemas"]["V3CallResponse"][];
|
|
2550
|
+
/** @description Pagination key for the next page, or null when no more results are available. */
|
|
2551
|
+
pagination_key: string | null;
|
|
2552
|
+
/** @description Whether more results are available. */
|
|
2553
|
+
has_more: boolean;
|
|
2554
|
+
/** @description Total number of matching calls. Present only when include_total is true. */
|
|
2555
|
+
total?: number;
|
|
2556
|
+
};
|
|
2557
|
+
V3CallResponse: components["schemas"]["V3WebCallResponse"] | components["schemas"]["V3PhoneCallResponse"];
|
|
2558
|
+
V3WebCallResponse: components["schemas"]["V3CallBase"] & {
|
|
2559
|
+
/** @enum {string} */
|
|
2560
|
+
call_type?: "web_call";
|
|
2561
|
+
access_token?: string | null;
|
|
2562
|
+
};
|
|
2563
|
+
V3CallBase: {
|
|
2564
|
+
call_id?: string;
|
|
2565
|
+
agent_id?: string;
|
|
2566
|
+
agent_name?: string | null;
|
|
2567
|
+
agent_version?: number | null;
|
|
2568
|
+
call_status?: string | null;
|
|
2569
|
+
/** @description Start timestamp in milliseconds since epoch. */
|
|
2570
|
+
start_timestamp?: number | null;
|
|
2571
|
+
/** @description End timestamp in milliseconds since epoch. */
|
|
2572
|
+
end_timestamp?: number | null;
|
|
2573
|
+
duration_ms?: number | null;
|
|
2574
|
+
disconnection_reason?: string | null;
|
|
2575
|
+
metadata?: {
|
|
2576
|
+
[key: string]: unknown;
|
|
2577
|
+
};
|
|
2578
|
+
transcript?: string | null;
|
|
2579
|
+
transcript_object?: {
|
|
2580
|
+
[key: string]: unknown;
|
|
2581
|
+
} | null;
|
|
2582
|
+
transcript_with_tool_calls?: {
|
|
2583
|
+
[key: string]: unknown;
|
|
2584
|
+
}[] | null;
|
|
2585
|
+
/** Format: uri */
|
|
2586
|
+
recording_url?: string | null;
|
|
2587
|
+
/** Format: uri */
|
|
2588
|
+
public_log_url?: string | null;
|
|
2589
|
+
call_analysis?: {
|
|
2590
|
+
[key: string]: unknown;
|
|
2591
|
+
};
|
|
2592
|
+
call_cost?: {
|
|
2593
|
+
[key: string]: unknown;
|
|
2594
|
+
};
|
|
2595
|
+
/** @enum {string|null} */
|
|
2596
|
+
data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only" | null;
|
|
2597
|
+
};
|
|
2598
|
+
V3PhoneCallResponse: components["schemas"]["V3CallBase"] & {
|
|
2599
|
+
/** @enum {string} */
|
|
2600
|
+
call_type?: "phone_call";
|
|
2601
|
+
from_number?: string | null;
|
|
2602
|
+
to_number?: string | null;
|
|
2603
|
+
direction?: string | null;
|
|
2604
|
+
};
|
|
2605
|
+
CallHistoryList: {
|
|
2606
|
+
success: boolean;
|
|
2607
|
+
calls: components["schemas"]["CallHistoryRecord"][];
|
|
2608
|
+
pagination: {
|
|
2609
|
+
page?: number;
|
|
2610
|
+
limit?: number;
|
|
2611
|
+
total?: number;
|
|
2612
|
+
pages?: number;
|
|
2613
|
+
};
|
|
2614
|
+
filters: components["schemas"]["CallHistoryFilters"];
|
|
2615
|
+
};
|
|
2616
|
+
CallHistoryRecord: {
|
|
2617
|
+
callSid: string;
|
|
2618
|
+
callStatus?: string | null;
|
|
2619
|
+
agentId?: string | null;
|
|
2620
|
+
agentVersion?: number | null;
|
|
2621
|
+
agentName?: string | null;
|
|
2622
|
+
workspaceId: number;
|
|
2623
|
+
workspaceName?: string | null;
|
|
2624
|
+
fromNumber?: string | null;
|
|
2625
|
+
toNumber?: string | null;
|
|
2626
|
+
direction?: string | null;
|
|
2627
|
+
customerName?: string | null;
|
|
2628
|
+
duration?: number | null;
|
|
2629
|
+
/** Format: date-time */
|
|
2630
|
+
startedAt?: string | null;
|
|
2631
|
+
/** Format: date-time */
|
|
2632
|
+
createdAt?: string | null;
|
|
2633
|
+
/** Format: date-time */
|
|
2634
|
+
updatedAt?: string | null;
|
|
2635
|
+
/** Format: uri */
|
|
2636
|
+
recordingUrl?: string | null;
|
|
2637
|
+
sentiment?: string | null;
|
|
2638
|
+
summary?: string | null;
|
|
2639
|
+
voiceModel?: string | null;
|
|
2640
|
+
llmModel?: string | null;
|
|
2641
|
+
telecommunicationsProvider?: string | null;
|
|
2642
|
+
carrierSid?: string | null;
|
|
2643
|
+
carrierName?: string | null;
|
|
2644
|
+
archived: boolean;
|
|
2645
|
+
costs?: components["schemas"]["CallHistoryCosts"];
|
|
2646
|
+
};
|
|
2647
|
+
CallHistoryCosts: {
|
|
2648
|
+
voice?: number | null;
|
|
2649
|
+
llm?: number | null;
|
|
2650
|
+
voiceMarkup?: number | null;
|
|
2651
|
+
llmMarkup?: number | null;
|
|
2652
|
+
gross?: number | null;
|
|
2653
|
+
markup?: number | null;
|
|
2654
|
+
total?: number | null;
|
|
2655
|
+
markupRate?: number | null;
|
|
2656
|
+
};
|
|
2657
|
+
CallHistoryFilters: {
|
|
2658
|
+
workspaceId?: number;
|
|
2659
|
+
agentId?: string | null;
|
|
2660
|
+
agentVersion?: number | null;
|
|
2661
|
+
status?: string | null;
|
|
2662
|
+
/** Format: date-time */
|
|
2663
|
+
fromDate?: string | null;
|
|
2664
|
+
/** Format: date-time */
|
|
2665
|
+
toDate?: string | null;
|
|
2666
|
+
search?: string | null;
|
|
2667
|
+
includeArchived?: boolean;
|
|
2668
|
+
includeChildCalls?: boolean;
|
|
2669
|
+
};
|
|
2670
|
+
UpdateCallRequest: {
|
|
2671
|
+
/** @description Optional backward-compatible fallback. Required only when the call cannot be resolved from stored call data. */
|
|
2672
|
+
workspaceId?: number;
|
|
2673
|
+
metadata?: {
|
|
2674
|
+
[key: string]: string;
|
|
2675
|
+
};
|
|
2676
|
+
optOutSensitiveDataStorage?: boolean;
|
|
2677
|
+
};
|
|
2678
|
+
CallActionWorkspaceRequest: {
|
|
2679
|
+
/** @description Optional backward-compatible fallback. Required only when the call cannot be resolved from stored call data. */
|
|
2680
|
+
workspaceId?: number;
|
|
2681
|
+
};
|
|
2682
|
+
EndLiveCallResponse: {
|
|
2683
|
+
success: boolean;
|
|
2684
|
+
callId: string;
|
|
2685
|
+
/** @example ended */
|
|
2686
|
+
status: string;
|
|
2687
|
+
call?: components["schemas"]["CallRecord"];
|
|
2688
|
+
};
|
|
2689
|
+
UpdateLiveCallRequest: components["schemas"]["CallActionWorkspaceRequest"] & {
|
|
2690
|
+
fieldsToOverride?: components["schemas"]["UpdateLiveCallFields"];
|
|
2691
|
+
fields_to_override?: components["schemas"]["UpdateLiveCallFields"];
|
|
2692
|
+
callControl?: components["schemas"]["LiveCallControl"];
|
|
2693
|
+
call_control?: components["schemas"]["LiveCallControl"];
|
|
2694
|
+
listen?: components["schemas"]["LiveCallListenControl"];
|
|
2695
|
+
};
|
|
2696
|
+
UpdateLiveCallFields: {
|
|
2697
|
+
/** @description Delta of dynamic variable overrides. Set to null to remove existing overrides. */
|
|
2698
|
+
dynamicVariables?: {
|
|
2699
|
+
[key: string]: string;
|
|
2700
|
+
} | null;
|
|
2701
|
+
/** @description Snake_case alias for dynamicVariables. */
|
|
2702
|
+
override_dynamic_variables?: {
|
|
2703
|
+
[key: string]: string;
|
|
2704
|
+
} | null;
|
|
2705
|
+
/** @description Metadata persisted to the call record. Maximum size is 50KB. */
|
|
2706
|
+
metadata?: {
|
|
2707
|
+
[key: string]: unknown;
|
|
2708
|
+
};
|
|
2709
|
+
/**
|
|
2710
|
+
* @description Data storage setting for this call. More restrictive settings may not be relaxed during a live call.
|
|
2711
|
+
* @enum {string}
|
|
2712
|
+
*/
|
|
2713
|
+
dataStorageSetting?: "everything" | "everything_except_pii" | "basic_attributes_only";
|
|
2714
|
+
/**
|
|
2715
|
+
* @description Snake_case alias for dataStorageSetting.
|
|
2716
|
+
* @enum {string}
|
|
2717
|
+
*/
|
|
2718
|
+
data_storage_setting?: "everything" | "everything_except_pii" | "basic_attributes_only";
|
|
2719
|
+
};
|
|
2720
|
+
LiveCallControl: {
|
|
2721
|
+
/** @description When true, requests that the live agent generate a response when appropriate. If the agent is speaking, the current response may be interrupted depending on the agent interruption settings. If the user is speaking, the request is ignored so the agent does not talk over them. */
|
|
2722
|
+
triggerResponse?: boolean;
|
|
2723
|
+
/** @description Snake_case alias for triggerResponse. */
|
|
2724
|
+
trigger_response?: boolean;
|
|
2725
|
+
/** @description Non-empty text injected into the live call context for the next agent response. */
|
|
2726
|
+
additionalContext?: string;
|
|
2727
|
+
/** @description Snake_case alias for additionalContext. */
|
|
2728
|
+
additional_context?: string;
|
|
2729
|
+
listen?: components["schemas"]["LiveCallListenControl"];
|
|
2730
|
+
};
|
|
2731
|
+
LiveCallListenControl: {
|
|
2732
|
+
/**
|
|
2733
|
+
* @description Start or stop a listen-only audio stream for the live call.
|
|
2734
|
+
* @enum {string}
|
|
2735
|
+
*/
|
|
2736
|
+
action: "start" | "stop";
|
|
2737
|
+
/**
|
|
2738
|
+
* Format: uri
|
|
2739
|
+
* @description WebSocket URL that will receive the live call audio stream. Required when action is start.
|
|
2740
|
+
*/
|
|
2741
|
+
url?: string;
|
|
2742
|
+
/**
|
|
2743
|
+
* @description Audio channel mix for the stream.
|
|
2744
|
+
* @default mixed
|
|
2745
|
+
* @enum {string}
|
|
2746
|
+
*/
|
|
2747
|
+
mixType: "mono" | "mixed" | "stereo";
|
|
2748
|
+
/**
|
|
2749
|
+
* @description Sample rate for the stream.
|
|
2750
|
+
* @default 8000
|
|
2751
|
+
* @enum {integer}
|
|
2752
|
+
*/
|
|
2753
|
+
sampleRate: 8000 | 16000 | 24000 | 48000;
|
|
2754
|
+
/**
|
|
2755
|
+
* @description Keep the stream listen-only.
|
|
2756
|
+
* @default true
|
|
2757
|
+
*/
|
|
2758
|
+
disableBidirectionalAudio: boolean;
|
|
2759
|
+
/** @description Optional WebSocket authentication payload. */
|
|
2760
|
+
wsAuth?: {
|
|
2761
|
+
[key: string]: unknown;
|
|
2762
|
+
};
|
|
2763
|
+
/** @description Optional metadata delivered with the stream setup. */
|
|
2764
|
+
metadata?: {
|
|
2765
|
+
[key: string]: unknown;
|
|
2766
|
+
};
|
|
2767
|
+
};
|
|
2768
|
+
UpdateLiveCallResponse: {
|
|
2769
|
+
success: boolean;
|
|
2770
|
+
callId: string;
|
|
2771
|
+
result?: {
|
|
2772
|
+
[key: string]: unknown;
|
|
2773
|
+
};
|
|
2774
|
+
listen?: {
|
|
2775
|
+
[key: string]: unknown;
|
|
2776
|
+
} | null;
|
|
2777
|
+
call?: components["schemas"]["CallRecord"];
|
|
2778
|
+
};
|
|
2779
|
+
RerunCallAnalysisResponse: {
|
|
2780
|
+
success: boolean;
|
|
2781
|
+
callId: string;
|
|
2782
|
+
call?: components["schemas"]["CallRecord"];
|
|
2783
|
+
};
|
|
2784
|
+
};
|
|
2785
|
+
responses: never;
|
|
2786
|
+
parameters: {
|
|
2787
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2788
|
+
WorkspaceIdQuery: number;
|
|
2789
|
+
/** @description Maximum number of records to return. */
|
|
2790
|
+
LimitQuery: number;
|
|
2791
|
+
/** @description Identifier to continue pagination. */
|
|
2792
|
+
PaginationKeyQuery: string;
|
|
2793
|
+
/** @description Version paired with the pagination key. */
|
|
2794
|
+
PaginationKeyVersionQuery: number;
|
|
2795
|
+
/** @description LLM identifier. */
|
|
2796
|
+
LlmIdPath: string;
|
|
2797
|
+
/** @description Specific version to retrieve or update. */
|
|
2798
|
+
VersionQuery: number;
|
|
2799
|
+
/** @description Agent identifier. */
|
|
2800
|
+
AgentIdPath: string;
|
|
2801
|
+
/** @description Specific agent version. */
|
|
2802
|
+
VersionPath: number;
|
|
2803
|
+
/** @description Sort direction for chat listings. */
|
|
2804
|
+
SortOrderQuery: "ascending" | "descending";
|
|
2805
|
+
/** @description Chat identifier. */
|
|
2806
|
+
ChatIdPath: string;
|
|
2807
|
+
/** @description Chat widget configuration identifier. */
|
|
2808
|
+
WidgetIdPath: number;
|
|
2809
|
+
/** @description Conversation flow identifier. */
|
|
2810
|
+
ConversationFlowIdPath: string;
|
|
2811
|
+
/** @description Knowledge base identifier. */
|
|
2812
|
+
KnowledgeBaseIdPath: string;
|
|
2813
|
+
/** @description Knowledge base source identifier. */
|
|
2814
|
+
SourceIdPath: string;
|
|
2815
|
+
/** @description Voice identifier. */
|
|
2816
|
+
VoiceIdPath: string;
|
|
2817
|
+
/** @description Response engine type used by an existing test case definition. */
|
|
2818
|
+
TestCaseDefinitionTypeQuery: string;
|
|
2819
|
+
/** @description LLM identifier filter. */
|
|
2820
|
+
LlmIdQuery: string;
|
|
2821
|
+
/** @description Conversation flow identifier filter. */
|
|
2822
|
+
ConversationFlowIdQuery: string;
|
|
2823
|
+
/** @description Test run batch identifier. */
|
|
2824
|
+
TestCaseBatchJobIdPath: string;
|
|
2825
|
+
/** @description Test case definition identifier. */
|
|
2826
|
+
TestCaseDefinitionIdPath: string;
|
|
2827
|
+
/** @description Test run job identifier. */
|
|
2828
|
+
TestCaseJobIdPath: string;
|
|
2829
|
+
/** @description Optional workspace identifier filter. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2830
|
+
WorkspaceIdQueryOptional: number;
|
|
2831
|
+
/** @description Filter call listings to a specific agent. */
|
|
2832
|
+
AgentIdQuery: string;
|
|
2833
|
+
/** @description Filter calls by status. */
|
|
2834
|
+
StatusQuery: string;
|
|
2835
|
+
/** @description Inclusive start date for call listing filter. */
|
|
2836
|
+
FromDateQuery: string;
|
|
2837
|
+
/** @description Inclusive end date for call listing filter. */
|
|
2838
|
+
ToDateQuery: string;
|
|
2839
|
+
PageQuery: number;
|
|
2840
|
+
/** @description Page size for list endpoints. */
|
|
2841
|
+
LimitQueryDefault20: number;
|
|
2842
|
+
/** @description Filter call history to a specific persisted agent version captured at call time. */
|
|
2843
|
+
AgentVersionQuery: number;
|
|
2844
|
+
/** @description Search by call SID, phone number, platform call ID, customer name, or agent name. */
|
|
2845
|
+
SearchQuery: string;
|
|
2846
|
+
/** @description When true, include archived calls in the response. */
|
|
2847
|
+
IncludeArchivedQuery: boolean;
|
|
2848
|
+
/** @description When true, include child calls linked to transfer or split-call workflows. */
|
|
2849
|
+
IncludeChildCallsQuery: boolean;
|
|
2850
|
+
/** @description Call identifier or SID. */
|
|
2851
|
+
CallIdPath: string;
|
|
2852
|
+
};
|
|
2853
|
+
requestBodies: never;
|
|
2854
|
+
headers: never;
|
|
2855
|
+
pathItems: never;
|
|
2856
|
+
}
|
|
2857
|
+
export type $defs = Record<string, never>;
|
|
2858
|
+
export interface operations {
|
|
2859
|
+
listLlms: {
|
|
2860
|
+
parameters: {
|
|
2861
|
+
query: {
|
|
2862
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2863
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
2864
|
+
/** @description Maximum number of records to return. */
|
|
2865
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
2866
|
+
/** @description Identifier to continue pagination. */
|
|
2867
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
2868
|
+
/** @description Version paired with the pagination key. */
|
|
2869
|
+
paginationKeyVersion?: components["parameters"]["PaginationKeyVersionQuery"];
|
|
2870
|
+
};
|
|
2871
|
+
header?: never;
|
|
2872
|
+
path?: never;
|
|
2873
|
+
cookie?: never;
|
|
2874
|
+
};
|
|
2875
|
+
requestBody?: never;
|
|
2876
|
+
responses: {
|
|
2877
|
+
/** @description LLM configurations visible to the workspace. */
|
|
2878
|
+
200: {
|
|
2879
|
+
headers: {
|
|
2880
|
+
[name: string]: unknown;
|
|
2881
|
+
};
|
|
2882
|
+
content: {
|
|
2883
|
+
"application/json": components["schemas"]["LlmSummary"][];
|
|
2884
|
+
};
|
|
2885
|
+
};
|
|
2886
|
+
};
|
|
2887
|
+
};
|
|
2888
|
+
createLlm: {
|
|
2889
|
+
parameters: {
|
|
2890
|
+
query?: never;
|
|
2891
|
+
header?: never;
|
|
2892
|
+
path?: never;
|
|
2893
|
+
cookie?: never;
|
|
2894
|
+
};
|
|
2895
|
+
requestBody: {
|
|
2896
|
+
content: {
|
|
2897
|
+
"application/json": components["schemas"]["CreateLlmRequest"];
|
|
2898
|
+
};
|
|
2899
|
+
};
|
|
2900
|
+
responses: {
|
|
2901
|
+
/** @description Newly created LLM configuration. */
|
|
2902
|
+
201: {
|
|
2903
|
+
headers: {
|
|
2904
|
+
[name: string]: unknown;
|
|
2905
|
+
};
|
|
2906
|
+
content: {
|
|
2907
|
+
"application/json": components["schemas"]["Llm"];
|
|
2908
|
+
};
|
|
2909
|
+
};
|
|
2910
|
+
};
|
|
2911
|
+
};
|
|
2912
|
+
getLlm: {
|
|
2913
|
+
parameters: {
|
|
2914
|
+
query: {
|
|
2915
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2916
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
2917
|
+
/** @description Specific version to retrieve or update. */
|
|
2918
|
+
version?: components["parameters"]["VersionQuery"];
|
|
2919
|
+
};
|
|
2920
|
+
header?: never;
|
|
2921
|
+
path: {
|
|
2922
|
+
/** @description LLM identifier. */
|
|
2923
|
+
llmId: components["parameters"]["LlmIdPath"];
|
|
2924
|
+
};
|
|
2925
|
+
cookie?: never;
|
|
2926
|
+
};
|
|
2927
|
+
requestBody?: never;
|
|
2928
|
+
responses: {
|
|
2929
|
+
/** @description LLM configuration details. */
|
|
2930
|
+
200: {
|
|
2931
|
+
headers: {
|
|
2932
|
+
[name: string]: unknown;
|
|
2933
|
+
};
|
|
2934
|
+
content: {
|
|
2935
|
+
"application/json": components["schemas"]["Llm"];
|
|
2936
|
+
};
|
|
2937
|
+
};
|
|
2938
|
+
};
|
|
2939
|
+
};
|
|
2940
|
+
deleteLlm: {
|
|
2941
|
+
parameters: {
|
|
2942
|
+
query: {
|
|
2943
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2944
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
2945
|
+
};
|
|
2946
|
+
header?: never;
|
|
2947
|
+
path: {
|
|
2948
|
+
/** @description LLM identifier. */
|
|
2949
|
+
llmId: components["parameters"]["LlmIdPath"];
|
|
2950
|
+
};
|
|
2951
|
+
cookie?: never;
|
|
2952
|
+
};
|
|
2953
|
+
requestBody?: never;
|
|
2954
|
+
responses: {
|
|
2955
|
+
/** @description LLM deleted. */
|
|
2956
|
+
204: {
|
|
2957
|
+
headers: {
|
|
2958
|
+
[name: string]: unknown;
|
|
2959
|
+
};
|
|
2960
|
+
content?: never;
|
|
2961
|
+
};
|
|
2962
|
+
};
|
|
2963
|
+
};
|
|
2964
|
+
updateLlm: {
|
|
2965
|
+
parameters: {
|
|
2966
|
+
query?: {
|
|
2967
|
+
/** @description Specific version to retrieve or update. */
|
|
2968
|
+
version?: components["parameters"]["VersionQuery"];
|
|
2969
|
+
};
|
|
2970
|
+
header?: never;
|
|
2971
|
+
path: {
|
|
2972
|
+
/** @description LLM identifier. */
|
|
2973
|
+
llmId: components["parameters"]["LlmIdPath"];
|
|
2974
|
+
};
|
|
2975
|
+
cookie?: never;
|
|
2976
|
+
};
|
|
2977
|
+
requestBody: {
|
|
2978
|
+
content: {
|
|
2979
|
+
"application/json": components["schemas"]["UpdateLlmRequest"];
|
|
2980
|
+
};
|
|
2981
|
+
};
|
|
2982
|
+
responses: {
|
|
2983
|
+
/** @description Updated LLM configuration. */
|
|
2984
|
+
200: {
|
|
2985
|
+
headers: {
|
|
2986
|
+
[name: string]: unknown;
|
|
2987
|
+
};
|
|
2988
|
+
content: {
|
|
2989
|
+
"application/json": components["schemas"]["Llm"];
|
|
2990
|
+
};
|
|
2991
|
+
};
|
|
2992
|
+
};
|
|
2993
|
+
};
|
|
2994
|
+
listAgents: {
|
|
2995
|
+
parameters: {
|
|
2996
|
+
query: {
|
|
2997
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
2998
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
2999
|
+
/** @description Maximum number of records to return. */
|
|
3000
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
3001
|
+
/** @description Identifier to continue pagination. */
|
|
3002
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
3003
|
+
/** @description Version paired with the pagination key. */
|
|
3004
|
+
paginationKeyVersion?: components["parameters"]["PaginationKeyVersionQuery"];
|
|
3005
|
+
};
|
|
3006
|
+
header?: never;
|
|
3007
|
+
path?: never;
|
|
3008
|
+
cookie?: never;
|
|
3009
|
+
};
|
|
3010
|
+
requestBody?: never;
|
|
3011
|
+
responses: {
|
|
3012
|
+
/** @description Agent summary list. */
|
|
3013
|
+
200: {
|
|
3014
|
+
headers: {
|
|
3015
|
+
[name: string]: unknown;
|
|
3016
|
+
};
|
|
3017
|
+
content: {
|
|
3018
|
+
"application/json": components["schemas"]["AgentSummary"][];
|
|
3019
|
+
};
|
|
3020
|
+
};
|
|
3021
|
+
};
|
|
3022
|
+
};
|
|
3023
|
+
createAgent: {
|
|
3024
|
+
parameters: {
|
|
3025
|
+
query?: never;
|
|
3026
|
+
header?: never;
|
|
3027
|
+
path?: never;
|
|
3028
|
+
cookie?: never;
|
|
3029
|
+
};
|
|
3030
|
+
requestBody: {
|
|
3031
|
+
content: {
|
|
3032
|
+
"application/json": components["schemas"]["CreateAgentRequest"];
|
|
3033
|
+
};
|
|
3034
|
+
};
|
|
3035
|
+
responses: {
|
|
3036
|
+
/** @description Newly created agent. */
|
|
3037
|
+
201: {
|
|
3038
|
+
headers: {
|
|
3039
|
+
[name: string]: unknown;
|
|
3040
|
+
};
|
|
3041
|
+
content: {
|
|
3042
|
+
"application/json": components["schemas"]["Agent"];
|
|
3043
|
+
};
|
|
3044
|
+
};
|
|
3045
|
+
};
|
|
3046
|
+
};
|
|
3047
|
+
getAgent: {
|
|
3048
|
+
parameters: {
|
|
3049
|
+
query: {
|
|
3050
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3051
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3052
|
+
/** @description Specific version to retrieve or update. */
|
|
3053
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3054
|
+
};
|
|
3055
|
+
header?: never;
|
|
3056
|
+
path: {
|
|
3057
|
+
/** @description Agent identifier. */
|
|
3058
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3059
|
+
};
|
|
3060
|
+
cookie?: never;
|
|
3061
|
+
};
|
|
3062
|
+
requestBody?: never;
|
|
3063
|
+
responses: {
|
|
3064
|
+
/** @description Agent configuration. */
|
|
3065
|
+
200: {
|
|
3066
|
+
headers: {
|
|
3067
|
+
[name: string]: unknown;
|
|
3068
|
+
};
|
|
3069
|
+
content: {
|
|
3070
|
+
"application/json": components["schemas"]["Agent"];
|
|
3071
|
+
};
|
|
3072
|
+
};
|
|
3073
|
+
};
|
|
3074
|
+
};
|
|
3075
|
+
deleteAgent: {
|
|
3076
|
+
parameters: {
|
|
3077
|
+
query: {
|
|
3078
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3079
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3080
|
+
};
|
|
3081
|
+
header?: never;
|
|
3082
|
+
path: {
|
|
3083
|
+
/** @description Agent identifier. */
|
|
3084
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3085
|
+
};
|
|
3086
|
+
cookie?: never;
|
|
3087
|
+
};
|
|
3088
|
+
requestBody?: never;
|
|
3089
|
+
responses: {
|
|
3090
|
+
/** @description Agent deleted. */
|
|
3091
|
+
204: {
|
|
3092
|
+
headers: {
|
|
3093
|
+
[name: string]: unknown;
|
|
3094
|
+
};
|
|
3095
|
+
content?: never;
|
|
3096
|
+
};
|
|
3097
|
+
};
|
|
3098
|
+
};
|
|
3099
|
+
updateAgent: {
|
|
3100
|
+
parameters: {
|
|
3101
|
+
query?: {
|
|
3102
|
+
/** @description Specific version to retrieve or update. */
|
|
3103
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3104
|
+
};
|
|
3105
|
+
header?: never;
|
|
3106
|
+
path: {
|
|
3107
|
+
/** @description Agent identifier. */
|
|
3108
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3109
|
+
};
|
|
3110
|
+
cookie?: never;
|
|
3111
|
+
};
|
|
3112
|
+
requestBody: {
|
|
3113
|
+
content: {
|
|
3114
|
+
"application/json": components["schemas"]["UpdateAgentRequest"];
|
|
3115
|
+
};
|
|
3116
|
+
};
|
|
3117
|
+
responses: {
|
|
3118
|
+
/** @description Updated agent. */
|
|
3119
|
+
200: {
|
|
3120
|
+
headers: {
|
|
3121
|
+
[name: string]: unknown;
|
|
3122
|
+
};
|
|
3123
|
+
content: {
|
|
3124
|
+
"application/json": components["schemas"]["Agent"];
|
|
3125
|
+
};
|
|
3126
|
+
};
|
|
3127
|
+
};
|
|
3128
|
+
};
|
|
3129
|
+
listAgentVersions: {
|
|
3130
|
+
parameters: {
|
|
3131
|
+
query: {
|
|
3132
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3133
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3134
|
+
};
|
|
3135
|
+
header?: never;
|
|
3136
|
+
path: {
|
|
3137
|
+
/** @description Agent identifier. */
|
|
3138
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3139
|
+
};
|
|
3140
|
+
cookie?: never;
|
|
3141
|
+
};
|
|
3142
|
+
requestBody?: never;
|
|
3143
|
+
responses: {
|
|
3144
|
+
/** @description Agent version history. */
|
|
3145
|
+
200: {
|
|
3146
|
+
headers: {
|
|
3147
|
+
[name: string]: unknown;
|
|
3148
|
+
};
|
|
3149
|
+
content: {
|
|
3150
|
+
"application/json": components["schemas"]["AgentVersion"][];
|
|
3151
|
+
};
|
|
3152
|
+
};
|
|
3153
|
+
};
|
|
3154
|
+
};
|
|
3155
|
+
createAgentDraftVersion: {
|
|
3156
|
+
parameters: {
|
|
3157
|
+
query?: never;
|
|
3158
|
+
header?: never;
|
|
3159
|
+
path: {
|
|
3160
|
+
/** @description Agent identifier. */
|
|
3161
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3162
|
+
};
|
|
3163
|
+
cookie?: never;
|
|
3164
|
+
};
|
|
3165
|
+
requestBody: {
|
|
3166
|
+
content: {
|
|
3167
|
+
"application/json": components["schemas"]["CreateAgentVersionRequest"];
|
|
3168
|
+
};
|
|
3169
|
+
};
|
|
3170
|
+
responses: {
|
|
3171
|
+
/** @description Draft version created. */
|
|
3172
|
+
201: {
|
|
3173
|
+
headers: {
|
|
3174
|
+
[name: string]: unknown;
|
|
3175
|
+
};
|
|
3176
|
+
content: {
|
|
3177
|
+
"application/json": components["schemas"]["Agent"];
|
|
3178
|
+
};
|
|
3179
|
+
};
|
|
3180
|
+
};
|
|
3181
|
+
};
|
|
3182
|
+
publishAgentVersion: {
|
|
3183
|
+
parameters: {
|
|
3184
|
+
query?: never;
|
|
3185
|
+
header?: never;
|
|
3186
|
+
path: {
|
|
3187
|
+
/** @description Agent identifier. */
|
|
3188
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3189
|
+
/** @description Specific agent version. */
|
|
3190
|
+
version: components["parameters"]["VersionPath"];
|
|
3191
|
+
};
|
|
3192
|
+
cookie?: never;
|
|
3193
|
+
};
|
|
3194
|
+
requestBody: {
|
|
3195
|
+
content: {
|
|
3196
|
+
"application/json": components["schemas"]["PublishAgentVersionRequest"];
|
|
3197
|
+
};
|
|
3198
|
+
};
|
|
3199
|
+
responses: {
|
|
3200
|
+
/** @description Published agent version. */
|
|
3201
|
+
200: {
|
|
3202
|
+
headers: {
|
|
3203
|
+
[name: string]: unknown;
|
|
3204
|
+
};
|
|
3205
|
+
content: {
|
|
3206
|
+
"application/json": components["schemas"]["Agent"];
|
|
3207
|
+
};
|
|
3208
|
+
};
|
|
3209
|
+
};
|
|
3210
|
+
};
|
|
3211
|
+
deleteAgentVersion: {
|
|
3212
|
+
parameters: {
|
|
3213
|
+
query: {
|
|
3214
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3215
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3216
|
+
};
|
|
3217
|
+
header?: never;
|
|
3218
|
+
path: {
|
|
3219
|
+
/** @description Agent identifier. */
|
|
3220
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3221
|
+
/** @description Specific agent version. */
|
|
3222
|
+
version: components["parameters"]["VersionPath"];
|
|
3223
|
+
};
|
|
3224
|
+
cookie?: never;
|
|
3225
|
+
};
|
|
3226
|
+
requestBody?: never;
|
|
3227
|
+
responses: {
|
|
3228
|
+
/** @description Agent version deleted. */
|
|
3229
|
+
204: {
|
|
3230
|
+
headers: {
|
|
3231
|
+
[name: string]: unknown;
|
|
3232
|
+
};
|
|
3233
|
+
content?: never;
|
|
3234
|
+
};
|
|
3235
|
+
};
|
|
3236
|
+
};
|
|
3237
|
+
listChatAgents: {
|
|
3238
|
+
parameters: {
|
|
3239
|
+
query: {
|
|
3240
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3241
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3242
|
+
/** @description Maximum number of records to return. */
|
|
3243
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
3244
|
+
/** @description Identifier to continue pagination. */
|
|
3245
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
3246
|
+
/** @description Version paired with the pagination key. */
|
|
3247
|
+
paginationKeyVersion?: components["parameters"]["PaginationKeyVersionQuery"];
|
|
3248
|
+
};
|
|
3249
|
+
header?: never;
|
|
3250
|
+
path?: never;
|
|
3251
|
+
cookie?: never;
|
|
3252
|
+
};
|
|
3253
|
+
requestBody?: never;
|
|
3254
|
+
responses: {
|
|
3255
|
+
/** @description Chat agent summary list. */
|
|
3256
|
+
200: {
|
|
3257
|
+
headers: {
|
|
3258
|
+
[name: string]: unknown;
|
|
3259
|
+
};
|
|
3260
|
+
content: {
|
|
3261
|
+
"application/json": components["schemas"]["ChatAgentListResponse"];
|
|
3262
|
+
};
|
|
3263
|
+
};
|
|
3264
|
+
};
|
|
3265
|
+
};
|
|
3266
|
+
createChatAgent: {
|
|
3267
|
+
parameters: {
|
|
3268
|
+
query?: never;
|
|
3269
|
+
header?: never;
|
|
3270
|
+
path?: never;
|
|
3271
|
+
cookie?: never;
|
|
3272
|
+
};
|
|
3273
|
+
requestBody: {
|
|
3274
|
+
content: {
|
|
3275
|
+
"application/json": components["schemas"]["CreateChatAgentRequest"];
|
|
3276
|
+
};
|
|
3277
|
+
};
|
|
3278
|
+
responses: {
|
|
3279
|
+
/** @description Newly created chat agent. */
|
|
3280
|
+
201: {
|
|
3281
|
+
headers: {
|
|
3282
|
+
[name: string]: unknown;
|
|
3283
|
+
};
|
|
3284
|
+
content: {
|
|
3285
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3286
|
+
};
|
|
3287
|
+
};
|
|
3288
|
+
};
|
|
3289
|
+
};
|
|
3290
|
+
getChatAgent: {
|
|
3291
|
+
parameters: {
|
|
3292
|
+
query: {
|
|
3293
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3294
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3295
|
+
/** @description Specific version to retrieve or update. */
|
|
3296
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3297
|
+
};
|
|
3298
|
+
header?: never;
|
|
3299
|
+
path: {
|
|
3300
|
+
/** @description Agent identifier. */
|
|
3301
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3302
|
+
};
|
|
3303
|
+
cookie?: never;
|
|
3304
|
+
};
|
|
3305
|
+
requestBody?: never;
|
|
3306
|
+
responses: {
|
|
3307
|
+
/** @description Chat agent configuration. */
|
|
3308
|
+
200: {
|
|
3309
|
+
headers: {
|
|
3310
|
+
[name: string]: unknown;
|
|
3311
|
+
};
|
|
3312
|
+
content: {
|
|
3313
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
3316
|
+
};
|
|
3317
|
+
};
|
|
3318
|
+
deleteChatAgent: {
|
|
3319
|
+
parameters: {
|
|
3320
|
+
query: {
|
|
3321
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3322
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3323
|
+
};
|
|
3324
|
+
header?: never;
|
|
3325
|
+
path: {
|
|
3326
|
+
/** @description Agent identifier. */
|
|
3327
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3328
|
+
};
|
|
3329
|
+
cookie?: never;
|
|
3330
|
+
};
|
|
3331
|
+
requestBody?: never;
|
|
3332
|
+
responses: {
|
|
3333
|
+
/** @description Chat agent deleted. */
|
|
3334
|
+
204: {
|
|
3335
|
+
headers: {
|
|
3336
|
+
[name: string]: unknown;
|
|
3337
|
+
};
|
|
3338
|
+
content?: never;
|
|
3339
|
+
};
|
|
3340
|
+
};
|
|
3341
|
+
};
|
|
3342
|
+
updateChatAgent: {
|
|
3343
|
+
parameters: {
|
|
3344
|
+
query?: {
|
|
3345
|
+
/** @description Specific version to retrieve or update. */
|
|
3346
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3347
|
+
};
|
|
3348
|
+
header?: never;
|
|
3349
|
+
path: {
|
|
3350
|
+
/** @description Agent identifier. */
|
|
3351
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3352
|
+
};
|
|
3353
|
+
cookie?: never;
|
|
3354
|
+
};
|
|
3355
|
+
requestBody: {
|
|
3356
|
+
content: {
|
|
3357
|
+
"application/json": components["schemas"]["UpdateChatAgentRequest"];
|
|
3358
|
+
};
|
|
3359
|
+
};
|
|
3360
|
+
responses: {
|
|
3361
|
+
/** @description Updated chat agent. */
|
|
3362
|
+
200: {
|
|
3363
|
+
headers: {
|
|
3364
|
+
[name: string]: unknown;
|
|
3365
|
+
};
|
|
3366
|
+
content: {
|
|
3367
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3368
|
+
};
|
|
3369
|
+
};
|
|
3370
|
+
};
|
|
3371
|
+
};
|
|
3372
|
+
listChatAgentVersions: {
|
|
3373
|
+
parameters: {
|
|
3374
|
+
query: {
|
|
3375
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3376
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3377
|
+
};
|
|
3378
|
+
header?: never;
|
|
3379
|
+
path: {
|
|
3380
|
+
/** @description Agent identifier. */
|
|
3381
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3382
|
+
};
|
|
3383
|
+
cookie?: never;
|
|
3384
|
+
};
|
|
3385
|
+
requestBody?: never;
|
|
3386
|
+
responses: {
|
|
3387
|
+
/** @description Chat agent version history. */
|
|
3388
|
+
200: {
|
|
3389
|
+
headers: {
|
|
3390
|
+
[name: string]: unknown;
|
|
3391
|
+
};
|
|
3392
|
+
content: {
|
|
3393
|
+
"application/json": components["schemas"]["ChatAgentVersionListResponse"];
|
|
3394
|
+
};
|
|
3395
|
+
};
|
|
3396
|
+
};
|
|
3397
|
+
};
|
|
3398
|
+
createChatAgentDraftVersion: {
|
|
3399
|
+
parameters: {
|
|
3400
|
+
query?: never;
|
|
3401
|
+
header?: never;
|
|
3402
|
+
path: {
|
|
3403
|
+
/** @description Agent identifier. */
|
|
3404
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3405
|
+
};
|
|
3406
|
+
cookie?: never;
|
|
3407
|
+
};
|
|
3408
|
+
requestBody: {
|
|
3409
|
+
content: {
|
|
3410
|
+
"application/json": components["schemas"]["CreateAgentVersionRequest"];
|
|
3411
|
+
};
|
|
3412
|
+
};
|
|
3413
|
+
responses: {
|
|
3414
|
+
/** @description Draft version created. */
|
|
3415
|
+
201: {
|
|
3416
|
+
headers: {
|
|
3417
|
+
[name: string]: unknown;
|
|
3418
|
+
};
|
|
3419
|
+
content: {
|
|
3420
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3421
|
+
};
|
|
3422
|
+
};
|
|
3423
|
+
};
|
|
3424
|
+
};
|
|
3425
|
+
publishChatAgentVersion: {
|
|
3426
|
+
parameters: {
|
|
3427
|
+
query?: never;
|
|
3428
|
+
header?: never;
|
|
3429
|
+
path: {
|
|
3430
|
+
/** @description Agent identifier. */
|
|
3431
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3432
|
+
/** @description Specific agent version. */
|
|
3433
|
+
version: components["parameters"]["VersionPath"];
|
|
3434
|
+
};
|
|
3435
|
+
cookie?: never;
|
|
3436
|
+
};
|
|
3437
|
+
requestBody: {
|
|
3438
|
+
content: {
|
|
3439
|
+
"application/json": components["schemas"]["PublishAgentVersionRequest"];
|
|
3440
|
+
};
|
|
3441
|
+
};
|
|
3442
|
+
responses: {
|
|
3443
|
+
/** @description Published chat agent version. */
|
|
3444
|
+
200: {
|
|
3445
|
+
headers: {
|
|
3446
|
+
[name: string]: unknown;
|
|
3447
|
+
};
|
|
3448
|
+
content: {
|
|
3449
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3450
|
+
};
|
|
3451
|
+
};
|
|
3452
|
+
};
|
|
3453
|
+
};
|
|
3454
|
+
deleteChatAgentVersion: {
|
|
3455
|
+
parameters: {
|
|
3456
|
+
query: {
|
|
3457
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3458
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3459
|
+
};
|
|
3460
|
+
header?: never;
|
|
3461
|
+
path: {
|
|
3462
|
+
/** @description Agent identifier. */
|
|
3463
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3464
|
+
/** @description Specific agent version. */
|
|
3465
|
+
version: components["parameters"]["VersionPath"];
|
|
3466
|
+
};
|
|
3467
|
+
cookie?: never;
|
|
3468
|
+
};
|
|
3469
|
+
requestBody?: never;
|
|
3470
|
+
responses: {
|
|
3471
|
+
/** @description Chat agent version deleted. */
|
|
3472
|
+
204: {
|
|
3473
|
+
headers: {
|
|
3474
|
+
[name: string]: unknown;
|
|
3475
|
+
};
|
|
3476
|
+
content?: never;
|
|
3477
|
+
};
|
|
3478
|
+
};
|
|
3479
|
+
};
|
|
3480
|
+
publishChatAgentVersionFiltered: {
|
|
3481
|
+
parameters: {
|
|
3482
|
+
query?: never;
|
|
3483
|
+
header?: never;
|
|
3484
|
+
path: {
|
|
3485
|
+
/** @description Agent identifier. */
|
|
3486
|
+
agentId: components["parameters"]["AgentIdPath"];
|
|
3487
|
+
};
|
|
3488
|
+
cookie?: never;
|
|
3489
|
+
};
|
|
3490
|
+
requestBody: {
|
|
3491
|
+
content: {
|
|
3492
|
+
"application/json": {
|
|
3493
|
+
workspaceId: number;
|
|
3494
|
+
version: number;
|
|
3495
|
+
versionTitle?: string;
|
|
3496
|
+
versionDescription?: string;
|
|
3497
|
+
};
|
|
3498
|
+
};
|
|
3499
|
+
};
|
|
3500
|
+
responses: {
|
|
3501
|
+
/** @description Published chat agent. */
|
|
3502
|
+
200: {
|
|
3503
|
+
headers: {
|
|
3504
|
+
[name: string]: unknown;
|
|
3505
|
+
};
|
|
3506
|
+
content: {
|
|
3507
|
+
"application/json": components["schemas"]["ChatAgent"];
|
|
3508
|
+
};
|
|
3509
|
+
};
|
|
3510
|
+
};
|
|
3511
|
+
};
|
|
3512
|
+
listChats: {
|
|
3513
|
+
parameters: {
|
|
3514
|
+
query: {
|
|
3515
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3516
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3517
|
+
/** @description Sort direction for chat listings. */
|
|
3518
|
+
sortOrder?: components["parameters"]["SortOrderQuery"];
|
|
3519
|
+
/** @description Maximum number of records to return. */
|
|
3520
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
3521
|
+
/** @description Identifier to continue pagination. */
|
|
3522
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
3523
|
+
};
|
|
3524
|
+
header?: never;
|
|
3525
|
+
path?: never;
|
|
3526
|
+
cookie?: never;
|
|
3527
|
+
};
|
|
3528
|
+
requestBody?: never;
|
|
3529
|
+
responses: {
|
|
3530
|
+
/** @description Chat session list. */
|
|
3531
|
+
200: {
|
|
3532
|
+
headers: {
|
|
3533
|
+
[name: string]: unknown;
|
|
3534
|
+
};
|
|
3535
|
+
content: {
|
|
3536
|
+
"application/json": components["schemas"]["ChatListResponse"];
|
|
3537
|
+
};
|
|
3538
|
+
};
|
|
3539
|
+
};
|
|
3540
|
+
};
|
|
3541
|
+
createChat: {
|
|
3542
|
+
parameters: {
|
|
3543
|
+
query?: never;
|
|
3544
|
+
header?: never;
|
|
3545
|
+
path?: never;
|
|
3546
|
+
cookie?: never;
|
|
3547
|
+
};
|
|
3548
|
+
requestBody: {
|
|
3549
|
+
content: {
|
|
3550
|
+
"application/json": components["schemas"]["CreateChatRequest"];
|
|
3551
|
+
};
|
|
3552
|
+
};
|
|
3553
|
+
responses: {
|
|
3554
|
+
/** @description Chat created. */
|
|
3555
|
+
201: {
|
|
3556
|
+
headers: {
|
|
3557
|
+
[name: string]: unknown;
|
|
3558
|
+
};
|
|
3559
|
+
content: {
|
|
3560
|
+
"application/json": components["schemas"]["Chat"];
|
|
3561
|
+
};
|
|
3562
|
+
};
|
|
3563
|
+
};
|
|
3564
|
+
};
|
|
3565
|
+
createOutboundSmsChat: {
|
|
3566
|
+
parameters: {
|
|
3567
|
+
query?: never;
|
|
3568
|
+
header?: never;
|
|
3569
|
+
path?: never;
|
|
3570
|
+
cookie?: never;
|
|
3571
|
+
};
|
|
3572
|
+
requestBody: {
|
|
3573
|
+
content: {
|
|
3574
|
+
"application/json": components["schemas"]["CreateOutboundSmsChatRequest"];
|
|
3575
|
+
};
|
|
3576
|
+
};
|
|
3577
|
+
responses: {
|
|
3578
|
+
/** @description Outbound SMS chat created. */
|
|
3579
|
+
201: {
|
|
3580
|
+
headers: {
|
|
3581
|
+
[name: string]: unknown;
|
|
3582
|
+
};
|
|
3583
|
+
content: {
|
|
3584
|
+
"application/json": components["schemas"]["Chat"];
|
|
3585
|
+
};
|
|
3586
|
+
};
|
|
3587
|
+
};
|
|
3588
|
+
};
|
|
3589
|
+
getChat: {
|
|
3590
|
+
parameters: {
|
|
3591
|
+
query: {
|
|
3592
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3593
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3594
|
+
};
|
|
3595
|
+
header?: never;
|
|
3596
|
+
path: {
|
|
3597
|
+
/** @description Chat identifier. */
|
|
3598
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
3599
|
+
};
|
|
3600
|
+
cookie?: never;
|
|
3601
|
+
};
|
|
3602
|
+
requestBody?: never;
|
|
3603
|
+
responses: {
|
|
3604
|
+
/** @description Chat details. */
|
|
3605
|
+
200: {
|
|
3606
|
+
headers: {
|
|
3607
|
+
[name: string]: unknown;
|
|
3608
|
+
};
|
|
3609
|
+
content: {
|
|
3610
|
+
"application/json": components["schemas"]["Chat"];
|
|
3611
|
+
};
|
|
3612
|
+
};
|
|
3613
|
+
};
|
|
3614
|
+
};
|
|
3615
|
+
updateChat: {
|
|
3616
|
+
parameters: {
|
|
3617
|
+
query?: never;
|
|
3618
|
+
header?: never;
|
|
3619
|
+
path: {
|
|
3620
|
+
/** @description Chat identifier. */
|
|
3621
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
3622
|
+
};
|
|
3623
|
+
cookie?: never;
|
|
3624
|
+
};
|
|
3625
|
+
requestBody: {
|
|
3626
|
+
content: {
|
|
3627
|
+
"application/json": components["schemas"]["UpdateChatRequest"];
|
|
3628
|
+
};
|
|
3629
|
+
};
|
|
3630
|
+
responses: {
|
|
3631
|
+
/** @description Updated chat session. */
|
|
3632
|
+
200: {
|
|
3633
|
+
headers: {
|
|
3634
|
+
[name: string]: unknown;
|
|
3635
|
+
};
|
|
3636
|
+
content: {
|
|
3637
|
+
"application/json": components["schemas"]["Chat"];
|
|
3638
|
+
};
|
|
3639
|
+
};
|
|
3640
|
+
};
|
|
3641
|
+
};
|
|
3642
|
+
createChatCompletion: {
|
|
3643
|
+
parameters: {
|
|
3644
|
+
query?: never;
|
|
3645
|
+
header?: never;
|
|
3646
|
+
path: {
|
|
3647
|
+
/** @description Chat identifier. */
|
|
3648
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
3649
|
+
};
|
|
3650
|
+
cookie?: never;
|
|
3651
|
+
};
|
|
3652
|
+
requestBody: {
|
|
3653
|
+
content: {
|
|
3654
|
+
"application/json": components["schemas"]["CreateChatCompletionRequest"];
|
|
3655
|
+
};
|
|
3656
|
+
};
|
|
3657
|
+
responses: {
|
|
3658
|
+
/** @description Chat completion messages. */
|
|
3659
|
+
201: {
|
|
3660
|
+
headers: {
|
|
3661
|
+
[name: string]: unknown;
|
|
3662
|
+
};
|
|
3663
|
+
content: {
|
|
3664
|
+
"application/json": components["schemas"]["ChatCompletionResponse"];
|
|
3665
|
+
};
|
|
3666
|
+
};
|
|
3667
|
+
};
|
|
3668
|
+
};
|
|
3669
|
+
endChat: {
|
|
3670
|
+
parameters: {
|
|
3671
|
+
query?: never;
|
|
3672
|
+
header?: never;
|
|
3673
|
+
path: {
|
|
3674
|
+
/** @description Chat identifier. */
|
|
3675
|
+
chatId: components["parameters"]["ChatIdPath"];
|
|
3676
|
+
};
|
|
3677
|
+
cookie?: never;
|
|
3678
|
+
};
|
|
3679
|
+
requestBody: {
|
|
3680
|
+
content: {
|
|
3681
|
+
"application/json": {
|
|
3682
|
+
workspaceId: number;
|
|
3683
|
+
};
|
|
3684
|
+
};
|
|
3685
|
+
};
|
|
3686
|
+
responses: {
|
|
3687
|
+
/** @description Chat ended. */
|
|
3688
|
+
204: {
|
|
3689
|
+
headers: {
|
|
3690
|
+
[name: string]: unknown;
|
|
3691
|
+
};
|
|
3692
|
+
content?: never;
|
|
3693
|
+
};
|
|
3694
|
+
};
|
|
3695
|
+
};
|
|
3696
|
+
listChatWidgets: {
|
|
3697
|
+
parameters: {
|
|
3698
|
+
query: {
|
|
3699
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3700
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3701
|
+
};
|
|
3702
|
+
header?: never;
|
|
3703
|
+
path?: never;
|
|
3704
|
+
cookie?: never;
|
|
3705
|
+
};
|
|
3706
|
+
requestBody?: never;
|
|
3707
|
+
responses: {
|
|
3708
|
+
/** @description Chat widget configurations. */
|
|
3709
|
+
200: {
|
|
3710
|
+
headers: {
|
|
3711
|
+
[name: string]: unknown;
|
|
3712
|
+
};
|
|
3713
|
+
content: {
|
|
3714
|
+
"application/json": components["schemas"]["ChatWidgetConfig"][];
|
|
3715
|
+
};
|
|
3716
|
+
};
|
|
3717
|
+
};
|
|
3718
|
+
};
|
|
3719
|
+
createChatWidget: {
|
|
3720
|
+
parameters: {
|
|
3721
|
+
query?: never;
|
|
3722
|
+
header?: never;
|
|
3723
|
+
path?: never;
|
|
3724
|
+
cookie?: never;
|
|
3725
|
+
};
|
|
3726
|
+
requestBody: {
|
|
3727
|
+
content: {
|
|
3728
|
+
"application/json": components["schemas"]["CreateChatWidgetRequest"];
|
|
3729
|
+
};
|
|
3730
|
+
};
|
|
3731
|
+
responses: {
|
|
3732
|
+
/** @description Chat widget created. */
|
|
3733
|
+
201: {
|
|
3734
|
+
headers: {
|
|
3735
|
+
[name: string]: unknown;
|
|
3736
|
+
};
|
|
3737
|
+
content: {
|
|
3738
|
+
"application/json": components["schemas"]["ChatWidgetConfig"];
|
|
3739
|
+
};
|
|
3740
|
+
};
|
|
3741
|
+
};
|
|
3742
|
+
};
|
|
3743
|
+
getChatWidget: {
|
|
3744
|
+
parameters: {
|
|
3745
|
+
query?: never;
|
|
3746
|
+
header?: never;
|
|
3747
|
+
path: {
|
|
3748
|
+
/** @description Chat widget configuration identifier. */
|
|
3749
|
+
widgetId: components["parameters"]["WidgetIdPath"];
|
|
3750
|
+
};
|
|
3751
|
+
cookie?: never;
|
|
3752
|
+
};
|
|
3753
|
+
requestBody?: never;
|
|
3754
|
+
responses: {
|
|
3755
|
+
/** @description Chat widget configuration. */
|
|
3756
|
+
200: {
|
|
3757
|
+
headers: {
|
|
3758
|
+
[name: string]: unknown;
|
|
3759
|
+
};
|
|
3760
|
+
content: {
|
|
3761
|
+
"application/json": components["schemas"]["ChatWidgetConfig"];
|
|
3762
|
+
};
|
|
3763
|
+
};
|
|
3764
|
+
};
|
|
3765
|
+
};
|
|
3766
|
+
updateChatWidget: {
|
|
3767
|
+
parameters: {
|
|
3768
|
+
query?: never;
|
|
3769
|
+
header?: never;
|
|
3770
|
+
path: {
|
|
3771
|
+
/** @description Chat widget configuration identifier. */
|
|
3772
|
+
widgetId: components["parameters"]["WidgetIdPath"];
|
|
3773
|
+
};
|
|
3774
|
+
cookie?: never;
|
|
3775
|
+
};
|
|
3776
|
+
requestBody: {
|
|
3777
|
+
content: {
|
|
3778
|
+
"application/json": components["schemas"]["UpdateChatWidgetRequest"];
|
|
3779
|
+
};
|
|
3780
|
+
};
|
|
3781
|
+
responses: {
|
|
3782
|
+
/** @description Updated chat widget. */
|
|
3783
|
+
200: {
|
|
3784
|
+
headers: {
|
|
3785
|
+
[name: string]: unknown;
|
|
3786
|
+
};
|
|
3787
|
+
content: {
|
|
3788
|
+
"application/json": components["schemas"]["ChatWidgetConfig"];
|
|
3789
|
+
};
|
|
3790
|
+
};
|
|
3791
|
+
};
|
|
3792
|
+
};
|
|
3793
|
+
regenerateWidgetKey: {
|
|
3794
|
+
parameters: {
|
|
3795
|
+
query?: never;
|
|
3796
|
+
header?: never;
|
|
3797
|
+
path: {
|
|
3798
|
+
/** @description Chat widget configuration identifier. */
|
|
3799
|
+
widgetId: components["parameters"]["WidgetIdPath"];
|
|
3800
|
+
};
|
|
3801
|
+
cookie?: never;
|
|
3802
|
+
};
|
|
3803
|
+
requestBody?: never;
|
|
3804
|
+
responses: {
|
|
3805
|
+
/** @description Chat widget with a new public key. */
|
|
3806
|
+
200: {
|
|
3807
|
+
headers: {
|
|
3808
|
+
[name: string]: unknown;
|
|
3809
|
+
};
|
|
3810
|
+
content: {
|
|
3811
|
+
"application/json": components["schemas"]["ChatWidgetConfig"];
|
|
3812
|
+
};
|
|
3813
|
+
};
|
|
3814
|
+
};
|
|
3815
|
+
};
|
|
3816
|
+
listConversationFlows: {
|
|
3817
|
+
parameters: {
|
|
3818
|
+
query: {
|
|
3819
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3820
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3821
|
+
/** @description Maximum number of records to return. */
|
|
3822
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
3823
|
+
/** @description Identifier to continue pagination. */
|
|
3824
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
3825
|
+
/** @description Version paired with the pagination key. */
|
|
3826
|
+
paginationKeyVersion?: components["parameters"]["PaginationKeyVersionQuery"];
|
|
3827
|
+
};
|
|
3828
|
+
header?: never;
|
|
3829
|
+
path?: never;
|
|
3830
|
+
cookie?: never;
|
|
3831
|
+
};
|
|
3832
|
+
requestBody?: never;
|
|
3833
|
+
responses: {
|
|
3834
|
+
/** @description Conversation flow summaries. */
|
|
3835
|
+
200: {
|
|
3836
|
+
headers: {
|
|
3837
|
+
[name: string]: unknown;
|
|
3838
|
+
};
|
|
3839
|
+
content: {
|
|
3840
|
+
"application/json": components["schemas"]["ConversationFlowSummary"][];
|
|
3841
|
+
};
|
|
3842
|
+
};
|
|
3843
|
+
};
|
|
3844
|
+
};
|
|
3845
|
+
createConversationFlow: {
|
|
3846
|
+
parameters: {
|
|
3847
|
+
query?: never;
|
|
3848
|
+
header?: never;
|
|
3849
|
+
path?: never;
|
|
3850
|
+
cookie?: never;
|
|
3851
|
+
};
|
|
3852
|
+
requestBody: {
|
|
3853
|
+
content: {
|
|
3854
|
+
"application/json": components["schemas"]["CreateConversationFlowRequest"];
|
|
3855
|
+
};
|
|
3856
|
+
};
|
|
3857
|
+
responses: {
|
|
3858
|
+
/** @description Newly created conversation flow. */
|
|
3859
|
+
201: {
|
|
3860
|
+
headers: {
|
|
3861
|
+
[name: string]: unknown;
|
|
3862
|
+
};
|
|
3863
|
+
content: {
|
|
3864
|
+
"application/json": components["schemas"]["ConversationFlow"];
|
|
3865
|
+
};
|
|
3866
|
+
};
|
|
3867
|
+
};
|
|
3868
|
+
};
|
|
3869
|
+
getConversationFlow: {
|
|
3870
|
+
parameters: {
|
|
3871
|
+
query: {
|
|
3872
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3873
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3874
|
+
/** @description Specific version to retrieve or update. */
|
|
3875
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3876
|
+
};
|
|
3877
|
+
header?: never;
|
|
3878
|
+
path: {
|
|
3879
|
+
/** @description Conversation flow identifier. */
|
|
3880
|
+
conversationFlowId: components["parameters"]["ConversationFlowIdPath"];
|
|
3881
|
+
};
|
|
3882
|
+
cookie?: never;
|
|
3883
|
+
};
|
|
3884
|
+
requestBody?: never;
|
|
3885
|
+
responses: {
|
|
3886
|
+
/** @description Conversation flow details. */
|
|
3887
|
+
200: {
|
|
3888
|
+
headers: {
|
|
3889
|
+
[name: string]: unknown;
|
|
3890
|
+
};
|
|
3891
|
+
content: {
|
|
3892
|
+
"application/json": components["schemas"]["ConversationFlow"];
|
|
3893
|
+
};
|
|
3894
|
+
};
|
|
3895
|
+
};
|
|
3896
|
+
};
|
|
3897
|
+
deleteConversationFlow: {
|
|
3898
|
+
parameters: {
|
|
3899
|
+
query: {
|
|
3900
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3901
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3902
|
+
};
|
|
3903
|
+
header?: never;
|
|
3904
|
+
path: {
|
|
3905
|
+
/** @description Conversation flow identifier. */
|
|
3906
|
+
conversationFlowId: components["parameters"]["ConversationFlowIdPath"];
|
|
3907
|
+
};
|
|
3908
|
+
cookie?: never;
|
|
3909
|
+
};
|
|
3910
|
+
requestBody?: never;
|
|
3911
|
+
responses: {
|
|
3912
|
+
/** @description Conversation flow deleted. */
|
|
3913
|
+
204: {
|
|
3914
|
+
headers: {
|
|
3915
|
+
[name: string]: unknown;
|
|
3916
|
+
};
|
|
3917
|
+
content?: never;
|
|
3918
|
+
};
|
|
3919
|
+
};
|
|
3920
|
+
};
|
|
3921
|
+
updateConversationFlow: {
|
|
3922
|
+
parameters: {
|
|
3923
|
+
query?: {
|
|
3924
|
+
/** @description Specific version to retrieve or update. */
|
|
3925
|
+
version?: components["parameters"]["VersionQuery"];
|
|
3926
|
+
};
|
|
3927
|
+
header?: never;
|
|
3928
|
+
path: {
|
|
3929
|
+
/** @description Conversation flow identifier. */
|
|
3930
|
+
conversationFlowId: components["parameters"]["ConversationFlowIdPath"];
|
|
3931
|
+
};
|
|
3932
|
+
cookie?: never;
|
|
3933
|
+
};
|
|
3934
|
+
requestBody: {
|
|
3935
|
+
content: {
|
|
3936
|
+
"application/json": components["schemas"]["UpdateConversationFlowRequest"];
|
|
3937
|
+
};
|
|
3938
|
+
};
|
|
3939
|
+
responses: {
|
|
3940
|
+
/** @description Updated conversation flow. */
|
|
3941
|
+
200: {
|
|
3942
|
+
headers: {
|
|
3943
|
+
[name: string]: unknown;
|
|
3944
|
+
};
|
|
3945
|
+
content: {
|
|
3946
|
+
"application/json": components["schemas"]["ConversationFlow"];
|
|
3947
|
+
};
|
|
3948
|
+
};
|
|
3949
|
+
};
|
|
3950
|
+
};
|
|
3951
|
+
listKnowledgeBases: {
|
|
3952
|
+
parameters: {
|
|
3953
|
+
query: {
|
|
3954
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
3955
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
3956
|
+
};
|
|
3957
|
+
header?: never;
|
|
3958
|
+
path?: never;
|
|
3959
|
+
cookie?: never;
|
|
3960
|
+
};
|
|
3961
|
+
requestBody?: never;
|
|
3962
|
+
responses: {
|
|
3963
|
+
/** @description Knowledge base summaries. */
|
|
3964
|
+
200: {
|
|
3965
|
+
headers: {
|
|
3966
|
+
[name: string]: unknown;
|
|
3967
|
+
};
|
|
3968
|
+
content: {
|
|
3969
|
+
"application/json": components["schemas"]["KnowledgeBaseSummary"][];
|
|
3970
|
+
};
|
|
3971
|
+
};
|
|
3972
|
+
};
|
|
3973
|
+
};
|
|
3974
|
+
createKnowledgeBase: {
|
|
3975
|
+
parameters: {
|
|
3976
|
+
query?: never;
|
|
3977
|
+
header?: never;
|
|
3978
|
+
path?: never;
|
|
3979
|
+
cookie?: never;
|
|
3980
|
+
};
|
|
3981
|
+
requestBody: {
|
|
3982
|
+
content: {
|
|
3983
|
+
"application/json": components["schemas"]["CreateKnowledgeBaseRequest"];
|
|
3984
|
+
};
|
|
3985
|
+
};
|
|
3986
|
+
responses: {
|
|
3987
|
+
/** @description Newly created knowledge base. */
|
|
3988
|
+
201: {
|
|
3989
|
+
headers: {
|
|
3990
|
+
[name: string]: unknown;
|
|
3991
|
+
};
|
|
3992
|
+
content: {
|
|
3993
|
+
"application/json": components["schemas"]["KnowledgeBase"];
|
|
3994
|
+
};
|
|
3995
|
+
};
|
|
3996
|
+
};
|
|
3997
|
+
};
|
|
3998
|
+
getKnowledgeBase: {
|
|
3999
|
+
parameters: {
|
|
4000
|
+
query: {
|
|
4001
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4002
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4003
|
+
};
|
|
4004
|
+
header?: never;
|
|
4005
|
+
path: {
|
|
4006
|
+
/** @description Knowledge base identifier. */
|
|
4007
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
4008
|
+
};
|
|
4009
|
+
cookie?: never;
|
|
4010
|
+
};
|
|
4011
|
+
requestBody?: never;
|
|
4012
|
+
responses: {
|
|
4013
|
+
/** @description Knowledge base details. */
|
|
4014
|
+
200: {
|
|
4015
|
+
headers: {
|
|
4016
|
+
[name: string]: unknown;
|
|
4017
|
+
};
|
|
4018
|
+
content: {
|
|
4019
|
+
"application/json": components["schemas"]["KnowledgeBase"];
|
|
4020
|
+
};
|
|
4021
|
+
};
|
|
4022
|
+
};
|
|
4023
|
+
};
|
|
4024
|
+
deleteKnowledgeBase: {
|
|
4025
|
+
parameters: {
|
|
4026
|
+
query: {
|
|
4027
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4028
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4029
|
+
};
|
|
4030
|
+
header?: never;
|
|
4031
|
+
path: {
|
|
4032
|
+
/** @description Knowledge base identifier. */
|
|
4033
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
4034
|
+
};
|
|
4035
|
+
cookie?: never;
|
|
4036
|
+
};
|
|
4037
|
+
requestBody?: never;
|
|
4038
|
+
responses: {
|
|
4039
|
+
/** @description Knowledge base deleted. */
|
|
4040
|
+
204: {
|
|
4041
|
+
headers: {
|
|
4042
|
+
[name: string]: unknown;
|
|
4043
|
+
};
|
|
4044
|
+
content?: never;
|
|
4045
|
+
};
|
|
4046
|
+
};
|
|
4047
|
+
};
|
|
4048
|
+
addKnowledgeBaseSources: {
|
|
4049
|
+
parameters: {
|
|
4050
|
+
query?: never;
|
|
4051
|
+
header?: never;
|
|
4052
|
+
path: {
|
|
4053
|
+
/** @description Knowledge base identifier. */
|
|
4054
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
4055
|
+
};
|
|
4056
|
+
cookie?: never;
|
|
4057
|
+
};
|
|
4058
|
+
requestBody: {
|
|
4059
|
+
content: {
|
|
4060
|
+
"application/json": components["schemas"]["AddKnowledgeBaseSourcesRequest"];
|
|
4061
|
+
};
|
|
4062
|
+
};
|
|
4063
|
+
responses: {
|
|
4064
|
+
/** @description Knowledge base with updated source list. */
|
|
4065
|
+
200: {
|
|
4066
|
+
headers: {
|
|
4067
|
+
[name: string]: unknown;
|
|
4068
|
+
};
|
|
4069
|
+
content: {
|
|
4070
|
+
"application/json": components["schemas"]["KnowledgeBase"];
|
|
4071
|
+
};
|
|
4072
|
+
};
|
|
4073
|
+
};
|
|
4074
|
+
};
|
|
4075
|
+
deleteKnowledgeBaseSource: {
|
|
4076
|
+
parameters: {
|
|
4077
|
+
query: {
|
|
4078
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4079
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4080
|
+
};
|
|
4081
|
+
header?: never;
|
|
4082
|
+
path: {
|
|
4083
|
+
/** @description Knowledge base identifier. */
|
|
4084
|
+
knowledgeBaseId: components["parameters"]["KnowledgeBaseIdPath"];
|
|
4085
|
+
/** @description Knowledge base source identifier. */
|
|
4086
|
+
sourceId: components["parameters"]["SourceIdPath"];
|
|
4087
|
+
};
|
|
4088
|
+
cookie?: never;
|
|
4089
|
+
};
|
|
4090
|
+
requestBody?: never;
|
|
4091
|
+
responses: {
|
|
4092
|
+
/** @description Knowledge base with updated source list. */
|
|
4093
|
+
200: {
|
|
4094
|
+
headers: {
|
|
4095
|
+
[name: string]: unknown;
|
|
4096
|
+
};
|
|
4097
|
+
content: {
|
|
4098
|
+
"application/json": components["schemas"]["KnowledgeBase"];
|
|
4099
|
+
};
|
|
4100
|
+
};
|
|
4101
|
+
};
|
|
4102
|
+
};
|
|
4103
|
+
listVoices: {
|
|
4104
|
+
parameters: {
|
|
4105
|
+
query: {
|
|
4106
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4107
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4108
|
+
};
|
|
4109
|
+
header?: never;
|
|
4110
|
+
path?: never;
|
|
4111
|
+
cookie?: never;
|
|
4112
|
+
};
|
|
4113
|
+
requestBody?: never;
|
|
4114
|
+
responses: {
|
|
4115
|
+
/** @description Voice catalog. */
|
|
4116
|
+
200: {
|
|
4117
|
+
headers: {
|
|
4118
|
+
[name: string]: unknown;
|
|
4119
|
+
};
|
|
4120
|
+
content: {
|
|
4121
|
+
"application/json": components["schemas"]["Voice"][];
|
|
4122
|
+
};
|
|
4123
|
+
};
|
|
4124
|
+
};
|
|
4125
|
+
};
|
|
4126
|
+
searchCommunityVoices: {
|
|
4127
|
+
parameters: {
|
|
4128
|
+
query?: never;
|
|
4129
|
+
header?: never;
|
|
4130
|
+
path?: never;
|
|
4131
|
+
cookie?: never;
|
|
4132
|
+
};
|
|
4133
|
+
requestBody: {
|
|
4134
|
+
content: {
|
|
4135
|
+
"application/json": components["schemas"]["SearchCommunityVoiceRequest"];
|
|
4136
|
+
};
|
|
4137
|
+
};
|
|
4138
|
+
responses: {
|
|
4139
|
+
/** @description Matching community voices. */
|
|
4140
|
+
200: {
|
|
4141
|
+
headers: {
|
|
4142
|
+
[name: string]: unknown;
|
|
4143
|
+
};
|
|
4144
|
+
content: {
|
|
4145
|
+
"application/json": components["schemas"]["SearchCommunityVoiceResponse"];
|
|
4146
|
+
};
|
|
4147
|
+
};
|
|
4148
|
+
};
|
|
4149
|
+
};
|
|
4150
|
+
addCommunityVoice: {
|
|
4151
|
+
parameters: {
|
|
4152
|
+
query?: never;
|
|
4153
|
+
header?: never;
|
|
4154
|
+
path?: never;
|
|
4155
|
+
cookie?: never;
|
|
4156
|
+
};
|
|
4157
|
+
requestBody: {
|
|
4158
|
+
content: {
|
|
4159
|
+
"application/json": components["schemas"]["AddCommunityVoiceRequest"];
|
|
4160
|
+
};
|
|
4161
|
+
};
|
|
4162
|
+
responses: {
|
|
4163
|
+
/** @description Community voice added. */
|
|
4164
|
+
200: {
|
|
4165
|
+
headers: {
|
|
4166
|
+
[name: string]: unknown;
|
|
4167
|
+
};
|
|
4168
|
+
content: {
|
|
4169
|
+
"application/json": components["schemas"]["Voice"];
|
|
4170
|
+
};
|
|
4171
|
+
};
|
|
4172
|
+
};
|
|
4173
|
+
};
|
|
4174
|
+
cloneVoice: {
|
|
4175
|
+
parameters: {
|
|
4176
|
+
query?: never;
|
|
4177
|
+
header?: never;
|
|
4178
|
+
path?: never;
|
|
4179
|
+
cookie?: never;
|
|
4180
|
+
};
|
|
4181
|
+
requestBody: {
|
|
4182
|
+
content: {
|
|
4183
|
+
"multipart/form-data": components["schemas"]["CloneVoiceRequest"];
|
|
4184
|
+
};
|
|
4185
|
+
};
|
|
4186
|
+
responses: {
|
|
4187
|
+
/** @description Cloned voice metadata. */
|
|
4188
|
+
201: {
|
|
4189
|
+
headers: {
|
|
4190
|
+
[name: string]: unknown;
|
|
4191
|
+
};
|
|
4192
|
+
content: {
|
|
4193
|
+
"application/json": components["schemas"]["Voice"];
|
|
4194
|
+
};
|
|
4195
|
+
};
|
|
4196
|
+
};
|
|
4197
|
+
};
|
|
4198
|
+
getVoice: {
|
|
4199
|
+
parameters: {
|
|
4200
|
+
query: {
|
|
4201
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4202
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4203
|
+
};
|
|
4204
|
+
header?: never;
|
|
4205
|
+
path: {
|
|
4206
|
+
/** @description Voice identifier. */
|
|
4207
|
+
voiceId: components["parameters"]["VoiceIdPath"];
|
|
4208
|
+
};
|
|
4209
|
+
cookie?: never;
|
|
4210
|
+
};
|
|
4211
|
+
requestBody?: never;
|
|
4212
|
+
responses: {
|
|
4213
|
+
/** @description Voice metadata. */
|
|
4214
|
+
200: {
|
|
4215
|
+
headers: {
|
|
4216
|
+
[name: string]: unknown;
|
|
4217
|
+
};
|
|
4218
|
+
content: {
|
|
4219
|
+
"application/json": components["schemas"]["Voice"];
|
|
4220
|
+
};
|
|
4221
|
+
};
|
|
4222
|
+
};
|
|
4223
|
+
};
|
|
4224
|
+
streamVoiceSample: {
|
|
4225
|
+
parameters: {
|
|
4226
|
+
query: {
|
|
4227
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4228
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4229
|
+
};
|
|
4230
|
+
header?: never;
|
|
4231
|
+
path: {
|
|
4232
|
+
/** @description Voice identifier. */
|
|
4233
|
+
voiceId: components["parameters"]["VoiceIdPath"];
|
|
4234
|
+
};
|
|
4235
|
+
cookie?: never;
|
|
4236
|
+
};
|
|
4237
|
+
requestBody?: never;
|
|
4238
|
+
responses: {
|
|
4239
|
+
/** @description Voice sample stream. */
|
|
4240
|
+
200: {
|
|
4241
|
+
headers: {
|
|
4242
|
+
[name: string]: unknown;
|
|
4243
|
+
};
|
|
4244
|
+
content: {
|
|
4245
|
+
"audio/mpeg": string;
|
|
4246
|
+
};
|
|
4247
|
+
};
|
|
4248
|
+
};
|
|
4249
|
+
};
|
|
4250
|
+
listTestCaseDefinitions: {
|
|
4251
|
+
parameters: {
|
|
4252
|
+
query: {
|
|
4253
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4254
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4255
|
+
/** @description Response engine type used by an existing test case definition. */
|
|
4256
|
+
type: components["parameters"]["TestCaseDefinitionTypeQuery"];
|
|
4257
|
+
/** @description LLM identifier filter. */
|
|
4258
|
+
llmId?: components["parameters"]["LlmIdQuery"];
|
|
4259
|
+
/** @description Conversation flow identifier filter. */
|
|
4260
|
+
conversationFlowId?: components["parameters"]["ConversationFlowIdQuery"];
|
|
4261
|
+
/** @description Specific version to retrieve or update. */
|
|
4262
|
+
version?: components["parameters"]["VersionQuery"];
|
|
4263
|
+
/** @description Maximum number of records to return. */
|
|
4264
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
4265
|
+
/** @description Identifier to continue pagination. */
|
|
4266
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
4267
|
+
};
|
|
4268
|
+
header?: never;
|
|
4269
|
+
path?: never;
|
|
4270
|
+
cookie?: never;
|
|
4271
|
+
};
|
|
4272
|
+
requestBody?: never;
|
|
4273
|
+
responses: {
|
|
4274
|
+
/** @description Test case definitions. */
|
|
4275
|
+
200: {
|
|
4276
|
+
headers: {
|
|
4277
|
+
[name: string]: unknown;
|
|
4278
|
+
};
|
|
4279
|
+
content: {
|
|
4280
|
+
"application/json": components["schemas"]["TestCaseDefinition"][];
|
|
4281
|
+
};
|
|
4282
|
+
};
|
|
4283
|
+
};
|
|
4284
|
+
};
|
|
4285
|
+
createTestCaseDefinition: {
|
|
4286
|
+
parameters: {
|
|
4287
|
+
query?: never;
|
|
4288
|
+
header?: never;
|
|
4289
|
+
path?: never;
|
|
4290
|
+
cookie?: never;
|
|
4291
|
+
};
|
|
4292
|
+
requestBody: {
|
|
4293
|
+
content: {
|
|
4294
|
+
"application/json": components["schemas"]["CreateTestCaseDefinitionRequest"];
|
|
4295
|
+
};
|
|
4296
|
+
};
|
|
4297
|
+
responses: {
|
|
4298
|
+
/** @description Created test case definition. */
|
|
4299
|
+
201: {
|
|
4300
|
+
headers: {
|
|
4301
|
+
[name: string]: unknown;
|
|
4302
|
+
};
|
|
4303
|
+
content: {
|
|
4304
|
+
"application/json": components["schemas"]["TestCaseDefinition"];
|
|
4305
|
+
};
|
|
4306
|
+
};
|
|
4307
|
+
};
|
|
4308
|
+
};
|
|
4309
|
+
listBatchTests: {
|
|
4310
|
+
parameters: {
|
|
4311
|
+
query: {
|
|
4312
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4313
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4314
|
+
/** @description Response engine type used by an existing test case definition. */
|
|
4315
|
+
type: components["parameters"]["TestCaseDefinitionTypeQuery"];
|
|
4316
|
+
/** @description LLM identifier filter. */
|
|
4317
|
+
llmId?: components["parameters"]["LlmIdQuery"];
|
|
4318
|
+
/** @description Conversation flow identifier filter. */
|
|
4319
|
+
conversationFlowId?: components["parameters"]["ConversationFlowIdQuery"];
|
|
4320
|
+
/** @description Specific version to retrieve or update. */
|
|
4321
|
+
version?: components["parameters"]["VersionQuery"];
|
|
4322
|
+
/** @description Maximum number of records to return. */
|
|
4323
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
4324
|
+
/** @description Identifier to continue pagination. */
|
|
4325
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
4326
|
+
};
|
|
4327
|
+
header?: never;
|
|
4328
|
+
path?: never;
|
|
4329
|
+
cookie?: never;
|
|
4330
|
+
};
|
|
4331
|
+
requestBody?: never;
|
|
4332
|
+
responses: {
|
|
4333
|
+
/** @description Batch test jobs. */
|
|
4334
|
+
200: {
|
|
4335
|
+
headers: {
|
|
4336
|
+
[name: string]: unknown;
|
|
4337
|
+
};
|
|
4338
|
+
content: {
|
|
4339
|
+
"application/json": components["schemas"]["BatchTest"][];
|
|
4340
|
+
};
|
|
4341
|
+
};
|
|
4342
|
+
};
|
|
4343
|
+
};
|
|
4344
|
+
createBatchTest: {
|
|
4345
|
+
parameters: {
|
|
4346
|
+
query?: never;
|
|
4347
|
+
header?: never;
|
|
4348
|
+
path?: never;
|
|
4349
|
+
cookie?: never;
|
|
4350
|
+
};
|
|
4351
|
+
requestBody: {
|
|
4352
|
+
content: {
|
|
4353
|
+
"application/json": components["schemas"]["CreateBatchTestRequest"];
|
|
4354
|
+
};
|
|
4355
|
+
};
|
|
4356
|
+
responses: {
|
|
4357
|
+
/** @description Created batch test job. */
|
|
4358
|
+
201: {
|
|
4359
|
+
headers: {
|
|
4360
|
+
[name: string]: unknown;
|
|
4361
|
+
};
|
|
4362
|
+
content: {
|
|
4363
|
+
"application/json": components["schemas"]["BatchTest"];
|
|
4364
|
+
};
|
|
4365
|
+
};
|
|
4366
|
+
};
|
|
4367
|
+
};
|
|
4368
|
+
getBatchTest: {
|
|
4369
|
+
parameters: {
|
|
4370
|
+
query: {
|
|
4371
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4372
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4373
|
+
};
|
|
4374
|
+
header?: never;
|
|
4375
|
+
path: {
|
|
4376
|
+
/** @description Test run batch identifier. */
|
|
4377
|
+
testCaseBatchJobId: components["parameters"]["TestCaseBatchJobIdPath"];
|
|
4378
|
+
};
|
|
4379
|
+
cookie?: never;
|
|
4380
|
+
};
|
|
4381
|
+
requestBody?: never;
|
|
4382
|
+
responses: {
|
|
4383
|
+
/** @description Batch test job. */
|
|
4384
|
+
200: {
|
|
4385
|
+
headers: {
|
|
4386
|
+
[name: string]: unknown;
|
|
4387
|
+
};
|
|
4388
|
+
content: {
|
|
4389
|
+
"application/json": components["schemas"]["BatchTest"];
|
|
4390
|
+
};
|
|
4391
|
+
};
|
|
4392
|
+
};
|
|
4393
|
+
};
|
|
4394
|
+
getTestCaseDefinition: {
|
|
4395
|
+
parameters: {
|
|
4396
|
+
query: {
|
|
4397
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4398
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4399
|
+
};
|
|
4400
|
+
header?: never;
|
|
4401
|
+
path: {
|
|
4402
|
+
/** @description Test case definition identifier. */
|
|
4403
|
+
testCaseDefinitionId: components["parameters"]["TestCaseDefinitionIdPath"];
|
|
4404
|
+
};
|
|
4405
|
+
cookie?: never;
|
|
4406
|
+
};
|
|
4407
|
+
requestBody?: never;
|
|
4408
|
+
responses: {
|
|
4409
|
+
/** @description Test case definition. */
|
|
4410
|
+
200: {
|
|
4411
|
+
headers: {
|
|
4412
|
+
[name: string]: unknown;
|
|
4413
|
+
};
|
|
4414
|
+
content: {
|
|
4415
|
+
"application/json": components["schemas"]["TestCaseDefinition"];
|
|
4416
|
+
};
|
|
4417
|
+
};
|
|
4418
|
+
};
|
|
4419
|
+
};
|
|
4420
|
+
updateTestCaseDefinition: {
|
|
4421
|
+
parameters: {
|
|
4422
|
+
query?: never;
|
|
4423
|
+
header?: never;
|
|
4424
|
+
path: {
|
|
4425
|
+
/** @description Test case definition identifier. */
|
|
4426
|
+
testCaseDefinitionId: components["parameters"]["TestCaseDefinitionIdPath"];
|
|
4427
|
+
};
|
|
4428
|
+
cookie?: never;
|
|
4429
|
+
};
|
|
4430
|
+
requestBody: {
|
|
4431
|
+
content: {
|
|
4432
|
+
"application/json": components["schemas"]["UpdateTestCaseDefinitionRequest"];
|
|
4433
|
+
};
|
|
4434
|
+
};
|
|
4435
|
+
responses: {
|
|
4436
|
+
/** @description Updated test case definition. */
|
|
4437
|
+
200: {
|
|
4438
|
+
headers: {
|
|
4439
|
+
[name: string]: unknown;
|
|
4440
|
+
};
|
|
4441
|
+
content: {
|
|
4442
|
+
"application/json": components["schemas"]["TestCaseDefinition"];
|
|
4443
|
+
};
|
|
4444
|
+
};
|
|
4445
|
+
};
|
|
4446
|
+
};
|
|
4447
|
+
deleteTestCaseDefinition: {
|
|
4448
|
+
parameters: {
|
|
4449
|
+
query: {
|
|
4450
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4451
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4452
|
+
};
|
|
4453
|
+
header?: never;
|
|
4454
|
+
path: {
|
|
4455
|
+
/** @description Test case definition identifier. */
|
|
4456
|
+
testCaseDefinitionId: components["parameters"]["TestCaseDefinitionIdPath"];
|
|
4457
|
+
};
|
|
4458
|
+
cookie?: never;
|
|
4459
|
+
};
|
|
4460
|
+
requestBody?: never;
|
|
4461
|
+
responses: {
|
|
4462
|
+
/** @description Test case definition deleted. */
|
|
4463
|
+
204: {
|
|
4464
|
+
headers: {
|
|
4465
|
+
[name: string]: unknown;
|
|
4466
|
+
};
|
|
4467
|
+
content?: never;
|
|
4468
|
+
};
|
|
4469
|
+
};
|
|
4470
|
+
};
|
|
4471
|
+
getTestRun: {
|
|
4472
|
+
parameters: {
|
|
4473
|
+
query: {
|
|
4474
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4475
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4476
|
+
};
|
|
4477
|
+
header?: never;
|
|
4478
|
+
path: {
|
|
4479
|
+
/** @description Test run job identifier. */
|
|
4480
|
+
testCaseJobId: components["parameters"]["TestCaseJobIdPath"];
|
|
4481
|
+
};
|
|
4482
|
+
cookie?: never;
|
|
4483
|
+
};
|
|
4484
|
+
requestBody?: never;
|
|
4485
|
+
responses: {
|
|
4486
|
+
/** @description Test run payload. */
|
|
4487
|
+
200: {
|
|
4488
|
+
headers: {
|
|
4489
|
+
[name: string]: unknown;
|
|
4490
|
+
};
|
|
4491
|
+
content: {
|
|
4492
|
+
"application/json": components["schemas"]["TestRun"];
|
|
4493
|
+
};
|
|
4494
|
+
};
|
|
4495
|
+
};
|
|
4496
|
+
};
|
|
4497
|
+
listTestRunsByBatch: {
|
|
4498
|
+
parameters: {
|
|
4499
|
+
query: {
|
|
4500
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4501
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4502
|
+
/** @description Maximum number of records to return. */
|
|
4503
|
+
limit?: components["parameters"]["LimitQuery"];
|
|
4504
|
+
/** @description Identifier to continue pagination. */
|
|
4505
|
+
paginationKey?: components["parameters"]["PaginationKeyQuery"];
|
|
4506
|
+
};
|
|
4507
|
+
header?: never;
|
|
4508
|
+
path: {
|
|
4509
|
+
/** @description Test run batch identifier. */
|
|
4510
|
+
testCaseBatchJobId: components["parameters"]["TestCaseBatchJobIdPath"];
|
|
4511
|
+
};
|
|
4512
|
+
cookie?: never;
|
|
4513
|
+
};
|
|
4514
|
+
requestBody?: never;
|
|
4515
|
+
responses: {
|
|
4516
|
+
/** @description Batch test runs. */
|
|
4517
|
+
200: {
|
|
4518
|
+
headers: {
|
|
4519
|
+
[name: string]: unknown;
|
|
4520
|
+
};
|
|
4521
|
+
content: {
|
|
4522
|
+
"application/json": components["schemas"]["TestRun"][];
|
|
4523
|
+
};
|
|
4524
|
+
};
|
|
4525
|
+
};
|
|
4526
|
+
};
|
|
4527
|
+
getConcurrency: {
|
|
4528
|
+
parameters: {
|
|
4529
|
+
query: {
|
|
4530
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4531
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4532
|
+
};
|
|
4533
|
+
header?: never;
|
|
4534
|
+
path?: never;
|
|
4535
|
+
cookie?: never;
|
|
4536
|
+
};
|
|
4537
|
+
requestBody?: never;
|
|
4538
|
+
responses: {
|
|
4539
|
+
/** @description Concurrency snapshot. */
|
|
4540
|
+
200: {
|
|
4541
|
+
headers: {
|
|
4542
|
+
[name: string]: unknown;
|
|
4543
|
+
};
|
|
4544
|
+
content: {
|
|
4545
|
+
"application/json": components["schemas"]["Concurrency"];
|
|
4546
|
+
};
|
|
4547
|
+
};
|
|
4548
|
+
};
|
|
4549
|
+
};
|
|
4550
|
+
listWorkspaces: {
|
|
4551
|
+
parameters: {
|
|
4552
|
+
query?: never;
|
|
4553
|
+
header?: never;
|
|
4554
|
+
path?: never;
|
|
4555
|
+
cookie?: never;
|
|
4556
|
+
};
|
|
4557
|
+
requestBody?: never;
|
|
4558
|
+
responses: {
|
|
4559
|
+
/** @description Workspaces visible to the authenticated token. */
|
|
4560
|
+
200: {
|
|
4561
|
+
headers: {
|
|
4562
|
+
[name: string]: unknown;
|
|
4563
|
+
};
|
|
4564
|
+
content: {
|
|
4565
|
+
"application/json": {
|
|
4566
|
+
workspaces: components["schemas"]["WorkspaceSummary"][];
|
|
4567
|
+
};
|
|
4568
|
+
};
|
|
4569
|
+
};
|
|
4570
|
+
};
|
|
4571
|
+
};
|
|
4572
|
+
createPhoneCall: {
|
|
4573
|
+
parameters: {
|
|
4574
|
+
query?: never;
|
|
4575
|
+
header?: never;
|
|
4576
|
+
path?: never;
|
|
4577
|
+
cookie?: never;
|
|
4578
|
+
};
|
|
4579
|
+
requestBody: {
|
|
4580
|
+
content: {
|
|
4581
|
+
"application/json": components["schemas"]["CreatePhoneCallRequest"];
|
|
4582
|
+
};
|
|
4583
|
+
};
|
|
4584
|
+
responses: {
|
|
4585
|
+
/** @description Call initiation response. */
|
|
4586
|
+
201: {
|
|
4587
|
+
headers: {
|
|
4588
|
+
[name: string]: unknown;
|
|
4589
|
+
};
|
|
4590
|
+
content: {
|
|
4591
|
+
"application/json": components["schemas"]["CreatePhoneCallResponse"];
|
|
4592
|
+
};
|
|
4593
|
+
};
|
|
4594
|
+
/** @description Invalid request. Unknown fields, invalid dynamic variable values, or conflicting dynamic variable objects are rejected before dialing. */
|
|
4595
|
+
400: {
|
|
4596
|
+
headers: {
|
|
4597
|
+
[name: string]: unknown;
|
|
4598
|
+
};
|
|
4599
|
+
content: {
|
|
4600
|
+
"application/json": {
|
|
4601
|
+
error?: string;
|
|
4602
|
+
unknownFields?: string[];
|
|
4603
|
+
dynamicVariablesField?: string;
|
|
4604
|
+
field?: string;
|
|
4605
|
+
invalidKeys?: string[];
|
|
4606
|
+
};
|
|
4607
|
+
};
|
|
4608
|
+
};
|
|
4609
|
+
};
|
|
4610
|
+
};
|
|
4611
|
+
createWebCall: {
|
|
4612
|
+
parameters: {
|
|
4613
|
+
query?: never;
|
|
4614
|
+
header?: never;
|
|
4615
|
+
path?: never;
|
|
4616
|
+
cookie?: never;
|
|
4617
|
+
};
|
|
4618
|
+
requestBody: {
|
|
4619
|
+
content: {
|
|
4620
|
+
"application/json": components["schemas"]["CreateWebCallRequest"];
|
|
4621
|
+
};
|
|
4622
|
+
};
|
|
4623
|
+
responses: {
|
|
4624
|
+
/** @description Web call created. */
|
|
4625
|
+
201: {
|
|
4626
|
+
headers: {
|
|
4627
|
+
[name: string]: unknown;
|
|
4628
|
+
};
|
|
4629
|
+
content: {
|
|
4630
|
+
"application/json": components["schemas"]["WebCall"];
|
|
4631
|
+
};
|
|
4632
|
+
};
|
|
4633
|
+
};
|
|
4634
|
+
};
|
|
4635
|
+
listCalls: {
|
|
4636
|
+
parameters: {
|
|
4637
|
+
query?: {
|
|
4638
|
+
/** @description Optional workspace identifier filter. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4639
|
+
workspaceId?: components["parameters"]["WorkspaceIdQueryOptional"];
|
|
4640
|
+
/** @description Filter call listings to a specific agent. */
|
|
4641
|
+
agentId?: components["parameters"]["AgentIdQuery"];
|
|
4642
|
+
/** @description Filter calls by status. */
|
|
4643
|
+
status?: components["parameters"]["StatusQuery"];
|
|
4644
|
+
/** @description Inclusive start date for call listing filter. */
|
|
4645
|
+
fromDate?: components["parameters"]["FromDateQuery"];
|
|
4646
|
+
/** @description Inclusive end date for call listing filter. */
|
|
4647
|
+
toDate?: components["parameters"]["ToDateQuery"];
|
|
4648
|
+
page?: components["parameters"]["PageQuery"];
|
|
4649
|
+
/** @description Page size for list endpoints. */
|
|
4650
|
+
limit?: components["parameters"]["LimitQueryDefault20"];
|
|
4651
|
+
};
|
|
4652
|
+
header?: never;
|
|
4653
|
+
path?: never;
|
|
4654
|
+
cookie?: never;
|
|
4655
|
+
};
|
|
4656
|
+
requestBody?: never;
|
|
4657
|
+
responses: {
|
|
4658
|
+
/** @description Paginated call list. */
|
|
4659
|
+
200: {
|
|
4660
|
+
headers: {
|
|
4661
|
+
[name: string]: unknown;
|
|
4662
|
+
};
|
|
4663
|
+
content: {
|
|
4664
|
+
"application/json": components["schemas"]["CallList"];
|
|
4665
|
+
};
|
|
4666
|
+
};
|
|
4667
|
+
};
|
|
4668
|
+
};
|
|
4669
|
+
listCallsFiltered: {
|
|
4670
|
+
parameters: {
|
|
4671
|
+
query?: never;
|
|
4672
|
+
header?: never;
|
|
4673
|
+
path?: never;
|
|
4674
|
+
cookie?: never;
|
|
4675
|
+
};
|
|
4676
|
+
requestBody?: {
|
|
4677
|
+
content: {
|
|
4678
|
+
"application/json": components["schemas"]["V3ListCallsRequest"];
|
|
4679
|
+
};
|
|
4680
|
+
};
|
|
4681
|
+
responses: {
|
|
4682
|
+
/** @description Calls matching the provided filters. */
|
|
4683
|
+
200: {
|
|
4684
|
+
headers: {
|
|
4685
|
+
[name: string]: unknown;
|
|
4686
|
+
};
|
|
4687
|
+
content: {
|
|
4688
|
+
"application/json": components["schemas"]["V3ListCallsResponse"];
|
|
4689
|
+
};
|
|
4690
|
+
};
|
|
4691
|
+
/** @description Invalid filter or pagination request. */
|
|
4692
|
+
400: {
|
|
4693
|
+
headers: {
|
|
4694
|
+
[name: string]: unknown;
|
|
4695
|
+
};
|
|
4696
|
+
content?: never;
|
|
4697
|
+
};
|
|
4698
|
+
};
|
|
4699
|
+
};
|
|
4700
|
+
fetchCallHistory: {
|
|
4701
|
+
parameters: {
|
|
4702
|
+
query: {
|
|
4703
|
+
/** @description Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token. */
|
|
4704
|
+
workspaceId: components["parameters"]["WorkspaceIdQuery"];
|
|
4705
|
+
/** @description Filter call listings to a specific agent. */
|
|
4706
|
+
agentId?: components["parameters"]["AgentIdQuery"];
|
|
4707
|
+
/** @description Filter call history to a specific persisted agent version captured at call time. */
|
|
4708
|
+
agentVersion?: components["parameters"]["AgentVersionQuery"];
|
|
4709
|
+
/** @description Filter calls by status. */
|
|
4710
|
+
status?: components["parameters"]["StatusQuery"];
|
|
4711
|
+
/** @description Search by call SID, phone number, platform call ID, customer name, or agent name. */
|
|
4712
|
+
search?: components["parameters"]["SearchQuery"];
|
|
4713
|
+
/** @description Inclusive start date for call listing filter. */
|
|
4714
|
+
fromDate?: components["parameters"]["FromDateQuery"];
|
|
4715
|
+
/** @description Inclusive end date for call listing filter. */
|
|
4716
|
+
toDate?: components["parameters"]["ToDateQuery"];
|
|
4717
|
+
page?: components["parameters"]["PageQuery"];
|
|
4718
|
+
/** @description Page size for list endpoints. */
|
|
4719
|
+
limit?: components["parameters"]["LimitQueryDefault20"];
|
|
4720
|
+
/** @description When true, include archived calls in the response. */
|
|
4721
|
+
includeArchived?: components["parameters"]["IncludeArchivedQuery"];
|
|
4722
|
+
/** @description When true, include child calls linked to transfer or split-call workflows. */
|
|
4723
|
+
includeChildCalls?: components["parameters"]["IncludeChildCallsQuery"];
|
|
4724
|
+
};
|
|
4725
|
+
header?: never;
|
|
4726
|
+
path?: never;
|
|
4727
|
+
cookie?: never;
|
|
4728
|
+
};
|
|
4729
|
+
requestBody?: never;
|
|
4730
|
+
responses: {
|
|
4731
|
+
/** @description Paginated call history. */
|
|
4732
|
+
200: {
|
|
4733
|
+
headers: {
|
|
4734
|
+
[name: string]: unknown;
|
|
4735
|
+
};
|
|
4736
|
+
content: {
|
|
4737
|
+
"application/json": components["schemas"]["CallHistoryList"];
|
|
4738
|
+
};
|
|
4739
|
+
};
|
|
4740
|
+
};
|
|
4741
|
+
};
|
|
4742
|
+
getCall: {
|
|
4743
|
+
parameters: {
|
|
4744
|
+
query?: never;
|
|
4745
|
+
header?: never;
|
|
4746
|
+
path: {
|
|
4747
|
+
/** @description Call identifier or SID. */
|
|
4748
|
+
callId: components["parameters"]["CallIdPath"];
|
|
4749
|
+
};
|
|
4750
|
+
cookie?: never;
|
|
4751
|
+
};
|
|
4752
|
+
requestBody?: never;
|
|
4753
|
+
responses: {
|
|
4754
|
+
/** @description Call details. */
|
|
4755
|
+
200: {
|
|
4756
|
+
headers: {
|
|
4757
|
+
[name: string]: unknown;
|
|
4758
|
+
};
|
|
4759
|
+
content: {
|
|
4760
|
+
"application/json": components["schemas"]["CallDetail"];
|
|
4761
|
+
};
|
|
4762
|
+
};
|
|
4763
|
+
};
|
|
4764
|
+
};
|
|
4765
|
+
updateCall: {
|
|
4766
|
+
parameters: {
|
|
4767
|
+
query?: never;
|
|
4768
|
+
header?: never;
|
|
4769
|
+
path: {
|
|
4770
|
+
/** @description Call identifier or SID. */
|
|
4771
|
+
callId: components["parameters"]["CallIdPath"];
|
|
4772
|
+
};
|
|
4773
|
+
cookie?: never;
|
|
4774
|
+
};
|
|
4775
|
+
requestBody: {
|
|
4776
|
+
content: {
|
|
4777
|
+
"application/json": components["schemas"]["UpdateCallRequest"];
|
|
4778
|
+
};
|
|
4779
|
+
};
|
|
4780
|
+
responses: {
|
|
4781
|
+
/** @description Updated call record. */
|
|
4782
|
+
200: {
|
|
4783
|
+
headers: {
|
|
4784
|
+
[name: string]: unknown;
|
|
4785
|
+
};
|
|
4786
|
+
content: {
|
|
4787
|
+
"application/json": components["schemas"]["CallRecord"];
|
|
4788
|
+
};
|
|
4789
|
+
};
|
|
4790
|
+
};
|
|
4791
|
+
};
|
|
4792
|
+
endLiveCall: {
|
|
4793
|
+
parameters: {
|
|
4794
|
+
query?: never;
|
|
4795
|
+
header?: never;
|
|
4796
|
+
path: {
|
|
4797
|
+
/** @description Call identifier or SID. */
|
|
4798
|
+
callId: components["parameters"]["CallIdPath"];
|
|
4799
|
+
};
|
|
4800
|
+
cookie?: never;
|
|
4801
|
+
};
|
|
4802
|
+
requestBody?: {
|
|
4803
|
+
content: {
|
|
4804
|
+
"application/json": components["schemas"]["CallActionWorkspaceRequest"];
|
|
4805
|
+
};
|
|
4806
|
+
};
|
|
4807
|
+
responses: {
|
|
4808
|
+
/** @description Live call ended. */
|
|
4809
|
+
200: {
|
|
4810
|
+
headers: {
|
|
4811
|
+
[name: string]: unknown;
|
|
4812
|
+
};
|
|
4813
|
+
content: {
|
|
4814
|
+
"application/json": components["schemas"]["EndLiveCallResponse"];
|
|
4815
|
+
};
|
|
4816
|
+
};
|
|
4817
|
+
/** @description The call is no longer live. */
|
|
4818
|
+
409: {
|
|
4819
|
+
headers: {
|
|
4820
|
+
[name: string]: unknown;
|
|
4821
|
+
};
|
|
4822
|
+
content?: never;
|
|
4823
|
+
};
|
|
4824
|
+
};
|
|
4825
|
+
};
|
|
4826
|
+
updateLiveCall: {
|
|
4827
|
+
parameters: {
|
|
4828
|
+
query?: never;
|
|
4829
|
+
header?: never;
|
|
4830
|
+
path: {
|
|
4831
|
+
/** @description Call identifier or SID. */
|
|
4832
|
+
callId: components["parameters"]["CallIdPath"];
|
|
4833
|
+
};
|
|
4834
|
+
cookie?: never;
|
|
4835
|
+
};
|
|
4836
|
+
requestBody: {
|
|
4837
|
+
content: {
|
|
4838
|
+
"application/json": components["schemas"]["UpdateLiveCallRequest"];
|
|
4839
|
+
};
|
|
4840
|
+
};
|
|
4841
|
+
responses: {
|
|
4842
|
+
/** @description Live call updated. */
|
|
4843
|
+
200: {
|
|
4844
|
+
headers: {
|
|
4845
|
+
[name: string]: unknown;
|
|
4846
|
+
};
|
|
4847
|
+
content: {
|
|
4848
|
+
"application/json": components["schemas"]["UpdateLiveCallResponse"];
|
|
4849
|
+
};
|
|
4850
|
+
};
|
|
4851
|
+
/** @description The call is no longer live. */
|
|
4852
|
+
409: {
|
|
4853
|
+
headers: {
|
|
4854
|
+
[name: string]: unknown;
|
|
4855
|
+
};
|
|
4856
|
+
content?: never;
|
|
4857
|
+
};
|
|
4858
|
+
};
|
|
4859
|
+
};
|
|
4860
|
+
rerunCallAnalysis: {
|
|
4861
|
+
parameters: {
|
|
4862
|
+
query?: never;
|
|
4863
|
+
header?: never;
|
|
4864
|
+
path: {
|
|
4865
|
+
/** @description Call identifier or SID. */
|
|
4866
|
+
callId: components["parameters"]["CallIdPath"];
|
|
4867
|
+
};
|
|
4868
|
+
cookie?: never;
|
|
4869
|
+
};
|
|
4870
|
+
requestBody?: {
|
|
4871
|
+
content: {
|
|
4872
|
+
"application/json": components["schemas"]["CallActionWorkspaceRequest"];
|
|
4873
|
+
};
|
|
4874
|
+
};
|
|
4875
|
+
responses: {
|
|
4876
|
+
/** @description Call analysis rerun started or completed. */
|
|
4877
|
+
201: {
|
|
4878
|
+
headers: {
|
|
4879
|
+
[name: string]: unknown;
|
|
4880
|
+
};
|
|
4881
|
+
content: {
|
|
4882
|
+
"application/json": components["schemas"]["RerunCallAnalysisResponse"];
|
|
4883
|
+
};
|
|
4884
|
+
};
|
|
4885
|
+
};
|
|
4886
|
+
};
|
|
4887
|
+
}
|