@epilot/sdk 2.20.70 → 2.20.72
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/definitions/ai-agents-runtime.json +1 -1
- package/definitions/ai-agents.json +1876 -450
- package/definitions/identity-runtime.json +1 -1
- package/definitions/identity.json +219 -34
- package/dist/ai-agents-5EG5UUP7.js +7 -0
- package/dist/ai-agents-HDLQXHEO.cjs +7 -0
- package/dist/{ai-agents-runtime-HOBR2KUZ.js → ai-agents-runtime-5AALEMLH.js} +1 -1
- package/dist/{ai-agents-runtime-T62OQDWE.cjs → ai-agents-runtime-H5UIFXVG.cjs} +2 -2
- package/dist/{ai-agents.d-B3TkP4mo.d.cts → ai-agents.d-BhnWCRxD.d.cts} +931 -48
- package/dist/{ai-agents.d-B3TkP4mo.d.ts → ai-agents.d-BhnWCRxD.d.ts} +931 -48
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +8 -8
- package/dist/apis/ai-agents.d.cts +2 -2
- package/dist/apis/ai-agents.d.ts +2 -2
- package/dist/apis/ai-agents.js +2 -2
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/external-values.cjs +6 -6
- package/dist/apis/external-values.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/identity.cjs +8 -8
- package/dist/apis/identity.js +2 -2
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/phone-integration.cjs +6 -6
- package/dist/apis/phone-integration.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-4PXSWMYJ.cjs → chunk-5QSR7CYT.cjs} +4 -4
- package/dist/{chunk-YIK62G53.js → chunk-B42G3PU6.js} +4 -4
- package/dist/{chunk-3IBAPVLY.js → chunk-DSYS22AC.js} +1 -1
- package/dist/chunk-QVJTUU3Q.js +14 -0
- package/dist/chunk-S455SL5C.cjs +14 -0
- package/dist/{chunk-RPWTWCDC.cjs → chunk-TKRZK7V2.cjs} +1 -1
- package/dist/identity-F5XHYPXY.js +7 -0
- package/dist/identity-JDTGYAOV.cjs +7 -0
- package/dist/{identity-runtime-PFM5KQWA.js → identity-runtime-A4LSC77N.js} +1 -1
- package/dist/{identity-runtime-57DQPQWX.cjs → identity-runtime-GNE4EC7V.cjs} +2 -2
- package/dist/index.cjs +12 -12
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +3 -3
- package/docs/ai-agents.md +1407 -50
- package/docs/identity.md +58 -64
- package/package.json +1 -1
- package/dist/ai-agents-ME5VRKMY.cjs +0 -7
- package/dist/ai-agents-MY4QE4CP.js +0 -7
- package/dist/chunk-GD6KHA54.cjs +0 -14
- package/dist/chunk-IZ6OQZZ2.js +0 -14
- package/dist/identity-EG35NBZW.js +0 -7
- package/dist/identity-XMX3VFXR.cjs +0 -7
package/docs/ai-agents.md
CHANGED
|
@@ -31,6 +31,21 @@ const { data } = await aiAgentsClient.createAgent(...)
|
|
|
31
31
|
- [`updateAgentById`](#updateagentbyid)
|
|
32
32
|
- [`deleteAgentById`](#deleteagentbyid)
|
|
33
33
|
|
|
34
|
+
**Customer Chat**
|
|
35
|
+
- [`listCustomerChat`](#listcustomerchat)
|
|
36
|
+
- [`createCustomerChatAgent`](#createcustomerchatagent)
|
|
37
|
+
- [`listCustomerChatCapabilities`](#listcustomerchatcapabilities)
|
|
38
|
+
- [`getCustomerChatAgent`](#getcustomerchatagent)
|
|
39
|
+
- [`renameCustomerChatAgent`](#renamecustomerchatagent)
|
|
40
|
+
- [`deleteCustomerChatAgent`](#deletecustomerchatagent)
|
|
41
|
+
- [`saveCustomerChatConfig`](#savecustomerchatconfig)
|
|
42
|
+
|
|
43
|
+
**Knowledge**
|
|
44
|
+
- [`listKnowledgeSources`](#listknowledgesources)
|
|
45
|
+
- [`createKnowledgeFileUpload`](#createknowledgefileupload)
|
|
46
|
+
- [`getKnowledgeSource`](#getknowledgesource)
|
|
47
|
+
- [`deleteKnowledgeSource`](#deleteknowledgesource)
|
|
48
|
+
|
|
34
49
|
**Agent Execution**
|
|
35
50
|
- [`executeAgent`](#executeagent)
|
|
36
51
|
- [`executeAgentStream`](#executeagentstream)
|
|
@@ -54,7 +69,36 @@ const { data } = await aiAgentsClient.createAgent(...)
|
|
|
54
69
|
- [`submitConversationFeedback`](#submitconversationfeedback)
|
|
55
70
|
|
|
56
71
|
**Schemas**
|
|
72
|
+
- [`AgentConfig`](#agentconfig)
|
|
73
|
+
- [`AppearanceConfig`](#appearanceconfig)
|
|
74
|
+
- [`LocalizedAppearance`](#localizedappearance)
|
|
75
|
+
- [`LocalizedFieldList`](#localizedfieldlist)
|
|
76
|
+
- [`CapabilityId`](#capabilityid)
|
|
77
|
+
- [`ActionAutonomy`](#actionautonomy)
|
|
78
|
+
- [`CapabilityState`](#capabilitystate)
|
|
79
|
+
- [`CapabilityInstance`](#capabilityinstance)
|
|
80
|
+
- [`CreateCustomerChatAgentRequest`](#createcustomerchatagentrequest)
|
|
81
|
+
- [`CustomerChatAgent`](#customerchatagent)
|
|
82
|
+
- [`CustomerChatCasRequest`](#customerchatcasrequest)
|
|
83
|
+
- [`DeleteCustomerChatAgentRequest`](#deletecustomerchatagentrequest)
|
|
84
|
+
- [`CustomerChatPlace`](#customerchatplace)
|
|
85
|
+
- [`EscalationConfig`](#escalationconfig)
|
|
86
|
+
- [`CustomerChatKnowledgeSource`](#customerchatknowledgesource)
|
|
87
|
+
- [`CustomerChatKnowledgeSourceType`](#customerchatknowledgesourcetype)
|
|
88
|
+
- [`ListCustomerChatResponse`](#listcustomerchatresponse)
|
|
89
|
+
- [`CustomerChatCapabilityCatalogEntry`](#customerchatcapabilitycatalogentry)
|
|
90
|
+
- [`ListCustomerChatCapabilitiesResponse`](#listcustomerchatcapabilitiesresponse)
|
|
91
|
+
- [`RenameCustomerChatAgentRequest`](#renamecustomerchatagentrequest)
|
|
92
|
+
- [`SaveCustomerChatConfigRequest`](#savecustomerchatconfigrequest)
|
|
93
|
+
- [`WebsiteHandover`](#websitehandover)
|
|
57
94
|
- [`AgentId`](#agentid)
|
|
95
|
+
- [`KnowledgeSourceIds`](#knowledgesourceids)
|
|
96
|
+
- [`KnowledgeSource`](#knowledgesource)
|
|
97
|
+
- [`KnowledgeFileSource`](#knowledgefilesource)
|
|
98
|
+
- [`CreateKnowledgeFileUploadRequest`](#createknowledgefileuploadrequest)
|
|
99
|
+
- [`CreateKnowledgeFileUploadResponse`](#createknowledgefileuploadresponse)
|
|
100
|
+
- [`ListKnowledgeSourcesResponse`](#listknowledgesourcesresponse)
|
|
101
|
+
- [`AgentDomain`](#agentdomain)
|
|
58
102
|
- [`CreateAgentRequest`](#createagentrequest)
|
|
59
103
|
- [`UpdateAgentRequest`](#updateagentrequest)
|
|
60
104
|
- [`AgentDefinition`](#agentdefinition)
|
|
@@ -75,6 +119,10 @@ const { data } = await aiAgentsClient.createAgent(...)
|
|
|
75
119
|
- [`ExecutionMetrics`](#executionmetrics)
|
|
76
120
|
- [`AgentExecutionEventStatus`](#agentexecutioneventstatus)
|
|
77
121
|
- [`AgentExecutionEvent`](#agentexecutionevent)
|
|
122
|
+
- [`KnowledgeSourceRegisteredEvent`](#knowledgesourceregisteredevent)
|
|
123
|
+
- [`KnowledgeFileSourceRegisteredEvent`](#knowledgefilesourceregisteredevent)
|
|
124
|
+
- [`KnowledgeSourceDeletedEvent`](#knowledgesourcedeletedevent)
|
|
125
|
+
- [`KnowledgeSourceProcessingCompletedEvent`](#knowledgesourceprocessingcompletedevent)
|
|
78
126
|
- [`ToolPreview`](#toolpreview)
|
|
79
127
|
- [`PreviewActionType`](#previewactiontype)
|
|
80
128
|
- [`PreviewEntity`](#previewentity)
|
|
@@ -107,7 +155,7 @@ const { data } = await aiAgentsClient.createAgent(...)
|
|
|
107
155
|
|
|
108
156
|
### `createAgent`
|
|
109
157
|
|
|
110
|
-
|
|
158
|
+
Create Agent definition
|
|
111
159
|
|
|
112
160
|
`POST /v1/agents`
|
|
113
161
|
|
|
@@ -115,6 +163,8 @@ Creates a new custom agent. System skills cannot be created via this endpoint.
|
|
|
115
163
|
const { data } = await client.createAgent(
|
|
116
164
|
null,
|
|
117
165
|
{
|
|
166
|
+
domain: 'customer_service',
|
|
167
|
+
availability: ['flows'],
|
|
118
168
|
name: 'Email Reply Generator',
|
|
119
169
|
description: 'string',
|
|
120
170
|
category: 'message',
|
|
@@ -152,7 +202,8 @@ const { data } = await client.createAgent(
|
|
|
152
202
|
/* ... 1 more */
|
|
153
203
|
],
|
|
154
204
|
required: ['target_schema']
|
|
155
|
-
}
|
|
205
|
+
},
|
|
206
|
+
knowledge_source_ids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6']
|
|
156
207
|
},
|
|
157
208
|
)
|
|
158
209
|
```
|
|
@@ -162,6 +213,7 @@ const { data } = await client.createAgent(
|
|
|
162
213
|
|
|
163
214
|
```json
|
|
164
215
|
{
|
|
216
|
+
"domain": "customer_service",
|
|
165
217
|
"agent_id": "skill:email-categorizer",
|
|
166
218
|
"org_id": "string",
|
|
167
219
|
"name": "string",
|
|
@@ -204,6 +256,7 @@ const { data } = await client.createAgent(
|
|
|
204
256
|
],
|
|
205
257
|
"required": ["target_schema"]
|
|
206
258
|
},
|
|
259
|
+
"knowledge_source_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
|
|
207
260
|
"version": 0,
|
|
208
261
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
209
262
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
@@ -217,8 +270,7 @@ const { data } = await client.createAgent(
|
|
|
217
270
|
|
|
218
271
|
### `listAgents`
|
|
219
272
|
|
|
220
|
-
|
|
221
|
-
Use query parameters to filter by source, availability, or entity schema.
|
|
273
|
+
List all agent configurations
|
|
222
274
|
|
|
223
275
|
`GET /v1/agents`
|
|
224
276
|
|
|
@@ -237,6 +289,7 @@ const { data } = await client.listAgents({
|
|
|
237
289
|
{
|
|
238
290
|
"agents": [
|
|
239
291
|
{
|
|
292
|
+
"domain": "customer_service",
|
|
240
293
|
"agent_id": "skill:email-categorizer",
|
|
241
294
|
"org_id": "string",
|
|
242
295
|
"name": "string",
|
|
@@ -279,6 +332,7 @@ const { data } = await client.listAgents({
|
|
|
279
332
|
],
|
|
280
333
|
"required": ["target_schema"]
|
|
281
334
|
},
|
|
335
|
+
"knowledge_source_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
|
|
282
336
|
"version": 0,
|
|
283
337
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
284
338
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
@@ -295,9 +349,7 @@ const { data } = await client.listAgents({
|
|
|
295
349
|
|
|
296
350
|
### `getAgentById`
|
|
297
351
|
|
|
298
|
-
|
|
299
|
-
- System skill IDs (prefixed): "skill:email-categorizer"
|
|
300
|
-
- Custom agent IDs (UUID): "0336a235-9417-4dd8-894c-fe81285bba75"
|
|
352
|
+
Get the agent configuration by ID
|
|
301
353
|
|
|
302
354
|
`GET /v1/agents/{agent_id}`
|
|
303
355
|
|
|
@@ -312,6 +364,7 @@ const { data } = await client.getAgentById({
|
|
|
312
364
|
|
|
313
365
|
```json
|
|
314
366
|
{
|
|
367
|
+
"domain": "customer_service",
|
|
315
368
|
"agent_id": "skill:email-categorizer",
|
|
316
369
|
"org_id": "string",
|
|
317
370
|
"name": "string",
|
|
@@ -354,6 +407,7 @@ const { data } = await client.getAgentById({
|
|
|
354
407
|
],
|
|
355
408
|
"required": ["target_schema"]
|
|
356
409
|
},
|
|
410
|
+
"knowledge_source_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
|
|
357
411
|
"version": 0,
|
|
358
412
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
359
413
|
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
@@ -367,7 +421,7 @@ const { data } = await client.getAgentById({
|
|
|
367
421
|
|
|
368
422
|
### `updateAgentById`
|
|
369
423
|
|
|
370
|
-
|
|
424
|
+
Update the agent configuration by ID
|
|
371
425
|
|
|
372
426
|
`PUT /v1/agents/{agent_id}`
|
|
373
427
|
|
|
@@ -377,6 +431,8 @@ const { data } = await client.updateAgentById(
|
|
|
377
431
|
agent_id: 'example',
|
|
378
432
|
},
|
|
379
433
|
{
|
|
434
|
+
domain: 'customer_service',
|
|
435
|
+
availability: ['flows'],
|
|
380
436
|
name: 'string',
|
|
381
437
|
description: 'string',
|
|
382
438
|
category: 'message',
|
|
@@ -414,7 +470,8 @@ const { data } = await client.updateAgentById(
|
|
|
414
470
|
/* ... 1 more */
|
|
415
471
|
],
|
|
416
472
|
required: ['target_schema']
|
|
417
|
-
}
|
|
473
|
+
},
|
|
474
|
+
knowledge_source_ids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6']
|
|
418
475
|
},
|
|
419
476
|
)
|
|
420
477
|
```
|
|
@@ -424,6 +481,7 @@ const { data } = await client.updateAgentById(
|
|
|
424
481
|
|
|
425
482
|
```json
|
|
426
483
|
{
|
|
484
|
+
"domain": "customer_service",
|
|
427
485
|
"agent_id": "skill:email-categorizer",
|
|
428
486
|
"org_id": "string",
|
|
429
487
|
"name": "string",
|
|
@@ -466,10 +524,739 @@ const { data } = await client.updateAgentById(
|
|
|
466
524
|
],
|
|
467
525
|
"required": ["target_schema"]
|
|
468
526
|
},
|
|
527
|
+
"knowledge_source_ids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6"],
|
|
469
528
|
"version": 0,
|
|
470
529
|
"created_at": "1970-01-01T00:00:00.000Z",
|
|
471
|
-
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
472
|
-
"created_by": "string"
|
|
530
|
+
"updated_at": "1970-01-01T00:00:00.000Z",
|
|
531
|
+
"created_by": "string"
|
|
532
|
+
}
|
|
533
|
+
```
|
|
534
|
+
|
|
535
|
+
</details>
|
|
536
|
+
|
|
537
|
+
---
|
|
538
|
+
|
|
539
|
+
### `deleteAgentById`
|
|
540
|
+
|
|
541
|
+
Delete the agent configuration by ID
|
|
542
|
+
|
|
543
|
+
`DELETE /v1/agents/{agent_id}`
|
|
544
|
+
|
|
545
|
+
```ts
|
|
546
|
+
const { data } = await client.deleteAgentById({
|
|
547
|
+
agent_id: 'example',
|
|
548
|
+
})
|
|
549
|
+
```
|
|
550
|
+
|
|
551
|
+
---
|
|
552
|
+
|
|
553
|
+
### `listCustomerChat`
|
|
554
|
+
|
|
555
|
+
List customer chat agents
|
|
556
|
+
|
|
557
|
+
`GET /v1/customer-chat`
|
|
558
|
+
|
|
559
|
+
```ts
|
|
560
|
+
const { data } = await client.listCustomerChat()
|
|
561
|
+
```
|
|
562
|
+
|
|
563
|
+
<details>
|
|
564
|
+
<summary>Response</summary>
|
|
565
|
+
|
|
566
|
+
```json
|
|
567
|
+
{
|
|
568
|
+
"agents": [
|
|
569
|
+
{
|
|
570
|
+
"org_id": "string",
|
|
571
|
+
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
572
|
+
"place": "website",
|
|
573
|
+
"internal_name": "string",
|
|
574
|
+
"runtime_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
575
|
+
"config": {
|
|
576
|
+
"capabilities": [
|
|
577
|
+
{
|
|
578
|
+
"type": "navigate_portal_pages",
|
|
579
|
+
"instanceId": "string",
|
|
580
|
+
"enabled": true,
|
|
581
|
+
"meterTypes": ["string"],
|
|
582
|
+
"ticketType": "string",
|
|
583
|
+
"allowedDomains": ["string"],
|
|
584
|
+
"autonomy": "draft",
|
|
585
|
+
"label": "string",
|
|
586
|
+
"guidance": "string",
|
|
587
|
+
"blockIds": ["string"],
|
|
588
|
+
"integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
589
|
+
"searchDeviceDocs": true
|
|
590
|
+
}
|
|
591
|
+
],
|
|
592
|
+
"knowledgeSources": [
|
|
593
|
+
{
|
|
594
|
+
"id": "string",
|
|
595
|
+
"type": "portal_page",
|
|
596
|
+
"title": "string",
|
|
597
|
+
"targetId": "string",
|
|
598
|
+
"detail": "string"
|
|
599
|
+
}
|
|
600
|
+
],
|
|
601
|
+
"escalation": {
|
|
602
|
+
"websiteHandover": {
|
|
603
|
+
"kind": "phone",
|
|
604
|
+
"value": "string",
|
|
605
|
+
"journeyId": "string",
|
|
606
|
+
"journeyName": "string"
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
"appearance": {
|
|
610
|
+
"displayName": "string",
|
|
611
|
+
"greeting": "string",
|
|
612
|
+
"starters": ["string"],
|
|
613
|
+
"language": "de",
|
|
614
|
+
"formOfAddress": "sie",
|
|
615
|
+
"languages": ["de"],
|
|
616
|
+
"translations": {
|
|
617
|
+
"de": {
|
|
618
|
+
"displayName": "string",
|
|
619
|
+
"greeting": "string",
|
|
620
|
+
"starters": ["string"]
|
|
621
|
+
},
|
|
622
|
+
"en": {
|
|
623
|
+
"displayName": "string",
|
|
624
|
+
"greeting": "string",
|
|
625
|
+
"starters": ["string"]
|
|
626
|
+
}
|
|
627
|
+
},
|
|
628
|
+
"needsReview": {
|
|
629
|
+
"de": ["displayName"],
|
|
630
|
+
"en": ["displayName"]
|
|
631
|
+
}
|
|
632
|
+
},
|
|
633
|
+
"instructions": "string",
|
|
634
|
+
"instructionTranslations": {
|
|
635
|
+
"de": "string",
|
|
636
|
+
"en": "string"
|
|
637
|
+
},
|
|
638
|
+
"instructionsNeedsReview": ["de"]
|
|
639
|
+
},
|
|
640
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
641
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
642
|
+
}
|
|
643
|
+
]
|
|
644
|
+
}
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
</details>
|
|
648
|
+
|
|
649
|
+
---
|
|
650
|
+
|
|
651
|
+
### `createCustomerChatAgent`
|
|
652
|
+
|
|
653
|
+
Create a customer chat agent with default config
|
|
654
|
+
|
|
655
|
+
`POST /v1/customer-chat`
|
|
656
|
+
|
|
657
|
+
```ts
|
|
658
|
+
const { data } = await client.createCustomerChatAgent(
|
|
659
|
+
null,
|
|
660
|
+
{
|
|
661
|
+
place: 'website',
|
|
662
|
+
internal_name: 'string'
|
|
663
|
+
},
|
|
664
|
+
)
|
|
665
|
+
```
|
|
666
|
+
|
|
667
|
+
<details>
|
|
668
|
+
<summary>Response</summary>
|
|
669
|
+
|
|
670
|
+
```json
|
|
671
|
+
{
|
|
672
|
+
"org_id": "string",
|
|
673
|
+
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
674
|
+
"place": "website",
|
|
675
|
+
"internal_name": "string",
|
|
676
|
+
"runtime_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
677
|
+
"config": {
|
|
678
|
+
"capabilities": [
|
|
679
|
+
{
|
|
680
|
+
"type": "navigate_portal_pages",
|
|
681
|
+
"instanceId": "string",
|
|
682
|
+
"enabled": true,
|
|
683
|
+
"meterTypes": ["string"],
|
|
684
|
+
"ticketType": "string",
|
|
685
|
+
"allowedDomains": ["string"],
|
|
686
|
+
"autonomy": "draft",
|
|
687
|
+
"label": "string",
|
|
688
|
+
"guidance": "string",
|
|
689
|
+
"blockIds": ["string"],
|
|
690
|
+
"integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
691
|
+
"searchDeviceDocs": true
|
|
692
|
+
}
|
|
693
|
+
],
|
|
694
|
+
"knowledgeSources": [
|
|
695
|
+
{
|
|
696
|
+
"id": "string",
|
|
697
|
+
"type": "portal_page",
|
|
698
|
+
"title": "string",
|
|
699
|
+
"targetId": "string",
|
|
700
|
+
"detail": "string"
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"escalation": {
|
|
704
|
+
"websiteHandover": {
|
|
705
|
+
"kind": "phone",
|
|
706
|
+
"value": "string",
|
|
707
|
+
"journeyId": "string",
|
|
708
|
+
"journeyName": "string"
|
|
709
|
+
}
|
|
710
|
+
},
|
|
711
|
+
"appearance": {
|
|
712
|
+
"displayName": "string",
|
|
713
|
+
"greeting": "string",
|
|
714
|
+
"starters": ["string"],
|
|
715
|
+
"language": "de",
|
|
716
|
+
"formOfAddress": "sie",
|
|
717
|
+
"languages": ["de"],
|
|
718
|
+
"translations": {
|
|
719
|
+
"de": {
|
|
720
|
+
"displayName": "string",
|
|
721
|
+
"greeting": "string",
|
|
722
|
+
"starters": ["string"]
|
|
723
|
+
},
|
|
724
|
+
"en": {
|
|
725
|
+
"displayName": "string",
|
|
726
|
+
"greeting": "string",
|
|
727
|
+
"starters": ["string"]
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
"needsReview": {
|
|
731
|
+
"de": ["displayName"],
|
|
732
|
+
"en": ["displayName"]
|
|
733
|
+
}
|
|
734
|
+
},
|
|
735
|
+
"instructions": "string",
|
|
736
|
+
"instructionTranslations": {
|
|
737
|
+
"de": "string",
|
|
738
|
+
"en": "string"
|
|
739
|
+
},
|
|
740
|
+
"instructionsNeedsReview": ["de"]
|
|
741
|
+
},
|
|
742
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
743
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
744
|
+
}
|
|
745
|
+
```
|
|
746
|
+
|
|
747
|
+
</details>
|
|
748
|
+
|
|
749
|
+
---
|
|
750
|
+
|
|
751
|
+
### `listCustomerChatCapabilities`
|
|
752
|
+
|
|
753
|
+
List the capability catalog
|
|
754
|
+
|
|
755
|
+
`GET /v1/customer-chat/capabilities`
|
|
756
|
+
|
|
757
|
+
```ts
|
|
758
|
+
const { data } = await client.listCustomerChatCapabilities()
|
|
759
|
+
```
|
|
760
|
+
|
|
761
|
+
<details>
|
|
762
|
+
<summary>Response</summary>
|
|
763
|
+
|
|
764
|
+
```json
|
|
765
|
+
{
|
|
766
|
+
"capabilities": [
|
|
767
|
+
{
|
|
768
|
+
"id": "navigate_portal_pages",
|
|
769
|
+
"places": ["website"],
|
|
770
|
+
"singleInstance": true,
|
|
771
|
+
"requiresIntegration": true
|
|
772
|
+
}
|
|
773
|
+
]
|
|
774
|
+
}
|
|
775
|
+
```
|
|
776
|
+
|
|
777
|
+
</details>
|
|
778
|
+
|
|
779
|
+
---
|
|
780
|
+
|
|
781
|
+
### `getCustomerChatAgent`
|
|
782
|
+
|
|
783
|
+
Get a customer chat agent
|
|
784
|
+
|
|
785
|
+
`GET /v1/customer-chat/{agent_id}`
|
|
786
|
+
|
|
787
|
+
```ts
|
|
788
|
+
const { data } = await client.getCustomerChatAgent({
|
|
789
|
+
agent_id: 'example',
|
|
790
|
+
})
|
|
791
|
+
```
|
|
792
|
+
|
|
793
|
+
<details>
|
|
794
|
+
<summary>Response</summary>
|
|
795
|
+
|
|
796
|
+
```json
|
|
797
|
+
{
|
|
798
|
+
"org_id": "string",
|
|
799
|
+
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
800
|
+
"place": "website",
|
|
801
|
+
"internal_name": "string",
|
|
802
|
+
"runtime_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
803
|
+
"config": {
|
|
804
|
+
"capabilities": [
|
|
805
|
+
{
|
|
806
|
+
"type": "navigate_portal_pages",
|
|
807
|
+
"instanceId": "string",
|
|
808
|
+
"enabled": true,
|
|
809
|
+
"meterTypes": ["string"],
|
|
810
|
+
"ticketType": "string",
|
|
811
|
+
"allowedDomains": ["string"],
|
|
812
|
+
"autonomy": "draft",
|
|
813
|
+
"label": "string",
|
|
814
|
+
"guidance": "string",
|
|
815
|
+
"blockIds": ["string"],
|
|
816
|
+
"integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
817
|
+
"searchDeviceDocs": true
|
|
818
|
+
}
|
|
819
|
+
],
|
|
820
|
+
"knowledgeSources": [
|
|
821
|
+
{
|
|
822
|
+
"id": "string",
|
|
823
|
+
"type": "portal_page",
|
|
824
|
+
"title": "string",
|
|
825
|
+
"targetId": "string",
|
|
826
|
+
"detail": "string"
|
|
827
|
+
}
|
|
828
|
+
],
|
|
829
|
+
"escalation": {
|
|
830
|
+
"websiteHandover": {
|
|
831
|
+
"kind": "phone",
|
|
832
|
+
"value": "string",
|
|
833
|
+
"journeyId": "string",
|
|
834
|
+
"journeyName": "string"
|
|
835
|
+
}
|
|
836
|
+
},
|
|
837
|
+
"appearance": {
|
|
838
|
+
"displayName": "string",
|
|
839
|
+
"greeting": "string",
|
|
840
|
+
"starters": ["string"],
|
|
841
|
+
"language": "de",
|
|
842
|
+
"formOfAddress": "sie",
|
|
843
|
+
"languages": ["de"],
|
|
844
|
+
"translations": {
|
|
845
|
+
"de": {
|
|
846
|
+
"displayName": "string",
|
|
847
|
+
"greeting": "string",
|
|
848
|
+
"starters": ["string"]
|
|
849
|
+
},
|
|
850
|
+
"en": {
|
|
851
|
+
"displayName": "string",
|
|
852
|
+
"greeting": "string",
|
|
853
|
+
"starters": ["string"]
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
"needsReview": {
|
|
857
|
+
"de": ["displayName"],
|
|
858
|
+
"en": ["displayName"]
|
|
859
|
+
}
|
|
860
|
+
},
|
|
861
|
+
"instructions": "string",
|
|
862
|
+
"instructionTranslations": {
|
|
863
|
+
"de": "string",
|
|
864
|
+
"en": "string"
|
|
865
|
+
},
|
|
866
|
+
"instructionsNeedsReview": ["de"]
|
|
867
|
+
},
|
|
868
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
869
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
870
|
+
}
|
|
871
|
+
```
|
|
872
|
+
|
|
873
|
+
</details>
|
|
874
|
+
|
|
875
|
+
---
|
|
876
|
+
|
|
877
|
+
### `renameCustomerChatAgent`
|
|
878
|
+
|
|
879
|
+
Rename a customer chat agent
|
|
880
|
+
|
|
881
|
+
`PATCH /v1/customer-chat/{agent_id}`
|
|
882
|
+
|
|
883
|
+
```ts
|
|
884
|
+
const { data } = await client.renameCustomerChatAgent(
|
|
885
|
+
{
|
|
886
|
+
agent_id: 'example',
|
|
887
|
+
If-Match: 'example',
|
|
888
|
+
},
|
|
889
|
+
{
|
|
890
|
+
internal_name: 'string',
|
|
891
|
+
updated_at: '1970-01-01T00:00:00.000Z'
|
|
892
|
+
},
|
|
893
|
+
)
|
|
894
|
+
```
|
|
895
|
+
|
|
896
|
+
<details>
|
|
897
|
+
<summary>Response</summary>
|
|
898
|
+
|
|
899
|
+
```json
|
|
900
|
+
{
|
|
901
|
+
"org_id": "string",
|
|
902
|
+
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
903
|
+
"place": "website",
|
|
904
|
+
"internal_name": "string",
|
|
905
|
+
"runtime_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
906
|
+
"config": {
|
|
907
|
+
"capabilities": [
|
|
908
|
+
{
|
|
909
|
+
"type": "navigate_portal_pages",
|
|
910
|
+
"instanceId": "string",
|
|
911
|
+
"enabled": true,
|
|
912
|
+
"meterTypes": ["string"],
|
|
913
|
+
"ticketType": "string",
|
|
914
|
+
"allowedDomains": ["string"],
|
|
915
|
+
"autonomy": "draft",
|
|
916
|
+
"label": "string",
|
|
917
|
+
"guidance": "string",
|
|
918
|
+
"blockIds": ["string"],
|
|
919
|
+
"integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
920
|
+
"searchDeviceDocs": true
|
|
921
|
+
}
|
|
922
|
+
],
|
|
923
|
+
"knowledgeSources": [
|
|
924
|
+
{
|
|
925
|
+
"id": "string",
|
|
926
|
+
"type": "portal_page",
|
|
927
|
+
"title": "string",
|
|
928
|
+
"targetId": "string",
|
|
929
|
+
"detail": "string"
|
|
930
|
+
}
|
|
931
|
+
],
|
|
932
|
+
"escalation": {
|
|
933
|
+
"websiteHandover": {
|
|
934
|
+
"kind": "phone",
|
|
935
|
+
"value": "string",
|
|
936
|
+
"journeyId": "string",
|
|
937
|
+
"journeyName": "string"
|
|
938
|
+
}
|
|
939
|
+
},
|
|
940
|
+
"appearance": {
|
|
941
|
+
"displayName": "string",
|
|
942
|
+
"greeting": "string",
|
|
943
|
+
"starters": ["string"],
|
|
944
|
+
"language": "de",
|
|
945
|
+
"formOfAddress": "sie",
|
|
946
|
+
"languages": ["de"],
|
|
947
|
+
"translations": {
|
|
948
|
+
"de": {
|
|
949
|
+
"displayName": "string",
|
|
950
|
+
"greeting": "string",
|
|
951
|
+
"starters": ["string"]
|
|
952
|
+
},
|
|
953
|
+
"en": {
|
|
954
|
+
"displayName": "string",
|
|
955
|
+
"greeting": "string",
|
|
956
|
+
"starters": ["string"]
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"needsReview": {
|
|
960
|
+
"de": ["displayName"],
|
|
961
|
+
"en": ["displayName"]
|
|
962
|
+
}
|
|
963
|
+
},
|
|
964
|
+
"instructions": "string",
|
|
965
|
+
"instructionTranslations": {
|
|
966
|
+
"de": "string",
|
|
967
|
+
"en": "string"
|
|
968
|
+
},
|
|
969
|
+
"instructionsNeedsReview": ["de"]
|
|
970
|
+
},
|
|
971
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
972
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
973
|
+
}
|
|
974
|
+
```
|
|
975
|
+
|
|
976
|
+
</details>
|
|
977
|
+
|
|
978
|
+
---
|
|
979
|
+
|
|
980
|
+
### `deleteCustomerChatAgent`
|
|
981
|
+
|
|
982
|
+
Remove a customer chat agent and its runtime projection
|
|
983
|
+
|
|
984
|
+
`DELETE /v1/customer-chat/{agent_id}`
|
|
985
|
+
|
|
986
|
+
```ts
|
|
987
|
+
const { data } = await client.deleteCustomerChatAgent(
|
|
988
|
+
{
|
|
989
|
+
agent_id: 'example',
|
|
990
|
+
If-Match: 'example',
|
|
991
|
+
},
|
|
992
|
+
{
|
|
993
|
+
updated_at: '1970-01-01T00:00:00.000Z',
|
|
994
|
+
portal_id: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
|
|
995
|
+
},
|
|
996
|
+
)
|
|
997
|
+
```
|
|
998
|
+
|
|
999
|
+
---
|
|
1000
|
+
|
|
1001
|
+
### `saveCustomerChatConfig`
|
|
1002
|
+
|
|
1003
|
+
Replace the AgentConfig and compile the runtime AgentRecord
|
|
1004
|
+
|
|
1005
|
+
`PUT /v1/customer-chat/{agent_id}/config`
|
|
1006
|
+
|
|
1007
|
+
```ts
|
|
1008
|
+
const { data } = await client.saveCustomerChatConfig(
|
|
1009
|
+
{
|
|
1010
|
+
agent_id: 'example',
|
|
1011
|
+
If-Match: 'example',
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
config: {
|
|
1015
|
+
capabilities: [
|
|
1016
|
+
{
|
|
1017
|
+
type: 'navigate_portal_pages',
|
|
1018
|
+
instanceId: 'string',
|
|
1019
|
+
enabled: true,
|
|
1020
|
+
meterTypes: ['string'],
|
|
1021
|
+
ticketType: 'string',
|
|
1022
|
+
allowedDomains: ['string'],
|
|
1023
|
+
autonomy: 'draft',
|
|
1024
|
+
label: 'string',
|
|
1025
|
+
guidance: 'string',
|
|
1026
|
+
blockIds: ['string'],
|
|
1027
|
+
integrationId: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
|
|
1028
|
+
searchDeviceDocs: true
|
|
1029
|
+
}
|
|
1030
|
+
],
|
|
1031
|
+
knowledgeSources: [
|
|
1032
|
+
{
|
|
1033
|
+
id: 'string',
|
|
1034
|
+
type: 'portal_page',
|
|
1035
|
+
title: 'string',
|
|
1036
|
+
targetId: 'string',
|
|
1037
|
+
detail: 'string'
|
|
1038
|
+
}
|
|
1039
|
+
],
|
|
1040
|
+
escalation: {
|
|
1041
|
+
websiteHandover: {
|
|
1042
|
+
kind: 'phone',
|
|
1043
|
+
value: 'string',
|
|
1044
|
+
journeyId: 'string',
|
|
1045
|
+
journeyName: 'string'
|
|
1046
|
+
}
|
|
1047
|
+
},
|
|
1048
|
+
appearance: {
|
|
1049
|
+
displayName: 'string',
|
|
1050
|
+
greeting: 'string',
|
|
1051
|
+
starters: ['string'],
|
|
1052
|
+
language: 'de',
|
|
1053
|
+
formOfAddress: 'sie',
|
|
1054
|
+
languages: ['de'],
|
|
1055
|
+
translations: {
|
|
1056
|
+
de: {
|
|
1057
|
+
displayName: 'string',
|
|
1058
|
+
greeting: 'string',
|
|
1059
|
+
starters: ['string']
|
|
1060
|
+
},
|
|
1061
|
+
en: {
|
|
1062
|
+
displayName: 'string',
|
|
1063
|
+
greeting: 'string',
|
|
1064
|
+
starters: ['string']
|
|
1065
|
+
}
|
|
1066
|
+
},
|
|
1067
|
+
needsReview: {
|
|
1068
|
+
de: ['displayName'],
|
|
1069
|
+
en: ['displayName']
|
|
1070
|
+
}
|
|
1071
|
+
},
|
|
1072
|
+
instructions: 'string',
|
|
1073
|
+
instructionTranslations: {
|
|
1074
|
+
de: 'string',
|
|
1075
|
+
en: 'string'
|
|
1076
|
+
},
|
|
1077
|
+
instructionsNeedsReview: ['de']
|
|
1078
|
+
},
|
|
1079
|
+
updated_at: '1970-01-01T00:00:00.000Z'
|
|
1080
|
+
},
|
|
1081
|
+
)
|
|
1082
|
+
```
|
|
1083
|
+
|
|
1084
|
+
<details>
|
|
1085
|
+
<summary>Response</summary>
|
|
1086
|
+
|
|
1087
|
+
```json
|
|
1088
|
+
{
|
|
1089
|
+
"org_id": "string",
|
|
1090
|
+
"agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1091
|
+
"place": "website",
|
|
1092
|
+
"internal_name": "string",
|
|
1093
|
+
"runtime_agent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1094
|
+
"config": {
|
|
1095
|
+
"capabilities": [
|
|
1096
|
+
{
|
|
1097
|
+
"type": "navigate_portal_pages",
|
|
1098
|
+
"instanceId": "string",
|
|
1099
|
+
"enabled": true,
|
|
1100
|
+
"meterTypes": ["string"],
|
|
1101
|
+
"ticketType": "string",
|
|
1102
|
+
"allowedDomains": ["string"],
|
|
1103
|
+
"autonomy": "draft",
|
|
1104
|
+
"label": "string",
|
|
1105
|
+
"guidance": "string",
|
|
1106
|
+
"blockIds": ["string"],
|
|
1107
|
+
"integrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1108
|
+
"searchDeviceDocs": true
|
|
1109
|
+
}
|
|
1110
|
+
],
|
|
1111
|
+
"knowledgeSources": [
|
|
1112
|
+
{
|
|
1113
|
+
"id": "string",
|
|
1114
|
+
"type": "portal_page",
|
|
1115
|
+
"title": "string",
|
|
1116
|
+
"targetId": "string",
|
|
1117
|
+
"detail": "string"
|
|
1118
|
+
}
|
|
1119
|
+
],
|
|
1120
|
+
"escalation": {
|
|
1121
|
+
"websiteHandover": {
|
|
1122
|
+
"kind": "phone",
|
|
1123
|
+
"value": "string",
|
|
1124
|
+
"journeyId": "string",
|
|
1125
|
+
"journeyName": "string"
|
|
1126
|
+
}
|
|
1127
|
+
},
|
|
1128
|
+
"appearance": {
|
|
1129
|
+
"displayName": "string",
|
|
1130
|
+
"greeting": "string",
|
|
1131
|
+
"starters": ["string"],
|
|
1132
|
+
"language": "de",
|
|
1133
|
+
"formOfAddress": "sie",
|
|
1134
|
+
"languages": ["de"],
|
|
1135
|
+
"translations": {
|
|
1136
|
+
"de": {
|
|
1137
|
+
"displayName": "string",
|
|
1138
|
+
"greeting": "string",
|
|
1139
|
+
"starters": ["string"]
|
|
1140
|
+
},
|
|
1141
|
+
"en": {
|
|
1142
|
+
"displayName": "string",
|
|
1143
|
+
"greeting": "string",
|
|
1144
|
+
"starters": ["string"]
|
|
1145
|
+
}
|
|
1146
|
+
},
|
|
1147
|
+
"needsReview": {
|
|
1148
|
+
"de": ["displayName"],
|
|
1149
|
+
"en": ["displayName"]
|
|
1150
|
+
}
|
|
1151
|
+
},
|
|
1152
|
+
"instructions": "string",
|
|
1153
|
+
"instructionTranslations": {
|
|
1154
|
+
"de": "string",
|
|
1155
|
+
"en": "string"
|
|
1156
|
+
},
|
|
1157
|
+
"instructionsNeedsReview": ["de"]
|
|
1158
|
+
},
|
|
1159
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1160
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
1161
|
+
}
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
</details>
|
|
1165
|
+
|
|
1166
|
+
---
|
|
1167
|
+
|
|
1168
|
+
### `listKnowledgeSources`
|
|
1169
|
+
|
|
1170
|
+
List knowledge sources
|
|
1171
|
+
|
|
1172
|
+
`GET /v1/knowledge/sources`
|
|
1173
|
+
|
|
1174
|
+
```ts
|
|
1175
|
+
const { data } = await client.listKnowledgeSources()
|
|
1176
|
+
```
|
|
1177
|
+
|
|
1178
|
+
<details>
|
|
1179
|
+
<summary>Response</summary>
|
|
1180
|
+
|
|
1181
|
+
```json
|
|
1182
|
+
{
|
|
1183
|
+
"sources": [
|
|
1184
|
+
{
|
|
1185
|
+
"type": "file",
|
|
1186
|
+
"source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1187
|
+
"filename": "string",
|
|
1188
|
+
"mime_type": "string",
|
|
1189
|
+
"size_bytes": 0,
|
|
1190
|
+
"ready": true,
|
|
1191
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1192
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
1193
|
+
}
|
|
1194
|
+
]
|
|
1195
|
+
}
|
|
1196
|
+
```
|
|
1197
|
+
|
|
1198
|
+
</details>
|
|
1199
|
+
|
|
1200
|
+
---
|
|
1201
|
+
|
|
1202
|
+
### `createKnowledgeFileUpload`
|
|
1203
|
+
|
|
1204
|
+
Create a knowledge file upload
|
|
1205
|
+
|
|
1206
|
+
`POST /v1/knowledge/file-uploads`
|
|
1207
|
+
|
|
1208
|
+
```ts
|
|
1209
|
+
const { data } = await client.createKnowledgeFileUpload(
|
|
1210
|
+
null,
|
|
1211
|
+
{
|
|
1212
|
+
filename: 'string',
|
|
1213
|
+
mime_type: 'string',
|
|
1214
|
+
size_bytes: 1
|
|
1215
|
+
},
|
|
1216
|
+
)
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
<details>
|
|
1220
|
+
<summary>Response</summary>
|
|
1221
|
+
|
|
1222
|
+
```json
|
|
1223
|
+
{
|
|
1224
|
+
"source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1225
|
+
"upload_url": "https://example.com/path",
|
|
1226
|
+
"upload_fields": {},
|
|
1227
|
+
"expires_at": "1970-01-01T00:00:00.000Z"
|
|
1228
|
+
}
|
|
1229
|
+
```
|
|
1230
|
+
|
|
1231
|
+
</details>
|
|
1232
|
+
|
|
1233
|
+
---
|
|
1234
|
+
|
|
1235
|
+
### `getKnowledgeSource`
|
|
1236
|
+
|
|
1237
|
+
Get a knowledge source
|
|
1238
|
+
|
|
1239
|
+
`GET /v1/knowledge/sources/{source_id}`
|
|
1240
|
+
|
|
1241
|
+
```ts
|
|
1242
|
+
const { data } = await client.getKnowledgeSource({
|
|
1243
|
+
source_id: 'example',
|
|
1244
|
+
})
|
|
1245
|
+
```
|
|
1246
|
+
|
|
1247
|
+
<details>
|
|
1248
|
+
<summary>Response</summary>
|
|
1249
|
+
|
|
1250
|
+
```json
|
|
1251
|
+
{
|
|
1252
|
+
"type": "file",
|
|
1253
|
+
"source_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
|
|
1254
|
+
"filename": "string",
|
|
1255
|
+
"mime_type": "string",
|
|
1256
|
+
"size_bytes": 0,
|
|
1257
|
+
"ready": true,
|
|
1258
|
+
"created_at": "1970-01-01T00:00:00.000Z",
|
|
1259
|
+
"updated_at": "1970-01-01T00:00:00.000Z"
|
|
473
1260
|
}
|
|
474
1261
|
```
|
|
475
1262
|
|
|
@@ -477,15 +1264,15 @@ const { data } = await client.updateAgentById(
|
|
|
477
1264
|
|
|
478
1265
|
---
|
|
479
1266
|
|
|
480
|
-
### `
|
|
1267
|
+
### `deleteKnowledgeSource`
|
|
481
1268
|
|
|
482
|
-
|
|
1269
|
+
Delete a knowledge source
|
|
483
1270
|
|
|
484
|
-
`DELETE /v1/
|
|
1271
|
+
`DELETE /v1/knowledge/sources/{source_id}`
|
|
485
1272
|
|
|
486
1273
|
```ts
|
|
487
|
-
const { data } = await client.
|
|
488
|
-
|
|
1274
|
+
const { data } = await client.deleteKnowledgeSource({
|
|
1275
|
+
source_id: 'example',
|
|
489
1276
|
})
|
|
490
1277
|
```
|
|
491
1278
|
|
|
@@ -493,10 +1280,7 @@ const { data } = await client.deleteAgentById({
|
|
|
493
1280
|
|
|
494
1281
|
### `executeAgent`
|
|
495
1282
|
|
|
496
|
-
|
|
497
|
-
Supports both:
|
|
498
|
-
- System skill IDs (prefixed): "skill:email-categorizer"
|
|
499
|
-
- Custom agent IDs (UUID): "0336a235-9417-4dd8-894c-fe81285bba75"
|
|
1283
|
+
Execute an agent
|
|
500
1284
|
|
|
501
1285
|
`POST /v1/agents/{agent_id}/execute`
|
|
502
1286
|
|
|
@@ -506,7 +1290,9 @@ const { data } = await client.executeAgent(
|
|
|
506
1290
|
agent_id: 'example',
|
|
507
1291
|
},
|
|
508
1292
|
{
|
|
1293
|
+
mode: 'auto',
|
|
509
1294
|
input: {
|
|
1295
|
+
message: 'string',
|
|
510
1296
|
entity_id: 'string',
|
|
511
1297
|
entity_schema: 'string',
|
|
512
1298
|
workflow_id: 'string',
|
|
@@ -518,7 +1304,15 @@ const { data } = await client.executeAgent(
|
|
|
518
1304
|
entity_id: 'string',
|
|
519
1305
|
entity_schema: 'string'
|
|
520
1306
|
}
|
|
521
|
-
]
|
|
1307
|
+
],
|
|
1308
|
+
attachment: {
|
|
1309
|
+
s3ref: {
|
|
1310
|
+
bucket: 'string',
|
|
1311
|
+
key: 'string'
|
|
1312
|
+
},
|
|
1313
|
+
mime_type: 'string',
|
|
1314
|
+
filename: 'string'
|
|
1315
|
+
}
|
|
522
1316
|
},
|
|
523
1317
|
parameters: {},
|
|
524
1318
|
execution_mode_override: 'automatic',
|
|
@@ -632,9 +1426,7 @@ const { data } = await client.executeAgent(
|
|
|
632
1426
|
|
|
633
1427
|
### `executeAgentStream`
|
|
634
1428
|
|
|
635
|
-
|
|
636
|
-
Returns Server-Sent Events (SSE) stream with token-by-token output,
|
|
637
|
-
tool call progress, and completion status.
|
|
1429
|
+
Execute an agent with streaming response
|
|
638
1430
|
|
|
639
1431
|
`POST /v1/agents/{agent_id}/execute/stream`
|
|
640
1432
|
|
|
@@ -644,7 +1436,9 @@ const { data } = await client.executeAgentStream(
|
|
|
644
1436
|
agent_id: 'example',
|
|
645
1437
|
},
|
|
646
1438
|
{
|
|
1439
|
+
mode: 'auto',
|
|
647
1440
|
input: {
|
|
1441
|
+
message: 'string',
|
|
648
1442
|
entity_id: 'string',
|
|
649
1443
|
entity_schema: 'string',
|
|
650
1444
|
workflow_id: 'string',
|
|
@@ -656,7 +1450,15 @@ const { data } = await client.executeAgentStream(
|
|
|
656
1450
|
entity_id: 'string',
|
|
657
1451
|
entity_schema: 'string'
|
|
658
1452
|
}
|
|
659
|
-
]
|
|
1453
|
+
],
|
|
1454
|
+
attachment: {
|
|
1455
|
+
s3ref: {
|
|
1456
|
+
bucket: 'string',
|
|
1457
|
+
key: 'string'
|
|
1458
|
+
},
|
|
1459
|
+
mime_type: 'string',
|
|
1460
|
+
filename: 'string'
|
|
1461
|
+
}
|
|
660
1462
|
},
|
|
661
1463
|
parameters: {},
|
|
662
1464
|
execution_mode_override: 'automatic',
|
|
@@ -1017,7 +1819,7 @@ const { data } = await client.cancelExecution({
|
|
|
1017
1819
|
|
|
1018
1820
|
### `getExecutionTrace`
|
|
1019
1821
|
|
|
1020
|
-
|
|
1822
|
+
Get execution trace/iterations
|
|
1021
1823
|
|
|
1022
1824
|
`GET /v1/executions/{execution_id}/trace`
|
|
1023
1825
|
|
|
@@ -1123,7 +1925,7 @@ const { data } = await client.putExecutionFeedback(
|
|
|
1123
1925
|
|
|
1124
1926
|
### `approveExecution`
|
|
1125
1927
|
|
|
1126
|
-
|
|
1928
|
+
Approve pending action
|
|
1127
1929
|
|
|
1128
1930
|
`POST /v1/executions/{execution_id}/approve`
|
|
1129
1931
|
|
|
@@ -1243,7 +2045,7 @@ const { data } = await client.approveExecution(
|
|
|
1243
2045
|
|
|
1244
2046
|
### `rejectExecution`
|
|
1245
2047
|
|
|
1246
|
-
|
|
2048
|
+
Reject pending action
|
|
1247
2049
|
|
|
1248
2050
|
`POST /v1/executions/{execution_id}/reject`
|
|
1249
2051
|
|
|
@@ -1361,7 +2163,7 @@ const { data } = await client.rejectExecution(
|
|
|
1361
2163
|
|
|
1362
2164
|
### `streamExecution`
|
|
1363
2165
|
|
|
1364
|
-
|
|
2166
|
+
Reconnect to execution stream
|
|
1365
2167
|
|
|
1366
2168
|
`GET /v1/executions/{execution_id}/stream`
|
|
1367
2169
|
|
|
@@ -1376,7 +2178,7 @@ const { data } = await client.streamExecution({
|
|
|
1376
2178
|
|
|
1377
2179
|
### `chat`
|
|
1378
2180
|
|
|
1379
|
-
|
|
2181
|
+
Streaming chat with AI agent
|
|
1380
2182
|
|
|
1381
2183
|
`POST /v1/chat`
|
|
1382
2184
|
|
|
@@ -1409,7 +2211,8 @@ const { data } = await client.chat(
|
|
|
1409
2211
|
mode: 'updates',
|
|
1410
2212
|
streamTokens: false,
|
|
1411
2213
|
includeMetadata: false
|
|
1412
|
-
}
|
|
2214
|
+
},
|
|
2215
|
+
preview_demo: true
|
|
1413
2216
|
},
|
|
1414
2217
|
)
|
|
1415
2218
|
```
|
|
@@ -1418,7 +2221,7 @@ const { data } = await client.chat(
|
|
|
1418
2221
|
|
|
1419
2222
|
### `listConversations`
|
|
1420
2223
|
|
|
1421
|
-
|
|
2224
|
+
List conversations
|
|
1422
2225
|
|
|
1423
2226
|
`GET /v1/conversations`
|
|
1424
2227
|
|
|
@@ -1462,7 +2265,7 @@ const { data } = await client.listConversations({
|
|
|
1462
2265
|
|
|
1463
2266
|
### `getConversation`
|
|
1464
2267
|
|
|
1465
|
-
|
|
2268
|
+
Get conversation with messages
|
|
1466
2269
|
|
|
1467
2270
|
`GET /v1/conversations/{conversation_id}`
|
|
1468
2271
|
|
|
@@ -1526,7 +2329,7 @@ const { data } = await client.getConversation({
|
|
|
1526
2329
|
|
|
1527
2330
|
### `deleteConversation`
|
|
1528
2331
|
|
|
1529
|
-
|
|
2332
|
+
Delete conversation
|
|
1530
2333
|
|
|
1531
2334
|
`DELETE /v1/conversations/{conversation_id}`
|
|
1532
2335
|
|
|
@@ -1540,7 +2343,7 @@ const { data } = await client.deleteConversation({
|
|
|
1540
2343
|
|
|
1541
2344
|
### `submitConversationFeedback`
|
|
1542
2345
|
|
|
1543
|
-
|
|
2346
|
+
Submit feedback for an assistant turn
|
|
1544
2347
|
|
|
1545
2348
|
`POST /v1/conversations/{conversation_id}/feedback`
|
|
1546
2349
|
|
|
@@ -1577,6 +2380,401 @@ const { data } = await client.submitConversationFeedback(
|
|
|
1577
2380
|
|
|
1578
2381
|
## Schemas
|
|
1579
2382
|
|
|
2383
|
+
### `AgentConfig`
|
|
2384
|
+
|
|
2385
|
+
```ts
|
|
2386
|
+
type AgentConfig = {
|
|
2387
|
+
capabilities: Array<{
|
|
2388
|
+
type: "navigate_portal_pages" | "search_portal_records" | "view_billing" | "view_meter_readings" | "view_contracts" | "search_web" | "open_quick_actions" | "view_hems_energy"
|
|
2389
|
+
instanceId?: string
|
|
2390
|
+
enabled: boolean
|
|
2391
|
+
meterTypes?: string[]
|
|
2392
|
+
ticketType?: string
|
|
2393
|
+
allowedDomains?: string[]
|
|
2394
|
+
autonomy?: "draft" | "approval" | "automatic"
|
|
2395
|
+
label?: string
|
|
2396
|
+
guidance?: string
|
|
2397
|
+
blockIds?: string[]
|
|
2398
|
+
integrationId?: string // uuid
|
|
2399
|
+
searchDeviceDocs?: boolean
|
|
2400
|
+
}>
|
|
2401
|
+
knowledgeSources: Array<{
|
|
2402
|
+
id: string
|
|
2403
|
+
type: "portal_page" | "document" | "catalogue" | "url"
|
|
2404
|
+
title: string
|
|
2405
|
+
targetId: string
|
|
2406
|
+
detail?: string
|
|
2407
|
+
}>
|
|
2408
|
+
escalation: {
|
|
2409
|
+
websiteHandover: {
|
|
2410
|
+
kind: { ... }
|
|
2411
|
+
value: { ... }
|
|
2412
|
+
journeyId?: { ... }
|
|
2413
|
+
journeyName?: { ... }
|
|
2414
|
+
}
|
|
2415
|
+
}
|
|
2416
|
+
appearance: {
|
|
2417
|
+
displayName: string
|
|
2418
|
+
greeting: string
|
|
2419
|
+
starters: string[]
|
|
2420
|
+
language: "de" | "en"
|
|
2421
|
+
formOfAddress: "sie" | "du"
|
|
2422
|
+
languages?: "de" | "en"[]
|
|
2423
|
+
translations?: {
|
|
2424
|
+
de?: { ... }
|
|
2425
|
+
en?: { ... }
|
|
2426
|
+
}
|
|
2427
|
+
needsReview?: {
|
|
2428
|
+
de?: { ... }
|
|
2429
|
+
en?: { ... }
|
|
2430
|
+
}
|
|
2431
|
+
}
|
|
2432
|
+
instructions?: string
|
|
2433
|
+
instructionTranslations?: {
|
|
2434
|
+
de?: string
|
|
2435
|
+
en?: string
|
|
2436
|
+
}
|
|
2437
|
+
instructionsNeedsReview?: "de" | "en"[]
|
|
2438
|
+
}
|
|
2439
|
+
```
|
|
2440
|
+
|
|
2441
|
+
### `AppearanceConfig`
|
|
2442
|
+
|
|
2443
|
+
```ts
|
|
2444
|
+
type AppearanceConfig = {
|
|
2445
|
+
displayName: string
|
|
2446
|
+
greeting: string
|
|
2447
|
+
starters: string[]
|
|
2448
|
+
language: "de" | "en"
|
|
2449
|
+
formOfAddress: "sie" | "du"
|
|
2450
|
+
languages?: "de" | "en"[]
|
|
2451
|
+
translations?: {
|
|
2452
|
+
de?: {
|
|
2453
|
+
displayName: { ... }
|
|
2454
|
+
greeting: { ... }
|
|
2455
|
+
starters: { ... }
|
|
2456
|
+
}
|
|
2457
|
+
en?: {
|
|
2458
|
+
displayName: { ... }
|
|
2459
|
+
greeting: { ... }
|
|
2460
|
+
starters: { ... }
|
|
2461
|
+
}
|
|
2462
|
+
}
|
|
2463
|
+
needsReview?: {
|
|
2464
|
+
de?: "displayName" | "greeting" | "starters"[]
|
|
2465
|
+
en?: "displayName" | "greeting" | "starters"[]
|
|
2466
|
+
}
|
|
2467
|
+
}
|
|
2468
|
+
```
|
|
2469
|
+
|
|
2470
|
+
### `LocalizedAppearance`
|
|
2471
|
+
|
|
2472
|
+
```ts
|
|
2473
|
+
type LocalizedAppearance = {
|
|
2474
|
+
displayName: string
|
|
2475
|
+
greeting: string
|
|
2476
|
+
starters: string[]
|
|
2477
|
+
}
|
|
2478
|
+
```
|
|
2479
|
+
|
|
2480
|
+
### `LocalizedFieldList`
|
|
2481
|
+
|
|
2482
|
+
```ts
|
|
2483
|
+
type LocalizedFieldList = "displayName" | "greeting" | "starters"[]
|
|
2484
|
+
```
|
|
2485
|
+
|
|
2486
|
+
### `CapabilityId`
|
|
2487
|
+
|
|
2488
|
+
```ts
|
|
2489
|
+
type CapabilityId = "navigate_portal_pages" | "search_portal_records" | "view_billing" | "view_meter_readings" | "view_contracts" | "search_web" | "open_quick_actions" | "view_hems_energy"
|
|
2490
|
+
```
|
|
2491
|
+
|
|
2492
|
+
### `ActionAutonomy`
|
|
2493
|
+
|
|
2494
|
+
Action capabilities only (`open_quick_actions`): per-capability autonomy.
|
|
2495
|
+
`draft` = suggest only (proposal + deep link, nothing opens),
|
|
2496
|
+
`approval` = the customer confirms in a card first,
|
|
2497
|
+
`automatic` = run immediately. Defaults to `approval` when the
|
|
2498
|
+
capability is enabled without one; unknown values
|
|
2499
|
+
|
|
2500
|
+
```ts
|
|
2501
|
+
type ActionAutonomy = "draft" | "approval" | "automatic"
|
|
2502
|
+
```
|
|
2503
|
+
|
|
2504
|
+
### `CapabilityState`
|
|
2505
|
+
|
|
2506
|
+
```ts
|
|
2507
|
+
type CapabilityState = {
|
|
2508
|
+
enabled: boolean
|
|
2509
|
+
meterTypes?: string[]
|
|
2510
|
+
ticketType?: string
|
|
2511
|
+
allowedDomains?: string[]
|
|
2512
|
+
autonomy?: "draft" | "approval" | "automatic"
|
|
2513
|
+
label?: string
|
|
2514
|
+
guidance?: string
|
|
2515
|
+
blockIds?: string[]
|
|
2516
|
+
integrationId?: string // uuid
|
|
2517
|
+
searchDeviceDocs?: boolean
|
|
2518
|
+
}
|
|
2519
|
+
```
|
|
2520
|
+
|
|
2521
|
+
### `CapabilityInstance`
|
|
2522
|
+
|
|
2523
|
+
```ts
|
|
2524
|
+
type CapabilityInstance = {
|
|
2525
|
+
type: "navigate_portal_pages" | "search_portal_records" | "view_billing" | "view_meter_readings" | "view_contracts" | "search_web" | "open_quick_actions" | "view_hems_energy"
|
|
2526
|
+
instanceId?: string
|
|
2527
|
+
enabled: boolean
|
|
2528
|
+
meterTypes?: string[]
|
|
2529
|
+
ticketType?: string
|
|
2530
|
+
allowedDomains?: string[]
|
|
2531
|
+
autonomy?: "draft" | "approval" | "automatic"
|
|
2532
|
+
label?: string
|
|
2533
|
+
guidance?: string
|
|
2534
|
+
blockIds?: string[]
|
|
2535
|
+
integrationId?: string // uuid
|
|
2536
|
+
searchDeviceDocs?: boolean
|
|
2537
|
+
}
|
|
2538
|
+
```
|
|
2539
|
+
|
|
2540
|
+
### `CreateCustomerChatAgentRequest`
|
|
2541
|
+
|
|
2542
|
+
```ts
|
|
2543
|
+
type CreateCustomerChatAgentRequest = {
|
|
2544
|
+
place: "website" | "portal"
|
|
2545
|
+
internal_name?: string
|
|
2546
|
+
}
|
|
2547
|
+
```
|
|
2548
|
+
|
|
2549
|
+
### `CustomerChatAgent`
|
|
2550
|
+
|
|
2551
|
+
```ts
|
|
2552
|
+
type CustomerChatAgent = {
|
|
2553
|
+
org_id: string
|
|
2554
|
+
agent_id: string // uuid
|
|
2555
|
+
place: "website" | "portal"
|
|
2556
|
+
internal_name: string
|
|
2557
|
+
runtime_agent_id: string // uuid
|
|
2558
|
+
config: {
|
|
2559
|
+
capabilities: Array<{
|
|
2560
|
+
type: { ... }
|
|
2561
|
+
instanceId?: { ... }
|
|
2562
|
+
enabled: { ... }
|
|
2563
|
+
meterTypes?: { ... }
|
|
2564
|
+
ticketType?: { ... }
|
|
2565
|
+
allowedDomains?: { ... }
|
|
2566
|
+
autonomy?: { ... }
|
|
2567
|
+
label?: { ... }
|
|
2568
|
+
guidance?: { ... }
|
|
2569
|
+
blockIds?: { ... }
|
|
2570
|
+
integrationId?: { ... }
|
|
2571
|
+
searchDeviceDocs?: { ... }
|
|
2572
|
+
}>
|
|
2573
|
+
knowledgeSources: Array<{
|
|
2574
|
+
id: { ... }
|
|
2575
|
+
type: { ... }
|
|
2576
|
+
title: { ... }
|
|
2577
|
+
targetId: { ... }
|
|
2578
|
+
detail?: { ... }
|
|
2579
|
+
}>
|
|
2580
|
+
escalation: {
|
|
2581
|
+
websiteHandover: { ... }
|
|
2582
|
+
}
|
|
2583
|
+
appearance: {
|
|
2584
|
+
displayName: { ... }
|
|
2585
|
+
greeting: { ... }
|
|
2586
|
+
starters: { ... }
|
|
2587
|
+
language: { ... }
|
|
2588
|
+
formOfAddress: { ... }
|
|
2589
|
+
languages?: { ... }
|
|
2590
|
+
translations?: { ... }
|
|
2591
|
+
needsReview?: { ... }
|
|
2592
|
+
}
|
|
2593
|
+
instructions?: string
|
|
2594
|
+
instructionTranslations?: {
|
|
2595
|
+
de?: { ... }
|
|
2596
|
+
en?: { ... }
|
|
2597
|
+
}
|
|
2598
|
+
instructionsNeedsReview?: "de" | "en"[]
|
|
2599
|
+
}
|
|
2600
|
+
created_at: string // date-time
|
|
2601
|
+
updated_at: string // date-time
|
|
2602
|
+
}
|
|
2603
|
+
```
|
|
2604
|
+
|
|
2605
|
+
### `CustomerChatCasRequest`
|
|
2606
|
+
|
|
2607
|
+
```ts
|
|
2608
|
+
type CustomerChatCasRequest = {
|
|
2609
|
+
updated_at?: string // date-time
|
|
2610
|
+
}
|
|
2611
|
+
```
|
|
2612
|
+
|
|
2613
|
+
### `DeleteCustomerChatAgentRequest`
|
|
2614
|
+
|
|
2615
|
+
```ts
|
|
2616
|
+
type DeleteCustomerChatAgentRequest = {
|
|
2617
|
+
updated_at?: string // date-time
|
|
2618
|
+
portal_id?: string // uuid
|
|
2619
|
+
}
|
|
2620
|
+
```
|
|
2621
|
+
|
|
2622
|
+
### `CustomerChatPlace`
|
|
2623
|
+
|
|
2624
|
+
```ts
|
|
2625
|
+
type CustomerChatPlace = "website" | "portal"
|
|
2626
|
+
```
|
|
2627
|
+
|
|
2628
|
+
### `EscalationConfig`
|
|
2629
|
+
|
|
2630
|
+
```ts
|
|
2631
|
+
type EscalationConfig = {
|
|
2632
|
+
websiteHandover: {
|
|
2633
|
+
kind: "phone" | "email" | "journey" | "unset"
|
|
2634
|
+
value: string
|
|
2635
|
+
journeyId?: string
|
|
2636
|
+
journeyName?: string
|
|
2637
|
+
}
|
|
2638
|
+
}
|
|
2639
|
+
```
|
|
2640
|
+
|
|
2641
|
+
### `CustomerChatKnowledgeSource`
|
|
2642
|
+
|
|
2643
|
+
```ts
|
|
2644
|
+
type CustomerChatKnowledgeSource = {
|
|
2645
|
+
id: string
|
|
2646
|
+
type: "portal_page" | "document" | "catalogue" | "url"
|
|
2647
|
+
title: string
|
|
2648
|
+
targetId: string
|
|
2649
|
+
detail?: string
|
|
2650
|
+
}
|
|
2651
|
+
```
|
|
2652
|
+
|
|
2653
|
+
### `CustomerChatKnowledgeSourceType`
|
|
2654
|
+
|
|
2655
|
+
```ts
|
|
2656
|
+
type CustomerChatKnowledgeSourceType = "portal_page" | "document" | "catalogue" | "url"
|
|
2657
|
+
```
|
|
2658
|
+
|
|
2659
|
+
### `ListCustomerChatResponse`
|
|
2660
|
+
|
|
2661
|
+
```ts
|
|
2662
|
+
type ListCustomerChatResponse = {
|
|
2663
|
+
agents: Array<{
|
|
2664
|
+
org_id: string
|
|
2665
|
+
agent_id: string // uuid
|
|
2666
|
+
place: "website" | "portal"
|
|
2667
|
+
internal_name: string
|
|
2668
|
+
runtime_agent_id: string // uuid
|
|
2669
|
+
config: {
|
|
2670
|
+
capabilities: { ... }
|
|
2671
|
+
knowledgeSources: { ... }
|
|
2672
|
+
escalation: { ... }
|
|
2673
|
+
appearance: { ... }
|
|
2674
|
+
instructions?: { ... }
|
|
2675
|
+
instructionTranslations?: { ... }
|
|
2676
|
+
instructionsNeedsReview?: { ... }
|
|
2677
|
+
}
|
|
2678
|
+
created_at: string // date-time
|
|
2679
|
+
updated_at: string // date-time
|
|
2680
|
+
}>
|
|
2681
|
+
}
|
|
2682
|
+
```
|
|
2683
|
+
|
|
2684
|
+
### `CustomerChatCapabilityCatalogEntry`
|
|
2685
|
+
|
|
2686
|
+
```ts
|
|
2687
|
+
type CustomerChatCapabilityCatalogEntry = {
|
|
2688
|
+
id: "navigate_portal_pages" | "search_portal_records" | "view_billing" | "view_meter_readings" | "view_contracts" | "search_web" | "open_quick_actions" | "view_hems_energy"
|
|
2689
|
+
places: "website" | "portal"[]
|
|
2690
|
+
singleInstance?: boolean
|
|
2691
|
+
requiresIntegration?: boolean
|
|
2692
|
+
}
|
|
2693
|
+
```
|
|
2694
|
+
|
|
2695
|
+
### `ListCustomerChatCapabilitiesResponse`
|
|
2696
|
+
|
|
2697
|
+
```ts
|
|
2698
|
+
type ListCustomerChatCapabilitiesResponse = {
|
|
2699
|
+
capabilities: Array<{
|
|
2700
|
+
id: "navigate_portal_pages" | "search_portal_records" | "view_billing" | "view_meter_readings" | "view_contracts" | "search_web" | "open_quick_actions" | "view_hems_energy"
|
|
2701
|
+
places: "website" | "portal"[]
|
|
2702
|
+
singleInstance?: boolean
|
|
2703
|
+
requiresIntegration?: boolean
|
|
2704
|
+
}>
|
|
2705
|
+
}
|
|
2706
|
+
```
|
|
2707
|
+
|
|
2708
|
+
### `RenameCustomerChatAgentRequest`
|
|
2709
|
+
|
|
2710
|
+
```ts
|
|
2711
|
+
type RenameCustomerChatAgentRequest = {
|
|
2712
|
+
internal_name: string
|
|
2713
|
+
updated_at?: string // date-time
|
|
2714
|
+
}
|
|
2715
|
+
```
|
|
2716
|
+
|
|
2717
|
+
### `SaveCustomerChatConfigRequest`
|
|
2718
|
+
|
|
2719
|
+
```ts
|
|
2720
|
+
type SaveCustomerChatConfigRequest = {
|
|
2721
|
+
config: {
|
|
2722
|
+
capabilities: Array<{
|
|
2723
|
+
type: { ... }
|
|
2724
|
+
instanceId?: { ... }
|
|
2725
|
+
enabled: { ... }
|
|
2726
|
+
meterTypes?: { ... }
|
|
2727
|
+
ticketType?: { ... }
|
|
2728
|
+
allowedDomains?: { ... }
|
|
2729
|
+
autonomy?: { ... }
|
|
2730
|
+
label?: { ... }
|
|
2731
|
+
guidance?: { ... }
|
|
2732
|
+
blockIds?: { ... }
|
|
2733
|
+
integrationId?: { ... }
|
|
2734
|
+
searchDeviceDocs?: { ... }
|
|
2735
|
+
}>
|
|
2736
|
+
knowledgeSources: Array<{
|
|
2737
|
+
id: { ... }
|
|
2738
|
+
type: { ... }
|
|
2739
|
+
title: { ... }
|
|
2740
|
+
targetId: { ... }
|
|
2741
|
+
detail?: { ... }
|
|
2742
|
+
}>
|
|
2743
|
+
escalation: {
|
|
2744
|
+
websiteHandover: { ... }
|
|
2745
|
+
}
|
|
2746
|
+
appearance: {
|
|
2747
|
+
displayName: { ... }
|
|
2748
|
+
greeting: { ... }
|
|
2749
|
+
starters: { ... }
|
|
2750
|
+
language: { ... }
|
|
2751
|
+
formOfAddress: { ... }
|
|
2752
|
+
languages?: { ... }
|
|
2753
|
+
translations?: { ... }
|
|
2754
|
+
needsReview?: { ... }
|
|
2755
|
+
}
|
|
2756
|
+
instructions?: string
|
|
2757
|
+
instructionTranslations?: {
|
|
2758
|
+
de?: { ... }
|
|
2759
|
+
en?: { ... }
|
|
2760
|
+
}
|
|
2761
|
+
instructionsNeedsReview?: "de" | "en"[]
|
|
2762
|
+
}
|
|
2763
|
+
updated_at?: string // date-time
|
|
2764
|
+
}
|
|
2765
|
+
```
|
|
2766
|
+
|
|
2767
|
+
### `WebsiteHandover`
|
|
2768
|
+
|
|
2769
|
+
```ts
|
|
2770
|
+
type WebsiteHandover = {
|
|
2771
|
+
kind: "phone" | "email" | "journey" | "unset"
|
|
2772
|
+
value: string
|
|
2773
|
+
journeyId?: string
|
|
2774
|
+
journeyName?: string
|
|
2775
|
+
}
|
|
2776
|
+
```
|
|
2777
|
+
|
|
1580
2778
|
### `AgentId`
|
|
1581
2779
|
|
|
1582
2780
|
Agent identifier. Can be either:
|
|
@@ -1588,10 +2786,96 @@ Agent identifier. Can be either:
|
|
|
1588
2786
|
type AgentId = string
|
|
1589
2787
|
```
|
|
1590
2788
|
|
|
2789
|
+
### `KnowledgeSourceIds`
|
|
2790
|
+
|
|
2791
|
+
Knowledge source IDs available to this agent. An empty array clears the selection.
|
|
2792
|
+
|
|
2793
|
+
```ts
|
|
2794
|
+
type KnowledgeSourceIds = string // uuid[]
|
|
2795
|
+
```
|
|
2796
|
+
|
|
2797
|
+
### `KnowledgeSource`
|
|
2798
|
+
|
|
2799
|
+
```ts
|
|
2800
|
+
type KnowledgeSource = {
|
|
2801
|
+
type: "file"
|
|
2802
|
+
source_id: string // uuid
|
|
2803
|
+
filename: string
|
|
2804
|
+
mime_type: string
|
|
2805
|
+
size_bytes: number
|
|
2806
|
+
ready: boolean
|
|
2807
|
+
created_at: string // date-time
|
|
2808
|
+
updated_at: string // date-time
|
|
2809
|
+
}
|
|
2810
|
+
```
|
|
2811
|
+
|
|
2812
|
+
### `KnowledgeFileSource`
|
|
2813
|
+
|
|
2814
|
+
```ts
|
|
2815
|
+
type KnowledgeFileSource = {
|
|
2816
|
+
type: "file"
|
|
2817
|
+
source_id: string // uuid
|
|
2818
|
+
filename: string
|
|
2819
|
+
mime_type: string
|
|
2820
|
+
size_bytes: number
|
|
2821
|
+
ready: boolean
|
|
2822
|
+
created_at: string // date-time
|
|
2823
|
+
updated_at: string // date-time
|
|
2824
|
+
}
|
|
2825
|
+
```
|
|
2826
|
+
|
|
2827
|
+
### `CreateKnowledgeFileUploadRequest`
|
|
2828
|
+
|
|
2829
|
+
```ts
|
|
2830
|
+
type CreateKnowledgeFileUploadRequest = {
|
|
2831
|
+
filename: string
|
|
2832
|
+
mime_type: string
|
|
2833
|
+
size_bytes: number
|
|
2834
|
+
}
|
|
2835
|
+
```
|
|
2836
|
+
|
|
2837
|
+
### `CreateKnowledgeFileUploadResponse`
|
|
2838
|
+
|
|
2839
|
+
```ts
|
|
2840
|
+
type CreateKnowledgeFileUploadResponse = {
|
|
2841
|
+
source_id: string // uuid
|
|
2842
|
+
upload_url: string // uri
|
|
2843
|
+
upload_fields: Record<string, string>
|
|
2844
|
+
expires_at: string // date-time
|
|
2845
|
+
}
|
|
2846
|
+
```
|
|
2847
|
+
|
|
2848
|
+
### `ListKnowledgeSourcesResponse`
|
|
2849
|
+
|
|
2850
|
+
```ts
|
|
2851
|
+
type ListKnowledgeSourcesResponse = {
|
|
2852
|
+
sources: Array<{
|
|
2853
|
+
type: "file"
|
|
2854
|
+
source_id: string // uuid
|
|
2855
|
+
filename: string
|
|
2856
|
+
mime_type: string
|
|
2857
|
+
size_bytes: number
|
|
2858
|
+
ready: boolean
|
|
2859
|
+
created_at: string // date-time
|
|
2860
|
+
updated_at: string // date-time
|
|
2861
|
+
}>
|
|
2862
|
+
}
|
|
2863
|
+
```
|
|
2864
|
+
|
|
2865
|
+
### `AgentDomain`
|
|
2866
|
+
|
|
2867
|
+
Business domain selected in the agent builder.
|
|
2868
|
+
|
|
2869
|
+
```ts
|
|
2870
|
+
type AgentDomain = "customer_service" | "sales" | "billing" | "metering_grid" | "other"
|
|
2871
|
+
```
|
|
2872
|
+
|
|
1591
2873
|
### `CreateAgentRequest`
|
|
1592
2874
|
|
|
1593
2875
|
```ts
|
|
1594
2876
|
type CreateAgentRequest = {
|
|
2877
|
+
domain?: "customer_service" | "sales" | "billing" | "metering_grid" | "other"
|
|
2878
|
+
availability?: "flows" | "copilot" | "portals" | "website" | "all"[]
|
|
1595
2879
|
name: string
|
|
1596
2880
|
description?: string
|
|
1597
2881
|
category?: "message" | "entity" | "document" | "classification" | "custom"
|
|
@@ -1632,6 +2916,7 @@ type CreateAgentRequest = {
|
|
|
1632
2916
|
}>
|
|
1633
2917
|
required?: string[]
|
|
1634
2918
|
}
|
|
2919
|
+
knowledge_source_ids?: string // uuid[]
|
|
1635
2920
|
}
|
|
1636
2921
|
```
|
|
1637
2922
|
|
|
@@ -1639,6 +2924,8 @@ type CreateAgentRequest = {
|
|
|
1639
2924
|
|
|
1640
2925
|
```ts
|
|
1641
2926
|
type UpdateAgentRequest = {
|
|
2927
|
+
domain?: "customer_service" | "sales" | "billing" | "metering_grid" | "other"
|
|
2928
|
+
availability?: "flows" | "copilot" | "portals" | "website" | "all"[]
|
|
1642
2929
|
name?: string
|
|
1643
2930
|
description?: string
|
|
1644
2931
|
category?: "message" | "entity" | "document" | "classification" | "custom"
|
|
@@ -1679,6 +2966,7 @@ type UpdateAgentRequest = {
|
|
|
1679
2966
|
}>
|
|
1680
2967
|
required?: string[]
|
|
1681
2968
|
}
|
|
2969
|
+
knowledge_source_ids?: string // uuid[]
|
|
1682
2970
|
}
|
|
1683
2971
|
```
|
|
1684
2972
|
|
|
@@ -1686,6 +2974,7 @@ type UpdateAgentRequest = {
|
|
|
1686
2974
|
|
|
1687
2975
|
```ts
|
|
1688
2976
|
type AgentDefinition = {
|
|
2977
|
+
domain?: "customer_service" | "sales" | "billing" | "metering_grid" | "other"
|
|
1689
2978
|
agent_id?: string
|
|
1690
2979
|
org_id?: string
|
|
1691
2980
|
name?: string
|
|
@@ -1693,7 +2982,7 @@ type AgentDefinition = {
|
|
|
1693
2982
|
category?: "message" | "entity" | "document" | "classification" | "custom"
|
|
1694
2983
|
icon?: string
|
|
1695
2984
|
source?: "system" | "custom"
|
|
1696
|
-
availability?: "flows" | "copilot" | "portals" | "all"[]
|
|
2985
|
+
availability?: "flows" | "copilot" | "portals" | "website" | "all"[]
|
|
1697
2986
|
allowed_entity_schemas?: string[]
|
|
1698
2987
|
system_prompt?: string
|
|
1699
2988
|
tools?: string[]
|
|
@@ -1731,6 +3020,7 @@ type AgentDefinition = {
|
|
|
1731
3020
|
}>
|
|
1732
3021
|
required?: string[]
|
|
1733
3022
|
}
|
|
3023
|
+
knowledge_source_ids?: string // uuid[]
|
|
1734
3024
|
version?: number
|
|
1735
3025
|
created_at?: string // date-time
|
|
1736
3026
|
updated_at?: string // date-time
|
|
@@ -1743,6 +3033,7 @@ type AgentDefinition = {
|
|
|
1743
3033
|
```ts
|
|
1744
3034
|
type ListAgentsResponse = {
|
|
1745
3035
|
agents?: Array<{
|
|
3036
|
+
domain?: "customer_service" | "sales" | "billing" | "metering_grid" | "other"
|
|
1746
3037
|
agent_id?: string
|
|
1747
3038
|
org_id?: string
|
|
1748
3039
|
name?: string
|
|
@@ -1750,7 +3041,7 @@ type ListAgentsResponse = {
|
|
|
1750
3041
|
category?: "message" | "entity" | "document" | "classification" | "custom"
|
|
1751
3042
|
icon?: string
|
|
1752
3043
|
source?: "system" | "custom"
|
|
1753
|
-
availability?: "flows" | "copilot" | "portals" | "all"[]
|
|
3044
|
+
availability?: "flows" | "copilot" | "portals" | "website" | "all"[]
|
|
1754
3045
|
allowed_entity_schemas?: string[]
|
|
1755
3046
|
system_prompt?: string
|
|
1756
3047
|
tools?: string[]
|
|
@@ -1770,6 +3061,7 @@ type ListAgentsResponse = {
|
|
|
1770
3061
|
parameters: { ... }
|
|
1771
3062
|
required?: { ... }
|
|
1772
3063
|
}
|
|
3064
|
+
knowledge_source_ids?: string // uuid[]
|
|
1773
3065
|
version?: number
|
|
1774
3066
|
created_at?: string // date-time
|
|
1775
3067
|
updated_at?: string // date-time
|
|
@@ -1788,9 +3080,9 @@ type ListExecutionsResponse = {
|
|
|
1788
3080
|
agent_id?: string
|
|
1789
3081
|
agent_source?: "system" | "custom"
|
|
1790
3082
|
agent_name?: string
|
|
1791
|
-
execution_context?: "flows" | "copilot" | "api"
|
|
3083
|
+
execution_context?: "flows" | "copilot" | "api" | "sharing"
|
|
1792
3084
|
org_id?: string
|
|
1793
|
-
status?: "pending" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
3085
|
+
status?: "pending" | "queued" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
1794
3086
|
input?: object
|
|
1795
3087
|
parameters?: object
|
|
1796
3088
|
result?: {
|
|
@@ -1851,7 +3143,9 @@ type RejectExecutionRequest = {
|
|
|
1851
3143
|
|
|
1852
3144
|
```ts
|
|
1853
3145
|
type ExecuteAgentRequest = {
|
|
3146
|
+
mode?: "auto" | "stream" | "async" | "sync"
|
|
1854
3147
|
input?: {
|
|
3148
|
+
message?: string
|
|
1855
3149
|
entity_id?: string
|
|
1856
3150
|
entity_schema?: string
|
|
1857
3151
|
workflow_id?: string
|
|
@@ -1862,10 +3156,15 @@ type ExecuteAgentRequest = {
|
|
|
1862
3156
|
entity_id: { ... }
|
|
1863
3157
|
entity_schema: { ... }
|
|
1864
3158
|
}>
|
|
3159
|
+
attachment?: {
|
|
3160
|
+
s3ref: { ... }
|
|
3161
|
+
mime_type: { ... }
|
|
3162
|
+
filename?: { ... }
|
|
3163
|
+
}
|
|
1865
3164
|
}
|
|
1866
3165
|
parameters?: Record<string, unknown>
|
|
1867
3166
|
execution_mode_override?: "automatic" | "approval" | "draft"
|
|
1868
|
-
execution_context?: "flows" | "copilot" | "api"
|
|
3167
|
+
execution_context?: "flows" | "copilot" | "api" | "sharing"
|
|
1869
3168
|
callback_url?: string // uri
|
|
1870
3169
|
timeout_ms?: number
|
|
1871
3170
|
}
|
|
@@ -1879,9 +3178,9 @@ type ExecutionResponse = {
|
|
|
1879
3178
|
agent_id?: string
|
|
1880
3179
|
agent_source?: "system" | "custom"
|
|
1881
3180
|
agent_name?: string
|
|
1882
|
-
execution_context?: "flows" | "copilot" | "api"
|
|
3181
|
+
execution_context?: "flows" | "copilot" | "api" | "sharing"
|
|
1883
3182
|
org_id?: string
|
|
1884
|
-
status?: "pending" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
3183
|
+
status?: "pending" | "queued" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
1885
3184
|
input?: object
|
|
1886
3185
|
parameters?: object
|
|
1887
3186
|
result?: {
|
|
@@ -2090,7 +3389,7 @@ the execution row: `pending` and `running` both surface as `started`, and
|
|
|
2090
3389
|
vocabularies are interchang
|
|
2091
3390
|
|
|
2092
3391
|
```ts
|
|
2093
|
-
type AgentExecutionEventStatus = "started" | "completed" | "failed" | "approval_required"
|
|
3392
|
+
type AgentExecutionEventStatus = "started" | "queued" | "completed" | "failed" | "approval_required"
|
|
2094
3393
|
```
|
|
2095
3394
|
|
|
2096
3395
|
### `AgentExecutionEvent`
|
|
@@ -2108,8 +3407,8 @@ type AgentExecutionEvent = {
|
|
|
2108
3407
|
agentId: string
|
|
2109
3408
|
orgId: string
|
|
2110
3409
|
userId?: string
|
|
2111
|
-
execution_status: "started" | "completed" | "failed" | "approval_required"
|
|
2112
|
-
execution_context?: "flows" | "copilot" | "api"
|
|
3410
|
+
execution_status: "started" | "queued" | "completed" | "failed" | "approval_required"
|
|
3411
|
+
execution_context?: "flows" | "copilot" | "api" | "sharing"
|
|
2113
3412
|
input?: Record<string, unknown>
|
|
2114
3413
|
output?: Record<string, unknown>
|
|
2115
3414
|
error?: {
|
|
@@ -2129,6 +3428,62 @@ type AgentExecutionEvent = {
|
|
|
2129
3428
|
}
|
|
2130
3429
|
```
|
|
2131
3430
|
|
|
3431
|
+
### `KnowledgeSourceRegisteredEvent`
|
|
3432
|
+
|
|
3433
|
+
Detail payload of the `knowledge-source-registered` event, published on
|
|
3434
|
+
the AI Agents event bus with source `ai-agents` after the source record
|
|
3435
|
+
exists in DynamoDB. Consumers must process `sourceId` idempotently.
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
```ts
|
|
3439
|
+
type KnowledgeSourceRegisteredEvent = {
|
|
3440
|
+
orgId: string
|
|
3441
|
+
sourceId: string // uuid
|
|
3442
|
+
type: "file"
|
|
3443
|
+
bucket: string
|
|
3444
|
+
key: string
|
|
3445
|
+
}
|
|
3446
|
+
```
|
|
3447
|
+
|
|
3448
|
+
### `KnowledgeFileSourceRegisteredEvent`
|
|
3449
|
+
|
|
3450
|
+
```ts
|
|
3451
|
+
type KnowledgeFileSourceRegisteredEvent = {
|
|
3452
|
+
orgId: string
|
|
3453
|
+
sourceId: string // uuid
|
|
3454
|
+
type: "file"
|
|
3455
|
+
bucket: string
|
|
3456
|
+
key: string
|
|
3457
|
+
}
|
|
3458
|
+
```
|
|
3459
|
+
|
|
3460
|
+
### `KnowledgeSourceDeletedEvent`
|
|
3461
|
+
|
|
3462
|
+
Published when a knowledge source is deleted.
|
|
3463
|
+
|
|
3464
|
+
```ts
|
|
3465
|
+
type KnowledgeSourceDeletedEvent = {
|
|
3466
|
+
orgId: string
|
|
3467
|
+
sourceId: string // uuid
|
|
3468
|
+
type: "file"
|
|
3469
|
+
}
|
|
3470
|
+
```
|
|
3471
|
+
|
|
3472
|
+
### `KnowledgeSourceProcessingCompletedEvent`
|
|
3473
|
+
|
|
3474
|
+
Published by a knowledge processing pipeline after all derived data for
|
|
3475
|
+
the source has been stored and is available for agent retrieval. The
|
|
3476
|
+
event uses source `knowledge-processing` and detail type
|
|
3477
|
+
`knowledge-source-processing-completed` on the AI Agents event bus.
|
|
3478
|
+
|
|
3479
|
+
|
|
3480
|
+
```ts
|
|
3481
|
+
type KnowledgeSourceProcessingCompletedEvent = {
|
|
3482
|
+
orgId: string
|
|
3483
|
+
sourceId: string // uuid
|
|
3484
|
+
}
|
|
3485
|
+
```
|
|
3486
|
+
|
|
2132
3487
|
### `ToolPreview`
|
|
2133
3488
|
|
|
2134
3489
|
Structured preview data for approval UI. Provides a generic format that any tool can populate.
|
|
@@ -2295,11 +3650,11 @@ Where the skill/agent is available:
|
|
|
2295
3650
|
- flows: Available in workflow automations
|
|
2296
3651
|
- copilot: Available as a sub-agent in copilot
|
|
2297
3652
|
- portals: Available in end-user self-service portals
|
|
2298
|
-
-
|
|
2299
|
-
|
|
3653
|
+
- website: Website chat, explicitly selected; currently supports anonymous execution
|
|
3654
|
+
- all: Available on the existing no
|
|
2300
3655
|
|
|
2301
3656
|
```ts
|
|
2302
|
-
type SkillAvailability = "flows" | "copilot" | "portals" | "all"
|
|
3657
|
+
type SkillAvailability = "flows" | "copilot" | "portals" | "website" | "all"
|
|
2303
3658
|
```
|
|
2304
3659
|
|
|
2305
3660
|
### `ExecutionContext`
|
|
@@ -2308,10 +3663,11 @@ Where the execution was triggered from:
|
|
|
2308
3663
|
- flows: Triggered from workflow automation
|
|
2309
3664
|
- copilot: Triggered from copilot assistant
|
|
2310
3665
|
- api: Direct API call
|
|
3666
|
+
- sharing: Triggered by sharing-api auto-sharing rules
|
|
2311
3667
|
|
|
2312
3668
|
|
|
2313
3669
|
```ts
|
|
2314
|
-
type ExecutionContext = "flows" | "copilot" | "api"
|
|
3670
|
+
type ExecutionContext = "flows" | "copilot" | "api" | "sharing"
|
|
2315
3671
|
```
|
|
2316
3672
|
|
|
2317
3673
|
### `ExecutionPattern`
|
|
@@ -2338,7 +3694,7 @@ type ExecutionMode = "automatic" | "approval" | "draft"
|
|
|
2338
3694
|
### `ExecutionStatus`
|
|
2339
3695
|
|
|
2340
3696
|
```ts
|
|
2341
|
-
type ExecutionStatus = "pending" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
3697
|
+
type ExecutionStatus = "pending" | "queued" | "running" | "waiting_approval" | "completed" | "failed" | "cancelled"
|
|
2342
3698
|
```
|
|
2343
3699
|
|
|
2344
3700
|
### `ParameterType`
|
|
@@ -2458,6 +3814,7 @@ type ChatRequest = {
|
|
|
2458
3814
|
streamTokens?: boolean
|
|
2459
3815
|
includeMetadata?: boolean
|
|
2460
3816
|
}
|
|
3817
|
+
preview_demo?: boolean
|
|
2461
3818
|
}
|
|
2462
3819
|
```
|
|
2463
3820
|
|