@lunnoa/client 0.0.0-development → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -202
- package/README.md +378 -338
- package/dist/cli.js +128 -4
- package/dist/index.cjs +76 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1333 -1055
- package/dist/index.d.ts +1333 -1055
- package/dist/index.js +75 -3
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +59 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +768 -596
- package/dist/react.d.ts +768 -596
- package/dist/react.js +59 -1
- package/dist/react.js.map +1 -1
- package/package.json +7 -5
- package/skills/lunnoa-client/SKILL.md +517 -0
- package/skills/lunnoa-solution-design/SKILL.md +190 -0
package/dist/index.d.cts
CHANGED
|
@@ -696,6 +696,26 @@ interface paths {
|
|
|
696
696
|
patch?: never;
|
|
697
697
|
trace?: never;
|
|
698
698
|
};
|
|
699
|
+
"/api/objects/{objectId}/queue-items": {
|
|
700
|
+
parameters: {
|
|
701
|
+
query?: never;
|
|
702
|
+
header?: never;
|
|
703
|
+
path?: never;
|
|
704
|
+
cookie?: never;
|
|
705
|
+
};
|
|
706
|
+
/**
|
|
707
|
+
* List queue items for an Object
|
|
708
|
+
* @description Returns work items linked to the given Object across all queues in the workspace. Use this for an Object detail "Work" panel.
|
|
709
|
+
*/
|
|
710
|
+
get: operations["ObjectQueueItemsController_listForObject"];
|
|
711
|
+
put?: never;
|
|
712
|
+
post?: never;
|
|
713
|
+
delete?: never;
|
|
714
|
+
options?: never;
|
|
715
|
+
head?: never;
|
|
716
|
+
patch?: never;
|
|
717
|
+
trace?: never;
|
|
718
|
+
};
|
|
699
719
|
"/api/workflows": {
|
|
700
720
|
parameters: {
|
|
701
721
|
query?: never;
|
|
@@ -756,7 +776,7 @@ interface paths {
|
|
|
756
776
|
patch?: never;
|
|
757
777
|
trace?: never;
|
|
758
778
|
};
|
|
759
|
-
"/api/
|
|
779
|
+
"/api/object-types": {
|
|
760
780
|
parameters: {
|
|
761
781
|
query?: never;
|
|
762
782
|
header?: never;
|
|
@@ -764,10 +784,10 @@ interface paths {
|
|
|
764
784
|
cookie?: never;
|
|
765
785
|
};
|
|
766
786
|
/**
|
|
767
|
-
*
|
|
768
|
-
* @description Returns
|
|
787
|
+
* Get all entity types for workspace
|
|
788
|
+
* @description Returns entity types in the workspace, sorted by name. Disabled types are excluded unless includeDisabled is true.
|
|
769
789
|
*/
|
|
770
|
-
get: operations["
|
|
790
|
+
get: operations["ObjectTypesController_findAll"];
|
|
771
791
|
put?: never;
|
|
772
792
|
post?: never;
|
|
773
793
|
delete?: never;
|
|
@@ -776,7 +796,7 @@ interface paths {
|
|
|
776
796
|
patch?: never;
|
|
777
797
|
trace?: never;
|
|
778
798
|
};
|
|
779
|
-
"/api/
|
|
799
|
+
"/api/object-types/upsert": {
|
|
780
800
|
parameters: {
|
|
781
801
|
query?: never;
|
|
782
802
|
header?: never;
|
|
@@ -786,30 +806,10 @@ interface paths {
|
|
|
786
806
|
get?: never;
|
|
787
807
|
put?: never;
|
|
788
808
|
/**
|
|
789
|
-
*
|
|
790
|
-
* @description Creates
|
|
791
|
-
*/
|
|
792
|
-
post: operations["WorkflowAppsController_connectApp"];
|
|
793
|
-
delete?: never;
|
|
794
|
-
options?: never;
|
|
795
|
-
head?: never;
|
|
796
|
-
patch?: never;
|
|
797
|
-
trace?: never;
|
|
798
|
-
};
|
|
799
|
-
"/api/object-types": {
|
|
800
|
-
parameters: {
|
|
801
|
-
query?: never;
|
|
802
|
-
header?: never;
|
|
803
|
-
path?: never;
|
|
804
|
-
cookie?: never;
|
|
805
|
-
};
|
|
806
|
-
/**
|
|
807
|
-
* Get all entity types for workspace
|
|
808
|
-
* @description Returns entity types in the workspace, sorted by name. Disabled types are excluded unless includeDisabled is true.
|
|
809
|
+
* Upsert entity type by workspace-scoped slug
|
|
810
|
+
* @description Creates or updates an entity type identified by workspace-scoped `slug`. Marks `managedByCode` by default. Prefer the CLI (`npx @lunnoa/client entity-types deploy`) over calling this from application code. Unknown instance attributes are rejected unless `allowUnknownAttributes` is true; reserved key `extensions` is always allowed.
|
|
809
811
|
*/
|
|
810
|
-
|
|
811
|
-
put?: never;
|
|
812
|
-
post?: never;
|
|
812
|
+
post: operations["ObjectTypesController_upsertBySlug"];
|
|
813
813
|
delete?: never;
|
|
814
814
|
options?: never;
|
|
815
815
|
head?: never;
|
|
@@ -1016,7 +1016,7 @@ interface paths {
|
|
|
1016
1016
|
patch?: never;
|
|
1017
1017
|
trace?: never;
|
|
1018
1018
|
};
|
|
1019
|
-
"/api/
|
|
1019
|
+
"/api/workflow-apps": {
|
|
1020
1020
|
parameters: {
|
|
1021
1021
|
query?: never;
|
|
1022
1022
|
header?: never;
|
|
@@ -1024,51 +1024,19 @@ interface paths {
|
|
|
1024
1024
|
cookie?: never;
|
|
1025
1025
|
};
|
|
1026
1026
|
/**
|
|
1027
|
-
* List
|
|
1028
|
-
* @description Returns
|
|
1027
|
+
* List all workflow apps
|
|
1028
|
+
* @description Returns the full catalogue of app definitions, including their actions and triggers. Custom UIs use this catalogue to resolve executionPath step appId/actionId pairs to names and icons. Each action and trigger exposes declarative UI metadata (inputConfig) describing its configuration fields.
|
|
1029
1029
|
*/
|
|
1030
|
-
get: operations["
|
|
1030
|
+
get: operations["WorkflowAppsController_findAll"];
|
|
1031
1031
|
put?: never;
|
|
1032
|
-
|
|
1033
|
-
* Create knowledge base
|
|
1034
|
-
* @description Creates a workspace-wide knowledge base with a dedicated vector index. Embedding model, provider and dimensions default to the platform configuration when omitted.
|
|
1035
|
-
*/
|
|
1036
|
-
post: operations["KnowledgeController_create"];
|
|
1032
|
+
post?: never;
|
|
1037
1033
|
delete?: never;
|
|
1038
1034
|
options?: never;
|
|
1039
1035
|
head?: never;
|
|
1040
1036
|
patch?: never;
|
|
1041
1037
|
trace?: never;
|
|
1042
1038
|
};
|
|
1043
|
-
"/api/
|
|
1044
|
-
parameters: {
|
|
1045
|
-
query?: never;
|
|
1046
|
-
header?: never;
|
|
1047
|
-
path?: never;
|
|
1048
|
-
cookie?: never;
|
|
1049
|
-
};
|
|
1050
|
-
/**
|
|
1051
|
-
* Get knowledge base by ID
|
|
1052
|
-
* @description Returns a single knowledge base.
|
|
1053
|
-
*/
|
|
1054
|
-
get: operations["KnowledgeController_findOne"];
|
|
1055
|
-
put?: never;
|
|
1056
|
-
post?: never;
|
|
1057
|
-
/**
|
|
1058
|
-
* Delete knowledge base
|
|
1059
|
-
* @description Deletes a knowledge base, its stored files and its vector index. This action cannot be undone.
|
|
1060
|
-
*/
|
|
1061
|
-
delete: operations["KnowledgeController_delete"];
|
|
1062
|
-
options?: never;
|
|
1063
|
-
head?: never;
|
|
1064
|
-
/**
|
|
1065
|
-
* Update knowledge base
|
|
1066
|
-
* @description Updates knowledge base properties. All body fields are optional; only provided fields are changed.
|
|
1067
|
-
*/
|
|
1068
|
-
patch: operations["KnowledgeController_update"];
|
|
1069
|
-
trace?: never;
|
|
1070
|
-
};
|
|
1071
|
-
"/api/knowledge/{knowledgeId}/saveUploadedText": {
|
|
1039
|
+
"/api/workflow-apps/{appId}/connections/{connectionId}/connect": {
|
|
1072
1040
|
parameters: {
|
|
1073
1041
|
query?: never;
|
|
1074
1042
|
header?: never;
|
|
@@ -1078,17 +1046,17 @@ interface paths {
|
|
|
1078
1046
|
get?: never;
|
|
1079
1047
|
put?: never;
|
|
1080
1048
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
* @description
|
|
1049
|
+
* Connect workflow app
|
|
1050
|
+
* @description Creates a connection for an app using non-interactive credentials such as an API key or basic auth username and password. OAuth2 connection types require the interactive browser flow and cannot be created through this endpoint with machine credentials.
|
|
1083
1051
|
*/
|
|
1084
|
-
post: operations["
|
|
1052
|
+
post: operations["WorkflowAppsController_connectApp"];
|
|
1085
1053
|
delete?: never;
|
|
1086
1054
|
options?: never;
|
|
1087
1055
|
head?: never;
|
|
1088
1056
|
patch?: never;
|
|
1089
1057
|
trace?: never;
|
|
1090
1058
|
};
|
|
1091
|
-
"/api/
|
|
1059
|
+
"/api/agents": {
|
|
1092
1060
|
parameters: {
|
|
1093
1061
|
query?: never;
|
|
1094
1062
|
header?: never;
|
|
@@ -1096,10 +1064,10 @@ interface paths {
|
|
|
1096
1064
|
cookie?: never;
|
|
1097
1065
|
};
|
|
1098
1066
|
/**
|
|
1099
|
-
* List
|
|
1100
|
-
* @description
|
|
1067
|
+
* List agents in current workspace
|
|
1068
|
+
* @description Lists every agent in the caller's active workspace, most recently updated first. By default each item carries only `id`, `name`, and `FK_aiConnectionId`; request additional fields with the `expansion` query parameter.
|
|
1101
1069
|
*/
|
|
1102
|
-
get: operations["
|
|
1070
|
+
get: operations["AgentsController_findAllForWorkspace"];
|
|
1103
1071
|
put?: never;
|
|
1104
1072
|
post?: never;
|
|
1105
1073
|
delete?: never;
|
|
@@ -1108,7 +1076,7 @@ interface paths {
|
|
|
1108
1076
|
patch?: never;
|
|
1109
1077
|
trace?: never;
|
|
1110
1078
|
};
|
|
1111
|
-
"/api/
|
|
1079
|
+
"/api/agents/{agentId}": {
|
|
1112
1080
|
parameters: {
|
|
1113
1081
|
query?: never;
|
|
1114
1082
|
header?: never;
|
|
@@ -1116,23 +1084,19 @@ interface paths {
|
|
|
1116
1084
|
cookie?: never;
|
|
1117
1085
|
};
|
|
1118
1086
|
/**
|
|
1119
|
-
* Get
|
|
1120
|
-
* @description Returns a
|
|
1087
|
+
* Get agent by ID
|
|
1088
|
+
* @description Returns a single agent. By default only `id`, `name`, and `FK_aiConnectionId` are returned; request additional fields with the `expansion` query parameter. Access is gated by the `agents:use` permission, so agents reachable via a share grant can also be fetched.
|
|
1121
1089
|
*/
|
|
1122
|
-
get: operations["
|
|
1090
|
+
get: operations["AgentsController_findOne"];
|
|
1123
1091
|
put?: never;
|
|
1124
1092
|
post?: never;
|
|
1125
|
-
|
|
1126
|
-
* Delete knowledge document group
|
|
1127
|
-
* @description Deletes a document group and all of its parts, including stored files and vector index entries. This action cannot be undone.
|
|
1128
|
-
*/
|
|
1129
|
-
delete: operations["KnowledgeController_deleteDocumentGroup"];
|
|
1093
|
+
delete?: never;
|
|
1130
1094
|
options?: never;
|
|
1131
1095
|
head?: never;
|
|
1132
1096
|
patch?: never;
|
|
1133
1097
|
trace?: never;
|
|
1134
1098
|
};
|
|
1135
|
-
"/api/
|
|
1099
|
+
"/api/projects/{projectId}/agents/upsert": {
|
|
1136
1100
|
parameters: {
|
|
1137
1101
|
query?: never;
|
|
1138
1102
|
header?: never;
|
|
@@ -1142,17 +1106,17 @@ interface paths {
|
|
|
1142
1106
|
get?: never;
|
|
1143
1107
|
put?: never;
|
|
1144
1108
|
/**
|
|
1145
|
-
*
|
|
1146
|
-
* @description
|
|
1109
|
+
* Upsert an agent by slug
|
|
1110
|
+
* @description Creates or updates an agent identified by project-scoped `slug`. Accepts instructions, model, optional aiConnectionId / connectionIds / workflowIds, and catalogue action tools. Marks `managedByCode` by default. Prefer the CLI (`npx @lunnoa/client agents deploy`) over calling this from application code.
|
|
1147
1111
|
*/
|
|
1148
|
-
post: operations["
|
|
1112
|
+
post: operations["ProjectAgentsController_upsertBySlug"];
|
|
1149
1113
|
delete?: never;
|
|
1150
1114
|
options?: never;
|
|
1151
1115
|
head?: never;
|
|
1152
1116
|
patch?: never;
|
|
1153
1117
|
trace?: never;
|
|
1154
1118
|
};
|
|
1155
|
-
"/api/
|
|
1119
|
+
"/api/knowledge": {
|
|
1156
1120
|
parameters: {
|
|
1157
1121
|
query?: never;
|
|
1158
1122
|
header?: never;
|
|
@@ -1160,19 +1124,23 @@ interface paths {
|
|
|
1160
1124
|
cookie?: never;
|
|
1161
1125
|
};
|
|
1162
1126
|
/**
|
|
1163
|
-
* List
|
|
1164
|
-
* @description Returns
|
|
1127
|
+
* List knowledge bases in workspace
|
|
1128
|
+
* @description Returns all knowledge bases in the current workspace, ordered by most recently updated.
|
|
1165
1129
|
*/
|
|
1166
|
-
get: operations["
|
|
1130
|
+
get: operations["KnowledgeController_findAllForWorkspace"];
|
|
1167
1131
|
put?: never;
|
|
1168
|
-
|
|
1132
|
+
/**
|
|
1133
|
+
* Create knowledge base
|
|
1134
|
+
* @description Creates a workspace-wide knowledge base with a dedicated vector index. Embedding model, provider and dimensions default to the platform configuration when omitted.
|
|
1135
|
+
*/
|
|
1136
|
+
post: operations["KnowledgeController_create"];
|
|
1169
1137
|
delete?: never;
|
|
1170
1138
|
options?: never;
|
|
1171
1139
|
head?: never;
|
|
1172
1140
|
patch?: never;
|
|
1173
1141
|
trace?: never;
|
|
1174
1142
|
};
|
|
1175
|
-
"/api/
|
|
1143
|
+
"/api/knowledge/{knowledgeId}": {
|
|
1176
1144
|
parameters: {
|
|
1177
1145
|
query?: never;
|
|
1178
1146
|
header?: never;
|
|
@@ -1180,73 +1148,85 @@ interface paths {
|
|
|
1180
1148
|
cookie?: never;
|
|
1181
1149
|
};
|
|
1182
1150
|
/**
|
|
1183
|
-
* Get
|
|
1184
|
-
* @description Returns a single
|
|
1151
|
+
* Get knowledge base by ID
|
|
1152
|
+
* @description Returns a single knowledge base.
|
|
1185
1153
|
*/
|
|
1186
|
-
get: operations["
|
|
1154
|
+
get: operations["KnowledgeController_findOne"];
|
|
1187
1155
|
put?: never;
|
|
1188
1156
|
post?: never;
|
|
1189
|
-
|
|
1157
|
+
/**
|
|
1158
|
+
* Delete knowledge base
|
|
1159
|
+
* @description Deletes a knowledge base, its stored files and its vector index. This action cannot be undone.
|
|
1160
|
+
*/
|
|
1161
|
+
delete: operations["KnowledgeController_delete"];
|
|
1190
1162
|
options?: never;
|
|
1191
1163
|
head?: never;
|
|
1192
|
-
|
|
1164
|
+
/**
|
|
1165
|
+
* Update knowledge base
|
|
1166
|
+
* @description Updates knowledge base properties. All body fields are optional; only provided fields are changed.
|
|
1167
|
+
*/
|
|
1168
|
+
patch: operations["KnowledgeController_update"];
|
|
1193
1169
|
trace?: never;
|
|
1194
1170
|
};
|
|
1195
|
-
"/api/
|
|
1171
|
+
"/api/knowledge/{knowledgeId}/saveUploadedText": {
|
|
1196
1172
|
parameters: {
|
|
1197
1173
|
query?: never;
|
|
1198
1174
|
header?: never;
|
|
1199
1175
|
path?: never;
|
|
1200
1176
|
cookie?: never;
|
|
1201
1177
|
};
|
|
1178
|
+
get?: never;
|
|
1179
|
+
put?: never;
|
|
1202
1180
|
/**
|
|
1203
|
-
*
|
|
1204
|
-
* @description
|
|
1181
|
+
* Save uploaded text to knowledge base
|
|
1182
|
+
* @description Chunks the provided text, generates embeddings and stores them in the knowledge base. Multi-chunk uploads are grouped into a single document.
|
|
1205
1183
|
*/
|
|
1206
|
-
|
|
1207
|
-
put?: never;
|
|
1208
|
-
post?: never;
|
|
1184
|
+
post: operations["KnowledgeController_saveUploadedTextToKnowledge"];
|
|
1209
1185
|
delete?: never;
|
|
1210
1186
|
options?: never;
|
|
1211
1187
|
head?: never;
|
|
1212
1188
|
patch?: never;
|
|
1213
1189
|
trace?: never;
|
|
1214
1190
|
};
|
|
1215
|
-
"/api/
|
|
1191
|
+
"/api/knowledge/{knowledgeId}/documents": {
|
|
1216
1192
|
parameters: {
|
|
1217
1193
|
query?: never;
|
|
1218
1194
|
header?: never;
|
|
1219
1195
|
path?: never;
|
|
1220
1196
|
cookie?: never;
|
|
1221
1197
|
};
|
|
1222
|
-
get?: never;
|
|
1223
|
-
put?: never;
|
|
1224
1198
|
/**
|
|
1225
|
-
*
|
|
1226
|
-
* @description
|
|
1199
|
+
* List documents for knowledge base
|
|
1200
|
+
* @description Returns a grouped document view of the knowledge base. Multi-part uploads appear as a single group document; single-part uploads appear as standalone documents.
|
|
1227
1201
|
*/
|
|
1228
|
-
|
|
1202
|
+
get: operations["KnowledgeController_getDocuments"];
|
|
1203
|
+
put?: never;
|
|
1204
|
+
post?: never;
|
|
1229
1205
|
delete?: never;
|
|
1230
1206
|
options?: never;
|
|
1231
1207
|
head?: never;
|
|
1232
1208
|
patch?: never;
|
|
1233
1209
|
trace?: never;
|
|
1234
1210
|
};
|
|
1235
|
-
"/api/
|
|
1211
|
+
"/api/knowledge/{knowledgeId}/documents/{groupId}": {
|
|
1236
1212
|
parameters: {
|
|
1237
1213
|
query?: never;
|
|
1238
1214
|
header?: never;
|
|
1239
1215
|
path?: never;
|
|
1240
1216
|
cookie?: never;
|
|
1241
1217
|
};
|
|
1242
|
-
|
|
1218
|
+
/**
|
|
1219
|
+
* Get knowledge document group
|
|
1220
|
+
* @description Returns a document group with all of its parts (vector references), ordered by part number.
|
|
1221
|
+
*/
|
|
1222
|
+
get: operations["KnowledgeController_getDocumentGroup"];
|
|
1243
1223
|
put?: never;
|
|
1224
|
+
post?: never;
|
|
1244
1225
|
/**
|
|
1245
|
-
*
|
|
1246
|
-
* @description
|
|
1226
|
+
* Delete knowledge document group
|
|
1227
|
+
* @description Deletes a document group and all of its parts, including stored files and vector index entries. This action cannot be undone.
|
|
1247
1228
|
*/
|
|
1248
|
-
|
|
1249
|
-
delete?: never;
|
|
1229
|
+
delete: operations["KnowledgeController_deleteDocumentGroup"];
|
|
1250
1230
|
options?: never;
|
|
1251
1231
|
head?: never;
|
|
1252
1232
|
patch?: never;
|
|
@@ -1344,55 +1324,47 @@ interface paths {
|
|
|
1344
1324
|
patch?: never;
|
|
1345
1325
|
trace?: never;
|
|
1346
1326
|
};
|
|
1347
|
-
"/api/
|
|
1327
|
+
"/api/executions/workflows/{workflowId}/execute": {
|
|
1348
1328
|
parameters: {
|
|
1349
1329
|
query?: never;
|
|
1350
1330
|
header?: never;
|
|
1351
1331
|
path?: never;
|
|
1352
1332
|
cookie?: never;
|
|
1353
1333
|
};
|
|
1334
|
+
get?: never;
|
|
1335
|
+
put?: never;
|
|
1354
1336
|
/**
|
|
1355
|
-
*
|
|
1356
|
-
* @description
|
|
1357
|
-
*/
|
|
1358
|
-
get: operations["WebhookController_workflowEventGet"];
|
|
1359
|
-
/**
|
|
1360
|
-
* Trigger workflow via custom webhook (PUT)
|
|
1361
|
-
* @description Unauthenticated workflow trigger. The workflow must have a webhook trigger configured. The JSON request body and headers are forwarded to the trigger. When the workflow responds synchronously, the response body contains the output of the webhook trigger; otherwise the body is empty.
|
|
1362
|
-
*/
|
|
1363
|
-
put: operations["WebhookController_workflowEventPUT"];
|
|
1364
|
-
/**
|
|
1365
|
-
* Trigger workflow via custom webhook (POST)
|
|
1366
|
-
* @description Unauthenticated workflow trigger. The workflow must have a webhook trigger configured. The JSON request body and headers are forwarded to the trigger. When the workflow responds synchronously, the response body contains the output of the webhook trigger; otherwise the body is empty.
|
|
1337
|
+
* Manually execute workflow by ID
|
|
1338
|
+
* @description Starts a new execution of the workflow immediately. The workflow must be active and use a manual or scheduled trigger strategy. The optional inputData object supplies values for the custom input fields configured on the workflow "Manually Run" trigger.
|
|
1367
1339
|
*/
|
|
1368
|
-
post: operations["
|
|
1340
|
+
post: operations["ExecutionsController_manuallyExecuteWorkflow"];
|
|
1369
1341
|
delete?: never;
|
|
1370
1342
|
options?: never;
|
|
1371
1343
|
head?: never;
|
|
1372
1344
|
patch?: never;
|
|
1373
1345
|
trace?: never;
|
|
1374
1346
|
};
|
|
1375
|
-
"/api/
|
|
1347
|
+
"/api/executions": {
|
|
1376
1348
|
parameters: {
|
|
1377
1349
|
query?: never;
|
|
1378
1350
|
header?: never;
|
|
1379
1351
|
path?: never;
|
|
1380
1352
|
cookie?: never;
|
|
1381
1353
|
};
|
|
1382
|
-
get?: never;
|
|
1383
|
-
put?: never;
|
|
1384
1354
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @description
|
|
1355
|
+
* List executions in current workspace
|
|
1356
|
+
* @description Returns the executions in the current workspace, most recently started first. By default only the execution ID is returned per item; use the expansion query parameter to include further fields.
|
|
1387
1357
|
*/
|
|
1388
|
-
|
|
1358
|
+
get: operations["ExecutionsController_findAll"];
|
|
1359
|
+
put?: never;
|
|
1360
|
+
post?: never;
|
|
1389
1361
|
delete?: never;
|
|
1390
1362
|
options?: never;
|
|
1391
1363
|
head?: never;
|
|
1392
1364
|
patch?: never;
|
|
1393
1365
|
trace?: never;
|
|
1394
1366
|
};
|
|
1395
|
-
"/api/
|
|
1367
|
+
"/api/executions/{executionId}": {
|
|
1396
1368
|
parameters: {
|
|
1397
1369
|
query?: never;
|
|
1398
1370
|
header?: never;
|
|
@@ -1400,10 +1372,10 @@ interface paths {
|
|
|
1400
1372
|
cookie?: never;
|
|
1401
1373
|
};
|
|
1402
1374
|
/**
|
|
1403
|
-
*
|
|
1404
|
-
* @description
|
|
1375
|
+
* Get execution by ID
|
|
1376
|
+
* @description Returns a single execution. The ID and startedAt timestamp are always returned; use the expansion query parameter to include further fields. Request the executionPath expansion to receive the business-readable step list (step labels, per-step status including NEEDS_INPUT, timings, and loop iterations) that custom UIs render progress from. Request the pendingInput expansion to receive the field schemas for steps currently waiting for user input.
|
|
1405
1377
|
*/
|
|
1406
|
-
get: operations["
|
|
1378
|
+
get: operations["ExecutionsController_findOne"];
|
|
1407
1379
|
put?: never;
|
|
1408
1380
|
post?: never;
|
|
1409
1381
|
delete?: never;
|
|
@@ -1412,7 +1384,7 @@ interface paths {
|
|
|
1412
1384
|
patch?: never;
|
|
1413
1385
|
trace?: never;
|
|
1414
1386
|
};
|
|
1415
|
-
"/api/
|
|
1387
|
+
"/api/executions/{executionId}/stream": {
|
|
1416
1388
|
parameters: {
|
|
1417
1389
|
query?: never;
|
|
1418
1390
|
header?: never;
|
|
@@ -1420,10 +1392,10 @@ interface paths {
|
|
|
1420
1392
|
cookie?: never;
|
|
1421
1393
|
};
|
|
1422
1394
|
/**
|
|
1423
|
-
*
|
|
1424
|
-
* @description
|
|
1395
|
+
* Stream execution updates (SSE)
|
|
1396
|
+
* @description Server-Sent Events stream for real-time execution updates. Emits `execution.progress` snapshots (status + executionPath + pendingInput) as steps change, `loop.progress` while For Each / Repeat loops run, `execution.finished` on terminal status, and periodic heartbeats. Use fetch with Authorization header (EventSource cannot send Bearer tokens). Ideal for custom timeline / progress UIs.
|
|
1425
1397
|
*/
|
|
1426
|
-
get: operations["
|
|
1398
|
+
get: operations["ExecutionsController_streamExecution"];
|
|
1427
1399
|
put?: never;
|
|
1428
1400
|
post?: never;
|
|
1429
1401
|
delete?: never;
|
|
@@ -1432,7 +1404,7 @@ interface paths {
|
|
|
1432
1404
|
patch?: never;
|
|
1433
1405
|
trace?: never;
|
|
1434
1406
|
};
|
|
1435
|
-
"/api/
|
|
1407
|
+
"/api/actions/run": {
|
|
1436
1408
|
parameters: {
|
|
1437
1409
|
query?: never;
|
|
1438
1410
|
header?: never;
|
|
@@ -1442,10 +1414,78 @@ interface paths {
|
|
|
1442
1414
|
get?: never;
|
|
1443
1415
|
put?: never;
|
|
1444
1416
|
/**
|
|
1445
|
-
*
|
|
1446
|
-
* @description Creates
|
|
1417
|
+
* Run a single app action as an ad-hoc Execution
|
|
1418
|
+
* @description Creates a one-step Execution with `source: SDK`, runs the catalogue action via the same prepareAndRunAction path used by workflows, then finalises the Execution. Discover `appId` / `actionId` / `inputConfig` via GET /workflow-apps. Pass `connectionId` (Connection instance UUID) when the action needs a connection and more than one exists for the app. Poll GET /executions/{id} with expansion=executionPath for the same record.
|
|
1447
1419
|
*/
|
|
1448
|
-
post: operations["
|
|
1420
|
+
post: operations["ActionsController_run"];
|
|
1421
|
+
delete?: never;
|
|
1422
|
+
options?: never;
|
|
1423
|
+
head?: never;
|
|
1424
|
+
patch?: never;
|
|
1425
|
+
trace?: never;
|
|
1426
|
+
};
|
|
1427
|
+
"/api/runs": {
|
|
1428
|
+
parameters: {
|
|
1429
|
+
query?: never;
|
|
1430
|
+
header?: never;
|
|
1431
|
+
path?: never;
|
|
1432
|
+
cookie?: never;
|
|
1433
|
+
};
|
|
1434
|
+
get?: never;
|
|
1435
|
+
put?: never;
|
|
1436
|
+
/**
|
|
1437
|
+
* Start a multi-step ad-hoc Execution
|
|
1438
|
+
* @description Creates one Execution with `source: SDK` and a linear multi-step `executionPath`. Each step is a catalogue action run via prepareAndRunAction (same path as workflows and POST /actions/run). Connection resolution per step: sole usable connection, else workspace default (`isDefault`), else 400 with candidates. Poll GET /executions/{id} with expansion=executionPath for the same record.
|
|
1439
|
+
*/
|
|
1440
|
+
post: operations["RunsController_start"];
|
|
1441
|
+
delete?: never;
|
|
1442
|
+
options?: never;
|
|
1443
|
+
head?: never;
|
|
1444
|
+
patch?: never;
|
|
1445
|
+
trace?: never;
|
|
1446
|
+
};
|
|
1447
|
+
"/api/webhooks/workflows/{workflowId}": {
|
|
1448
|
+
parameters: {
|
|
1449
|
+
query?: never;
|
|
1450
|
+
header?: never;
|
|
1451
|
+
path?: never;
|
|
1452
|
+
cookie?: never;
|
|
1453
|
+
};
|
|
1454
|
+
/**
|
|
1455
|
+
* Trigger workflow via custom webhook (GET)
|
|
1456
|
+
* @description Unauthenticated workflow trigger. The workflow must have a webhook trigger configured. Query parameters and headers are forwarded to the trigger as the payload. When the workflow responds synchronously, the response body contains the output of the webhook trigger; otherwise the body is empty.
|
|
1457
|
+
*/
|
|
1458
|
+
get: operations["WebhookController_workflowEventGet"];
|
|
1459
|
+
/**
|
|
1460
|
+
* Trigger workflow via custom webhook (PUT)
|
|
1461
|
+
* @description Unauthenticated workflow trigger. The workflow must have a webhook trigger configured. The JSON request body and headers are forwarded to the trigger. When the workflow responds synchronously, the response body contains the output of the webhook trigger; otherwise the body is empty.
|
|
1462
|
+
*/
|
|
1463
|
+
put: operations["WebhookController_workflowEventPUT"];
|
|
1464
|
+
/**
|
|
1465
|
+
* Trigger workflow via custom webhook (POST)
|
|
1466
|
+
* @description Unauthenticated workflow trigger. The workflow must have a webhook trigger configured. The JSON request body and headers are forwarded to the trigger. When the workflow responds synchronously, the response body contains the output of the webhook trigger; otherwise the body is empty.
|
|
1467
|
+
*/
|
|
1468
|
+
post: operations["WebhookController_workflowEventPOST"];
|
|
1469
|
+
delete?: never;
|
|
1470
|
+
options?: never;
|
|
1471
|
+
head?: never;
|
|
1472
|
+
patch?: never;
|
|
1473
|
+
trace?: never;
|
|
1474
|
+
};
|
|
1475
|
+
"/api/webhooks/executions/{executionId}/nodes/{nodeId}/input": {
|
|
1476
|
+
parameters: {
|
|
1477
|
+
query?: never;
|
|
1478
|
+
header?: never;
|
|
1479
|
+
path?: never;
|
|
1480
|
+
cookie?: never;
|
|
1481
|
+
};
|
|
1482
|
+
get?: never;
|
|
1483
|
+
put?: never;
|
|
1484
|
+
/**
|
|
1485
|
+
* Submit input to a workflow execution step
|
|
1486
|
+
* @description Unauthenticated endpoint implementing the pause-for-user-input pattern: it resumes an execution paused in the NEEDS_INPUT status by submitting values for the node that is waiting. Identify the waiting node and its field schema via GET /executions/{executionId}?expansion=pendingInput,executionPath (steps with status NEEDS_INPUT, or the pendingInput array). Required fields from the schema must be present; missing required values return 400. The endpoint acknowledges receipt immediately and the execution resumes asynchronously.
|
|
1487
|
+
*/
|
|
1488
|
+
post: operations["WebhookController_executionStepEventPOST"];
|
|
1449
1489
|
delete?: never;
|
|
1450
1490
|
options?: never;
|
|
1451
1491
|
head?: never;
|
|
@@ -1620,6 +1660,8 @@ interface components {
|
|
|
1620
1660
|
SKILLS: boolean;
|
|
1621
1661
|
/** @description Whether the hexagonal agent builder canvas UI is enabled. */
|
|
1622
1662
|
AGENT_BUILDER_CANVAS: boolean;
|
|
1663
|
+
/** @description Whether the Solution Designer UI is enabled. */
|
|
1664
|
+
SOLUTION_DESIGNER: boolean;
|
|
1623
1665
|
/** @description Whether isolated code execution for agents is enabled. */
|
|
1624
1666
|
CODE_EXECUTION: boolean;
|
|
1625
1667
|
/** @description Whether SSO (OIDC) login is enabled. Requires at least one enabled SSO provider. */
|
|
@@ -1690,6 +1732,8 @@ interface components {
|
|
|
1690
1732
|
CreateQueueDto: {
|
|
1691
1733
|
/** @description Human-readable name for the queue. */
|
|
1692
1734
|
name: string;
|
|
1735
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
1736
|
+
allowedObjectTypeIds?: string[];
|
|
1693
1737
|
/** @description Description of what the queue is used for. */
|
|
1694
1738
|
description?: string;
|
|
1695
1739
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -1731,6 +1775,14 @@ interface components {
|
|
|
1731
1775
|
/** @description Number of items in the queue. */
|
|
1732
1776
|
items: number;
|
|
1733
1777
|
};
|
|
1778
|
+
QueueAllowedObjectTypeDto: {
|
|
1779
|
+
/** @description Object type ID. */
|
|
1780
|
+
id: string;
|
|
1781
|
+
/** @description Object type name. */
|
|
1782
|
+
name: string;
|
|
1783
|
+
/** @description Object type slug. */
|
|
1784
|
+
slug: string;
|
|
1785
|
+
};
|
|
1734
1786
|
QueueResponseDto: {
|
|
1735
1787
|
/** @description Queue ID. */
|
|
1736
1788
|
id: string;
|
|
@@ -1776,6 +1828,8 @@ interface components {
|
|
|
1776
1828
|
createdByWorkspaceUser?: components["schemas"]["QueueCreatedByWorkspaceUserDto"];
|
|
1777
1829
|
/** @description Relation counts. Included when `expansion=itemCounts` is requested. */
|
|
1778
1830
|
_count?: components["schemas"]["QueueItemCountsDto"];
|
|
1831
|
+
/** @description ObjectTypes this queue accepts for linked items. Empty means any type is allowed. Included when `expansion=allowedObjectTypes` is requested. */
|
|
1832
|
+
allowedObjectTypes?: components["schemas"]["QueueAllowedObjectTypeDto"][];
|
|
1779
1833
|
};
|
|
1780
1834
|
QueueStatsResponseDto: {
|
|
1781
1835
|
/** @description Total number of items in the queue. */
|
|
@@ -1794,6 +1848,8 @@ interface components {
|
|
|
1794
1848
|
UpdateQueueDto: {
|
|
1795
1849
|
/** @description Human-readable name for the queue. */
|
|
1796
1850
|
name?: string;
|
|
1851
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
1852
|
+
allowedObjectTypeIds?: string[];
|
|
1797
1853
|
/** @description Description of what the queue is used for. */
|
|
1798
1854
|
description?: string;
|
|
1799
1855
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -1814,6 +1870,8 @@ interface components {
|
|
|
1814
1870
|
CreateQueueItemDto: {
|
|
1815
1871
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
1816
1872
|
externalId?: string;
|
|
1873
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
1874
|
+
objectId?: string;
|
|
1817
1875
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
1818
1876
|
data?: {
|
|
1819
1877
|
[key: string]: unknown;
|
|
@@ -1860,11 +1918,31 @@ interface components {
|
|
|
1860
1918
|
/** @description Workflow the execution belongs to. */
|
|
1861
1919
|
workflow: components["schemas"]["QueueItemExecutionWorkflowDto"];
|
|
1862
1920
|
};
|
|
1921
|
+
QueueItemObjectTypeSummaryDto: {
|
|
1922
|
+
/** @description Object type ID. */
|
|
1923
|
+
id: string;
|
|
1924
|
+
/** @description Object type name. */
|
|
1925
|
+
name: string;
|
|
1926
|
+
/** @description Object type slug. */
|
|
1927
|
+
slug: string;
|
|
1928
|
+
};
|
|
1929
|
+
QueueItemObjectSummaryDto: {
|
|
1930
|
+
/** @description Object ID. */
|
|
1931
|
+
id: string;
|
|
1932
|
+
/** @description Object display name. */
|
|
1933
|
+
name: string;
|
|
1934
|
+
/** @description Current object state ID. */
|
|
1935
|
+
state: string | null;
|
|
1936
|
+
/** @description Object type summary. */
|
|
1937
|
+
objectType: components["schemas"]["QueueItemObjectTypeSummaryDto"];
|
|
1938
|
+
};
|
|
1863
1939
|
QueueItemCreateResponseDto: {
|
|
1864
1940
|
/** @description Queue item ID. */
|
|
1865
1941
|
id: string;
|
|
1866
1942
|
/** @description External identifier used for deduplication. */
|
|
1867
1943
|
externalId: string | null;
|
|
1944
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
1945
|
+
objectId: string | null;
|
|
1868
1946
|
/** @description JSON payload for the item. */
|
|
1869
1947
|
data: {
|
|
1870
1948
|
[key: string]: unknown;
|
|
@@ -1927,6 +2005,8 @@ interface components {
|
|
|
1927
2005
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
1928
2006
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
1929
2007
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
2008
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
2009
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
1930
2010
|
/** @description True when an existing item with the same externalId was returned instead of creating a new one. */
|
|
1931
2011
|
isDuplicate: boolean;
|
|
1932
2012
|
};
|
|
@@ -1947,6 +2027,8 @@ interface components {
|
|
|
1947
2027
|
id: string;
|
|
1948
2028
|
/** @description External identifier used for deduplication. */
|
|
1949
2029
|
externalId: string | null;
|
|
2030
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
2031
|
+
objectId: string | null;
|
|
1950
2032
|
/** @description JSON payload for the item. */
|
|
1951
2033
|
data: {
|
|
1952
2034
|
[key: string]: unknown;
|
|
@@ -2009,6 +2091,8 @@ interface components {
|
|
|
2009
2091
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
2010
2092
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
2011
2093
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
2094
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
2095
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
2012
2096
|
};
|
|
2013
2097
|
BulkCreateQueueItemsSummaryDto: {
|
|
2014
2098
|
/** @description Number of items created. */
|
|
@@ -2059,6 +2143,8 @@ interface components {
|
|
|
2059
2143
|
updatedAt: string;
|
|
2060
2144
|
/** @description External identifier used for deduplication. */
|
|
2061
2145
|
externalId: string | null;
|
|
2146
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
2147
|
+
FK_objectId: string | null;
|
|
2062
2148
|
/** @description JSON payload for the item. */
|
|
2063
2149
|
data: {
|
|
2064
2150
|
[key: string]: unknown;
|
|
@@ -2149,6 +2235,8 @@ interface components {
|
|
|
2149
2235
|
UpdateQueueItemDto: {
|
|
2150
2236
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
2151
2237
|
externalId?: string;
|
|
2238
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
2239
|
+
objectId?: string;
|
|
2152
2240
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
2153
2241
|
data?: {
|
|
2154
2242
|
[key: string]: unknown;
|
|
@@ -2314,33 +2402,45 @@ interface components {
|
|
|
2314
2402
|
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
2315
2403
|
managedByCode?: boolean;
|
|
2316
2404
|
};
|
|
2317
|
-
|
|
2318
|
-
/** @description
|
|
2319
|
-
|
|
2320
|
-
/** @description
|
|
2321
|
-
name
|
|
2322
|
-
/** @description
|
|
2323
|
-
|
|
2324
|
-
/** @description
|
|
2325
|
-
|
|
2326
|
-
/**
|
|
2327
|
-
|
|
2328
|
-
|
|
2329
|
-
|
|
2330
|
-
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
|
|
2335
|
-
|
|
2336
|
-
/** @description
|
|
2337
|
-
|
|
2405
|
+
UpsertObjectTypeBySlugDto: {
|
|
2406
|
+
/** @description Stable workspace-scoped slug (lowercase, digits, hyphens). Used as the upsert key. */
|
|
2407
|
+
slug: string;
|
|
2408
|
+
/** @description Singular display name. */
|
|
2409
|
+
name?: string;
|
|
2410
|
+
/** @description Plural display name. */
|
|
2411
|
+
namePlural?: string;
|
|
2412
|
+
/** @description Description. */
|
|
2413
|
+
description?: string;
|
|
2414
|
+
/**
|
|
2415
|
+
* @description Icon identifier.
|
|
2416
|
+
* @default box
|
|
2417
|
+
*/
|
|
2418
|
+
icon: string;
|
|
2419
|
+
/**
|
|
2420
|
+
* @description Hex colour.
|
|
2421
|
+
* @default #3B82F6
|
|
2422
|
+
*/
|
|
2423
|
+
color: string;
|
|
2424
|
+
/** @description Field definitions grouped into sections. */
|
|
2425
|
+
attributeSchema: {
|
|
2338
2426
|
[key: string]: unknown;
|
|
2339
|
-
}
|
|
2340
|
-
/** @description
|
|
2341
|
-
|
|
2427
|
+
};
|
|
2428
|
+
/** @description Optional state machine definition. */
|
|
2429
|
+
stateSchema?: {
|
|
2342
2430
|
[key: string]: unknown;
|
|
2343
|
-
}
|
|
2431
|
+
} | null;
|
|
2432
|
+
/** @description Whether the type is enabled. */
|
|
2433
|
+
isEnabled?: boolean;
|
|
2434
|
+
/**
|
|
2435
|
+
* @description When false (default), reject unknown attribute keys on entity writes.
|
|
2436
|
+
* @default false
|
|
2437
|
+
*/
|
|
2438
|
+
allowUnknownAttributes: boolean;
|
|
2439
|
+
/**
|
|
2440
|
+
* @description Marks the type as code-managed. Defaults to true on upsert.
|
|
2441
|
+
* @default true
|
|
2442
|
+
*/
|
|
2443
|
+
managedByCode: boolean;
|
|
2344
2444
|
};
|
|
2345
2445
|
ObjectTypeUserSummaryDto: {
|
|
2346
2446
|
/** @description User ID. */
|
|
@@ -2374,6 +2474,12 @@ interface components {
|
|
|
2374
2474
|
color: string;
|
|
2375
2475
|
/** @description Whether the entity type is enabled. */
|
|
2376
2476
|
isEnabled: boolean;
|
|
2477
|
+
/** @description When false, entity create/update rejects attribute keys not declared on the type. Reserved key `extensions` is always allowed. */
|
|
2478
|
+
allowUnknownAttributes: boolean;
|
|
2479
|
+
/** @description True when last written by code (CLI / SDK upsert). */
|
|
2480
|
+
managedByCode: boolean;
|
|
2481
|
+
/** @description Incremented when attributeSchema, stateSchema, or allowUnknownAttributes changes. */
|
|
2482
|
+
schemaRevision: number;
|
|
2377
2483
|
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
2378
2484
|
description?: string | null;
|
|
2379
2485
|
/** @description Field definitions grouped into sections. Included when `expansion=attributeSchema` is requested. */
|
|
@@ -2651,49 +2757,55 @@ interface components {
|
|
|
2651
2757
|
[key: string]: string;
|
|
2652
2758
|
};
|
|
2653
2759
|
};
|
|
2654
|
-
|
|
2655
|
-
/** @description
|
|
2656
|
-
name: string;
|
|
2657
|
-
/** @description Description of the knowledge base. */
|
|
2658
|
-
description?: string;
|
|
2659
|
-
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
2660
|
-
chunkOverlap?: number;
|
|
2661
|
-
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
2662
|
-
chunkSize?: number;
|
|
2663
|
-
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
2664
|
-
embeddingModel?: string;
|
|
2665
|
-
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
2666
|
-
embeddingProvider?: string;
|
|
2667
|
-
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
2668
|
-
dimensions?: number;
|
|
2669
|
-
};
|
|
2670
|
-
KnowledgeCountDto: {
|
|
2671
|
-
/** @description Number of vector references stored in this knowledge base. */
|
|
2672
|
-
vectorRefs: number;
|
|
2673
|
-
};
|
|
2674
|
-
KnowledgeVectorRefSummaryDto: {
|
|
2675
|
-
/** @description Vector reference ID. */
|
|
2676
|
-
id: string;
|
|
2677
|
-
/** @description ID of the knowledge base the vector reference belongs to. */
|
|
2678
|
-
FK_knowledgeId: string;
|
|
2679
|
-
};
|
|
2680
|
-
KnowledgeUsageDto: {
|
|
2681
|
-
/** @description Total prompt tokens consumed when embedding content into this knowledge base. */
|
|
2682
|
-
promptTokens: number;
|
|
2683
|
-
};
|
|
2684
|
-
KnowledgeWorkspaceDto: {
|
|
2685
|
-
/** @description Workspace ID. */
|
|
2760
|
+
WorkflowAppResponseDto: {
|
|
2761
|
+
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
2686
2762
|
id: string;
|
|
2687
|
-
/** @description
|
|
2763
|
+
/** @description Human-readable app name. */
|
|
2688
2764
|
name: string;
|
|
2765
|
+
/** @description App description. */
|
|
2766
|
+
description: string;
|
|
2767
|
+
/** @description URL of the app logo. */
|
|
2768
|
+
logoUrl: string;
|
|
2769
|
+
/** @description Whether the app is published and available for use. */
|
|
2770
|
+
isPublished: boolean;
|
|
2771
|
+
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
2772
|
+
needsConnection: boolean;
|
|
2773
|
+
/** @description Whether the app can be used by agents. */
|
|
2774
|
+
availableForAgent: boolean;
|
|
2775
|
+
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
2776
|
+
actions: {
|
|
2777
|
+
[key: string]: unknown;
|
|
2778
|
+
}[];
|
|
2779
|
+
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
2780
|
+
triggers: {
|
|
2781
|
+
[key: string]: unknown;
|
|
2782
|
+
}[];
|
|
2783
|
+
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
2784
|
+
connections: {
|
|
2785
|
+
[key: string]: unknown;
|
|
2786
|
+
}[];
|
|
2689
2787
|
};
|
|
2690
|
-
|
|
2691
|
-
/**
|
|
2788
|
+
AgentResponseDto: {
|
|
2789
|
+
/**
|
|
2790
|
+
* @description Agent ID (UUID)
|
|
2791
|
+
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
2792
|
+
*/
|
|
2692
2793
|
id: string;
|
|
2693
|
-
/**
|
|
2794
|
+
/**
|
|
2795
|
+
* @description Agent name
|
|
2796
|
+
* @example Invoice Triage Agent
|
|
2797
|
+
*/
|
|
2694
2798
|
name: string;
|
|
2695
|
-
/** @description
|
|
2696
|
-
|
|
2799
|
+
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
2800
|
+
slug?: string | null;
|
|
2801
|
+
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
2802
|
+
managedByCode?: boolean;
|
|
2803
|
+
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
2804
|
+
FK_aiConnectionId: string | null;
|
|
2805
|
+
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
2806
|
+
description?: string | null;
|
|
2807
|
+
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
2808
|
+
profileImageUrl?: string | null;
|
|
2697
2809
|
/**
|
|
2698
2810
|
* Format: date-time
|
|
2699
2811
|
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
@@ -2704,366 +2816,456 @@ interface components {
|
|
|
2704
2816
|
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2705
2817
|
*/
|
|
2706
2818
|
updatedAt?: string;
|
|
2707
|
-
/** @description
|
|
2708
|
-
|
|
2709
|
-
/** @description Default chunk size in words used when uploading text. Included when `expansion=chunkSize` is requested. */
|
|
2710
|
-
chunkSize?: number;
|
|
2711
|
-
/** @description Default chunk overlap in words used when uploading text. Included when `expansion=chunkOverlap` is requested. */
|
|
2712
|
-
chunkOverlap?: number;
|
|
2713
|
-
/** @description Embedding model used for this knowledge base. Included when `expansion=embeddingModel` is requested. */
|
|
2714
|
-
embeddingModel?: string;
|
|
2715
|
-
/** @description Embedding provider used for this knowledge base. Included when `expansion=embeddingProvider` is requested. */
|
|
2716
|
-
embeddingProvider?: string;
|
|
2717
|
-
/** @description Embedding vector dimensions. Included when `expansion=dimensions` is requested. */
|
|
2718
|
-
dimensions?: number;
|
|
2719
|
-
/** @description Aggregate counts. Included when `expansion=countVectorRefs` is requested. */
|
|
2720
|
-
_count?: components["schemas"]["KnowledgeCountDto"];
|
|
2721
|
-
/** @description Vector references stored in this knowledge base. Included when `expansion=vectorRefs` is requested. */
|
|
2722
|
-
vectorRefs?: components["schemas"]["KnowledgeVectorRefSummaryDto"][];
|
|
2723
|
-
/** @description Embedding token usage. Included when `expansion=usage` is requested. */
|
|
2724
|
-
usage?: components["schemas"]["KnowledgeUsageDto"];
|
|
2725
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
2726
|
-
workspace?: components["schemas"]["KnowledgeWorkspaceDto"];
|
|
2727
|
-
};
|
|
2728
|
-
UpdateKnowledgeDto: {
|
|
2729
|
-
/** @description Name of the knowledge base. */
|
|
2730
|
-
name?: string;
|
|
2731
|
-
/** @description Description of the knowledge base. */
|
|
2732
|
-
description?: string;
|
|
2733
|
-
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
2734
|
-
chunkOverlap?: number;
|
|
2735
|
-
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
2736
|
-
chunkSize?: number;
|
|
2737
|
-
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
2738
|
-
embeddingModel?: string;
|
|
2739
|
-
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
2740
|
-
embeddingProvider?: string;
|
|
2741
|
-
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
2742
|
-
dimensions?: number;
|
|
2743
|
-
};
|
|
2744
|
-
SaveUploadedTextToKnowledgeDto: {
|
|
2745
|
-
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
2746
|
-
name: string;
|
|
2747
|
-
/** @description Raw text content to embed into the knowledge base. */
|
|
2748
|
-
text: string;
|
|
2749
|
-
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
2750
|
-
chunkOverlap: number;
|
|
2751
|
-
/** @description Chunk size in words used to split the text before embedding. */
|
|
2752
|
-
chunkSize: number;
|
|
2753
|
-
};
|
|
2754
|
-
KnowledgeDocumentResponseDto: {
|
|
2755
|
-
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
2756
|
-
id: string;
|
|
2757
|
-
/** @description Document name. */
|
|
2758
|
-
name: string;
|
|
2759
|
-
/**
|
|
2760
|
-
* Format: date-time
|
|
2761
|
-
* @description Creation timestamp.
|
|
2762
|
-
*/
|
|
2763
|
-
createdAt: string;
|
|
2764
|
-
/** @description Number of parts (chunks) the document was split into. */
|
|
2765
|
-
partCount: number;
|
|
2766
|
-
/**
|
|
2767
|
-
* @description Whether the document is a multi-part group or a standalone single-part upload.
|
|
2768
|
-
* @enum {string}
|
|
2769
|
-
*/
|
|
2770
|
-
type: "group" | "standalone";
|
|
2771
|
-
};
|
|
2772
|
-
KnowledgeDocumentGroupVectorRefDto: {
|
|
2773
|
-
/** @description Vector reference ID. */
|
|
2774
|
-
id: string;
|
|
2775
|
-
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
2776
|
-
name: string;
|
|
2777
|
-
/**
|
|
2778
|
-
* Format: date-time
|
|
2779
|
-
* @description Creation timestamp.
|
|
2780
|
-
*/
|
|
2781
|
-
createdAt: string;
|
|
2782
|
-
/** @description Part number within the group, or null for single-part uploads. */
|
|
2783
|
-
part: number | null;
|
|
2784
|
-
/** @description Storage path of the raw text for this part. */
|
|
2785
|
-
s3Link: string | null;
|
|
2786
|
-
};
|
|
2787
|
-
KnowledgeDocumentGroupResponseDto: {
|
|
2788
|
-
/** @description Document group ID. */
|
|
2789
|
-
id: string;
|
|
2790
|
-
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
2791
|
-
name: string | null;
|
|
2792
|
-
/**
|
|
2793
|
-
* Format: date-time
|
|
2794
|
-
* @description Creation timestamp.
|
|
2795
|
-
*/
|
|
2796
|
-
createdAt: string;
|
|
2797
|
-
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
2798
|
-
FK_knowledgeId: string | null;
|
|
2799
|
-
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
2800
|
-
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
2801
|
-
};
|
|
2802
|
-
ManuallyRunWorkflowInputDataDto: {
|
|
2819
|
+
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
2820
|
+
instructions?: string | null;
|
|
2803
2821
|
/**
|
|
2804
|
-
* @description
|
|
2805
|
-
* @example
|
|
2806
|
-
* "customerEmail": "jane@example.com",
|
|
2807
|
-
* "priority": "high"
|
|
2808
|
-
* }
|
|
2822
|
+
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
2823
|
+
* @example 1
|
|
2809
2824
|
*/
|
|
2810
|
-
|
|
2811
|
-
|
|
2812
|
-
|
|
2813
|
-
};
|
|
2814
|
-
ExecuteWorkflowResponseDto: {
|
|
2815
|
-
/** @description ID of the newly created execution. Poll GET /executions/{executionId} to track progress. */
|
|
2816
|
-
id: string;
|
|
2817
|
-
};
|
|
2818
|
-
ExecutionWorkspaceSummaryDto: {
|
|
2819
|
-
/** @description Workspace ID */
|
|
2820
|
-
id: string;
|
|
2821
|
-
/** @description Workspace name */
|
|
2822
|
-
name: string;
|
|
2823
|
-
};
|
|
2824
|
-
ExecutionProjectSummaryDto: {
|
|
2825
|
-
/** @description Project ID */
|
|
2826
|
-
id: string;
|
|
2827
|
-
/** @description Project name */
|
|
2828
|
-
name: string;
|
|
2829
|
-
/** @description The workspace the project belongs to. Included when `expansion=workspace` is requested alongside `workflow` and `project`. */
|
|
2830
|
-
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
2831
|
-
};
|
|
2832
|
-
ExecutionWorkflowSummaryDto: {
|
|
2833
|
-
/** @description Workflow ID */
|
|
2834
|
-
id: string;
|
|
2835
|
-
/** @description Workflow name */
|
|
2836
|
-
name: string;
|
|
2837
|
-
/** @description The project the workflow belongs to. Included when `expansion=project` is requested alongside `workflow`. */
|
|
2838
|
-
project?: components["schemas"]["ExecutionProjectSummaryDto"];
|
|
2839
|
-
};
|
|
2840
|
-
ExecutionPathStepDto: {
|
|
2841
|
-
/** @description ID of the workflow node this step represents */
|
|
2842
|
-
nodeId: string;
|
|
2843
|
-
/** @description Human-friendly node name */
|
|
2844
|
-
label: string;
|
|
2845
|
-
/** @description ID of the app the node belongs to */
|
|
2846
|
-
appId: string;
|
|
2847
|
-
/** @description Action ID, present when the step is an action node */
|
|
2848
|
-
actionId?: string;
|
|
2849
|
-
/** @description Trigger ID, present when the step is the trigger node */
|
|
2850
|
-
triggerId?: string;
|
|
2825
|
+
temperature?: number;
|
|
2826
|
+
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
2827
|
+
maxOutputTokens?: number | null;
|
|
2851
2828
|
/**
|
|
2852
|
-
* @description
|
|
2853
|
-
* @
|
|
2829
|
+
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
2830
|
+
* @example 1
|
|
2854
2831
|
*/
|
|
2855
|
-
|
|
2856
|
-
/** @description Status detail message for the step */
|
|
2857
|
-
statusMessage?: string;
|
|
2858
|
-
/** @description Timestamp when the step started */
|
|
2859
|
-
startTime?: string;
|
|
2860
|
-
/** @description Timestamp when the step finished */
|
|
2861
|
-
endTime?: string;
|
|
2862
|
-
/** @description nodeId this step is an iteration of (set on loop child entries) */
|
|
2863
|
-
iterationOf?: string;
|
|
2864
|
-
/** @description Index of the loop iteration this step belongs to */
|
|
2865
|
-
iterationIndex?: number;
|
|
2866
|
-
/** @description On the collapsed loop parent entry: how many times the loop ran (or is planned to run) */
|
|
2867
|
-
iterationCount?: number;
|
|
2832
|
+
topP?: number;
|
|
2868
2833
|
/**
|
|
2869
|
-
* @description
|
|
2870
|
-
* @
|
|
2834
|
+
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
2835
|
+
* @example 0
|
|
2871
2836
|
*/
|
|
2872
|
-
|
|
2873
|
-
/** @description Number of approve decisions received so far */
|
|
2874
|
-
approvalsReceived?: number;
|
|
2875
|
-
/** @description Number of approvals required for quorum / current stage */
|
|
2876
|
-
approvalsRequired?: number;
|
|
2877
|
-
};
|
|
2878
|
-
PendingInputFieldDto: {
|
|
2879
|
-
/** @description Field ID used as the key when submitting input */
|
|
2880
|
-
id: string;
|
|
2881
|
-
/** @description Human-readable field label */
|
|
2882
|
-
label: string;
|
|
2883
|
-
/** @description Field input type from the workflow builder (e.g. text, number, select) */
|
|
2884
|
-
inputType: string;
|
|
2885
|
-
/** @description Whether the field must be provided to resume */
|
|
2886
|
-
required: boolean;
|
|
2887
|
-
/** @description Optional helper text for the field */
|
|
2888
|
-
description?: string;
|
|
2889
|
-
/** @description Selectable options when the field is a select-like input */
|
|
2890
|
-
options?: {
|
|
2891
|
-
label?: string;
|
|
2892
|
-
value?: string;
|
|
2893
|
-
}[];
|
|
2894
|
-
};
|
|
2895
|
-
PendingInputDto: {
|
|
2896
|
-
/** @description ID of the waiting workflow node */
|
|
2897
|
-
nodeId: string;
|
|
2898
|
-
/** @description Human-friendly node name */
|
|
2899
|
-
label: string;
|
|
2900
|
-
/** @description Action ID of the waiting node, when it is an action step */
|
|
2901
|
-
actionId?: string;
|
|
2902
|
-
/** @description Optional instructions configured on the waiting node */
|
|
2903
|
-
instructions?: string;
|
|
2904
|
-
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
2905
|
-
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
2906
|
-
};
|
|
2907
|
-
ExecutionResponseDto: {
|
|
2908
|
-
/** @description Execution ID */
|
|
2909
|
-
id: string;
|
|
2837
|
+
frequencyPenalty?: number;
|
|
2910
2838
|
/**
|
|
2911
|
-
*
|
|
2912
|
-
* @
|
|
2839
|
+
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
2840
|
+
* @example 0
|
|
2913
2841
|
*/
|
|
2914
|
-
|
|
2842
|
+
presencePenalty?: number;
|
|
2915
2843
|
/**
|
|
2916
|
-
*
|
|
2917
|
-
* @
|
|
2844
|
+
* @description Maximum retries for a failed model call. Included when `expansion=maxRetries` is requested.
|
|
2845
|
+
* @example 0
|
|
2918
2846
|
*/
|
|
2919
|
-
|
|
2847
|
+
maxRetries?: number;
|
|
2848
|
+
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
2849
|
+
seed?: number | null;
|
|
2920
2850
|
/**
|
|
2921
|
-
*
|
|
2922
|
-
* @
|
|
2851
|
+
* @description Maximum tool roundtrips per turn. Included when `expansion=maxToolRoundtrips` is requested.
|
|
2852
|
+
* @example 5
|
|
2923
2853
|
*/
|
|
2924
|
-
|
|
2854
|
+
maxToolRoundtrips?: number;
|
|
2925
2855
|
/**
|
|
2926
|
-
*
|
|
2927
|
-
* @
|
|
2856
|
+
* @description How many previous messages are sent to the model. Included when `expansion=messageLookbackLimit` is requested.
|
|
2857
|
+
* @example 40
|
|
2928
2858
|
*/
|
|
2929
|
-
|
|
2930
|
-
/** @description
|
|
2931
|
-
|
|
2932
|
-
/** @description Raw execution node state (JSON). Included when `expansion=nodes` is requested. Most integrations should prefer the `executionPath` expansion instead. */
|
|
2933
|
-
nodes?: {
|
|
2934
|
-
[key: string]: unknown;
|
|
2935
|
-
}[];
|
|
2936
|
-
/** @description Raw execution edge state (JSON). Included when `expansion=edges` is requested. */
|
|
2937
|
-
edges?: {
|
|
2859
|
+
messageLookbackLimit?: number;
|
|
2860
|
+
/** @description Configured tool nodes (app actions) for the agent. Included when `expansion=tools` is requested. */
|
|
2861
|
+
tools?: {
|
|
2938
2862
|
[key: string]: unknown;
|
|
2939
|
-
}[];
|
|
2863
|
+
}[] | null;
|
|
2864
|
+
/** @description Action IDs of the configured tools. Included when `expansion=toolIds` is requested. */
|
|
2865
|
+
toolIds?: string[];
|
|
2866
|
+
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
2867
|
+
taskNamingInstructions?: string | null;
|
|
2868
|
+
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
2869
|
+
enabledBuiltInTools?: string[];
|
|
2870
|
+
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
2871
|
+
enabledPlatformTools?: string[];
|
|
2872
|
+
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
2873
|
+
dynamicActionDiscoveryEnabled?: boolean;
|
|
2874
|
+
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
2875
|
+
dynamicMcpDiscoveryEnabled?: boolean;
|
|
2876
|
+
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
2877
|
+
dynamicSelfInstructionsEnabled?: boolean;
|
|
2878
|
+
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
2879
|
+
memoryEnabled?: boolean;
|
|
2880
|
+
/** @description Whether runtime planning tools are enabled. Included when `expansion=enablePlanning` is requested. */
|
|
2881
|
+
enablePlanning?: boolean;
|
|
2882
|
+
/** @description Whether oversized tool-result offload is enabled. Included when `expansion=enableToolResultOffload` is requested. */
|
|
2883
|
+
enableToolResultOffload?: boolean;
|
|
2884
|
+
/** @description Byte threshold for tool-result offload. Included when `expansion=toolResultOffloadThresholdBytes` is requested. */
|
|
2885
|
+
toolResultOffloadThresholdBytes?: number;
|
|
2886
|
+
/** @description Whether long-horizon mode is enabled. Included when `expansion=longHorizonMode` is requested. */
|
|
2887
|
+
longHorizonMode?: boolean;
|
|
2888
|
+
/** @description prepareStep safety-net policy ids. Included when `expansion=enabledToolPolicies` is requested. */
|
|
2889
|
+
enabledToolPolicies?: string[];
|
|
2890
|
+
/** @description Per-tool force overrides. Included when `expansion=forcedTools` is requested. */
|
|
2891
|
+
forcedTools?: string[];
|
|
2892
|
+
/** @description When true with planning, gate heavy tools until plan approval. Included when `expansion=requirePlanApproval` is requested. */
|
|
2893
|
+
requirePlanApproval?: boolean;
|
|
2894
|
+
/** @description Optional elevated max steps for long-horizon mode. Included when `expansion=longHorizonMaxSteps` is requested. */
|
|
2895
|
+
longHorizonMaxSteps?: number | null;
|
|
2896
|
+
/** @description Optional max tokens per run hint for long-horizon mode. Included when `expansion=longHorizonMaxTokensPerRun` is requested. */
|
|
2897
|
+
longHorizonMaxTokensPerRun?: number | null;
|
|
2940
2898
|
/**
|
|
2941
|
-
* @description
|
|
2899
|
+
* @description Memory partitioning scope. Included when `expansion=memoryScope` is requested.
|
|
2942
2900
|
* @enum {string}
|
|
2943
2901
|
*/
|
|
2944
|
-
|
|
2945
|
-
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
2946
|
-
statusMessage?: string | null;
|
|
2947
|
-
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
2948
|
-
output?: {
|
|
2949
|
-
[key: string]: unknown;
|
|
2950
|
-
} | null;
|
|
2902
|
+
memoryScope?: "PER_USER" | "PER_AGENT" | "PER_USER_PER_AGENT";
|
|
2951
2903
|
/**
|
|
2952
|
-
*
|
|
2953
|
-
* @
|
|
2904
|
+
* @description Days memories are retained. Included when `expansion=memoryRetentionDays` is requested.
|
|
2905
|
+
* @example 90
|
|
2954
2906
|
*/
|
|
2955
|
-
|
|
2907
|
+
memoryRetentionDays?: number;
|
|
2908
|
+
/** @description Suggested prompts shown to users starting a conversation. Included when `expansion=suggestedPrompts` is requested. */
|
|
2909
|
+
suggestedPrompts?: string[];
|
|
2956
2910
|
/**
|
|
2957
|
-
*
|
|
2958
|
-
* @
|
|
2911
|
+
* Format: date-time
|
|
2912
|
+
* @description When the first-time builder setup wizard was completed. Included when `expansion=builderSetupCompletedAt` is requested.
|
|
2959
2913
|
*/
|
|
2960
|
-
|
|
2961
|
-
/** @description
|
|
2962
|
-
|
|
2914
|
+
builderSetupCompletedAt?: string | null;
|
|
2915
|
+
/** @description Saved canvas node positions for the agent builder. Included when `expansion=builderCanvasPositions` is requested. */
|
|
2916
|
+
builderCanvasPositions?: {
|
|
2963
2917
|
[key: string]: unknown;
|
|
2964
2918
|
} | null;
|
|
2965
|
-
/** @description
|
|
2966
|
-
|
|
2967
|
-
/** @description
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
|
|
2971
|
-
|
|
2972
|
-
|
|
2973
|
-
|
|
2974
|
-
|
|
2975
|
-
source?: "WORKFLOW" | "SDK";
|
|
2976
|
-
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
2977
|
-
name?: string | null;
|
|
2978
|
-
};
|
|
2979
|
-
RunActionDto: {
|
|
2980
|
-
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
2981
|
-
appId: string;
|
|
2982
|
-
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
2983
|
-
actionId: string;
|
|
2984
|
-
/** @description Connection instance UUID (`Connection.id`). Required when the action needs a connection and the workspace has more than one connection for the app with no single workspace default. When omitted: sole usable connection for the app is used; else the workspace default (`isDefault`); else 400 with candidates. Never silently picks among multiple non-default connections. */
|
|
2985
|
-
connectionId?: string;
|
|
2986
|
-
/** @description Project UUID used for variable/project scoping. When omitted and the workspace has exactly one project, that project is used; otherwise the request fails with 400. */
|
|
2987
|
-
projectId?: string;
|
|
2988
|
-
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
2989
|
-
input?: {
|
|
2990
|
-
[key: string]: unknown;
|
|
2991
|
-
};
|
|
2992
|
-
/** @description Optional display name for the ad-hoc Execution. */
|
|
2993
|
-
name?: string;
|
|
2994
|
-
};
|
|
2995
|
-
RunActionResponseDto: {
|
|
2996
|
-
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
2997
|
-
id: string;
|
|
2998
|
-
/**
|
|
2999
|
-
* @description Final execution status after the single action step.
|
|
3000
|
-
* @enum {string}
|
|
3001
|
-
*/
|
|
3002
|
-
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3003
|
-
/** @description Human-readable status detail. */
|
|
3004
|
-
statusMessage?: string | null;
|
|
3005
|
-
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
3006
|
-
output?: {
|
|
3007
|
-
[key: string]: unknown;
|
|
2919
|
+
/** @description Selected model ID within the AI provider connection. Included when `expansion=selectedModelId` is requested. */
|
|
2920
|
+
selectedModelId?: string | null;
|
|
2921
|
+
/** @description Assigned AI provider connection. Included when `expansion=aiConnection` is requested. */
|
|
2922
|
+
aiConnection?: {
|
|
2923
|
+
id?: string;
|
|
2924
|
+
name?: string;
|
|
2925
|
+
providerConfig?: {
|
|
2926
|
+
id?: string;
|
|
2927
|
+
providerSlug?: string;
|
|
2928
|
+
};
|
|
3008
2929
|
} | null;
|
|
3009
|
-
/** @description
|
|
3010
|
-
|
|
2930
|
+
/** @description Knowledge notebooks attached to the agent. Included when `expansion=knowledge` is requested. */
|
|
2931
|
+
agentKnowledge?: {
|
|
2932
|
+
id?: string;
|
|
2933
|
+
knowledge?: {
|
|
2934
|
+
id?: string;
|
|
2935
|
+
name?: string;
|
|
2936
|
+
};
|
|
2937
|
+
}[];
|
|
2938
|
+
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
2939
|
+
agentObjectTypes?: {
|
|
2940
|
+
id?: string;
|
|
2941
|
+
scope?: string;
|
|
2942
|
+
objectType?: {
|
|
2943
|
+
id?: string;
|
|
2944
|
+
name?: string;
|
|
2945
|
+
slug?: string;
|
|
2946
|
+
icon?: string | null;
|
|
2947
|
+
color?: string | null;
|
|
2948
|
+
};
|
|
2949
|
+
}[];
|
|
2950
|
+
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
2951
|
+
agentObjects?: {
|
|
2952
|
+
id?: string;
|
|
2953
|
+
scope?: string;
|
|
2954
|
+
object?: {
|
|
2955
|
+
id?: string;
|
|
2956
|
+
name?: string;
|
|
2957
|
+
state?: string;
|
|
2958
|
+
objectType?: {
|
|
2959
|
+
id?: string;
|
|
2960
|
+
name?: string;
|
|
2961
|
+
slug?: string;
|
|
2962
|
+
icon?: string | null;
|
|
2963
|
+
color?: string | null;
|
|
2964
|
+
};
|
|
2965
|
+
};
|
|
2966
|
+
}[];
|
|
2967
|
+
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
2968
|
+
connections?: {
|
|
2969
|
+
id?: string;
|
|
2970
|
+
name?: string;
|
|
2971
|
+
}[];
|
|
2972
|
+
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
2973
|
+
agentVariables?: {
|
|
2974
|
+
id?: string;
|
|
2975
|
+
variable?: {
|
|
2976
|
+
id?: string;
|
|
2977
|
+
name?: string;
|
|
2978
|
+
};
|
|
2979
|
+
}[];
|
|
2980
|
+
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
2981
|
+
agentWorkflows?: {
|
|
2982
|
+
id?: string;
|
|
2983
|
+
workflow?: {
|
|
2984
|
+
id?: string;
|
|
2985
|
+
name?: string;
|
|
2986
|
+
};
|
|
2987
|
+
}[];
|
|
2988
|
+
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
2989
|
+
agentSubAgents?: {
|
|
2990
|
+
id?: string;
|
|
2991
|
+
subagent?: {
|
|
2992
|
+
id?: string;
|
|
2993
|
+
name?: string;
|
|
2994
|
+
};
|
|
2995
|
+
parentAgent?: {
|
|
2996
|
+
id?: string;
|
|
2997
|
+
name?: string;
|
|
2998
|
+
};
|
|
2999
|
+
}[];
|
|
3000
|
+
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
3001
|
+
agentMcpServers?: {
|
|
3002
|
+
id?: string;
|
|
3003
|
+
mcpServer?: {
|
|
3004
|
+
id?: string;
|
|
3005
|
+
slug?: string;
|
|
3006
|
+
name?: string;
|
|
3007
|
+
provider?: string;
|
|
3008
|
+
logoUrl?: string | null;
|
|
3009
|
+
description?: string | null;
|
|
3010
|
+
};
|
|
3011
|
+
toolOverrides?: {
|
|
3012
|
+
id?: string;
|
|
3013
|
+
toolName?: string;
|
|
3014
|
+
enabled?: boolean;
|
|
3015
|
+
requireApproval?: boolean;
|
|
3016
|
+
}[];
|
|
3017
|
+
}[];
|
|
3018
|
+
/** @description A2A (agent-to-agent) endpoints attached to the agent. Included when `expansion=a2aAgents` is requested. */
|
|
3019
|
+
agentA2aAgents?: {
|
|
3020
|
+
id?: string;
|
|
3021
|
+
a2aAgent?: {
|
|
3022
|
+
id?: string;
|
|
3023
|
+
slug?: string;
|
|
3024
|
+
name?: string;
|
|
3025
|
+
logoUrl?: string | null;
|
|
3026
|
+
description?: string | null;
|
|
3027
|
+
authType?: string;
|
|
3028
|
+
};
|
|
3029
|
+
}[];
|
|
3030
|
+
/** @description Web access configuration. Included when `expansion=webAccess` is requested. */
|
|
3031
|
+
agentWebAccess?: {
|
|
3032
|
+
service?: string;
|
|
3033
|
+
webSearchEnabled?: boolean;
|
|
3034
|
+
websiteAccessEnabled?: boolean;
|
|
3035
|
+
} | null;
|
|
3036
|
+
/** @description Phone access configuration. Included when `expansion=phoneAccess` is requested. */
|
|
3037
|
+
agentPhoneAccess?: {
|
|
3038
|
+
service?: string;
|
|
3039
|
+
outboundCallsEnabled?: boolean;
|
|
3040
|
+
inboundCallsEnabled?: boolean;
|
|
3041
|
+
} | null;
|
|
3042
|
+
/** @description Project the agent belongs to. Included when `expansion=project` is requested. */
|
|
3043
|
+
project?: {
|
|
3044
|
+
id?: string;
|
|
3045
|
+
name?: string;
|
|
3046
|
+
};
|
|
3011
3047
|
};
|
|
3012
|
-
|
|
3013
|
-
/** @description Workflow app id (catalogue slug)
|
|
3048
|
+
UpsertAgentToolDto: {
|
|
3049
|
+
/** @description Workflow app id (catalogue slug). */
|
|
3014
3050
|
appId: string;
|
|
3015
|
-
/** @description
|
|
3051
|
+
/** @description Catalogue action id. */
|
|
3016
3052
|
actionId: string;
|
|
3017
|
-
/** @description Connection instance UUID
|
|
3053
|
+
/** @description Connection instance UUID pre-bound on the tool. */
|
|
3018
3054
|
connectionId?: string;
|
|
3019
|
-
/** @description
|
|
3055
|
+
/** @description Tool display name for the model. */
|
|
3056
|
+
name?: string;
|
|
3057
|
+
/** @description Tool description shown to the model. */
|
|
3058
|
+
description?: string;
|
|
3059
|
+
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
3020
3060
|
input?: {
|
|
3021
3061
|
[key: string]: unknown;
|
|
3022
3062
|
};
|
|
3023
|
-
/** @description Optional display name for this step. */
|
|
3024
|
-
name?: string;
|
|
3025
3063
|
};
|
|
3026
|
-
|
|
3027
|
-
/**
|
|
3028
|
-
|
|
3029
|
-
|
|
3030
|
-
|
|
3031
|
-
|
|
3064
|
+
UpsertAgentBySlugDto: {
|
|
3065
|
+
/**
|
|
3066
|
+
* @description Stable project-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
3067
|
+
* @example support-triage
|
|
3068
|
+
*/
|
|
3069
|
+
slug: string;
|
|
3070
|
+
/** @description Display name. Defaults to the slug when omitted. */
|
|
3032
3071
|
name?: string;
|
|
3072
|
+
description?: string;
|
|
3073
|
+
/** @description System instructions / prompt for the agent. */
|
|
3074
|
+
instructions: string;
|
|
3075
|
+
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
3076
|
+
model: string;
|
|
3077
|
+
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
3078
|
+
aiConnectionId?: string;
|
|
3079
|
+
/** @description App Connection UUIDs the agent may use for tools. */
|
|
3080
|
+
connectionIds?: string[];
|
|
3081
|
+
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
3082
|
+
workflowIds?: string[];
|
|
3083
|
+
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
3084
|
+
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
3085
|
+
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
3086
|
+
managedByCode?: boolean;
|
|
3033
3087
|
};
|
|
3034
|
-
|
|
3035
|
-
/** @description Name of the
|
|
3088
|
+
CreateKnowledgeDto: {
|
|
3089
|
+
/** @description Name of the knowledge base. */
|
|
3036
3090
|
name: string;
|
|
3037
|
-
/** @description Description of the
|
|
3091
|
+
/** @description Description of the knowledge base. */
|
|
3038
3092
|
description?: string;
|
|
3039
|
-
/**
|
|
3040
|
-
|
|
3041
|
-
|
|
3042
|
-
|
|
3043
|
-
|
|
3044
|
-
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3050
|
-
projectId?: string;
|
|
3051
|
-
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3052
|
-
value: string;
|
|
3093
|
+
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
3094
|
+
chunkOverlap?: number;
|
|
3095
|
+
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
3096
|
+
chunkSize?: number;
|
|
3097
|
+
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
3098
|
+
embeddingModel?: string;
|
|
3099
|
+
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
3100
|
+
embeddingProvider?: string;
|
|
3101
|
+
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
3102
|
+
dimensions?: number;
|
|
3053
3103
|
};
|
|
3054
|
-
|
|
3104
|
+
KnowledgeCountDto: {
|
|
3105
|
+
/** @description Number of vector references stored in this knowledge base. */
|
|
3106
|
+
vectorRefs: number;
|
|
3107
|
+
};
|
|
3108
|
+
KnowledgeVectorRefSummaryDto: {
|
|
3109
|
+
/** @description Vector reference ID. */
|
|
3110
|
+
id: string;
|
|
3111
|
+
/** @description ID of the knowledge base the vector reference belongs to. */
|
|
3112
|
+
FK_knowledgeId: string;
|
|
3113
|
+
};
|
|
3114
|
+
KnowledgeUsageDto: {
|
|
3115
|
+
/** @description Total prompt tokens consumed when embedding content into this knowledge base. */
|
|
3116
|
+
promptTokens: number;
|
|
3117
|
+
};
|
|
3118
|
+
KnowledgeWorkspaceDto: {
|
|
3055
3119
|
/** @description Workspace ID. */
|
|
3056
3120
|
id: string;
|
|
3057
3121
|
/** @description Workspace name. */
|
|
3058
3122
|
name: string;
|
|
3059
3123
|
};
|
|
3060
|
-
|
|
3061
|
-
/** @description
|
|
3124
|
+
KnowledgeResponseDto: {
|
|
3125
|
+
/** @description Knowledge base ID. */
|
|
3062
3126
|
id: string;
|
|
3063
|
-
/** @description
|
|
3127
|
+
/** @description Knowledge base name. */
|
|
3064
3128
|
name: string;
|
|
3065
|
-
|
|
3066
|
-
|
|
3129
|
+
/** @description Knowledge base description. Included when `expansion=description` is requested. */
|
|
3130
|
+
description?: string;
|
|
3131
|
+
/**
|
|
3132
|
+
* Format: date-time
|
|
3133
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3134
|
+
*/
|
|
3135
|
+
createdAt?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* Format: date-time
|
|
3138
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3139
|
+
*/
|
|
3140
|
+
updatedAt?: string;
|
|
3141
|
+
/** @description Name of the underlying vector index collection. Included when `expansion=indexName` is requested. */
|
|
3142
|
+
indexName?: string;
|
|
3143
|
+
/** @description Default chunk size in words used when uploading text. Included when `expansion=chunkSize` is requested. */
|
|
3144
|
+
chunkSize?: number;
|
|
3145
|
+
/** @description Default chunk overlap in words used when uploading text. Included when `expansion=chunkOverlap` is requested. */
|
|
3146
|
+
chunkOverlap?: number;
|
|
3147
|
+
/** @description Embedding model used for this knowledge base. Included when `expansion=embeddingModel` is requested. */
|
|
3148
|
+
embeddingModel?: string;
|
|
3149
|
+
/** @description Embedding provider used for this knowledge base. Included when `expansion=embeddingProvider` is requested. */
|
|
3150
|
+
embeddingProvider?: string;
|
|
3151
|
+
/** @description Embedding vector dimensions. Included when `expansion=dimensions` is requested. */
|
|
3152
|
+
dimensions?: number;
|
|
3153
|
+
/** @description Aggregate counts. Included when `expansion=countVectorRefs` is requested. */
|
|
3154
|
+
_count?: components["schemas"]["KnowledgeCountDto"];
|
|
3155
|
+
/** @description Vector references stored in this knowledge base. Included when `expansion=vectorRefs` is requested. */
|
|
3156
|
+
vectorRefs?: components["schemas"]["KnowledgeVectorRefSummaryDto"][];
|
|
3157
|
+
/** @description Embedding token usage. Included when `expansion=usage` is requested. */
|
|
3158
|
+
usage?: components["schemas"]["KnowledgeUsageDto"];
|
|
3159
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3160
|
+
workspace?: components["schemas"]["KnowledgeWorkspaceDto"];
|
|
3161
|
+
};
|
|
3162
|
+
UpdateKnowledgeDto: {
|
|
3163
|
+
/** @description Name of the knowledge base. */
|
|
3164
|
+
name?: string;
|
|
3165
|
+
/** @description Description of the knowledge base. */
|
|
3166
|
+
description?: string;
|
|
3167
|
+
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
3168
|
+
chunkOverlap?: number;
|
|
3169
|
+
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
3170
|
+
chunkSize?: number;
|
|
3171
|
+
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
3172
|
+
embeddingModel?: string;
|
|
3173
|
+
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
3174
|
+
embeddingProvider?: string;
|
|
3175
|
+
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
3176
|
+
dimensions?: number;
|
|
3177
|
+
};
|
|
3178
|
+
SaveUploadedTextToKnowledgeDto: {
|
|
3179
|
+
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
3180
|
+
name: string;
|
|
3181
|
+
/** @description Raw text content to embed into the knowledge base. */
|
|
3182
|
+
text: string;
|
|
3183
|
+
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
3184
|
+
chunkOverlap: number;
|
|
3185
|
+
/** @description Chunk size in words used to split the text before embedding. */
|
|
3186
|
+
chunkSize: number;
|
|
3187
|
+
};
|
|
3188
|
+
KnowledgeDocumentResponseDto: {
|
|
3189
|
+
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
3190
|
+
id: string;
|
|
3191
|
+
/** @description Document name. */
|
|
3192
|
+
name: string;
|
|
3193
|
+
/**
|
|
3194
|
+
* Format: date-time
|
|
3195
|
+
* @description Creation timestamp.
|
|
3196
|
+
*/
|
|
3197
|
+
createdAt: string;
|
|
3198
|
+
/** @description Number of parts (chunks) the document was split into. */
|
|
3199
|
+
partCount: number;
|
|
3200
|
+
/**
|
|
3201
|
+
* @description Whether the document is a multi-part group or a standalone single-part upload.
|
|
3202
|
+
* @enum {string}
|
|
3203
|
+
*/
|
|
3204
|
+
type: "group" | "standalone";
|
|
3205
|
+
};
|
|
3206
|
+
KnowledgeDocumentGroupVectorRefDto: {
|
|
3207
|
+
/** @description Vector reference ID. */
|
|
3208
|
+
id: string;
|
|
3209
|
+
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
3210
|
+
name: string;
|
|
3211
|
+
/**
|
|
3212
|
+
* Format: date-time
|
|
3213
|
+
* @description Creation timestamp.
|
|
3214
|
+
*/
|
|
3215
|
+
createdAt: string;
|
|
3216
|
+
/** @description Part number within the group, or null for single-part uploads. */
|
|
3217
|
+
part: number | null;
|
|
3218
|
+
/** @description Storage path of the raw text for this part. */
|
|
3219
|
+
s3Link: string | null;
|
|
3220
|
+
};
|
|
3221
|
+
KnowledgeDocumentGroupResponseDto: {
|
|
3222
|
+
/** @description Document group ID. */
|
|
3223
|
+
id: string;
|
|
3224
|
+
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
3225
|
+
name: string | null;
|
|
3226
|
+
/**
|
|
3227
|
+
* Format: date-time
|
|
3228
|
+
* @description Creation timestamp.
|
|
3229
|
+
*/
|
|
3230
|
+
createdAt: string;
|
|
3231
|
+
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
3232
|
+
FK_knowledgeId: string | null;
|
|
3233
|
+
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
3234
|
+
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
3235
|
+
};
|
|
3236
|
+
CreateVariableDto: {
|
|
3237
|
+
/** @description Name of the variable. */
|
|
3238
|
+
name: string;
|
|
3239
|
+
/** @description Description of the variable. */
|
|
3240
|
+
description?: string;
|
|
3241
|
+
/**
|
|
3242
|
+
* @description Scope of the variable (system, workspace or project).
|
|
3243
|
+
* @enum {string}
|
|
3244
|
+
*/
|
|
3245
|
+
type: "system" | "workspace" | "project";
|
|
3246
|
+
/**
|
|
3247
|
+
* @description Data type of the variable value.
|
|
3248
|
+
* @enum {string}
|
|
3249
|
+
*/
|
|
3250
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3251
|
+
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3252
|
+
projectId?: string;
|
|
3253
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3254
|
+
value: string;
|
|
3255
|
+
};
|
|
3256
|
+
VariableWorkspaceDto: {
|
|
3257
|
+
/** @description Workspace ID. */
|
|
3258
|
+
id: string;
|
|
3259
|
+
/** @description Workspace name. */
|
|
3260
|
+
name: string;
|
|
3261
|
+
};
|
|
3262
|
+
VariableProjectDto: {
|
|
3263
|
+
/** @description Project ID. */
|
|
3264
|
+
id: string;
|
|
3265
|
+
/** @description Project name. */
|
|
3266
|
+
name: string;
|
|
3267
|
+
};
|
|
3268
|
+
VariableResponseDto: {
|
|
3067
3269
|
/** @description Variable ID. */
|
|
3068
3270
|
id: string;
|
|
3069
3271
|
/** @description Variable name. */
|
|
@@ -3149,287 +3351,237 @@ interface components {
|
|
|
3149
3351
|
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3150
3352
|
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
3151
3353
|
};
|
|
3152
|
-
|
|
3354
|
+
ManuallyRunWorkflowInputDataDto: {
|
|
3153
3355
|
/**
|
|
3154
|
-
* @description
|
|
3155
|
-
* @example
|
|
3356
|
+
* @description Values for the custom input fields configured on the workflow "Manually Run" trigger, keyed by field ID. Pass an empty object when the trigger defines no custom input fields.
|
|
3357
|
+
* @example {
|
|
3358
|
+
* "customerEmail": "jane@example.com",
|
|
3359
|
+
* "priority": "high"
|
|
3360
|
+
* }
|
|
3156
3361
|
*/
|
|
3362
|
+
inputData: {
|
|
3363
|
+
[key: string]: unknown;
|
|
3364
|
+
};
|
|
3365
|
+
};
|
|
3366
|
+
ExecuteWorkflowResponseDto: {
|
|
3367
|
+
/** @description ID of the newly created execution. Poll GET /executions/{executionId} to track progress. */
|
|
3157
3368
|
id: string;
|
|
3158
|
-
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3369
|
+
};
|
|
3370
|
+
ExecutionWorkspaceSummaryDto: {
|
|
3371
|
+
/** @description Workspace ID */
|
|
3372
|
+
id: string;
|
|
3373
|
+
/** @description Workspace name */
|
|
3162
3374
|
name: string;
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
/** @description
|
|
3166
|
-
|
|
3167
|
-
/** @description
|
|
3168
|
-
|
|
3169
|
-
/** @description
|
|
3170
|
-
|
|
3171
|
-
|
|
3172
|
-
|
|
3173
|
-
/**
|
|
3174
|
-
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3179
|
-
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
/** @description
|
|
3184
|
-
|
|
3185
|
-
/**
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
|
|
3191
|
-
maxOutputTokens?: number | null;
|
|
3192
|
-
/**
|
|
3193
|
-
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
3194
|
-
* @example 1
|
|
3195
|
-
*/
|
|
3196
|
-
topP?: number;
|
|
3197
|
-
/**
|
|
3198
|
-
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
3199
|
-
* @example 0
|
|
3200
|
-
*/
|
|
3201
|
-
frequencyPenalty?: number;
|
|
3202
|
-
/**
|
|
3203
|
-
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
3204
|
-
* @example 0
|
|
3205
|
-
*/
|
|
3206
|
-
presencePenalty?: number;
|
|
3207
|
-
/**
|
|
3208
|
-
* @description Maximum retries for a failed model call. Included when `expansion=maxRetries` is requested.
|
|
3209
|
-
* @example 0
|
|
3210
|
-
*/
|
|
3211
|
-
maxRetries?: number;
|
|
3212
|
-
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
3213
|
-
seed?: number | null;
|
|
3214
|
-
/**
|
|
3215
|
-
* @description Maximum tool roundtrips per turn. Included when `expansion=maxToolRoundtrips` is requested.
|
|
3216
|
-
* @example 5
|
|
3217
|
-
*/
|
|
3218
|
-
maxToolRoundtrips?: number;
|
|
3219
|
-
/**
|
|
3220
|
-
* @description How many previous messages are sent to the model. Included when `expansion=messageLookbackLimit` is requested.
|
|
3221
|
-
* @example 40
|
|
3222
|
-
*/
|
|
3223
|
-
messageLookbackLimit?: number;
|
|
3224
|
-
/** @description Configured tool nodes (app actions) for the agent. Included when `expansion=tools` is requested. */
|
|
3225
|
-
tools?: {
|
|
3226
|
-
[key: string]: unknown;
|
|
3227
|
-
}[] | null;
|
|
3228
|
-
/** @description Action IDs of the configured tools. Included when `expansion=toolIds` is requested. */
|
|
3229
|
-
toolIds?: string[];
|
|
3230
|
-
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
3231
|
-
taskNamingInstructions?: string | null;
|
|
3232
|
-
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
3233
|
-
enabledBuiltInTools?: string[];
|
|
3234
|
-
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
3235
|
-
enabledPlatformTools?: string[];
|
|
3236
|
-
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
3237
|
-
dynamicActionDiscoveryEnabled?: boolean;
|
|
3238
|
-
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
3239
|
-
dynamicMcpDiscoveryEnabled?: boolean;
|
|
3240
|
-
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
3241
|
-
dynamicSelfInstructionsEnabled?: boolean;
|
|
3242
|
-
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
3243
|
-
memoryEnabled?: boolean;
|
|
3375
|
+
};
|
|
3376
|
+
ExecutionProjectSummaryDto: {
|
|
3377
|
+
/** @description Project ID */
|
|
3378
|
+
id: string;
|
|
3379
|
+
/** @description Project name */
|
|
3380
|
+
name: string;
|
|
3381
|
+
/** @description The workspace the project belongs to. Included when `expansion=workspace` is requested alongside `workflow` and `project`. */
|
|
3382
|
+
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
3383
|
+
};
|
|
3384
|
+
ExecutionWorkflowSummaryDto: {
|
|
3385
|
+
/** @description Workflow ID */
|
|
3386
|
+
id: string;
|
|
3387
|
+
/** @description Workflow name */
|
|
3388
|
+
name: string;
|
|
3389
|
+
/** @description The project the workflow belongs to. Included when `expansion=project` is requested alongside `workflow`. */
|
|
3390
|
+
project?: components["schemas"]["ExecutionProjectSummaryDto"];
|
|
3391
|
+
};
|
|
3392
|
+
ExecutionPathStepDto: {
|
|
3393
|
+
/** @description ID of the workflow node this step represents */
|
|
3394
|
+
nodeId: string;
|
|
3395
|
+
/** @description Human-friendly node name */
|
|
3396
|
+
label: string;
|
|
3397
|
+
/** @description ID of the app the node belongs to */
|
|
3398
|
+
appId: string;
|
|
3399
|
+
/** @description Action ID, present when the step is an action node */
|
|
3400
|
+
actionId?: string;
|
|
3401
|
+
/** @description Trigger ID, present when the step is the trigger node */
|
|
3402
|
+
triggerId?: string;
|
|
3244
3403
|
/**
|
|
3245
|
-
* @description
|
|
3404
|
+
* @description Step status. NEEDS_INPUT indicates the step is paused waiting for user input.
|
|
3246
3405
|
* @enum {string}
|
|
3247
3406
|
*/
|
|
3248
|
-
|
|
3249
|
-
/**
|
|
3250
|
-
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
|
|
3255
|
-
|
|
3407
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "RETRYING" | "WAITING";
|
|
3408
|
+
/** @description Status detail message for the step */
|
|
3409
|
+
statusMessage?: string;
|
|
3410
|
+
/** @description Timestamp when the step started */
|
|
3411
|
+
startTime?: string;
|
|
3412
|
+
/** @description Timestamp when the step finished */
|
|
3413
|
+
endTime?: string;
|
|
3414
|
+
/** @description nodeId this step is an iteration of (set on loop child entries) */
|
|
3415
|
+
iterationOf?: string;
|
|
3416
|
+
/** @description Index of the loop iteration this step belongs to */
|
|
3417
|
+
iterationIndex?: number;
|
|
3418
|
+
/** @description On the collapsed loop parent entry: how many times the loop ran (or is planned to run) */
|
|
3419
|
+
iterationCount?: number;
|
|
3256
3420
|
/**
|
|
3257
|
-
*
|
|
3258
|
-
* @
|
|
3421
|
+
* @description Approval status when this step is a Request Approval node awaiting or past a decision
|
|
3422
|
+
* @enum {string}
|
|
3259
3423
|
*/
|
|
3260
|
-
|
|
3261
|
-
/** @description
|
|
3262
|
-
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
|
|
3266
|
-
|
|
3267
|
-
/** @description
|
|
3268
|
-
|
|
3269
|
-
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
|
|
3278
|
-
|
|
3279
|
-
|
|
3280
|
-
|
|
3281
|
-
name?: string;
|
|
3282
|
-
};
|
|
3283
|
-
}[];
|
|
3284
|
-
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
3285
|
-
agentObjectTypes?: {
|
|
3286
|
-
id?: string;
|
|
3287
|
-
scope?: string;
|
|
3288
|
-
objectType?: {
|
|
3289
|
-
id?: string;
|
|
3290
|
-
name?: string;
|
|
3291
|
-
slug?: string;
|
|
3292
|
-
icon?: string | null;
|
|
3293
|
-
color?: string | null;
|
|
3294
|
-
};
|
|
3295
|
-
}[];
|
|
3296
|
-
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
3297
|
-
agentObjects?: {
|
|
3298
|
-
id?: string;
|
|
3299
|
-
scope?: string;
|
|
3300
|
-
object?: {
|
|
3301
|
-
id?: string;
|
|
3302
|
-
name?: string;
|
|
3303
|
-
state?: string;
|
|
3304
|
-
objectType?: {
|
|
3305
|
-
id?: string;
|
|
3306
|
-
name?: string;
|
|
3307
|
-
slug?: string;
|
|
3308
|
-
icon?: string | null;
|
|
3309
|
-
color?: string | null;
|
|
3310
|
-
};
|
|
3311
|
-
};
|
|
3312
|
-
}[];
|
|
3313
|
-
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
3314
|
-
connections?: {
|
|
3315
|
-
id?: string;
|
|
3316
|
-
name?: string;
|
|
3317
|
-
}[];
|
|
3318
|
-
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
3319
|
-
agentVariables?: {
|
|
3320
|
-
id?: string;
|
|
3321
|
-
variable?: {
|
|
3322
|
-
id?: string;
|
|
3323
|
-
name?: string;
|
|
3324
|
-
};
|
|
3325
|
-
}[];
|
|
3326
|
-
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
3327
|
-
agentWorkflows?: {
|
|
3328
|
-
id?: string;
|
|
3329
|
-
workflow?: {
|
|
3330
|
-
id?: string;
|
|
3331
|
-
name?: string;
|
|
3332
|
-
};
|
|
3333
|
-
}[];
|
|
3334
|
-
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
3335
|
-
agentSubAgents?: {
|
|
3336
|
-
id?: string;
|
|
3337
|
-
subagent?: {
|
|
3338
|
-
id?: string;
|
|
3339
|
-
name?: string;
|
|
3340
|
-
};
|
|
3341
|
-
parentAgent?: {
|
|
3342
|
-
id?: string;
|
|
3343
|
-
name?: string;
|
|
3344
|
-
};
|
|
3345
|
-
}[];
|
|
3346
|
-
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
3347
|
-
agentMcpServers?: {
|
|
3348
|
-
id?: string;
|
|
3349
|
-
mcpServer?: {
|
|
3350
|
-
id?: string;
|
|
3351
|
-
slug?: string;
|
|
3352
|
-
name?: string;
|
|
3353
|
-
provider?: string;
|
|
3354
|
-
logoUrl?: string | null;
|
|
3355
|
-
description?: string | null;
|
|
3356
|
-
};
|
|
3357
|
-
toolOverrides?: {
|
|
3358
|
-
id?: string;
|
|
3359
|
-
toolName?: string;
|
|
3360
|
-
enabled?: boolean;
|
|
3361
|
-
requireApproval?: boolean;
|
|
3362
|
-
}[];
|
|
3424
|
+
approvalStatus?: "pending" | "partially_approved" | "approved" | "rejected" | "expired";
|
|
3425
|
+
/** @description Number of approve decisions received so far */
|
|
3426
|
+
approvalsReceived?: number;
|
|
3427
|
+
/** @description Number of approvals required for quorum / current stage */
|
|
3428
|
+
approvalsRequired?: number;
|
|
3429
|
+
};
|
|
3430
|
+
PendingInputFieldDto: {
|
|
3431
|
+
/** @description Field ID used as the key when submitting input */
|
|
3432
|
+
id: string;
|
|
3433
|
+
/** @description Human-readable field label */
|
|
3434
|
+
label: string;
|
|
3435
|
+
/** @description Field input type from the workflow builder (e.g. text, number, select) */
|
|
3436
|
+
inputType: string;
|
|
3437
|
+
/** @description Whether the field must be provided to resume */
|
|
3438
|
+
required: boolean;
|
|
3439
|
+
/** @description Optional helper text for the field */
|
|
3440
|
+
description?: string;
|
|
3441
|
+
/** @description Selectable options when the field is a select-like input */
|
|
3442
|
+
options?: {
|
|
3443
|
+
label?: string;
|
|
3444
|
+
value?: string;
|
|
3363
3445
|
}[];
|
|
3364
|
-
|
|
3365
|
-
|
|
3366
|
-
|
|
3367
|
-
|
|
3368
|
-
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
|
|
3373
|
-
|
|
3374
|
-
|
|
3446
|
+
};
|
|
3447
|
+
PendingInputDto: {
|
|
3448
|
+
/** @description ID of the waiting workflow node */
|
|
3449
|
+
nodeId: string;
|
|
3450
|
+
/** @description Human-friendly node name */
|
|
3451
|
+
label: string;
|
|
3452
|
+
/** @description Action ID of the waiting node, when it is an action step */
|
|
3453
|
+
actionId?: string;
|
|
3454
|
+
/** @description Optional instructions configured on the waiting node */
|
|
3455
|
+
instructions?: string;
|
|
3456
|
+
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
3457
|
+
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
3458
|
+
};
|
|
3459
|
+
ExecutionResponseDto: {
|
|
3460
|
+
/** @description Execution ID */
|
|
3461
|
+
id: string;
|
|
3462
|
+
/**
|
|
3463
|
+
* Format: date-time
|
|
3464
|
+
* @description Timestamp when the execution started. Always returned by GET /executions/{executionId}; included in list responses when `expansion=startedAt` is requested.
|
|
3465
|
+
*/
|
|
3466
|
+
startedAt?: string;
|
|
3467
|
+
/**
|
|
3468
|
+
* Format: date-time
|
|
3469
|
+
* @description Timestamp when the execution stopped. Included when `expansion=stoppedAt` is requested.
|
|
3470
|
+
*/
|
|
3471
|
+
stoppedAt?: string | null;
|
|
3472
|
+
/**
|
|
3473
|
+
* Format: date-time
|
|
3474
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3475
|
+
*/
|
|
3476
|
+
createdAt?: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* Format: date-time
|
|
3479
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3480
|
+
*/
|
|
3481
|
+
updatedAt?: string | null;
|
|
3482
|
+
/** @description Sequential execution number within the workflow. Included when `expansion=executionNumber` is requested. */
|
|
3483
|
+
executionNumber?: number;
|
|
3484
|
+
/** @description Raw execution node state (JSON). Included when `expansion=nodes` is requested. Most integrations should prefer the `executionPath` expansion instead. */
|
|
3485
|
+
nodes?: {
|
|
3486
|
+
[key: string]: unknown;
|
|
3375
3487
|
}[];
|
|
3376
|
-
/** @description
|
|
3377
|
-
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
|
|
3488
|
+
/** @description Raw execution edge state (JSON). Included when `expansion=edges` is requested. */
|
|
3489
|
+
edges?: {
|
|
3490
|
+
[key: string]: unknown;
|
|
3491
|
+
}[];
|
|
3492
|
+
/**
|
|
3493
|
+
* @description Overall execution status. Included when `expansion=status` is requested.
|
|
3494
|
+
* @enum {string}
|
|
3495
|
+
*/
|
|
3496
|
+
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3497
|
+
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
3498
|
+
statusMessage?: string | null;
|
|
3499
|
+
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
3500
|
+
output?: {
|
|
3501
|
+
[key: string]: unknown;
|
|
3381
3502
|
} | null;
|
|
3382
|
-
/**
|
|
3383
|
-
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3503
|
+
/**
|
|
3504
|
+
* Format: date-time
|
|
3505
|
+
* @description Timestamp when a waiting execution is scheduled to continue. Included when `expansion=continueExecutionAt` is requested.
|
|
3506
|
+
*/
|
|
3507
|
+
continueExecutionAt?: string | null;
|
|
3508
|
+
/**
|
|
3509
|
+
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
3510
|
+
* @enum {string}
|
|
3511
|
+
*/
|
|
3512
|
+
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
3513
|
+
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
3514
|
+
executionVariables?: {
|
|
3515
|
+
[key: string]: unknown;
|
|
3387
3516
|
} | null;
|
|
3388
|
-
/** @description
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
}
|
|
3517
|
+
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
3518
|
+
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
3519
|
+
/** @description Business-readable, ordered representation of the executed (or queued) steps, derived from the raw node and edge state: step labels, per-step status (including NEEDS_INPUT for steps paused awaiting user input), start and end timings, and loop iteration metadata. Custom UIs render execution progress from this field. Included when `expansion=executionPath` is requested. Only returned by GET /executions/{executionId}. */
|
|
3520
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3521
|
+
/** @description Field schemas for steps currently paused in NEEDS_INPUT. Each entry includes the waiting nodeId, label, optional instructions, and the fields to collect. Submit values keyed by field id to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. Included when `expansion=pendingInput` is requested. Only returned by GET /executions/{executionId}. Null when no step is waiting for input. */
|
|
3522
|
+
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
3523
|
+
/**
|
|
3524
|
+
* @description How the execution was started. `WORKFLOW` for graph runs; `SDK` for ad-hoc single-action runs from the Public API / client SDK. Included when `expansion=source` is requested.
|
|
3525
|
+
* @enum {string}
|
|
3526
|
+
*/
|
|
3527
|
+
source?: "WORKFLOW" | "SDK";
|
|
3528
|
+
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
3529
|
+
name?: string | null;
|
|
3393
3530
|
};
|
|
3394
|
-
|
|
3395
|
-
/** @description Workflow app id (catalogue slug). */
|
|
3531
|
+
RunActionDto: {
|
|
3532
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3396
3533
|
appId: string;
|
|
3397
|
-
/** @description
|
|
3534
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
3398
3535
|
actionId: string;
|
|
3399
|
-
/** @description Connection instance UUID
|
|
3536
|
+
/** @description Connection instance UUID (`Connection.id`). Required when the action needs a connection and the workspace has more than one connection for the app with no single workspace default. When omitted: sole usable connection for the app is used; else the workspace default (`isDefault`); else 400 with candidates. Never silently picks among multiple non-default connections. */
|
|
3400
3537
|
connectionId?: string;
|
|
3401
|
-
/** @description
|
|
3402
|
-
|
|
3403
|
-
/** @description
|
|
3404
|
-
description?: string;
|
|
3405
|
-
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
3538
|
+
/** @description Project UUID used for variable/project scoping. When omitted and the workspace has exactly one project, that project is used; otherwise the request fails with 400. */
|
|
3539
|
+
projectId?: string;
|
|
3540
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
3406
3541
|
input?: {
|
|
3407
3542
|
[key: string]: unknown;
|
|
3408
3543
|
};
|
|
3544
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
3545
|
+
name?: string;
|
|
3409
3546
|
};
|
|
3410
|
-
|
|
3547
|
+
RunActionResponseDto: {
|
|
3548
|
+
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
3549
|
+
id: string;
|
|
3411
3550
|
/**
|
|
3412
|
-
* @description
|
|
3413
|
-
* @
|
|
3551
|
+
* @description Final execution status after the single action step.
|
|
3552
|
+
* @enum {string}
|
|
3414
3553
|
*/
|
|
3415
|
-
|
|
3416
|
-
/** @description
|
|
3554
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3555
|
+
/** @description Human-readable status detail. */
|
|
3556
|
+
statusMessage?: string | null;
|
|
3557
|
+
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
3558
|
+
output?: {
|
|
3559
|
+
[key: string]: unknown;
|
|
3560
|
+
} | null;
|
|
3561
|
+
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
3562
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3563
|
+
};
|
|
3564
|
+
RunStepDto: {
|
|
3565
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3566
|
+
appId: string;
|
|
3567
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
3568
|
+
actionId: string;
|
|
3569
|
+
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
3570
|
+
connectionId?: string;
|
|
3571
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
3572
|
+
input?: {
|
|
3573
|
+
[key: string]: unknown;
|
|
3574
|
+
};
|
|
3575
|
+
/** @description Optional display name for this step. */
|
|
3576
|
+
name?: string;
|
|
3577
|
+
};
|
|
3578
|
+
StartRunDto: {
|
|
3579
|
+
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
3580
|
+
steps: components["schemas"]["RunStepDto"][];
|
|
3581
|
+
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
3582
|
+
projectId?: string;
|
|
3583
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
3417
3584
|
name?: string;
|
|
3418
|
-
description?: string;
|
|
3419
|
-
/** @description System instructions / prompt for the agent. */
|
|
3420
|
-
instructions: string;
|
|
3421
|
-
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
3422
|
-
model: string;
|
|
3423
|
-
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
3424
|
-
aiConnectionId?: string;
|
|
3425
|
-
/** @description App Connection UUIDs the agent may use for tools. */
|
|
3426
|
-
connectionIds?: string[];
|
|
3427
|
-
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
3428
|
-
workflowIds?: string[];
|
|
3429
|
-
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
3430
|
-
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
3431
|
-
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
3432
|
-
managedByCode?: boolean;
|
|
3433
3585
|
};
|
|
3434
3586
|
TaskListItemResponseDto: {
|
|
3435
3587
|
/**
|
|
@@ -3576,6 +3728,8 @@ interface components {
|
|
|
3576
3728
|
* @example Conversation covering the Q3 regional sales report
|
|
3577
3729
|
*/
|
|
3578
3730
|
description?: string;
|
|
3731
|
+
/** @description Approve (true) or clear (false) the current runtime plan for plan-before-execute gating. */
|
|
3732
|
+
approvePlan?: boolean;
|
|
3579
3733
|
};
|
|
3580
3734
|
DeletedTaskResponseDto: {
|
|
3581
3735
|
/**
|
|
@@ -3649,6 +3803,10 @@ interface components {
|
|
|
3649
3803
|
* }
|
|
3650
3804
|
*/
|
|
3651
3805
|
data?: Record<string, never>;
|
|
3806
|
+
/** @description Solution Designer handoff */
|
|
3807
|
+
solutionId?: string;
|
|
3808
|
+
planStepId?: string;
|
|
3809
|
+
delegationId?: string;
|
|
3652
3810
|
};
|
|
3653
3811
|
StreamMessageStopDto: {
|
|
3654
3812
|
/** @description Partial assistant message to persist when stopping a stream */
|
|
@@ -3974,9 +4132,9 @@ interface operations {
|
|
|
3974
4132
|
limit?: number;
|
|
3975
4133
|
/** @description Number of items to skip for pagination. */
|
|
3976
4134
|
offset?: number;
|
|
3977
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4135
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
3978
4136
|
expansion?: string;
|
|
3979
|
-
/** @description Comma-separated key:value filter pairs. Available keys: status, externalId, priority, scheduledFor, search, createdAfter, createdBefore. */
|
|
4137
|
+
/** @description Comma-separated key:value filter pairs. Available keys: status, externalId, objectId, priority, scheduledFor, search, createdAfter, createdBefore. */
|
|
3980
4138
|
filterBy?: string;
|
|
3981
4139
|
};
|
|
3982
4140
|
header?: never;
|
|
@@ -4001,7 +4159,7 @@ interface operations {
|
|
|
4001
4159
|
QueueItemsController_create: {
|
|
4002
4160
|
parameters: {
|
|
4003
4161
|
query?: {
|
|
4004
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4162
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4005
4163
|
expansion?: string;
|
|
4006
4164
|
};
|
|
4007
4165
|
header?: never;
|
|
@@ -4030,7 +4188,7 @@ interface operations {
|
|
|
4030
4188
|
QueueItemsController_bulkCreate: {
|
|
4031
4189
|
parameters: {
|
|
4032
4190
|
query?: {
|
|
4033
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4191
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4034
4192
|
expansion?: string;
|
|
4035
4193
|
};
|
|
4036
4194
|
header?: never;
|
|
@@ -4085,7 +4243,7 @@ interface operations {
|
|
|
4085
4243
|
QueueItemsController_bulkUpdate: {
|
|
4086
4244
|
parameters: {
|
|
4087
4245
|
query?: {
|
|
4088
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4246
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4089
4247
|
expansion?: string;
|
|
4090
4248
|
};
|
|
4091
4249
|
header?: never;
|
|
@@ -4195,7 +4353,7 @@ interface operations {
|
|
|
4195
4353
|
QueueItemsController_findByExternalId: {
|
|
4196
4354
|
parameters: {
|
|
4197
4355
|
query?: {
|
|
4198
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4356
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4199
4357
|
expansion?: string;
|
|
4200
4358
|
};
|
|
4201
4359
|
header?: never;
|
|
@@ -4225,9 +4383,9 @@ interface operations {
|
|
|
4225
4383
|
limit?: number;
|
|
4226
4384
|
/** @description Number of items to skip for pagination. */
|
|
4227
4385
|
offset?: number;
|
|
4228
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4386
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4229
4387
|
expansion?: string;
|
|
4230
|
-
/** @description Comma-separated key:value filter pairs. Available keys: status, externalId, priority, scheduledFor, search, createdAfter, createdBefore. */
|
|
4388
|
+
/** @description Comma-separated key:value filter pairs. Available keys: status, externalId, objectId, priority, scheduledFor, search, createdAfter, createdBefore. */
|
|
4231
4389
|
filterBy?: string;
|
|
4232
4390
|
};
|
|
4233
4391
|
header?: never;
|
|
@@ -4274,7 +4432,7 @@ interface operations {
|
|
|
4274
4432
|
QueueItemsController_findOne: {
|
|
4275
4433
|
parameters: {
|
|
4276
4434
|
query?: {
|
|
4277
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4435
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4278
4436
|
expansion?: string;
|
|
4279
4437
|
};
|
|
4280
4438
|
header?: never;
|
|
@@ -4323,7 +4481,7 @@ interface operations {
|
|
|
4323
4481
|
QueueItemsController_update: {
|
|
4324
4482
|
parameters: {
|
|
4325
4483
|
query?: {
|
|
4326
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4484
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4327
4485
|
expansion?: string;
|
|
4328
4486
|
};
|
|
4329
4487
|
header?: never;
|
|
@@ -4376,7 +4534,7 @@ interface operations {
|
|
|
4376
4534
|
QueueItemsController_updateStatus: {
|
|
4377
4535
|
parameters: {
|
|
4378
4536
|
query?: {
|
|
4379
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4537
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4380
4538
|
expansion?: string;
|
|
4381
4539
|
};
|
|
4382
4540
|
header?: never;
|
|
@@ -4406,7 +4564,7 @@ interface operations {
|
|
|
4406
4564
|
QueueItemsController_linkExecution: {
|
|
4407
4565
|
parameters: {
|
|
4408
4566
|
query?: {
|
|
4409
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4567
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4410
4568
|
expansion?: string;
|
|
4411
4569
|
};
|
|
4412
4570
|
header?: never;
|
|
@@ -4436,7 +4594,7 @@ interface operations {
|
|
|
4436
4594
|
QueueItemsController_retryItem: {
|
|
4437
4595
|
parameters: {
|
|
4438
4596
|
query?: {
|
|
4439
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4597
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4440
4598
|
expansion?: string;
|
|
4441
4599
|
};
|
|
4442
4600
|
header?: never;
|
|
@@ -4462,7 +4620,7 @@ interface operations {
|
|
|
4462
4620
|
QueueItemsController_addError: {
|
|
4463
4621
|
parameters: {
|
|
4464
4622
|
query?: {
|
|
4465
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4623
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Note: createdAt also expands the other timestamp fields (nextRetryAt, processingStartedAt, processingCompletedAt, lastErrorAt, scheduledFor). */
|
|
4466
4624
|
expansion?: string;
|
|
4467
4625
|
};
|
|
4468
4626
|
header?: never;
|
|
@@ -4489,131 +4647,112 @@ interface operations {
|
|
|
4489
4647
|
};
|
|
4490
4648
|
};
|
|
4491
4649
|
};
|
|
4492
|
-
|
|
4650
|
+
ObjectQueueItemsController_listForObject: {
|
|
4493
4651
|
parameters: {
|
|
4494
4652
|
query?: {
|
|
4495
|
-
/** @description
|
|
4496
|
-
|
|
4497
|
-
/** @description
|
|
4498
|
-
|
|
4499
|
-
/** @description
|
|
4653
|
+
/** @description Optional status filter */
|
|
4654
|
+
status?: "PENDING" | "PROCESSING" | "SUCCESS" | "FAILED" | "RETRYING";
|
|
4655
|
+
/** @description Maximum number of items to return. */
|
|
4656
|
+
limit?: number;
|
|
4657
|
+
/** @description Number of items to skip for pagination. */
|
|
4658
|
+
offset?: number;
|
|
4659
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Defaults include queue and object. */
|
|
4500
4660
|
expansion?: string;
|
|
4501
4661
|
};
|
|
4502
4662
|
header?: never;
|
|
4503
|
-
path
|
|
4663
|
+
path: {
|
|
4664
|
+
/** @description Object (entity) ID */
|
|
4665
|
+
objectId: string;
|
|
4666
|
+
};
|
|
4504
4667
|
cookie?: never;
|
|
4505
4668
|
};
|
|
4506
4669
|
requestBody?: never;
|
|
4507
4670
|
responses: {
|
|
4508
|
-
/** @description
|
|
4671
|
+
/** @description Queue items linked to the Object. */
|
|
4509
4672
|
200: {
|
|
4510
4673
|
headers: {
|
|
4511
4674
|
[name: string]: unknown;
|
|
4512
4675
|
};
|
|
4513
4676
|
content: {
|
|
4514
|
-
"application/json": components["schemas"]["
|
|
4677
|
+
"application/json": components["schemas"]["QueueItemListResponseDto"];
|
|
4515
4678
|
};
|
|
4516
4679
|
};
|
|
4517
4680
|
};
|
|
4518
4681
|
};
|
|
4519
|
-
|
|
4682
|
+
WorkflowsController_findAllForWorkspace: {
|
|
4520
4683
|
parameters: {
|
|
4521
4684
|
query?: {
|
|
4522
|
-
/** @description Comma-separated
|
|
4685
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include internal workflows, which are excluded by default. */
|
|
4686
|
+
includeType?: string;
|
|
4687
|
+
/** @description Comma-separated key:value filters. Available: projectId, agentCanTrigger. Example: filterBy=projectId:proj_123 */
|
|
4688
|
+
filterBy?: string;
|
|
4689
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, isActive, isInternal, description, output, project, nodes, edges, triggerNode, triggerAndActionIds, pollStorage, nextScheduledExecution, orientation. Example: expansion=description,isActive,project */
|
|
4523
4690
|
expansion?: string;
|
|
4524
4691
|
};
|
|
4525
4692
|
header?: never;
|
|
4526
|
-
path
|
|
4527
|
-
workflowId: string;
|
|
4528
|
-
};
|
|
4693
|
+
path?: never;
|
|
4529
4694
|
cookie?: never;
|
|
4530
4695
|
};
|
|
4531
4696
|
requestBody?: never;
|
|
4532
4697
|
responses: {
|
|
4533
|
-
/** @description
|
|
4698
|
+
/** @description List of workflows. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4534
4699
|
200: {
|
|
4535
4700
|
headers: {
|
|
4536
4701
|
[name: string]: unknown;
|
|
4537
4702
|
};
|
|
4538
4703
|
content: {
|
|
4539
|
-
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4704
|
+
"application/json": components["schemas"]["WorkflowResponseDto"][];
|
|
4540
4705
|
};
|
|
4541
4706
|
};
|
|
4542
4707
|
};
|
|
4543
4708
|
};
|
|
4544
|
-
|
|
4709
|
+
WorkflowsController_findOne: {
|
|
4545
4710
|
parameters: {
|
|
4546
|
-
query?:
|
|
4547
|
-
|
|
4548
|
-
|
|
4549
|
-
projectId: string;
|
|
4550
|
-
};
|
|
4551
|
-
cookie?: never;
|
|
4552
|
-
};
|
|
4553
|
-
requestBody: {
|
|
4554
|
-
content: {
|
|
4555
|
-
"application/json": components["schemas"]["UpsertWorkflowBySlugDto"];
|
|
4556
|
-
};
|
|
4557
|
-
};
|
|
4558
|
-
responses: {
|
|
4559
|
-
/** @description The created or updated workflow. */
|
|
4560
|
-
200: {
|
|
4561
|
-
headers: {
|
|
4562
|
-
[name: string]: unknown;
|
|
4563
|
-
};
|
|
4564
|
-
content: {
|
|
4565
|
-
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4566
|
-
};
|
|
4711
|
+
query?: {
|
|
4712
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, isActive, isInternal, description, output, project, nodes, edges, triggerNode, triggerAndActionIds, subWorkflowIds, agentIds, pollStorage, nextScheduledExecution, orientation. Example: expansion=description,nodes,edges */
|
|
4713
|
+
expansion?: string;
|
|
4567
4714
|
};
|
|
4568
|
-
};
|
|
4569
|
-
};
|
|
4570
|
-
WorkflowAppsController_findAll: {
|
|
4571
|
-
parameters: {
|
|
4572
|
-
query?: never;
|
|
4573
4715
|
header?: never;
|
|
4574
|
-
path
|
|
4716
|
+
path: {
|
|
4717
|
+
workflowId: string;
|
|
4718
|
+
};
|
|
4575
4719
|
cookie?: never;
|
|
4576
4720
|
};
|
|
4577
4721
|
requestBody?: never;
|
|
4578
4722
|
responses: {
|
|
4579
|
-
/** @description
|
|
4723
|
+
/** @description The workflow. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4580
4724
|
200: {
|
|
4581
4725
|
headers: {
|
|
4582
4726
|
[name: string]: unknown;
|
|
4583
4727
|
};
|
|
4584
4728
|
content: {
|
|
4585
|
-
"application/json": components["schemas"]["
|
|
4729
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4586
4730
|
};
|
|
4587
4731
|
};
|
|
4588
4732
|
};
|
|
4589
4733
|
};
|
|
4590
|
-
|
|
4734
|
+
ProjectWorkflowsController_upsertBySlug: {
|
|
4591
4735
|
parameters: {
|
|
4592
4736
|
query?: never;
|
|
4593
4737
|
header?: never;
|
|
4594
4738
|
path: {
|
|
4595
|
-
|
|
4596
|
-
connectionId: string;
|
|
4739
|
+
projectId: string;
|
|
4597
4740
|
};
|
|
4598
4741
|
cookie?: never;
|
|
4599
4742
|
};
|
|
4600
4743
|
requestBody: {
|
|
4601
4744
|
content: {
|
|
4602
|
-
"application/json":
|
|
4603
|
-
[key: string]: unknown;
|
|
4604
|
-
};
|
|
4745
|
+
"application/json": components["schemas"]["UpsertWorkflowBySlugDto"];
|
|
4605
4746
|
};
|
|
4606
4747
|
};
|
|
4607
4748
|
responses: {
|
|
4608
|
-
/** @description
|
|
4749
|
+
/** @description The created or updated workflow. */
|
|
4609
4750
|
200: {
|
|
4610
4751
|
headers: {
|
|
4611
4752
|
[name: string]: unknown;
|
|
4612
4753
|
};
|
|
4613
4754
|
content: {
|
|
4614
|
-
"application/json":
|
|
4615
|
-
[key: string]: unknown;
|
|
4616
|
-
};
|
|
4755
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4617
4756
|
};
|
|
4618
4757
|
};
|
|
4619
4758
|
};
|
|
@@ -4643,6 +4782,33 @@ interface operations {
|
|
|
4643
4782
|
};
|
|
4644
4783
|
};
|
|
4645
4784
|
};
|
|
4785
|
+
ObjectTypesController_upsertBySlug: {
|
|
4786
|
+
parameters: {
|
|
4787
|
+
query?: {
|
|
4788
|
+
/** @description Comma-separated fields to expand. Available: description, attributeSchema, stateSchema, createdAt, updatedAt, createdBy, countObjects. */
|
|
4789
|
+
expansion?: string;
|
|
4790
|
+
};
|
|
4791
|
+
header?: never;
|
|
4792
|
+
path?: never;
|
|
4793
|
+
cookie?: never;
|
|
4794
|
+
};
|
|
4795
|
+
requestBody: {
|
|
4796
|
+
content: {
|
|
4797
|
+
"application/json": components["schemas"]["UpsertObjectTypeBySlugDto"];
|
|
4798
|
+
};
|
|
4799
|
+
};
|
|
4800
|
+
responses: {
|
|
4801
|
+
/** @description The created or updated entity type. */
|
|
4802
|
+
200: {
|
|
4803
|
+
headers: {
|
|
4804
|
+
[name: string]: unknown;
|
|
4805
|
+
};
|
|
4806
|
+
content: {
|
|
4807
|
+
"application/json": components["schemas"]["ObjectTypeResponseDto"];
|
|
4808
|
+
};
|
|
4809
|
+
};
|
|
4810
|
+
};
|
|
4811
|
+
};
|
|
4646
4812
|
ObjectTypesController_findBySlug: {
|
|
4647
4813
|
parameters: {
|
|
4648
4814
|
query?: {
|
|
@@ -5028,215 +5194,222 @@ interface operations {
|
|
|
5028
5194
|
};
|
|
5029
5195
|
};
|
|
5030
5196
|
};
|
|
5031
|
-
|
|
5197
|
+
WorkflowAppsController_findAll: {
|
|
5032
5198
|
parameters: {
|
|
5033
|
-
query?:
|
|
5034
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5035
|
-
expansion?: string;
|
|
5036
|
-
};
|
|
5199
|
+
query?: never;
|
|
5037
5200
|
header?: never;
|
|
5038
5201
|
path?: never;
|
|
5039
5202
|
cookie?: never;
|
|
5040
5203
|
};
|
|
5041
5204
|
requestBody?: never;
|
|
5042
5205
|
responses: {
|
|
5043
|
-
/** @description
|
|
5206
|
+
/** @description All workflow app definitions. */
|
|
5044
5207
|
200: {
|
|
5045
5208
|
headers: {
|
|
5046
5209
|
[name: string]: unknown;
|
|
5047
5210
|
};
|
|
5048
5211
|
content: {
|
|
5049
|
-
"application/json": components["schemas"]["
|
|
5212
|
+
"application/json": components["schemas"]["WorkflowAppResponseDto"][];
|
|
5050
5213
|
};
|
|
5051
5214
|
};
|
|
5052
5215
|
};
|
|
5053
5216
|
};
|
|
5054
|
-
|
|
5217
|
+
WorkflowAppsController_connectApp: {
|
|
5055
5218
|
parameters: {
|
|
5056
|
-
query?:
|
|
5057
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5058
|
-
expansion?: string;
|
|
5059
|
-
};
|
|
5219
|
+
query?: never;
|
|
5060
5220
|
header?: never;
|
|
5061
|
-
path
|
|
5221
|
+
path: {
|
|
5222
|
+
appId: string;
|
|
5223
|
+
connectionId: string;
|
|
5224
|
+
};
|
|
5062
5225
|
cookie?: never;
|
|
5063
5226
|
};
|
|
5064
5227
|
requestBody: {
|
|
5065
5228
|
content: {
|
|
5066
|
-
"application/json":
|
|
5229
|
+
"application/json": {
|
|
5230
|
+
[key: string]: unknown;
|
|
5231
|
+
};
|
|
5067
5232
|
};
|
|
5068
5233
|
};
|
|
5069
5234
|
responses: {
|
|
5070
|
-
/** @description
|
|
5071
|
-
|
|
5235
|
+
/** @description Result of the connection attempt, written by the app connection handler. */
|
|
5236
|
+
200: {
|
|
5072
5237
|
headers: {
|
|
5073
5238
|
[name: string]: unknown;
|
|
5074
5239
|
};
|
|
5075
5240
|
content: {
|
|
5076
|
-
"application/json":
|
|
5241
|
+
"application/json": {
|
|
5242
|
+
[key: string]: unknown;
|
|
5243
|
+
};
|
|
5077
5244
|
};
|
|
5078
5245
|
};
|
|
5079
5246
|
};
|
|
5080
5247
|
};
|
|
5081
|
-
|
|
5248
|
+
AgentsController_findAllForWorkspace: {
|
|
5082
5249
|
parameters: {
|
|
5083
5250
|
query?: {
|
|
5084
|
-
/** @description Comma-separated
|
|
5251
|
+
/** @description Comma-separated include flags, e.g. `includeType=all`. Available: all */
|
|
5252
|
+
includeType?: string;
|
|
5253
|
+
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=projectId:<uuid>`. Available: projectId */
|
|
5254
|
+
filterBy?: string;
|
|
5255
|
+
/** @description Comma-separated fields to expand, e.g. `expansion=description,createdAt`. Available: createdAt, updatedAt, description, profileImageUrl, instructions, temperature, maxOutputTokens, topP, frequencyPenalty, presencePenalty, maxRetries, seed, maxToolRoundtrips, messageLookbackLimit, project, tools, toolIds, knowledge, objects, objectTypes, connections, variables, workflows, subAgents, webAccess, phoneAccess, aiConnection, selectedModelId, taskNamingInstructions, enabledBuiltInTools, enabledPlatformTools, mcpServers, a2aAgents, dynamicActionDiscoveryEnabled, dynamicMcpDiscoveryEnabled, dynamicSelfInstructionsEnabled, memoryEnabled, memoryScope, memoryRetentionDays, enablePlanning, enableToolResultOffload, toolResultOffloadThresholdBytes, longHorizonMode, longHorizonMaxSteps, longHorizonMaxTokensPerRun, enabledToolPolicies, forcedTools, requirePlanApproval, suggestedPrompts, builderSetupCompletedAt, builderCanvasPositions, slug, managedByCode */
|
|
5085
5256
|
expansion?: string;
|
|
5086
5257
|
};
|
|
5087
5258
|
header?: never;
|
|
5088
|
-
path
|
|
5089
|
-
knowledgeId: string;
|
|
5090
|
-
};
|
|
5259
|
+
path?: never;
|
|
5091
5260
|
cookie?: never;
|
|
5092
5261
|
};
|
|
5093
5262
|
requestBody?: never;
|
|
5094
5263
|
responses: {
|
|
5095
|
-
/** @description
|
|
5264
|
+
/** @description Agents in the current workspace */
|
|
5096
5265
|
200: {
|
|
5097
5266
|
headers: {
|
|
5098
5267
|
[name: string]: unknown;
|
|
5099
5268
|
};
|
|
5100
5269
|
content: {
|
|
5101
|
-
"application/json": components["schemas"]["
|
|
5270
|
+
"application/json": components["schemas"]["AgentResponseDto"][];
|
|
5102
5271
|
};
|
|
5103
5272
|
};
|
|
5104
5273
|
};
|
|
5105
5274
|
};
|
|
5106
|
-
|
|
5275
|
+
AgentsController_findOne: {
|
|
5107
5276
|
parameters: {
|
|
5108
|
-
query?:
|
|
5277
|
+
query?: {
|
|
5278
|
+
/** @description Comma-separated fields to expand, e.g. `expansion=description,createdAt`. Available: createdAt, updatedAt, description, profileImageUrl, instructions, temperature, maxOutputTokens, topP, frequencyPenalty, presencePenalty, maxRetries, seed, maxToolRoundtrips, messageLookbackLimit, project, tools, toolIds, knowledge, objects, objectTypes, connections, variables, workflows, subAgents, webAccess, phoneAccess, aiConnection, selectedModelId, taskNamingInstructions, enabledBuiltInTools, enabledPlatformTools, mcpServers, a2aAgents, dynamicActionDiscoveryEnabled, dynamicMcpDiscoveryEnabled, dynamicSelfInstructionsEnabled, memoryEnabled, memoryScope, memoryRetentionDays, enablePlanning, enableToolResultOffload, toolResultOffloadThresholdBytes, longHorizonMode, longHorizonMaxSteps, longHorizonMaxTokensPerRun, enabledToolPolicies, forcedTools, requirePlanApproval, suggestedPrompts, builderSetupCompletedAt, builderCanvasPositions, slug, managedByCode */
|
|
5279
|
+
expansion?: string;
|
|
5280
|
+
};
|
|
5109
5281
|
header?: never;
|
|
5110
5282
|
path: {
|
|
5111
|
-
|
|
5283
|
+
agentId: string;
|
|
5112
5284
|
};
|
|
5113
5285
|
cookie?: never;
|
|
5114
5286
|
};
|
|
5115
5287
|
requestBody?: never;
|
|
5116
5288
|
responses: {
|
|
5117
|
-
/** @description
|
|
5289
|
+
/** @description The requested agent */
|
|
5118
5290
|
200: {
|
|
5119
5291
|
headers: {
|
|
5120
5292
|
[name: string]: unknown;
|
|
5121
5293
|
};
|
|
5122
5294
|
content: {
|
|
5123
|
-
"application/json":
|
|
5295
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
5124
5296
|
};
|
|
5125
5297
|
};
|
|
5126
5298
|
};
|
|
5127
5299
|
};
|
|
5128
|
-
|
|
5300
|
+
ProjectAgentsController_upsertBySlug: {
|
|
5129
5301
|
parameters: {
|
|
5130
|
-
query?:
|
|
5131
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5132
|
-
expansion?: string;
|
|
5133
|
-
};
|
|
5302
|
+
query?: never;
|
|
5134
5303
|
header?: never;
|
|
5135
5304
|
path: {
|
|
5136
|
-
|
|
5305
|
+
projectId: string;
|
|
5137
5306
|
};
|
|
5138
5307
|
cookie?: never;
|
|
5139
5308
|
};
|
|
5140
5309
|
requestBody: {
|
|
5141
5310
|
content: {
|
|
5142
|
-
"application/json": components["schemas"]["
|
|
5311
|
+
"application/json": components["schemas"]["UpsertAgentBySlugDto"];
|
|
5143
5312
|
};
|
|
5144
5313
|
};
|
|
5145
5314
|
responses: {
|
|
5146
|
-
/** @description The updated
|
|
5315
|
+
/** @description The created or updated agent. */
|
|
5147
5316
|
200: {
|
|
5148
5317
|
headers: {
|
|
5149
5318
|
[name: string]: unknown;
|
|
5150
5319
|
};
|
|
5151
5320
|
content: {
|
|
5152
|
-
"application/json": components["schemas"]["
|
|
5321
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
5153
5322
|
};
|
|
5154
5323
|
};
|
|
5155
5324
|
};
|
|
5156
5325
|
};
|
|
5157
|
-
|
|
5326
|
+
KnowledgeController_findAllForWorkspace: {
|
|
5158
5327
|
parameters: {
|
|
5159
|
-
query?:
|
|
5160
|
-
|
|
5161
|
-
|
|
5162
|
-
knowledgeId: string;
|
|
5328
|
+
query?: {
|
|
5329
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5330
|
+
expansion?: string;
|
|
5163
5331
|
};
|
|
5332
|
+
header?: never;
|
|
5333
|
+
path?: never;
|
|
5164
5334
|
cookie?: never;
|
|
5165
5335
|
};
|
|
5166
|
-
requestBody
|
|
5167
|
-
content: {
|
|
5168
|
-
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5169
|
-
};
|
|
5170
|
-
};
|
|
5336
|
+
requestBody?: never;
|
|
5171
5337
|
responses: {
|
|
5172
|
-
/** @description
|
|
5173
|
-
|
|
5338
|
+
/** @description Knowledge bases in the workspace. */
|
|
5339
|
+
200: {
|
|
5174
5340
|
headers: {
|
|
5175
5341
|
[name: string]: unknown;
|
|
5176
5342
|
};
|
|
5177
5343
|
content: {
|
|
5178
|
-
"application/json":
|
|
5344
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"][];
|
|
5179
5345
|
};
|
|
5180
5346
|
};
|
|
5181
5347
|
};
|
|
5182
5348
|
};
|
|
5183
|
-
|
|
5349
|
+
KnowledgeController_create: {
|
|
5184
5350
|
parameters: {
|
|
5185
|
-
query?:
|
|
5186
|
-
|
|
5187
|
-
|
|
5188
|
-
knowledgeId: string;
|
|
5351
|
+
query?: {
|
|
5352
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5353
|
+
expansion?: string;
|
|
5189
5354
|
};
|
|
5355
|
+
header?: never;
|
|
5356
|
+
path?: never;
|
|
5190
5357
|
cookie?: never;
|
|
5191
5358
|
};
|
|
5192
|
-
requestBody
|
|
5359
|
+
requestBody: {
|
|
5360
|
+
content: {
|
|
5361
|
+
"application/json": components["schemas"]["CreateKnowledgeDto"];
|
|
5362
|
+
};
|
|
5363
|
+
};
|
|
5193
5364
|
responses: {
|
|
5194
|
-
/** @description
|
|
5195
|
-
|
|
5365
|
+
/** @description The created knowledge base. */
|
|
5366
|
+
201: {
|
|
5196
5367
|
headers: {
|
|
5197
5368
|
[name: string]: unknown;
|
|
5198
5369
|
};
|
|
5199
5370
|
content: {
|
|
5200
|
-
"application/json": components["schemas"]["
|
|
5371
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5201
5372
|
};
|
|
5202
5373
|
};
|
|
5203
5374
|
};
|
|
5204
5375
|
};
|
|
5205
|
-
|
|
5376
|
+
KnowledgeController_findOne: {
|
|
5206
5377
|
parameters: {
|
|
5207
|
-
query?:
|
|
5378
|
+
query?: {
|
|
5379
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5380
|
+
expansion?: string;
|
|
5381
|
+
};
|
|
5208
5382
|
header?: never;
|
|
5209
5383
|
path: {
|
|
5210
|
-
|
|
5384
|
+
knowledgeId: string;
|
|
5211
5385
|
};
|
|
5212
5386
|
cookie?: never;
|
|
5213
5387
|
};
|
|
5214
5388
|
requestBody?: never;
|
|
5215
5389
|
responses: {
|
|
5216
|
-
/** @description The requested
|
|
5390
|
+
/** @description The requested knowledge base. */
|
|
5217
5391
|
200: {
|
|
5218
5392
|
headers: {
|
|
5219
5393
|
[name: string]: unknown;
|
|
5220
5394
|
};
|
|
5221
5395
|
content: {
|
|
5222
|
-
"application/json": components["schemas"]["
|
|
5396
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5223
5397
|
};
|
|
5224
5398
|
};
|
|
5225
5399
|
};
|
|
5226
5400
|
};
|
|
5227
|
-
|
|
5401
|
+
KnowledgeController_delete: {
|
|
5228
5402
|
parameters: {
|
|
5229
5403
|
query?: never;
|
|
5230
5404
|
header?: never;
|
|
5231
5405
|
path: {
|
|
5232
5406
|
knowledgeId: string;
|
|
5233
|
-
groupId: string;
|
|
5234
5407
|
};
|
|
5235
5408
|
cookie?: never;
|
|
5236
5409
|
};
|
|
5237
5410
|
requestBody?: never;
|
|
5238
5411
|
responses: {
|
|
5239
|
-
/** @description Returns true when the
|
|
5412
|
+
/** @description Returns true when the knowledge base was deleted. */
|
|
5240
5413
|
200: {
|
|
5241
5414
|
headers: {
|
|
5242
5415
|
[name: string]: unknown;
|
|
@@ -5247,147 +5420,124 @@ interface operations {
|
|
|
5247
5420
|
};
|
|
5248
5421
|
};
|
|
5249
5422
|
};
|
|
5250
|
-
|
|
5423
|
+
KnowledgeController_update: {
|
|
5251
5424
|
parameters: {
|
|
5252
|
-
query?:
|
|
5425
|
+
query?: {
|
|
5426
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5427
|
+
expansion?: string;
|
|
5428
|
+
};
|
|
5253
5429
|
header?: never;
|
|
5254
5430
|
path: {
|
|
5255
|
-
|
|
5431
|
+
knowledgeId: string;
|
|
5256
5432
|
};
|
|
5257
5433
|
cookie?: never;
|
|
5258
5434
|
};
|
|
5259
5435
|
requestBody: {
|
|
5260
5436
|
content: {
|
|
5261
|
-
"application/json": components["schemas"]["
|
|
5262
|
-
};
|
|
5263
|
-
};
|
|
5264
|
-
responses: {
|
|
5265
|
-
/** @description The newly created execution. Only the execution ID is returned; poll GET /executions/{executionId} to track progress. */
|
|
5266
|
-
201: {
|
|
5267
|
-
headers: {
|
|
5268
|
-
[name: string]: unknown;
|
|
5269
|
-
};
|
|
5270
|
-
content: {
|
|
5271
|
-
"application/json": components["schemas"]["ExecuteWorkflowResponseDto"];
|
|
5272
|
-
};
|
|
5273
|
-
};
|
|
5274
|
-
};
|
|
5275
|
-
};
|
|
5276
|
-
ExecutionsController_findAll: {
|
|
5277
|
-
parameters: {
|
|
5278
|
-
query?: {
|
|
5279
|
-
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include executions of internal workflows, which are excluded by default. */
|
|
5280
|
-
includeType?: string;
|
|
5281
|
-
/** @description Comma-separated key:value filters. Available: projectId, workflowId, source (WORKFLOW|SDK). Example: filterBy=workflowId:wf_123 or filterBy=source:SDK */
|
|
5282
|
-
filterBy?: string;
|
|
5283
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, startedAt, stoppedAt, executionNumber, nodes, edges, status, statusMessage, continueExecutionAt, workflow, project, workspace, output, orientation, executionVariables, source, name. The executionPath expansion is only honoured on GET /executions/{executionId}. Example: expansion=status,startedAt,workflow,source */
|
|
5284
|
-
expansion?: string;
|
|
5437
|
+
"application/json": components["schemas"]["UpdateKnowledgeDto"];
|
|
5285
5438
|
};
|
|
5286
|
-
header?: never;
|
|
5287
|
-
path?: never;
|
|
5288
|
-
cookie?: never;
|
|
5289
5439
|
};
|
|
5290
|
-
requestBody?: never;
|
|
5291
5440
|
responses: {
|
|
5292
|
-
/** @description
|
|
5441
|
+
/** @description The updated knowledge base. */
|
|
5293
5442
|
200: {
|
|
5294
5443
|
headers: {
|
|
5295
5444
|
[name: string]: unknown;
|
|
5296
5445
|
};
|
|
5297
5446
|
content: {
|
|
5298
|
-
"application/json": components["schemas"]["
|
|
5447
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5299
5448
|
};
|
|
5300
5449
|
};
|
|
5301
5450
|
};
|
|
5302
5451
|
};
|
|
5303
|
-
|
|
5452
|
+
KnowledgeController_saveUploadedTextToKnowledge: {
|
|
5304
5453
|
parameters: {
|
|
5305
|
-
query?:
|
|
5306
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, startedAt, stoppedAt, executionNumber, nodes, edges, status, statusMessage, continueExecutionAt, workflow, project, workspace, output, orientation, executionVariables, executionPath, pendingInput, source, name. executionPath is the derived, ordered list of executed (or queued) steps with labels, per-step status, timings, and loop iteration metadata. pendingInput is the field schema for steps paused in NEEDS_INPUT. Example: expansion=status,executionPath,pendingInput,source */
|
|
5307
|
-
expansion?: string;
|
|
5308
|
-
};
|
|
5454
|
+
query?: never;
|
|
5309
5455
|
header?: never;
|
|
5310
5456
|
path: {
|
|
5311
|
-
|
|
5457
|
+
knowledgeId: string;
|
|
5312
5458
|
};
|
|
5313
5459
|
cookie?: never;
|
|
5314
5460
|
};
|
|
5315
|
-
requestBody
|
|
5461
|
+
requestBody: {
|
|
5462
|
+
content: {
|
|
5463
|
+
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5464
|
+
};
|
|
5465
|
+
};
|
|
5316
5466
|
responses: {
|
|
5317
|
-
/** @description
|
|
5318
|
-
|
|
5467
|
+
/** @description Returns true when the text was embedded and stored. */
|
|
5468
|
+
201: {
|
|
5319
5469
|
headers: {
|
|
5320
5470
|
[name: string]: unknown;
|
|
5321
5471
|
};
|
|
5322
5472
|
content: {
|
|
5323
|
-
"application/json":
|
|
5473
|
+
"application/json": boolean;
|
|
5324
5474
|
};
|
|
5325
5475
|
};
|
|
5326
5476
|
};
|
|
5327
5477
|
};
|
|
5328
|
-
|
|
5478
|
+
KnowledgeController_getDocuments: {
|
|
5329
5479
|
parameters: {
|
|
5330
5480
|
query?: never;
|
|
5331
5481
|
header?: never;
|
|
5332
5482
|
path: {
|
|
5333
|
-
|
|
5483
|
+
knowledgeId: string;
|
|
5334
5484
|
};
|
|
5335
5485
|
cookie?: never;
|
|
5336
5486
|
};
|
|
5337
5487
|
requestBody?: never;
|
|
5338
5488
|
responses: {
|
|
5489
|
+
/** @description Documents in the knowledge base, newest first. */
|
|
5339
5490
|
200: {
|
|
5340
5491
|
headers: {
|
|
5341
5492
|
[name: string]: unknown;
|
|
5342
5493
|
};
|
|
5343
|
-
content
|
|
5494
|
+
content: {
|
|
5495
|
+
"application/json": components["schemas"]["KnowledgeDocumentResponseDto"][];
|
|
5496
|
+
};
|
|
5344
5497
|
};
|
|
5345
5498
|
};
|
|
5346
5499
|
};
|
|
5347
|
-
|
|
5500
|
+
KnowledgeController_getDocumentGroup: {
|
|
5348
5501
|
parameters: {
|
|
5349
5502
|
query?: never;
|
|
5350
5503
|
header?: never;
|
|
5351
|
-
path
|
|
5352
|
-
|
|
5353
|
-
};
|
|
5354
|
-
requestBody: {
|
|
5355
|
-
content: {
|
|
5356
|
-
"application/json": components["schemas"]["RunActionDto"];
|
|
5504
|
+
path: {
|
|
5505
|
+
groupId: string;
|
|
5357
5506
|
};
|
|
5507
|
+
cookie?: never;
|
|
5358
5508
|
};
|
|
5509
|
+
requestBody?: never;
|
|
5359
5510
|
responses: {
|
|
5360
|
-
/** @description The
|
|
5361
|
-
|
|
5511
|
+
/** @description The requested document group. */
|
|
5512
|
+
200: {
|
|
5362
5513
|
headers: {
|
|
5363
5514
|
[name: string]: unknown;
|
|
5364
5515
|
};
|
|
5365
5516
|
content: {
|
|
5366
|
-
"application/json": components["schemas"]["
|
|
5517
|
+
"application/json": components["schemas"]["KnowledgeDocumentGroupResponseDto"];
|
|
5367
5518
|
};
|
|
5368
5519
|
};
|
|
5369
5520
|
};
|
|
5370
5521
|
};
|
|
5371
|
-
|
|
5522
|
+
KnowledgeController_deleteDocumentGroup: {
|
|
5372
5523
|
parameters: {
|
|
5373
5524
|
query?: never;
|
|
5374
5525
|
header?: never;
|
|
5375
|
-
path
|
|
5376
|
-
|
|
5377
|
-
|
|
5378
|
-
requestBody: {
|
|
5379
|
-
content: {
|
|
5380
|
-
"application/json": components["schemas"]["StartRunDto"];
|
|
5526
|
+
path: {
|
|
5527
|
+
knowledgeId: string;
|
|
5528
|
+
groupId: string;
|
|
5381
5529
|
};
|
|
5530
|
+
cookie?: never;
|
|
5382
5531
|
};
|
|
5532
|
+
requestBody?: never;
|
|
5383
5533
|
responses: {
|
|
5384
|
-
/** @description
|
|
5385
|
-
|
|
5534
|
+
/** @description Returns true when the document group was deleted. */
|
|
5535
|
+
200: {
|
|
5386
5536
|
headers: {
|
|
5387
5537
|
[name: string]: unknown;
|
|
5388
5538
|
};
|
|
5389
5539
|
content: {
|
|
5390
|
-
"application/json":
|
|
5540
|
+
"application/json": boolean;
|
|
5391
5541
|
};
|
|
5392
5542
|
};
|
|
5393
5543
|
};
|
|
@@ -5574,7 +5724,7 @@ interface operations {
|
|
|
5574
5724
|
};
|
|
5575
5725
|
};
|
|
5576
5726
|
};
|
|
5577
|
-
|
|
5727
|
+
ExecutionsController_manuallyExecuteWorkflow: {
|
|
5578
5728
|
parameters: {
|
|
5579
5729
|
query?: never;
|
|
5580
5730
|
header?: never;
|
|
@@ -5583,100 +5733,157 @@ interface operations {
|
|
|
5583
5733
|
};
|
|
5584
5734
|
cookie?: never;
|
|
5585
5735
|
};
|
|
5736
|
+
requestBody: {
|
|
5737
|
+
content: {
|
|
5738
|
+
"application/json": components["schemas"]["ManuallyRunWorkflowInputDataDto"];
|
|
5739
|
+
};
|
|
5740
|
+
};
|
|
5741
|
+
responses: {
|
|
5742
|
+
/** @description The newly created execution. Only the execution ID is returned; poll GET /executions/{executionId} to track progress. */
|
|
5743
|
+
201: {
|
|
5744
|
+
headers: {
|
|
5745
|
+
[name: string]: unknown;
|
|
5746
|
+
};
|
|
5747
|
+
content: {
|
|
5748
|
+
"application/json": components["schemas"]["ExecuteWorkflowResponseDto"];
|
|
5749
|
+
};
|
|
5750
|
+
};
|
|
5751
|
+
};
|
|
5752
|
+
};
|
|
5753
|
+
ExecutionsController_findAll: {
|
|
5754
|
+
parameters: {
|
|
5755
|
+
query?: {
|
|
5756
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include executions of internal workflows, which are excluded by default. */
|
|
5757
|
+
includeType?: string;
|
|
5758
|
+
/** @description Comma-separated key:value filters. Available: projectId, workflowId, source (WORKFLOW|SDK). Example: filterBy=workflowId:wf_123 or filterBy=source:SDK */
|
|
5759
|
+
filterBy?: string;
|
|
5760
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, startedAt, stoppedAt, executionNumber, nodes, edges, status, statusMessage, continueExecutionAt, workflow, project, workspace, output, orientation, executionVariables, source, name. The executionPath expansion is only honoured on GET /executions/{executionId}. Example: expansion=status,startedAt,workflow,source */
|
|
5761
|
+
expansion?: string;
|
|
5762
|
+
};
|
|
5763
|
+
header?: never;
|
|
5764
|
+
path?: never;
|
|
5765
|
+
cookie?: never;
|
|
5766
|
+
};
|
|
5586
5767
|
requestBody?: never;
|
|
5587
5768
|
responses: {
|
|
5588
|
-
/** @description
|
|
5769
|
+
/** @description List of executions. Fields beyond the ID are included according to the expansion query parameter. */
|
|
5589
5770
|
200: {
|
|
5590
5771
|
headers: {
|
|
5591
5772
|
[name: string]: unknown;
|
|
5592
5773
|
};
|
|
5593
5774
|
content: {
|
|
5594
|
-
"application/json":
|
|
5595
|
-
[key: string]: unknown;
|
|
5596
|
-
};
|
|
5775
|
+
"application/json": components["schemas"]["ExecutionResponseDto"][];
|
|
5597
5776
|
};
|
|
5598
5777
|
};
|
|
5599
5778
|
};
|
|
5600
5779
|
};
|
|
5601
|
-
|
|
5780
|
+
ExecutionsController_findOne: {
|
|
5602
5781
|
parameters: {
|
|
5603
|
-
query?:
|
|
5782
|
+
query?: {
|
|
5783
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, startedAt, stoppedAt, executionNumber, nodes, edges, status, statusMessage, continueExecutionAt, workflow, project, workspace, output, orientation, executionVariables, executionPath, pendingInput, source, name. executionPath is the derived, ordered list of executed (or queued) steps with labels, per-step status, timings, and loop iteration metadata. pendingInput is the field schema for steps paused in NEEDS_INPUT. Example: expansion=status,executionPath,pendingInput,source */
|
|
5784
|
+
expansion?: string;
|
|
5785
|
+
};
|
|
5604
5786
|
header?: never;
|
|
5605
5787
|
path: {
|
|
5606
|
-
|
|
5788
|
+
executionId: string;
|
|
5607
5789
|
};
|
|
5608
5790
|
cookie?: never;
|
|
5609
5791
|
};
|
|
5610
|
-
requestBody?:
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5792
|
+
requestBody?: never;
|
|
5793
|
+
responses: {
|
|
5794
|
+
/** @description The execution. Fields beyond the ID and startedAt are included according to the expansion query parameter. */
|
|
5795
|
+
200: {
|
|
5796
|
+
headers: {
|
|
5797
|
+
[name: string]: unknown;
|
|
5614
5798
|
};
|
|
5799
|
+
content: {
|
|
5800
|
+
"application/json": components["schemas"]["ExecutionResponseDto"];
|
|
5801
|
+
};
|
|
5802
|
+
};
|
|
5803
|
+
};
|
|
5804
|
+
};
|
|
5805
|
+
ExecutionsController_streamExecution: {
|
|
5806
|
+
parameters: {
|
|
5807
|
+
query?: never;
|
|
5808
|
+
header?: never;
|
|
5809
|
+
path: {
|
|
5810
|
+
executionId: string;
|
|
5615
5811
|
};
|
|
5812
|
+
cookie?: never;
|
|
5616
5813
|
};
|
|
5814
|
+
requestBody?: never;
|
|
5617
5815
|
responses: {
|
|
5618
|
-
/** @description
|
|
5816
|
+
/** @description SSE stream of execution progress, loop progress, finished, and heartbeat events */
|
|
5619
5817
|
200: {
|
|
5620
5818
|
headers: {
|
|
5621
5819
|
[name: string]: unknown;
|
|
5622
5820
|
};
|
|
5623
5821
|
content: {
|
|
5624
|
-
"
|
|
5625
|
-
[key: string]: unknown;
|
|
5626
|
-
};
|
|
5822
|
+
"text/event-stream": string;
|
|
5627
5823
|
};
|
|
5628
5824
|
};
|
|
5629
5825
|
};
|
|
5630
5826
|
};
|
|
5631
|
-
|
|
5827
|
+
ActionsController_run: {
|
|
5632
5828
|
parameters: {
|
|
5633
5829
|
query?: never;
|
|
5634
5830
|
header?: never;
|
|
5635
|
-
path
|
|
5636
|
-
workflowId: string;
|
|
5637
|
-
};
|
|
5831
|
+
path?: never;
|
|
5638
5832
|
cookie?: never;
|
|
5639
5833
|
};
|
|
5640
|
-
requestBody
|
|
5834
|
+
requestBody: {
|
|
5641
5835
|
content: {
|
|
5642
|
-
"application/json":
|
|
5643
|
-
[key: string]: unknown;
|
|
5644
|
-
};
|
|
5836
|
+
"application/json": components["schemas"]["RunActionDto"];
|
|
5645
5837
|
};
|
|
5646
5838
|
};
|
|
5647
5839
|
responses: {
|
|
5648
|
-
/** @description The
|
|
5649
|
-
|
|
5840
|
+
/** @description The ad-hoc Execution id plus the synchronous action result (status, output, single-step executionPath). */
|
|
5841
|
+
201: {
|
|
5650
5842
|
headers: {
|
|
5651
5843
|
[name: string]: unknown;
|
|
5652
5844
|
};
|
|
5653
5845
|
content: {
|
|
5654
|
-
"application/json":
|
|
5655
|
-
[key: string]: unknown;
|
|
5656
|
-
};
|
|
5846
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5657
5847
|
};
|
|
5658
5848
|
};
|
|
5659
5849
|
};
|
|
5660
5850
|
};
|
|
5661
|
-
|
|
5851
|
+
RunsController_start: {
|
|
5662
5852
|
parameters: {
|
|
5663
5853
|
query?: never;
|
|
5664
5854
|
header?: never;
|
|
5665
|
-
path
|
|
5666
|
-
executionId: string;
|
|
5667
|
-
nodeId: string;
|
|
5668
|
-
};
|
|
5855
|
+
path?: never;
|
|
5669
5856
|
cookie?: never;
|
|
5670
5857
|
};
|
|
5671
|
-
requestBody
|
|
5858
|
+
requestBody: {
|
|
5672
5859
|
content: {
|
|
5673
|
-
"application/json":
|
|
5674
|
-
|
|
5860
|
+
"application/json": components["schemas"]["StartRunDto"];
|
|
5861
|
+
};
|
|
5862
|
+
};
|
|
5863
|
+
responses: {
|
|
5864
|
+
/** @description The ad-hoc Execution id plus the synchronous multi-step result (status, last-step output, executionPath). */
|
|
5865
|
+
201: {
|
|
5866
|
+
headers: {
|
|
5867
|
+
[name: string]: unknown;
|
|
5868
|
+
};
|
|
5869
|
+
content: {
|
|
5870
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5675
5871
|
};
|
|
5676
5872
|
};
|
|
5677
5873
|
};
|
|
5874
|
+
};
|
|
5875
|
+
WebhookController_workflowEventGet: {
|
|
5876
|
+
parameters: {
|
|
5877
|
+
query?: never;
|
|
5878
|
+
header?: never;
|
|
5879
|
+
path: {
|
|
5880
|
+
workflowId: string;
|
|
5881
|
+
};
|
|
5882
|
+
cookie?: never;
|
|
5883
|
+
};
|
|
5884
|
+
requestBody?: never;
|
|
5678
5885
|
responses: {
|
|
5679
|
-
/** @description
|
|
5886
|
+
/** @description The output of the webhook trigger when the workflow responds synchronously; empty otherwise. */
|
|
5680
5887
|
200: {
|
|
5681
5888
|
headers: {
|
|
5682
5889
|
[name: string]: unknown;
|
|
@@ -5689,80 +5896,93 @@ interface operations {
|
|
|
5689
5896
|
};
|
|
5690
5897
|
};
|
|
5691
5898
|
};
|
|
5692
|
-
|
|
5899
|
+
WebhookController_workflowEventPUT: {
|
|
5693
5900
|
parameters: {
|
|
5694
|
-
query?:
|
|
5695
|
-
/** @description Comma-separated include flags, e.g. `includeType=all`. Available: all */
|
|
5696
|
-
includeType?: string;
|
|
5697
|
-
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=projectId:<uuid>`. Available: projectId */
|
|
5698
|
-
filterBy?: string;
|
|
5699
|
-
/** @description Comma-separated fields to expand, e.g. `expansion=description,createdAt`. Available: createdAt, updatedAt, description, profileImageUrl, instructions, temperature, maxOutputTokens, topP, frequencyPenalty, presencePenalty, maxRetries, seed, maxToolRoundtrips, messageLookbackLimit, project, tools, toolIds, knowledge, objects, objectTypes, connections, variables, workflows, subAgents, webAccess, phoneAccess, aiConnection, selectedModelId, taskNamingInstructions, enabledBuiltInTools, enabledPlatformTools, mcpServers, a2aAgents, dynamicActionDiscoveryEnabled, dynamicMcpDiscoveryEnabled, dynamicSelfInstructionsEnabled, memoryEnabled, memoryScope, memoryRetentionDays, suggestedPrompts, builderSetupCompletedAt, builderCanvasPositions, slug, managedByCode */
|
|
5700
|
-
expansion?: string;
|
|
5701
|
-
};
|
|
5901
|
+
query?: never;
|
|
5702
5902
|
header?: never;
|
|
5703
|
-
path
|
|
5903
|
+
path: {
|
|
5904
|
+
workflowId: string;
|
|
5905
|
+
};
|
|
5704
5906
|
cookie?: never;
|
|
5705
5907
|
};
|
|
5706
|
-
requestBody?:
|
|
5908
|
+
requestBody?: {
|
|
5909
|
+
content: {
|
|
5910
|
+
"application/json": {
|
|
5911
|
+
[key: string]: unknown;
|
|
5912
|
+
};
|
|
5913
|
+
};
|
|
5914
|
+
};
|
|
5707
5915
|
responses: {
|
|
5708
|
-
/** @description
|
|
5916
|
+
/** @description The output of the webhook trigger when the workflow responds synchronously; empty otherwise. */
|
|
5709
5917
|
200: {
|
|
5710
5918
|
headers: {
|
|
5711
5919
|
[name: string]: unknown;
|
|
5712
5920
|
};
|
|
5713
5921
|
content: {
|
|
5714
|
-
"application/json":
|
|
5922
|
+
"application/json": {
|
|
5923
|
+
[key: string]: unknown;
|
|
5924
|
+
};
|
|
5715
5925
|
};
|
|
5716
5926
|
};
|
|
5717
5927
|
};
|
|
5718
5928
|
};
|
|
5719
|
-
|
|
5929
|
+
WebhookController_workflowEventPOST: {
|
|
5720
5930
|
parameters: {
|
|
5721
|
-
query?:
|
|
5722
|
-
/** @description Comma-separated fields to expand, e.g. `expansion=description,createdAt`. Available: createdAt, updatedAt, description, profileImageUrl, instructions, temperature, maxOutputTokens, topP, frequencyPenalty, presencePenalty, maxRetries, seed, maxToolRoundtrips, messageLookbackLimit, project, tools, toolIds, knowledge, objects, objectTypes, connections, variables, workflows, subAgents, webAccess, phoneAccess, aiConnection, selectedModelId, taskNamingInstructions, enabledBuiltInTools, enabledPlatformTools, mcpServers, a2aAgents, dynamicActionDiscoveryEnabled, dynamicMcpDiscoveryEnabled, dynamicSelfInstructionsEnabled, memoryEnabled, memoryScope, memoryRetentionDays, suggestedPrompts, builderSetupCompletedAt, builderCanvasPositions, slug, managedByCode */
|
|
5723
|
-
expansion?: string;
|
|
5724
|
-
};
|
|
5931
|
+
query?: never;
|
|
5725
5932
|
header?: never;
|
|
5726
5933
|
path: {
|
|
5727
|
-
|
|
5934
|
+
workflowId: string;
|
|
5728
5935
|
};
|
|
5729
5936
|
cookie?: never;
|
|
5730
5937
|
};
|
|
5731
|
-
requestBody?:
|
|
5938
|
+
requestBody?: {
|
|
5939
|
+
content: {
|
|
5940
|
+
"application/json": {
|
|
5941
|
+
[key: string]: unknown;
|
|
5942
|
+
};
|
|
5943
|
+
};
|
|
5944
|
+
};
|
|
5732
5945
|
responses: {
|
|
5733
|
-
/** @description The
|
|
5946
|
+
/** @description The output of the webhook trigger when the workflow responds synchronously; empty otherwise. */
|
|
5734
5947
|
200: {
|
|
5735
5948
|
headers: {
|
|
5736
5949
|
[name: string]: unknown;
|
|
5737
5950
|
};
|
|
5738
5951
|
content: {
|
|
5739
|
-
"application/json":
|
|
5952
|
+
"application/json": {
|
|
5953
|
+
[key: string]: unknown;
|
|
5954
|
+
};
|
|
5740
5955
|
};
|
|
5741
5956
|
};
|
|
5742
5957
|
};
|
|
5743
5958
|
};
|
|
5744
|
-
|
|
5959
|
+
WebhookController_executionStepEventPOST: {
|
|
5745
5960
|
parameters: {
|
|
5746
5961
|
query?: never;
|
|
5747
5962
|
header?: never;
|
|
5748
5963
|
path: {
|
|
5749
|
-
|
|
5964
|
+
executionId: string;
|
|
5965
|
+
nodeId: string;
|
|
5750
5966
|
};
|
|
5751
5967
|
cookie?: never;
|
|
5752
5968
|
};
|
|
5753
|
-
requestBody
|
|
5969
|
+
requestBody?: {
|
|
5754
5970
|
content: {
|
|
5755
|
-
"application/json":
|
|
5971
|
+
"application/json": {
|
|
5972
|
+
[key: string]: unknown;
|
|
5973
|
+
};
|
|
5756
5974
|
};
|
|
5757
5975
|
};
|
|
5758
5976
|
responses: {
|
|
5759
|
-
/** @description The
|
|
5977
|
+
/** @description Acknowledgement that the input was received. The execution resumes asynchronously; poll GET /executions/{executionId} to track progress. */
|
|
5760
5978
|
200: {
|
|
5761
5979
|
headers: {
|
|
5762
5980
|
[name: string]: unknown;
|
|
5763
5981
|
};
|
|
5764
5982
|
content: {
|
|
5765
|
-
"application/json":
|
|
5983
|
+
"application/json": {
|
|
5984
|
+
[key: string]: unknown;
|
|
5985
|
+
};
|
|
5766
5986
|
};
|
|
5767
5987
|
};
|
|
5768
5988
|
};
|
|
@@ -6067,8 +6287,10 @@ type Queue = Schemas['QueueResponseDto'];
|
|
|
6067
6287
|
type CreateQueueInput = Schemas['CreateQueueDto'];
|
|
6068
6288
|
type UpdateQueueInput = Schemas['UpdateQueueDto'];
|
|
6069
6289
|
type QueueStats = Schemas['QueueStatsResponseDto'];
|
|
6290
|
+
type QueueAllowedObjectType = Schemas['QueueAllowedObjectTypeDto'];
|
|
6070
6291
|
type QueueItem = Schemas['QueueItemResponseDto'];
|
|
6071
6292
|
type QueueItemFull = Schemas['QueueItemFullResponseDto'];
|
|
6293
|
+
type QueueItemCreated = Schemas['QueueItemCreateResponseDto'];
|
|
6072
6294
|
type CreateQueueItemInput = Schemas['CreateQueueItemDto'];
|
|
6073
6295
|
type UpdateQueueItemInput = Schemas['UpdateQueueItemDto'];
|
|
6074
6296
|
type QueueItemList = Schemas['QueueItemListResponseDto'];
|
|
@@ -6076,6 +6298,7 @@ type QueueItemStats = Schemas['QueueItemStatsResponseDto'];
|
|
|
6076
6298
|
type BulkCreateQueueItemsInput = Schemas['BulkCreateQueueItemsDto'];
|
|
6077
6299
|
type BulkCreateQueueItemsResult = Schemas['BulkCreateQueueItemsResponseDto'];
|
|
6078
6300
|
type QueueItemErrorEntry = Schemas['QueueItemErrorEntryResponseDto'];
|
|
6301
|
+
type QueueItemObjectSummary = Schemas['QueueItemObjectSummaryDto'];
|
|
6079
6302
|
type Variable = Schemas['VariableResponseDto'];
|
|
6080
6303
|
type CreateVariableInput = Schemas['CreateVariableDto'];
|
|
6081
6304
|
type UpdateVariableInput = Schemas['UpdateVariableDto'];
|
|
@@ -6328,6 +6551,7 @@ declare const DEFINE_KINDS: {
|
|
|
6328
6551
|
readonly action: "action";
|
|
6329
6552
|
readonly workflow: "workflow";
|
|
6330
6553
|
readonly agent: "agent";
|
|
6554
|
+
readonly entityType: "entityType";
|
|
6331
6555
|
};
|
|
6332
6556
|
type DefineKind = (typeof DEFINE_KINDS)[keyof typeof DEFINE_KINDS];
|
|
6333
6557
|
/** Ref to an existing app Connection (credentials stay on Lunnoa). */
|
|
@@ -6400,6 +6624,26 @@ declare function defineAiConnection(config?: Omit<AiConnectionDefinition, 'kind'
|
|
|
6400
6624
|
declare function defineAction(config: Omit<ActionDefinition, 'kind'>): ActionDefinition;
|
|
6401
6625
|
declare function defineWorkflow(config: Omit<WorkflowDefinition, 'kind'>): WorkflowDefinition;
|
|
6402
6626
|
declare function defineAgent(config: Omit<AgentDefinition, 'kind'>): AgentDefinition;
|
|
6627
|
+
interface EntityTypeDefinition {
|
|
6628
|
+
kind: typeof DEFINE_KINDS.entityType;
|
|
6629
|
+
/** Stable workspace-scoped slug (upsert key). */
|
|
6630
|
+
slug: string;
|
|
6631
|
+
name?: string;
|
|
6632
|
+
namePlural?: string;
|
|
6633
|
+
description?: string;
|
|
6634
|
+
icon?: string;
|
|
6635
|
+
color?: string;
|
|
6636
|
+
/** Field definitions grouped into sections (same contract as Adminspace). */
|
|
6637
|
+
attributeSchema: Record<string, unknown>;
|
|
6638
|
+
stateSchema?: Record<string, unknown> | null;
|
|
6639
|
+
isEnabled?: boolean;
|
|
6640
|
+
/**
|
|
6641
|
+
* When false (default), entity writes reject undeclared attribute keys.
|
|
6642
|
+
* Reserved key `extensions` is always allowed as a JSON object.
|
|
6643
|
+
*/
|
|
6644
|
+
allowUnknownAttributes?: boolean;
|
|
6645
|
+
}
|
|
6646
|
+
declare function defineEntityType(config: Omit<EntityTypeDefinition, 'kind'>): EntityTypeDefinition;
|
|
6403
6647
|
/** Infer appId from catalogue action ids like `http_action_send-request`. */
|
|
6404
6648
|
declare function resolveActionAppId(action: ActionDefinition): string;
|
|
6405
6649
|
declare function resolveActionId(action: ActionDefinition): string;
|
|
@@ -6697,6 +6941,21 @@ interface EntityTypeReadOptions {
|
|
|
6697
6941
|
/** Fields to expand, e.g. `['attributeSchema', 'stateSchema', 'description']`. */
|
|
6698
6942
|
expansion?: string | string[];
|
|
6699
6943
|
}
|
|
6944
|
+
/** Payload for `POST /api/object-types/upsert`. */
|
|
6945
|
+
interface UpsertEntityTypeBySlugInput {
|
|
6946
|
+
slug: string;
|
|
6947
|
+
name?: string;
|
|
6948
|
+
namePlural?: string;
|
|
6949
|
+
description?: string;
|
|
6950
|
+
icon?: string;
|
|
6951
|
+
color?: string;
|
|
6952
|
+
attributeSchema: Record<string, unknown>;
|
|
6953
|
+
stateSchema?: Record<string, unknown> | null;
|
|
6954
|
+
isEnabled?: boolean;
|
|
6955
|
+
allowUnknownAttributes?: boolean;
|
|
6956
|
+
managedByCode?: boolean;
|
|
6957
|
+
}
|
|
6958
|
+
declare function entityTypeDefinitionToUpsert(def: EntityTypeDefinition): UpsertEntityTypeBySlugInput;
|
|
6700
6959
|
declare class EntityTypesResource {
|
|
6701
6960
|
private readonly http;
|
|
6702
6961
|
constructor(http: HttpClient);
|
|
@@ -6712,6 +6971,11 @@ declare class EntityTypesResource {
|
|
|
6712
6971
|
get(id: string, options?: EntityTypeReadOptions): Promise<EntityType>;
|
|
6713
6972
|
/** Returns a single entity type by its URL-safe slug. */
|
|
6714
6973
|
getBySlug(slug: string, options?: EntityTypeReadOptions): Promise<EntityType>;
|
|
6974
|
+
/**
|
|
6975
|
+
* Creates or updates an entity type by workspace-scoped slug.
|
|
6976
|
+
* Prefer the CLI (`npx @lunnoa/client entity-types deploy`) for happy-path deploy.
|
|
6977
|
+
*/
|
|
6978
|
+
upsertBySlug(definition: EntityTypeDefinition | UpsertEntityTypeBySlugInput): Promise<EntityType>;
|
|
6715
6979
|
}
|
|
6716
6980
|
|
|
6717
6981
|
type EligibleApprover = {
|
|
@@ -6819,8 +7083,15 @@ interface ListQueueItemsOptions {
|
|
|
6819
7083
|
limit?: number;
|
|
6820
7084
|
offset?: number;
|
|
6821
7085
|
expansion?: string | string[];
|
|
7086
|
+
/** Supports keys including `status`, `externalId`, `objectId`, `priority`. */
|
|
6822
7087
|
filterBy?: string | Record<string, string>;
|
|
6823
7088
|
}
|
|
7089
|
+
interface ListQueueItemsByObjectOptions {
|
|
7090
|
+
status?: string;
|
|
7091
|
+
limit?: number;
|
|
7092
|
+
offset?: number;
|
|
7093
|
+
expansion?: string | string[];
|
|
7094
|
+
}
|
|
6824
7095
|
declare class QueueItemsResource {
|
|
6825
7096
|
private readonly http;
|
|
6826
7097
|
constructor(http: HttpClient);
|
|
@@ -6830,8 +7101,15 @@ declare class QueueItemsResource {
|
|
|
6830
7101
|
iterate(queueId: string, options?: Omit<ListQueueItemsOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
6831
7102
|
/** Returns a single queue item. */
|
|
6832
7103
|
get(queueId: string, itemId: string): Promise<QueueItemFull>;
|
|
6833
|
-
/** Adds an item to a queue. */
|
|
6834
|
-
create(queueId: string, data: CreateQueueItemInput): Promise<
|
|
7104
|
+
/** Adds an item to a queue. Pass `objectId` to link the item to an entity. */
|
|
7105
|
+
create(queueId: string, data: CreateQueueItemInput): Promise<QueueItemCreated>;
|
|
7106
|
+
/**
|
|
7107
|
+
* Lists queue items linked to an Object across all queues in the workspace.
|
|
7108
|
+
* Use for Object detail "Work" panels.
|
|
7109
|
+
*/
|
|
7110
|
+
listByObject(objectId: string, options?: ListQueueItemsByObjectOptions): Promise<QueueItemList>;
|
|
7111
|
+
/** Async-iterates every queue item linked to an Object. */
|
|
7112
|
+
iterateByObject(objectId: string, options?: Omit<ListQueueItemsByObjectOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
6835
7113
|
/** Adds many items to a queue in one call. */
|
|
6836
7114
|
bulkCreate(queueId: string, data: BulkCreateQueueItemsInput): Promise<BulkCreateQueueItemsResult>;
|
|
6837
7115
|
/** Updates a queue item. */
|
|
@@ -7208,4 +7486,4 @@ interface CreateServerClientOptions {
|
|
|
7208
7486
|
*/
|
|
7209
7487
|
declare function createServerClient(options: CreateServerClientOptions): LunnoaClient;
|
|
7210
7488
|
|
|
7211
|
-
export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type Agent, AgentChatClient, AgentChatStream, type AgentDefinition, type AgentToolDefinition, AgentsResource, type AiConnectionDefinition, type ApprovalInboxItem, ApprovalsResource, AuthResource, type AuthTokens, type BulkCreateQueueItemsInput, type BulkCreateQueueItemsResult, type ChangeEntityStateInput, type ChangeEntityStateResult, type ChatMode, type Connection, type ConnectionDefinition, ConnectionsResource, type CreateBrowserClientOptions, type CreateEntityInput, type CreateKnowledgeInput, type CreateProjectInput, type CreateQueueInput, type CreateQueueItemInput, type CreateServerClientOptions, type CreateTaskInput, type CreateVariableInput, type CurrentUser, DEFINE_KINDS, type DefineKind, type DeletedTask, DiscoveryResource, type EligibleApprover, type EnabledFeatures, EntitiesResource, type Entity, type EntityStateHistoryEntry, type EntityStateTransitions, type EntityType, type EntityTypeReadOptions, EntityTypesResource, type ExecuteWorkflowResult, type Execution, type ExecutionPathStep, type ExecutionProgress, type ExecutionProgressPayload, type ExecutionProgressStep, ExecutionProgressStream, type ExecutionStatus, type ExecutionStreamEvent, type ExecutionStreamEventType, ExecutionTimeoutError, ExecutionsResource, type ExportEntitiesInput, type FetchLike, HttpClient, type ImportEntitiesInput, type ImportEntitiesResult, type ImportTemplate, type Knowledge, type KnowledgeDocument, type KnowledgeDocumentGroup, KnowledgeResource, type ListEntitiesOptions, type ListQueryOptions, type ListQueueItemsOptions, type LocalStorageTokenStoreOptions, type LoginRequires2FA, type LoginResult, type LoginSuccess, LunnoaApiError, LunnoaClient, type LunnoaClientOptions, type MessageTaskInput, type OffsetPagination, type PagePagination, type PaginatedEntities, type PendingInput, type PendingInputField, type Project, ProjectsResource, type QueryValue, type Queue, type QueueItem, type QueueItemErrorEntry, type QueueItemFull, type QueueItemList, type QueueItemStats, QueueItemsResource, type QueueStats, QueuesResource, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type SseEvent, SsoAuthResource, type SsoProviderSummary, type SsoProvidersResponse, type StartRunInput, type StartRunInputDto, type StartRunOptions, type StartRunStep, type StopStreamOptions, type StreamMessageOptions, type Task, type TaskListItem, TasksResource, type TokenStore, type UpdateEntityInput, type UpdateKnowledgeInput, type UpdateQueueInput, type UpdateQueueItemInput, type UpdateTaskInput, type UpdateVariableInput, type UpsertAgentBySlugInput, type UpsertAgentBySlugInputDto, type UpsertAgentToolInput, type UpsertWorkflowBySlugInput, type UpsertWorkflowBySlugInputDto, type UpsertWorkflowStepInput, type Variable, VariablesResource, type WaitUntilFinishedOptions, type WatchProgressOptions, type Workflow, type WorkflowApp, WorkflowAppsResource, type WorkflowDefinition, type WorkflowStepDefinition, WorkflowsResource, assertApiKeyAllowedInEnvironment, type components, createBrowserClient, createLocalStorageTokenStore, createMemoryTokenStore, createServerClient, defineAction, defineAgent, defineAiConnection, defineConnection, defineWorkflow, isBrowserEnvironment, isLoginRequires2FA, iterateOffset, iteratePages, type operations, parseSseEvents, parseSseStream, type paths, resolveActionAppId, resolveActionId };
|
|
7489
|
+
export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type Agent, AgentChatClient, AgentChatStream, type AgentDefinition, type AgentToolDefinition, AgentsResource, type AiConnectionDefinition, type ApprovalInboxItem, ApprovalsResource, AuthResource, type AuthTokens, type BulkCreateQueueItemsInput, type BulkCreateQueueItemsResult, type ChangeEntityStateInput, type ChangeEntityStateResult, type ChatMode, type Connection, type ConnectionDefinition, ConnectionsResource, type CreateBrowserClientOptions, type CreateEntityInput, type CreateKnowledgeInput, type CreateProjectInput, type CreateQueueInput, type CreateQueueItemInput, type CreateServerClientOptions, type CreateTaskInput, type CreateVariableInput, type CurrentUser, DEFINE_KINDS, type DefineKind, type DeletedTask, DiscoveryResource, type EligibleApprover, type EnabledFeatures, EntitiesResource, type Entity, type EntityStateHistoryEntry, type EntityStateTransitions, type EntityType, type EntityTypeDefinition, type EntityTypeReadOptions, EntityTypesResource, type ExecuteWorkflowResult, type Execution, type ExecutionPathStep, type ExecutionProgress, type ExecutionProgressPayload, type ExecutionProgressStep, ExecutionProgressStream, type ExecutionStatus, type ExecutionStreamEvent, type ExecutionStreamEventType, ExecutionTimeoutError, ExecutionsResource, type ExportEntitiesInput, type FetchLike, HttpClient, type ImportEntitiesInput, type ImportEntitiesResult, type ImportTemplate, type Knowledge, type KnowledgeDocument, type KnowledgeDocumentGroup, KnowledgeResource, type ListEntitiesOptions, type ListQueryOptions, type ListQueueItemsByObjectOptions, type ListQueueItemsOptions, type LocalStorageTokenStoreOptions, type LoginRequires2FA, type LoginResult, type LoginSuccess, LunnoaApiError, LunnoaClient, type LunnoaClientOptions, type MessageTaskInput, type OffsetPagination, type PagePagination, type PaginatedEntities, type PendingInput, type PendingInputField, type Project, ProjectsResource, type QueryValue, type Queue, type QueueAllowedObjectType, type QueueItem, type QueueItemCreated, type QueueItemErrorEntry, type QueueItemFull, type QueueItemList, type QueueItemObjectSummary, type QueueItemStats, QueueItemsResource, type QueueStats, QueuesResource, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type SseEvent, SsoAuthResource, type SsoProviderSummary, type SsoProvidersResponse, type StartRunInput, type StartRunInputDto, type StartRunOptions, type StartRunStep, type StopStreamOptions, type StreamMessageOptions, type Task, type TaskListItem, TasksResource, type TokenStore, type UpdateEntityInput, type UpdateKnowledgeInput, type UpdateQueueInput, type UpdateQueueItemInput, type UpdateTaskInput, type UpdateVariableInput, type UpsertAgentBySlugInput, type UpsertAgentBySlugInputDto, type UpsertAgentToolInput, type UpsertEntityTypeBySlugInput, type UpsertWorkflowBySlugInput, type UpsertWorkflowBySlugInputDto, type UpsertWorkflowStepInput, type Variable, VariablesResource, type WaitUntilFinishedOptions, type WatchProgressOptions, type Workflow, type WorkflowApp, WorkflowAppsResource, type WorkflowDefinition, type WorkflowStepDefinition, WorkflowsResource, assertApiKeyAllowedInEnvironment, type components, createBrowserClient, createLocalStorageTokenStore, createMemoryTokenStore, createServerClient, defineAction, defineAgent, defineAiConnection, defineConnection, defineEntityType, defineWorkflow, entityTypeDefinitionToUpsert, isBrowserEnvironment, isLoginRequires2FA, iterateOffset, iteratePages, type operations, parseSseEvents, parseSseStream, type paths, resolveActionAppId, resolveActionId };
|