@epilot/cli 0.1.212 → 0.1.213
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/definitions/ai-agents.json +1876 -450
- package/dist/{access-token-Y5S5XUCQ.js → access-token-EFXWKVSM.js} +2 -2
- package/dist/{add-component-54LK3CSB.js → add-component-HO5K2E5S.js} +2 -2
- package/dist/{add-function-HVMMQOYL.js → add-function-PUG3JLQU.js} +2 -2
- package/dist/{address-ZZFNW3GY.js → address-RFLQMMPA.js} +2 -2
- package/dist/{address-suggestions-ZAPCZKKX.js → address-suggestions-STSSH64L.js} +2 -2
- package/dist/{ai-agents-XKGI2BP5.js → ai-agents-LLUL7JK4.js} +2 -2
- package/dist/{api-73TOYCHG.js → api-OWCUDKQW.js} +2 -2
- package/dist/app-3YAJH3BR.js +26 -0
- package/dist/{audit-logs-UUG6E5DB.js → audit-logs-4YNPLEDW.js} +2 -2
- package/dist/{automation-3XGH4GBH.js → automation-PTO3XXKF.js} +2 -2
- package/dist/{billing-LUB6OQTC.js → billing-N4I55XZY.js} +2 -2
- package/dist/bin/epilot.js +61 -61
- package/dist/{blueprint-manifest-JHQBFR7D.js → blueprint-manifest-BP7BHIAK.js} +2 -2
- package/dist/{calendar-H25CYIVO.js → calendar-H7OLOWWS.js} +2 -2
- package/dist/{chat-ZHVC2OC4.js → chat-CDGVZS5V.js} +2 -2
- package/dist/{chunk-ZDX4D6DE.js → chunk-BBL3RWW3.js} +1 -1
- package/dist/{chunk-5323KYPY.js → chunk-BVS5ECQA.js} +12 -1
- package/dist/{chunk-PXZ5GHS4.js → chunk-LBMKIPAA.js} +1 -1
- package/dist/{chunk-XW7C377I.js → chunk-VNJMFZBC.js} +1 -1
- package/dist/{completion-CO7C74VQ.js → completion-MVY6A4TG.js} +1 -1
- package/dist/{configuration-hub-4VQG4C5D.js → configuration-hub-4KIJC3M7.js} +2 -2
- package/dist/{consent-TLPVJYPE.js → consent-52F5FNT7.js} +2 -2
- package/dist/{customer-portal-5VIY4ADN.js → customer-portal-TLBFM7DT.js} +2 -2
- package/dist/{dashboard-L3Z76TJF.js → dashboard-SZ7TYDJA.js} +2 -2
- package/dist/{data-governance-MC7GUKGI.js → data-governance-RB5I2PHI.js} +2 -2
- package/dist/{deduplication-MZEPYFQB.js → deduplication-G2AZJXEJ.js} +2 -2
- package/dist/{deploy-Q3B57X3Z.js → deploy-6XV4KU7T.js} +2 -2
- package/dist/{design-7K7UTUMA.js → design-2H3DR753.js} +2 -2
- package/dist/{dev-4G6ANEN4.js → dev-4B7TVTXC.js} +2 -2
- package/dist/{document-QI47JUS5.js → document-OL46EELF.js} +2 -2
- package/dist/{email-settings-IXQE3WRS.js → email-settings-L3G4OUXC.js} +2 -2
- package/dist/{email-template-2ZKDWNDK.js → email-template-QGVNXWXQ.js} +2 -2
- package/dist/{entity-HAIMFYEG.js → entity-KIQ57UXF.js} +2 -2
- package/dist/{entity-mapping-3GG2XAZJ.js → entity-mapping-QGGRF2V2.js} +2 -2
- package/dist/{environments-GFUHW2PO.js → environments-T6BJUAYV.js} +2 -2
- package/dist/{event-catalog-KTMAOKTQ.js → event-catalog-EWVMAGSJ.js} +2 -2
- package/dist/{export-YGUG3MNY.js → export-WOFPVNMH.js} +2 -2
- package/dist/{external-values-G2REBBZY.js → external-values-DPJDNTAG.js} +2 -2
- package/dist/{file-HVW577I2.js → file-22RURD3J.js} +2 -2
- package/dist/{iban-SNCDFXEV.js → iban-VCVAMTCQ.js} +2 -2
- package/dist/{identity-7FGW6YXS.js → identity-YPLVKPVD.js} +2 -2
- package/dist/{init-X2LGJS33.js → init-EVCDTTO6.js} +2 -2
- package/dist/{integration-toolkit-HF24VDL6.js → integration-toolkit-OTOPMVZW.js} +2 -2
- package/dist/{journey-WJYB6YM6.js → journey-AWREA2VN.js} +2 -2
- package/dist/{kanban-YIXMFESP.js → kanban-NINAABEC.js} +2 -2
- package/dist/{message-6JVHPL4Z.js → message-E2QLHMWV.js} +2 -2
- package/dist/{metering-CP67KMFS.js → metering-QDTLVZNZ.js} +2 -2
- package/dist/{notes-YPSKQGMN.js → notes-4U2HEODR.js} +2 -2
- package/dist/{notification-HN2QO4CZ.js → notification-VU7RBY2S.js} +2 -2
- package/dist/{organization-YJ7EKX5D.js → organization-OSVYCBGD.js} +2 -2
- package/dist/{partner-directory-QKFX462V.js → partner-directory-CMDLZ6AZ.js} +2 -2
- package/dist/{permissions-R7RXU3HS.js → permissions-PCCNISDG.js} +2 -2
- package/dist/{phone-integration-THSSLWDC.js → phone-integration-CGGLN7MZ.js} +2 -2
- package/dist/{pricing-NIIBFZ5D.js → pricing-OQLWZGSS.js} +2 -2
- package/dist/{pricing-tier-WUH2N4RT.js → pricing-tier-3ZCOUVMM.js} +2 -2
- package/dist/{purpose-NSIUF6WX.js → purpose-WPOYJXKT.js} +2 -2
- package/dist/{query-2LJ6CQAP.js → query-Q7AZGQLX.js} +2 -2
- package/dist/{remove-component-77CWIOSK.js → remove-component-5AVTYBHL.js} +2 -2
- package/dist/{review-6LG5CYE5.js → review-ERVARUO5.js} +2 -2
- package/dist/{sandbox-SPGUYGRP.js → sandbox-7ZSJEZYP.js} +2 -2
- package/dist/{sharing-SIVI5VBW.js → sharing-67KCYO33.js} +2 -2
- package/dist/{snapshot-QNMEOVUS.js → snapshot-CH5F3DLO.js} +2 -2
- package/dist/{submission-ACQECUPW.js → submission-7ASSGT5J.js} +2 -2
- package/dist/{targeting-6I5KTOLL.js → targeting-E6EV7W4D.js} +2 -2
- package/dist/{template-variables-EJBWEOEX.js → template-variables-FPXRAYLG.js} +2 -2
- package/dist/{upgrade-MLSEKTBY.js → upgrade-ZUMCB7AR.js} +1 -1
- package/dist/{user-QULYB7FC.js → user-GJ3G3XAD.js} +2 -2
- package/dist/{validate-E6BMCLTM.js → validate-Y5ZDH4OD.js} +2 -2
- package/dist/{validation-rules-65EMXMCZ.js → validation-rules-XAREU4LN.js} +2 -2
- package/dist/{versions-M63VHJB4.js → versions-UO2ZNEIE.js} +2 -2
- package/dist/{webhooks-MWDV7QVB.js → webhooks-N6KPYBZG.js} +2 -2
- package/dist/{workflow-7QB4SFLV.js → workflow-V6Y2GMYJ.js} +2 -2
- package/dist/{workflow-definition-VQJZPADV.js → workflow-definition-G53IREEE.js} +2 -2
- package/package.json +1 -1
- package/dist/app-KJOJDVBH.js +0 -26
|
@@ -26,6 +26,10 @@
|
|
|
26
26
|
"name": "Agents Configuration",
|
|
27
27
|
"description": "Everything about AI Agent configuration"
|
|
28
28
|
},
|
|
29
|
+
{
|
|
30
|
+
"name": "Customer Chat",
|
|
31
|
+
"description": "Org-scoped configuration for website and portal chat agents"
|
|
32
|
+
},
|
|
29
33
|
{
|
|
30
34
|
"name": "Agent Execution",
|
|
31
35
|
"description": "Execute AI agents and manage executions"
|
|
@@ -37,6 +41,10 @@
|
|
|
37
41
|
{
|
|
38
42
|
"name": "Conversations",
|
|
39
43
|
"description": "Manage conversation history"
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
"name": "Knowledge",
|
|
47
|
+
"description": "Manage knowledge sources used by custom agents"
|
|
40
48
|
}
|
|
41
49
|
],
|
|
42
50
|
"paths": {
|
|
@@ -45,7 +53,7 @@
|
|
|
45
53
|
"tags": [
|
|
46
54
|
"Agents Configuration"
|
|
47
55
|
],
|
|
48
|
-
"summary": "
|
|
56
|
+
"summary": "Create Agent definition",
|
|
49
57
|
"description": "Creates a new custom agent. System skills cannot be created via this endpoint.",
|
|
50
58
|
"operationId": "createAgent",
|
|
51
59
|
"security": [
|
|
@@ -90,7 +98,7 @@
|
|
|
90
98
|
"tags": [
|
|
91
99
|
"Agents Configuration"
|
|
92
100
|
],
|
|
93
|
-
"summary": "
|
|
101
|
+
"summary": "List all agent configurations",
|
|
94
102
|
"description": "Lists agents from both system skills and custom agents.\nUse query parameters to filter by source, availability, or entity schema.\n",
|
|
95
103
|
"operationId": "listAgents",
|
|
96
104
|
"parameters": [
|
|
@@ -148,7 +156,7 @@
|
|
|
148
156
|
"tags": [
|
|
149
157
|
"Agents Configuration"
|
|
150
158
|
],
|
|
151
|
-
"summary": "
|
|
159
|
+
"summary": "Get the agent configuration by ID",
|
|
152
160
|
"description": "Retrieves an agent by ID. Supports both:\n- System skill IDs (prefixed): \"skill:email-categorizer\"\n- Custom agent IDs (UUID): \"0336a235-9417-4dd8-894c-fe81285bba75\"\n",
|
|
153
161
|
"operationId": "getAgentById",
|
|
154
162
|
"security": [
|
|
@@ -193,7 +201,7 @@
|
|
|
193
201
|
"tags": [
|
|
194
202
|
"Agents Configuration"
|
|
195
203
|
],
|
|
196
|
-
"summary": "
|
|
204
|
+
"summary": "Update the agent configuration by ID",
|
|
197
205
|
"description": "Updates a custom agent. System skills cannot be updated via this endpoint.",
|
|
198
206
|
"operationId": "updateAgentById",
|
|
199
207
|
"security": [
|
|
@@ -241,6 +249,26 @@
|
|
|
241
249
|
}
|
|
242
250
|
}
|
|
243
251
|
}
|
|
252
|
+
},
|
|
253
|
+
"404": {
|
|
254
|
+
"description": "Agent not found",
|
|
255
|
+
"content": {
|
|
256
|
+
"application/json": {
|
|
257
|
+
"schema": {
|
|
258
|
+
"$ref": "#/components/schemas/Error"
|
|
259
|
+
}
|
|
260
|
+
}
|
|
261
|
+
}
|
|
262
|
+
},
|
|
263
|
+
"409": {
|
|
264
|
+
"description": "Agent changed during the update; retry the request",
|
|
265
|
+
"content": {
|
|
266
|
+
"application/json": {
|
|
267
|
+
"schema": {
|
|
268
|
+
"$ref": "#/components/schemas/Error"
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
}
|
|
244
272
|
}
|
|
245
273
|
}
|
|
246
274
|
},
|
|
@@ -248,7 +276,7 @@
|
|
|
248
276
|
"tags": [
|
|
249
277
|
"Agents Configuration"
|
|
250
278
|
],
|
|
251
|
-
"summary": "
|
|
279
|
+
"summary": "Delete the agent configuration by ID",
|
|
252
280
|
"description": "Deletes a custom agent. System skills cannot be deleted via this endpoint.",
|
|
253
281
|
"security": [
|
|
254
282
|
{
|
|
@@ -283,62 +311,32 @@
|
|
|
283
311
|
}
|
|
284
312
|
}
|
|
285
313
|
},
|
|
286
|
-
"/v1/
|
|
287
|
-
"
|
|
314
|
+
"/v1/customer-chat": {
|
|
315
|
+
"get": {
|
|
288
316
|
"tags": [
|
|
289
|
-
"
|
|
317
|
+
"Customer Chat"
|
|
290
318
|
],
|
|
291
|
-
"summary": "
|
|
292
|
-
"description": "
|
|
293
|
-
"operationId": "
|
|
319
|
+
"summary": "List customer chat agents",
|
|
320
|
+
"description": "Returns the org's website agent (at most one) first, then its portal agents ordered by created_at ascending.",
|
|
321
|
+
"operationId": "listCustomerChat",
|
|
294
322
|
"security": [
|
|
295
323
|
{
|
|
296
324
|
"EpilotAuth": []
|
|
297
325
|
}
|
|
298
326
|
],
|
|
299
|
-
"parameters": [
|
|
300
|
-
{
|
|
301
|
-
"name": "agent_id",
|
|
302
|
-
"in": "path",
|
|
303
|
-
"required": true,
|
|
304
|
-
"schema": {
|
|
305
|
-
"$ref": "#/components/schemas/AgentId"
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
],
|
|
309
|
-
"requestBody": {
|
|
310
|
-
"required": false,
|
|
311
|
-
"content": {
|
|
312
|
-
"application/json": {
|
|
313
|
-
"schema": {
|
|
314
|
-
"$ref": "#/components/schemas/ExecuteAgentRequest"
|
|
315
|
-
}
|
|
316
|
-
}
|
|
317
|
-
}
|
|
318
|
-
},
|
|
319
327
|
"responses": {
|
|
320
328
|
"200": {
|
|
321
|
-
"description": "
|
|
329
|
+
"description": "Customer Chat agents",
|
|
322
330
|
"content": {
|
|
323
331
|
"application/json": {
|
|
324
332
|
"schema": {
|
|
325
|
-
"$ref": "#/components/schemas/
|
|
333
|
+
"$ref": "#/components/schemas/ListCustomerChatResponse"
|
|
326
334
|
}
|
|
327
335
|
}
|
|
328
336
|
}
|
|
329
337
|
},
|
|
330
338
|
"400": {
|
|
331
|
-
"description": "Error
|
|
332
|
-
"content": {
|
|
333
|
-
"application/json": {
|
|
334
|
-
"schema": {
|
|
335
|
-
"$ref": "#/components/schemas/Error"
|
|
336
|
-
}
|
|
337
|
-
}
|
|
338
|
-
}
|
|
339
|
-
},
|
|
340
|
-
"404": {
|
|
341
|
-
"description": "Agent not found",
|
|
339
|
+
"description": "Error listing customer chat",
|
|
342
340
|
"content": {
|
|
343
341
|
"application/json": {
|
|
344
342
|
"schema": {
|
|
@@ -348,54 +346,42 @@
|
|
|
348
346
|
}
|
|
349
347
|
}
|
|
350
348
|
}
|
|
351
|
-
}
|
|
352
|
-
},
|
|
353
|
-
"/v1/agents/{agent_id}/execute/stream": {
|
|
349
|
+
},
|
|
354
350
|
"post": {
|
|
355
351
|
"tags": [
|
|
356
|
-
"
|
|
352
|
+
"Customer Chat"
|
|
357
353
|
],
|
|
358
|
-
"summary": "
|
|
359
|
-
"description": "
|
|
360
|
-
"operationId": "
|
|
354
|
+
"summary": "Create a customer chat agent with default config",
|
|
355
|
+
"description": "Mints agent_id (equal to runtime_agent_id) and compiles the runtime AgentRecord. An org can have at most one website agent (409 on a second one) and any number of portal agents.",
|
|
356
|
+
"operationId": "createCustomerChatAgent",
|
|
361
357
|
"security": [
|
|
362
358
|
{
|
|
363
359
|
"EpilotAuth": []
|
|
364
360
|
}
|
|
365
361
|
],
|
|
366
|
-
"parameters": [
|
|
367
|
-
{
|
|
368
|
-
"name": "agent_id",
|
|
369
|
-
"in": "path",
|
|
370
|
-
"required": true,
|
|
371
|
-
"schema": {
|
|
372
|
-
"$ref": "#/components/schemas/AgentId"
|
|
373
|
-
}
|
|
374
|
-
}
|
|
375
|
-
],
|
|
376
362
|
"requestBody": {
|
|
377
|
-
"required":
|
|
363
|
+
"required": true,
|
|
378
364
|
"content": {
|
|
379
365
|
"application/json": {
|
|
380
366
|
"schema": {
|
|
381
|
-
"$ref": "#/components/schemas/
|
|
367
|
+
"$ref": "#/components/schemas/CreateCustomerChatAgentRequest"
|
|
382
368
|
}
|
|
383
369
|
}
|
|
384
370
|
}
|
|
385
371
|
},
|
|
386
372
|
"responses": {
|
|
387
|
-
"
|
|
388
|
-
"description": "
|
|
373
|
+
"201": {
|
|
374
|
+
"description": "Customer Chat agent created",
|
|
389
375
|
"content": {
|
|
390
|
-
"
|
|
376
|
+
"application/json": {
|
|
391
377
|
"schema": {
|
|
392
|
-
"$ref": "#/components/schemas/
|
|
378
|
+
"$ref": "#/components/schemas/CustomerChatAgent"
|
|
393
379
|
}
|
|
394
380
|
}
|
|
395
381
|
}
|
|
396
382
|
},
|
|
397
383
|
"400": {
|
|
398
|
-
"description": "
|
|
384
|
+
"description": "Invalid request",
|
|
399
385
|
"content": {
|
|
400
386
|
"application/json": {
|
|
401
387
|
"schema": {
|
|
@@ -404,8 +390,8 @@
|
|
|
404
390
|
}
|
|
405
391
|
}
|
|
406
392
|
},
|
|
407
|
-
"
|
|
408
|
-
"description": "
|
|
393
|
+
"409": {
|
|
394
|
+
"description": "The org already has a website agent",
|
|
409
395
|
"content": {
|
|
410
396
|
"application/json": {
|
|
411
397
|
"schema": {
|
|
@@ -417,63 +403,26 @@
|
|
|
417
403
|
}
|
|
418
404
|
}
|
|
419
405
|
},
|
|
420
|
-
"/v1/
|
|
406
|
+
"/v1/customer-chat/capabilities": {
|
|
421
407
|
"get": {
|
|
422
408
|
"tags": [
|
|
423
|
-
"
|
|
409
|
+
"Customer Chat"
|
|
424
410
|
],
|
|
425
|
-
"summary": "
|
|
426
|
-
"description": "
|
|
427
|
-
"operationId": "
|
|
411
|
+
"summary": "List the capability catalog",
|
|
412
|
+
"description": "Capabilities admins can enable and the places they are offered on.\nSingle source of truth for Agent Builder; capabilities that are no\nlonger offered are omitted, while already-enabled instances of them\nkeep working.\n",
|
|
413
|
+
"operationId": "listCustomerChatCapabilities",
|
|
428
414
|
"security": [
|
|
429
415
|
{
|
|
430
416
|
"EpilotAuth": []
|
|
431
417
|
}
|
|
432
418
|
],
|
|
433
|
-
"parameters": [
|
|
434
|
-
{
|
|
435
|
-
"name": "agent_id",
|
|
436
|
-
"in": "query",
|
|
437
|
-
"schema": {
|
|
438
|
-
"type": "string"
|
|
439
|
-
},
|
|
440
|
-
"description": "Filter by agent ID"
|
|
441
|
-
},
|
|
442
|
-
{
|
|
443
|
-
"name": "status",
|
|
444
|
-
"in": "query",
|
|
445
|
-
"schema": {
|
|
446
|
-
"$ref": "#/components/schemas/ExecutionStatus"
|
|
447
|
-
},
|
|
448
|
-
"description": "Filter by status"
|
|
449
|
-
},
|
|
450
|
-
{
|
|
451
|
-
"name": "limit",
|
|
452
|
-
"in": "query",
|
|
453
|
-
"schema": {
|
|
454
|
-
"type": "integer",
|
|
455
|
-
"default": 50
|
|
456
|
-
},
|
|
457
|
-
"description": "Maximum number of executions to return"
|
|
458
|
-
}
|
|
459
|
-
],
|
|
460
419
|
"responses": {
|
|
461
420
|
"200": {
|
|
462
|
-
"description": "
|
|
463
|
-
"content": {
|
|
464
|
-
"application/json": {
|
|
465
|
-
"schema": {
|
|
466
|
-
"$ref": "#/components/schemas/ListExecutionsResponse"
|
|
467
|
-
}
|
|
468
|
-
}
|
|
469
|
-
}
|
|
470
|
-
},
|
|
471
|
-
"400": {
|
|
472
|
-
"description": "Error fetching executions",
|
|
421
|
+
"description": "Capability catalog",
|
|
473
422
|
"content": {
|
|
474
423
|
"application/json": {
|
|
475
424
|
"schema": {
|
|
476
|
-
"$ref": "#/components/schemas/
|
|
425
|
+
"$ref": "#/components/schemas/ListCustomerChatCapabilitiesResponse"
|
|
477
426
|
}
|
|
478
427
|
}
|
|
479
428
|
}
|
|
@@ -481,14 +430,13 @@
|
|
|
481
430
|
}
|
|
482
431
|
}
|
|
483
432
|
},
|
|
484
|
-
"/v1/
|
|
433
|
+
"/v1/customer-chat/{agent_id}": {
|
|
485
434
|
"get": {
|
|
486
435
|
"tags": [
|
|
487
|
-
"
|
|
436
|
+
"Customer Chat"
|
|
488
437
|
],
|
|
489
|
-
"summary": "
|
|
490
|
-
"
|
|
491
|
-
"operationId": "getExecution",
|
|
438
|
+
"summary": "Get a customer chat agent",
|
|
439
|
+
"operationId": "getCustomerChatAgent",
|
|
492
440
|
"security": [
|
|
493
441
|
{
|
|
494
442
|
"EpilotAuth": []
|
|
@@ -496,28 +444,22 @@
|
|
|
496
444
|
],
|
|
497
445
|
"parameters": [
|
|
498
446
|
{
|
|
499
|
-
"
|
|
500
|
-
"in": "path",
|
|
501
|
-
"required": true,
|
|
502
|
-
"schema": {
|
|
503
|
-
"type": "string",
|
|
504
|
-
"format": "uuid"
|
|
505
|
-
}
|
|
447
|
+
"$ref": "#/components/parameters/CustomerChatAgentIdPath"
|
|
506
448
|
}
|
|
507
449
|
],
|
|
508
450
|
"responses": {
|
|
509
451
|
"200": {
|
|
510
|
-
"description": "
|
|
452
|
+
"description": "Customer Chat agent",
|
|
511
453
|
"content": {
|
|
512
454
|
"application/json": {
|
|
513
455
|
"schema": {
|
|
514
|
-
"$ref": "#/components/schemas/
|
|
456
|
+
"$ref": "#/components/schemas/CustomerChatAgent"
|
|
515
457
|
}
|
|
516
458
|
}
|
|
517
459
|
}
|
|
518
460
|
},
|
|
519
461
|
"404": {
|
|
520
|
-
"description": "
|
|
462
|
+
"description": "Customer Chat agent not found",
|
|
521
463
|
"content": {
|
|
522
464
|
"application/json": {
|
|
523
465
|
"schema": {
|
|
@@ -528,13 +470,12 @@
|
|
|
528
470
|
}
|
|
529
471
|
}
|
|
530
472
|
},
|
|
531
|
-
"
|
|
473
|
+
"patch": {
|
|
532
474
|
"tags": [
|
|
533
|
-
"
|
|
475
|
+
"Customer Chat"
|
|
534
476
|
],
|
|
535
|
-
"summary": "
|
|
536
|
-
"
|
|
537
|
-
"operationId": "cancelExecution",
|
|
477
|
+
"summary": "Rename a customer chat agent",
|
|
478
|
+
"operationId": "renameCustomerChatAgent",
|
|
538
479
|
"security": [
|
|
539
480
|
{
|
|
540
481
|
"EpilotAuth": []
|
|
@@ -542,28 +483,35 @@
|
|
|
542
483
|
],
|
|
543
484
|
"parameters": [
|
|
544
485
|
{
|
|
545
|
-
"
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
"
|
|
549
|
-
"type": "string",
|
|
550
|
-
"format": "uuid"
|
|
551
|
-
}
|
|
486
|
+
"$ref": "#/components/parameters/CustomerChatAgentIdPath"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
"$ref": "#/components/parameters/IfMatchUpdatedAt"
|
|
552
490
|
}
|
|
553
491
|
],
|
|
492
|
+
"requestBody": {
|
|
493
|
+
"required": true,
|
|
494
|
+
"content": {
|
|
495
|
+
"application/json": {
|
|
496
|
+
"schema": {
|
|
497
|
+
"$ref": "#/components/schemas/RenameCustomerChatAgentRequest"
|
|
498
|
+
}
|
|
499
|
+
}
|
|
500
|
+
}
|
|
501
|
+
},
|
|
554
502
|
"responses": {
|
|
555
503
|
"200": {
|
|
556
|
-
"description": "
|
|
504
|
+
"description": "Customer Chat agent renamed",
|
|
557
505
|
"content": {
|
|
558
506
|
"application/json": {
|
|
559
507
|
"schema": {
|
|
560
|
-
"$ref": "#/components/schemas/
|
|
508
|
+
"$ref": "#/components/schemas/CustomerChatAgent"
|
|
561
509
|
}
|
|
562
510
|
}
|
|
563
511
|
}
|
|
564
512
|
},
|
|
565
513
|
"400": {
|
|
566
|
-
"description": "
|
|
514
|
+
"description": "Invalid request",
|
|
567
515
|
"content": {
|
|
568
516
|
"application/json": {
|
|
569
517
|
"schema": {
|
|
@@ -573,7 +521,17 @@
|
|
|
573
521
|
}
|
|
574
522
|
},
|
|
575
523
|
"404": {
|
|
576
|
-
"description": "
|
|
524
|
+
"description": "Customer Chat agent not found",
|
|
525
|
+
"content": {
|
|
526
|
+
"application/json": {
|
|
527
|
+
"schema": {
|
|
528
|
+
"$ref": "#/components/schemas/Error"
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
},
|
|
533
|
+
"409": {
|
|
534
|
+
"description": "Stale update",
|
|
577
535
|
"content": {
|
|
578
536
|
"application/json": {
|
|
579
537
|
"schema": {
|
|
@@ -583,16 +541,14 @@
|
|
|
583
541
|
}
|
|
584
542
|
}
|
|
585
543
|
}
|
|
586
|
-
}
|
|
587
|
-
|
|
588
|
-
"/v1/executions/{execution_id}/trace": {
|
|
589
|
-
"get": {
|
|
544
|
+
},
|
|
545
|
+
"delete": {
|
|
590
546
|
"tags": [
|
|
591
|
-
"
|
|
547
|
+
"Customer Chat"
|
|
592
548
|
],
|
|
593
|
-
"summary": "
|
|
594
|
-
"description": "
|
|
595
|
-
"operationId": "
|
|
549
|
+
"summary": "Remove a customer chat agent and its runtime projection",
|
|
550
|
+
"description": "Deletes the place agent. For portal agents, also clears\n`feature_settings.portal_copilot_agent_id` on linked portals (pass\n`portal_id` when known, otherwise the API scans org portal configs)\nbefore deleting, so a single request cannot leave an orphan agent.\n",
|
|
551
|
+
"operationId": "deleteCustomerChatAgent",
|
|
596
552
|
"security": [
|
|
597
553
|
{
|
|
598
554
|
"EpilotAuth": []
|
|
@@ -600,28 +556,38 @@
|
|
|
600
556
|
],
|
|
601
557
|
"parameters": [
|
|
602
558
|
{
|
|
603
|
-
"
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
"
|
|
607
|
-
"type": "string",
|
|
608
|
-
"format": "uuid"
|
|
609
|
-
}
|
|
559
|
+
"$ref": "#/components/parameters/CustomerChatAgentIdPath"
|
|
560
|
+
},
|
|
561
|
+
{
|
|
562
|
+
"$ref": "#/components/parameters/IfMatchUpdatedAt"
|
|
610
563
|
}
|
|
611
564
|
],
|
|
565
|
+
"requestBody": {
|
|
566
|
+
"required": false,
|
|
567
|
+
"content": {
|
|
568
|
+
"application/json": {
|
|
569
|
+
"schema": {
|
|
570
|
+
"$ref": "#/components/schemas/DeleteCustomerChatAgentRequest"
|
|
571
|
+
}
|
|
572
|
+
}
|
|
573
|
+
}
|
|
574
|
+
},
|
|
612
575
|
"responses": {
|
|
613
|
-
"
|
|
614
|
-
"description": "
|
|
576
|
+
"204": {
|
|
577
|
+
"description": "Customer Chat agent deleted"
|
|
578
|
+
},
|
|
579
|
+
"404": {
|
|
580
|
+
"description": "Customer Chat agent not found",
|
|
615
581
|
"content": {
|
|
616
582
|
"application/json": {
|
|
617
583
|
"schema": {
|
|
618
|
-
"$ref": "#/components/schemas/
|
|
584
|
+
"$ref": "#/components/schemas/Error"
|
|
619
585
|
}
|
|
620
586
|
}
|
|
621
587
|
}
|
|
622
588
|
},
|
|
623
|
-
"
|
|
624
|
-
"description": "
|
|
589
|
+
"409": {
|
|
590
|
+
"description": "Stale update",
|
|
625
591
|
"content": {
|
|
626
592
|
"application/json": {
|
|
627
593
|
"schema": {
|
|
@@ -633,14 +599,13 @@
|
|
|
633
599
|
}
|
|
634
600
|
}
|
|
635
601
|
},
|
|
636
|
-
"/v1/
|
|
637
|
-
"
|
|
602
|
+
"/v1/customer-chat/{agent_id}/config": {
|
|
603
|
+
"put": {
|
|
638
604
|
"tags": [
|
|
639
|
-
"
|
|
605
|
+
"Customer Chat"
|
|
640
606
|
],
|
|
641
|
-
"summary": "
|
|
642
|
-
"
|
|
643
|
-
"operationId": "getExecutionFeedback",
|
|
607
|
+
"summary": "Replace the AgentConfig and compile the runtime AgentRecord",
|
|
608
|
+
"operationId": "saveCustomerChatConfig",
|
|
644
609
|
"security": [
|
|
645
610
|
{
|
|
646
611
|
"EpilotAuth": []
|
|
@@ -648,28 +613,55 @@
|
|
|
648
613
|
],
|
|
649
614
|
"parameters": [
|
|
650
615
|
{
|
|
651
|
-
"
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
"
|
|
655
|
-
"type": "string",
|
|
656
|
-
"format": "uuid"
|
|
657
|
-
}
|
|
616
|
+
"$ref": "#/components/parameters/CustomerChatAgentIdPath"
|
|
617
|
+
},
|
|
618
|
+
{
|
|
619
|
+
"$ref": "#/components/parameters/IfMatchUpdatedAt"
|
|
658
620
|
}
|
|
659
621
|
],
|
|
622
|
+
"requestBody": {
|
|
623
|
+
"required": true,
|
|
624
|
+
"content": {
|
|
625
|
+
"application/json": {
|
|
626
|
+
"schema": {
|
|
627
|
+
"$ref": "#/components/schemas/SaveCustomerChatConfigRequest"
|
|
628
|
+
}
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
},
|
|
660
632
|
"responses": {
|
|
661
633
|
"200": {
|
|
662
|
-
"description": "
|
|
634
|
+
"description": "Config saved",
|
|
663
635
|
"content": {
|
|
664
636
|
"application/json": {
|
|
665
637
|
"schema": {
|
|
666
|
-
"$ref": "#/components/schemas/
|
|
638
|
+
"$ref": "#/components/schemas/CustomerChatAgent"
|
|
667
639
|
}
|
|
668
640
|
}
|
|
669
641
|
}
|
|
670
642
|
},
|
|
671
|
-
"
|
|
672
|
-
"description": "
|
|
643
|
+
"400": {
|
|
644
|
+
"description": "Invalid config",
|
|
645
|
+
"content": {
|
|
646
|
+
"application/json": {
|
|
647
|
+
"schema": {
|
|
648
|
+
"$ref": "#/components/schemas/Error"
|
|
649
|
+
}
|
|
650
|
+
}
|
|
651
|
+
}
|
|
652
|
+
},
|
|
653
|
+
"404": {
|
|
654
|
+
"description": "Customer Chat agent not found",
|
|
655
|
+
"content": {
|
|
656
|
+
"application/json": {
|
|
657
|
+
"schema": {
|
|
658
|
+
"$ref": "#/components/schemas/Error"
|
|
659
|
+
}
|
|
660
|
+
}
|
|
661
|
+
}
|
|
662
|
+
},
|
|
663
|
+
"409": {
|
|
664
|
+
"description": "Stale update",
|
|
673
665
|
"content": {
|
|
674
666
|
"application/json": {
|
|
675
667
|
"schema": {
|
|
@@ -678,64 +670,61 @@
|
|
|
678
670
|
}
|
|
679
671
|
}
|
|
680
672
|
}
|
|
681
|
-
}
|
|
682
|
-
}
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
"description": "Upserts thumbs up/down feedback and mirrors it to the execution's Langfuse trace.",
|
|
689
|
-
"operationId": "putExecutionFeedback",
|
|
690
|
-
"security": [
|
|
691
|
-
{
|
|
692
|
-
"EpilotAuth": []
|
|
693
|
-
}
|
|
673
|
+
}
|
|
674
|
+
}
|
|
675
|
+
},
|
|
676
|
+
"/v1/knowledge/sources": {
|
|
677
|
+
"get": {
|
|
678
|
+
"tags": [
|
|
679
|
+
"Knowledge"
|
|
694
680
|
],
|
|
695
|
-
"
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
"
|
|
700
|
-
"
|
|
701
|
-
"
|
|
702
|
-
|
|
681
|
+
"summary": "List knowledge sources",
|
|
682
|
+
"operationId": "listKnowledgeSources",
|
|
683
|
+
"responses": {
|
|
684
|
+
"200": {
|
|
685
|
+
"description": "Knowledge sources available to the organization",
|
|
686
|
+
"content": {
|
|
687
|
+
"application/json": {
|
|
688
|
+
"schema": {
|
|
689
|
+
"$ref": "#/components/schemas/ListKnowledgeSourcesResponse"
|
|
690
|
+
}
|
|
691
|
+
}
|
|
703
692
|
}
|
|
704
693
|
}
|
|
694
|
+
}
|
|
695
|
+
}
|
|
696
|
+
},
|
|
697
|
+
"/v1/knowledge/file-uploads": {
|
|
698
|
+
"post": {
|
|
699
|
+
"tags": [
|
|
700
|
+
"Knowledge"
|
|
705
701
|
],
|
|
702
|
+
"summary": "Create a knowledge file upload",
|
|
703
|
+
"description": "Returns a direct S3 upload. The source becomes available after S3 confirms the completed object.",
|
|
704
|
+
"operationId": "createKnowledgeFileUpload",
|
|
706
705
|
"requestBody": {
|
|
707
706
|
"required": true,
|
|
708
707
|
"content": {
|
|
709
708
|
"application/json": {
|
|
710
709
|
"schema": {
|
|
711
|
-
"$ref": "#/components/schemas/
|
|
710
|
+
"$ref": "#/components/schemas/CreateKnowledgeFileUploadRequest"
|
|
712
711
|
}
|
|
713
712
|
}
|
|
714
713
|
}
|
|
715
714
|
},
|
|
716
715
|
"responses": {
|
|
717
|
-
"
|
|
718
|
-
"description": "
|
|
716
|
+
"201": {
|
|
717
|
+
"description": "Upload created",
|
|
719
718
|
"content": {
|
|
720
719
|
"application/json": {
|
|
721
720
|
"schema": {
|
|
722
|
-
"$ref": "#/components/schemas/
|
|
721
|
+
"$ref": "#/components/schemas/CreateKnowledgeFileUploadResponse"
|
|
723
722
|
}
|
|
724
723
|
}
|
|
725
724
|
}
|
|
726
725
|
},
|
|
727
726
|
"400": {
|
|
728
|
-
"description": "Invalid
|
|
729
|
-
"content": {
|
|
730
|
-
"application/json": {
|
|
731
|
-
"schema": {
|
|
732
|
-
"$ref": "#/components/schemas/Error"
|
|
733
|
-
}
|
|
734
|
-
}
|
|
735
|
-
}
|
|
736
|
-
},
|
|
737
|
-
"404": {
|
|
738
|
-
"description": "Execution not found",
|
|
727
|
+
"description": "Invalid file metadata",
|
|
739
728
|
"content": {
|
|
740
729
|
"application/json": {
|
|
741
730
|
"schema": {
|
|
@@ -745,7 +734,7 @@
|
|
|
745
734
|
}
|
|
746
735
|
},
|
|
747
736
|
"409": {
|
|
748
|
-
"description": "
|
|
737
|
+
"description": "Organization knowledge source limit reached",
|
|
749
738
|
"content": {
|
|
750
739
|
"application/json": {
|
|
751
740
|
"schema": {
|
|
@@ -757,52 +746,37 @@
|
|
|
757
746
|
}
|
|
758
747
|
}
|
|
759
748
|
},
|
|
760
|
-
"/v1/
|
|
761
|
-
"
|
|
762
|
-
|
|
763
|
-
"
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
{
|
|
770
|
-
"EpilotAuth": []
|
|
771
|
-
}
|
|
772
|
-
],
|
|
773
|
-
"parameters": [
|
|
774
|
-
{
|
|
775
|
-
"name": "execution_id",
|
|
776
|
-
"in": "path",
|
|
777
|
-
"required": true,
|
|
778
|
-
"schema": {
|
|
779
|
-
"type": "string",
|
|
780
|
-
"format": "uuid"
|
|
781
|
-
}
|
|
749
|
+
"/v1/knowledge/sources/{source_id}": {
|
|
750
|
+
"parameters": [
|
|
751
|
+
{
|
|
752
|
+
"name": "source_id",
|
|
753
|
+
"in": "path",
|
|
754
|
+
"required": true,
|
|
755
|
+
"schema": {
|
|
756
|
+
"type": "string",
|
|
757
|
+
"format": "uuid"
|
|
782
758
|
}
|
|
759
|
+
}
|
|
760
|
+
],
|
|
761
|
+
"get": {
|
|
762
|
+
"tags": [
|
|
763
|
+
"Knowledge"
|
|
783
764
|
],
|
|
784
|
-
"
|
|
785
|
-
|
|
786
|
-
"application/json": {
|
|
787
|
-
"schema": {
|
|
788
|
-
"$ref": "#/components/schemas/ApproveExecutionRequest"
|
|
789
|
-
}
|
|
790
|
-
}
|
|
791
|
-
}
|
|
792
|
-
},
|
|
765
|
+
"summary": "Get a knowledge source",
|
|
766
|
+
"operationId": "getKnowledgeSource",
|
|
793
767
|
"responses": {
|
|
794
768
|
"200": {
|
|
795
|
-
"description": "
|
|
769
|
+
"description": "Knowledge source",
|
|
796
770
|
"content": {
|
|
797
771
|
"application/json": {
|
|
798
772
|
"schema": {
|
|
799
|
-
"$ref": "#/components/schemas/
|
|
773
|
+
"$ref": "#/components/schemas/KnowledgeSource"
|
|
800
774
|
}
|
|
801
775
|
}
|
|
802
776
|
}
|
|
803
777
|
},
|
|
804
|
-
"
|
|
805
|
-
"description": "
|
|
778
|
+
"404": {
|
|
779
|
+
"description": "Knowledge source not found",
|
|
806
780
|
"content": {
|
|
807
781
|
"application/json": {
|
|
808
782
|
"schema": {
|
|
@@ -810,9 +784,21 @@
|
|
|
810
784
|
}
|
|
811
785
|
}
|
|
812
786
|
}
|
|
787
|
+
}
|
|
788
|
+
}
|
|
789
|
+
},
|
|
790
|
+
"delete": {
|
|
791
|
+
"tags": [
|
|
792
|
+
"Knowledge"
|
|
793
|
+
],
|
|
794
|
+
"summary": "Delete a knowledge source",
|
|
795
|
+
"operationId": "deleteKnowledgeSource",
|
|
796
|
+
"responses": {
|
|
797
|
+
"204": {
|
|
798
|
+
"description": "Knowledge source deleted"
|
|
813
799
|
},
|
|
814
|
-
"
|
|
815
|
-
"description": "
|
|
800
|
+
"409": {
|
|
801
|
+
"description": "Knowledge source is referenced by an agent",
|
|
816
802
|
"content": {
|
|
817
803
|
"application/json": {
|
|
818
804
|
"schema": {
|
|
@@ -824,14 +810,14 @@
|
|
|
824
810
|
}
|
|
825
811
|
}
|
|
826
812
|
},
|
|
827
|
-
"/v1/
|
|
813
|
+
"/v1/agents/{agent_id}/execute": {
|
|
828
814
|
"post": {
|
|
829
815
|
"tags": [
|
|
830
816
|
"Agent Execution"
|
|
831
817
|
],
|
|
832
|
-
"summary": "
|
|
833
|
-
"description": "
|
|
834
|
-
"operationId": "
|
|
818
|
+
"summary": "Execute an agent",
|
|
819
|
+
"description": "Executes an agent (system skill or custom agent).\nSupports both:\n- System skill IDs (prefixed): \"skill:email-categorizer\"\n- Custom agent IDs (UUID): \"0336a235-9417-4dd8-894c-fe81285bba75\"\n",
|
|
820
|
+
"operationId": "executeAgent",
|
|
835
821
|
"security": [
|
|
836
822
|
{
|
|
837
823
|
"EpilotAuth": []
|
|
@@ -839,28 +825,37 @@
|
|
|
839
825
|
],
|
|
840
826
|
"parameters": [
|
|
841
827
|
{
|
|
842
|
-
"name": "
|
|
828
|
+
"name": "agent_id",
|
|
843
829
|
"in": "path",
|
|
844
830
|
"required": true,
|
|
845
831
|
"schema": {
|
|
846
|
-
"
|
|
847
|
-
"format": "uuid"
|
|
832
|
+
"$ref": "#/components/schemas/AgentId"
|
|
848
833
|
}
|
|
849
834
|
}
|
|
850
835
|
],
|
|
851
836
|
"requestBody": {
|
|
852
|
-
"required":
|
|
837
|
+
"required": false,
|
|
853
838
|
"content": {
|
|
854
839
|
"application/json": {
|
|
855
840
|
"schema": {
|
|
856
|
-
"$ref": "#/components/schemas/
|
|
841
|
+
"$ref": "#/components/schemas/ExecuteAgentRequest"
|
|
857
842
|
}
|
|
858
843
|
}
|
|
859
844
|
}
|
|
860
845
|
},
|
|
861
846
|
"responses": {
|
|
862
847
|
"200": {
|
|
863
|
-
"description": "
|
|
848
|
+
"description": "Completed execution (`mode: sync`)",
|
|
849
|
+
"content": {
|
|
850
|
+
"application/json": {
|
|
851
|
+
"schema": {
|
|
852
|
+
"$ref": "#/components/schemas/ExecutionResponse"
|
|
853
|
+
}
|
|
854
|
+
}
|
|
855
|
+
}
|
|
856
|
+
},
|
|
857
|
+
"201": {
|
|
858
|
+
"description": "Execution accepted; poll it by `execution_id`",
|
|
864
859
|
"content": {
|
|
865
860
|
"application/json": {
|
|
866
861
|
"schema": {
|
|
@@ -870,7 +865,7 @@
|
|
|
870
865
|
}
|
|
871
866
|
},
|
|
872
867
|
"400": {
|
|
873
|
-
"description": "
|
|
868
|
+
"description": "Error while executing the agent",
|
|
874
869
|
"content": {
|
|
875
870
|
"application/json": {
|
|
876
871
|
"schema": {
|
|
@@ -880,7 +875,7 @@
|
|
|
880
875
|
}
|
|
881
876
|
},
|
|
882
877
|
"404": {
|
|
883
|
-
"description": "
|
|
878
|
+
"description": "Agent not found",
|
|
884
879
|
"content": {
|
|
885
880
|
"application/json": {
|
|
886
881
|
"schema": {
|
|
@@ -888,55 +883,19 @@
|
|
|
888
883
|
}
|
|
889
884
|
}
|
|
890
885
|
}
|
|
891
|
-
}
|
|
892
|
-
}
|
|
893
|
-
}
|
|
894
|
-
},
|
|
895
|
-
"/v1/executions/{execution_id}/stream": {
|
|
896
|
-
"get": {
|
|
897
|
-
"tags": [
|
|
898
|
-
"Agent Execution"
|
|
899
|
-
],
|
|
900
|
-
"summary": "streamExecution",
|
|
901
|
-
"description": "Reconnects to an execution's event stream after approval. Replays missed events from event log and continues streaming if execution is still running.",
|
|
902
|
-
"operationId": "streamExecution",
|
|
903
|
-
"security": [
|
|
904
|
-
{
|
|
905
|
-
"EpilotAuth": []
|
|
906
|
-
}
|
|
907
|
-
],
|
|
908
|
-
"parameters": [
|
|
909
|
-
{
|
|
910
|
-
"name": "execution_id",
|
|
911
|
-
"in": "path",
|
|
912
|
-
"required": true,
|
|
913
|
-
"schema": {
|
|
914
|
-
"type": "string",
|
|
915
|
-
"format": "uuid"
|
|
916
|
-
}
|
|
917
886
|
},
|
|
918
|
-
{
|
|
919
|
-
"
|
|
920
|
-
"in": "query",
|
|
921
|
-
"schema": {
|
|
922
|
-
"type": "integer"
|
|
923
|
-
},
|
|
924
|
-
"description": "Resume from this event sequence number (for reconnection)"
|
|
925
|
-
}
|
|
926
|
-
],
|
|
927
|
-
"responses": {
|
|
928
|
-
"200": {
|
|
929
|
-
"description": "SSE stream of execution events",
|
|
887
|
+
"422": {
|
|
888
|
+
"description": "`mode: sync`: the input exceeds the model's context window (`error: INPUT_TOO_LONG`)",
|
|
930
889
|
"content": {
|
|
931
|
-
"
|
|
890
|
+
"application/json": {
|
|
932
891
|
"schema": {
|
|
933
|
-
"$ref": "#/components/schemas/
|
|
892
|
+
"$ref": "#/components/schemas/Error"
|
|
934
893
|
}
|
|
935
894
|
}
|
|
936
895
|
}
|
|
937
896
|
},
|
|
938
|
-
"
|
|
939
|
-
"description": "
|
|
897
|
+
"504": {
|
|
898
|
+
"description": "`mode: sync`: the model did not answer within the request deadline (`error: TIMEOUT`)",
|
|
940
899
|
"content": {
|
|
941
900
|
"application/json": {
|
|
942
901
|
"schema": {
|
|
@@ -948,32 +907,42 @@
|
|
|
948
907
|
}
|
|
949
908
|
}
|
|
950
909
|
},
|
|
951
|
-
"/v1/
|
|
910
|
+
"/v1/agents/{agent_id}/execute/stream": {
|
|
952
911
|
"post": {
|
|
953
912
|
"tags": [
|
|
954
|
-
"
|
|
913
|
+
"Agent Execution"
|
|
955
914
|
],
|
|
956
|
-
"summary": "
|
|
957
|
-
"description": "
|
|
958
|
-
"operationId": "
|
|
915
|
+
"summary": "Execute an agent with streaming response",
|
|
916
|
+
"description": "Executes an agent with real-time streaming of tokens and tool events.\nReturns Server-Sent Events (SSE) stream with token-by-token output,\ntool call progress, and completion status.\n\nUnlike the async `/execute` endpoint which returns immediately with\nan execution_id for polling, this endpoint streams all events in real-time.\n\nSupports both:\n- System skill IDs (prefixed): \"skill:email-categorizer\"\n- Custom agent IDs (UUID): \"0336a235-9417-4dd8-894c-fe81285bba75\"\n",
|
|
917
|
+
"operationId": "executeAgentStream",
|
|
959
918
|
"security": [
|
|
960
919
|
{
|
|
961
920
|
"EpilotAuth": []
|
|
962
921
|
}
|
|
963
922
|
],
|
|
923
|
+
"parameters": [
|
|
924
|
+
{
|
|
925
|
+
"name": "agent_id",
|
|
926
|
+
"in": "path",
|
|
927
|
+
"required": true,
|
|
928
|
+
"schema": {
|
|
929
|
+
"$ref": "#/components/schemas/AgentId"
|
|
930
|
+
}
|
|
931
|
+
}
|
|
932
|
+
],
|
|
964
933
|
"requestBody": {
|
|
965
|
-
"required":
|
|
934
|
+
"required": false,
|
|
966
935
|
"content": {
|
|
967
936
|
"application/json": {
|
|
968
937
|
"schema": {
|
|
969
|
-
"$ref": "#/components/schemas/
|
|
938
|
+
"$ref": "#/components/schemas/ExecuteAgentRequest"
|
|
970
939
|
}
|
|
971
940
|
}
|
|
972
941
|
}
|
|
973
942
|
},
|
|
974
943
|
"responses": {
|
|
975
944
|
"200": {
|
|
976
|
-
"description": "SSE stream of
|
|
945
|
+
"description": "SSE stream of execution events",
|
|
977
946
|
"content": {
|
|
978
947
|
"text/event-stream": {
|
|
979
948
|
"schema": {
|
|
@@ -983,7 +952,7 @@
|
|
|
983
952
|
}
|
|
984
953
|
},
|
|
985
954
|
"400": {
|
|
986
|
-
"description": "
|
|
955
|
+
"description": "Error while executing the agent",
|
|
987
956
|
"content": {
|
|
988
957
|
"application/json": {
|
|
989
958
|
"schema": {
|
|
@@ -1005,14 +974,14 @@
|
|
|
1005
974
|
}
|
|
1006
975
|
}
|
|
1007
976
|
},
|
|
1008
|
-
"/v1/
|
|
977
|
+
"/v1/executions": {
|
|
1009
978
|
"get": {
|
|
1010
979
|
"tags": [
|
|
1011
|
-
"
|
|
980
|
+
"Agent Execution"
|
|
1012
981
|
],
|
|
1013
|
-
"summary": "
|
|
1014
|
-
"description": "
|
|
1015
|
-
"operationId": "
|
|
982
|
+
"summary": "List executions",
|
|
983
|
+
"description": "List executions",
|
|
984
|
+
"operationId": "listExecutions",
|
|
1016
985
|
"security": [
|
|
1017
986
|
{
|
|
1018
987
|
"EpilotAuth": []
|
|
@@ -1028,36 +997,36 @@
|
|
|
1028
997
|
"description": "Filter by agent ID"
|
|
1029
998
|
},
|
|
1030
999
|
{
|
|
1031
|
-
"name": "
|
|
1000
|
+
"name": "status",
|
|
1032
1001
|
"in": "query",
|
|
1033
1002
|
"schema": {
|
|
1034
|
-
"
|
|
1035
|
-
"default": 20
|
|
1003
|
+
"$ref": "#/components/schemas/ExecutionStatus"
|
|
1036
1004
|
},
|
|
1037
|
-
"description": "
|
|
1005
|
+
"description": "Filter by status"
|
|
1038
1006
|
},
|
|
1039
1007
|
{
|
|
1040
|
-
"name": "
|
|
1008
|
+
"name": "limit",
|
|
1041
1009
|
"in": "query",
|
|
1042
1010
|
"schema": {
|
|
1043
|
-
"type": "
|
|
1011
|
+
"type": "integer",
|
|
1012
|
+
"default": 50
|
|
1044
1013
|
},
|
|
1045
|
-
"description": "
|
|
1014
|
+
"description": "Maximum number of executions to return"
|
|
1046
1015
|
}
|
|
1047
1016
|
],
|
|
1048
1017
|
"responses": {
|
|
1049
1018
|
"200": {
|
|
1050
|
-
"description": "List of
|
|
1019
|
+
"description": "List of executions",
|
|
1051
1020
|
"content": {
|
|
1052
1021
|
"application/json": {
|
|
1053
1022
|
"schema": {
|
|
1054
|
-
"$ref": "#/components/schemas/
|
|
1023
|
+
"$ref": "#/components/schemas/ListExecutionsResponse"
|
|
1055
1024
|
}
|
|
1056
1025
|
}
|
|
1057
1026
|
}
|
|
1058
1027
|
},
|
|
1059
1028
|
"400": {
|
|
1060
|
-
"description": "Error fetching
|
|
1029
|
+
"description": "Error fetching executions",
|
|
1061
1030
|
"content": {
|
|
1062
1031
|
"application/json": {
|
|
1063
1032
|
"schema": {
|
|
@@ -1069,14 +1038,14 @@
|
|
|
1069
1038
|
}
|
|
1070
1039
|
}
|
|
1071
1040
|
},
|
|
1072
|
-
"/v1/
|
|
1041
|
+
"/v1/executions/{execution_id}": {
|
|
1073
1042
|
"get": {
|
|
1074
1043
|
"tags": [
|
|
1075
|
-
"
|
|
1044
|
+
"Agent Execution"
|
|
1076
1045
|
],
|
|
1077
|
-
"summary": "
|
|
1078
|
-
"description": "
|
|
1079
|
-
"operationId": "
|
|
1046
|
+
"summary": "Get execution by ID",
|
|
1047
|
+
"description": "Get execution by ID",
|
|
1048
|
+
"operationId": "getExecution",
|
|
1080
1049
|
"security": [
|
|
1081
1050
|
{
|
|
1082
1051
|
"EpilotAuth": []
|
|
@@ -1084,37 +1053,180 @@
|
|
|
1084
1053
|
],
|
|
1085
1054
|
"parameters": [
|
|
1086
1055
|
{
|
|
1087
|
-
"name": "
|
|
1056
|
+
"name": "execution_id",
|
|
1088
1057
|
"in": "path",
|
|
1089
1058
|
"required": true,
|
|
1090
1059
|
"schema": {
|
|
1091
1060
|
"type": "string",
|
|
1092
1061
|
"format": "uuid"
|
|
1093
1062
|
}
|
|
1063
|
+
}
|
|
1064
|
+
],
|
|
1065
|
+
"responses": {
|
|
1066
|
+
"200": {
|
|
1067
|
+
"description": "Execution details",
|
|
1068
|
+
"content": {
|
|
1069
|
+
"application/json": {
|
|
1070
|
+
"schema": {
|
|
1071
|
+
"$ref": "#/components/schemas/ExecutionResponse"
|
|
1072
|
+
}
|
|
1073
|
+
}
|
|
1074
|
+
}
|
|
1094
1075
|
},
|
|
1076
|
+
"404": {
|
|
1077
|
+
"description": "Execution not found",
|
|
1078
|
+
"content": {
|
|
1079
|
+
"application/json": {
|
|
1080
|
+
"schema": {
|
|
1081
|
+
"$ref": "#/components/schemas/Error"
|
|
1082
|
+
}
|
|
1083
|
+
}
|
|
1084
|
+
}
|
|
1085
|
+
}
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1088
|
+
"delete": {
|
|
1089
|
+
"tags": [
|
|
1090
|
+
"Agent Execution"
|
|
1091
|
+
],
|
|
1092
|
+
"summary": "Cancel execution",
|
|
1093
|
+
"description": "Cancel execution",
|
|
1094
|
+
"operationId": "cancelExecution",
|
|
1095
|
+
"security": [
|
|
1095
1096
|
{
|
|
1096
|
-
"
|
|
1097
|
-
|
|
1097
|
+
"EpilotAuth": []
|
|
1098
|
+
}
|
|
1099
|
+
],
|
|
1100
|
+
"parameters": [
|
|
1101
|
+
{
|
|
1102
|
+
"name": "execution_id",
|
|
1103
|
+
"in": "path",
|
|
1104
|
+
"required": true,
|
|
1098
1105
|
"schema": {
|
|
1099
|
-
"type": "
|
|
1100
|
-
"
|
|
1101
|
-
}
|
|
1102
|
-
"description": "Maximum number of messages to return"
|
|
1106
|
+
"type": "string",
|
|
1107
|
+
"format": "uuid"
|
|
1108
|
+
}
|
|
1103
1109
|
}
|
|
1104
1110
|
],
|
|
1105
1111
|
"responses": {
|
|
1106
1112
|
"200": {
|
|
1107
|
-
"description": "
|
|
1113
|
+
"description": "Execution cancelled",
|
|
1108
1114
|
"content": {
|
|
1109
1115
|
"application/json": {
|
|
1110
1116
|
"schema": {
|
|
1111
|
-
"$ref": "#/components/schemas/
|
|
1117
|
+
"$ref": "#/components/schemas/ExecutionResponse"
|
|
1118
|
+
}
|
|
1119
|
+
}
|
|
1120
|
+
}
|
|
1121
|
+
},
|
|
1122
|
+
"400": {
|
|
1123
|
+
"description": "Cannot cancel execution (already completed or failed)",
|
|
1124
|
+
"content": {
|
|
1125
|
+
"application/json": {
|
|
1126
|
+
"schema": {
|
|
1127
|
+
"$ref": "#/components/schemas/Error"
|
|
1112
1128
|
}
|
|
1113
1129
|
}
|
|
1114
1130
|
}
|
|
1115
1131
|
},
|
|
1116
1132
|
"404": {
|
|
1117
|
-
"description": "
|
|
1133
|
+
"description": "Execution not found",
|
|
1134
|
+
"content": {
|
|
1135
|
+
"application/json": {
|
|
1136
|
+
"schema": {
|
|
1137
|
+
"$ref": "#/components/schemas/Error"
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
}
|
|
1143
|
+
}
|
|
1144
|
+
},
|
|
1145
|
+
"/v1/executions/{execution_id}/trace": {
|
|
1146
|
+
"get": {
|
|
1147
|
+
"tags": [
|
|
1148
|
+
"Agent Execution"
|
|
1149
|
+
],
|
|
1150
|
+
"summary": "Get execution trace/iterations",
|
|
1151
|
+
"description": "Returns the step-by-step reasoning and tool calls for ReAct mode executions. Returns empty iterations array for direct mode executions.",
|
|
1152
|
+
"operationId": "getExecutionTrace",
|
|
1153
|
+
"security": [
|
|
1154
|
+
{
|
|
1155
|
+
"EpilotAuth": []
|
|
1156
|
+
}
|
|
1157
|
+
],
|
|
1158
|
+
"parameters": [
|
|
1159
|
+
{
|
|
1160
|
+
"name": "execution_id",
|
|
1161
|
+
"in": "path",
|
|
1162
|
+
"required": true,
|
|
1163
|
+
"schema": {
|
|
1164
|
+
"type": "string",
|
|
1165
|
+
"format": "uuid"
|
|
1166
|
+
}
|
|
1167
|
+
}
|
|
1168
|
+
],
|
|
1169
|
+
"responses": {
|
|
1170
|
+
"200": {
|
|
1171
|
+
"description": "Execution trace",
|
|
1172
|
+
"content": {
|
|
1173
|
+
"application/json": {
|
|
1174
|
+
"schema": {
|
|
1175
|
+
"$ref": "#/components/schemas/ExecutionTrace"
|
|
1176
|
+
}
|
|
1177
|
+
}
|
|
1178
|
+
}
|
|
1179
|
+
},
|
|
1180
|
+
"404": {
|
|
1181
|
+
"description": "Execution not found",
|
|
1182
|
+
"content": {
|
|
1183
|
+
"application/json": {
|
|
1184
|
+
"schema": {
|
|
1185
|
+
"$ref": "#/components/schemas/Error"
|
|
1186
|
+
}
|
|
1187
|
+
}
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
}
|
|
1192
|
+
},
|
|
1193
|
+
"/v1/executions/{execution_id}/feedback": {
|
|
1194
|
+
"get": {
|
|
1195
|
+
"tags": [
|
|
1196
|
+
"Agent Execution"
|
|
1197
|
+
],
|
|
1198
|
+
"summary": "Get execution feedback",
|
|
1199
|
+
"description": "Returns the authenticated user's feedback for an execution.",
|
|
1200
|
+
"operationId": "getExecutionFeedback",
|
|
1201
|
+
"security": [
|
|
1202
|
+
{
|
|
1203
|
+
"EpilotAuth": []
|
|
1204
|
+
}
|
|
1205
|
+
],
|
|
1206
|
+
"parameters": [
|
|
1207
|
+
{
|
|
1208
|
+
"name": "execution_id",
|
|
1209
|
+
"in": "path",
|
|
1210
|
+
"required": true,
|
|
1211
|
+
"schema": {
|
|
1212
|
+
"type": "string",
|
|
1213
|
+
"format": "uuid"
|
|
1214
|
+
}
|
|
1215
|
+
}
|
|
1216
|
+
],
|
|
1217
|
+
"responses": {
|
|
1218
|
+
"200": {
|
|
1219
|
+
"description": "Feedback state",
|
|
1220
|
+
"content": {
|
|
1221
|
+
"application/json": {
|
|
1222
|
+
"schema": {
|
|
1223
|
+
"$ref": "#/components/schemas/ExecutionFeedbackResponse"
|
|
1224
|
+
}
|
|
1225
|
+
}
|
|
1226
|
+
}
|
|
1227
|
+
},
|
|
1228
|
+
"404": {
|
|
1229
|
+
"description": "Execution not found",
|
|
1118
1230
|
"content": {
|
|
1119
1231
|
"application/json": {
|
|
1120
1232
|
"schema": {
|
|
@@ -1125,13 +1237,13 @@
|
|
|
1125
1237
|
}
|
|
1126
1238
|
}
|
|
1127
1239
|
},
|
|
1128
|
-
"
|
|
1240
|
+
"put": {
|
|
1129
1241
|
"tags": [
|
|
1130
|
-
"
|
|
1242
|
+
"Agent Execution"
|
|
1131
1243
|
],
|
|
1132
|
-
"summary": "
|
|
1133
|
-
"description": "
|
|
1134
|
-
"operationId": "
|
|
1244
|
+
"summary": "Submit execution feedback",
|
|
1245
|
+
"description": "Upserts thumbs up/down feedback and mirrors it to the execution's Langfuse trace.",
|
|
1246
|
+
"operationId": "putExecutionFeedback",
|
|
1135
1247
|
"security": [
|
|
1136
1248
|
{
|
|
1137
1249
|
"EpilotAuth": []
|
|
@@ -1139,7 +1251,85 @@
|
|
|
1139
1251
|
],
|
|
1140
1252
|
"parameters": [
|
|
1141
1253
|
{
|
|
1142
|
-
"name": "
|
|
1254
|
+
"name": "execution_id",
|
|
1255
|
+
"in": "path",
|
|
1256
|
+
"required": true,
|
|
1257
|
+
"schema": {
|
|
1258
|
+
"type": "string",
|
|
1259
|
+
"format": "uuid"
|
|
1260
|
+
}
|
|
1261
|
+
}
|
|
1262
|
+
],
|
|
1263
|
+
"requestBody": {
|
|
1264
|
+
"required": true,
|
|
1265
|
+
"content": {
|
|
1266
|
+
"application/json": {
|
|
1267
|
+
"schema": {
|
|
1268
|
+
"$ref": "#/components/schemas/PutExecutionFeedbackRequest"
|
|
1269
|
+
}
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
},
|
|
1273
|
+
"responses": {
|
|
1274
|
+
"200": {
|
|
1275
|
+
"description": "Feedback recorded",
|
|
1276
|
+
"content": {
|
|
1277
|
+
"application/json": {
|
|
1278
|
+
"schema": {
|
|
1279
|
+
"$ref": "#/components/schemas/ExecutionFeedbackResponse"
|
|
1280
|
+
}
|
|
1281
|
+
}
|
|
1282
|
+
}
|
|
1283
|
+
},
|
|
1284
|
+
"400": {
|
|
1285
|
+
"description": "Invalid feedback",
|
|
1286
|
+
"content": {
|
|
1287
|
+
"application/json": {
|
|
1288
|
+
"schema": {
|
|
1289
|
+
"$ref": "#/components/schemas/Error"
|
|
1290
|
+
}
|
|
1291
|
+
}
|
|
1292
|
+
}
|
|
1293
|
+
},
|
|
1294
|
+
"404": {
|
|
1295
|
+
"description": "Execution not found",
|
|
1296
|
+
"content": {
|
|
1297
|
+
"application/json": {
|
|
1298
|
+
"schema": {
|
|
1299
|
+
"$ref": "#/components/schemas/Error"
|
|
1300
|
+
}
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
"409": {
|
|
1305
|
+
"description": "Execution cannot be rated",
|
|
1306
|
+
"content": {
|
|
1307
|
+
"application/json": {
|
|
1308
|
+
"schema": {
|
|
1309
|
+
"$ref": "#/components/schemas/Error"
|
|
1310
|
+
}
|
|
1311
|
+
}
|
|
1312
|
+
}
|
|
1313
|
+
}
|
|
1314
|
+
}
|
|
1315
|
+
}
|
|
1316
|
+
},
|
|
1317
|
+
"/v1/executions/{execution_id}/approve": {
|
|
1318
|
+
"post": {
|
|
1319
|
+
"tags": [
|
|
1320
|
+
"Agent Execution"
|
|
1321
|
+
],
|
|
1322
|
+
"summary": "Approve pending action",
|
|
1323
|
+
"description": "Approves a pending tool action when execution is in waiting_approval status",
|
|
1324
|
+
"operationId": "approveExecution",
|
|
1325
|
+
"security": [
|
|
1326
|
+
{
|
|
1327
|
+
"EpilotAuth": []
|
|
1328
|
+
}
|
|
1329
|
+
],
|
|
1330
|
+
"parameters": [
|
|
1331
|
+
{
|
|
1332
|
+
"name": "execution_id",
|
|
1143
1333
|
"in": "path",
|
|
1144
1334
|
"required": true,
|
|
1145
1335
|
"schema": {
|
|
@@ -1148,111 +1338,1171 @@
|
|
|
1148
1338
|
}
|
|
1149
1339
|
}
|
|
1150
1340
|
],
|
|
1151
|
-
"
|
|
1152
|
-
"
|
|
1153
|
-
"
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
|
|
1341
|
+
"requestBody": {
|
|
1342
|
+
"content": {
|
|
1343
|
+
"application/json": {
|
|
1344
|
+
"schema": {
|
|
1345
|
+
"$ref": "#/components/schemas/ApproveExecutionRequest"
|
|
1346
|
+
}
|
|
1347
|
+
}
|
|
1348
|
+
}
|
|
1349
|
+
},
|
|
1350
|
+
"responses": {
|
|
1351
|
+
"200": {
|
|
1352
|
+
"description": "Action approved",
|
|
1353
|
+
"content": {
|
|
1354
|
+
"application/json": {
|
|
1355
|
+
"schema": {
|
|
1356
|
+
"$ref": "#/components/schemas/ExecutionResponse"
|
|
1357
|
+
}
|
|
1358
|
+
}
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
"400": {
|
|
1362
|
+
"description": "No pending action to approve",
|
|
1363
|
+
"content": {
|
|
1364
|
+
"application/json": {
|
|
1365
|
+
"schema": {
|
|
1366
|
+
"$ref": "#/components/schemas/Error"
|
|
1367
|
+
}
|
|
1368
|
+
}
|
|
1369
|
+
}
|
|
1370
|
+
},
|
|
1371
|
+
"404": {
|
|
1372
|
+
"description": "Execution not found",
|
|
1373
|
+
"content": {
|
|
1374
|
+
"application/json": {
|
|
1375
|
+
"schema": {
|
|
1376
|
+
"$ref": "#/components/schemas/Error"
|
|
1377
|
+
}
|
|
1378
|
+
}
|
|
1379
|
+
}
|
|
1380
|
+
}
|
|
1381
|
+
}
|
|
1382
|
+
}
|
|
1383
|
+
},
|
|
1384
|
+
"/v1/executions/{execution_id}/reject": {
|
|
1385
|
+
"post": {
|
|
1386
|
+
"tags": [
|
|
1387
|
+
"Agent Execution"
|
|
1388
|
+
],
|
|
1389
|
+
"summary": "Reject pending action",
|
|
1390
|
+
"description": "Rejects a pending tool action when execution is in waiting_approval status",
|
|
1391
|
+
"operationId": "rejectExecution",
|
|
1392
|
+
"security": [
|
|
1393
|
+
{
|
|
1394
|
+
"EpilotAuth": []
|
|
1395
|
+
}
|
|
1396
|
+
],
|
|
1397
|
+
"parameters": [
|
|
1398
|
+
{
|
|
1399
|
+
"name": "execution_id",
|
|
1400
|
+
"in": "path",
|
|
1401
|
+
"required": true,
|
|
1402
|
+
"schema": {
|
|
1403
|
+
"type": "string",
|
|
1404
|
+
"format": "uuid"
|
|
1405
|
+
}
|
|
1406
|
+
}
|
|
1407
|
+
],
|
|
1408
|
+
"requestBody": {
|
|
1409
|
+
"required": true,
|
|
1410
|
+
"content": {
|
|
1411
|
+
"application/json": {
|
|
1412
|
+
"schema": {
|
|
1413
|
+
"$ref": "#/components/schemas/RejectExecutionRequest"
|
|
1414
|
+
}
|
|
1415
|
+
}
|
|
1416
|
+
}
|
|
1417
|
+
},
|
|
1418
|
+
"responses": {
|
|
1419
|
+
"200": {
|
|
1420
|
+
"description": "Action rejected",
|
|
1421
|
+
"content": {
|
|
1422
|
+
"application/json": {
|
|
1423
|
+
"schema": {
|
|
1424
|
+
"$ref": "#/components/schemas/ExecutionResponse"
|
|
1425
|
+
}
|
|
1426
|
+
}
|
|
1427
|
+
}
|
|
1428
|
+
},
|
|
1429
|
+
"400": {
|
|
1430
|
+
"description": "No pending action to reject",
|
|
1431
|
+
"content": {
|
|
1432
|
+
"application/json": {
|
|
1433
|
+
"schema": {
|
|
1434
|
+
"$ref": "#/components/schemas/Error"
|
|
1435
|
+
}
|
|
1436
|
+
}
|
|
1437
|
+
}
|
|
1438
|
+
},
|
|
1439
|
+
"404": {
|
|
1440
|
+
"description": "Execution not found",
|
|
1441
|
+
"content": {
|
|
1442
|
+
"application/json": {
|
|
1443
|
+
"schema": {
|
|
1444
|
+
"$ref": "#/components/schemas/Error"
|
|
1445
|
+
}
|
|
1446
|
+
}
|
|
1447
|
+
}
|
|
1448
|
+
}
|
|
1449
|
+
}
|
|
1450
|
+
}
|
|
1451
|
+
},
|
|
1452
|
+
"/v1/executions/{execution_id}/stream": {
|
|
1453
|
+
"get": {
|
|
1454
|
+
"tags": [
|
|
1455
|
+
"Agent Execution"
|
|
1456
|
+
],
|
|
1457
|
+
"summary": "Reconnect to execution stream",
|
|
1458
|
+
"description": "Reconnects to an execution's event stream after approval. Replays missed events from event log and continues streaming if execution is still running.",
|
|
1459
|
+
"operationId": "streamExecution",
|
|
1460
|
+
"security": [
|
|
1461
|
+
{
|
|
1462
|
+
"EpilotAuth": []
|
|
1463
|
+
}
|
|
1464
|
+
],
|
|
1465
|
+
"parameters": [
|
|
1466
|
+
{
|
|
1467
|
+
"name": "execution_id",
|
|
1468
|
+
"in": "path",
|
|
1469
|
+
"required": true,
|
|
1470
|
+
"schema": {
|
|
1471
|
+
"type": "string",
|
|
1472
|
+
"format": "uuid"
|
|
1473
|
+
}
|
|
1474
|
+
},
|
|
1475
|
+
{
|
|
1476
|
+
"name": "from_sequence",
|
|
1477
|
+
"in": "query",
|
|
1478
|
+
"schema": {
|
|
1479
|
+
"type": "integer"
|
|
1480
|
+
},
|
|
1481
|
+
"description": "Resume from this event sequence number (for reconnection)"
|
|
1482
|
+
}
|
|
1483
|
+
],
|
|
1484
|
+
"responses": {
|
|
1485
|
+
"200": {
|
|
1486
|
+
"description": "SSE stream of execution events",
|
|
1487
|
+
"content": {
|
|
1488
|
+
"text/event-stream": {
|
|
1489
|
+
"schema": {
|
|
1490
|
+
"$ref": "#/components/schemas/StreamEvent"
|
|
1491
|
+
}
|
|
1492
|
+
}
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"404": {
|
|
1496
|
+
"description": "Execution not found",
|
|
1497
|
+
"content": {
|
|
1498
|
+
"application/json": {
|
|
1499
|
+
"schema": {
|
|
1500
|
+
"$ref": "#/components/schemas/Error"
|
|
1501
|
+
}
|
|
1502
|
+
}
|
|
1503
|
+
}
|
|
1504
|
+
}
|
|
1505
|
+
}
|
|
1506
|
+
}
|
|
1507
|
+
},
|
|
1508
|
+
"/v1/chat": {
|
|
1509
|
+
"post": {
|
|
1510
|
+
"tags": [
|
|
1511
|
+
"Chat"
|
|
1512
|
+
],
|
|
1513
|
+
"summary": "Streaming chat with AI agent",
|
|
1514
|
+
"description": "Initiates a streaming chat session with an AI agent. Supports server-side conversation memory via conversationId or client-provided history via clientHistory.",
|
|
1515
|
+
"operationId": "chat",
|
|
1516
|
+
"security": [
|
|
1517
|
+
{
|
|
1518
|
+
"EpilotAuth": []
|
|
1519
|
+
}
|
|
1520
|
+
],
|
|
1521
|
+
"requestBody": {
|
|
1522
|
+
"required": true,
|
|
1523
|
+
"content": {
|
|
1524
|
+
"application/json": {
|
|
1525
|
+
"schema": {
|
|
1526
|
+
"$ref": "#/components/schemas/ChatRequest"
|
|
1527
|
+
}
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
},
|
|
1531
|
+
"responses": {
|
|
1532
|
+
"200": {
|
|
1533
|
+
"description": "SSE stream of chat events",
|
|
1534
|
+
"content": {
|
|
1535
|
+
"text/event-stream": {
|
|
1536
|
+
"schema": {
|
|
1537
|
+
"$ref": "#/components/schemas/StreamEvent"
|
|
1538
|
+
}
|
|
1539
|
+
}
|
|
1540
|
+
}
|
|
1541
|
+
},
|
|
1542
|
+
"400": {
|
|
1543
|
+
"description": "Invalid request",
|
|
1544
|
+
"content": {
|
|
1545
|
+
"application/json": {
|
|
1546
|
+
"schema": {
|
|
1547
|
+
"$ref": "#/components/schemas/Error"
|
|
1548
|
+
}
|
|
1549
|
+
}
|
|
1550
|
+
}
|
|
1551
|
+
},
|
|
1552
|
+
"404": {
|
|
1553
|
+
"description": "Agent not found",
|
|
1554
|
+
"content": {
|
|
1555
|
+
"application/json": {
|
|
1556
|
+
"schema": {
|
|
1557
|
+
"$ref": "#/components/schemas/Error"
|
|
1558
|
+
}
|
|
1559
|
+
}
|
|
1560
|
+
}
|
|
1561
|
+
}
|
|
1562
|
+
}
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
"/v1/conversations": {
|
|
1566
|
+
"get": {
|
|
1567
|
+
"tags": [
|
|
1568
|
+
"Conversations"
|
|
1569
|
+
],
|
|
1570
|
+
"summary": "List conversations",
|
|
1571
|
+
"description": "Lists conversations for the authenticated user, sorted by most recent.",
|
|
1572
|
+
"operationId": "listConversations",
|
|
1573
|
+
"security": [
|
|
1574
|
+
{
|
|
1575
|
+
"EpilotAuth": []
|
|
1576
|
+
}
|
|
1577
|
+
],
|
|
1578
|
+
"parameters": [
|
|
1579
|
+
{
|
|
1580
|
+
"name": "agent_id",
|
|
1581
|
+
"in": "query",
|
|
1582
|
+
"schema": {
|
|
1583
|
+
"type": "string"
|
|
1584
|
+
},
|
|
1585
|
+
"description": "Filter by agent ID"
|
|
1586
|
+
},
|
|
1587
|
+
{
|
|
1588
|
+
"name": "limit",
|
|
1589
|
+
"in": "query",
|
|
1590
|
+
"schema": {
|
|
1591
|
+
"type": "integer",
|
|
1592
|
+
"default": 20
|
|
1593
|
+
},
|
|
1594
|
+
"description": "Maximum number of conversations to return"
|
|
1595
|
+
},
|
|
1596
|
+
{
|
|
1597
|
+
"name": "cursor",
|
|
1598
|
+
"in": "query",
|
|
1599
|
+
"schema": {
|
|
1600
|
+
"type": "string"
|
|
1601
|
+
},
|
|
1602
|
+
"description": "Pagination cursor"
|
|
1603
|
+
}
|
|
1604
|
+
],
|
|
1605
|
+
"responses": {
|
|
1606
|
+
"200": {
|
|
1607
|
+
"description": "List of conversations",
|
|
1608
|
+
"content": {
|
|
1609
|
+
"application/json": {
|
|
1610
|
+
"schema": {
|
|
1611
|
+
"$ref": "#/components/schemas/ListConversationsResponse"
|
|
1612
|
+
}
|
|
1613
|
+
}
|
|
1614
|
+
}
|
|
1615
|
+
},
|
|
1616
|
+
"400": {
|
|
1617
|
+
"description": "Error fetching conversations",
|
|
1618
|
+
"content": {
|
|
1619
|
+
"application/json": {
|
|
1620
|
+
"schema": {
|
|
1621
|
+
"$ref": "#/components/schemas/Error"
|
|
1622
|
+
}
|
|
1623
|
+
}
|
|
1624
|
+
}
|
|
1625
|
+
}
|
|
1626
|
+
}
|
|
1627
|
+
}
|
|
1628
|
+
},
|
|
1629
|
+
"/v1/conversations/{conversation_id}": {
|
|
1630
|
+
"get": {
|
|
1631
|
+
"tags": [
|
|
1632
|
+
"Conversations"
|
|
1633
|
+
],
|
|
1634
|
+
"summary": "Get conversation with messages",
|
|
1635
|
+
"description": "Retrieves a conversation and its message history.",
|
|
1636
|
+
"operationId": "getConversation",
|
|
1637
|
+
"security": [
|
|
1638
|
+
{
|
|
1639
|
+
"EpilotAuth": []
|
|
1640
|
+
}
|
|
1641
|
+
],
|
|
1642
|
+
"parameters": [
|
|
1643
|
+
{
|
|
1644
|
+
"name": "conversation_id",
|
|
1645
|
+
"in": "path",
|
|
1646
|
+
"required": true,
|
|
1647
|
+
"schema": {
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"format": "uuid"
|
|
1650
|
+
}
|
|
1651
|
+
},
|
|
1652
|
+
{
|
|
1653
|
+
"name": "message_limit",
|
|
1654
|
+
"in": "query",
|
|
1655
|
+
"schema": {
|
|
1656
|
+
"type": "integer",
|
|
1657
|
+
"default": 100
|
|
1658
|
+
},
|
|
1659
|
+
"description": "Maximum number of messages to return"
|
|
1660
|
+
}
|
|
1661
|
+
],
|
|
1662
|
+
"responses": {
|
|
1663
|
+
"200": {
|
|
1664
|
+
"description": "Conversation with messages",
|
|
1665
|
+
"content": {
|
|
1666
|
+
"application/json": {
|
|
1667
|
+
"schema": {
|
|
1668
|
+
"$ref": "#/components/schemas/ConversationWithMessages"
|
|
1669
|
+
}
|
|
1670
|
+
}
|
|
1671
|
+
}
|
|
1672
|
+
},
|
|
1673
|
+
"404": {
|
|
1674
|
+
"description": "Conversation not found",
|
|
1675
|
+
"content": {
|
|
1676
|
+
"application/json": {
|
|
1677
|
+
"schema": {
|
|
1678
|
+
"$ref": "#/components/schemas/Error"
|
|
1679
|
+
}
|
|
1680
|
+
}
|
|
1681
|
+
}
|
|
1682
|
+
}
|
|
1683
|
+
}
|
|
1684
|
+
},
|
|
1685
|
+
"delete": {
|
|
1686
|
+
"tags": [
|
|
1687
|
+
"Conversations"
|
|
1688
|
+
],
|
|
1689
|
+
"summary": "Delete conversation",
|
|
1690
|
+
"description": "Deletes a conversation and all its messages.",
|
|
1691
|
+
"operationId": "deleteConversation",
|
|
1692
|
+
"security": [
|
|
1693
|
+
{
|
|
1694
|
+
"EpilotAuth": []
|
|
1695
|
+
}
|
|
1696
|
+
],
|
|
1697
|
+
"parameters": [
|
|
1698
|
+
{
|
|
1699
|
+
"name": "conversation_id",
|
|
1700
|
+
"in": "path",
|
|
1701
|
+
"required": true,
|
|
1702
|
+
"schema": {
|
|
1703
|
+
"type": "string",
|
|
1704
|
+
"format": "uuid"
|
|
1705
|
+
}
|
|
1706
|
+
}
|
|
1707
|
+
],
|
|
1708
|
+
"responses": {
|
|
1709
|
+
"204": {
|
|
1710
|
+
"description": "Conversation deleted"
|
|
1711
|
+
},
|
|
1712
|
+
"404": {
|
|
1713
|
+
"description": "Conversation not found",
|
|
1714
|
+
"content": {
|
|
1715
|
+
"application/json": {
|
|
1716
|
+
"schema": {
|
|
1717
|
+
"$ref": "#/components/schemas/Error"
|
|
1718
|
+
}
|
|
1719
|
+
}
|
|
1720
|
+
}
|
|
1721
|
+
}
|
|
1722
|
+
}
|
|
1723
|
+
}
|
|
1724
|
+
},
|
|
1725
|
+
"/v1/conversations/{conversation_id}/feedback": {
|
|
1726
|
+
"post": {
|
|
1727
|
+
"tags": [
|
|
1728
|
+
"Conversations"
|
|
1729
|
+
],
|
|
1730
|
+
"summary": "Submit feedback for an assistant turn",
|
|
1731
|
+
"description": "Records a thumbs up/down (with optional comment) for the assistant turn identified by its Langfuse trace id. The rating is persisted on the message and mirrored to Langfuse as a trace score.\n",
|
|
1732
|
+
"operationId": "submitConversationFeedback",
|
|
1733
|
+
"security": [
|
|
1734
|
+
{
|
|
1735
|
+
"EpilotAuth": []
|
|
1736
|
+
}
|
|
1737
|
+
],
|
|
1738
|
+
"parameters": [
|
|
1739
|
+
{
|
|
1740
|
+
"name": "conversation_id",
|
|
1741
|
+
"in": "path",
|
|
1742
|
+
"required": true,
|
|
1743
|
+
"schema": {
|
|
1744
|
+
"type": "string",
|
|
1745
|
+
"format": "uuid"
|
|
1746
|
+
}
|
|
1747
|
+
}
|
|
1748
|
+
],
|
|
1749
|
+
"requestBody": {
|
|
1750
|
+
"required": true,
|
|
1751
|
+
"content": {
|
|
1752
|
+
"application/json": {
|
|
1753
|
+
"schema": {
|
|
1754
|
+
"$ref": "#/components/schemas/SubmitFeedbackRequest"
|
|
1755
|
+
}
|
|
1756
|
+
}
|
|
1757
|
+
}
|
|
1758
|
+
},
|
|
1759
|
+
"responses": {
|
|
1760
|
+
"200": {
|
|
1761
|
+
"description": "Feedback recorded",
|
|
1762
|
+
"content": {
|
|
1763
|
+
"application/json": {
|
|
1764
|
+
"schema": {
|
|
1765
|
+
"type": "object",
|
|
1766
|
+
"properties": {
|
|
1767
|
+
"feedback": {
|
|
1768
|
+
"$ref": "#/components/schemas/MessageFeedback"
|
|
1769
|
+
}
|
|
1770
|
+
}
|
|
1771
|
+
}
|
|
1772
|
+
}
|
|
1773
|
+
}
|
|
1774
|
+
},
|
|
1775
|
+
"400": {
|
|
1776
|
+
"description": "Invalid request",
|
|
1777
|
+
"content": {
|
|
1778
|
+
"application/json": {
|
|
1779
|
+
"schema": {
|
|
1780
|
+
"$ref": "#/components/schemas/Error"
|
|
1781
|
+
}
|
|
1782
|
+
}
|
|
1783
|
+
}
|
|
1784
|
+
},
|
|
1785
|
+
"404": {
|
|
1786
|
+
"description": "Conversation or message not found",
|
|
1787
|
+
"content": {
|
|
1788
|
+
"application/json": {
|
|
1789
|
+
"schema": {
|
|
1790
|
+
"$ref": "#/components/schemas/Error"
|
|
1791
|
+
}
|
|
1792
|
+
}
|
|
1793
|
+
}
|
|
1794
|
+
}
|
|
1795
|
+
}
|
|
1796
|
+
}
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
"components": {
|
|
1800
|
+
"securitySchemes": {
|
|
1801
|
+
"EpilotAuth": {
|
|
1802
|
+
"type": "http",
|
|
1803
|
+
"scheme": "bearer",
|
|
1804
|
+
"description": "Authorization header with epilot OAuth2 bearer token. Supports RFC8725 for JWT validation.",
|
|
1805
|
+
"bearerFormat": "JWT"
|
|
1806
|
+
}
|
|
1807
|
+
},
|
|
1808
|
+
"parameters": {
|
|
1809
|
+
"CustomerChatAgentIdPath": {
|
|
1810
|
+
"name": "agent_id",
|
|
1811
|
+
"in": "path",
|
|
1812
|
+
"required": true,
|
|
1813
|
+
"description": "Customer Chat agent id",
|
|
1814
|
+
"schema": {
|
|
1815
|
+
"type": "string"
|
|
1816
|
+
}
|
|
1817
|
+
},
|
|
1818
|
+
"IfMatchUpdatedAt": {
|
|
1819
|
+
"name": "If-Match",
|
|
1820
|
+
"in": "header",
|
|
1821
|
+
"required": false,
|
|
1822
|
+
"description": "Compare-and-swap token. The agent's current `updated_at`; may be sent as `updated_at` in the body instead.",
|
|
1823
|
+
"schema": {
|
|
1824
|
+
"type": "string"
|
|
1825
|
+
}
|
|
1826
|
+
}
|
|
1827
|
+
},
|
|
1828
|
+
"schemas": {
|
|
1829
|
+
"AgentConfig": {
|
|
1830
|
+
"type": "object",
|
|
1831
|
+
"required": [
|
|
1832
|
+
"capabilities",
|
|
1833
|
+
"knowledgeSources",
|
|
1834
|
+
"escalation",
|
|
1835
|
+
"appearance"
|
|
1836
|
+
],
|
|
1837
|
+
"properties": {
|
|
1838
|
+
"capabilities": {
|
|
1839
|
+
"description": "Configured capability instances, up to 30 per agent. The same\ncatalog `type` may appear more than once when `label` (name) or\n`guidance` (when to use) differs between siblings.\n",
|
|
1840
|
+
"type": "array",
|
|
1841
|
+
"items": {
|
|
1842
|
+
"$ref": "#/components/schemas/CapabilityInstance"
|
|
1843
|
+
}
|
|
1844
|
+
},
|
|
1845
|
+
"knowledgeSources": {
|
|
1846
|
+
"type": "array",
|
|
1847
|
+
"items": {
|
|
1848
|
+
"$ref": "#/components/schemas/CustomerChatKnowledgeSource"
|
|
1849
|
+
}
|
|
1850
|
+
},
|
|
1851
|
+
"escalation": {
|
|
1852
|
+
"$ref": "#/components/schemas/EscalationConfig"
|
|
1853
|
+
},
|
|
1854
|
+
"appearance": {
|
|
1855
|
+
"$ref": "#/components/schemas/AppearanceConfig"
|
|
1856
|
+
},
|
|
1857
|
+
"instructions": {
|
|
1858
|
+
"type": "string",
|
|
1859
|
+
"maxLength": 8000,
|
|
1860
|
+
"description": "Admin-editable briefing in the default `appearance.language`. Prefilled with a place default on create; omitted on save keeps the saved value."
|
|
1861
|
+
},
|
|
1862
|
+
"instructionTranslations": {
|
|
1863
|
+
"type": "object",
|
|
1864
|
+
"description": "Briefings for each language in `appearance.languages` other than `appearance.language`. Only present once the agent speaks a second language.",
|
|
1865
|
+
"properties": {
|
|
1866
|
+
"de": {
|
|
1867
|
+
"type": "string",
|
|
1868
|
+
"maxLength": 8000
|
|
1869
|
+
},
|
|
1870
|
+
"en": {
|
|
1871
|
+
"type": "string",
|
|
1872
|
+
"maxLength": 8000
|
|
1873
|
+
}
|
|
1874
|
+
}
|
|
1875
|
+
},
|
|
1876
|
+
"instructionsNeedsReview": {
|
|
1877
|
+
"type": "array",
|
|
1878
|
+
"description": "Languages whose briefing changed in another language and are not checked yet.",
|
|
1879
|
+
"items": {
|
|
1880
|
+
"type": "string",
|
|
1881
|
+
"enum": [
|
|
1882
|
+
"de",
|
|
1883
|
+
"en"
|
|
1884
|
+
]
|
|
1885
|
+
}
|
|
1886
|
+
}
|
|
1887
|
+
}
|
|
1888
|
+
},
|
|
1889
|
+
"AppearanceConfig": {
|
|
1890
|
+
"type": "object",
|
|
1891
|
+
"required": [
|
|
1892
|
+
"displayName",
|
|
1893
|
+
"greeting",
|
|
1894
|
+
"starters",
|
|
1895
|
+
"language",
|
|
1896
|
+
"formOfAddress"
|
|
1897
|
+
],
|
|
1898
|
+
"properties": {
|
|
1899
|
+
"displayName": {
|
|
1900
|
+
"type": "string"
|
|
1901
|
+
},
|
|
1902
|
+
"greeting": {
|
|
1903
|
+
"type": "string"
|
|
1904
|
+
},
|
|
1905
|
+
"starters": {
|
|
1906
|
+
"type": "array",
|
|
1907
|
+
"items": {
|
|
1908
|
+
"type": "string"
|
|
1909
|
+
}
|
|
1910
|
+
},
|
|
1911
|
+
"language": {
|
|
1912
|
+
"type": "string",
|
|
1913
|
+
"description": "Default language. The top-level texts are written in it.",
|
|
1914
|
+
"enum": [
|
|
1915
|
+
"de",
|
|
1916
|
+
"en"
|
|
1917
|
+
]
|
|
1918
|
+
},
|
|
1919
|
+
"formOfAddress": {
|
|
1920
|
+
"type": "string",
|
|
1921
|
+
"enum": [
|
|
1922
|
+
"sie",
|
|
1923
|
+
"du"
|
|
1924
|
+
]
|
|
1925
|
+
},
|
|
1926
|
+
"languages": {
|
|
1927
|
+
"type": "array",
|
|
1928
|
+
"description": "Languages customers can chat in. Only present with two or more; always includes `language`.",
|
|
1929
|
+
"items": {
|
|
1930
|
+
"type": "string",
|
|
1931
|
+
"enum": [
|
|
1932
|
+
"de",
|
|
1933
|
+
"en"
|
|
1934
|
+
]
|
|
1935
|
+
}
|
|
1936
|
+
},
|
|
1937
|
+
"translations": {
|
|
1938
|
+
"type": "object",
|
|
1939
|
+
"description": "Texts for each language in `languages` other than `language`.",
|
|
1940
|
+
"properties": {
|
|
1941
|
+
"de": {
|
|
1942
|
+
"$ref": "#/components/schemas/LocalizedAppearance"
|
|
1943
|
+
},
|
|
1944
|
+
"en": {
|
|
1945
|
+
"$ref": "#/components/schemas/LocalizedAppearance"
|
|
1946
|
+
}
|
|
1947
|
+
}
|
|
1948
|
+
},
|
|
1949
|
+
"needsReview": {
|
|
1950
|
+
"type": "object",
|
|
1951
|
+
"description": "Per language, texts that changed in another language and are not checked yet.",
|
|
1952
|
+
"properties": {
|
|
1953
|
+
"de": {
|
|
1954
|
+
"$ref": "#/components/schemas/LocalizedFieldList"
|
|
1955
|
+
},
|
|
1956
|
+
"en": {
|
|
1957
|
+
"$ref": "#/components/schemas/LocalizedFieldList"
|
|
1958
|
+
}
|
|
1959
|
+
}
|
|
1960
|
+
}
|
|
1961
|
+
}
|
|
1962
|
+
},
|
|
1963
|
+
"LocalizedAppearance": {
|
|
1964
|
+
"type": "object",
|
|
1965
|
+
"required": [
|
|
1966
|
+
"displayName",
|
|
1967
|
+
"greeting",
|
|
1968
|
+
"starters"
|
|
1969
|
+
],
|
|
1970
|
+
"properties": {
|
|
1971
|
+
"displayName": {
|
|
1972
|
+
"type": "string"
|
|
1973
|
+
},
|
|
1974
|
+
"greeting": {
|
|
1975
|
+
"type": "string"
|
|
1976
|
+
},
|
|
1977
|
+
"starters": {
|
|
1978
|
+
"type": "array",
|
|
1979
|
+
"items": {
|
|
1980
|
+
"type": "string"
|
|
1981
|
+
}
|
|
1982
|
+
}
|
|
1983
|
+
}
|
|
1984
|
+
},
|
|
1985
|
+
"LocalizedFieldList": {
|
|
1986
|
+
"type": "array",
|
|
1987
|
+
"items": {
|
|
1988
|
+
"type": "string",
|
|
1989
|
+
"enum": [
|
|
1990
|
+
"displayName",
|
|
1991
|
+
"greeting",
|
|
1992
|
+
"starters"
|
|
1993
|
+
]
|
|
1994
|
+
}
|
|
1995
|
+
},
|
|
1996
|
+
"CapabilityId": {
|
|
1997
|
+
"type": "string",
|
|
1998
|
+
"enum": [
|
|
1999
|
+
"navigate_portal_pages",
|
|
2000
|
+
"search_portal_records",
|
|
2001
|
+
"view_billing",
|
|
2002
|
+
"view_meter_readings",
|
|
2003
|
+
"view_contracts",
|
|
2004
|
+
"search_web",
|
|
2005
|
+
"open_quick_actions",
|
|
2006
|
+
"view_hems_energy"
|
|
2007
|
+
]
|
|
2008
|
+
},
|
|
2009
|
+
"ActionAutonomy": {
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"description": "Action capabilities only (`open_quick_actions`): per-capability autonomy.\n`draft` = suggest only (proposal + deep link, nothing opens),\n`approval` = the customer confirms in a card first,\n`automatic` = run immediately. Defaults to `approval` when the\ncapability is enabled without one; unknown values become `approval`;\nvalues above the capability's maximum are clamped down.\n",
|
|
2012
|
+
"enum": [
|
|
2013
|
+
"draft",
|
|
2014
|
+
"approval",
|
|
2015
|
+
"automatic"
|
|
2016
|
+
]
|
|
2017
|
+
},
|
|
2018
|
+
"CapabilityState": {
|
|
2019
|
+
"type": "object",
|
|
2020
|
+
"required": [
|
|
2021
|
+
"enabled"
|
|
2022
|
+
],
|
|
2023
|
+
"properties": {
|
|
2024
|
+
"enabled": {
|
|
2025
|
+
"type": "boolean"
|
|
2026
|
+
},
|
|
2027
|
+
"meterTypes": {
|
|
2028
|
+
"type": "array",
|
|
2029
|
+
"items": {
|
|
2030
|
+
"type": "string"
|
|
2031
|
+
}
|
|
2032
|
+
},
|
|
2033
|
+
"ticketType": {
|
|
2034
|
+
"type": "string"
|
|
2035
|
+
},
|
|
2036
|
+
"allowedDomains": {
|
|
2037
|
+
"type": "array",
|
|
2038
|
+
"maxItems": 20,
|
|
2039
|
+
"description": "`search_web` only. Websites web search may use, normalized to\n`host[/path]` (scheme, `www.`, query, fragment and trailing slash\nremoved; host lowercased; duplicates dropped). Empty or missing\nallows any website. When set, only `web_search.search` is granted.\n",
|
|
2040
|
+
"items": {
|
|
2041
|
+
"type": "string"
|
|
2042
|
+
}
|
|
2043
|
+
},
|
|
2044
|
+
"autonomy": {
|
|
2045
|
+
"$ref": "#/components/schemas/ActionAutonomy"
|
|
2046
|
+
},
|
|
2047
|
+
"label": {
|
|
2048
|
+
"type": "string",
|
|
2049
|
+
"maxLength": 100,
|
|
2050
|
+
"description": "Admin label override. Kept on every capability so a disabled row stays listed."
|
|
2051
|
+
},
|
|
2052
|
+
"guidance": {
|
|
2053
|
+
"type": "string",
|
|
2054
|
+
"maxLength": 1000,
|
|
2055
|
+
"description": "Admin guidance. Kept on every capability so a disabled row stays listed; action capabilities also inject it into the prompt."
|
|
2056
|
+
},
|
|
2057
|
+
"blockIds": {
|
|
2058
|
+
"type": "array",
|
|
2059
|
+
"description": "`open_quick_actions` only. Reserved tile allowlist (at most 200);\nempty or missing allows every quick-action tile on the linked portal.\n",
|
|
2060
|
+
"items": {
|
|
2061
|
+
"type": "string"
|
|
2062
|
+
}
|
|
2063
|
+
},
|
|
2064
|
+
"integrationId": {
|
|
2065
|
+
"type": "string",
|
|
2066
|
+
"format": "uuid",
|
|
2067
|
+
"description": "`view_hems_energy` only. Hub integration installation id used by\nHEMS portal tools (`portal.hems.snapshot` via list_devices, and\nwhen searchDeviceDocs is on also get_vendors /\nget_connection_options). Chosen in Agent Builder via the\nintegration picker.\n"
|
|
2068
|
+
},
|
|
2069
|
+
"searchDeviceDocs": {
|
|
2070
|
+
"type": "boolean",
|
|
2071
|
+
"description": "`view_hems_energy` only. When true or omitted, grants device\nonboarding docs tools (`portal.hems.vendors` via get_vendors +\n`portal.hems.onboarding_docs` via get_connection_options) once\nan integrationId is set. Set false to disable. Portal place only.\n"
|
|
2072
|
+
}
|
|
2073
|
+
}
|
|
2074
|
+
},
|
|
2075
|
+
"CapabilityInstance": {
|
|
2076
|
+
"allOf": [
|
|
2077
|
+
{
|
|
2078
|
+
"type": "object",
|
|
2079
|
+
"required": [
|
|
2080
|
+
"type",
|
|
2081
|
+
"enabled"
|
|
2082
|
+
],
|
|
2083
|
+
"properties": {
|
|
2084
|
+
"type": {
|
|
2085
|
+
"$ref": "#/components/schemas/CapabilityId"
|
|
2086
|
+
},
|
|
2087
|
+
"instanceId": {
|
|
2088
|
+
"type": "string",
|
|
2089
|
+
"minLength": 1,
|
|
2090
|
+
"description": "Stable id for this instance within the agent. Generated when\nomitted; send it back unchanged on later saves.\n"
|
|
2091
|
+
}
|
|
2092
|
+
}
|
|
2093
|
+
},
|
|
2094
|
+
{
|
|
2095
|
+
"$ref": "#/components/schemas/CapabilityState"
|
|
2096
|
+
}
|
|
2097
|
+
]
|
|
2098
|
+
},
|
|
2099
|
+
"CreateCustomerChatAgentRequest": {
|
|
2100
|
+
"type": "object",
|
|
2101
|
+
"required": [
|
|
2102
|
+
"place"
|
|
2103
|
+
],
|
|
2104
|
+
"properties": {
|
|
2105
|
+
"place": {
|
|
2106
|
+
"$ref": "#/components/schemas/CustomerChatPlace"
|
|
2107
|
+
},
|
|
2108
|
+
"internal_name": {
|
|
2109
|
+
"type": "string",
|
|
2110
|
+
"minLength": 1,
|
|
2111
|
+
"maxLength": 100
|
|
2112
|
+
}
|
|
2113
|
+
}
|
|
2114
|
+
},
|
|
2115
|
+
"CustomerChatAgent": {
|
|
2116
|
+
"type": "object",
|
|
2117
|
+
"required": [
|
|
2118
|
+
"org_id",
|
|
2119
|
+
"agent_id",
|
|
2120
|
+
"place",
|
|
2121
|
+
"internal_name",
|
|
2122
|
+
"runtime_agent_id",
|
|
2123
|
+
"config",
|
|
2124
|
+
"created_at",
|
|
2125
|
+
"updated_at"
|
|
2126
|
+
],
|
|
2127
|
+
"properties": {
|
|
2128
|
+
"org_id": {
|
|
2129
|
+
"type": "string"
|
|
2130
|
+
},
|
|
2131
|
+
"agent_id": {
|
|
2132
|
+
"type": "string",
|
|
2133
|
+
"format": "uuid",
|
|
2134
|
+
"description": "Stable id of the customer chat agent; equal to runtime_agent_id."
|
|
2135
|
+
},
|
|
2136
|
+
"place": {
|
|
2137
|
+
"$ref": "#/components/schemas/CustomerChatPlace"
|
|
2138
|
+
},
|
|
2139
|
+
"internal_name": {
|
|
2140
|
+
"type": "string"
|
|
2141
|
+
},
|
|
2142
|
+
"runtime_agent_id": {
|
|
2143
|
+
"type": "string",
|
|
2144
|
+
"format": "uuid"
|
|
2145
|
+
},
|
|
2146
|
+
"config": {
|
|
2147
|
+
"$ref": "#/components/schemas/AgentConfig"
|
|
2148
|
+
},
|
|
2149
|
+
"created_at": {
|
|
2150
|
+
"type": "string",
|
|
2151
|
+
"format": "date-time"
|
|
2152
|
+
},
|
|
2153
|
+
"updated_at": {
|
|
2154
|
+
"type": "string",
|
|
2155
|
+
"format": "date-time"
|
|
2156
|
+
}
|
|
2157
|
+
}
|
|
2158
|
+
},
|
|
2159
|
+
"CustomerChatCasRequest": {
|
|
2160
|
+
"type": "object",
|
|
2161
|
+
"properties": {
|
|
2162
|
+
"updated_at": {
|
|
2163
|
+
"type": "string",
|
|
2164
|
+
"format": "date-time"
|
|
2165
|
+
}
|
|
2166
|
+
}
|
|
2167
|
+
},
|
|
2168
|
+
"DeleteCustomerChatAgentRequest": {
|
|
2169
|
+
"allOf": [
|
|
2170
|
+
{
|
|
2171
|
+
"$ref": "#/components/schemas/CustomerChatCasRequest"
|
|
2172
|
+
},
|
|
2173
|
+
{
|
|
2174
|
+
"type": "object",
|
|
2175
|
+
"properties": {
|
|
2176
|
+
"portal_id": {
|
|
2177
|
+
"type": "string",
|
|
2178
|
+
"format": "uuid",
|
|
2179
|
+
"description": "Portal linked to this agent (`feature_settings.portal_copilot_agent_id`).\nWhen set, only that portal is unlinked. When omitted for a portal agent,\norg portal configs are scanned for matching links.\n"
|
|
2180
|
+
}
|
|
2181
|
+
}
|
|
2182
|
+
}
|
|
2183
|
+
]
|
|
2184
|
+
},
|
|
2185
|
+
"CustomerChatPlace": {
|
|
2186
|
+
"type": "string",
|
|
2187
|
+
"enum": [
|
|
2188
|
+
"website",
|
|
2189
|
+
"portal"
|
|
2190
|
+
]
|
|
2191
|
+
},
|
|
2192
|
+
"EscalationConfig": {
|
|
2193
|
+
"type": "object",
|
|
2194
|
+
"required": [
|
|
2195
|
+
"websiteHandover"
|
|
2196
|
+
],
|
|
2197
|
+
"properties": {
|
|
2198
|
+
"websiteHandover": {
|
|
2199
|
+
"$ref": "#/components/schemas/WebsiteHandover"
|
|
2200
|
+
}
|
|
2201
|
+
}
|
|
2202
|
+
},
|
|
2203
|
+
"CustomerChatKnowledgeSource": {
|
|
2204
|
+
"type": "object",
|
|
2205
|
+
"required": [
|
|
2206
|
+
"id",
|
|
2207
|
+
"type",
|
|
2208
|
+
"title",
|
|
2209
|
+
"targetId"
|
|
2210
|
+
],
|
|
2211
|
+
"properties": {
|
|
2212
|
+
"id": {
|
|
2213
|
+
"type": "string"
|
|
2214
|
+
},
|
|
2215
|
+
"type": {
|
|
2216
|
+
"$ref": "#/components/schemas/CustomerChatKnowledgeSourceType"
|
|
2217
|
+
},
|
|
2218
|
+
"title": {
|
|
2219
|
+
"type": "string"
|
|
2220
|
+
},
|
|
2221
|
+
"targetId": {
|
|
2222
|
+
"type": "string"
|
|
2223
|
+
},
|
|
2224
|
+
"detail": {
|
|
2225
|
+
"type": "string"
|
|
2226
|
+
}
|
|
2227
|
+
}
|
|
2228
|
+
},
|
|
2229
|
+
"CustomerChatKnowledgeSourceType": {
|
|
2230
|
+
"type": "string",
|
|
2231
|
+
"enum": [
|
|
2232
|
+
"portal_page",
|
|
2233
|
+
"document",
|
|
2234
|
+
"catalogue",
|
|
2235
|
+
"url"
|
|
2236
|
+
]
|
|
2237
|
+
},
|
|
2238
|
+
"ListCustomerChatResponse": {
|
|
2239
|
+
"type": "object",
|
|
2240
|
+
"required": [
|
|
2241
|
+
"agents"
|
|
2242
|
+
],
|
|
2243
|
+
"properties": {
|
|
2244
|
+
"agents": {
|
|
2245
|
+
"type": "array",
|
|
2246
|
+
"items": {
|
|
2247
|
+
"$ref": "#/components/schemas/CustomerChatAgent"
|
|
2248
|
+
}
|
|
2249
|
+
}
|
|
2250
|
+
}
|
|
2251
|
+
},
|
|
2252
|
+
"CustomerChatCapabilityCatalogEntry": {
|
|
2253
|
+
"type": "object",
|
|
2254
|
+
"required": [
|
|
2255
|
+
"id",
|
|
2256
|
+
"places"
|
|
2257
|
+
],
|
|
2258
|
+
"properties": {
|
|
2259
|
+
"id": {
|
|
2260
|
+
"$ref": "#/components/schemas/CapabilityId"
|
|
2261
|
+
},
|
|
2262
|
+
"places": {
|
|
2263
|
+
"type": "array",
|
|
2264
|
+
"items": {
|
|
2265
|
+
"$ref": "#/components/schemas/CustomerChatPlace"
|
|
2266
|
+
}
|
|
2267
|
+
},
|
|
2268
|
+
"singleInstance": {
|
|
2269
|
+
"type": "boolean",
|
|
2270
|
+
"description": "An agent can have this capability at most once. Agents that already\nhave more instances keep them, but cannot add another.\n"
|
|
2271
|
+
},
|
|
2272
|
+
"requiresIntegration": {
|
|
2273
|
+
"type": "boolean",
|
|
2274
|
+
"description": "Only offer this capability when the organization has a matching\nintegration set up.\n"
|
|
2275
|
+
}
|
|
2276
|
+
}
|
|
2277
|
+
},
|
|
2278
|
+
"ListCustomerChatCapabilitiesResponse": {
|
|
2279
|
+
"type": "object",
|
|
2280
|
+
"required": [
|
|
2281
|
+
"capabilities"
|
|
2282
|
+
],
|
|
2283
|
+
"properties": {
|
|
2284
|
+
"capabilities": {
|
|
2285
|
+
"type": "array",
|
|
2286
|
+
"items": {
|
|
2287
|
+
"$ref": "#/components/schemas/CustomerChatCapabilityCatalogEntry"
|
|
2288
|
+
}
|
|
2289
|
+
}
|
|
2290
|
+
}
|
|
2291
|
+
},
|
|
2292
|
+
"RenameCustomerChatAgentRequest": {
|
|
2293
|
+
"type": "object",
|
|
2294
|
+
"required": [
|
|
2295
|
+
"internal_name"
|
|
2296
|
+
],
|
|
2297
|
+
"properties": {
|
|
2298
|
+
"internal_name": {
|
|
2299
|
+
"type": "string",
|
|
2300
|
+
"minLength": 1,
|
|
2301
|
+
"maxLength": 100
|
|
2302
|
+
},
|
|
2303
|
+
"updated_at": {
|
|
2304
|
+
"type": "string",
|
|
2305
|
+
"format": "date-time"
|
|
2306
|
+
}
|
|
2307
|
+
}
|
|
2308
|
+
},
|
|
2309
|
+
"SaveCustomerChatConfigRequest": {
|
|
2310
|
+
"type": "object",
|
|
2311
|
+
"required": [
|
|
2312
|
+
"config"
|
|
2313
|
+
],
|
|
2314
|
+
"properties": {
|
|
2315
|
+
"config": {
|
|
2316
|
+
"$ref": "#/components/schemas/AgentConfig"
|
|
2317
|
+
},
|
|
2318
|
+
"updated_at": {
|
|
2319
|
+
"type": "string",
|
|
2320
|
+
"format": "date-time"
|
|
2321
|
+
}
|
|
2322
|
+
}
|
|
2323
|
+
},
|
|
2324
|
+
"WebsiteHandover": {
|
|
2325
|
+
"type": "object",
|
|
2326
|
+
"required": [
|
|
2327
|
+
"kind",
|
|
2328
|
+
"value"
|
|
2329
|
+
],
|
|
2330
|
+
"properties": {
|
|
2331
|
+
"kind": {
|
|
2332
|
+
"type": "string",
|
|
2333
|
+
"enum": [
|
|
2334
|
+
"phone",
|
|
2335
|
+
"email",
|
|
2336
|
+
"journey",
|
|
2337
|
+
"unset"
|
|
2338
|
+
]
|
|
2339
|
+
},
|
|
2340
|
+
"value": {
|
|
2341
|
+
"type": "string"
|
|
2342
|
+
},
|
|
2343
|
+
"journeyId": {
|
|
2344
|
+
"type": "string"
|
|
2345
|
+
},
|
|
2346
|
+
"journeyName": {
|
|
2347
|
+
"type": "string"
|
|
2348
|
+
}
|
|
2349
|
+
}
|
|
2350
|
+
},
|
|
2351
|
+
"AgentId": {
|
|
2352
|
+
"type": "string",
|
|
2353
|
+
"description": "Agent identifier. Can be either:\n- System skill ID (prefixed): \"skill:email-categorizer\", \"skill:email-labeler\"\n- Custom agent UUID: \"0336a235-9417-4dd8-894c-fe81285bba75\"\n",
|
|
2354
|
+
"example": "skill:email-categorizer"
|
|
2355
|
+
},
|
|
2356
|
+
"KnowledgeSourceIds": {
|
|
2357
|
+
"type": "array",
|
|
2358
|
+
"description": "Knowledge source IDs available to this agent. An empty array clears the selection.",
|
|
2359
|
+
"uniqueItems": true,
|
|
2360
|
+
"items": {
|
|
2361
|
+
"type": "string",
|
|
2362
|
+
"format": "uuid"
|
|
2363
|
+
}
|
|
2364
|
+
},
|
|
2365
|
+
"KnowledgeSource": {
|
|
2366
|
+
"oneOf": [
|
|
2367
|
+
{
|
|
2368
|
+
"$ref": "#/components/schemas/KnowledgeFileSource"
|
|
2369
|
+
}
|
|
2370
|
+
],
|
|
2371
|
+
"discriminator": {
|
|
2372
|
+
"propertyName": "type",
|
|
2373
|
+
"mapping": {
|
|
2374
|
+
"file": "#/components/schemas/KnowledgeFileSource"
|
|
1164
2375
|
}
|
|
1165
2376
|
}
|
|
1166
|
-
}
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
"
|
|
2377
|
+
},
|
|
2378
|
+
"KnowledgeFileSource": {
|
|
2379
|
+
"type": "object",
|
|
2380
|
+
"required": [
|
|
2381
|
+
"type",
|
|
2382
|
+
"source_id",
|
|
2383
|
+
"filename",
|
|
2384
|
+
"mime_type",
|
|
2385
|
+
"size_bytes",
|
|
2386
|
+
"ready",
|
|
2387
|
+
"created_at",
|
|
2388
|
+
"updated_at"
|
|
1172
2389
|
],
|
|
1173
|
-
"
|
|
1174
|
-
"
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
2390
|
+
"additionalProperties": false,
|
|
2391
|
+
"properties": {
|
|
2392
|
+
"type": {
|
|
2393
|
+
"type": "string",
|
|
2394
|
+
"enum": [
|
|
2395
|
+
"file"
|
|
2396
|
+
]
|
|
2397
|
+
},
|
|
2398
|
+
"source_id": {
|
|
2399
|
+
"type": "string",
|
|
2400
|
+
"format": "uuid"
|
|
2401
|
+
},
|
|
2402
|
+
"filename": {
|
|
2403
|
+
"type": "string"
|
|
2404
|
+
},
|
|
2405
|
+
"mime_type": {
|
|
2406
|
+
"type": "string"
|
|
2407
|
+
},
|
|
2408
|
+
"size_bytes": {
|
|
2409
|
+
"type": "integer",
|
|
2410
|
+
"format": "int64"
|
|
2411
|
+
},
|
|
2412
|
+
"ready": {
|
|
2413
|
+
"type": "boolean",
|
|
2414
|
+
"description": "Whether the source is available for agent retrieval."
|
|
2415
|
+
},
|
|
2416
|
+
"created_at": {
|
|
2417
|
+
"type": "string",
|
|
2418
|
+
"format": "date-time"
|
|
2419
|
+
},
|
|
2420
|
+
"updated_at": {
|
|
2421
|
+
"type": "string",
|
|
2422
|
+
"format": "date-time"
|
|
1179
2423
|
}
|
|
2424
|
+
}
|
|
2425
|
+
},
|
|
2426
|
+
"CreateKnowledgeFileUploadRequest": {
|
|
2427
|
+
"type": "object",
|
|
2428
|
+
"required": [
|
|
2429
|
+
"filename",
|
|
2430
|
+
"mime_type",
|
|
2431
|
+
"size_bytes"
|
|
1180
2432
|
],
|
|
1181
|
-
"
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
"
|
|
1185
|
-
"
|
|
1186
|
-
"
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
2433
|
+
"additionalProperties": false,
|
|
2434
|
+
"properties": {
|
|
2435
|
+
"filename": {
|
|
2436
|
+
"type": "string",
|
|
2437
|
+
"minLength": 1,
|
|
2438
|
+
"maxLength": 255
|
|
2439
|
+
},
|
|
2440
|
+
"mime_type": {
|
|
2441
|
+
"type": "string",
|
|
2442
|
+
"minLength": 1,
|
|
2443
|
+
"maxLength": 255
|
|
2444
|
+
},
|
|
2445
|
+
"size_bytes": {
|
|
2446
|
+
"type": "integer",
|
|
2447
|
+
"format": "int64",
|
|
2448
|
+
"minimum": 1,
|
|
2449
|
+
"maximum": 1000000000
|
|
1190
2450
|
}
|
|
2451
|
+
}
|
|
2452
|
+
},
|
|
2453
|
+
"CreateKnowledgeFileUploadResponse": {
|
|
2454
|
+
"type": "object",
|
|
2455
|
+
"required": [
|
|
2456
|
+
"source_id",
|
|
2457
|
+
"upload_url",
|
|
2458
|
+
"upload_fields",
|
|
2459
|
+
"expires_at"
|
|
1191
2460
|
],
|
|
1192
|
-
"
|
|
1193
|
-
"
|
|
1194
|
-
|
|
1195
|
-
"
|
|
1196
|
-
"schema": {
|
|
1197
|
-
"$ref": "#/components/schemas/SubmitFeedbackRequest"
|
|
1198
|
-
}
|
|
1199
|
-
}
|
|
1200
|
-
}
|
|
1201
|
-
},
|
|
1202
|
-
"responses": {
|
|
1203
|
-
"200": {
|
|
1204
|
-
"description": "Feedback recorded",
|
|
1205
|
-
"content": {
|
|
1206
|
-
"application/json": {
|
|
1207
|
-
"schema": {
|
|
1208
|
-
"type": "object",
|
|
1209
|
-
"properties": {
|
|
1210
|
-
"feedback": {
|
|
1211
|
-
"$ref": "#/components/schemas/MessageFeedback"
|
|
1212
|
-
}
|
|
1213
|
-
}
|
|
1214
|
-
}
|
|
1215
|
-
}
|
|
1216
|
-
}
|
|
2461
|
+
"properties": {
|
|
2462
|
+
"source_id": {
|
|
2463
|
+
"type": "string",
|
|
2464
|
+
"format": "uuid"
|
|
1217
2465
|
},
|
|
1218
|
-
"
|
|
1219
|
-
"
|
|
1220
|
-
"
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
2466
|
+
"upload_url": {
|
|
2467
|
+
"type": "string",
|
|
2468
|
+
"format": "uri"
|
|
2469
|
+
},
|
|
2470
|
+
"upload_fields": {
|
|
2471
|
+
"type": "object",
|
|
2472
|
+
"additionalProperties": {
|
|
2473
|
+
"type": "string"
|
|
1226
2474
|
}
|
|
1227
2475
|
},
|
|
1228
|
-
"
|
|
1229
|
-
"
|
|
1230
|
-
"
|
|
1231
|
-
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
2476
|
+
"expires_at": {
|
|
2477
|
+
"type": "string",
|
|
2478
|
+
"format": "date-time"
|
|
2479
|
+
}
|
|
2480
|
+
}
|
|
2481
|
+
},
|
|
2482
|
+
"ListKnowledgeSourcesResponse": {
|
|
2483
|
+
"type": "object",
|
|
2484
|
+
"required": [
|
|
2485
|
+
"sources"
|
|
2486
|
+
],
|
|
2487
|
+
"properties": {
|
|
2488
|
+
"sources": {
|
|
2489
|
+
"type": "array",
|
|
2490
|
+
"items": {
|
|
2491
|
+
"$ref": "#/components/schemas/KnowledgeSource"
|
|
1236
2492
|
}
|
|
1237
2493
|
}
|
|
1238
2494
|
}
|
|
1239
|
-
}
|
|
1240
|
-
|
|
1241
|
-
},
|
|
1242
|
-
"components": {
|
|
1243
|
-
"securitySchemes": {
|
|
1244
|
-
"EpilotAuth": {
|
|
1245
|
-
"type": "http",
|
|
1246
|
-
"scheme": "bearer",
|
|
1247
|
-
"description": "Authorization header with epilot OAuth2 bearer token. Supports RFC8725 for JWT validation.",
|
|
1248
|
-
"bearerFormat": "JWT"
|
|
1249
|
-
}
|
|
1250
|
-
},
|
|
1251
|
-
"schemas": {
|
|
1252
|
-
"AgentId": {
|
|
2495
|
+
},
|
|
2496
|
+
"AgentDomain": {
|
|
1253
2497
|
"type": "string",
|
|
1254
|
-
"description": "
|
|
1255
|
-
"
|
|
2498
|
+
"description": "Business domain selected in the agent builder.",
|
|
2499
|
+
"enum": [
|
|
2500
|
+
"customer_service",
|
|
2501
|
+
"sales",
|
|
2502
|
+
"billing",
|
|
2503
|
+
"metering_grid",
|
|
2504
|
+
"other"
|
|
2505
|
+
]
|
|
1256
2506
|
},
|
|
1257
2507
|
"CreateAgentRequest": {
|
|
1258
2508
|
"type": "object",
|
|
@@ -1262,6 +2512,17 @@
|
|
|
1262
2512
|
"execution_pattern"
|
|
1263
2513
|
],
|
|
1264
2514
|
"properties": {
|
|
2515
|
+
"domain": {
|
|
2516
|
+
"$ref": "#/components/schemas/AgentDomain"
|
|
2517
|
+
},
|
|
2518
|
+
"availability": {
|
|
2519
|
+
"type": "array",
|
|
2520
|
+
"minItems": 1,
|
|
2521
|
+
"uniqueItems": true,
|
|
2522
|
+
"items": {
|
|
2523
|
+
"$ref": "#/components/schemas/SkillAvailability"
|
|
2524
|
+
}
|
|
2525
|
+
},
|
|
1265
2526
|
"name": {
|
|
1266
2527
|
"type": "string",
|
|
1267
2528
|
"minLength": 1,
|
|
@@ -1317,12 +2578,26 @@
|
|
|
1317
2578
|
},
|
|
1318
2579
|
"input_parameters_schema": {
|
|
1319
2580
|
"$ref": "#/components/schemas/InputParametersSchema"
|
|
2581
|
+
},
|
|
2582
|
+
"knowledge_source_ids": {
|
|
2583
|
+
"$ref": "#/components/schemas/KnowledgeSourceIds"
|
|
1320
2584
|
}
|
|
1321
2585
|
}
|
|
1322
2586
|
},
|
|
1323
2587
|
"UpdateAgentRequest": {
|
|
1324
2588
|
"type": "object",
|
|
1325
2589
|
"properties": {
|
|
2590
|
+
"domain": {
|
|
2591
|
+
"$ref": "#/components/schemas/AgentDomain"
|
|
2592
|
+
},
|
|
2593
|
+
"availability": {
|
|
2594
|
+
"type": "array",
|
|
2595
|
+
"minItems": 1,
|
|
2596
|
+
"uniqueItems": true,
|
|
2597
|
+
"items": {
|
|
2598
|
+
"$ref": "#/components/schemas/SkillAvailability"
|
|
2599
|
+
}
|
|
2600
|
+
},
|
|
1326
2601
|
"name": {
|
|
1327
2602
|
"type": "string",
|
|
1328
2603
|
"minLength": 1,
|
|
@@ -1367,12 +2642,18 @@
|
|
|
1367
2642
|
},
|
|
1368
2643
|
"input_parameters_schema": {
|
|
1369
2644
|
"$ref": "#/components/schemas/InputParametersSchema"
|
|
2645
|
+
},
|
|
2646
|
+
"knowledge_source_ids": {
|
|
2647
|
+
"$ref": "#/components/schemas/KnowledgeSourceIds"
|
|
1370
2648
|
}
|
|
1371
2649
|
}
|
|
1372
2650
|
},
|
|
1373
2651
|
"AgentDefinition": {
|
|
1374
2652
|
"type": "object",
|
|
1375
2653
|
"properties": {
|
|
2654
|
+
"domain": {
|
|
2655
|
+
"$ref": "#/components/schemas/AgentDomain"
|
|
2656
|
+
},
|
|
1376
2657
|
"agent_id": {
|
|
1377
2658
|
"$ref": "#/components/schemas/AgentId"
|
|
1378
2659
|
},
|
|
@@ -1442,6 +2723,9 @@
|
|
|
1442
2723
|
"input_parameters_schema": {
|
|
1443
2724
|
"$ref": "#/components/schemas/InputParametersSchema"
|
|
1444
2725
|
},
|
|
2726
|
+
"knowledge_source_ids": {
|
|
2727
|
+
"$ref": "#/components/schemas/KnowledgeSourceIds"
|
|
2728
|
+
},
|
|
1445
2729
|
"version": {
|
|
1446
2730
|
"type": "integer"
|
|
1447
2731
|
},
|
|
@@ -1526,9 +2810,24 @@
|
|
|
1526
2810
|
"ExecuteAgentRequest": {
|
|
1527
2811
|
"type": "object",
|
|
1528
2812
|
"properties": {
|
|
2813
|
+
"mode": {
|
|
2814
|
+
"type": "string",
|
|
2815
|
+
"enum": [
|
|
2816
|
+
"auto",
|
|
2817
|
+
"stream",
|
|
2818
|
+
"async",
|
|
2819
|
+
"sync"
|
|
2820
|
+
],
|
|
2821
|
+
"default": "auto",
|
|
2822
|
+
"description": "`sync` runs the skill inside the request and answers 200 with the completed execution, or 422/504/500\nwith the failed execution's id in `details.execution_id`. Only for direct, tool-less, automatic skills;\nthe model call is cut off after 27 seconds.\n"
|
|
2823
|
+
},
|
|
1529
2824
|
"input": {
|
|
1530
2825
|
"type": "object",
|
|
1531
2826
|
"properties": {
|
|
2827
|
+
"message": {
|
|
2828
|
+
"type": "string",
|
|
2829
|
+
"description": "Free-text instruction or query for the agent"
|
|
2830
|
+
},
|
|
1532
2831
|
"entity_id": {
|
|
1533
2832
|
"type": "string",
|
|
1534
2833
|
"description": "Primary entity ID for context"
|
|
@@ -1568,6 +2867,38 @@
|
|
|
1568
2867
|
"entity_schema"
|
|
1569
2868
|
]
|
|
1570
2869
|
}
|
|
2870
|
+
},
|
|
2871
|
+
"attachment": {
|
|
2872
|
+
"type": "object",
|
|
2873
|
+
"description": "The file the agent should look at, referenced by S3 object. Only accepted by skills\nthat declare attachment support (currently direct-mode document skills). The object is\nread by the execution Lambda and passed to the model as an image or document content\nblock; images must be JPEG, PNG, GIF or WebP, documents PDF, DOCX, DOC, XLSX, XLS,\nCSV, TXT, HTML or Markdown. Callers are expected to downscale images and cap document\npages before referencing them.\n",
|
|
2874
|
+
"required": [
|
|
2875
|
+
"s3ref",
|
|
2876
|
+
"mime_type"
|
|
2877
|
+
],
|
|
2878
|
+
"properties": {
|
|
2879
|
+
"s3ref": {
|
|
2880
|
+
"type": "object",
|
|
2881
|
+
"required": [
|
|
2882
|
+
"bucket",
|
|
2883
|
+
"key"
|
|
2884
|
+
],
|
|
2885
|
+
"properties": {
|
|
2886
|
+
"bucket": {
|
|
2887
|
+
"type": "string"
|
|
2888
|
+
},
|
|
2889
|
+
"key": {
|
|
2890
|
+
"type": "string"
|
|
2891
|
+
}
|
|
2892
|
+
}
|
|
2893
|
+
},
|
|
2894
|
+
"mime_type": {
|
|
2895
|
+
"type": "string",
|
|
2896
|
+
"description": "Mime type of the object, decides whether it is sent as an image or a document block."
|
|
2897
|
+
},
|
|
2898
|
+
"filename": {
|
|
2899
|
+
"type": "string"
|
|
2900
|
+
}
|
|
2901
|
+
}
|
|
1571
2902
|
}
|
|
1572
2903
|
}
|
|
1573
2904
|
},
|
|
@@ -1884,9 +3215,10 @@
|
|
|
1884
3215
|
},
|
|
1885
3216
|
"AgentExecutionEventStatus": {
|
|
1886
3217
|
"type": "string",
|
|
1887
|
-
"description": "Lifecycle status carried on an agent execution event.\n\nDeliberately narrower than `ExecutionStatus`, which is the stored status of\nthe execution row: `pending` and `running` both surface as `started`, and\n`cancelled` surfaces as `failed`. Consumers must not assume the two\nvocabularies are interchangeable.\n",
|
|
3218
|
+
"description": "Lifecycle status carried on an agent execution event.\n\nDeliberately narrower than `ExecutionStatus`, which is the stored status of\nthe execution row: `pending` and `running` both surface as `started`, and\n`cancelled` surfaces as `failed`. Consumers must not assume the two\nvocabularies are interchangeable.\n\n`queued` is non-terminal: the execution is waiting for executor capacity and will\nbe followed by `started`, and it can be published more than once if a throttled\nexecution is put back on the queue. Consumers must not treat it as an outcome.\n",
|
|
1888
3219
|
"enum": [
|
|
1889
3220
|
"started",
|
|
3221
|
+
"queued",
|
|
1890
3222
|
"completed",
|
|
1891
3223
|
"failed",
|
|
1892
3224
|
"approval_required"
|
|
@@ -1981,6 +3313,93 @@
|
|
|
1981
3313
|
}
|
|
1982
3314
|
}
|
|
1983
3315
|
},
|
|
3316
|
+
"KnowledgeSourceRegisteredEvent": {
|
|
3317
|
+
"description": "Detail payload of the `knowledge-source-registered` event, published on\nthe AI Agents event bus with source `ai-agents` after the source record\nexists in DynamoDB. Consumers must process `sourceId` idempotently.\n",
|
|
3318
|
+
"oneOf": [
|
|
3319
|
+
{
|
|
3320
|
+
"$ref": "#/components/schemas/KnowledgeFileSourceRegisteredEvent"
|
|
3321
|
+
}
|
|
3322
|
+
],
|
|
3323
|
+
"discriminator": {
|
|
3324
|
+
"propertyName": "type",
|
|
3325
|
+
"mapping": {
|
|
3326
|
+
"file": "#/components/schemas/KnowledgeFileSourceRegisteredEvent"
|
|
3327
|
+
}
|
|
3328
|
+
}
|
|
3329
|
+
},
|
|
3330
|
+
"KnowledgeFileSourceRegisteredEvent": {
|
|
3331
|
+
"type": "object",
|
|
3332
|
+
"required": [
|
|
3333
|
+
"orgId",
|
|
3334
|
+
"sourceId",
|
|
3335
|
+
"type",
|
|
3336
|
+
"bucket",
|
|
3337
|
+
"key"
|
|
3338
|
+
],
|
|
3339
|
+
"properties": {
|
|
3340
|
+
"orgId": {
|
|
3341
|
+
"type": "string"
|
|
3342
|
+
},
|
|
3343
|
+
"sourceId": {
|
|
3344
|
+
"type": "string",
|
|
3345
|
+
"format": "uuid"
|
|
3346
|
+
},
|
|
3347
|
+
"type": {
|
|
3348
|
+
"type": "string",
|
|
3349
|
+
"enum": [
|
|
3350
|
+
"file"
|
|
3351
|
+
]
|
|
3352
|
+
},
|
|
3353
|
+
"bucket": {
|
|
3354
|
+
"type": "string"
|
|
3355
|
+
},
|
|
3356
|
+
"key": {
|
|
3357
|
+
"type": "string"
|
|
3358
|
+
}
|
|
3359
|
+
}
|
|
3360
|
+
},
|
|
3361
|
+
"KnowledgeSourceDeletedEvent": {
|
|
3362
|
+
"type": "object",
|
|
3363
|
+
"description": "Published when a knowledge source is deleted.",
|
|
3364
|
+
"required": [
|
|
3365
|
+
"orgId",
|
|
3366
|
+
"sourceId",
|
|
3367
|
+
"type"
|
|
3368
|
+
],
|
|
3369
|
+
"properties": {
|
|
3370
|
+
"orgId": {
|
|
3371
|
+
"type": "string"
|
|
3372
|
+
},
|
|
3373
|
+
"sourceId": {
|
|
3374
|
+
"type": "string",
|
|
3375
|
+
"format": "uuid"
|
|
3376
|
+
},
|
|
3377
|
+
"type": {
|
|
3378
|
+
"type": "string",
|
|
3379
|
+
"enum": [
|
|
3380
|
+
"file"
|
|
3381
|
+
]
|
|
3382
|
+
}
|
|
3383
|
+
}
|
|
3384
|
+
},
|
|
3385
|
+
"KnowledgeSourceProcessingCompletedEvent": {
|
|
3386
|
+
"type": "object",
|
|
3387
|
+
"description": "Published by a knowledge processing pipeline after all derived data for\nthe source has been stored and is available for agent retrieval. The\nevent uses source `knowledge-processing` and detail type\n`knowledge-source-processing-completed` on the AI Agents event bus.\n",
|
|
3388
|
+
"required": [
|
|
3389
|
+
"orgId",
|
|
3390
|
+
"sourceId"
|
|
3391
|
+
],
|
|
3392
|
+
"additionalProperties": false,
|
|
3393
|
+
"properties": {
|
|
3394
|
+
"orgId": {
|
|
3395
|
+
"type": "string"
|
|
3396
|
+
},
|
|
3397
|
+
"sourceId": {
|
|
3398
|
+
"type": "string",
|
|
3399
|
+
"format": "uuid"
|
|
3400
|
+
}
|
|
3401
|
+
}
|
|
3402
|
+
},
|
|
1984
3403
|
"ToolPreview": {
|
|
1985
3404
|
"type": "object",
|
|
1986
3405
|
"description": "Structured preview data for approval UI. Provides a generic format that any tool can populate.",
|
|
@@ -2217,18 +3636,20 @@
|
|
|
2217
3636
|
"flows",
|
|
2218
3637
|
"copilot",
|
|
2219
3638
|
"portals",
|
|
3639
|
+
"website",
|
|
2220
3640
|
"all"
|
|
2221
3641
|
],
|
|
2222
|
-
"description": "Where the skill/agent is available:\n- flows: Available in workflow automations\n- copilot: Available as a sub-agent in copilot\n- portals: Available in end-user self-service portals\n- all: Available
|
|
3642
|
+
"description": "Where the skill/agent is available:\n- flows: Available in workflow automations\n- copilot: Available as a sub-agent in copilot\n- portals: Available in end-user self-service portals\n- website: Website chat, explicitly selected; currently supports anonymous execution\n- all: Available on the existing non-website surfaces; website requires explicit selection\n"
|
|
2223
3643
|
},
|
|
2224
3644
|
"ExecutionContext": {
|
|
2225
3645
|
"type": "string",
|
|
2226
3646
|
"enum": [
|
|
2227
3647
|
"flows",
|
|
2228
3648
|
"copilot",
|
|
2229
|
-
"api"
|
|
3649
|
+
"api",
|
|
3650
|
+
"sharing"
|
|
2230
3651
|
],
|
|
2231
|
-
"description": "Where the execution was triggered from:\n- flows: Triggered from workflow automation\n- copilot: Triggered from copilot assistant\n- api: Direct API call\n"
|
|
3652
|
+
"description": "Where the execution was triggered from:\n- flows: Triggered from workflow automation\n- copilot: Triggered from copilot assistant\n- api: Direct API call\n- sharing: Triggered by sharing-api auto-sharing rules\n"
|
|
2232
3653
|
},
|
|
2233
3654
|
"ExecutionPattern": {
|
|
2234
3655
|
"type": "string",
|
|
@@ -2251,6 +3672,7 @@
|
|
|
2251
3672
|
"type": "string",
|
|
2252
3673
|
"enum": [
|
|
2253
3674
|
"pending",
|
|
3675
|
+
"queued",
|
|
2254
3676
|
"running",
|
|
2255
3677
|
"waiting_approval",
|
|
2256
3678
|
"completed",
|
|
@@ -2520,6 +3942,10 @@
|
|
|
2520
3942
|
},
|
|
2521
3943
|
"streaming": {
|
|
2522
3944
|
"$ref": "#/components/schemas/StreamingOptions"
|
|
3945
|
+
},
|
|
3946
|
+
"preview_demo": {
|
|
3947
|
+
"type": "boolean",
|
|
3948
|
+
"description": "Agent Builder place-agent preview: when true, portal tools return\nsynthetic demo fixtures instead of calling customer-portal-api,\nand execution mode is forced to draft.\n"
|
|
2523
3949
|
}
|
|
2524
3950
|
}
|
|
2525
3951
|
},
|