@upon-ai/sdk 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/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/metadata.js
ADDED
|
@@ -0,0 +1,2142 @@
|
|
|
1
|
+
// Generated from the approved public contract.
|
|
2
|
+
export const metadata = {
|
|
3
|
+
"listLlms": {
|
|
4
|
+
"path": "/api/v1/llms",
|
|
5
|
+
"method": "get",
|
|
6
|
+
"summary": "List LLMs",
|
|
7
|
+
"parameters": [
|
|
8
|
+
{
|
|
9
|
+
"name": "workspaceId",
|
|
10
|
+
"in": "query",
|
|
11
|
+
"required": true,
|
|
12
|
+
"schema": {
|
|
13
|
+
"type": "integer"
|
|
14
|
+
},
|
|
15
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
16
|
+
},
|
|
17
|
+
{
|
|
18
|
+
"name": "limit",
|
|
19
|
+
"in": "query",
|
|
20
|
+
"required": false,
|
|
21
|
+
"schema": {
|
|
22
|
+
"type": "integer",
|
|
23
|
+
"minimum": 1,
|
|
24
|
+
"maximum": 1000,
|
|
25
|
+
"default": 1000
|
|
26
|
+
},
|
|
27
|
+
"description": "Maximum number of records to return."
|
|
28
|
+
},
|
|
29
|
+
{
|
|
30
|
+
"name": "paginationKey",
|
|
31
|
+
"in": "query",
|
|
32
|
+
"required": false,
|
|
33
|
+
"schema": {
|
|
34
|
+
"type": "string"
|
|
35
|
+
},
|
|
36
|
+
"description": "Identifier to continue pagination."
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
"name": "paginationKeyVersion",
|
|
40
|
+
"in": "query",
|
|
41
|
+
"required": false,
|
|
42
|
+
"schema": {
|
|
43
|
+
"type": "integer"
|
|
44
|
+
},
|
|
45
|
+
"description": "Version paired with the pagination key."
|
|
46
|
+
}
|
|
47
|
+
],
|
|
48
|
+
"bodyRequired": false,
|
|
49
|
+
"bodyType": null,
|
|
50
|
+
"bodySchema": null
|
|
51
|
+
},
|
|
52
|
+
"createLlm": {
|
|
53
|
+
"path": "/api/v1/llms",
|
|
54
|
+
"method": "post",
|
|
55
|
+
"summary": "Create LLM",
|
|
56
|
+
"parameters": [],
|
|
57
|
+
"bodyRequired": true,
|
|
58
|
+
"bodyType": "application/json",
|
|
59
|
+
"bodySchema": {
|
|
60
|
+
"$ref": "#/components/schemas/CreateLlmRequest"
|
|
61
|
+
}
|
|
62
|
+
},
|
|
63
|
+
"getLlm": {
|
|
64
|
+
"path": "/api/v1/llms/{llmId}",
|
|
65
|
+
"method": "get",
|
|
66
|
+
"summary": "Get LLM",
|
|
67
|
+
"parameters": [
|
|
68
|
+
{
|
|
69
|
+
"name": "llmId",
|
|
70
|
+
"in": "path",
|
|
71
|
+
"required": true,
|
|
72
|
+
"schema": {
|
|
73
|
+
"type": "string"
|
|
74
|
+
},
|
|
75
|
+
"description": "LLM identifier."
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"name": "workspaceId",
|
|
79
|
+
"in": "query",
|
|
80
|
+
"required": true,
|
|
81
|
+
"schema": {
|
|
82
|
+
"type": "integer"
|
|
83
|
+
},
|
|
84
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
85
|
+
},
|
|
86
|
+
{
|
|
87
|
+
"name": "version",
|
|
88
|
+
"in": "query",
|
|
89
|
+
"required": false,
|
|
90
|
+
"schema": {
|
|
91
|
+
"type": "integer",
|
|
92
|
+
"minimum": 0
|
|
93
|
+
},
|
|
94
|
+
"description": "Specific version to retrieve or update."
|
|
95
|
+
}
|
|
96
|
+
],
|
|
97
|
+
"bodyRequired": false,
|
|
98
|
+
"bodyType": null,
|
|
99
|
+
"bodySchema": null
|
|
100
|
+
},
|
|
101
|
+
"updateLlm": {
|
|
102
|
+
"path": "/api/v1/llms/{llmId}",
|
|
103
|
+
"method": "patch",
|
|
104
|
+
"summary": "Update LLM",
|
|
105
|
+
"parameters": [
|
|
106
|
+
{
|
|
107
|
+
"name": "llmId",
|
|
108
|
+
"in": "path",
|
|
109
|
+
"required": true,
|
|
110
|
+
"schema": {
|
|
111
|
+
"type": "string"
|
|
112
|
+
},
|
|
113
|
+
"description": "LLM identifier."
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "version",
|
|
117
|
+
"in": "query",
|
|
118
|
+
"required": false,
|
|
119
|
+
"schema": {
|
|
120
|
+
"type": "integer",
|
|
121
|
+
"minimum": 0
|
|
122
|
+
},
|
|
123
|
+
"description": "Specific version to retrieve or update."
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
"bodyRequired": true,
|
|
127
|
+
"bodyType": "application/json",
|
|
128
|
+
"bodySchema": {
|
|
129
|
+
"$ref": "#/components/schemas/UpdateLlmRequest"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
"deleteLlm": {
|
|
133
|
+
"path": "/api/v1/llms/{llmId}",
|
|
134
|
+
"method": "delete",
|
|
135
|
+
"summary": "Delete LLM",
|
|
136
|
+
"parameters": [
|
|
137
|
+
{
|
|
138
|
+
"name": "llmId",
|
|
139
|
+
"in": "path",
|
|
140
|
+
"required": true,
|
|
141
|
+
"schema": {
|
|
142
|
+
"type": "string"
|
|
143
|
+
},
|
|
144
|
+
"description": "LLM identifier."
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"name": "workspaceId",
|
|
148
|
+
"in": "query",
|
|
149
|
+
"required": true,
|
|
150
|
+
"schema": {
|
|
151
|
+
"type": "integer"
|
|
152
|
+
},
|
|
153
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
154
|
+
}
|
|
155
|
+
],
|
|
156
|
+
"bodyRequired": false,
|
|
157
|
+
"bodyType": null,
|
|
158
|
+
"bodySchema": null
|
|
159
|
+
},
|
|
160
|
+
"listAgents": {
|
|
161
|
+
"path": "/api/v1/agents",
|
|
162
|
+
"method": "get",
|
|
163
|
+
"summary": "List agents",
|
|
164
|
+
"parameters": [
|
|
165
|
+
{
|
|
166
|
+
"name": "workspaceId",
|
|
167
|
+
"in": "query",
|
|
168
|
+
"required": true,
|
|
169
|
+
"schema": {
|
|
170
|
+
"type": "integer"
|
|
171
|
+
},
|
|
172
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
"name": "limit",
|
|
176
|
+
"in": "query",
|
|
177
|
+
"required": false,
|
|
178
|
+
"schema": {
|
|
179
|
+
"type": "integer",
|
|
180
|
+
"minimum": 1,
|
|
181
|
+
"maximum": 1000,
|
|
182
|
+
"default": 1000
|
|
183
|
+
},
|
|
184
|
+
"description": "Maximum number of records to return."
|
|
185
|
+
},
|
|
186
|
+
{
|
|
187
|
+
"name": "paginationKey",
|
|
188
|
+
"in": "query",
|
|
189
|
+
"required": false,
|
|
190
|
+
"schema": {
|
|
191
|
+
"type": "string"
|
|
192
|
+
},
|
|
193
|
+
"description": "Identifier to continue pagination."
|
|
194
|
+
},
|
|
195
|
+
{
|
|
196
|
+
"name": "paginationKeyVersion",
|
|
197
|
+
"in": "query",
|
|
198
|
+
"required": false,
|
|
199
|
+
"schema": {
|
|
200
|
+
"type": "integer"
|
|
201
|
+
},
|
|
202
|
+
"description": "Version paired with the pagination key."
|
|
203
|
+
}
|
|
204
|
+
],
|
|
205
|
+
"bodyRequired": false,
|
|
206
|
+
"bodyType": null,
|
|
207
|
+
"bodySchema": null
|
|
208
|
+
},
|
|
209
|
+
"createAgent": {
|
|
210
|
+
"path": "/api/v1/agents",
|
|
211
|
+
"method": "post",
|
|
212
|
+
"summary": "Create agent",
|
|
213
|
+
"parameters": [],
|
|
214
|
+
"bodyRequired": true,
|
|
215
|
+
"bodyType": "application/json",
|
|
216
|
+
"bodySchema": {
|
|
217
|
+
"$ref": "#/components/schemas/CreateAgentRequest"
|
|
218
|
+
}
|
|
219
|
+
},
|
|
220
|
+
"getAgent": {
|
|
221
|
+
"path": "/api/v1/agents/{agentId}",
|
|
222
|
+
"method": "get",
|
|
223
|
+
"summary": "Get agent",
|
|
224
|
+
"parameters": [
|
|
225
|
+
{
|
|
226
|
+
"name": "agentId",
|
|
227
|
+
"in": "path",
|
|
228
|
+
"required": true,
|
|
229
|
+
"schema": {
|
|
230
|
+
"type": "string"
|
|
231
|
+
},
|
|
232
|
+
"description": "Agent identifier."
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"name": "workspaceId",
|
|
236
|
+
"in": "query",
|
|
237
|
+
"required": true,
|
|
238
|
+
"schema": {
|
|
239
|
+
"type": "integer"
|
|
240
|
+
},
|
|
241
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
242
|
+
},
|
|
243
|
+
{
|
|
244
|
+
"name": "version",
|
|
245
|
+
"in": "query",
|
|
246
|
+
"required": false,
|
|
247
|
+
"schema": {
|
|
248
|
+
"type": "integer",
|
|
249
|
+
"minimum": 0
|
|
250
|
+
},
|
|
251
|
+
"description": "Specific version to retrieve or update."
|
|
252
|
+
}
|
|
253
|
+
],
|
|
254
|
+
"bodyRequired": false,
|
|
255
|
+
"bodyType": null,
|
|
256
|
+
"bodySchema": null
|
|
257
|
+
},
|
|
258
|
+
"updateAgent": {
|
|
259
|
+
"path": "/api/v1/agents/{agentId}",
|
|
260
|
+
"method": "patch",
|
|
261
|
+
"summary": "Update agent",
|
|
262
|
+
"parameters": [
|
|
263
|
+
{
|
|
264
|
+
"name": "agentId",
|
|
265
|
+
"in": "path",
|
|
266
|
+
"required": true,
|
|
267
|
+
"schema": {
|
|
268
|
+
"type": "string"
|
|
269
|
+
},
|
|
270
|
+
"description": "Agent identifier."
|
|
271
|
+
},
|
|
272
|
+
{
|
|
273
|
+
"name": "version",
|
|
274
|
+
"in": "query",
|
|
275
|
+
"required": false,
|
|
276
|
+
"schema": {
|
|
277
|
+
"type": "integer",
|
|
278
|
+
"minimum": 0
|
|
279
|
+
},
|
|
280
|
+
"description": "Specific version to retrieve or update."
|
|
281
|
+
}
|
|
282
|
+
],
|
|
283
|
+
"bodyRequired": true,
|
|
284
|
+
"bodyType": "application/json",
|
|
285
|
+
"bodySchema": {
|
|
286
|
+
"$ref": "#/components/schemas/UpdateAgentRequest"
|
|
287
|
+
}
|
|
288
|
+
},
|
|
289
|
+
"deleteAgent": {
|
|
290
|
+
"path": "/api/v1/agents/{agentId}",
|
|
291
|
+
"method": "delete",
|
|
292
|
+
"summary": "Delete agent",
|
|
293
|
+
"parameters": [
|
|
294
|
+
{
|
|
295
|
+
"name": "agentId",
|
|
296
|
+
"in": "path",
|
|
297
|
+
"required": true,
|
|
298
|
+
"schema": {
|
|
299
|
+
"type": "string"
|
|
300
|
+
},
|
|
301
|
+
"description": "Agent identifier."
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
"name": "workspaceId",
|
|
305
|
+
"in": "query",
|
|
306
|
+
"required": true,
|
|
307
|
+
"schema": {
|
|
308
|
+
"type": "integer"
|
|
309
|
+
},
|
|
310
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
311
|
+
}
|
|
312
|
+
],
|
|
313
|
+
"bodyRequired": false,
|
|
314
|
+
"bodyType": null,
|
|
315
|
+
"bodySchema": null
|
|
316
|
+
},
|
|
317
|
+
"listAgentVersions": {
|
|
318
|
+
"path": "/api/v1/agents/{agentId}/versions",
|
|
319
|
+
"method": "get",
|
|
320
|
+
"summary": "List agent versions",
|
|
321
|
+
"parameters": [
|
|
322
|
+
{
|
|
323
|
+
"name": "agentId",
|
|
324
|
+
"in": "path",
|
|
325
|
+
"required": true,
|
|
326
|
+
"schema": {
|
|
327
|
+
"type": "string"
|
|
328
|
+
},
|
|
329
|
+
"description": "Agent identifier."
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
"name": "workspaceId",
|
|
333
|
+
"in": "query",
|
|
334
|
+
"required": true,
|
|
335
|
+
"schema": {
|
|
336
|
+
"type": "integer"
|
|
337
|
+
},
|
|
338
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
339
|
+
}
|
|
340
|
+
],
|
|
341
|
+
"bodyRequired": false,
|
|
342
|
+
"bodyType": null,
|
|
343
|
+
"bodySchema": null
|
|
344
|
+
},
|
|
345
|
+
"createAgentDraftVersion": {
|
|
346
|
+
"path": "/api/v1/agents/{agentId}/versions",
|
|
347
|
+
"method": "post",
|
|
348
|
+
"summary": "Create agent draft version",
|
|
349
|
+
"parameters": [
|
|
350
|
+
{
|
|
351
|
+
"name": "agentId",
|
|
352
|
+
"in": "path",
|
|
353
|
+
"required": true,
|
|
354
|
+
"schema": {
|
|
355
|
+
"type": "string"
|
|
356
|
+
},
|
|
357
|
+
"description": "Agent identifier."
|
|
358
|
+
}
|
|
359
|
+
],
|
|
360
|
+
"bodyRequired": true,
|
|
361
|
+
"bodyType": "application/json",
|
|
362
|
+
"bodySchema": {
|
|
363
|
+
"$ref": "#/components/schemas/CreateAgentVersionRequest"
|
|
364
|
+
}
|
|
365
|
+
},
|
|
366
|
+
"publishAgentVersion": {
|
|
367
|
+
"path": "/api/v1/agents/{agentId}/versions/{version}/publish",
|
|
368
|
+
"method": "post",
|
|
369
|
+
"summary": "Publish agent version",
|
|
370
|
+
"parameters": [
|
|
371
|
+
{
|
|
372
|
+
"name": "agentId",
|
|
373
|
+
"in": "path",
|
|
374
|
+
"required": true,
|
|
375
|
+
"schema": {
|
|
376
|
+
"type": "string"
|
|
377
|
+
},
|
|
378
|
+
"description": "Agent identifier."
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
"name": "version",
|
|
382
|
+
"in": "path",
|
|
383
|
+
"required": true,
|
|
384
|
+
"schema": {
|
|
385
|
+
"type": "integer",
|
|
386
|
+
"minimum": 0
|
|
387
|
+
},
|
|
388
|
+
"description": "Specific agent version."
|
|
389
|
+
}
|
|
390
|
+
],
|
|
391
|
+
"bodyRequired": true,
|
|
392
|
+
"bodyType": "application/json",
|
|
393
|
+
"bodySchema": {
|
|
394
|
+
"$ref": "#/components/schemas/PublishAgentVersionRequest"
|
|
395
|
+
}
|
|
396
|
+
},
|
|
397
|
+
"deleteAgentVersion": {
|
|
398
|
+
"path": "/api/v1/agents/{agentId}/versions/{version}",
|
|
399
|
+
"method": "delete",
|
|
400
|
+
"summary": "Delete agent version",
|
|
401
|
+
"parameters": [
|
|
402
|
+
{
|
|
403
|
+
"name": "agentId",
|
|
404
|
+
"in": "path",
|
|
405
|
+
"required": true,
|
|
406
|
+
"schema": {
|
|
407
|
+
"type": "string"
|
|
408
|
+
},
|
|
409
|
+
"description": "Agent identifier."
|
|
410
|
+
},
|
|
411
|
+
{
|
|
412
|
+
"name": "version",
|
|
413
|
+
"in": "path",
|
|
414
|
+
"required": true,
|
|
415
|
+
"schema": {
|
|
416
|
+
"type": "integer",
|
|
417
|
+
"minimum": 0
|
|
418
|
+
},
|
|
419
|
+
"description": "Specific agent version."
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"name": "workspaceId",
|
|
423
|
+
"in": "query",
|
|
424
|
+
"required": true,
|
|
425
|
+
"schema": {
|
|
426
|
+
"type": "integer"
|
|
427
|
+
},
|
|
428
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
429
|
+
}
|
|
430
|
+
],
|
|
431
|
+
"bodyRequired": false,
|
|
432
|
+
"bodyType": null,
|
|
433
|
+
"bodySchema": null
|
|
434
|
+
},
|
|
435
|
+
"listChatAgents": {
|
|
436
|
+
"path": "/api/v1/chat-agents",
|
|
437
|
+
"method": "get",
|
|
438
|
+
"summary": "List chat agents",
|
|
439
|
+
"parameters": [
|
|
440
|
+
{
|
|
441
|
+
"name": "workspaceId",
|
|
442
|
+
"in": "query",
|
|
443
|
+
"required": true,
|
|
444
|
+
"schema": {
|
|
445
|
+
"type": "integer"
|
|
446
|
+
},
|
|
447
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
"name": "limit",
|
|
451
|
+
"in": "query",
|
|
452
|
+
"required": false,
|
|
453
|
+
"schema": {
|
|
454
|
+
"type": "integer",
|
|
455
|
+
"minimum": 1,
|
|
456
|
+
"maximum": 1000,
|
|
457
|
+
"default": 1000
|
|
458
|
+
},
|
|
459
|
+
"description": "Maximum number of records to return."
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
"name": "paginationKey",
|
|
463
|
+
"in": "query",
|
|
464
|
+
"required": false,
|
|
465
|
+
"schema": {
|
|
466
|
+
"type": "string"
|
|
467
|
+
},
|
|
468
|
+
"description": "Identifier to continue pagination."
|
|
469
|
+
},
|
|
470
|
+
{
|
|
471
|
+
"name": "paginationKeyVersion",
|
|
472
|
+
"in": "query",
|
|
473
|
+
"required": false,
|
|
474
|
+
"schema": {
|
|
475
|
+
"type": "integer"
|
|
476
|
+
},
|
|
477
|
+
"description": "Version paired with the pagination key."
|
|
478
|
+
}
|
|
479
|
+
],
|
|
480
|
+
"bodyRequired": false,
|
|
481
|
+
"bodyType": null,
|
|
482
|
+
"bodySchema": null
|
|
483
|
+
},
|
|
484
|
+
"createChatAgent": {
|
|
485
|
+
"path": "/api/v1/chat-agents",
|
|
486
|
+
"method": "post",
|
|
487
|
+
"summary": "Create chat agent",
|
|
488
|
+
"parameters": [],
|
|
489
|
+
"bodyRequired": true,
|
|
490
|
+
"bodyType": "application/json",
|
|
491
|
+
"bodySchema": {
|
|
492
|
+
"$ref": "#/components/schemas/CreateChatAgentRequest"
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
"getChatAgent": {
|
|
496
|
+
"path": "/api/v1/chat-agents/{agentId}",
|
|
497
|
+
"method": "get",
|
|
498
|
+
"summary": "Get chat agent",
|
|
499
|
+
"parameters": [
|
|
500
|
+
{
|
|
501
|
+
"name": "agentId",
|
|
502
|
+
"in": "path",
|
|
503
|
+
"required": true,
|
|
504
|
+
"schema": {
|
|
505
|
+
"type": "string"
|
|
506
|
+
},
|
|
507
|
+
"description": "Agent identifier."
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "workspaceId",
|
|
511
|
+
"in": "query",
|
|
512
|
+
"required": true,
|
|
513
|
+
"schema": {
|
|
514
|
+
"type": "integer"
|
|
515
|
+
},
|
|
516
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
517
|
+
},
|
|
518
|
+
{
|
|
519
|
+
"name": "version",
|
|
520
|
+
"in": "query",
|
|
521
|
+
"required": false,
|
|
522
|
+
"schema": {
|
|
523
|
+
"type": "integer",
|
|
524
|
+
"minimum": 0
|
|
525
|
+
},
|
|
526
|
+
"description": "Specific version to retrieve or update."
|
|
527
|
+
}
|
|
528
|
+
],
|
|
529
|
+
"bodyRequired": false,
|
|
530
|
+
"bodyType": null,
|
|
531
|
+
"bodySchema": null
|
|
532
|
+
},
|
|
533
|
+
"updateChatAgent": {
|
|
534
|
+
"path": "/api/v1/chat-agents/{agentId}",
|
|
535
|
+
"method": "patch",
|
|
536
|
+
"summary": "Update chat agent",
|
|
537
|
+
"parameters": [
|
|
538
|
+
{
|
|
539
|
+
"name": "agentId",
|
|
540
|
+
"in": "path",
|
|
541
|
+
"required": true,
|
|
542
|
+
"schema": {
|
|
543
|
+
"type": "string"
|
|
544
|
+
},
|
|
545
|
+
"description": "Agent identifier."
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"name": "version",
|
|
549
|
+
"in": "query",
|
|
550
|
+
"required": false,
|
|
551
|
+
"schema": {
|
|
552
|
+
"type": "integer",
|
|
553
|
+
"minimum": 0
|
|
554
|
+
},
|
|
555
|
+
"description": "Specific version to retrieve or update."
|
|
556
|
+
}
|
|
557
|
+
],
|
|
558
|
+
"bodyRequired": true,
|
|
559
|
+
"bodyType": "application/json",
|
|
560
|
+
"bodySchema": {
|
|
561
|
+
"$ref": "#/components/schemas/UpdateChatAgentRequest"
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
"deleteChatAgent": {
|
|
565
|
+
"path": "/api/v1/chat-agents/{agentId}",
|
|
566
|
+
"method": "delete",
|
|
567
|
+
"summary": "Delete chat agent",
|
|
568
|
+
"parameters": [
|
|
569
|
+
{
|
|
570
|
+
"name": "agentId",
|
|
571
|
+
"in": "path",
|
|
572
|
+
"required": true,
|
|
573
|
+
"schema": {
|
|
574
|
+
"type": "string"
|
|
575
|
+
},
|
|
576
|
+
"description": "Agent identifier."
|
|
577
|
+
},
|
|
578
|
+
{
|
|
579
|
+
"name": "workspaceId",
|
|
580
|
+
"in": "query",
|
|
581
|
+
"required": true,
|
|
582
|
+
"schema": {
|
|
583
|
+
"type": "integer"
|
|
584
|
+
},
|
|
585
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
586
|
+
}
|
|
587
|
+
],
|
|
588
|
+
"bodyRequired": false,
|
|
589
|
+
"bodyType": null,
|
|
590
|
+
"bodySchema": null
|
|
591
|
+
},
|
|
592
|
+
"listChatAgentVersions": {
|
|
593
|
+
"path": "/api/v1/chat-agents/{agentId}/versions",
|
|
594
|
+
"method": "get",
|
|
595
|
+
"summary": "List chat agent versions",
|
|
596
|
+
"parameters": [
|
|
597
|
+
{
|
|
598
|
+
"name": "agentId",
|
|
599
|
+
"in": "path",
|
|
600
|
+
"required": true,
|
|
601
|
+
"schema": {
|
|
602
|
+
"type": "string"
|
|
603
|
+
},
|
|
604
|
+
"description": "Agent identifier."
|
|
605
|
+
},
|
|
606
|
+
{
|
|
607
|
+
"name": "workspaceId",
|
|
608
|
+
"in": "query",
|
|
609
|
+
"required": true,
|
|
610
|
+
"schema": {
|
|
611
|
+
"type": "integer"
|
|
612
|
+
},
|
|
613
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
614
|
+
}
|
|
615
|
+
],
|
|
616
|
+
"bodyRequired": false,
|
|
617
|
+
"bodyType": null,
|
|
618
|
+
"bodySchema": null
|
|
619
|
+
},
|
|
620
|
+
"createChatAgentDraftVersion": {
|
|
621
|
+
"path": "/api/v1/chat-agents/{agentId}/versions",
|
|
622
|
+
"method": "post",
|
|
623
|
+
"summary": "Create chat agent draft version",
|
|
624
|
+
"parameters": [
|
|
625
|
+
{
|
|
626
|
+
"name": "agentId",
|
|
627
|
+
"in": "path",
|
|
628
|
+
"required": true,
|
|
629
|
+
"schema": {
|
|
630
|
+
"type": "string"
|
|
631
|
+
},
|
|
632
|
+
"description": "Agent identifier."
|
|
633
|
+
}
|
|
634
|
+
],
|
|
635
|
+
"bodyRequired": true,
|
|
636
|
+
"bodyType": "application/json",
|
|
637
|
+
"bodySchema": {
|
|
638
|
+
"$ref": "#/components/schemas/CreateAgentVersionRequest"
|
|
639
|
+
}
|
|
640
|
+
},
|
|
641
|
+
"publishChatAgentVersion": {
|
|
642
|
+
"path": "/api/v1/chat-agents/{agentId}/versions/{version}/publish",
|
|
643
|
+
"method": "post",
|
|
644
|
+
"summary": "Publish chat agent version",
|
|
645
|
+
"parameters": [
|
|
646
|
+
{
|
|
647
|
+
"name": "agentId",
|
|
648
|
+
"in": "path",
|
|
649
|
+
"required": true,
|
|
650
|
+
"schema": {
|
|
651
|
+
"type": "string"
|
|
652
|
+
},
|
|
653
|
+
"description": "Agent identifier."
|
|
654
|
+
},
|
|
655
|
+
{
|
|
656
|
+
"name": "version",
|
|
657
|
+
"in": "path",
|
|
658
|
+
"required": true,
|
|
659
|
+
"schema": {
|
|
660
|
+
"type": "integer",
|
|
661
|
+
"minimum": 0
|
|
662
|
+
},
|
|
663
|
+
"description": "Specific agent version."
|
|
664
|
+
}
|
|
665
|
+
],
|
|
666
|
+
"bodyRequired": true,
|
|
667
|
+
"bodyType": "application/json",
|
|
668
|
+
"bodySchema": {
|
|
669
|
+
"$ref": "#/components/schemas/PublishAgentVersionRequest"
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
"deleteChatAgentVersion": {
|
|
673
|
+
"path": "/api/v1/chat-agents/{agentId}/versions/{version}",
|
|
674
|
+
"method": "delete",
|
|
675
|
+
"summary": "Delete chat agent version",
|
|
676
|
+
"parameters": [
|
|
677
|
+
{
|
|
678
|
+
"name": "agentId",
|
|
679
|
+
"in": "path",
|
|
680
|
+
"required": true,
|
|
681
|
+
"schema": {
|
|
682
|
+
"type": "string"
|
|
683
|
+
},
|
|
684
|
+
"description": "Agent identifier."
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
"name": "version",
|
|
688
|
+
"in": "path",
|
|
689
|
+
"required": true,
|
|
690
|
+
"schema": {
|
|
691
|
+
"type": "integer",
|
|
692
|
+
"minimum": 0
|
|
693
|
+
},
|
|
694
|
+
"description": "Specific agent version."
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
"name": "workspaceId",
|
|
698
|
+
"in": "query",
|
|
699
|
+
"required": true,
|
|
700
|
+
"schema": {
|
|
701
|
+
"type": "integer"
|
|
702
|
+
},
|
|
703
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
704
|
+
}
|
|
705
|
+
],
|
|
706
|
+
"bodyRequired": false,
|
|
707
|
+
"bodyType": null,
|
|
708
|
+
"bodySchema": null
|
|
709
|
+
},
|
|
710
|
+
"publishChatAgentVersionFiltered": {
|
|
711
|
+
"path": "/api/v1/chat-agents/{agentId}/publish",
|
|
712
|
+
"method": "post",
|
|
713
|
+
"summary": "Publish chat agent version (legacy path)",
|
|
714
|
+
"parameters": [
|
|
715
|
+
{
|
|
716
|
+
"name": "agentId",
|
|
717
|
+
"in": "path",
|
|
718
|
+
"required": true,
|
|
719
|
+
"schema": {
|
|
720
|
+
"type": "string"
|
|
721
|
+
},
|
|
722
|
+
"description": "Agent identifier."
|
|
723
|
+
}
|
|
724
|
+
],
|
|
725
|
+
"bodyRequired": true,
|
|
726
|
+
"bodyType": "application/json",
|
|
727
|
+
"bodySchema": {
|
|
728
|
+
"type": "object",
|
|
729
|
+
"required": [
|
|
730
|
+
"workspaceId",
|
|
731
|
+
"version"
|
|
732
|
+
],
|
|
733
|
+
"properties": {
|
|
734
|
+
"workspaceId": {
|
|
735
|
+
"type": "integer"
|
|
736
|
+
},
|
|
737
|
+
"version": {
|
|
738
|
+
"type": "integer",
|
|
739
|
+
"minimum": 0
|
|
740
|
+
},
|
|
741
|
+
"versionTitle": {
|
|
742
|
+
"type": "string"
|
|
743
|
+
},
|
|
744
|
+
"versionDescription": {
|
|
745
|
+
"type": "string"
|
|
746
|
+
}
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
},
|
|
750
|
+
"listChats": {
|
|
751
|
+
"path": "/api/v1/chats",
|
|
752
|
+
"method": "get",
|
|
753
|
+
"summary": "List chats",
|
|
754
|
+
"parameters": [
|
|
755
|
+
{
|
|
756
|
+
"name": "workspaceId",
|
|
757
|
+
"in": "query",
|
|
758
|
+
"required": true,
|
|
759
|
+
"schema": {
|
|
760
|
+
"type": "integer"
|
|
761
|
+
},
|
|
762
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"name": "sortOrder",
|
|
766
|
+
"in": "query",
|
|
767
|
+
"required": false,
|
|
768
|
+
"schema": {
|
|
769
|
+
"type": "string",
|
|
770
|
+
"enum": [
|
|
771
|
+
"ascending",
|
|
772
|
+
"descending"
|
|
773
|
+
],
|
|
774
|
+
"default": "descending"
|
|
775
|
+
},
|
|
776
|
+
"description": "Sort direction for chat listings."
|
|
777
|
+
},
|
|
778
|
+
{
|
|
779
|
+
"name": "limit",
|
|
780
|
+
"in": "query",
|
|
781
|
+
"required": false,
|
|
782
|
+
"schema": {
|
|
783
|
+
"type": "integer",
|
|
784
|
+
"minimum": 1,
|
|
785
|
+
"maximum": 1000,
|
|
786
|
+
"default": 1000
|
|
787
|
+
},
|
|
788
|
+
"description": "Maximum number of records to return."
|
|
789
|
+
},
|
|
790
|
+
{
|
|
791
|
+
"name": "paginationKey",
|
|
792
|
+
"in": "query",
|
|
793
|
+
"required": false,
|
|
794
|
+
"schema": {
|
|
795
|
+
"type": "string"
|
|
796
|
+
},
|
|
797
|
+
"description": "Identifier to continue pagination."
|
|
798
|
+
}
|
|
799
|
+
],
|
|
800
|
+
"bodyRequired": false,
|
|
801
|
+
"bodyType": null,
|
|
802
|
+
"bodySchema": null
|
|
803
|
+
},
|
|
804
|
+
"createChat": {
|
|
805
|
+
"path": "/api/v1/chats",
|
|
806
|
+
"method": "post",
|
|
807
|
+
"summary": "Create chat",
|
|
808
|
+
"parameters": [],
|
|
809
|
+
"bodyRequired": true,
|
|
810
|
+
"bodyType": "application/json",
|
|
811
|
+
"bodySchema": {
|
|
812
|
+
"$ref": "#/components/schemas/CreateChatRequest"
|
|
813
|
+
}
|
|
814
|
+
},
|
|
815
|
+
"createOutboundSmsChat": {
|
|
816
|
+
"path": "/api/v1/chats/outbound-sms",
|
|
817
|
+
"method": "post",
|
|
818
|
+
"summary": "Create outbound SMS chat",
|
|
819
|
+
"parameters": [],
|
|
820
|
+
"bodyRequired": true,
|
|
821
|
+
"bodyType": "application/json",
|
|
822
|
+
"bodySchema": {
|
|
823
|
+
"$ref": "#/components/schemas/CreateOutboundSmsChatRequest"
|
|
824
|
+
}
|
|
825
|
+
},
|
|
826
|
+
"getChat": {
|
|
827
|
+
"path": "/api/v1/chats/{chatId}",
|
|
828
|
+
"method": "get",
|
|
829
|
+
"summary": "Get chat",
|
|
830
|
+
"parameters": [
|
|
831
|
+
{
|
|
832
|
+
"name": "chatId",
|
|
833
|
+
"in": "path",
|
|
834
|
+
"required": true,
|
|
835
|
+
"schema": {
|
|
836
|
+
"type": "string"
|
|
837
|
+
},
|
|
838
|
+
"description": "Chat identifier."
|
|
839
|
+
},
|
|
840
|
+
{
|
|
841
|
+
"name": "workspaceId",
|
|
842
|
+
"in": "query",
|
|
843
|
+
"required": true,
|
|
844
|
+
"schema": {
|
|
845
|
+
"type": "integer"
|
|
846
|
+
},
|
|
847
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
848
|
+
}
|
|
849
|
+
],
|
|
850
|
+
"bodyRequired": false,
|
|
851
|
+
"bodyType": null,
|
|
852
|
+
"bodySchema": null
|
|
853
|
+
},
|
|
854
|
+
"updateChat": {
|
|
855
|
+
"path": "/api/v1/chats/{chatId}",
|
|
856
|
+
"method": "patch",
|
|
857
|
+
"summary": "Update chat",
|
|
858
|
+
"parameters": [
|
|
859
|
+
{
|
|
860
|
+
"name": "chatId",
|
|
861
|
+
"in": "path",
|
|
862
|
+
"required": true,
|
|
863
|
+
"schema": {
|
|
864
|
+
"type": "string"
|
|
865
|
+
},
|
|
866
|
+
"description": "Chat identifier."
|
|
867
|
+
}
|
|
868
|
+
],
|
|
869
|
+
"bodyRequired": true,
|
|
870
|
+
"bodyType": "application/json",
|
|
871
|
+
"bodySchema": {
|
|
872
|
+
"$ref": "#/components/schemas/UpdateChatRequest"
|
|
873
|
+
}
|
|
874
|
+
},
|
|
875
|
+
"createChatCompletion": {
|
|
876
|
+
"path": "/api/v1/chats/{chatId}/completions",
|
|
877
|
+
"method": "post",
|
|
878
|
+
"summary": "Create chat completion",
|
|
879
|
+
"parameters": [
|
|
880
|
+
{
|
|
881
|
+
"name": "chatId",
|
|
882
|
+
"in": "path",
|
|
883
|
+
"required": true,
|
|
884
|
+
"schema": {
|
|
885
|
+
"type": "string"
|
|
886
|
+
},
|
|
887
|
+
"description": "Chat identifier."
|
|
888
|
+
}
|
|
889
|
+
],
|
|
890
|
+
"bodyRequired": true,
|
|
891
|
+
"bodyType": "application/json",
|
|
892
|
+
"bodySchema": {
|
|
893
|
+
"$ref": "#/components/schemas/CreateChatCompletionRequest"
|
|
894
|
+
}
|
|
895
|
+
},
|
|
896
|
+
"endChat": {
|
|
897
|
+
"path": "/api/v1/chats/{chatId}/end",
|
|
898
|
+
"method": "post",
|
|
899
|
+
"summary": "End chat",
|
|
900
|
+
"parameters": [
|
|
901
|
+
{
|
|
902
|
+
"name": "chatId",
|
|
903
|
+
"in": "path",
|
|
904
|
+
"required": true,
|
|
905
|
+
"schema": {
|
|
906
|
+
"type": "string"
|
|
907
|
+
},
|
|
908
|
+
"description": "Chat identifier."
|
|
909
|
+
}
|
|
910
|
+
],
|
|
911
|
+
"bodyRequired": true,
|
|
912
|
+
"bodyType": "application/json",
|
|
913
|
+
"bodySchema": {
|
|
914
|
+
"type": "object",
|
|
915
|
+
"required": [
|
|
916
|
+
"workspaceId"
|
|
917
|
+
],
|
|
918
|
+
"properties": {
|
|
919
|
+
"workspaceId": {
|
|
920
|
+
"type": "integer"
|
|
921
|
+
}
|
|
922
|
+
}
|
|
923
|
+
}
|
|
924
|
+
},
|
|
925
|
+
"listChatWidgets": {
|
|
926
|
+
"path": "/api/v1/chat-widgets",
|
|
927
|
+
"method": "get",
|
|
928
|
+
"summary": "List chat widgets",
|
|
929
|
+
"parameters": [
|
|
930
|
+
{
|
|
931
|
+
"name": "workspaceId",
|
|
932
|
+
"in": "query",
|
|
933
|
+
"required": true,
|
|
934
|
+
"schema": {
|
|
935
|
+
"type": "integer"
|
|
936
|
+
},
|
|
937
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
938
|
+
}
|
|
939
|
+
],
|
|
940
|
+
"bodyRequired": false,
|
|
941
|
+
"bodyType": null,
|
|
942
|
+
"bodySchema": null
|
|
943
|
+
},
|
|
944
|
+
"createChatWidget": {
|
|
945
|
+
"path": "/api/v1/chat-widgets",
|
|
946
|
+
"method": "post",
|
|
947
|
+
"summary": "Create chat widget",
|
|
948
|
+
"parameters": [],
|
|
949
|
+
"bodyRequired": true,
|
|
950
|
+
"bodyType": "application/json",
|
|
951
|
+
"bodySchema": {
|
|
952
|
+
"$ref": "#/components/schemas/CreateChatWidgetRequest"
|
|
953
|
+
}
|
|
954
|
+
},
|
|
955
|
+
"getChatWidget": {
|
|
956
|
+
"path": "/api/v1/chat-widgets/{widgetId}",
|
|
957
|
+
"method": "get",
|
|
958
|
+
"summary": "Get chat widget",
|
|
959
|
+
"parameters": [
|
|
960
|
+
{
|
|
961
|
+
"name": "widgetId",
|
|
962
|
+
"in": "path",
|
|
963
|
+
"required": true,
|
|
964
|
+
"schema": {
|
|
965
|
+
"type": "integer"
|
|
966
|
+
},
|
|
967
|
+
"description": "Chat widget configuration identifier."
|
|
968
|
+
}
|
|
969
|
+
],
|
|
970
|
+
"bodyRequired": false,
|
|
971
|
+
"bodyType": null,
|
|
972
|
+
"bodySchema": null
|
|
973
|
+
},
|
|
974
|
+
"updateChatWidget": {
|
|
975
|
+
"path": "/api/v1/chat-widgets/{widgetId}",
|
|
976
|
+
"method": "patch",
|
|
977
|
+
"summary": "Update chat widget",
|
|
978
|
+
"parameters": [
|
|
979
|
+
{
|
|
980
|
+
"name": "widgetId",
|
|
981
|
+
"in": "path",
|
|
982
|
+
"required": true,
|
|
983
|
+
"schema": {
|
|
984
|
+
"type": "integer"
|
|
985
|
+
},
|
|
986
|
+
"description": "Chat widget configuration identifier."
|
|
987
|
+
}
|
|
988
|
+
],
|
|
989
|
+
"bodyRequired": true,
|
|
990
|
+
"bodyType": "application/json",
|
|
991
|
+
"bodySchema": {
|
|
992
|
+
"$ref": "#/components/schemas/UpdateChatWidgetRequest"
|
|
993
|
+
}
|
|
994
|
+
},
|
|
995
|
+
"regenerateWidgetKey": {
|
|
996
|
+
"path": "/api/v1/chat-widgets/{widgetId}/regenerate-key",
|
|
997
|
+
"method": "post",
|
|
998
|
+
"summary": "Regenerate widget key",
|
|
999
|
+
"parameters": [
|
|
1000
|
+
{
|
|
1001
|
+
"name": "widgetId",
|
|
1002
|
+
"in": "path",
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"schema": {
|
|
1005
|
+
"type": "integer"
|
|
1006
|
+
},
|
|
1007
|
+
"description": "Chat widget configuration identifier."
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"bodyRequired": false,
|
|
1011
|
+
"bodyType": null,
|
|
1012
|
+
"bodySchema": null
|
|
1013
|
+
},
|
|
1014
|
+
"listConversationFlows": {
|
|
1015
|
+
"path": "/api/v1/conversation-flows",
|
|
1016
|
+
"method": "get",
|
|
1017
|
+
"summary": "List conversation flows",
|
|
1018
|
+
"parameters": [
|
|
1019
|
+
{
|
|
1020
|
+
"name": "workspaceId",
|
|
1021
|
+
"in": "query",
|
|
1022
|
+
"required": true,
|
|
1023
|
+
"schema": {
|
|
1024
|
+
"type": "integer"
|
|
1025
|
+
},
|
|
1026
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"name": "limit",
|
|
1030
|
+
"in": "query",
|
|
1031
|
+
"required": false,
|
|
1032
|
+
"schema": {
|
|
1033
|
+
"type": "integer",
|
|
1034
|
+
"minimum": 1,
|
|
1035
|
+
"maximum": 1000,
|
|
1036
|
+
"default": 1000
|
|
1037
|
+
},
|
|
1038
|
+
"description": "Maximum number of records to return."
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"name": "paginationKey",
|
|
1042
|
+
"in": "query",
|
|
1043
|
+
"required": false,
|
|
1044
|
+
"schema": {
|
|
1045
|
+
"type": "string"
|
|
1046
|
+
},
|
|
1047
|
+
"description": "Identifier to continue pagination."
|
|
1048
|
+
},
|
|
1049
|
+
{
|
|
1050
|
+
"name": "paginationKeyVersion",
|
|
1051
|
+
"in": "query",
|
|
1052
|
+
"required": false,
|
|
1053
|
+
"schema": {
|
|
1054
|
+
"type": "integer"
|
|
1055
|
+
},
|
|
1056
|
+
"description": "Version paired with the pagination key."
|
|
1057
|
+
}
|
|
1058
|
+
],
|
|
1059
|
+
"bodyRequired": false,
|
|
1060
|
+
"bodyType": null,
|
|
1061
|
+
"bodySchema": null
|
|
1062
|
+
},
|
|
1063
|
+
"createConversationFlow": {
|
|
1064
|
+
"path": "/api/v1/conversation-flows",
|
|
1065
|
+
"method": "post",
|
|
1066
|
+
"summary": "Create conversation flow",
|
|
1067
|
+
"parameters": [],
|
|
1068
|
+
"bodyRequired": true,
|
|
1069
|
+
"bodyType": "application/json",
|
|
1070
|
+
"bodySchema": {
|
|
1071
|
+
"$ref": "#/components/schemas/CreateConversationFlowRequest"
|
|
1072
|
+
}
|
|
1073
|
+
},
|
|
1074
|
+
"getConversationFlow": {
|
|
1075
|
+
"path": "/api/v1/conversation-flows/{conversationFlowId}",
|
|
1076
|
+
"method": "get",
|
|
1077
|
+
"summary": "Get conversation flow",
|
|
1078
|
+
"parameters": [
|
|
1079
|
+
{
|
|
1080
|
+
"name": "conversationFlowId",
|
|
1081
|
+
"in": "path",
|
|
1082
|
+
"required": true,
|
|
1083
|
+
"schema": {
|
|
1084
|
+
"type": "string"
|
|
1085
|
+
},
|
|
1086
|
+
"description": "Conversation flow identifier."
|
|
1087
|
+
},
|
|
1088
|
+
{
|
|
1089
|
+
"name": "workspaceId",
|
|
1090
|
+
"in": "query",
|
|
1091
|
+
"required": true,
|
|
1092
|
+
"schema": {
|
|
1093
|
+
"type": "integer"
|
|
1094
|
+
},
|
|
1095
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"name": "version",
|
|
1099
|
+
"in": "query",
|
|
1100
|
+
"required": false,
|
|
1101
|
+
"schema": {
|
|
1102
|
+
"type": "integer",
|
|
1103
|
+
"minimum": 0
|
|
1104
|
+
},
|
|
1105
|
+
"description": "Specific version to retrieve or update."
|
|
1106
|
+
}
|
|
1107
|
+
],
|
|
1108
|
+
"bodyRequired": false,
|
|
1109
|
+
"bodyType": null,
|
|
1110
|
+
"bodySchema": null
|
|
1111
|
+
},
|
|
1112
|
+
"updateConversationFlow": {
|
|
1113
|
+
"path": "/api/v1/conversation-flows/{conversationFlowId}",
|
|
1114
|
+
"method": "patch",
|
|
1115
|
+
"summary": "Update conversation flow",
|
|
1116
|
+
"parameters": [
|
|
1117
|
+
{
|
|
1118
|
+
"name": "conversationFlowId",
|
|
1119
|
+
"in": "path",
|
|
1120
|
+
"required": true,
|
|
1121
|
+
"schema": {
|
|
1122
|
+
"type": "string"
|
|
1123
|
+
},
|
|
1124
|
+
"description": "Conversation flow identifier."
|
|
1125
|
+
},
|
|
1126
|
+
{
|
|
1127
|
+
"name": "version",
|
|
1128
|
+
"in": "query",
|
|
1129
|
+
"required": false,
|
|
1130
|
+
"schema": {
|
|
1131
|
+
"type": "integer",
|
|
1132
|
+
"minimum": 0
|
|
1133
|
+
},
|
|
1134
|
+
"description": "Specific version to retrieve or update."
|
|
1135
|
+
}
|
|
1136
|
+
],
|
|
1137
|
+
"bodyRequired": true,
|
|
1138
|
+
"bodyType": "application/json",
|
|
1139
|
+
"bodySchema": {
|
|
1140
|
+
"$ref": "#/components/schemas/UpdateConversationFlowRequest"
|
|
1141
|
+
}
|
|
1142
|
+
},
|
|
1143
|
+
"deleteConversationFlow": {
|
|
1144
|
+
"path": "/api/v1/conversation-flows/{conversationFlowId}",
|
|
1145
|
+
"method": "delete",
|
|
1146
|
+
"summary": "Delete conversation flow",
|
|
1147
|
+
"parameters": [
|
|
1148
|
+
{
|
|
1149
|
+
"name": "conversationFlowId",
|
|
1150
|
+
"in": "path",
|
|
1151
|
+
"required": true,
|
|
1152
|
+
"schema": {
|
|
1153
|
+
"type": "string"
|
|
1154
|
+
},
|
|
1155
|
+
"description": "Conversation flow identifier."
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"name": "workspaceId",
|
|
1159
|
+
"in": "query",
|
|
1160
|
+
"required": true,
|
|
1161
|
+
"schema": {
|
|
1162
|
+
"type": "integer"
|
|
1163
|
+
},
|
|
1164
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1165
|
+
}
|
|
1166
|
+
],
|
|
1167
|
+
"bodyRequired": false,
|
|
1168
|
+
"bodyType": null,
|
|
1169
|
+
"bodySchema": null
|
|
1170
|
+
},
|
|
1171
|
+
"listKnowledgeBases": {
|
|
1172
|
+
"path": "/api/v1/knowledge-bases",
|
|
1173
|
+
"method": "get",
|
|
1174
|
+
"summary": "List knowledge bases",
|
|
1175
|
+
"parameters": [
|
|
1176
|
+
{
|
|
1177
|
+
"name": "workspaceId",
|
|
1178
|
+
"in": "query",
|
|
1179
|
+
"required": true,
|
|
1180
|
+
"schema": {
|
|
1181
|
+
"type": "integer"
|
|
1182
|
+
},
|
|
1183
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1184
|
+
}
|
|
1185
|
+
],
|
|
1186
|
+
"bodyRequired": false,
|
|
1187
|
+
"bodyType": null,
|
|
1188
|
+
"bodySchema": null
|
|
1189
|
+
},
|
|
1190
|
+
"createKnowledgeBase": {
|
|
1191
|
+
"path": "/api/v1/knowledge-bases",
|
|
1192
|
+
"method": "post",
|
|
1193
|
+
"summary": "Create knowledge base",
|
|
1194
|
+
"parameters": [],
|
|
1195
|
+
"bodyRequired": true,
|
|
1196
|
+
"bodyType": "application/json",
|
|
1197
|
+
"bodySchema": {
|
|
1198
|
+
"$ref": "#/components/schemas/CreateKnowledgeBaseRequest"
|
|
1199
|
+
}
|
|
1200
|
+
},
|
|
1201
|
+
"getKnowledgeBase": {
|
|
1202
|
+
"path": "/api/v1/knowledge-bases/{knowledgeBaseId}",
|
|
1203
|
+
"method": "get",
|
|
1204
|
+
"summary": "Get knowledge base",
|
|
1205
|
+
"parameters": [
|
|
1206
|
+
{
|
|
1207
|
+
"name": "knowledgeBaseId",
|
|
1208
|
+
"in": "path",
|
|
1209
|
+
"required": true,
|
|
1210
|
+
"schema": {
|
|
1211
|
+
"type": "string"
|
|
1212
|
+
},
|
|
1213
|
+
"description": "Knowledge base identifier."
|
|
1214
|
+
},
|
|
1215
|
+
{
|
|
1216
|
+
"name": "workspaceId",
|
|
1217
|
+
"in": "query",
|
|
1218
|
+
"required": true,
|
|
1219
|
+
"schema": {
|
|
1220
|
+
"type": "integer"
|
|
1221
|
+
},
|
|
1222
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1223
|
+
}
|
|
1224
|
+
],
|
|
1225
|
+
"bodyRequired": false,
|
|
1226
|
+
"bodyType": null,
|
|
1227
|
+
"bodySchema": null
|
|
1228
|
+
},
|
|
1229
|
+
"deleteKnowledgeBase": {
|
|
1230
|
+
"path": "/api/v1/knowledge-bases/{knowledgeBaseId}",
|
|
1231
|
+
"method": "delete",
|
|
1232
|
+
"summary": "Delete knowledge base",
|
|
1233
|
+
"parameters": [
|
|
1234
|
+
{
|
|
1235
|
+
"name": "knowledgeBaseId",
|
|
1236
|
+
"in": "path",
|
|
1237
|
+
"required": true,
|
|
1238
|
+
"schema": {
|
|
1239
|
+
"type": "string"
|
|
1240
|
+
},
|
|
1241
|
+
"description": "Knowledge base identifier."
|
|
1242
|
+
},
|
|
1243
|
+
{
|
|
1244
|
+
"name": "workspaceId",
|
|
1245
|
+
"in": "query",
|
|
1246
|
+
"required": true,
|
|
1247
|
+
"schema": {
|
|
1248
|
+
"type": "integer"
|
|
1249
|
+
},
|
|
1250
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1251
|
+
}
|
|
1252
|
+
],
|
|
1253
|
+
"bodyRequired": false,
|
|
1254
|
+
"bodyType": null,
|
|
1255
|
+
"bodySchema": null
|
|
1256
|
+
},
|
|
1257
|
+
"addKnowledgeBaseSources": {
|
|
1258
|
+
"path": "/api/v1/knowledge-bases/{knowledgeBaseId}/sources",
|
|
1259
|
+
"method": "post",
|
|
1260
|
+
"summary": "Add knowledge base sources",
|
|
1261
|
+
"parameters": [
|
|
1262
|
+
{
|
|
1263
|
+
"name": "knowledgeBaseId",
|
|
1264
|
+
"in": "path",
|
|
1265
|
+
"required": true,
|
|
1266
|
+
"schema": {
|
|
1267
|
+
"type": "string"
|
|
1268
|
+
},
|
|
1269
|
+
"description": "Knowledge base identifier."
|
|
1270
|
+
}
|
|
1271
|
+
],
|
|
1272
|
+
"bodyRequired": true,
|
|
1273
|
+
"bodyType": "application/json",
|
|
1274
|
+
"bodySchema": {
|
|
1275
|
+
"$ref": "#/components/schemas/AddKnowledgeBaseSourcesRequest"
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1278
|
+
"deleteKnowledgeBaseSource": {
|
|
1279
|
+
"path": "/api/v1/knowledge-bases/{knowledgeBaseId}/sources/{sourceId}",
|
|
1280
|
+
"method": "delete",
|
|
1281
|
+
"summary": "Delete knowledge base source",
|
|
1282
|
+
"parameters": [
|
|
1283
|
+
{
|
|
1284
|
+
"name": "knowledgeBaseId",
|
|
1285
|
+
"in": "path",
|
|
1286
|
+
"required": true,
|
|
1287
|
+
"schema": {
|
|
1288
|
+
"type": "string"
|
|
1289
|
+
},
|
|
1290
|
+
"description": "Knowledge base identifier."
|
|
1291
|
+
},
|
|
1292
|
+
{
|
|
1293
|
+
"name": "sourceId",
|
|
1294
|
+
"in": "path",
|
|
1295
|
+
"required": true,
|
|
1296
|
+
"schema": {
|
|
1297
|
+
"type": "string"
|
|
1298
|
+
},
|
|
1299
|
+
"description": "Knowledge base source identifier."
|
|
1300
|
+
},
|
|
1301
|
+
{
|
|
1302
|
+
"name": "workspaceId",
|
|
1303
|
+
"in": "query",
|
|
1304
|
+
"required": true,
|
|
1305
|
+
"schema": {
|
|
1306
|
+
"type": "integer"
|
|
1307
|
+
},
|
|
1308
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1309
|
+
}
|
|
1310
|
+
],
|
|
1311
|
+
"bodyRequired": false,
|
|
1312
|
+
"bodyType": null,
|
|
1313
|
+
"bodySchema": null
|
|
1314
|
+
},
|
|
1315
|
+
"listVoices": {
|
|
1316
|
+
"path": "/api/v1/voices",
|
|
1317
|
+
"method": "get",
|
|
1318
|
+
"summary": "List voices",
|
|
1319
|
+
"parameters": [
|
|
1320
|
+
{
|
|
1321
|
+
"name": "workspaceId",
|
|
1322
|
+
"in": "query",
|
|
1323
|
+
"required": true,
|
|
1324
|
+
"schema": {
|
|
1325
|
+
"type": "integer"
|
|
1326
|
+
},
|
|
1327
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1328
|
+
}
|
|
1329
|
+
],
|
|
1330
|
+
"bodyRequired": false,
|
|
1331
|
+
"bodyType": null,
|
|
1332
|
+
"bodySchema": null
|
|
1333
|
+
},
|
|
1334
|
+
"searchCommunityVoices": {
|
|
1335
|
+
"path": "/api/v1/voices/search",
|
|
1336
|
+
"method": "post",
|
|
1337
|
+
"summary": "Search community voices",
|
|
1338
|
+
"parameters": [],
|
|
1339
|
+
"bodyRequired": true,
|
|
1340
|
+
"bodyType": "application/json",
|
|
1341
|
+
"bodySchema": {
|
|
1342
|
+
"$ref": "#/components/schemas/SearchCommunityVoiceRequest"
|
|
1343
|
+
}
|
|
1344
|
+
},
|
|
1345
|
+
"addCommunityVoice": {
|
|
1346
|
+
"path": "/api/v1/voices/community",
|
|
1347
|
+
"method": "post",
|
|
1348
|
+
"summary": "Add community voice",
|
|
1349
|
+
"parameters": [],
|
|
1350
|
+
"bodyRequired": true,
|
|
1351
|
+
"bodyType": "application/json",
|
|
1352
|
+
"bodySchema": {
|
|
1353
|
+
"$ref": "#/components/schemas/AddCommunityVoiceRequest"
|
|
1354
|
+
}
|
|
1355
|
+
},
|
|
1356
|
+
"cloneVoice": {
|
|
1357
|
+
"path": "/api/v1/voices/clone",
|
|
1358
|
+
"method": "post",
|
|
1359
|
+
"summary": "Clone voice",
|
|
1360
|
+
"parameters": [],
|
|
1361
|
+
"bodyRequired": true,
|
|
1362
|
+
"bodyType": "multipart/form-data",
|
|
1363
|
+
"bodySchema": {
|
|
1364
|
+
"$ref": "#/components/schemas/CloneVoiceRequest"
|
|
1365
|
+
}
|
|
1366
|
+
},
|
|
1367
|
+
"getVoice": {
|
|
1368
|
+
"path": "/api/v1/voices/{voiceId}",
|
|
1369
|
+
"method": "get",
|
|
1370
|
+
"summary": "Get voice",
|
|
1371
|
+
"parameters": [
|
|
1372
|
+
{
|
|
1373
|
+
"name": "voiceId",
|
|
1374
|
+
"in": "path",
|
|
1375
|
+
"required": true,
|
|
1376
|
+
"schema": {
|
|
1377
|
+
"type": "string"
|
|
1378
|
+
},
|
|
1379
|
+
"description": "Voice identifier."
|
|
1380
|
+
},
|
|
1381
|
+
{
|
|
1382
|
+
"name": "workspaceId",
|
|
1383
|
+
"in": "query",
|
|
1384
|
+
"required": true,
|
|
1385
|
+
"schema": {
|
|
1386
|
+
"type": "integer"
|
|
1387
|
+
},
|
|
1388
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1389
|
+
}
|
|
1390
|
+
],
|
|
1391
|
+
"bodyRequired": false,
|
|
1392
|
+
"bodyType": null,
|
|
1393
|
+
"bodySchema": null
|
|
1394
|
+
},
|
|
1395
|
+
"streamVoiceSample": {
|
|
1396
|
+
"path": "/api/v1/voices/{voiceId}/sample",
|
|
1397
|
+
"method": "get",
|
|
1398
|
+
"summary": "Stream voice sample",
|
|
1399
|
+
"parameters": [
|
|
1400
|
+
{
|
|
1401
|
+
"name": "voiceId",
|
|
1402
|
+
"in": "path",
|
|
1403
|
+
"required": true,
|
|
1404
|
+
"schema": {
|
|
1405
|
+
"type": "string"
|
|
1406
|
+
},
|
|
1407
|
+
"description": "Voice identifier."
|
|
1408
|
+
},
|
|
1409
|
+
{
|
|
1410
|
+
"name": "workspaceId",
|
|
1411
|
+
"in": "query",
|
|
1412
|
+
"required": true,
|
|
1413
|
+
"schema": {
|
|
1414
|
+
"type": "integer"
|
|
1415
|
+
},
|
|
1416
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1417
|
+
}
|
|
1418
|
+
],
|
|
1419
|
+
"bodyRequired": false,
|
|
1420
|
+
"bodyType": null,
|
|
1421
|
+
"bodySchema": null
|
|
1422
|
+
},
|
|
1423
|
+
"listTestCaseDefinitions": {
|
|
1424
|
+
"path": "/api/v1/test-case-definitions",
|
|
1425
|
+
"method": "get",
|
|
1426
|
+
"summary": "List test case definitions",
|
|
1427
|
+
"parameters": [
|
|
1428
|
+
{
|
|
1429
|
+
"name": "workspaceId",
|
|
1430
|
+
"in": "query",
|
|
1431
|
+
"required": true,
|
|
1432
|
+
"schema": {
|
|
1433
|
+
"type": "integer"
|
|
1434
|
+
},
|
|
1435
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
"name": "type",
|
|
1439
|
+
"in": "query",
|
|
1440
|
+
"required": true,
|
|
1441
|
+
"schema": {
|
|
1442
|
+
"type": "string"
|
|
1443
|
+
},
|
|
1444
|
+
"description": "Response engine type used by an existing test case definition."
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"name": "llmId",
|
|
1448
|
+
"in": "query",
|
|
1449
|
+
"required": false,
|
|
1450
|
+
"schema": {
|
|
1451
|
+
"type": "string"
|
|
1452
|
+
},
|
|
1453
|
+
"description": "LLM identifier filter."
|
|
1454
|
+
},
|
|
1455
|
+
{
|
|
1456
|
+
"name": "conversationFlowId",
|
|
1457
|
+
"in": "query",
|
|
1458
|
+
"required": false,
|
|
1459
|
+
"schema": {
|
|
1460
|
+
"type": "string"
|
|
1461
|
+
},
|
|
1462
|
+
"description": "Conversation flow identifier filter."
|
|
1463
|
+
},
|
|
1464
|
+
{
|
|
1465
|
+
"name": "version",
|
|
1466
|
+
"in": "query",
|
|
1467
|
+
"required": false,
|
|
1468
|
+
"schema": {
|
|
1469
|
+
"type": "integer",
|
|
1470
|
+
"minimum": 0
|
|
1471
|
+
},
|
|
1472
|
+
"description": "Specific version to retrieve or update."
|
|
1473
|
+
},
|
|
1474
|
+
{
|
|
1475
|
+
"name": "limit",
|
|
1476
|
+
"in": "query",
|
|
1477
|
+
"required": false,
|
|
1478
|
+
"schema": {
|
|
1479
|
+
"type": "integer",
|
|
1480
|
+
"minimum": 1,
|
|
1481
|
+
"maximum": 1000,
|
|
1482
|
+
"default": 1000
|
|
1483
|
+
},
|
|
1484
|
+
"description": "Maximum number of records to return."
|
|
1485
|
+
},
|
|
1486
|
+
{
|
|
1487
|
+
"name": "paginationKey",
|
|
1488
|
+
"in": "query",
|
|
1489
|
+
"required": false,
|
|
1490
|
+
"schema": {
|
|
1491
|
+
"type": "string"
|
|
1492
|
+
},
|
|
1493
|
+
"description": "Identifier to continue pagination."
|
|
1494
|
+
}
|
|
1495
|
+
],
|
|
1496
|
+
"bodyRequired": false,
|
|
1497
|
+
"bodyType": null,
|
|
1498
|
+
"bodySchema": null
|
|
1499
|
+
},
|
|
1500
|
+
"createTestCaseDefinition": {
|
|
1501
|
+
"path": "/api/v1/test-case-definitions",
|
|
1502
|
+
"method": "post",
|
|
1503
|
+
"summary": "Create test case definition",
|
|
1504
|
+
"parameters": [],
|
|
1505
|
+
"bodyRequired": true,
|
|
1506
|
+
"bodyType": "application/json",
|
|
1507
|
+
"bodySchema": {
|
|
1508
|
+
"$ref": "#/components/schemas/CreateTestCaseDefinitionRequest"
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
"listBatchTests": {
|
|
1512
|
+
"path": "/api/v1/batch-tests",
|
|
1513
|
+
"method": "get",
|
|
1514
|
+
"summary": "List batch tests",
|
|
1515
|
+
"parameters": [
|
|
1516
|
+
{
|
|
1517
|
+
"name": "workspaceId",
|
|
1518
|
+
"in": "query",
|
|
1519
|
+
"required": true,
|
|
1520
|
+
"schema": {
|
|
1521
|
+
"type": "integer"
|
|
1522
|
+
},
|
|
1523
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"name": "type",
|
|
1527
|
+
"in": "query",
|
|
1528
|
+
"required": true,
|
|
1529
|
+
"schema": {
|
|
1530
|
+
"type": "string"
|
|
1531
|
+
},
|
|
1532
|
+
"description": "Response engine type used by an existing test case definition."
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"name": "llmId",
|
|
1536
|
+
"in": "query",
|
|
1537
|
+
"required": false,
|
|
1538
|
+
"schema": {
|
|
1539
|
+
"type": "string"
|
|
1540
|
+
},
|
|
1541
|
+
"description": "LLM identifier filter."
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"name": "conversationFlowId",
|
|
1545
|
+
"in": "query",
|
|
1546
|
+
"required": false,
|
|
1547
|
+
"schema": {
|
|
1548
|
+
"type": "string"
|
|
1549
|
+
},
|
|
1550
|
+
"description": "Conversation flow identifier filter."
|
|
1551
|
+
},
|
|
1552
|
+
{
|
|
1553
|
+
"name": "version",
|
|
1554
|
+
"in": "query",
|
|
1555
|
+
"required": false,
|
|
1556
|
+
"schema": {
|
|
1557
|
+
"type": "integer",
|
|
1558
|
+
"minimum": 0
|
|
1559
|
+
},
|
|
1560
|
+
"description": "Specific version to retrieve or update."
|
|
1561
|
+
},
|
|
1562
|
+
{
|
|
1563
|
+
"name": "limit",
|
|
1564
|
+
"in": "query",
|
|
1565
|
+
"required": false,
|
|
1566
|
+
"schema": {
|
|
1567
|
+
"type": "integer",
|
|
1568
|
+
"minimum": 1,
|
|
1569
|
+
"maximum": 1000,
|
|
1570
|
+
"default": 1000
|
|
1571
|
+
},
|
|
1572
|
+
"description": "Maximum number of records to return."
|
|
1573
|
+
},
|
|
1574
|
+
{
|
|
1575
|
+
"name": "paginationKey",
|
|
1576
|
+
"in": "query",
|
|
1577
|
+
"required": false,
|
|
1578
|
+
"schema": {
|
|
1579
|
+
"type": "string"
|
|
1580
|
+
},
|
|
1581
|
+
"description": "Identifier to continue pagination."
|
|
1582
|
+
}
|
|
1583
|
+
],
|
|
1584
|
+
"bodyRequired": false,
|
|
1585
|
+
"bodyType": null,
|
|
1586
|
+
"bodySchema": null
|
|
1587
|
+
},
|
|
1588
|
+
"createBatchTest": {
|
|
1589
|
+
"path": "/api/v1/batch-tests",
|
|
1590
|
+
"method": "post",
|
|
1591
|
+
"summary": "Create batch test",
|
|
1592
|
+
"parameters": [],
|
|
1593
|
+
"bodyRequired": true,
|
|
1594
|
+
"bodyType": "application/json",
|
|
1595
|
+
"bodySchema": {
|
|
1596
|
+
"$ref": "#/components/schemas/CreateBatchTestRequest"
|
|
1597
|
+
}
|
|
1598
|
+
},
|
|
1599
|
+
"getBatchTest": {
|
|
1600
|
+
"path": "/api/v1/batch-tests/{testCaseBatchJobId}",
|
|
1601
|
+
"method": "get",
|
|
1602
|
+
"summary": "Get batch test",
|
|
1603
|
+
"parameters": [
|
|
1604
|
+
{
|
|
1605
|
+
"name": "testCaseBatchJobId",
|
|
1606
|
+
"in": "path",
|
|
1607
|
+
"required": true,
|
|
1608
|
+
"schema": {
|
|
1609
|
+
"type": "string"
|
|
1610
|
+
},
|
|
1611
|
+
"description": "Test run batch identifier."
|
|
1612
|
+
},
|
|
1613
|
+
{
|
|
1614
|
+
"name": "workspaceId",
|
|
1615
|
+
"in": "query",
|
|
1616
|
+
"required": true,
|
|
1617
|
+
"schema": {
|
|
1618
|
+
"type": "integer"
|
|
1619
|
+
},
|
|
1620
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1621
|
+
}
|
|
1622
|
+
],
|
|
1623
|
+
"bodyRequired": false,
|
|
1624
|
+
"bodyType": null,
|
|
1625
|
+
"bodySchema": null
|
|
1626
|
+
},
|
|
1627
|
+
"getTestCaseDefinition": {
|
|
1628
|
+
"path": "/api/v1/test-case-definitions/{testCaseDefinitionId}",
|
|
1629
|
+
"method": "get",
|
|
1630
|
+
"summary": "Get test case definition",
|
|
1631
|
+
"parameters": [
|
|
1632
|
+
{
|
|
1633
|
+
"name": "testCaseDefinitionId",
|
|
1634
|
+
"in": "path",
|
|
1635
|
+
"required": true,
|
|
1636
|
+
"schema": {
|
|
1637
|
+
"type": "string"
|
|
1638
|
+
},
|
|
1639
|
+
"description": "Test case definition identifier."
|
|
1640
|
+
},
|
|
1641
|
+
{
|
|
1642
|
+
"name": "workspaceId",
|
|
1643
|
+
"in": "query",
|
|
1644
|
+
"required": true,
|
|
1645
|
+
"schema": {
|
|
1646
|
+
"type": "integer"
|
|
1647
|
+
},
|
|
1648
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1649
|
+
}
|
|
1650
|
+
],
|
|
1651
|
+
"bodyRequired": false,
|
|
1652
|
+
"bodyType": null,
|
|
1653
|
+
"bodySchema": null
|
|
1654
|
+
},
|
|
1655
|
+
"updateTestCaseDefinition": {
|
|
1656
|
+
"path": "/api/v1/test-case-definitions/{testCaseDefinitionId}",
|
|
1657
|
+
"method": "put",
|
|
1658
|
+
"summary": "Update test case definition",
|
|
1659
|
+
"parameters": [
|
|
1660
|
+
{
|
|
1661
|
+
"name": "testCaseDefinitionId",
|
|
1662
|
+
"in": "path",
|
|
1663
|
+
"required": true,
|
|
1664
|
+
"schema": {
|
|
1665
|
+
"type": "string"
|
|
1666
|
+
},
|
|
1667
|
+
"description": "Test case definition identifier."
|
|
1668
|
+
}
|
|
1669
|
+
],
|
|
1670
|
+
"bodyRequired": true,
|
|
1671
|
+
"bodyType": "application/json",
|
|
1672
|
+
"bodySchema": {
|
|
1673
|
+
"$ref": "#/components/schemas/UpdateTestCaseDefinitionRequest"
|
|
1674
|
+
}
|
|
1675
|
+
},
|
|
1676
|
+
"deleteTestCaseDefinition": {
|
|
1677
|
+
"path": "/api/v1/test-case-definitions/{testCaseDefinitionId}",
|
|
1678
|
+
"method": "delete",
|
|
1679
|
+
"summary": "Delete test case definition",
|
|
1680
|
+
"parameters": [
|
|
1681
|
+
{
|
|
1682
|
+
"name": "testCaseDefinitionId",
|
|
1683
|
+
"in": "path",
|
|
1684
|
+
"required": true,
|
|
1685
|
+
"schema": {
|
|
1686
|
+
"type": "string"
|
|
1687
|
+
},
|
|
1688
|
+
"description": "Test case definition identifier."
|
|
1689
|
+
},
|
|
1690
|
+
{
|
|
1691
|
+
"name": "workspaceId",
|
|
1692
|
+
"in": "query",
|
|
1693
|
+
"required": true,
|
|
1694
|
+
"schema": {
|
|
1695
|
+
"type": "integer"
|
|
1696
|
+
},
|
|
1697
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1698
|
+
}
|
|
1699
|
+
],
|
|
1700
|
+
"bodyRequired": false,
|
|
1701
|
+
"bodyType": null,
|
|
1702
|
+
"bodySchema": null
|
|
1703
|
+
},
|
|
1704
|
+
"getTestRun": {
|
|
1705
|
+
"path": "/api/v1/test-runs/{testCaseJobId}",
|
|
1706
|
+
"method": "get",
|
|
1707
|
+
"summary": "Get test run",
|
|
1708
|
+
"parameters": [
|
|
1709
|
+
{
|
|
1710
|
+
"name": "testCaseJobId",
|
|
1711
|
+
"in": "path",
|
|
1712
|
+
"required": true,
|
|
1713
|
+
"schema": {
|
|
1714
|
+
"type": "string"
|
|
1715
|
+
},
|
|
1716
|
+
"description": "Test run job identifier."
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
"name": "workspaceId",
|
|
1720
|
+
"in": "query",
|
|
1721
|
+
"required": true,
|
|
1722
|
+
"schema": {
|
|
1723
|
+
"type": "integer"
|
|
1724
|
+
},
|
|
1725
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1726
|
+
}
|
|
1727
|
+
],
|
|
1728
|
+
"bodyRequired": false,
|
|
1729
|
+
"bodyType": null,
|
|
1730
|
+
"bodySchema": null
|
|
1731
|
+
},
|
|
1732
|
+
"listTestRunsByBatch": {
|
|
1733
|
+
"path": "/api/v1/test-runs/batches/{testCaseBatchJobId}",
|
|
1734
|
+
"method": "get",
|
|
1735
|
+
"summary": "List test runs by batch",
|
|
1736
|
+
"parameters": [
|
|
1737
|
+
{
|
|
1738
|
+
"name": "testCaseBatchJobId",
|
|
1739
|
+
"in": "path",
|
|
1740
|
+
"required": true,
|
|
1741
|
+
"schema": {
|
|
1742
|
+
"type": "string"
|
|
1743
|
+
},
|
|
1744
|
+
"description": "Test run batch identifier."
|
|
1745
|
+
},
|
|
1746
|
+
{
|
|
1747
|
+
"name": "workspaceId",
|
|
1748
|
+
"in": "query",
|
|
1749
|
+
"required": true,
|
|
1750
|
+
"schema": {
|
|
1751
|
+
"type": "integer"
|
|
1752
|
+
},
|
|
1753
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1754
|
+
},
|
|
1755
|
+
{
|
|
1756
|
+
"name": "limit",
|
|
1757
|
+
"in": "query",
|
|
1758
|
+
"required": false,
|
|
1759
|
+
"schema": {
|
|
1760
|
+
"type": "integer",
|
|
1761
|
+
"minimum": 1,
|
|
1762
|
+
"maximum": 1000,
|
|
1763
|
+
"default": 1000
|
|
1764
|
+
},
|
|
1765
|
+
"description": "Maximum number of records to return."
|
|
1766
|
+
},
|
|
1767
|
+
{
|
|
1768
|
+
"name": "paginationKey",
|
|
1769
|
+
"in": "query",
|
|
1770
|
+
"required": false,
|
|
1771
|
+
"schema": {
|
|
1772
|
+
"type": "string"
|
|
1773
|
+
},
|
|
1774
|
+
"description": "Identifier to continue pagination."
|
|
1775
|
+
}
|
|
1776
|
+
],
|
|
1777
|
+
"bodyRequired": false,
|
|
1778
|
+
"bodyType": null,
|
|
1779
|
+
"bodySchema": null
|
|
1780
|
+
},
|
|
1781
|
+
"getConcurrency": {
|
|
1782
|
+
"path": "/api/v1/concurrency",
|
|
1783
|
+
"method": "get",
|
|
1784
|
+
"summary": "Get concurrency",
|
|
1785
|
+
"parameters": [
|
|
1786
|
+
{
|
|
1787
|
+
"name": "workspaceId",
|
|
1788
|
+
"in": "query",
|
|
1789
|
+
"required": true,
|
|
1790
|
+
"schema": {
|
|
1791
|
+
"type": "integer"
|
|
1792
|
+
},
|
|
1793
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1794
|
+
}
|
|
1795
|
+
],
|
|
1796
|
+
"bodyRequired": false,
|
|
1797
|
+
"bodyType": null,
|
|
1798
|
+
"bodySchema": null
|
|
1799
|
+
},
|
|
1800
|
+
"listWorkspaces": {
|
|
1801
|
+
"path": "/api/v1/workspaces",
|
|
1802
|
+
"method": "get",
|
|
1803
|
+
"summary": "List workspaces",
|
|
1804
|
+
"parameters": [],
|
|
1805
|
+
"bodyRequired": false,
|
|
1806
|
+
"bodyType": null,
|
|
1807
|
+
"bodySchema": null
|
|
1808
|
+
},
|
|
1809
|
+
"createPhoneCall": {
|
|
1810
|
+
"path": "/api/v1/calls/initiate",
|
|
1811
|
+
"method": "post",
|
|
1812
|
+
"summary": "Create phone call",
|
|
1813
|
+
"parameters": [],
|
|
1814
|
+
"bodyRequired": true,
|
|
1815
|
+
"bodyType": "application/json",
|
|
1816
|
+
"bodySchema": {
|
|
1817
|
+
"$ref": "#/components/schemas/CreatePhoneCallRequest"
|
|
1818
|
+
}
|
|
1819
|
+
},
|
|
1820
|
+
"createWebCall": {
|
|
1821
|
+
"path": "/api/v1/calls/web",
|
|
1822
|
+
"method": "post",
|
|
1823
|
+
"summary": "Create web call",
|
|
1824
|
+
"parameters": [],
|
|
1825
|
+
"bodyRequired": true,
|
|
1826
|
+
"bodyType": "application/json",
|
|
1827
|
+
"bodySchema": {
|
|
1828
|
+
"$ref": "#/components/schemas/CreateWebCallRequest"
|
|
1829
|
+
}
|
|
1830
|
+
},
|
|
1831
|
+
"listCalls": {
|
|
1832
|
+
"path": "/api/v1/calls",
|
|
1833
|
+
"method": "get",
|
|
1834
|
+
"summary": "List calls",
|
|
1835
|
+
"parameters": [
|
|
1836
|
+
{
|
|
1837
|
+
"name": "workspaceId",
|
|
1838
|
+
"in": "query",
|
|
1839
|
+
"required": false,
|
|
1840
|
+
"schema": {
|
|
1841
|
+
"type": "integer"
|
|
1842
|
+
},
|
|
1843
|
+
"description": "Optional workspace identifier filter. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"name": "agentId",
|
|
1847
|
+
"in": "query",
|
|
1848
|
+
"required": false,
|
|
1849
|
+
"schema": {
|
|
1850
|
+
"type": "string"
|
|
1851
|
+
},
|
|
1852
|
+
"description": "Filter call listings to a specific agent."
|
|
1853
|
+
},
|
|
1854
|
+
{
|
|
1855
|
+
"name": "status",
|
|
1856
|
+
"in": "query",
|
|
1857
|
+
"required": false,
|
|
1858
|
+
"schema": {
|
|
1859
|
+
"type": "string"
|
|
1860
|
+
},
|
|
1861
|
+
"description": "Filter calls by status."
|
|
1862
|
+
},
|
|
1863
|
+
{
|
|
1864
|
+
"name": "fromDate",
|
|
1865
|
+
"in": "query",
|
|
1866
|
+
"required": false,
|
|
1867
|
+
"schema": {
|
|
1868
|
+
"type": "string",
|
|
1869
|
+
"format": "date-time"
|
|
1870
|
+
},
|
|
1871
|
+
"description": "Inclusive start date for call listing filter."
|
|
1872
|
+
},
|
|
1873
|
+
{
|
|
1874
|
+
"name": "toDate",
|
|
1875
|
+
"in": "query",
|
|
1876
|
+
"required": false,
|
|
1877
|
+
"schema": {
|
|
1878
|
+
"type": "string",
|
|
1879
|
+
"format": "date-time"
|
|
1880
|
+
},
|
|
1881
|
+
"description": "Inclusive end date for call listing filter."
|
|
1882
|
+
},
|
|
1883
|
+
{
|
|
1884
|
+
"name": "page",
|
|
1885
|
+
"in": "query",
|
|
1886
|
+
"required": false,
|
|
1887
|
+
"schema": {
|
|
1888
|
+
"type": "integer",
|
|
1889
|
+
"minimum": 1,
|
|
1890
|
+
"default": 1
|
|
1891
|
+
}
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"name": "limit",
|
|
1895
|
+
"in": "query",
|
|
1896
|
+
"required": false,
|
|
1897
|
+
"schema": {
|
|
1898
|
+
"type": "integer",
|
|
1899
|
+
"minimum": 1,
|
|
1900
|
+
"maximum": 100,
|
|
1901
|
+
"default": 20
|
|
1902
|
+
},
|
|
1903
|
+
"description": "Page size for list endpoints."
|
|
1904
|
+
}
|
|
1905
|
+
],
|
|
1906
|
+
"bodyRequired": false,
|
|
1907
|
+
"bodyType": null,
|
|
1908
|
+
"bodySchema": null
|
|
1909
|
+
},
|
|
1910
|
+
"listCallsFiltered": {
|
|
1911
|
+
"path": "/api/v1/calls/list",
|
|
1912
|
+
"method": "post",
|
|
1913
|
+
"summary": "List calls",
|
|
1914
|
+
"parameters": [],
|
|
1915
|
+
"bodyRequired": false,
|
|
1916
|
+
"bodyType": "application/json",
|
|
1917
|
+
"bodySchema": {
|
|
1918
|
+
"$ref": "#/components/schemas/V3ListCallsRequest"
|
|
1919
|
+
}
|
|
1920
|
+
},
|
|
1921
|
+
"fetchCallHistory": {
|
|
1922
|
+
"path": "/api/v1/calls/history",
|
|
1923
|
+
"method": "get",
|
|
1924
|
+
"summary": "Fetch call history",
|
|
1925
|
+
"parameters": [
|
|
1926
|
+
{
|
|
1927
|
+
"name": "workspaceId",
|
|
1928
|
+
"in": "query",
|
|
1929
|
+
"required": true,
|
|
1930
|
+
"schema": {
|
|
1931
|
+
"type": "integer"
|
|
1932
|
+
},
|
|
1933
|
+
"description": "Workspace identifier. Call GET /api/v1/workspaces to list workspaces accessible to your token."
|
|
1934
|
+
},
|
|
1935
|
+
{
|
|
1936
|
+
"name": "agentId",
|
|
1937
|
+
"in": "query",
|
|
1938
|
+
"required": false,
|
|
1939
|
+
"schema": {
|
|
1940
|
+
"type": "string"
|
|
1941
|
+
},
|
|
1942
|
+
"description": "Filter call listings to a specific agent."
|
|
1943
|
+
},
|
|
1944
|
+
{
|
|
1945
|
+
"name": "agentVersion",
|
|
1946
|
+
"in": "query",
|
|
1947
|
+
"required": false,
|
|
1948
|
+
"schema": {
|
|
1949
|
+
"type": "integer",
|
|
1950
|
+
"minimum": 0
|
|
1951
|
+
},
|
|
1952
|
+
"description": "Filter call history to a specific persisted agent version captured at call time."
|
|
1953
|
+
},
|
|
1954
|
+
{
|
|
1955
|
+
"name": "status",
|
|
1956
|
+
"in": "query",
|
|
1957
|
+
"required": false,
|
|
1958
|
+
"schema": {
|
|
1959
|
+
"type": "string"
|
|
1960
|
+
},
|
|
1961
|
+
"description": "Filter calls by status."
|
|
1962
|
+
},
|
|
1963
|
+
{
|
|
1964
|
+
"name": "search",
|
|
1965
|
+
"in": "query",
|
|
1966
|
+
"required": false,
|
|
1967
|
+
"schema": {
|
|
1968
|
+
"type": "string"
|
|
1969
|
+
},
|
|
1970
|
+
"description": "Search by call SID, phone number, platform call ID, customer name, or agent name."
|
|
1971
|
+
},
|
|
1972
|
+
{
|
|
1973
|
+
"name": "fromDate",
|
|
1974
|
+
"in": "query",
|
|
1975
|
+
"required": false,
|
|
1976
|
+
"schema": {
|
|
1977
|
+
"type": "string",
|
|
1978
|
+
"format": "date-time"
|
|
1979
|
+
},
|
|
1980
|
+
"description": "Inclusive start date for call listing filter."
|
|
1981
|
+
},
|
|
1982
|
+
{
|
|
1983
|
+
"name": "toDate",
|
|
1984
|
+
"in": "query",
|
|
1985
|
+
"required": false,
|
|
1986
|
+
"schema": {
|
|
1987
|
+
"type": "string",
|
|
1988
|
+
"format": "date-time"
|
|
1989
|
+
},
|
|
1990
|
+
"description": "Inclusive end date for call listing filter."
|
|
1991
|
+
},
|
|
1992
|
+
{
|
|
1993
|
+
"name": "page",
|
|
1994
|
+
"in": "query",
|
|
1995
|
+
"required": false,
|
|
1996
|
+
"schema": {
|
|
1997
|
+
"type": "integer",
|
|
1998
|
+
"minimum": 1,
|
|
1999
|
+
"default": 1
|
|
2000
|
+
}
|
|
2001
|
+
},
|
|
2002
|
+
{
|
|
2003
|
+
"name": "limit",
|
|
2004
|
+
"in": "query",
|
|
2005
|
+
"required": false,
|
|
2006
|
+
"schema": {
|
|
2007
|
+
"type": "integer",
|
|
2008
|
+
"minimum": 1,
|
|
2009
|
+
"maximum": 100,
|
|
2010
|
+
"default": 20
|
|
2011
|
+
},
|
|
2012
|
+
"description": "Page size for list endpoints."
|
|
2013
|
+
},
|
|
2014
|
+
{
|
|
2015
|
+
"name": "includeArchived",
|
|
2016
|
+
"in": "query",
|
|
2017
|
+
"required": false,
|
|
2018
|
+
"schema": {
|
|
2019
|
+
"type": "boolean",
|
|
2020
|
+
"default": false
|
|
2021
|
+
},
|
|
2022
|
+
"description": "When true, include archived calls in the response."
|
|
2023
|
+
},
|
|
2024
|
+
{
|
|
2025
|
+
"name": "includeChildCalls",
|
|
2026
|
+
"in": "query",
|
|
2027
|
+
"required": false,
|
|
2028
|
+
"schema": {
|
|
2029
|
+
"type": "boolean",
|
|
2030
|
+
"default": false
|
|
2031
|
+
},
|
|
2032
|
+
"description": "When true, include child calls linked to transfer or split-call workflows."
|
|
2033
|
+
}
|
|
2034
|
+
],
|
|
2035
|
+
"bodyRequired": false,
|
|
2036
|
+
"bodyType": null,
|
|
2037
|
+
"bodySchema": null
|
|
2038
|
+
},
|
|
2039
|
+
"getCall": {
|
|
2040
|
+
"path": "/api/v1/calls/{callId}",
|
|
2041
|
+
"method": "get",
|
|
2042
|
+
"summary": "Get call",
|
|
2043
|
+
"parameters": [
|
|
2044
|
+
{
|
|
2045
|
+
"name": "callId",
|
|
2046
|
+
"in": "path",
|
|
2047
|
+
"required": true,
|
|
2048
|
+
"schema": {
|
|
2049
|
+
"type": "string"
|
|
2050
|
+
},
|
|
2051
|
+
"description": "Call identifier or SID."
|
|
2052
|
+
}
|
|
2053
|
+
],
|
|
2054
|
+
"bodyRequired": false,
|
|
2055
|
+
"bodyType": null,
|
|
2056
|
+
"bodySchema": null
|
|
2057
|
+
},
|
|
2058
|
+
"updateCall": {
|
|
2059
|
+
"path": "/api/v1/calls/{callId}",
|
|
2060
|
+
"method": "patch",
|
|
2061
|
+
"summary": "Update call",
|
|
2062
|
+
"parameters": [
|
|
2063
|
+
{
|
|
2064
|
+
"name": "callId",
|
|
2065
|
+
"in": "path",
|
|
2066
|
+
"required": true,
|
|
2067
|
+
"schema": {
|
|
2068
|
+
"type": "string"
|
|
2069
|
+
},
|
|
2070
|
+
"description": "Call identifier or SID."
|
|
2071
|
+
}
|
|
2072
|
+
],
|
|
2073
|
+
"bodyRequired": true,
|
|
2074
|
+
"bodyType": "application/json",
|
|
2075
|
+
"bodySchema": {
|
|
2076
|
+
"$ref": "#/components/schemas/UpdateCallRequest"
|
|
2077
|
+
}
|
|
2078
|
+
},
|
|
2079
|
+
"endLiveCall": {
|
|
2080
|
+
"path": "/api/v1/calls/{callId}/end",
|
|
2081
|
+
"method": "post",
|
|
2082
|
+
"summary": "End live call",
|
|
2083
|
+
"parameters": [
|
|
2084
|
+
{
|
|
2085
|
+
"name": "callId",
|
|
2086
|
+
"in": "path",
|
|
2087
|
+
"required": true,
|
|
2088
|
+
"schema": {
|
|
2089
|
+
"type": "string"
|
|
2090
|
+
},
|
|
2091
|
+
"description": "Call identifier or SID."
|
|
2092
|
+
}
|
|
2093
|
+
],
|
|
2094
|
+
"bodyRequired": false,
|
|
2095
|
+
"bodyType": "application/json",
|
|
2096
|
+
"bodySchema": {
|
|
2097
|
+
"$ref": "#/components/schemas/CallActionWorkspaceRequest"
|
|
2098
|
+
}
|
|
2099
|
+
},
|
|
2100
|
+
"updateLiveCall": {
|
|
2101
|
+
"path": "/api/v1/calls/{callId}/live",
|
|
2102
|
+
"method": "patch",
|
|
2103
|
+
"summary": "Update live call",
|
|
2104
|
+
"parameters": [
|
|
2105
|
+
{
|
|
2106
|
+
"name": "callId",
|
|
2107
|
+
"in": "path",
|
|
2108
|
+
"required": true,
|
|
2109
|
+
"schema": {
|
|
2110
|
+
"type": "string"
|
|
2111
|
+
},
|
|
2112
|
+
"description": "Call identifier or SID."
|
|
2113
|
+
}
|
|
2114
|
+
],
|
|
2115
|
+
"bodyRequired": true,
|
|
2116
|
+
"bodyType": "application/json",
|
|
2117
|
+
"bodySchema": {
|
|
2118
|
+
"$ref": "#/components/schemas/UpdateLiveCallRequest"
|
|
2119
|
+
}
|
|
2120
|
+
},
|
|
2121
|
+
"rerunCallAnalysis": {
|
|
2122
|
+
"path": "/api/v1/calls/{callId}/analysis/rerun",
|
|
2123
|
+
"method": "put",
|
|
2124
|
+
"summary": "Rerun call analysis",
|
|
2125
|
+
"parameters": [
|
|
2126
|
+
{
|
|
2127
|
+
"name": "callId",
|
|
2128
|
+
"in": "path",
|
|
2129
|
+
"required": true,
|
|
2130
|
+
"schema": {
|
|
2131
|
+
"type": "string"
|
|
2132
|
+
},
|
|
2133
|
+
"description": "Call identifier or SID."
|
|
2134
|
+
}
|
|
2135
|
+
],
|
|
2136
|
+
"bodyRequired": false,
|
|
2137
|
+
"bodyType": "application/json",
|
|
2138
|
+
"bodySchema": {
|
|
2139
|
+
"$ref": "#/components/schemas/CallActionWorkspaceRequest"
|
|
2140
|
+
}
|
|
2141
|
+
}
|
|
2142
|
+
};
|