@lunnoa/client 1.4.0 → 1.5.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/README.md +11 -3
- package/dist/cli.js +199 -18
- package/dist/index.cjs +33 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1322 -1059
- package/dist/index.d.ts +1322 -1059
- package/dist/index.js +33 -1
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +52 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +697 -608
- package/dist/react.d.ts +697 -608
- package/dist/react.js +52 -1
- package/dist/react.js.map +1 -1
- package/package.json +2 -6
- package/skills/lunnoa-client/SKILL.md +18 -6
- package/skills/lunnoa-solution-design/SKILL.md +20 -4
package/dist/index.d.cts
CHANGED
|
@@ -785,6 +785,106 @@ interface paths {
|
|
|
785
785
|
patch?: never;
|
|
786
786
|
trace?: never;
|
|
787
787
|
};
|
|
788
|
+
"/api/agents": {
|
|
789
|
+
parameters: {
|
|
790
|
+
query?: never;
|
|
791
|
+
header?: never;
|
|
792
|
+
path?: never;
|
|
793
|
+
cookie?: never;
|
|
794
|
+
};
|
|
795
|
+
/**
|
|
796
|
+
* List agents in current workspace
|
|
797
|
+
* @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.
|
|
798
|
+
*/
|
|
799
|
+
get: operations["AgentsController_findAllForWorkspace"];
|
|
800
|
+
put?: never;
|
|
801
|
+
post?: never;
|
|
802
|
+
delete?: never;
|
|
803
|
+
options?: never;
|
|
804
|
+
head?: never;
|
|
805
|
+
patch?: never;
|
|
806
|
+
trace?: never;
|
|
807
|
+
};
|
|
808
|
+
"/api/agents/{agentId}": {
|
|
809
|
+
parameters: {
|
|
810
|
+
query?: never;
|
|
811
|
+
header?: never;
|
|
812
|
+
path?: never;
|
|
813
|
+
cookie?: never;
|
|
814
|
+
};
|
|
815
|
+
/**
|
|
816
|
+
* Get agent by ID
|
|
817
|
+
* @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.
|
|
818
|
+
*/
|
|
819
|
+
get: operations["AgentsController_findOne"];
|
|
820
|
+
put?: never;
|
|
821
|
+
post?: never;
|
|
822
|
+
delete?: never;
|
|
823
|
+
options?: never;
|
|
824
|
+
head?: never;
|
|
825
|
+
patch?: never;
|
|
826
|
+
trace?: never;
|
|
827
|
+
};
|
|
828
|
+
"/api/projects/{projectId}/agents/upsert": {
|
|
829
|
+
parameters: {
|
|
830
|
+
query?: never;
|
|
831
|
+
header?: never;
|
|
832
|
+
path?: never;
|
|
833
|
+
cookie?: never;
|
|
834
|
+
};
|
|
835
|
+
get?: never;
|
|
836
|
+
put?: never;
|
|
837
|
+
/**
|
|
838
|
+
* Upsert an agent by slug
|
|
839
|
+
* @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.
|
|
840
|
+
*/
|
|
841
|
+
post: operations["ProjectAgentsController_upsertBySlug"];
|
|
842
|
+
delete?: never;
|
|
843
|
+
options?: never;
|
|
844
|
+
head?: never;
|
|
845
|
+
patch?: never;
|
|
846
|
+
trace?: never;
|
|
847
|
+
};
|
|
848
|
+
"/api/workflow-apps": {
|
|
849
|
+
parameters: {
|
|
850
|
+
query?: never;
|
|
851
|
+
header?: never;
|
|
852
|
+
path?: never;
|
|
853
|
+
cookie?: never;
|
|
854
|
+
};
|
|
855
|
+
/**
|
|
856
|
+
* List all workflow apps
|
|
857
|
+
* @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.
|
|
858
|
+
*/
|
|
859
|
+
get: operations["WorkflowAppsController_findAll"];
|
|
860
|
+
put?: never;
|
|
861
|
+
post?: never;
|
|
862
|
+
delete?: never;
|
|
863
|
+
options?: never;
|
|
864
|
+
head?: never;
|
|
865
|
+
patch?: never;
|
|
866
|
+
trace?: never;
|
|
867
|
+
};
|
|
868
|
+
"/api/workflow-apps/{appId}/connections/{connectionId}/connect": {
|
|
869
|
+
parameters: {
|
|
870
|
+
query?: never;
|
|
871
|
+
header?: never;
|
|
872
|
+
path?: never;
|
|
873
|
+
cookie?: never;
|
|
874
|
+
};
|
|
875
|
+
get?: never;
|
|
876
|
+
put?: never;
|
|
877
|
+
/**
|
|
878
|
+
* Connect workflow app
|
|
879
|
+
* @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.
|
|
880
|
+
*/
|
|
881
|
+
post: operations["WorkflowAppsController_connectApp"];
|
|
882
|
+
delete?: never;
|
|
883
|
+
options?: never;
|
|
884
|
+
head?: never;
|
|
885
|
+
patch?: never;
|
|
886
|
+
trace?: never;
|
|
887
|
+
};
|
|
788
888
|
"/api/object-types": {
|
|
789
889
|
parameters: {
|
|
790
890
|
query?: never;
|
|
@@ -794,7 +894,7 @@ interface paths {
|
|
|
794
894
|
};
|
|
795
895
|
/**
|
|
796
896
|
* Get all entity types for workspace
|
|
797
|
-
* @description Returns
|
|
897
|
+
* @description Returns object types granted to the active workspace. Set includeCatalog to also list enabled types the workspace does not have, as name and description only.
|
|
798
898
|
*/
|
|
799
899
|
get: operations["ObjectTypesController_findAll"];
|
|
800
900
|
put?: never;
|
|
@@ -1025,7 +1125,7 @@ interface paths {
|
|
|
1025
1125
|
patch?: never;
|
|
1026
1126
|
trace?: never;
|
|
1027
1127
|
};
|
|
1028
|
-
"/api/
|
|
1128
|
+
"/api/knowledge": {
|
|
1029
1129
|
parameters: {
|
|
1030
1130
|
query?: never;
|
|
1031
1131
|
header?: never;
|
|
@@ -1033,19 +1133,51 @@ interface paths {
|
|
|
1033
1133
|
cookie?: never;
|
|
1034
1134
|
};
|
|
1035
1135
|
/**
|
|
1036
|
-
* List
|
|
1037
|
-
* @description Returns
|
|
1136
|
+
* List knowledge bases in workspace
|
|
1137
|
+
* @description Returns all knowledge bases in the current workspace, ordered by most recently updated.
|
|
1038
1138
|
*/
|
|
1039
|
-
get: operations["
|
|
1139
|
+
get: operations["KnowledgeController_findAllForWorkspace"];
|
|
1040
1140
|
put?: never;
|
|
1041
|
-
|
|
1141
|
+
/**
|
|
1142
|
+
* Create knowledge base
|
|
1143
|
+
* @description Creates a workspace-wide knowledge base with a dedicated vector index. Embedding model, provider and dimensions default to the platform configuration when omitted.
|
|
1144
|
+
*/
|
|
1145
|
+
post: operations["KnowledgeController_create"];
|
|
1042
1146
|
delete?: never;
|
|
1043
1147
|
options?: never;
|
|
1044
1148
|
head?: never;
|
|
1045
1149
|
patch?: never;
|
|
1046
1150
|
trace?: never;
|
|
1047
1151
|
};
|
|
1048
|
-
"/api/
|
|
1152
|
+
"/api/knowledge/{knowledgeId}": {
|
|
1153
|
+
parameters: {
|
|
1154
|
+
query?: never;
|
|
1155
|
+
header?: never;
|
|
1156
|
+
path?: never;
|
|
1157
|
+
cookie?: never;
|
|
1158
|
+
};
|
|
1159
|
+
/**
|
|
1160
|
+
* Get knowledge base by ID
|
|
1161
|
+
* @description Returns a single knowledge base.
|
|
1162
|
+
*/
|
|
1163
|
+
get: operations["KnowledgeController_findOne"];
|
|
1164
|
+
put?: never;
|
|
1165
|
+
post?: never;
|
|
1166
|
+
/**
|
|
1167
|
+
* Delete knowledge base
|
|
1168
|
+
* @description Deletes a knowledge base, its stored files and its vector index. This action cannot be undone.
|
|
1169
|
+
*/
|
|
1170
|
+
delete: operations["KnowledgeController_delete"];
|
|
1171
|
+
options?: never;
|
|
1172
|
+
head?: never;
|
|
1173
|
+
/**
|
|
1174
|
+
* Update knowledge base
|
|
1175
|
+
* @description Updates knowledge base properties. All body fields are optional; only provided fields are changed.
|
|
1176
|
+
*/
|
|
1177
|
+
patch: operations["KnowledgeController_update"];
|
|
1178
|
+
trace?: never;
|
|
1179
|
+
};
|
|
1180
|
+
"/api/knowledge/{knowledgeId}/saveUploadedText": {
|
|
1049
1181
|
parameters: {
|
|
1050
1182
|
query?: never;
|
|
1051
1183
|
header?: never;
|
|
@@ -1055,17 +1187,17 @@ interface paths {
|
|
|
1055
1187
|
get?: never;
|
|
1056
1188
|
put?: never;
|
|
1057
1189
|
/**
|
|
1058
|
-
*
|
|
1059
|
-
* @description
|
|
1190
|
+
* Save uploaded text to knowledge base
|
|
1191
|
+
* @description Chunks the provided text, generates embeddings and stores them in the knowledge base. Multi-chunk uploads are grouped into a single document.
|
|
1060
1192
|
*/
|
|
1061
|
-
post: operations["
|
|
1193
|
+
post: operations["KnowledgeController_saveUploadedTextToKnowledge"];
|
|
1062
1194
|
delete?: never;
|
|
1063
1195
|
options?: never;
|
|
1064
1196
|
head?: never;
|
|
1065
1197
|
patch?: never;
|
|
1066
1198
|
trace?: never;
|
|
1067
1199
|
};
|
|
1068
|
-
"/api/
|
|
1200
|
+
"/api/knowledge/{knowledgeId}/documents": {
|
|
1069
1201
|
parameters: {
|
|
1070
1202
|
query?: never;
|
|
1071
1203
|
header?: never;
|
|
@@ -1073,10 +1205,10 @@ interface paths {
|
|
|
1073
1205
|
cookie?: never;
|
|
1074
1206
|
};
|
|
1075
1207
|
/**
|
|
1076
|
-
* List
|
|
1077
|
-
* @description
|
|
1208
|
+
* List documents for knowledge base
|
|
1209
|
+
* @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.
|
|
1078
1210
|
*/
|
|
1079
|
-
get: operations["
|
|
1211
|
+
get: operations["KnowledgeController_getDocuments"];
|
|
1080
1212
|
put?: never;
|
|
1081
1213
|
post?: never;
|
|
1082
1214
|
delete?: never;
|
|
@@ -1085,7 +1217,7 @@ interface paths {
|
|
|
1085
1217
|
patch?: never;
|
|
1086
1218
|
trace?: never;
|
|
1087
1219
|
};
|
|
1088
|
-
"/api/
|
|
1220
|
+
"/api/knowledge/{knowledgeId}/documents/{groupId}": {
|
|
1089
1221
|
parameters: {
|
|
1090
1222
|
query?: never;
|
|
1091
1223
|
header?: never;
|
|
@@ -1093,19 +1225,23 @@ interface paths {
|
|
|
1093
1225
|
cookie?: never;
|
|
1094
1226
|
};
|
|
1095
1227
|
/**
|
|
1096
|
-
* Get
|
|
1097
|
-
* @description Returns a
|
|
1228
|
+
* Get knowledge document group
|
|
1229
|
+
* @description Returns a document group with all of its parts (vector references), ordered by part number.
|
|
1098
1230
|
*/
|
|
1099
|
-
get: operations["
|
|
1231
|
+
get: operations["KnowledgeController_getDocumentGroup"];
|
|
1100
1232
|
put?: never;
|
|
1101
1233
|
post?: never;
|
|
1102
|
-
|
|
1234
|
+
/**
|
|
1235
|
+
* Delete knowledge document group
|
|
1236
|
+
* @description Deletes a document group and all of its parts, including stored files and vector index entries. This action cannot be undone.
|
|
1237
|
+
*/
|
|
1238
|
+
delete: operations["KnowledgeController_deleteDocumentGroup"];
|
|
1103
1239
|
options?: never;
|
|
1104
1240
|
head?: never;
|
|
1105
1241
|
patch?: never;
|
|
1106
1242
|
trace?: never;
|
|
1107
1243
|
};
|
|
1108
|
-
"/api/
|
|
1244
|
+
"/api/executions/workflows/{workflowId}/execute": {
|
|
1109
1245
|
parameters: {
|
|
1110
1246
|
query?: never;
|
|
1111
1247
|
header?: never;
|
|
@@ -1115,17 +1251,17 @@ interface paths {
|
|
|
1115
1251
|
get?: never;
|
|
1116
1252
|
put?: never;
|
|
1117
1253
|
/**
|
|
1118
|
-
*
|
|
1119
|
-
* @description
|
|
1254
|
+
* Manually execute workflow by ID
|
|
1255
|
+
* @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.
|
|
1120
1256
|
*/
|
|
1121
|
-
post: operations["
|
|
1257
|
+
post: operations["ExecutionsController_manuallyExecuteWorkflow"];
|
|
1122
1258
|
delete?: never;
|
|
1123
1259
|
options?: never;
|
|
1124
1260
|
head?: never;
|
|
1125
1261
|
patch?: never;
|
|
1126
1262
|
trace?: never;
|
|
1127
1263
|
};
|
|
1128
|
-
"/api/
|
|
1264
|
+
"/api/executions": {
|
|
1129
1265
|
parameters: {
|
|
1130
1266
|
query?: never;
|
|
1131
1267
|
header?: never;
|
|
@@ -1133,23 +1269,19 @@ interface paths {
|
|
|
1133
1269
|
cookie?: never;
|
|
1134
1270
|
};
|
|
1135
1271
|
/**
|
|
1136
|
-
* List
|
|
1137
|
-
* @description Returns
|
|
1272
|
+
* List executions in current workspace
|
|
1273
|
+
* @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.
|
|
1138
1274
|
*/
|
|
1139
|
-
get: operations["
|
|
1275
|
+
get: operations["ExecutionsController_findAll"];
|
|
1140
1276
|
put?: never;
|
|
1141
|
-
|
|
1142
|
-
* Create knowledge base
|
|
1143
|
-
* @description Creates a workspace-wide knowledge base with a dedicated vector index. Embedding model, provider and dimensions default to the platform configuration when omitted.
|
|
1144
|
-
*/
|
|
1145
|
-
post: operations["KnowledgeController_create"];
|
|
1277
|
+
post?: never;
|
|
1146
1278
|
delete?: never;
|
|
1147
1279
|
options?: never;
|
|
1148
1280
|
head?: never;
|
|
1149
1281
|
patch?: never;
|
|
1150
1282
|
trace?: never;
|
|
1151
1283
|
};
|
|
1152
|
-
"/api/
|
|
1284
|
+
"/api/executions/{executionId}": {
|
|
1153
1285
|
parameters: {
|
|
1154
1286
|
query?: never;
|
|
1155
1287
|
header?: never;
|
|
@@ -1157,85 +1289,73 @@ interface paths {
|
|
|
1157
1289
|
cookie?: never;
|
|
1158
1290
|
};
|
|
1159
1291
|
/**
|
|
1160
|
-
* Get
|
|
1161
|
-
* @description Returns a single
|
|
1292
|
+
* Get execution by ID
|
|
1293
|
+
* @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.
|
|
1162
1294
|
*/
|
|
1163
|
-
get: operations["
|
|
1295
|
+
get: operations["ExecutionsController_findOne"];
|
|
1164
1296
|
put?: never;
|
|
1165
1297
|
post?: never;
|
|
1166
|
-
|
|
1167
|
-
* Delete knowledge base
|
|
1168
|
-
* @description Deletes a knowledge base, its stored files and its vector index. This action cannot be undone.
|
|
1169
|
-
*/
|
|
1170
|
-
delete: operations["KnowledgeController_delete"];
|
|
1298
|
+
delete?: never;
|
|
1171
1299
|
options?: never;
|
|
1172
1300
|
head?: never;
|
|
1173
|
-
|
|
1174
|
-
* Update knowledge base
|
|
1175
|
-
* @description Updates knowledge base properties. All body fields are optional; only provided fields are changed.
|
|
1176
|
-
*/
|
|
1177
|
-
patch: operations["KnowledgeController_update"];
|
|
1301
|
+
patch?: never;
|
|
1178
1302
|
trace?: never;
|
|
1179
1303
|
};
|
|
1180
|
-
"/api/
|
|
1304
|
+
"/api/executions/{executionId}/stream": {
|
|
1181
1305
|
parameters: {
|
|
1182
1306
|
query?: never;
|
|
1183
1307
|
header?: never;
|
|
1184
1308
|
path?: never;
|
|
1185
1309
|
cookie?: never;
|
|
1186
1310
|
};
|
|
1187
|
-
get?: never;
|
|
1188
|
-
put?: never;
|
|
1189
1311
|
/**
|
|
1190
|
-
*
|
|
1191
|
-
* @description
|
|
1312
|
+
* Stream execution updates (SSE)
|
|
1313
|
+
* @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.
|
|
1192
1314
|
*/
|
|
1193
|
-
|
|
1315
|
+
get: operations["ExecutionsController_streamExecution"];
|
|
1316
|
+
put?: never;
|
|
1317
|
+
post?: never;
|
|
1194
1318
|
delete?: never;
|
|
1195
1319
|
options?: never;
|
|
1196
1320
|
head?: never;
|
|
1197
1321
|
patch?: never;
|
|
1198
1322
|
trace?: never;
|
|
1199
1323
|
};
|
|
1200
|
-
"/api/
|
|
1324
|
+
"/api/actions/run": {
|
|
1201
1325
|
parameters: {
|
|
1202
1326
|
query?: never;
|
|
1203
1327
|
header?: never;
|
|
1204
1328
|
path?: never;
|
|
1205
1329
|
cookie?: never;
|
|
1206
1330
|
};
|
|
1331
|
+
get?: never;
|
|
1332
|
+
put?: never;
|
|
1207
1333
|
/**
|
|
1208
|
-
*
|
|
1209
|
-
* @description
|
|
1334
|
+
* Run a single app action as an ad-hoc Execution
|
|
1335
|
+
* @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.
|
|
1210
1336
|
*/
|
|
1211
|
-
|
|
1212
|
-
put?: never;
|
|
1213
|
-
post?: never;
|
|
1337
|
+
post: operations["ActionsController_run"];
|
|
1214
1338
|
delete?: never;
|
|
1215
1339
|
options?: never;
|
|
1216
1340
|
head?: never;
|
|
1217
1341
|
patch?: never;
|
|
1218
1342
|
trace?: never;
|
|
1219
1343
|
};
|
|
1220
|
-
"/api/
|
|
1344
|
+
"/api/runs": {
|
|
1221
1345
|
parameters: {
|
|
1222
1346
|
query?: never;
|
|
1223
1347
|
header?: never;
|
|
1224
1348
|
path?: never;
|
|
1225
1349
|
cookie?: never;
|
|
1226
1350
|
};
|
|
1227
|
-
|
|
1228
|
-
* Get knowledge document group
|
|
1229
|
-
* @description Returns a document group with all of its parts (vector references), ordered by part number.
|
|
1230
|
-
*/
|
|
1231
|
-
get: operations["KnowledgeController_getDocumentGroup"];
|
|
1351
|
+
get?: never;
|
|
1232
1352
|
put?: never;
|
|
1233
|
-
post?: never;
|
|
1234
1353
|
/**
|
|
1235
|
-
*
|
|
1236
|
-
* @description
|
|
1354
|
+
* Start a multi-step ad-hoc Execution
|
|
1355
|
+
* @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.
|
|
1237
1356
|
*/
|
|
1238
|
-
|
|
1357
|
+
post: operations["RunsController_start"];
|
|
1358
|
+
delete?: never;
|
|
1239
1359
|
options?: never;
|
|
1240
1360
|
head?: never;
|
|
1241
1361
|
patch?: never;
|
|
@@ -1293,7 +1413,7 @@ interface paths {
|
|
|
1293
1413
|
patch: operations["VariablesController_update"];
|
|
1294
1414
|
trace?: never;
|
|
1295
1415
|
};
|
|
1296
|
-
"/api/
|
|
1416
|
+
"/api/tables": {
|
|
1297
1417
|
parameters: {
|
|
1298
1418
|
query?: never;
|
|
1299
1419
|
header?: never;
|
|
@@ -1301,30 +1421,10 @@ interface paths {
|
|
|
1301
1421
|
cookie?: never;
|
|
1302
1422
|
};
|
|
1303
1423
|
/**
|
|
1304
|
-
* List
|
|
1305
|
-
* @description
|
|
1306
|
-
*/
|
|
1307
|
-
get: operations["ConnectionsController_findAllForWorkspace"];
|
|
1308
|
-
put?: never;
|
|
1309
|
-
post?: never;
|
|
1310
|
-
delete?: never;
|
|
1311
|
-
options?: never;
|
|
1312
|
-
head?: never;
|
|
1313
|
-
patch?: never;
|
|
1314
|
-
trace?: never;
|
|
1315
|
-
};
|
|
1316
|
-
"/api/connections/{connectionId}": {
|
|
1317
|
-
parameters: {
|
|
1318
|
-
query?: never;
|
|
1319
|
-
header?: never;
|
|
1320
|
-
path?: never;
|
|
1321
|
-
cookie?: never;
|
|
1322
|
-
};
|
|
1323
|
-
/**
|
|
1324
|
-
* Get connection by ID
|
|
1325
|
-
* @description Returns a single connection. Credential values are never returned.
|
|
1424
|
+
* List tables
|
|
1425
|
+
* @description Lists tables in the current workspace, without rows.
|
|
1326
1426
|
*/
|
|
1327
|
-
get: operations["
|
|
1427
|
+
get: operations["TablesController_findAll"];
|
|
1328
1428
|
put?: never;
|
|
1329
1429
|
post?: never;
|
|
1330
1430
|
delete?: never;
|
|
@@ -1333,7 +1433,7 @@ interface paths {
|
|
|
1333
1433
|
patch?: never;
|
|
1334
1434
|
trace?: never;
|
|
1335
1435
|
};
|
|
1336
|
-
"/api/
|
|
1436
|
+
"/api/tables/upsert": {
|
|
1337
1437
|
parameters: {
|
|
1338
1438
|
query?: never;
|
|
1339
1439
|
header?: never;
|
|
@@ -1343,17 +1443,17 @@ interface paths {
|
|
|
1343
1443
|
get?: never;
|
|
1344
1444
|
put?: never;
|
|
1345
1445
|
/**
|
|
1346
|
-
*
|
|
1347
|
-
* @description
|
|
1446
|
+
* Upsert table by slug
|
|
1447
|
+
* @description Creates or updates the table with this workspace `slug`. Omitted columns or rows keep their current value. Marks `managedByCode` by default.
|
|
1348
1448
|
*/
|
|
1349
|
-
post: operations["
|
|
1449
|
+
post: operations["TablesController_upsertBySlug"];
|
|
1350
1450
|
delete?: never;
|
|
1351
1451
|
options?: never;
|
|
1352
1452
|
head?: never;
|
|
1353
1453
|
patch?: never;
|
|
1354
1454
|
trace?: never;
|
|
1355
1455
|
};
|
|
1356
|
-
"/api/
|
|
1456
|
+
"/api/tables/slug/{slug}": {
|
|
1357
1457
|
parameters: {
|
|
1358
1458
|
query?: never;
|
|
1359
1459
|
header?: never;
|
|
@@ -1361,10 +1461,10 @@ interface paths {
|
|
|
1361
1461
|
cookie?: never;
|
|
1362
1462
|
};
|
|
1363
1463
|
/**
|
|
1364
|
-
*
|
|
1365
|
-
* @description Returns
|
|
1464
|
+
* Get table by slug
|
|
1465
|
+
* @description Returns a table, including columns and rows.
|
|
1366
1466
|
*/
|
|
1367
|
-
get: operations["
|
|
1467
|
+
get: operations["TablesController_findBySlug"];
|
|
1368
1468
|
put?: never;
|
|
1369
1469
|
post?: never;
|
|
1370
1470
|
delete?: never;
|
|
@@ -1373,7 +1473,7 @@ interface paths {
|
|
|
1373
1473
|
patch?: never;
|
|
1374
1474
|
trace?: never;
|
|
1375
1475
|
};
|
|
1376
|
-
"/api/
|
|
1476
|
+
"/api/tables/{tableId}": {
|
|
1377
1477
|
parameters: {
|
|
1378
1478
|
query?: never;
|
|
1379
1479
|
header?: never;
|
|
@@ -1381,10 +1481,10 @@ interface paths {
|
|
|
1381
1481
|
cookie?: never;
|
|
1382
1482
|
};
|
|
1383
1483
|
/**
|
|
1384
|
-
* Get
|
|
1385
|
-
* @description Returns a
|
|
1484
|
+
* Get table
|
|
1485
|
+
* @description Returns a table, including columns and rows.
|
|
1386
1486
|
*/
|
|
1387
|
-
get: operations["
|
|
1487
|
+
get: operations["TablesController_findOne"];
|
|
1388
1488
|
put?: never;
|
|
1389
1489
|
post?: never;
|
|
1390
1490
|
delete?: never;
|
|
@@ -1393,7 +1493,7 @@ interface paths {
|
|
|
1393
1493
|
patch?: never;
|
|
1394
1494
|
trace?: never;
|
|
1395
1495
|
};
|
|
1396
|
-
"/api/
|
|
1496
|
+
"/api/connections": {
|
|
1397
1497
|
parameters: {
|
|
1398
1498
|
query?: never;
|
|
1399
1499
|
header?: never;
|
|
@@ -1401,10 +1501,10 @@ interface paths {
|
|
|
1401
1501
|
cookie?: never;
|
|
1402
1502
|
};
|
|
1403
1503
|
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @description
|
|
1504
|
+
* List connections in current workspace
|
|
1505
|
+
* @description Returns all connections available to the current user: OAuth connections belonging to the workspace and managed connections assigned to the user. Credential values are never returned.
|
|
1406
1506
|
*/
|
|
1407
|
-
get: operations["
|
|
1507
|
+
get: operations["ConnectionsController_findAllForWorkspace"];
|
|
1408
1508
|
put?: never;
|
|
1409
1509
|
post?: never;
|
|
1410
1510
|
delete?: never;
|
|
@@ -1413,40 +1513,20 @@ interface paths {
|
|
|
1413
1513
|
patch?: never;
|
|
1414
1514
|
trace?: never;
|
|
1415
1515
|
};
|
|
1416
|
-
"/api/
|
|
1516
|
+
"/api/connections/{connectionId}": {
|
|
1417
1517
|
parameters: {
|
|
1418
1518
|
query?: never;
|
|
1419
1519
|
header?: never;
|
|
1420
1520
|
path?: never;
|
|
1421
1521
|
cookie?: never;
|
|
1422
1522
|
};
|
|
1423
|
-
get?: never;
|
|
1424
|
-
put?: never;
|
|
1425
1523
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @description
|
|
1524
|
+
* Get connection by ID
|
|
1525
|
+
* @description Returns a single connection. Credential values are never returned.
|
|
1428
1526
|
*/
|
|
1429
|
-
|
|
1430
|
-
delete?: never;
|
|
1431
|
-
options?: never;
|
|
1432
|
-
head?: never;
|
|
1433
|
-
patch?: never;
|
|
1434
|
-
trace?: never;
|
|
1435
|
-
};
|
|
1436
|
-
"/api/runs": {
|
|
1437
|
-
parameters: {
|
|
1438
|
-
query?: never;
|
|
1439
|
-
header?: never;
|
|
1440
|
-
path?: never;
|
|
1441
|
-
cookie?: never;
|
|
1442
|
-
};
|
|
1443
|
-
get?: never;
|
|
1527
|
+
get: operations["ConnectionsController_findOne"];
|
|
1444
1528
|
put?: never;
|
|
1445
|
-
|
|
1446
|
-
* Start a multi-step ad-hoc Execution
|
|
1447
|
-
* @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.
|
|
1448
|
-
*/
|
|
1449
|
-
post: operations["RunsController_start"];
|
|
1529
|
+
post?: never;
|
|
1450
1530
|
delete?: never;
|
|
1451
1531
|
options?: never;
|
|
1452
1532
|
head?: never;
|
|
@@ -2289,7 +2369,9 @@ interface components {
|
|
|
2289
2369
|
/** @description Error message to record against the queue item. */
|
|
2290
2370
|
error: string;
|
|
2291
2371
|
/** @description Additional structured error details, supplied as a JSON string. */
|
|
2292
|
-
errorDetails?:
|
|
2372
|
+
errorDetails?: {
|
|
2373
|
+
[key: string]: unknown;
|
|
2374
|
+
};
|
|
2293
2375
|
};
|
|
2294
2376
|
BulkDeleteItemsDto: {
|
|
2295
2377
|
/** @description IDs of the queue items to delete. */
|
|
@@ -2338,6 +2420,14 @@ interface components {
|
|
|
2338
2420
|
isActive?: boolean;
|
|
2339
2421
|
/** @description Whether the workflow is internal (hidden from default listings). Included when `expansion=isInternal` is requested. */
|
|
2340
2422
|
isInternal?: boolean;
|
|
2423
|
+
/** @description Object type whose records list this workflow's runs. Included when `expansion=objectLink` is requested. */
|
|
2424
|
+
objectTypeId?: string | null;
|
|
2425
|
+
/** @description Dot path on the trigger payload. A Lunnoa id when the type has no unique key, otherwise that key's value. Included when `expansion=objectLink` is requested. */
|
|
2426
|
+
objectIdPath?: string | null;
|
|
2427
|
+
/** @description Create a record when the unique key value is not found, then file the run on it. Included when `expansion=objectLink` is requested. */
|
|
2428
|
+
createObjectIfMissing?: boolean;
|
|
2429
|
+
/** @description Unique key on the linked object type (`name` or `attribute:<field>`). Included when `expansion=objectLink` is requested. */
|
|
2430
|
+
uniqueKeyField?: string | null;
|
|
2341
2431
|
/** @description Workflow node definitions (JSON). Included when `expansion=nodes` is requested. */
|
|
2342
2432
|
nodes?: {
|
|
2343
2433
|
[key: string]: unknown;
|
|
@@ -2407,422 +2497,46 @@ interface components {
|
|
|
2407
2497
|
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
2408
2498
|
managedByCode?: boolean;
|
|
2409
2499
|
};
|
|
2410
|
-
|
|
2411
|
-
/** @description Stable deployment-wide slug (lowercase, digits, hyphens). Used as the upsert key. Granted to the caller workspace when new. */
|
|
2412
|
-
slug: string;
|
|
2413
|
-
/** @description Singular display name. */
|
|
2414
|
-
name?: string;
|
|
2415
|
-
/** @description Plural display name. */
|
|
2416
|
-
namePlural?: string;
|
|
2417
|
-
/** @description Description. */
|
|
2418
|
-
description?: string;
|
|
2419
|
-
/**
|
|
2420
|
-
* @description Icon identifier.
|
|
2421
|
-
* @default box
|
|
2422
|
-
*/
|
|
2423
|
-
icon: string;
|
|
2424
|
-
/**
|
|
2425
|
-
* @description Hex colour.
|
|
2426
|
-
* @default #3B82F6
|
|
2427
|
-
*/
|
|
2428
|
-
color: string;
|
|
2429
|
-
/** @description Field definitions grouped into sections. */
|
|
2430
|
-
attributeSchema: {
|
|
2431
|
-
[key: string]: unknown;
|
|
2432
|
-
};
|
|
2433
|
-
/** @description Optional state machine definition. */
|
|
2434
|
-
stateSchema?: {
|
|
2435
|
-
[key: string]: unknown;
|
|
2436
|
-
} | null;
|
|
2437
|
-
/** @description Whether the type is enabled. */
|
|
2438
|
-
isEnabled?: boolean;
|
|
2500
|
+
AgentResponseDto: {
|
|
2439
2501
|
/**
|
|
2440
|
-
* @description
|
|
2441
|
-
* @
|
|
2502
|
+
* @description Agent ID (UUID)
|
|
2503
|
+
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
2442
2504
|
*/
|
|
2443
|
-
|
|
2505
|
+
id: string;
|
|
2444
2506
|
/**
|
|
2445
|
-
* @description
|
|
2446
|
-
* @
|
|
2507
|
+
* @description Agent name
|
|
2508
|
+
* @example Invoice Triage Agent
|
|
2447
2509
|
*/
|
|
2448
|
-
managedByCode: boolean;
|
|
2449
|
-
};
|
|
2450
|
-
ObjectTypeUserSummaryDto: {
|
|
2451
|
-
/** @description User ID. */
|
|
2452
|
-
id: string;
|
|
2453
|
-
/** @description Email address of the user. */
|
|
2454
|
-
email: string;
|
|
2455
|
-
/** @description Display name of the user. */
|
|
2456
|
-
name: string;
|
|
2457
|
-
};
|
|
2458
|
-
ObjectTypeCreatedByDto: {
|
|
2459
|
-
/** @description Workspace user ID. */
|
|
2460
|
-
id: string;
|
|
2461
|
-
user: components["schemas"]["ObjectTypeUserSummaryDto"];
|
|
2462
|
-
};
|
|
2463
|
-
ObjectTypeCountDto: {
|
|
2464
|
-
/** @description Number of non-deleted entities of this type. */
|
|
2465
|
-
objects: number;
|
|
2466
|
-
};
|
|
2467
|
-
ObjectTypeResponseDto: {
|
|
2468
|
-
/** @description Entity type ID. */
|
|
2469
|
-
id: string;
|
|
2470
|
-
/** @description Singular display name of the entity type. */
|
|
2471
2510
|
name: string;
|
|
2472
|
-
/** @description
|
|
2473
|
-
|
|
2474
|
-
/** @description
|
|
2475
|
-
|
|
2476
|
-
/** @description
|
|
2477
|
-
|
|
2478
|
-
/** @description
|
|
2479
|
-
color: string;
|
|
2480
|
-
/** @description Whether the entity type is enabled. */
|
|
2481
|
-
isEnabled: boolean;
|
|
2482
|
-
/** @description When false, entity create/update rejects attribute keys not declared on the type. Reserved key `extensions` is always allowed. */
|
|
2483
|
-
allowUnknownAttributes: boolean;
|
|
2484
|
-
/** @description True when last written by code (CLI / SDK upsert). */
|
|
2485
|
-
managedByCode: boolean;
|
|
2486
|
-
/** @description Incremented when attributeSchema, stateSchema, or allowUnknownAttributes changes. */
|
|
2487
|
-
schemaRevision: number;
|
|
2488
|
-
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
2511
|
+
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
2512
|
+
slug?: string | null;
|
|
2513
|
+
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
2514
|
+
managedByCode?: boolean;
|
|
2515
|
+
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
2516
|
+
FK_aiConnectionId: string | null;
|
|
2517
|
+
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
2489
2518
|
description?: string | null;
|
|
2490
|
-
/** @description
|
|
2491
|
-
|
|
2492
|
-
[key: string]: unknown;
|
|
2493
|
-
};
|
|
2494
|
-
/** @description State machine definition. Included when `expansion=stateSchema` is requested. */
|
|
2495
|
-
stateSchema?: {
|
|
2496
|
-
[key: string]: unknown;
|
|
2497
|
-
} | null;
|
|
2519
|
+
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
2520
|
+
profileImageUrl?: string | null;
|
|
2498
2521
|
/**
|
|
2499
2522
|
* Format: date-time
|
|
2500
|
-
* @description Included when `expansion=createdAt` is requested.
|
|
2523
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
2501
2524
|
*/
|
|
2502
2525
|
createdAt?: string;
|
|
2503
2526
|
/**
|
|
2504
2527
|
* Format: date-time
|
|
2505
|
-
* @description Included when `expansion=updatedAt` is requested.
|
|
2528
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2506
2529
|
*/
|
|
2507
2530
|
updatedAt?: string;
|
|
2508
|
-
/** @description
|
|
2509
|
-
|
|
2510
|
-
/** @description Included when `expansion=countObjects` is requested. */
|
|
2511
|
-
_count?: components["schemas"]["ObjectTypeCountDto"];
|
|
2512
|
-
};
|
|
2513
|
-
CreateObjectDto: {
|
|
2514
|
-
/** @description Display name of the entity. */
|
|
2515
|
-
name: string;
|
|
2531
|
+
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
2532
|
+
instructions?: string | null;
|
|
2516
2533
|
/**
|
|
2517
|
-
*
|
|
2518
|
-
* @
|
|
2534
|
+
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
2535
|
+
* @example 1
|
|
2519
2536
|
*/
|
|
2520
|
-
|
|
2521
|
-
/** @description
|
|
2522
|
-
|
|
2523
|
-
/** @description Dynamic attribute values keyed by field ID. */
|
|
2524
|
-
attributes?: {
|
|
2525
|
-
[key: string]: unknown;
|
|
2526
|
-
};
|
|
2527
|
-
};
|
|
2528
|
-
ObjectTypeSummaryDto: {
|
|
2529
|
-
/** @description Entity type ID. */
|
|
2530
|
-
id: string;
|
|
2531
|
-
/** @description Singular display name of the entity type. */
|
|
2532
|
-
name: string;
|
|
2533
|
-
/** @description URL-safe slug of the entity type. */
|
|
2534
|
-
slug: string;
|
|
2535
|
-
/** @description Icon identifier for the entity type. */
|
|
2536
|
-
icon: string;
|
|
2537
|
-
/** @description Hex colour of the entity type. */
|
|
2538
|
-
color: string;
|
|
2539
|
-
/** @description Plural display name. Included when `expansion=objectType` is requested. */
|
|
2540
|
-
namePlural?: string;
|
|
2541
|
-
/** @description Field definitions grouped into sections. Included when `expansion=objectType` is requested on single-entity reads. */
|
|
2542
|
-
attributeSchema?: {
|
|
2543
|
-
[key: string]: unknown;
|
|
2544
|
-
};
|
|
2545
|
-
/** @description State machine definition. Included when `expansion=objectType` is requested. */
|
|
2546
|
-
stateSchema?: {
|
|
2547
|
-
[key: string]: unknown;
|
|
2548
|
-
} | null;
|
|
2549
|
-
};
|
|
2550
|
-
ObjectUserSummaryDto: {
|
|
2551
|
-
/** @description User ID. */
|
|
2552
|
-
id: string;
|
|
2553
|
-
/** @description Email address of the user. */
|
|
2554
|
-
email: string;
|
|
2555
|
-
/** @description Display name of the user. */
|
|
2556
|
-
name: string;
|
|
2557
|
-
};
|
|
2558
|
-
ObjectWorkspaceUserSummaryDto: {
|
|
2559
|
-
/** @description Workspace user ID. */
|
|
2560
|
-
id: string;
|
|
2561
|
-
user: components["schemas"]["ObjectUserSummaryDto"];
|
|
2562
|
-
};
|
|
2563
|
-
ObjectStateHistoryUserSummaryDto: {
|
|
2564
|
-
/** @description User ID. */
|
|
2565
|
-
id: string;
|
|
2566
|
-
/** @description Display name of the user. */
|
|
2567
|
-
name: string;
|
|
2568
|
-
};
|
|
2569
|
-
ObjectStateHistoryChangedByDto: {
|
|
2570
|
-
/** @description Workspace user ID. */
|
|
2571
|
-
id: string;
|
|
2572
|
-
user: components["schemas"]["ObjectStateHistoryUserSummaryDto"];
|
|
2573
|
-
};
|
|
2574
|
-
ObjectStateHistoryItemDto: {
|
|
2575
|
-
/** @description State history entry ID. */
|
|
2576
|
-
id: string;
|
|
2577
|
-
/** @description State the entity moved from. Null for the initial state. */
|
|
2578
|
-
fromState: string | null;
|
|
2579
|
-
/** @description State the entity moved to. */
|
|
2580
|
-
toState: string;
|
|
2581
|
-
/** @description Reason recorded for the state change, if any. */
|
|
2582
|
-
reason: string | null;
|
|
2583
|
-
/**
|
|
2584
|
-
* Format: date-time
|
|
2585
|
-
* @description When the state change occurred.
|
|
2586
|
-
*/
|
|
2587
|
-
createdAt: string;
|
|
2588
|
-
/** @description Workspace member who made the change, if recorded. */
|
|
2589
|
-
changedBy: components["schemas"]["ObjectStateHistoryChangedByDto"] | null;
|
|
2590
|
-
};
|
|
2591
|
-
ObjectResponseDto: {
|
|
2592
|
-
/** @description Entity ID. */
|
|
2593
|
-
id: string;
|
|
2594
|
-
/** @description Display name of the entity. */
|
|
2595
|
-
name: string;
|
|
2596
|
-
/** @description Current state of the entity, if the type defines states. */
|
|
2597
|
-
state: string | null;
|
|
2598
|
-
/** @description Dynamic attribute values keyed by field ID. */
|
|
2599
|
-
attributes: {
|
|
2600
|
-
[key: string]: unknown;
|
|
2601
|
-
};
|
|
2602
|
-
/**
|
|
2603
|
-
* Format: date-time
|
|
2604
|
-
* @description Included when `expansion=createdAt` is requested.
|
|
2605
|
-
*/
|
|
2606
|
-
createdAt?: string;
|
|
2607
|
-
/**
|
|
2608
|
-
* Format: date-time
|
|
2609
|
-
* @description Included by default on list responses, otherwise when `expansion=updatedAt` is requested.
|
|
2610
|
-
*/
|
|
2611
|
-
updatedAt?: string;
|
|
2612
|
-
/** @description Included by default on list responses with a minimal shape, otherwise when `expansion=objectType` is requested. */
|
|
2613
|
-
objectType?: components["schemas"]["ObjectTypeSummaryDto"];
|
|
2614
|
-
/** @description Included when `expansion=owner` is requested. */
|
|
2615
|
-
owner?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
2616
|
-
/** @description Included when `expansion=createdBy` is requested. */
|
|
2617
|
-
createdBy?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
2618
|
-
/** @description Most recent state changes (up to 50, newest first). Included when `expansion=stateHistory` is requested. */
|
|
2619
|
-
stateHistory?: components["schemas"]["ObjectStateHistoryItemDto"][];
|
|
2620
|
-
};
|
|
2621
|
-
ObjectPaginationDto: {
|
|
2622
|
-
/** @description Current page number (1-based). */
|
|
2623
|
-
page: number;
|
|
2624
|
-
/** @description Number of items per page (maximum 100). */
|
|
2625
|
-
pageSize: number;
|
|
2626
|
-
/** @description Total number of matching entities. */
|
|
2627
|
-
totalCount: number;
|
|
2628
|
-
/** @description Total number of pages. */
|
|
2629
|
-
totalPages: number;
|
|
2630
|
-
};
|
|
2631
|
-
PaginatedObjectsResponseDto: {
|
|
2632
|
-
data: components["schemas"]["ObjectResponseDto"][];
|
|
2633
|
-
pagination: components["schemas"]["ObjectPaginationDto"];
|
|
2634
|
-
};
|
|
2635
|
-
UpdateObjectDto: {
|
|
2636
|
-
/** @description New display name of the entity. */
|
|
2637
|
-
name?: string;
|
|
2638
|
-
/** @description Attribute values keyed by field ID. Merged into the existing attributes; fields not supplied are left unchanged. */
|
|
2639
|
-
attributes?: {
|
|
2640
|
-
[key: string]: unknown;
|
|
2641
|
-
};
|
|
2642
|
-
};
|
|
2643
|
-
ChangeObjectStateDto: {
|
|
2644
|
-
/** @description ID of the target state. Must be a valid transition from the current state when the entity type defines transitions. */
|
|
2645
|
-
newState: string;
|
|
2646
|
-
/** @description Reason for the state change. Required when the transition is configured with requiresReason. */
|
|
2647
|
-
reason?: string;
|
|
2648
|
-
};
|
|
2649
|
-
ChangeObjectStateResponseDto: {
|
|
2650
|
-
/** @description Entity ID. */
|
|
2651
|
-
id: string;
|
|
2652
|
-
/** @description Display name of the entity. */
|
|
2653
|
-
name: string;
|
|
2654
|
-
/** @description State of the entity after the change. */
|
|
2655
|
-
state: string | null;
|
|
2656
|
-
/**
|
|
2657
|
-
* Format: date-time
|
|
2658
|
-
* @description When the entity was last updated.
|
|
2659
|
-
*/
|
|
2660
|
-
updatedAt: string;
|
|
2661
|
-
};
|
|
2662
|
-
StateHistoryUserSummaryDto: {
|
|
2663
|
-
/** @description User ID. */
|
|
2664
|
-
id: string;
|
|
2665
|
-
/** @description Display name of the user. */
|
|
2666
|
-
name: string;
|
|
2667
|
-
/** @description Email address of the user. */
|
|
2668
|
-
email: string;
|
|
2669
|
-
};
|
|
2670
|
-
StateHistoryChangedByDto: {
|
|
2671
|
-
/** @description Workspace user ID. */
|
|
2672
|
-
id: string;
|
|
2673
|
-
user: components["schemas"]["StateHistoryUserSummaryDto"];
|
|
2674
|
-
};
|
|
2675
|
-
ObjectStateHistoryEntryResponseDto: {
|
|
2676
|
-
/** @description State history entry ID. */
|
|
2677
|
-
id: string;
|
|
2678
|
-
/** @description State the entity moved from. Null for the initial state. */
|
|
2679
|
-
fromState: string | null;
|
|
2680
|
-
/** @description State the entity moved to. */
|
|
2681
|
-
toState: string;
|
|
2682
|
-
/** @description Reason recorded for the state change, if any. */
|
|
2683
|
-
reason: string | null;
|
|
2684
|
-
/**
|
|
2685
|
-
* Format: date-time
|
|
2686
|
-
* @description When the state change occurred.
|
|
2687
|
-
*/
|
|
2688
|
-
createdAt: string;
|
|
2689
|
-
/** @description Workspace member who made the change, if recorded. */
|
|
2690
|
-
changedBy: components["schemas"]["StateHistoryChangedByDto"] | null;
|
|
2691
|
-
};
|
|
2692
|
-
ObjectStateInfoDto: {
|
|
2693
|
-
/** @description State ID. */
|
|
2694
|
-
id: string;
|
|
2695
|
-
/** @description Display name of the state. */
|
|
2696
|
-
name: string;
|
|
2697
|
-
/** @description Colour associated with the state. */
|
|
2698
|
-
color?: string;
|
|
2699
|
-
/** @description Icon associated with the state. */
|
|
2700
|
-
icon?: string;
|
|
2701
|
-
/** @description Whether the state is a final state. */
|
|
2702
|
-
isFinal: boolean;
|
|
2703
|
-
};
|
|
2704
|
-
ObjectStateTransitionDto: {
|
|
2705
|
-
/** @description Transition ID from the state schema. */
|
|
2706
|
-
transitionId: string;
|
|
2707
|
-
/** @description ID of the target state. */
|
|
2708
|
-
toStateId: string;
|
|
2709
|
-
/** @description Display name of the target state. */
|
|
2710
|
-
toStateName: string;
|
|
2711
|
-
/** @description Colour of the target state. */
|
|
2712
|
-
toStateColor?: string;
|
|
2713
|
-
/** @description Icon of the target state. */
|
|
2714
|
-
toStateIcon?: string;
|
|
2715
|
-
/** @description Whether a reason must be supplied for this transition. */
|
|
2716
|
-
requiresReason: boolean;
|
|
2717
|
-
/** @description Confirmation message to show before applying the transition. */
|
|
2718
|
-
confirmationMessage?: string;
|
|
2719
|
-
};
|
|
2720
|
-
ObjectStateTransitionsResponseDto: {
|
|
2721
|
-
/** @description Current state of the entity. Null when the entity has no state or the type defines no state schema. */
|
|
2722
|
-
currentState: components["schemas"]["ObjectStateInfoDto"] | null;
|
|
2723
|
-
/** @description Transitions allowed from the current state. */
|
|
2724
|
-
validTransitions: components["schemas"]["ObjectStateTransitionDto"][];
|
|
2725
|
-
/** @description All states defined by the entity type, for cases where no transitions are defined. */
|
|
2726
|
-
allStates: components["schemas"]["ObjectStateInfoDto"][];
|
|
2727
|
-
};
|
|
2728
|
-
ImportRowErrorDto: {
|
|
2729
|
-
/** @description Row number the error relates to (1-based). */
|
|
2730
|
-
row: number;
|
|
2731
|
-
/** @description Field ID the error relates to, when applicable. */
|
|
2732
|
-
field?: string;
|
|
2733
|
-
/** @description Human-readable error message. */
|
|
2734
|
-
message: string;
|
|
2735
|
-
};
|
|
2736
|
-
ImportEntitiesResponseDto: {
|
|
2737
|
-
/** @description Total number of rows processed. */
|
|
2738
|
-
totalRows: number;
|
|
2739
|
-
/** @description Number of rows imported successfully. */
|
|
2740
|
-
successCount: number;
|
|
2741
|
-
/** @description Number of rows that failed to import. */
|
|
2742
|
-
errorCount: number;
|
|
2743
|
-
/** @description Per-row errors encountered during the import. */
|
|
2744
|
-
errors: components["schemas"]["ImportRowErrorDto"][];
|
|
2745
|
-
/** @description IDs of entities created by the import. */
|
|
2746
|
-
createdIds: string[];
|
|
2747
|
-
/** @description IDs of existing entities updated by the import. */
|
|
2748
|
-
updatedIds: string[];
|
|
2749
|
-
};
|
|
2750
|
-
ImportTemplateResponseDto: {
|
|
2751
|
-
/** @description Column headers for the import file. Always starts with "name". */
|
|
2752
|
-
columns: string[];
|
|
2753
|
-
/** @description Sample row with an example value for each column. */
|
|
2754
|
-
sampleRow: {
|
|
2755
|
-
[key: string]: string;
|
|
2756
|
-
};
|
|
2757
|
-
};
|
|
2758
|
-
WorkflowAppResponseDto: {
|
|
2759
|
-
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
2760
|
-
id: string;
|
|
2761
|
-
/** @description Human-readable app name. */
|
|
2762
|
-
name: string;
|
|
2763
|
-
/** @description App description. */
|
|
2764
|
-
description: string;
|
|
2765
|
-
/** @description URL of the app logo. */
|
|
2766
|
-
logoUrl: string;
|
|
2767
|
-
/** @description Whether the app is published and available for use. */
|
|
2768
|
-
isPublished: boolean;
|
|
2769
|
-
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
2770
|
-
needsConnection: boolean;
|
|
2771
|
-
/** @description Whether the app can be used by agents. */
|
|
2772
|
-
availableForAgent: boolean;
|
|
2773
|
-
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
2774
|
-
actions: {
|
|
2775
|
-
[key: string]: unknown;
|
|
2776
|
-
}[];
|
|
2777
|
-
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
2778
|
-
triggers: {
|
|
2779
|
-
[key: string]: unknown;
|
|
2780
|
-
}[];
|
|
2781
|
-
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
2782
|
-
connections: {
|
|
2783
|
-
[key: string]: unknown;
|
|
2784
|
-
}[];
|
|
2785
|
-
};
|
|
2786
|
-
AgentResponseDto: {
|
|
2787
|
-
/**
|
|
2788
|
-
* @description Agent ID (UUID)
|
|
2789
|
-
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
2790
|
-
*/
|
|
2791
|
-
id: string;
|
|
2792
|
-
/**
|
|
2793
|
-
* @description Agent name
|
|
2794
|
-
* @example Invoice Triage Agent
|
|
2795
|
-
*/
|
|
2796
|
-
name: string;
|
|
2797
|
-
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
2798
|
-
slug?: string | null;
|
|
2799
|
-
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
2800
|
-
managedByCode?: boolean;
|
|
2801
|
-
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
2802
|
-
FK_aiConnectionId: string | null;
|
|
2803
|
-
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
2804
|
-
description?: string | null;
|
|
2805
|
-
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
2806
|
-
profileImageUrl?: string | null;
|
|
2807
|
-
/**
|
|
2808
|
-
* Format: date-time
|
|
2809
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
2810
|
-
*/
|
|
2811
|
-
createdAt?: string;
|
|
2812
|
-
/**
|
|
2813
|
-
* Format: date-time
|
|
2814
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2815
|
-
*/
|
|
2816
|
-
updatedAt?: string;
|
|
2817
|
-
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
2818
|
-
instructions?: string | null;
|
|
2819
|
-
/**
|
|
2820
|
-
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
2821
|
-
* @example 1
|
|
2822
|
-
*/
|
|
2823
|
-
temperature?: number;
|
|
2824
|
-
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
2825
|
-
maxOutputTokens?: number | null;
|
|
2537
|
+
temperature?: number;
|
|
2538
|
+
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
2539
|
+
maxOutputTokens?: number | null;
|
|
2826
2540
|
/**
|
|
2827
2541
|
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
2828
2542
|
* @example 1
|
|
@@ -3083,19 +2797,400 @@ interface components {
|
|
|
3083
2797
|
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
3084
2798
|
managedByCode?: boolean;
|
|
3085
2799
|
};
|
|
3086
|
-
|
|
3087
|
-
/** @description
|
|
2800
|
+
WorkflowAppResponseDto: {
|
|
2801
|
+
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
2802
|
+
id: string;
|
|
2803
|
+
/** @description Human-readable app name. */
|
|
3088
2804
|
name: string;
|
|
3089
|
-
/** @description
|
|
3090
|
-
description
|
|
3091
|
-
/** @description
|
|
3092
|
-
|
|
3093
|
-
/** @description
|
|
3094
|
-
|
|
3095
|
-
/** @description
|
|
3096
|
-
|
|
3097
|
-
/** @description
|
|
3098
|
-
|
|
2805
|
+
/** @description App description. */
|
|
2806
|
+
description: string;
|
|
2807
|
+
/** @description URL of the app logo. */
|
|
2808
|
+
logoUrl: string;
|
|
2809
|
+
/** @description Whether the app is published and available for use. */
|
|
2810
|
+
isPublished: boolean;
|
|
2811
|
+
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
2812
|
+
needsConnection: boolean;
|
|
2813
|
+
/** @description Whether the app can be used by agents. */
|
|
2814
|
+
availableForAgent: boolean;
|
|
2815
|
+
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
2816
|
+
actions: {
|
|
2817
|
+
[key: string]: unknown;
|
|
2818
|
+
}[];
|
|
2819
|
+
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
2820
|
+
triggers: {
|
|
2821
|
+
[key: string]: unknown;
|
|
2822
|
+
}[];
|
|
2823
|
+
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
2824
|
+
connections: {
|
|
2825
|
+
[key: string]: unknown;
|
|
2826
|
+
}[];
|
|
2827
|
+
};
|
|
2828
|
+
UpsertObjectTypeBySlugDto: {
|
|
2829
|
+
/** @description Stable deployment-wide slug (lowercase, digits, hyphens). Used as the upsert key. Granted to the caller workspace when new. */
|
|
2830
|
+
slug: string;
|
|
2831
|
+
/** @description Singular display name. */
|
|
2832
|
+
name?: string;
|
|
2833
|
+
/** @description Plural display name. */
|
|
2834
|
+
namePlural?: string;
|
|
2835
|
+
/** @description Description. */
|
|
2836
|
+
description?: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* @description Icon identifier.
|
|
2839
|
+
* @default box
|
|
2840
|
+
*/
|
|
2841
|
+
icon: string;
|
|
2842
|
+
/**
|
|
2843
|
+
* @description Hex colour.
|
|
2844
|
+
* @default #3B82F6
|
|
2845
|
+
*/
|
|
2846
|
+
color: string;
|
|
2847
|
+
/** @description Field definitions grouped into sections. */
|
|
2848
|
+
attributeSchema: {
|
|
2849
|
+
[key: string]: unknown;
|
|
2850
|
+
};
|
|
2851
|
+
/** @description Optional state machine definition. */
|
|
2852
|
+
stateSchema?: {
|
|
2853
|
+
[key: string]: unknown;
|
|
2854
|
+
} | null;
|
|
2855
|
+
/** @description Whether the type is enabled. */
|
|
2856
|
+
isEnabled?: boolean;
|
|
2857
|
+
/**
|
|
2858
|
+
* @description When false (default), reject unknown attribute keys on entity writes.
|
|
2859
|
+
* @default false
|
|
2860
|
+
*/
|
|
2861
|
+
allowUnknownAttributes: boolean;
|
|
2862
|
+
/**
|
|
2863
|
+
* @description Marks the type as code-managed. Defaults to true on upsert.
|
|
2864
|
+
* @default true
|
|
2865
|
+
*/
|
|
2866
|
+
managedByCode: boolean;
|
|
2867
|
+
};
|
|
2868
|
+
ObjectTypeUserSummaryDto: {
|
|
2869
|
+
/** @description User ID. */
|
|
2870
|
+
id: string;
|
|
2871
|
+
/** @description Email address of the user. */
|
|
2872
|
+
email: string;
|
|
2873
|
+
/** @description Display name of the user. */
|
|
2874
|
+
name: string;
|
|
2875
|
+
};
|
|
2876
|
+
ObjectTypeCreatedByDto: {
|
|
2877
|
+
/** @description Workspace user ID. */
|
|
2878
|
+
id: string;
|
|
2879
|
+
user: components["schemas"]["ObjectTypeUserSummaryDto"];
|
|
2880
|
+
};
|
|
2881
|
+
ObjectTypeCountDto: {
|
|
2882
|
+
/** @description Number of non-deleted entities of this type. */
|
|
2883
|
+
objects: number;
|
|
2884
|
+
};
|
|
2885
|
+
ObjectTypeResponseDto: {
|
|
2886
|
+
/** @description Entity type ID. */
|
|
2887
|
+
id: string;
|
|
2888
|
+
/** @description Singular display name of the entity type. */
|
|
2889
|
+
name: string;
|
|
2890
|
+
/** @description Plural display name of the entity type. */
|
|
2891
|
+
namePlural: string;
|
|
2892
|
+
/** @description URL-safe slug, unique across the deployment. */
|
|
2893
|
+
slug: string;
|
|
2894
|
+
/** @description Icon identifier for the entity type. */
|
|
2895
|
+
icon: string;
|
|
2896
|
+
/** @description Hex colour of the entity type. */
|
|
2897
|
+
color: string;
|
|
2898
|
+
/** @description Whether the entity type is enabled. */
|
|
2899
|
+
isEnabled: boolean;
|
|
2900
|
+
/** @description When false, entity create/update rejects attribute keys not declared on the type. Reserved key `extensions` is always allowed. */
|
|
2901
|
+
allowUnknownAttributes: boolean;
|
|
2902
|
+
/** @description True when last written by code (CLI / SDK upsert). */
|
|
2903
|
+
managedByCode: boolean;
|
|
2904
|
+
/** @description Incremented when attributeSchema, stateSchema, or allowUnknownAttributes changes. */
|
|
2905
|
+
schemaRevision: number;
|
|
2906
|
+
/** @description Field that identifies a record besides the Lunnoa id. `name`, or `attribute:<field name>`. */
|
|
2907
|
+
uniqueKeyField?: string | null;
|
|
2908
|
+
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
2909
|
+
description?: string | null;
|
|
2910
|
+
/** @description Field definitions grouped into sections. Included when `expansion=attributeSchema` is requested. */
|
|
2911
|
+
attributeSchema?: {
|
|
2912
|
+
[key: string]: unknown;
|
|
2913
|
+
};
|
|
2914
|
+
/** @description State machine definition. Included when `expansion=stateSchema` is requested. */
|
|
2915
|
+
stateSchema?: {
|
|
2916
|
+
[key: string]: unknown;
|
|
2917
|
+
} | null;
|
|
2918
|
+
/**
|
|
2919
|
+
* Format: date-time
|
|
2920
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
2921
|
+
*/
|
|
2922
|
+
createdAt?: string;
|
|
2923
|
+
/**
|
|
2924
|
+
* Format: date-time
|
|
2925
|
+
* @description Included when `expansion=updatedAt` is requested.
|
|
2926
|
+
*/
|
|
2927
|
+
updatedAt?: string;
|
|
2928
|
+
/** @description Workspace member who created the entity type. Included when `expansion=createdBy` is requested. */
|
|
2929
|
+
createdBy?: components["schemas"]["ObjectTypeCreatedByDto"];
|
|
2930
|
+
/** @description Included when `expansion=countObjects` is requested. */
|
|
2931
|
+
_count?: components["schemas"]["ObjectTypeCountDto"];
|
|
2932
|
+
};
|
|
2933
|
+
CreateObjectDto: {
|
|
2934
|
+
/** @description Display name of the entity. */
|
|
2935
|
+
name: string;
|
|
2936
|
+
/**
|
|
2937
|
+
* Format: uuid
|
|
2938
|
+
* @description Platform admin only. Workspace the record is created in. Builders always use their active workspace.
|
|
2939
|
+
*/
|
|
2940
|
+
workspaceId?: string;
|
|
2941
|
+
/**
|
|
2942
|
+
* Format: uuid
|
|
2943
|
+
* @description ID of the entity type to create the entity under.
|
|
2944
|
+
*/
|
|
2945
|
+
objectTypeId: string;
|
|
2946
|
+
/** @description Initial state ID. Must exist in the entity type state schema. Defaults to the schema initial state when omitted. */
|
|
2947
|
+
state?: string;
|
|
2948
|
+
/** @description Attribute values keyed by field ID. Unknown keys are rejected unless the entity type has allowUnknownAttributes=true. Reserved key `extensions` (JSON object) is always allowed. */
|
|
2949
|
+
attributes?: {
|
|
2950
|
+
[key: string]: unknown;
|
|
2951
|
+
};
|
|
2952
|
+
};
|
|
2953
|
+
ObjectTypeSummaryDto: {
|
|
2954
|
+
/** @description Entity type ID. */
|
|
2955
|
+
id: string;
|
|
2956
|
+
/** @description Singular display name of the entity type. */
|
|
2957
|
+
name: string;
|
|
2958
|
+
/** @description URL-safe slug of the entity type. */
|
|
2959
|
+
slug: string;
|
|
2960
|
+
/** @description Icon identifier for the entity type. */
|
|
2961
|
+
icon: string;
|
|
2962
|
+
/** @description Hex colour of the entity type. */
|
|
2963
|
+
color: string;
|
|
2964
|
+
/** @description Plural display name. Included when `expansion=objectType` is requested. */
|
|
2965
|
+
namePlural?: string;
|
|
2966
|
+
/** @description Field definitions grouped into sections. Included when `expansion=objectType` is requested on single-entity reads. */
|
|
2967
|
+
attributeSchema?: {
|
|
2968
|
+
[key: string]: unknown;
|
|
2969
|
+
};
|
|
2970
|
+
/** @description State machine definition. Included when `expansion=objectType` is requested. */
|
|
2971
|
+
stateSchema?: {
|
|
2972
|
+
[key: string]: unknown;
|
|
2973
|
+
} | null;
|
|
2974
|
+
};
|
|
2975
|
+
ObjectUserSummaryDto: {
|
|
2976
|
+
/** @description User ID. */
|
|
2977
|
+
id: string;
|
|
2978
|
+
/** @description Email address of the user. */
|
|
2979
|
+
email: string;
|
|
2980
|
+
/** @description Display name of the user. */
|
|
2981
|
+
name: string;
|
|
2982
|
+
};
|
|
2983
|
+
ObjectWorkspaceUserSummaryDto: {
|
|
2984
|
+
/** @description Workspace user ID. */
|
|
2985
|
+
id: string;
|
|
2986
|
+
user: components["schemas"]["ObjectUserSummaryDto"];
|
|
2987
|
+
};
|
|
2988
|
+
ObjectStateHistoryUserSummaryDto: {
|
|
2989
|
+
/** @description User ID. */
|
|
2990
|
+
id: string;
|
|
2991
|
+
/** @description Display name of the user. */
|
|
2992
|
+
name: string;
|
|
2993
|
+
};
|
|
2994
|
+
ObjectStateHistoryChangedByDto: {
|
|
2995
|
+
/** @description Workspace user ID. */
|
|
2996
|
+
id: string;
|
|
2997
|
+
user: components["schemas"]["ObjectStateHistoryUserSummaryDto"];
|
|
2998
|
+
};
|
|
2999
|
+
ObjectStateHistoryItemDto: {
|
|
3000
|
+
/** @description State history entry ID. */
|
|
3001
|
+
id: string;
|
|
3002
|
+
/** @description State the entity moved from. Null for the initial state. */
|
|
3003
|
+
fromState: string | null;
|
|
3004
|
+
/** @description State the entity moved to. */
|
|
3005
|
+
toState: string;
|
|
3006
|
+
/** @description Reason recorded for the state change, if any. */
|
|
3007
|
+
reason: string | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* Format: date-time
|
|
3010
|
+
* @description When the state change occurred.
|
|
3011
|
+
*/
|
|
3012
|
+
createdAt: string;
|
|
3013
|
+
/** @description Workspace member who made the change, if recorded. */
|
|
3014
|
+
changedBy: components["schemas"]["ObjectStateHistoryChangedByDto"] | null;
|
|
3015
|
+
};
|
|
3016
|
+
ObjectResponseDto: {
|
|
3017
|
+
/** @description Entity ID. */
|
|
3018
|
+
id: string;
|
|
3019
|
+
/** @description Display name of the entity. */
|
|
3020
|
+
name: string;
|
|
3021
|
+
/** @description Current state of the entity, if the type defines states. */
|
|
3022
|
+
state: string | null;
|
|
3023
|
+
/** @description Dynamic attribute values keyed by field ID. */
|
|
3024
|
+
attributes: {
|
|
3025
|
+
[key: string]: unknown;
|
|
3026
|
+
};
|
|
3027
|
+
/**
|
|
3028
|
+
* Format: date-time
|
|
3029
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
3030
|
+
*/
|
|
3031
|
+
createdAt?: string;
|
|
3032
|
+
/**
|
|
3033
|
+
* Format: date-time
|
|
3034
|
+
* @description Included by default on list responses, otherwise when `expansion=updatedAt` is requested.
|
|
3035
|
+
*/
|
|
3036
|
+
updatedAt?: string;
|
|
3037
|
+
/** @description Included by default on list responses with a minimal shape, otherwise when `expansion=objectType` is requested. */
|
|
3038
|
+
objectType?: components["schemas"]["ObjectTypeSummaryDto"];
|
|
3039
|
+
/** @description Included when `expansion=createdBy` is requested. */
|
|
3040
|
+
createdBy?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
3041
|
+
/** @description Most recent state changes (up to 50, newest first). Included when `expansion=stateHistory` is requested. */
|
|
3042
|
+
stateHistory?: components["schemas"]["ObjectStateHistoryItemDto"][];
|
|
3043
|
+
};
|
|
3044
|
+
ObjectPaginationDto: {
|
|
3045
|
+
/** @description Current page number (1-based). */
|
|
3046
|
+
page: number;
|
|
3047
|
+
/** @description Number of items per page (maximum 100). */
|
|
3048
|
+
pageSize: number;
|
|
3049
|
+
/** @description Total number of matching entities. */
|
|
3050
|
+
totalCount: number;
|
|
3051
|
+
/** @description Total number of pages. */
|
|
3052
|
+
totalPages: number;
|
|
3053
|
+
};
|
|
3054
|
+
PaginatedObjectsResponseDto: {
|
|
3055
|
+
data: components["schemas"]["ObjectResponseDto"][];
|
|
3056
|
+
pagination: components["schemas"]["ObjectPaginationDto"];
|
|
3057
|
+
};
|
|
3058
|
+
UpdateObjectDto: {
|
|
3059
|
+
/** @description New display name of the entity. */
|
|
3060
|
+
name?: string;
|
|
3061
|
+
/** @description Attribute values keyed by field ID. Merged into existing attributes. Unknown keys are rejected unless the entity type has allowUnknownAttributes=true. Reserved key `extensions` is always allowed. */
|
|
3062
|
+
attributes?: {
|
|
3063
|
+
[key: string]: unknown;
|
|
3064
|
+
};
|
|
3065
|
+
};
|
|
3066
|
+
ChangeObjectStateDto: {
|
|
3067
|
+
/** @description ID of the target state. Must be a valid transition from the current state when the entity type defines transitions. */
|
|
3068
|
+
newState: string;
|
|
3069
|
+
/** @description Reason for the state change. Required when the transition is configured with requiresReason. */
|
|
3070
|
+
reason?: string;
|
|
3071
|
+
};
|
|
3072
|
+
ChangeObjectStateResponseDto: {
|
|
3073
|
+
/** @description Entity ID. */
|
|
3074
|
+
id: string;
|
|
3075
|
+
/** @description Display name of the entity. */
|
|
3076
|
+
name: string;
|
|
3077
|
+
/** @description State of the entity after the change. */
|
|
3078
|
+
state: string | null;
|
|
3079
|
+
/**
|
|
3080
|
+
* Format: date-time
|
|
3081
|
+
* @description When the entity was last updated.
|
|
3082
|
+
*/
|
|
3083
|
+
updatedAt: string;
|
|
3084
|
+
};
|
|
3085
|
+
StateHistoryUserSummaryDto: {
|
|
3086
|
+
/** @description User ID. */
|
|
3087
|
+
id: string;
|
|
3088
|
+
/** @description Display name of the user. */
|
|
3089
|
+
name: string;
|
|
3090
|
+
/** @description Email address of the user. */
|
|
3091
|
+
email: string;
|
|
3092
|
+
};
|
|
3093
|
+
StateHistoryChangedByDto: {
|
|
3094
|
+
/** @description Workspace user ID. */
|
|
3095
|
+
id: string;
|
|
3096
|
+
user: components["schemas"]["StateHistoryUserSummaryDto"];
|
|
3097
|
+
};
|
|
3098
|
+
ObjectStateHistoryEntryResponseDto: {
|
|
3099
|
+
/** @description State history entry ID. */
|
|
3100
|
+
id: string;
|
|
3101
|
+
/** @description State the entity moved from. Null for the initial state. */
|
|
3102
|
+
fromState: string | null;
|
|
3103
|
+
/** @description State the entity moved to. */
|
|
3104
|
+
toState: string;
|
|
3105
|
+
/** @description Reason recorded for the state change, if any. */
|
|
3106
|
+
reason: string | null;
|
|
3107
|
+
/**
|
|
3108
|
+
* Format: date-time
|
|
3109
|
+
* @description When the state change occurred.
|
|
3110
|
+
*/
|
|
3111
|
+
createdAt: string;
|
|
3112
|
+
/** @description Workspace member who made the change, if recorded. */
|
|
3113
|
+
changedBy: components["schemas"]["StateHistoryChangedByDto"] | null;
|
|
3114
|
+
};
|
|
3115
|
+
ObjectStateInfoDto: {
|
|
3116
|
+
/** @description State ID. */
|
|
3117
|
+
id: string;
|
|
3118
|
+
/** @description Display name of the state. */
|
|
3119
|
+
name: string;
|
|
3120
|
+
/** @description Colour associated with the state. */
|
|
3121
|
+
color?: string;
|
|
3122
|
+
/** @description Icon associated with the state. */
|
|
3123
|
+
icon?: string;
|
|
3124
|
+
/** @description Whether the state is a final state. */
|
|
3125
|
+
isFinal: boolean;
|
|
3126
|
+
};
|
|
3127
|
+
ObjectStateTransitionDto: {
|
|
3128
|
+
/** @description Transition ID from the state schema. */
|
|
3129
|
+
transitionId: string;
|
|
3130
|
+
/** @description ID of the target state. */
|
|
3131
|
+
toStateId: string;
|
|
3132
|
+
/** @description Display name of the target state. */
|
|
3133
|
+
toStateName: string;
|
|
3134
|
+
/** @description Colour of the target state. */
|
|
3135
|
+
toStateColor?: string;
|
|
3136
|
+
/** @description Icon of the target state. */
|
|
3137
|
+
toStateIcon?: string;
|
|
3138
|
+
/** @description Whether a reason must be supplied for this transition. */
|
|
3139
|
+
requiresReason: boolean;
|
|
3140
|
+
/** @description Confirmation message to show before applying the transition. */
|
|
3141
|
+
confirmationMessage?: string;
|
|
3142
|
+
};
|
|
3143
|
+
ObjectStateTransitionsResponseDto: {
|
|
3144
|
+
/** @description Current state of the entity. Null when the entity has no state or the type defines no state schema. */
|
|
3145
|
+
currentState: components["schemas"]["ObjectStateInfoDto"] | null;
|
|
3146
|
+
/** @description Transitions allowed from the current state. */
|
|
3147
|
+
validTransitions: components["schemas"]["ObjectStateTransitionDto"][];
|
|
3148
|
+
/** @description All states defined by the entity type, for cases where no transitions are defined. */
|
|
3149
|
+
allStates: components["schemas"]["ObjectStateInfoDto"][];
|
|
3150
|
+
};
|
|
3151
|
+
ImportRowErrorDto: {
|
|
3152
|
+
/** @description Row number the error relates to (1-based). */
|
|
3153
|
+
row: number;
|
|
3154
|
+
/** @description Field ID the error relates to, when applicable. */
|
|
3155
|
+
field?: string;
|
|
3156
|
+
/** @description Human-readable error message. */
|
|
3157
|
+
message: string;
|
|
3158
|
+
};
|
|
3159
|
+
ImportEntitiesResponseDto: {
|
|
3160
|
+
/** @description Total number of rows processed. */
|
|
3161
|
+
totalRows: number;
|
|
3162
|
+
/** @description Number of rows imported successfully. */
|
|
3163
|
+
successCount: number;
|
|
3164
|
+
/** @description Number of rows that failed to import. */
|
|
3165
|
+
errorCount: number;
|
|
3166
|
+
/** @description Per-row errors encountered during the import. */
|
|
3167
|
+
errors: components["schemas"]["ImportRowErrorDto"][];
|
|
3168
|
+
/** @description IDs of entities created by the import. */
|
|
3169
|
+
createdIds: string[];
|
|
3170
|
+
/** @description IDs of existing entities updated by the import. */
|
|
3171
|
+
updatedIds: string[];
|
|
3172
|
+
};
|
|
3173
|
+
ImportTemplateResponseDto: {
|
|
3174
|
+
/** @description Column headers for the import file. Always starts with "name". */
|
|
3175
|
+
columns: string[];
|
|
3176
|
+
/** @description Sample row with an example value for each column. */
|
|
3177
|
+
sampleRow: {
|
|
3178
|
+
[key: string]: string;
|
|
3179
|
+
};
|
|
3180
|
+
};
|
|
3181
|
+
CreateKnowledgeDto: {
|
|
3182
|
+
/** @description Name of the knowledge base. */
|
|
3183
|
+
name: string;
|
|
3184
|
+
/** @description Description of the knowledge base. */
|
|
3185
|
+
description?: string;
|
|
3186
|
+
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
3187
|
+
chunkOverlap?: number;
|
|
3188
|
+
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
3189
|
+
chunkSize?: number;
|
|
3190
|
+
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
3191
|
+
embeddingModel?: string;
|
|
3192
|
+
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
3193
|
+
embeddingProvider?: string;
|
|
3099
3194
|
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
3100
3195
|
dimensions?: number;
|
|
3101
3196
|
};
|
|
@@ -3169,185 +3264,67 @@ interface components {
|
|
|
3169
3264
|
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
3170
3265
|
embeddingModel?: string;
|
|
3171
3266
|
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
3172
|
-
embeddingProvider?: string;
|
|
3173
|
-
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
3174
|
-
dimensions?: number;
|
|
3175
|
-
};
|
|
3176
|
-
SaveUploadedTextToKnowledgeDto: {
|
|
3177
|
-
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
3178
|
-
name: string;
|
|
3179
|
-
/** @description Raw text content to embed into the knowledge base. */
|
|
3180
|
-
text: string;
|
|
3181
|
-
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
3182
|
-
chunkOverlap: number;
|
|
3183
|
-
/** @description Chunk size in words used to split the text before embedding. */
|
|
3184
|
-
chunkSize: number;
|
|
3185
|
-
};
|
|
3186
|
-
KnowledgeDocumentResponseDto: {
|
|
3187
|
-
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
3188
|
-
id: string;
|
|
3189
|
-
/** @description Document name. */
|
|
3190
|
-
name: string;
|
|
3191
|
-
/**
|
|
3192
|
-
* Format: date-time
|
|
3193
|
-
* @description Creation timestamp.
|
|
3194
|
-
*/
|
|
3195
|
-
createdAt: string;
|
|
3196
|
-
/** @description Number of parts (chunks) the document was split into. */
|
|
3197
|
-
partCount: number;
|
|
3198
|
-
/**
|
|
3199
|
-
* @description Whether the document is a multi-part group or a standalone single-part upload.
|
|
3200
|
-
* @enum {string}
|
|
3201
|
-
*/
|
|
3202
|
-
type: "group" | "standalone";
|
|
3203
|
-
};
|
|
3204
|
-
KnowledgeDocumentGroupVectorRefDto: {
|
|
3205
|
-
/** @description Vector reference ID. */
|
|
3206
|
-
id: string;
|
|
3207
|
-
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
3208
|
-
name: string;
|
|
3209
|
-
/**
|
|
3210
|
-
* Format: date-time
|
|
3211
|
-
* @description Creation timestamp.
|
|
3212
|
-
*/
|
|
3213
|
-
createdAt: string;
|
|
3214
|
-
/** @description Part number within the group, or null for single-part uploads. */
|
|
3215
|
-
part: number | null;
|
|
3216
|
-
/** @description Storage path of the raw text for this part. */
|
|
3217
|
-
s3Link: string | null;
|
|
3218
|
-
};
|
|
3219
|
-
KnowledgeDocumentGroupResponseDto: {
|
|
3220
|
-
/** @description Document group ID. */
|
|
3221
|
-
id: string;
|
|
3222
|
-
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
3223
|
-
name: string | null;
|
|
3224
|
-
/**
|
|
3225
|
-
* Format: date-time
|
|
3226
|
-
* @description Creation timestamp.
|
|
3227
|
-
*/
|
|
3228
|
-
createdAt: string;
|
|
3229
|
-
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
3230
|
-
FK_knowledgeId: string | null;
|
|
3231
|
-
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
3232
|
-
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
3233
|
-
};
|
|
3234
|
-
CreateVariableDto: {
|
|
3235
|
-
/** @description Name of the variable. */
|
|
3236
|
-
name: string;
|
|
3237
|
-
/** @description Description of the variable. */
|
|
3238
|
-
description?: string;
|
|
3239
|
-
/**
|
|
3240
|
-
* @description Scope of the variable (system, workspace or project).
|
|
3241
|
-
* @enum {string}
|
|
3242
|
-
*/
|
|
3243
|
-
type: "system" | "workspace" | "project";
|
|
3244
|
-
/**
|
|
3245
|
-
* @description Data type of the variable value.
|
|
3246
|
-
* @enum {string}
|
|
3247
|
-
*/
|
|
3248
|
-
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3249
|
-
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3250
|
-
projectId?: string;
|
|
3251
|
-
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3252
|
-
value: string;
|
|
3253
|
-
};
|
|
3254
|
-
VariableWorkspaceDto: {
|
|
3255
|
-
/** @description Workspace ID. */
|
|
3256
|
-
id: string;
|
|
3257
|
-
/** @description Workspace name. */
|
|
3258
|
-
name: string;
|
|
3267
|
+
embeddingProvider?: string;
|
|
3268
|
+
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
3269
|
+
dimensions?: number;
|
|
3259
3270
|
};
|
|
3260
|
-
|
|
3261
|
-
/** @description
|
|
3262
|
-
id: string;
|
|
3263
|
-
/** @description Project name. */
|
|
3271
|
+
SaveUploadedTextToKnowledgeDto: {
|
|
3272
|
+
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
3264
3273
|
name: string;
|
|
3274
|
+
/** @description Raw text content to embed into the knowledge base. */
|
|
3275
|
+
text: string;
|
|
3276
|
+
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
3277
|
+
chunkOverlap: number;
|
|
3278
|
+
/** @description Chunk size in words used to split the text before embedding. */
|
|
3279
|
+
chunkSize: number;
|
|
3265
3280
|
};
|
|
3266
|
-
|
|
3267
|
-
/** @description
|
|
3281
|
+
KnowledgeDocumentResponseDto: {
|
|
3282
|
+
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
3268
3283
|
id: string;
|
|
3269
|
-
/** @description
|
|
3284
|
+
/** @description Document name. */
|
|
3270
3285
|
name: string;
|
|
3271
|
-
/**
|
|
3272
|
-
* @description Data type of the variable value.
|
|
3273
|
-
* @enum {string}
|
|
3274
|
-
*/
|
|
3275
|
-
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3276
|
-
/**
|
|
3277
|
-
* @description Scope of the variable (system, workspace or project).
|
|
3278
|
-
* @enum {string}
|
|
3279
|
-
*/
|
|
3280
|
-
type: "system" | "workspace" | "project";
|
|
3281
|
-
/** @description Variable value. Included when `expansion=value` is requested. */
|
|
3282
|
-
value?: Record<string, never>;
|
|
3283
|
-
/** @description Variable description. Included when `expansion=description` is requested. */
|
|
3284
|
-
description?: string;
|
|
3285
|
-
/**
|
|
3286
|
-
* Format: date-time
|
|
3287
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3288
|
-
*/
|
|
3289
|
-
createdAt?: string;
|
|
3290
3286
|
/**
|
|
3291
3287
|
* Format: date-time
|
|
3292
|
-
* @description
|
|
3293
|
-
*/
|
|
3294
|
-
updatedAt?: string;
|
|
3295
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3296
|
-
workspace?: components["schemas"]["VariableWorkspaceDto"];
|
|
3297
|
-
/** @description Owning project for project-scoped variables. Included when `expansion=project` is requested. */
|
|
3298
|
-
project?: components["schemas"]["VariableProjectDto"];
|
|
3299
|
-
};
|
|
3300
|
-
UpdateVariableDto: {
|
|
3301
|
-
/** @description Name of the variable. */
|
|
3302
|
-
name?: string;
|
|
3303
|
-
/** @description Description of the variable. */
|
|
3304
|
-
description?: string;
|
|
3305
|
-
/**
|
|
3306
|
-
* @description Scope of the variable (system, workspace or project).
|
|
3307
|
-
* @enum {string}
|
|
3288
|
+
* @description Creation timestamp.
|
|
3308
3289
|
*/
|
|
3309
|
-
|
|
3290
|
+
createdAt: string;
|
|
3291
|
+
/** @description Number of parts (chunks) the document was split into. */
|
|
3292
|
+
partCount: number;
|
|
3310
3293
|
/**
|
|
3311
|
-
* @description
|
|
3294
|
+
* @description Whether the document is a multi-part group or a standalone single-part upload.
|
|
3312
3295
|
* @enum {string}
|
|
3313
3296
|
*/
|
|
3314
|
-
|
|
3315
|
-
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3316
|
-
projectId?: string;
|
|
3317
|
-
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3318
|
-
value?: string;
|
|
3319
|
-
};
|
|
3320
|
-
ConnectionWorkspaceDto: {
|
|
3321
|
-
/** @description Workspace ID. */
|
|
3322
|
-
id: string;
|
|
3323
|
-
/** @description Workspace name. */
|
|
3324
|
-
name: string;
|
|
3297
|
+
type: "group" | "standalone";
|
|
3325
3298
|
};
|
|
3326
|
-
|
|
3327
|
-
/** @description
|
|
3299
|
+
KnowledgeDocumentGroupVectorRefDto: {
|
|
3300
|
+
/** @description Vector reference ID. */
|
|
3328
3301
|
id: string;
|
|
3329
|
-
/** @description
|
|
3302
|
+
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
3330
3303
|
name: string;
|
|
3331
3304
|
/**
|
|
3332
3305
|
* Format: date-time
|
|
3333
|
-
* @description Creation timestamp.
|
|
3306
|
+
* @description Creation timestamp.
|
|
3334
3307
|
*/
|
|
3335
|
-
createdAt
|
|
3308
|
+
createdAt: string;
|
|
3309
|
+
/** @description Part number within the group, or null for single-part uploads. */
|
|
3310
|
+
part: number | null;
|
|
3311
|
+
/** @description Storage path of the raw text for this part. */
|
|
3312
|
+
s3Link: string | null;
|
|
3313
|
+
};
|
|
3314
|
+
KnowledgeDocumentGroupResponseDto: {
|
|
3315
|
+
/** @description Document group ID. */
|
|
3316
|
+
id: string;
|
|
3317
|
+
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
3318
|
+
name: string | null;
|
|
3336
3319
|
/**
|
|
3337
3320
|
* Format: date-time
|
|
3338
|
-
* @description
|
|
3321
|
+
* @description Creation timestamp.
|
|
3339
3322
|
*/
|
|
3340
|
-
|
|
3341
|
-
/** @description
|
|
3342
|
-
|
|
3343
|
-
/** @description
|
|
3344
|
-
|
|
3345
|
-
/** @description Full workflow app definition for this connection. Included when `expansion=workflowApp` is requested on the list endpoint. */
|
|
3346
|
-
workflowApp?: {
|
|
3347
|
-
[key: string]: unknown;
|
|
3348
|
-
};
|
|
3349
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3350
|
-
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
3323
|
+
createdAt: string;
|
|
3324
|
+
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
3325
|
+
FK_knowledgeId: string | null;
|
|
3326
|
+
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
3327
|
+
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
3351
3328
|
};
|
|
3352
3329
|
ManuallyRunWorkflowInputDataDto: {
|
|
3353
3330
|
/**
|
|
@@ -3491,95 +3468,268 @@ interface components {
|
|
|
3491
3468
|
* @description Overall execution status. Included when `expansion=status` is requested.
|
|
3492
3469
|
* @enum {string}
|
|
3493
3470
|
*/
|
|
3494
|
-
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3495
|
-
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
3496
|
-
statusMessage?: string | null;
|
|
3497
|
-
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
3498
|
-
output?: {
|
|
3499
|
-
[key: string]: unknown;
|
|
3500
|
-
} | null;
|
|
3471
|
+
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3472
|
+
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
3473
|
+
statusMessage?: string | null;
|
|
3474
|
+
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
3475
|
+
output?: {
|
|
3476
|
+
[key: string]: unknown;
|
|
3477
|
+
} | null;
|
|
3478
|
+
/**
|
|
3479
|
+
* Format: date-time
|
|
3480
|
+
* @description Timestamp when a waiting execution is scheduled to continue. Included when `expansion=continueExecutionAt` is requested.
|
|
3481
|
+
*/
|
|
3482
|
+
continueExecutionAt?: string | null;
|
|
3483
|
+
/**
|
|
3484
|
+
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
3485
|
+
* @enum {string}
|
|
3486
|
+
*/
|
|
3487
|
+
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
3488
|
+
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
3489
|
+
executionVariables?: {
|
|
3490
|
+
[key: string]: unknown;
|
|
3491
|
+
} | null;
|
|
3492
|
+
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
3493
|
+
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
3494
|
+
/** @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}. */
|
|
3495
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3496
|
+
/** @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. */
|
|
3497
|
+
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
3498
|
+
/**
|
|
3499
|
+
* @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.
|
|
3500
|
+
* @enum {string}
|
|
3501
|
+
*/
|
|
3502
|
+
source?: "WORKFLOW" | "SDK";
|
|
3503
|
+
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
3504
|
+
name?: string | null;
|
|
3505
|
+
};
|
|
3506
|
+
RunActionDto: {
|
|
3507
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3508
|
+
appId: string;
|
|
3509
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
3510
|
+
actionId: string;
|
|
3511
|
+
/** @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. */
|
|
3512
|
+
connectionId?: string;
|
|
3513
|
+
/** @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. */
|
|
3514
|
+
projectId?: string;
|
|
3515
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
3516
|
+
input?: {
|
|
3517
|
+
[key: string]: unknown;
|
|
3518
|
+
};
|
|
3519
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
3520
|
+
name?: string;
|
|
3521
|
+
};
|
|
3522
|
+
RunActionResponseDto: {
|
|
3523
|
+
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
3524
|
+
id: string;
|
|
3525
|
+
/**
|
|
3526
|
+
* @description Final execution status after the single action step.
|
|
3527
|
+
* @enum {string}
|
|
3528
|
+
*/
|
|
3529
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3530
|
+
/** @description Human-readable status detail. */
|
|
3531
|
+
statusMessage?: string | null;
|
|
3532
|
+
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
3533
|
+
output?: {
|
|
3534
|
+
[key: string]: unknown;
|
|
3535
|
+
} | null;
|
|
3536
|
+
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
3537
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3538
|
+
};
|
|
3539
|
+
RunStepDto: {
|
|
3540
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3541
|
+
appId: string;
|
|
3542
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
3543
|
+
actionId: string;
|
|
3544
|
+
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
3545
|
+
connectionId?: string;
|
|
3546
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
3547
|
+
input?: {
|
|
3548
|
+
[key: string]: unknown;
|
|
3549
|
+
};
|
|
3550
|
+
/** @description Optional display name for this step. */
|
|
3551
|
+
name?: string;
|
|
3552
|
+
};
|
|
3553
|
+
StartRunDto: {
|
|
3554
|
+
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
3555
|
+
steps: components["schemas"]["RunStepDto"][];
|
|
3556
|
+
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
3557
|
+
projectId?: string;
|
|
3558
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
3559
|
+
name?: string;
|
|
3560
|
+
};
|
|
3561
|
+
CreateVariableDto: {
|
|
3562
|
+
/** @description Name of the variable. */
|
|
3563
|
+
name: string;
|
|
3564
|
+
/** @description Description of the variable. */
|
|
3565
|
+
description?: string;
|
|
3566
|
+
/**
|
|
3567
|
+
* @description Scope of the variable (system, workspace or project).
|
|
3568
|
+
* @enum {string}
|
|
3569
|
+
*/
|
|
3570
|
+
type: "system" | "workspace" | "project";
|
|
3571
|
+
/**
|
|
3572
|
+
* @description Data type of the variable value.
|
|
3573
|
+
* @enum {string}
|
|
3574
|
+
*/
|
|
3575
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3576
|
+
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3577
|
+
projectId?: string;
|
|
3578
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3579
|
+
value: string;
|
|
3580
|
+
};
|
|
3581
|
+
VariableWorkspaceDto: {
|
|
3582
|
+
/** @description Workspace ID. */
|
|
3583
|
+
id: string;
|
|
3584
|
+
/** @description Workspace name. */
|
|
3585
|
+
name: string;
|
|
3586
|
+
};
|
|
3587
|
+
VariableProjectDto: {
|
|
3588
|
+
/** @description Project ID. */
|
|
3589
|
+
id: string;
|
|
3590
|
+
/** @description Project name. */
|
|
3591
|
+
name: string;
|
|
3592
|
+
};
|
|
3593
|
+
VariableResponseDto: {
|
|
3594
|
+
/** @description Variable ID. */
|
|
3595
|
+
id: string;
|
|
3596
|
+
/** @description Variable name. */
|
|
3597
|
+
name: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* @description Data type of the variable value.
|
|
3600
|
+
* @enum {string}
|
|
3601
|
+
*/
|
|
3602
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3603
|
+
/**
|
|
3604
|
+
* @description Scope of the variable (system, workspace or project).
|
|
3605
|
+
* @enum {string}
|
|
3606
|
+
*/
|
|
3607
|
+
type: "system" | "workspace" | "project";
|
|
3608
|
+
/** @description Variable value. Included when `expansion=value` is requested. */
|
|
3609
|
+
value?: Record<string, never>;
|
|
3610
|
+
/** @description Variable description. Included when `expansion=description` is requested. */
|
|
3611
|
+
description?: string;
|
|
3612
|
+
/**
|
|
3613
|
+
* Format: date-time
|
|
3614
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3615
|
+
*/
|
|
3616
|
+
createdAt?: string;
|
|
3501
3617
|
/**
|
|
3502
3618
|
* Format: date-time
|
|
3503
|
-
* @description
|
|
3619
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3504
3620
|
*/
|
|
3505
|
-
|
|
3621
|
+
updatedAt?: string;
|
|
3622
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3623
|
+
workspace?: components["schemas"]["VariableWorkspaceDto"];
|
|
3624
|
+
/** @description Owning project for project-scoped variables. Included when `expansion=project` is requested. */
|
|
3625
|
+
project?: components["schemas"]["VariableProjectDto"];
|
|
3626
|
+
};
|
|
3627
|
+
UpdateVariableDto: {
|
|
3628
|
+
/** @description Name of the variable. */
|
|
3629
|
+
name?: string;
|
|
3630
|
+
/** @description Description of the variable. */
|
|
3631
|
+
description?: string;
|
|
3506
3632
|
/**
|
|
3507
|
-
* @description
|
|
3633
|
+
* @description Scope of the variable (system, workspace or project).
|
|
3508
3634
|
* @enum {string}
|
|
3509
3635
|
*/
|
|
3510
|
-
|
|
3511
|
-
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
3512
|
-
executionVariables?: {
|
|
3513
|
-
[key: string]: unknown;
|
|
3514
|
-
} | null;
|
|
3515
|
-
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
3516
|
-
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
3517
|
-
/** @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}. */
|
|
3518
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3519
|
-
/** @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. */
|
|
3520
|
-
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
3636
|
+
type?: "system" | "workspace" | "project";
|
|
3521
3637
|
/**
|
|
3522
|
-
* @description
|
|
3638
|
+
* @description Data type of the variable value.
|
|
3523
3639
|
* @enum {string}
|
|
3524
3640
|
*/
|
|
3525
|
-
|
|
3526
|
-
/** @description
|
|
3527
|
-
|
|
3641
|
+
dataType?: "string" | "number" | "boolean" | "date" | "json";
|
|
3642
|
+
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
3643
|
+
projectId?: string;
|
|
3644
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3645
|
+
value?: string;
|
|
3528
3646
|
};
|
|
3529
|
-
|
|
3530
|
-
/** @description
|
|
3531
|
-
|
|
3532
|
-
/** @description
|
|
3533
|
-
|
|
3534
|
-
/** @description
|
|
3535
|
-
connectionId?: string;
|
|
3536
|
-
/** @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. */
|
|
3647
|
+
UpsertTableBySlugDto: {
|
|
3648
|
+
/** @description Display name of the table. */
|
|
3649
|
+
name?: string;
|
|
3650
|
+
/** @description What the table contains. Agents use this to choose a table. */
|
|
3651
|
+
description?: string;
|
|
3652
|
+
/** @description Project ID to scope the table to. Omit for a workspace-wide table. */
|
|
3537
3653
|
projectId?: string;
|
|
3538
|
-
/** @description
|
|
3539
|
-
|
|
3654
|
+
/** @description Column names: [{ key }]. */
|
|
3655
|
+
columns?: {
|
|
3540
3656
|
[key: string]: unknown;
|
|
3541
|
-
};
|
|
3542
|
-
/** @description
|
|
3543
|
-
|
|
3657
|
+
}[];
|
|
3658
|
+
/** @description Rows as objects keyed by column name. */
|
|
3659
|
+
rows?: {
|
|
3660
|
+
[key: string]: unknown;
|
|
3661
|
+
}[];
|
|
3662
|
+
/** @description Stable workspace-unique key. Used as the upsert key. */
|
|
3663
|
+
slug: string;
|
|
3664
|
+
/** @description Marks the table as code-managed. Defaults to true on upsert. */
|
|
3665
|
+
managedByCode?: boolean;
|
|
3544
3666
|
};
|
|
3545
|
-
|
|
3546
|
-
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
3667
|
+
TableProjectDto: {
|
|
3547
3668
|
id: string;
|
|
3548
|
-
|
|
3549
|
-
|
|
3550
|
-
|
|
3551
|
-
|
|
3552
|
-
|
|
3553
|
-
/** @description
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3669
|
+
name: string;
|
|
3670
|
+
};
|
|
3671
|
+
TableColumnDto: {
|
|
3672
|
+
/** @description Column key used in rows. */
|
|
3673
|
+
key: string;
|
|
3674
|
+
/** @description Display label. */
|
|
3675
|
+
label: string;
|
|
3676
|
+
};
|
|
3677
|
+
TableResponseDto: {
|
|
3678
|
+
/** @description Table ID. */
|
|
3679
|
+
id: string;
|
|
3680
|
+
/** @description Display name. */
|
|
3681
|
+
name: string;
|
|
3682
|
+
/** @description Stable key, unique within the workspace. */
|
|
3683
|
+
slug: string;
|
|
3684
|
+
/** @description What the table contains. */
|
|
3685
|
+
description?: string | null;
|
|
3686
|
+
/** @description Whether the table is managed by code (CLI / API upsert). */
|
|
3687
|
+
managedByCode: boolean;
|
|
3688
|
+
/** @description Project the table is scoped to, or null for workspace-wide. */
|
|
3689
|
+
FK_projectId?: string | null;
|
|
3690
|
+
project?: components["schemas"]["TableProjectDto"] | null;
|
|
3691
|
+
/** @description Columns. Returned by get and upsert, not by list. */
|
|
3692
|
+
columns?: components["schemas"]["TableColumnDto"][];
|
|
3693
|
+
/** @description Rows keyed by column key. Returned by get and upsert, not by list. */
|
|
3694
|
+
rows?: {
|
|
3557
3695
|
[key: string]: unknown;
|
|
3558
|
-
}
|
|
3559
|
-
/**
|
|
3560
|
-
|
|
3696
|
+
}[];
|
|
3697
|
+
/** Format: date-time */
|
|
3698
|
+
createdAt: string;
|
|
3699
|
+
/** Format: date-time */
|
|
3700
|
+
updatedAt: string;
|
|
3561
3701
|
};
|
|
3562
|
-
|
|
3563
|
-
/** @description
|
|
3564
|
-
|
|
3565
|
-
/** @description
|
|
3566
|
-
|
|
3567
|
-
|
|
3702
|
+
ConnectionWorkspaceDto: {
|
|
3703
|
+
/** @description Workspace ID. */
|
|
3704
|
+
id: string;
|
|
3705
|
+
/** @description Workspace name. */
|
|
3706
|
+
name: string;
|
|
3707
|
+
};
|
|
3708
|
+
ConnectionResponseDto: {
|
|
3709
|
+
/** @description Connection ID. */
|
|
3710
|
+
id: string;
|
|
3711
|
+
/** @description Connection name. */
|
|
3712
|
+
name: string;
|
|
3713
|
+
/**
|
|
3714
|
+
* Format: date-time
|
|
3715
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3716
|
+
*/
|
|
3717
|
+
createdAt?: string;
|
|
3718
|
+
/**
|
|
3719
|
+
* Format: date-time
|
|
3720
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3721
|
+
*/
|
|
3722
|
+
updatedAt?: string;
|
|
3723
|
+
/** @description App connection type ID (e.g. the OAuth2 or API key connection definition of the app). Included when `expansion=connectionId` is requested. */
|
|
3568
3724
|
connectionId?: string;
|
|
3569
|
-
/** @description
|
|
3570
|
-
|
|
3725
|
+
/** @description ID of the workflow app this connection belongs to. Included when `expansion=workflowAppId` or `expansion=workflowApp` is requested. */
|
|
3726
|
+
workflowAppId?: string;
|
|
3727
|
+
/** @description Full workflow app definition for this connection. Included when `expansion=workflowApp` is requested on the list endpoint. */
|
|
3728
|
+
workflowApp?: {
|
|
3571
3729
|
[key: string]: unknown;
|
|
3572
3730
|
};
|
|
3573
|
-
/** @description
|
|
3574
|
-
|
|
3575
|
-
};
|
|
3576
|
-
StartRunDto: {
|
|
3577
|
-
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
3578
|
-
steps: components["schemas"]["RunStepDto"][];
|
|
3579
|
-
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
3580
|
-
projectId?: string;
|
|
3581
|
-
/** @description Optional display name for the ad-hoc Execution. */
|
|
3582
|
-
name?: string;
|
|
3731
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3732
|
+
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
3583
3733
|
};
|
|
3584
3734
|
TaskListItemResponseDto: {
|
|
3585
3735
|
/**
|
|
@@ -3800,12 +3950,9 @@ interface components {
|
|
|
3800
3950
|
* "imageUrl": "https://example.com/image.png"
|
|
3801
3951
|
* }
|
|
3802
3952
|
*/
|
|
3803
|
-
data?:
|
|
3804
|
-
/** @description URL of an image attached to the message. */
|
|
3805
|
-
imageUrl?: string;
|
|
3806
|
-
};
|
|
3953
|
+
data?: Record<string, never>;
|
|
3807
3954
|
/**
|
|
3808
|
-
* @description Answer to an ask
|
|
3955
|
+
* @description Answer to an "ask before sending" personal-data prompt. Applies to this message only.
|
|
3809
3956
|
* @enum {string}
|
|
3810
3957
|
*/
|
|
3811
3958
|
piiResolution?: "anonymize" | "fallback";
|
|
@@ -4593,168 +4740,297 @@ interface operations {
|
|
|
4593
4740
|
};
|
|
4594
4741
|
};
|
|
4595
4742
|
};
|
|
4596
|
-
QueueItemsController_retryItem: {
|
|
4743
|
+
QueueItemsController_retryItem: {
|
|
4744
|
+
parameters: {
|
|
4745
|
+
query?: {
|
|
4746
|
+
/** @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). */
|
|
4747
|
+
expansion?: string;
|
|
4748
|
+
};
|
|
4749
|
+
header?: never;
|
|
4750
|
+
path: {
|
|
4751
|
+
queueId: string;
|
|
4752
|
+
itemId: string;
|
|
4753
|
+
};
|
|
4754
|
+
cookie?: never;
|
|
4755
|
+
};
|
|
4756
|
+
requestBody?: never;
|
|
4757
|
+
responses: {
|
|
4758
|
+
/** @description The queue item transitioned to RETRYING. */
|
|
4759
|
+
201: {
|
|
4760
|
+
headers: {
|
|
4761
|
+
[name: string]: unknown;
|
|
4762
|
+
};
|
|
4763
|
+
content: {
|
|
4764
|
+
"application/json": components["schemas"]["QueueItemResponseDto"];
|
|
4765
|
+
};
|
|
4766
|
+
};
|
|
4767
|
+
};
|
|
4768
|
+
};
|
|
4769
|
+
QueueItemsController_addError: {
|
|
4770
|
+
parameters: {
|
|
4771
|
+
query?: {
|
|
4772
|
+
/** @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). */
|
|
4773
|
+
expansion?: string;
|
|
4774
|
+
};
|
|
4775
|
+
header?: never;
|
|
4776
|
+
path: {
|
|
4777
|
+
queueId: string;
|
|
4778
|
+
itemId: string;
|
|
4779
|
+
};
|
|
4780
|
+
cookie?: never;
|
|
4781
|
+
};
|
|
4782
|
+
requestBody: {
|
|
4783
|
+
content: {
|
|
4784
|
+
"application/json": components["schemas"]["AddErrorDto"];
|
|
4785
|
+
};
|
|
4786
|
+
};
|
|
4787
|
+
responses: {
|
|
4788
|
+
/** @description The queue item after the error was recorded. */
|
|
4789
|
+
201: {
|
|
4790
|
+
headers: {
|
|
4791
|
+
[name: string]: unknown;
|
|
4792
|
+
};
|
|
4793
|
+
content: {
|
|
4794
|
+
"application/json": components["schemas"]["QueueItemResponseDto"];
|
|
4795
|
+
};
|
|
4796
|
+
};
|
|
4797
|
+
};
|
|
4798
|
+
};
|
|
4799
|
+
ObjectQueueItemsController_listForObject: {
|
|
4800
|
+
parameters: {
|
|
4801
|
+
query?: {
|
|
4802
|
+
/** @description Optional status filter */
|
|
4803
|
+
status?: "PENDING" | "PROCESSING" | "SUCCESS" | "FAILED" | "RETRYING";
|
|
4804
|
+
/** @description Maximum number of items to return. */
|
|
4805
|
+
limit?: number;
|
|
4806
|
+
/** @description Number of items to skip for pagination. */
|
|
4807
|
+
offset?: number;
|
|
4808
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Defaults include queue and object. */
|
|
4809
|
+
expansion?: string;
|
|
4810
|
+
};
|
|
4811
|
+
header?: never;
|
|
4812
|
+
path: {
|
|
4813
|
+
/** @description Object (entity) ID */
|
|
4814
|
+
objectId: string;
|
|
4815
|
+
};
|
|
4816
|
+
cookie?: never;
|
|
4817
|
+
};
|
|
4818
|
+
requestBody?: never;
|
|
4819
|
+
responses: {
|
|
4820
|
+
/** @description Queue items linked to the Object. */
|
|
4821
|
+
200: {
|
|
4822
|
+
headers: {
|
|
4823
|
+
[name: string]: unknown;
|
|
4824
|
+
};
|
|
4825
|
+
content: {
|
|
4826
|
+
"application/json": components["schemas"]["QueueItemListResponseDto"];
|
|
4827
|
+
};
|
|
4828
|
+
};
|
|
4829
|
+
};
|
|
4830
|
+
};
|
|
4831
|
+
WorkflowsController_findAllForWorkspace: {
|
|
4832
|
+
parameters: {
|
|
4833
|
+
query?: {
|
|
4834
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include internal workflows, which are excluded by default. */
|
|
4835
|
+
includeType?: string;
|
|
4836
|
+
/** @description Comma-separated key:value filters. Available: projectId, agentCanTrigger. Example: filterBy=projectId:proj_123 */
|
|
4837
|
+
filterBy?: string;
|
|
4838
|
+
/** @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 */
|
|
4839
|
+
expansion?: string;
|
|
4840
|
+
};
|
|
4841
|
+
header?: never;
|
|
4842
|
+
path?: never;
|
|
4843
|
+
cookie?: never;
|
|
4844
|
+
};
|
|
4845
|
+
requestBody?: never;
|
|
4846
|
+
responses: {
|
|
4847
|
+
/** @description List of workflows. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4848
|
+
200: {
|
|
4849
|
+
headers: {
|
|
4850
|
+
[name: string]: unknown;
|
|
4851
|
+
};
|
|
4852
|
+
content: {
|
|
4853
|
+
"application/json": components["schemas"]["WorkflowResponseDto"][];
|
|
4854
|
+
};
|
|
4855
|
+
};
|
|
4856
|
+
};
|
|
4857
|
+
};
|
|
4858
|
+
WorkflowsController_findOne: {
|
|
4597
4859
|
parameters: {
|
|
4598
4860
|
query?: {
|
|
4599
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt,
|
|
4861
|
+
/** @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 */
|
|
4600
4862
|
expansion?: string;
|
|
4601
4863
|
};
|
|
4602
4864
|
header?: never;
|
|
4603
4865
|
path: {
|
|
4604
|
-
|
|
4605
|
-
itemId: string;
|
|
4866
|
+
workflowId: string;
|
|
4606
4867
|
};
|
|
4607
4868
|
cookie?: never;
|
|
4608
4869
|
};
|
|
4609
4870
|
requestBody?: never;
|
|
4610
4871
|
responses: {
|
|
4611
|
-
/** @description The
|
|
4612
|
-
|
|
4872
|
+
/** @description The workflow. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4873
|
+
200: {
|
|
4613
4874
|
headers: {
|
|
4614
4875
|
[name: string]: unknown;
|
|
4615
4876
|
};
|
|
4616
4877
|
content: {
|
|
4617
|
-
"application/json": components["schemas"]["
|
|
4878
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4618
4879
|
};
|
|
4619
4880
|
};
|
|
4620
4881
|
};
|
|
4621
4882
|
};
|
|
4622
|
-
|
|
4883
|
+
ProjectWorkflowsController_upsertBySlug: {
|
|
4623
4884
|
parameters: {
|
|
4624
|
-
query?:
|
|
4625
|
-
/** @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). */
|
|
4626
|
-
expansion?: string;
|
|
4627
|
-
};
|
|
4885
|
+
query?: never;
|
|
4628
4886
|
header?: never;
|
|
4629
4887
|
path: {
|
|
4630
|
-
|
|
4631
|
-
itemId: string;
|
|
4888
|
+
projectId: string;
|
|
4632
4889
|
};
|
|
4633
4890
|
cookie?: never;
|
|
4634
4891
|
};
|
|
4635
4892
|
requestBody: {
|
|
4636
4893
|
content: {
|
|
4637
|
-
"application/json": components["schemas"]["
|
|
4894
|
+
"application/json": components["schemas"]["UpsertWorkflowBySlugDto"];
|
|
4638
4895
|
};
|
|
4639
4896
|
};
|
|
4640
4897
|
responses: {
|
|
4641
|
-
/** @description The
|
|
4642
|
-
|
|
4898
|
+
/** @description The created or updated workflow. */
|
|
4899
|
+
200: {
|
|
4643
4900
|
headers: {
|
|
4644
4901
|
[name: string]: unknown;
|
|
4645
4902
|
};
|
|
4646
4903
|
content: {
|
|
4647
|
-
"application/json": components["schemas"]["
|
|
4904
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4648
4905
|
};
|
|
4649
4906
|
};
|
|
4650
4907
|
};
|
|
4651
4908
|
};
|
|
4652
|
-
|
|
4909
|
+
AgentsController_findAllForWorkspace: {
|
|
4653
4910
|
parameters: {
|
|
4654
4911
|
query?: {
|
|
4655
|
-
/** @description
|
|
4656
|
-
|
|
4657
|
-
/** @description
|
|
4658
|
-
|
|
4659
|
-
/** @description
|
|
4660
|
-
offset?: number;
|
|
4661
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Defaults include queue and object. */
|
|
4912
|
+
/** @description Comma-separated include flags, e.g. `includeType=all`. Available: all */
|
|
4913
|
+
includeType?: string;
|
|
4914
|
+
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=projectId:<uuid>`. Available: projectId */
|
|
4915
|
+
filterBy?: string;
|
|
4916
|
+
/** @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 */
|
|
4662
4917
|
expansion?: string;
|
|
4663
4918
|
};
|
|
4664
4919
|
header?: never;
|
|
4665
|
-
path
|
|
4666
|
-
/** @description Object (entity) ID */
|
|
4667
|
-
objectId: string;
|
|
4668
|
-
};
|
|
4920
|
+
path?: never;
|
|
4669
4921
|
cookie?: never;
|
|
4670
4922
|
};
|
|
4671
4923
|
requestBody?: never;
|
|
4672
4924
|
responses: {
|
|
4673
|
-
/** @description
|
|
4925
|
+
/** @description Agents in the current workspace */
|
|
4674
4926
|
200: {
|
|
4675
4927
|
headers: {
|
|
4676
4928
|
[name: string]: unknown;
|
|
4677
4929
|
};
|
|
4678
4930
|
content: {
|
|
4679
|
-
"application/json": components["schemas"]["
|
|
4931
|
+
"application/json": components["schemas"]["AgentResponseDto"][];
|
|
4680
4932
|
};
|
|
4681
4933
|
};
|
|
4682
4934
|
};
|
|
4683
4935
|
};
|
|
4684
|
-
|
|
4936
|
+
AgentsController_findOne: {
|
|
4685
4937
|
parameters: {
|
|
4686
4938
|
query?: {
|
|
4687
|
-
/** @description Comma-separated
|
|
4688
|
-
includeType?: string;
|
|
4689
|
-
/** @description Comma-separated key:value filters. Available: projectId, agentCanTrigger. Example: filterBy=projectId:proj_123 */
|
|
4690
|
-
filterBy?: string;
|
|
4691
|
-
/** @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 */
|
|
4939
|
+
/** @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 */
|
|
4692
4940
|
expansion?: string;
|
|
4693
4941
|
};
|
|
4694
4942
|
header?: never;
|
|
4695
|
-
path
|
|
4943
|
+
path: {
|
|
4944
|
+
agentId: string;
|
|
4945
|
+
};
|
|
4696
4946
|
cookie?: never;
|
|
4697
4947
|
};
|
|
4698
4948
|
requestBody?: never;
|
|
4699
4949
|
responses: {
|
|
4700
|
-
/** @description
|
|
4950
|
+
/** @description The requested agent */
|
|
4701
4951
|
200: {
|
|
4702
4952
|
headers: {
|
|
4703
4953
|
[name: string]: unknown;
|
|
4704
4954
|
};
|
|
4705
4955
|
content: {
|
|
4706
|
-
"application/json": components["schemas"]["
|
|
4956
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
4707
4957
|
};
|
|
4708
4958
|
};
|
|
4709
4959
|
};
|
|
4710
4960
|
};
|
|
4711
|
-
|
|
4961
|
+
ProjectAgentsController_upsertBySlug: {
|
|
4712
4962
|
parameters: {
|
|
4713
|
-
query?:
|
|
4714
|
-
/** @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 */
|
|
4715
|
-
expansion?: string;
|
|
4716
|
-
};
|
|
4963
|
+
query?: never;
|
|
4717
4964
|
header?: never;
|
|
4718
4965
|
path: {
|
|
4719
|
-
|
|
4966
|
+
projectId: string;
|
|
4967
|
+
};
|
|
4968
|
+
cookie?: never;
|
|
4969
|
+
};
|
|
4970
|
+
requestBody: {
|
|
4971
|
+
content: {
|
|
4972
|
+
"application/json": components["schemas"]["UpsertAgentBySlugDto"];
|
|
4973
|
+
};
|
|
4974
|
+
};
|
|
4975
|
+
responses: {
|
|
4976
|
+
/** @description The created or updated agent. */
|
|
4977
|
+
200: {
|
|
4978
|
+
headers: {
|
|
4979
|
+
[name: string]: unknown;
|
|
4980
|
+
};
|
|
4981
|
+
content: {
|
|
4982
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
4983
|
+
};
|
|
4720
4984
|
};
|
|
4985
|
+
};
|
|
4986
|
+
};
|
|
4987
|
+
WorkflowAppsController_findAll: {
|
|
4988
|
+
parameters: {
|
|
4989
|
+
query?: never;
|
|
4990
|
+
header?: never;
|
|
4991
|
+
path?: never;
|
|
4721
4992
|
cookie?: never;
|
|
4722
4993
|
};
|
|
4723
4994
|
requestBody?: never;
|
|
4724
4995
|
responses: {
|
|
4725
|
-
/** @description
|
|
4996
|
+
/** @description All workflow app definitions. */
|
|
4726
4997
|
200: {
|
|
4727
4998
|
headers: {
|
|
4728
4999
|
[name: string]: unknown;
|
|
4729
5000
|
};
|
|
4730
5001
|
content: {
|
|
4731
|
-
"application/json": components["schemas"]["
|
|
5002
|
+
"application/json": components["schemas"]["WorkflowAppResponseDto"][];
|
|
4732
5003
|
};
|
|
4733
5004
|
};
|
|
4734
5005
|
};
|
|
4735
5006
|
};
|
|
4736
|
-
|
|
5007
|
+
WorkflowAppsController_connectApp: {
|
|
4737
5008
|
parameters: {
|
|
4738
5009
|
query?: never;
|
|
4739
5010
|
header?: never;
|
|
4740
5011
|
path: {
|
|
4741
|
-
|
|
5012
|
+
appId: string;
|
|
5013
|
+
connectionId: string;
|
|
4742
5014
|
};
|
|
4743
5015
|
cookie?: never;
|
|
4744
5016
|
};
|
|
4745
5017
|
requestBody: {
|
|
4746
5018
|
content: {
|
|
4747
|
-
"application/json":
|
|
5019
|
+
"application/json": {
|
|
5020
|
+
[key: string]: unknown;
|
|
5021
|
+
};
|
|
4748
5022
|
};
|
|
4749
5023
|
};
|
|
4750
5024
|
responses: {
|
|
4751
|
-
/** @description
|
|
5025
|
+
/** @description Result of the connection attempt, written by the app connection handler. */
|
|
4752
5026
|
200: {
|
|
4753
5027
|
headers: {
|
|
4754
5028
|
[name: string]: unknown;
|
|
4755
5029
|
};
|
|
4756
5030
|
content: {
|
|
4757
|
-
"application/json":
|
|
5031
|
+
"application/json": {
|
|
5032
|
+
[key: string]: unknown;
|
|
5033
|
+
};
|
|
4758
5034
|
};
|
|
4759
5035
|
};
|
|
4760
5036
|
};
|
|
@@ -4762,8 +5038,10 @@ interface operations {
|
|
|
4762
5038
|
ObjectTypesController_findAll: {
|
|
4763
5039
|
parameters: {
|
|
4764
5040
|
query?: {
|
|
4765
|
-
/** @description Set to true to include disabled entity types. */
|
|
5041
|
+
/** @description Set to true to include disabled entity types the workspace is granted. */
|
|
4766
5042
|
includeDisabled?: boolean;
|
|
5043
|
+
/** @description Set to true to include enabled types that are not granted to the active workspace. */
|
|
5044
|
+
includeCatalog?: boolean;
|
|
4767
5045
|
/** @description Comma-separated fields to expand. Available: description, attributeSchema, stateSchema, createdAt, updatedAt, createdBy, countObjects. */
|
|
4768
5046
|
expansion?: string;
|
|
4769
5047
|
};
|
|
@@ -4866,6 +5144,8 @@ interface operations {
|
|
|
4866
5144
|
query?: {
|
|
4867
5145
|
/** @description Filter by entity type ID. */
|
|
4868
5146
|
objectTypeId?: string;
|
|
5147
|
+
/** @description Platform admin only. Limit records to this workspace. Omit to list every workspace. */
|
|
5148
|
+
workspaceId?: string;
|
|
4869
5149
|
/** @description Filter by entity type slug. */
|
|
4870
5150
|
objectTypeSlug?: string;
|
|
4871
5151
|
/** @description Filter by a single state ID. */
|
|
@@ -4882,7 +5162,7 @@ interface operations {
|
|
|
4882
5162
|
page?: number;
|
|
4883
5163
|
/** @description Items per page. Defaults to 25, capped at 100. */
|
|
4884
5164
|
pageSize?: number;
|
|
4885
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
5165
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4886
5166
|
expansion?: string;
|
|
4887
5167
|
};
|
|
4888
5168
|
header?: never;
|
|
@@ -4905,7 +5185,7 @@ interface operations {
|
|
|
4905
5185
|
ObjectsController_create: {
|
|
4906
5186
|
parameters: {
|
|
4907
5187
|
query?: {
|
|
4908
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
5188
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4909
5189
|
expansion?: string;
|
|
4910
5190
|
};
|
|
4911
5191
|
header?: never;
|
|
@@ -4932,7 +5212,7 @@ interface operations {
|
|
|
4932
5212
|
ObjectsController_findOne: {
|
|
4933
5213
|
parameters: {
|
|
4934
5214
|
query?: {
|
|
4935
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
5215
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4936
5216
|
expansion?: string;
|
|
4937
5217
|
};
|
|
4938
5218
|
header?: never;
|
|
@@ -4979,7 +5259,7 @@ interface operations {
|
|
|
4979
5259
|
ObjectsController_update: {
|
|
4980
5260
|
parameters: {
|
|
4981
5261
|
query?: {
|
|
4982
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
5262
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4983
5263
|
expansion?: string;
|
|
4984
5264
|
};
|
|
4985
5265
|
header?: never;
|
|
@@ -5192,350 +5472,369 @@ interface operations {
|
|
|
5192
5472
|
};
|
|
5193
5473
|
};
|
|
5194
5474
|
};
|
|
5195
|
-
|
|
5475
|
+
KnowledgeController_findAllForWorkspace: {
|
|
5196
5476
|
parameters: {
|
|
5197
|
-
query?:
|
|
5477
|
+
query?: {
|
|
5478
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5479
|
+
expansion?: string;
|
|
5480
|
+
};
|
|
5198
5481
|
header?: never;
|
|
5199
5482
|
path?: never;
|
|
5200
5483
|
cookie?: never;
|
|
5201
5484
|
};
|
|
5202
5485
|
requestBody?: never;
|
|
5203
5486
|
responses: {
|
|
5204
|
-
/** @description
|
|
5487
|
+
/** @description Knowledge bases in the workspace. */
|
|
5205
5488
|
200: {
|
|
5206
5489
|
headers: {
|
|
5207
5490
|
[name: string]: unknown;
|
|
5208
5491
|
};
|
|
5209
5492
|
content: {
|
|
5210
|
-
"application/json": components["schemas"]["
|
|
5493
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"][];
|
|
5211
5494
|
};
|
|
5212
5495
|
};
|
|
5213
5496
|
};
|
|
5214
5497
|
};
|
|
5215
|
-
|
|
5498
|
+
KnowledgeController_create: {
|
|
5216
5499
|
parameters: {
|
|
5217
|
-
query?:
|
|
5218
|
-
|
|
5219
|
-
|
|
5220
|
-
appId: string;
|
|
5221
|
-
connectionId: string;
|
|
5500
|
+
query?: {
|
|
5501
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5502
|
+
expansion?: string;
|
|
5222
5503
|
};
|
|
5504
|
+
header?: never;
|
|
5505
|
+
path?: never;
|
|
5223
5506
|
cookie?: never;
|
|
5224
5507
|
};
|
|
5225
5508
|
requestBody: {
|
|
5226
5509
|
content: {
|
|
5227
|
-
"application/json":
|
|
5228
|
-
[key: string]: unknown;
|
|
5229
|
-
};
|
|
5510
|
+
"application/json": components["schemas"]["CreateKnowledgeDto"];
|
|
5230
5511
|
};
|
|
5231
5512
|
};
|
|
5232
5513
|
responses: {
|
|
5233
|
-
/** @description
|
|
5234
|
-
|
|
5514
|
+
/** @description The created knowledge base. */
|
|
5515
|
+
201: {
|
|
5235
5516
|
headers: {
|
|
5236
5517
|
[name: string]: unknown;
|
|
5237
5518
|
};
|
|
5238
5519
|
content: {
|
|
5239
|
-
"application/json":
|
|
5240
|
-
[key: string]: unknown;
|
|
5241
|
-
};
|
|
5520
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5242
5521
|
};
|
|
5243
5522
|
};
|
|
5244
5523
|
};
|
|
5245
5524
|
};
|
|
5246
|
-
|
|
5525
|
+
KnowledgeController_findOne: {
|
|
5247
5526
|
parameters: {
|
|
5248
5527
|
query?: {
|
|
5249
|
-
/** @description Comma-separated
|
|
5250
|
-
includeType?: string;
|
|
5251
|
-
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=projectId:<uuid>`. Available: projectId */
|
|
5252
|
-
filterBy?: string;
|
|
5253
|
-
/** @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 */
|
|
5528
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5254
5529
|
expansion?: string;
|
|
5255
5530
|
};
|
|
5256
5531
|
header?: never;
|
|
5257
|
-
path
|
|
5532
|
+
path: {
|
|
5533
|
+
knowledgeId: string;
|
|
5534
|
+
};
|
|
5258
5535
|
cookie?: never;
|
|
5259
5536
|
};
|
|
5260
5537
|
requestBody?: never;
|
|
5261
5538
|
responses: {
|
|
5262
|
-
/** @description
|
|
5539
|
+
/** @description The requested knowledge base. */
|
|
5263
5540
|
200: {
|
|
5264
5541
|
headers: {
|
|
5265
5542
|
[name: string]: unknown;
|
|
5266
5543
|
};
|
|
5267
5544
|
content: {
|
|
5268
|
-
"application/json": components["schemas"]["
|
|
5545
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5269
5546
|
};
|
|
5270
5547
|
};
|
|
5271
5548
|
};
|
|
5272
5549
|
};
|
|
5273
|
-
|
|
5550
|
+
KnowledgeController_delete: {
|
|
5551
|
+
parameters: {
|
|
5552
|
+
query?: never;
|
|
5553
|
+
header?: never;
|
|
5554
|
+
path: {
|
|
5555
|
+
knowledgeId: string;
|
|
5556
|
+
};
|
|
5557
|
+
cookie?: never;
|
|
5558
|
+
};
|
|
5559
|
+
requestBody?: never;
|
|
5560
|
+
responses: {
|
|
5561
|
+
/** @description Returns true when the knowledge base was deleted. */
|
|
5562
|
+
200: {
|
|
5563
|
+
headers: {
|
|
5564
|
+
[name: string]: unknown;
|
|
5565
|
+
};
|
|
5566
|
+
content: {
|
|
5567
|
+
"application/json": boolean;
|
|
5568
|
+
};
|
|
5569
|
+
};
|
|
5570
|
+
};
|
|
5571
|
+
};
|
|
5572
|
+
KnowledgeController_update: {
|
|
5274
5573
|
parameters: {
|
|
5275
5574
|
query?: {
|
|
5276
|
-
/** @description Comma-separated fields to expand
|
|
5575
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5277
5576
|
expansion?: string;
|
|
5278
5577
|
};
|
|
5279
5578
|
header?: never;
|
|
5280
5579
|
path: {
|
|
5281
|
-
|
|
5580
|
+
knowledgeId: string;
|
|
5282
5581
|
};
|
|
5283
5582
|
cookie?: never;
|
|
5284
5583
|
};
|
|
5285
|
-
requestBody
|
|
5584
|
+
requestBody: {
|
|
5585
|
+
content: {
|
|
5586
|
+
"application/json": components["schemas"]["UpdateKnowledgeDto"];
|
|
5587
|
+
};
|
|
5588
|
+
};
|
|
5286
5589
|
responses: {
|
|
5287
|
-
/** @description The
|
|
5590
|
+
/** @description The updated knowledge base. */
|
|
5288
5591
|
200: {
|
|
5289
5592
|
headers: {
|
|
5290
5593
|
[name: string]: unknown;
|
|
5291
5594
|
};
|
|
5292
5595
|
content: {
|
|
5293
|
-
"application/json": components["schemas"]["
|
|
5596
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5294
5597
|
};
|
|
5295
5598
|
};
|
|
5296
5599
|
};
|
|
5297
5600
|
};
|
|
5298
|
-
|
|
5601
|
+
KnowledgeController_saveUploadedTextToKnowledge: {
|
|
5299
5602
|
parameters: {
|
|
5300
5603
|
query?: never;
|
|
5301
5604
|
header?: never;
|
|
5302
5605
|
path: {
|
|
5303
|
-
|
|
5606
|
+
knowledgeId: string;
|
|
5304
5607
|
};
|
|
5305
5608
|
cookie?: never;
|
|
5306
5609
|
};
|
|
5307
5610
|
requestBody: {
|
|
5308
5611
|
content: {
|
|
5309
|
-
"application/json": components["schemas"]["
|
|
5612
|
+
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5310
5613
|
};
|
|
5311
5614
|
};
|
|
5312
5615
|
responses: {
|
|
5313
|
-
/** @description
|
|
5314
|
-
|
|
5616
|
+
/** @description Returns true when the text was embedded and stored. */
|
|
5617
|
+
201: {
|
|
5315
5618
|
headers: {
|
|
5316
5619
|
[name: string]: unknown;
|
|
5317
5620
|
};
|
|
5318
5621
|
content: {
|
|
5319
|
-
"application/json":
|
|
5622
|
+
"application/json": boolean;
|
|
5320
5623
|
};
|
|
5321
5624
|
};
|
|
5322
5625
|
};
|
|
5323
5626
|
};
|
|
5324
|
-
|
|
5627
|
+
KnowledgeController_getDocuments: {
|
|
5325
5628
|
parameters: {
|
|
5326
|
-
query?:
|
|
5327
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5328
|
-
expansion?: string;
|
|
5329
|
-
};
|
|
5629
|
+
query?: never;
|
|
5330
5630
|
header?: never;
|
|
5331
|
-
path
|
|
5631
|
+
path: {
|
|
5632
|
+
knowledgeId: string;
|
|
5633
|
+
};
|
|
5332
5634
|
cookie?: never;
|
|
5333
5635
|
};
|
|
5334
5636
|
requestBody?: never;
|
|
5335
5637
|
responses: {
|
|
5336
|
-
/** @description
|
|
5638
|
+
/** @description Documents in the knowledge base, newest first. */
|
|
5337
5639
|
200: {
|
|
5338
5640
|
headers: {
|
|
5339
5641
|
[name: string]: unknown;
|
|
5340
5642
|
};
|
|
5341
5643
|
content: {
|
|
5342
|
-
"application/json": components["schemas"]["
|
|
5644
|
+
"application/json": components["schemas"]["KnowledgeDocumentResponseDto"][];
|
|
5343
5645
|
};
|
|
5344
5646
|
};
|
|
5345
5647
|
};
|
|
5346
5648
|
};
|
|
5347
|
-
|
|
5649
|
+
KnowledgeController_getDocumentGroup: {
|
|
5348
5650
|
parameters: {
|
|
5349
|
-
query?:
|
|
5350
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5351
|
-
expansion?: string;
|
|
5352
|
-
};
|
|
5651
|
+
query?: never;
|
|
5353
5652
|
header?: never;
|
|
5354
|
-
path
|
|
5355
|
-
|
|
5356
|
-
};
|
|
5357
|
-
requestBody: {
|
|
5358
|
-
content: {
|
|
5359
|
-
"application/json": components["schemas"]["CreateKnowledgeDto"];
|
|
5653
|
+
path: {
|
|
5654
|
+
groupId: string;
|
|
5360
5655
|
};
|
|
5656
|
+
cookie?: never;
|
|
5361
5657
|
};
|
|
5658
|
+
requestBody?: never;
|
|
5362
5659
|
responses: {
|
|
5363
|
-
/** @description The
|
|
5364
|
-
|
|
5660
|
+
/** @description The requested document group. */
|
|
5661
|
+
200: {
|
|
5365
5662
|
headers: {
|
|
5366
5663
|
[name: string]: unknown;
|
|
5367
5664
|
};
|
|
5368
5665
|
content: {
|
|
5369
|
-
"application/json": components["schemas"]["
|
|
5666
|
+
"application/json": components["schemas"]["KnowledgeDocumentGroupResponseDto"];
|
|
5370
5667
|
};
|
|
5371
5668
|
};
|
|
5372
5669
|
};
|
|
5373
5670
|
};
|
|
5374
|
-
|
|
5671
|
+
KnowledgeController_deleteDocumentGroup: {
|
|
5375
5672
|
parameters: {
|
|
5376
|
-
query?:
|
|
5377
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5378
|
-
expansion?: string;
|
|
5379
|
-
};
|
|
5673
|
+
query?: never;
|
|
5380
5674
|
header?: never;
|
|
5381
5675
|
path: {
|
|
5382
5676
|
knowledgeId: string;
|
|
5677
|
+
groupId: string;
|
|
5383
5678
|
};
|
|
5384
5679
|
cookie?: never;
|
|
5385
5680
|
};
|
|
5386
5681
|
requestBody?: never;
|
|
5387
5682
|
responses: {
|
|
5388
|
-
/** @description
|
|
5683
|
+
/** @description Returns true when the document group was deleted. */
|
|
5389
5684
|
200: {
|
|
5390
5685
|
headers: {
|
|
5391
5686
|
[name: string]: unknown;
|
|
5392
5687
|
};
|
|
5393
5688
|
content: {
|
|
5394
|
-
"application/json":
|
|
5689
|
+
"application/json": boolean;
|
|
5395
5690
|
};
|
|
5396
5691
|
};
|
|
5397
5692
|
};
|
|
5398
5693
|
};
|
|
5399
|
-
|
|
5694
|
+
ExecutionsController_manuallyExecuteWorkflow: {
|
|
5400
5695
|
parameters: {
|
|
5401
5696
|
query?: never;
|
|
5402
5697
|
header?: never;
|
|
5403
5698
|
path: {
|
|
5404
|
-
|
|
5699
|
+
workflowId: string;
|
|
5405
5700
|
};
|
|
5406
5701
|
cookie?: never;
|
|
5407
5702
|
};
|
|
5408
|
-
requestBody
|
|
5703
|
+
requestBody: {
|
|
5704
|
+
content: {
|
|
5705
|
+
"application/json": components["schemas"]["ManuallyRunWorkflowInputDataDto"];
|
|
5706
|
+
};
|
|
5707
|
+
};
|
|
5409
5708
|
responses: {
|
|
5410
|
-
/** @description
|
|
5411
|
-
|
|
5709
|
+
/** @description The newly created execution. Only the execution ID is returned; poll GET /executions/{executionId} to track progress. */
|
|
5710
|
+
201: {
|
|
5412
5711
|
headers: {
|
|
5413
5712
|
[name: string]: unknown;
|
|
5414
5713
|
};
|
|
5415
5714
|
content: {
|
|
5416
|
-
"application/json":
|
|
5715
|
+
"application/json": components["schemas"]["ExecuteWorkflowResponseDto"];
|
|
5417
5716
|
};
|
|
5418
5717
|
};
|
|
5419
5718
|
};
|
|
5420
5719
|
};
|
|
5421
|
-
|
|
5720
|
+
ExecutionsController_findAll: {
|
|
5422
5721
|
parameters: {
|
|
5423
5722
|
query?: {
|
|
5424
|
-
/** @description Comma-separated
|
|
5723
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include executions of internal workflows, which are excluded by default. */
|
|
5724
|
+
includeType?: string;
|
|
5725
|
+
/** @description Comma-separated key:value filters. Available: projectId, workflowId, source (WORKFLOW|SDK), objectId. Example: filterBy=workflowId:wf_123 or filterBy=objectId:<uuid> */
|
|
5726
|
+
filterBy?: string;
|
|
5727
|
+
/** @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 */
|
|
5425
5728
|
expansion?: string;
|
|
5426
5729
|
};
|
|
5427
5730
|
header?: never;
|
|
5428
|
-
path
|
|
5429
|
-
knowledgeId: string;
|
|
5430
|
-
};
|
|
5731
|
+
path?: never;
|
|
5431
5732
|
cookie?: never;
|
|
5432
5733
|
};
|
|
5433
|
-
requestBody
|
|
5434
|
-
content: {
|
|
5435
|
-
"application/json": components["schemas"]["UpdateKnowledgeDto"];
|
|
5436
|
-
};
|
|
5437
|
-
};
|
|
5734
|
+
requestBody?: never;
|
|
5438
5735
|
responses: {
|
|
5439
|
-
/** @description
|
|
5736
|
+
/** @description List of executions. Fields beyond the ID are included according to the expansion query parameter. */
|
|
5440
5737
|
200: {
|
|
5441
5738
|
headers: {
|
|
5442
5739
|
[name: string]: unknown;
|
|
5443
5740
|
};
|
|
5444
5741
|
content: {
|
|
5445
|
-
"application/json": components["schemas"]["
|
|
5742
|
+
"application/json": components["schemas"]["ExecutionResponseDto"][];
|
|
5446
5743
|
};
|
|
5447
5744
|
};
|
|
5448
5745
|
};
|
|
5449
5746
|
};
|
|
5450
|
-
|
|
5747
|
+
ExecutionsController_findOne: {
|
|
5451
5748
|
parameters: {
|
|
5452
|
-
query?:
|
|
5749
|
+
query?: {
|
|
5750
|
+
/** @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 */
|
|
5751
|
+
expansion?: string;
|
|
5752
|
+
};
|
|
5453
5753
|
header?: never;
|
|
5454
5754
|
path: {
|
|
5455
|
-
|
|
5755
|
+
executionId: string;
|
|
5456
5756
|
};
|
|
5457
5757
|
cookie?: never;
|
|
5458
5758
|
};
|
|
5459
|
-
requestBody
|
|
5460
|
-
content: {
|
|
5461
|
-
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5462
|
-
};
|
|
5463
|
-
};
|
|
5759
|
+
requestBody?: never;
|
|
5464
5760
|
responses: {
|
|
5465
|
-
/** @description
|
|
5466
|
-
|
|
5761
|
+
/** @description The execution. Fields beyond the ID and startedAt are included according to the expansion query parameter. */
|
|
5762
|
+
200: {
|
|
5467
5763
|
headers: {
|
|
5468
5764
|
[name: string]: unknown;
|
|
5469
5765
|
};
|
|
5470
5766
|
content: {
|
|
5471
|
-
"application/json":
|
|
5767
|
+
"application/json": components["schemas"]["ExecutionResponseDto"];
|
|
5472
5768
|
};
|
|
5473
5769
|
};
|
|
5474
5770
|
};
|
|
5475
5771
|
};
|
|
5476
|
-
|
|
5772
|
+
ExecutionsController_streamExecution: {
|
|
5477
5773
|
parameters: {
|
|
5478
5774
|
query?: never;
|
|
5479
5775
|
header?: never;
|
|
5480
5776
|
path: {
|
|
5481
|
-
|
|
5777
|
+
executionId: string;
|
|
5482
5778
|
};
|
|
5483
5779
|
cookie?: never;
|
|
5484
5780
|
};
|
|
5485
5781
|
requestBody?: never;
|
|
5486
5782
|
responses: {
|
|
5487
|
-
/** @description
|
|
5783
|
+
/** @description SSE stream of execution progress, loop progress, finished, and heartbeat events */
|
|
5488
5784
|
200: {
|
|
5489
5785
|
headers: {
|
|
5490
5786
|
[name: string]: unknown;
|
|
5491
5787
|
};
|
|
5492
5788
|
content: {
|
|
5493
|
-
"
|
|
5789
|
+
"text/event-stream": string;
|
|
5494
5790
|
};
|
|
5495
5791
|
};
|
|
5496
5792
|
};
|
|
5497
5793
|
};
|
|
5498
|
-
|
|
5794
|
+
ActionsController_run: {
|
|
5499
5795
|
parameters: {
|
|
5500
5796
|
query?: never;
|
|
5501
5797
|
header?: never;
|
|
5502
|
-
path
|
|
5503
|
-
groupId: string;
|
|
5504
|
-
};
|
|
5798
|
+
path?: never;
|
|
5505
5799
|
cookie?: never;
|
|
5506
5800
|
};
|
|
5507
|
-
requestBody
|
|
5801
|
+
requestBody: {
|
|
5802
|
+
content: {
|
|
5803
|
+
"application/json": components["schemas"]["RunActionDto"];
|
|
5804
|
+
};
|
|
5805
|
+
};
|
|
5508
5806
|
responses: {
|
|
5509
|
-
/** @description The
|
|
5510
|
-
|
|
5807
|
+
/** @description The ad-hoc Execution id plus the synchronous action result (status, output, single-step executionPath). */
|
|
5808
|
+
201: {
|
|
5511
5809
|
headers: {
|
|
5512
5810
|
[name: string]: unknown;
|
|
5513
5811
|
};
|
|
5514
5812
|
content: {
|
|
5515
|
-
"application/json": components["schemas"]["
|
|
5813
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5516
5814
|
};
|
|
5517
5815
|
};
|
|
5518
5816
|
};
|
|
5519
5817
|
};
|
|
5520
|
-
|
|
5818
|
+
RunsController_start: {
|
|
5521
5819
|
parameters: {
|
|
5522
5820
|
query?: never;
|
|
5523
5821
|
header?: never;
|
|
5524
|
-
path
|
|
5525
|
-
knowledgeId: string;
|
|
5526
|
-
groupId: string;
|
|
5527
|
-
};
|
|
5822
|
+
path?: never;
|
|
5528
5823
|
cookie?: never;
|
|
5529
5824
|
};
|
|
5530
|
-
requestBody
|
|
5825
|
+
requestBody: {
|
|
5826
|
+
content: {
|
|
5827
|
+
"application/json": components["schemas"]["StartRunDto"];
|
|
5828
|
+
};
|
|
5829
|
+
};
|
|
5531
5830
|
responses: {
|
|
5532
|
-
/** @description
|
|
5533
|
-
|
|
5831
|
+
/** @description The ad-hoc Execution id plus the synchronous multi-step result (status, last-step output, executionPath). */
|
|
5832
|
+
201: {
|
|
5534
5833
|
headers: {
|
|
5535
5834
|
[name: string]: unknown;
|
|
5536
5835
|
};
|
|
5537
5836
|
content: {
|
|
5538
|
-
"application/json":
|
|
5837
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5539
5838
|
};
|
|
5540
5839
|
};
|
|
5541
5840
|
};
|
|
@@ -5670,15 +5969,10 @@ interface operations {
|
|
|
5670
5969
|
};
|
|
5671
5970
|
};
|
|
5672
5971
|
};
|
|
5673
|
-
|
|
5972
|
+
TablesController_findAll: {
|
|
5674
5973
|
parameters: {
|
|
5675
5974
|
query?: {
|
|
5676
|
-
|
|
5677
|
-
includeType?: string;
|
|
5678
|
-
/** @description Comma-separated key:value filters. Available: workflowAppId. Example: filterBy=workflowAppId:gmail */
|
|
5679
|
-
filterBy?: string;
|
|
5680
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
5681
|
-
expansion?: string;
|
|
5975
|
+
projectId?: string;
|
|
5682
5976
|
};
|
|
5683
5977
|
header?: never;
|
|
5684
5978
|
path?: never;
|
|
@@ -5686,186 +5980,133 @@ interface operations {
|
|
|
5686
5980
|
};
|
|
5687
5981
|
requestBody?: never;
|
|
5688
5982
|
responses: {
|
|
5689
|
-
/** @description
|
|
5690
|
-
200: {
|
|
5691
|
-
headers: {
|
|
5692
|
-
[name: string]: unknown;
|
|
5693
|
-
};
|
|
5694
|
-
content: {
|
|
5695
|
-
"application/json": components["schemas"]["ConnectionResponseDto"][];
|
|
5696
|
-
};
|
|
5697
|
-
};
|
|
5698
|
-
};
|
|
5699
|
-
};
|
|
5700
|
-
ConnectionsController_findOne: {
|
|
5701
|
-
parameters: {
|
|
5702
|
-
query?: {
|
|
5703
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
5704
|
-
expansion?: string;
|
|
5705
|
-
};
|
|
5706
|
-
header?: never;
|
|
5707
|
-
path: {
|
|
5708
|
-
connectionId: string;
|
|
5709
|
-
};
|
|
5710
|
-
cookie?: never;
|
|
5711
|
-
};
|
|
5712
|
-
requestBody?: never;
|
|
5713
|
-
responses: {
|
|
5714
|
-
/** @description The requested connection. */
|
|
5983
|
+
/** @description Tables in the workspace. */
|
|
5715
5984
|
200: {
|
|
5716
5985
|
headers: {
|
|
5717
5986
|
[name: string]: unknown;
|
|
5718
5987
|
};
|
|
5719
5988
|
content: {
|
|
5720
|
-
"application/json": components["schemas"]["
|
|
5989
|
+
"application/json": components["schemas"]["TableResponseDto"][];
|
|
5721
5990
|
};
|
|
5722
5991
|
};
|
|
5723
5992
|
};
|
|
5724
5993
|
};
|
|
5725
|
-
|
|
5994
|
+
TablesController_upsertBySlug: {
|
|
5726
5995
|
parameters: {
|
|
5727
5996
|
query?: never;
|
|
5728
5997
|
header?: never;
|
|
5729
|
-
path
|
|
5730
|
-
workflowId: string;
|
|
5731
|
-
};
|
|
5998
|
+
path?: never;
|
|
5732
5999
|
cookie?: never;
|
|
5733
6000
|
};
|
|
5734
6001
|
requestBody: {
|
|
5735
6002
|
content: {
|
|
5736
|
-
"application/json": components["schemas"]["
|
|
5737
|
-
};
|
|
5738
|
-
};
|
|
5739
|
-
responses: {
|
|
5740
|
-
/** @description The newly created execution. Only the execution ID is returned; poll GET /executions/{executionId} to track progress. */
|
|
5741
|
-
201: {
|
|
5742
|
-
headers: {
|
|
5743
|
-
[name: string]: unknown;
|
|
5744
|
-
};
|
|
5745
|
-
content: {
|
|
5746
|
-
"application/json": components["schemas"]["ExecuteWorkflowResponseDto"];
|
|
5747
|
-
};
|
|
5748
|
-
};
|
|
5749
|
-
};
|
|
5750
|
-
};
|
|
5751
|
-
ExecutionsController_findAll: {
|
|
5752
|
-
parameters: {
|
|
5753
|
-
query?: {
|
|
5754
|
-
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include executions of internal workflows, which are excluded by default. */
|
|
5755
|
-
includeType?: string;
|
|
5756
|
-
/** @description Comma-separated key:value filters. Available: projectId, workflowId, source (WORKFLOW|SDK). Example: filterBy=workflowId:wf_123 or filterBy=source:SDK */
|
|
5757
|
-
filterBy?: string;
|
|
5758
|
-
/** @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 */
|
|
5759
|
-
expansion?: string;
|
|
6003
|
+
"application/json": components["schemas"]["UpsertTableBySlugDto"];
|
|
5760
6004
|
};
|
|
5761
|
-
header?: never;
|
|
5762
|
-
path?: never;
|
|
5763
|
-
cookie?: never;
|
|
5764
6005
|
};
|
|
5765
|
-
requestBody?: never;
|
|
5766
6006
|
responses: {
|
|
5767
|
-
/** @description
|
|
6007
|
+
/** @description The created or updated table, including columns and rows. */
|
|
5768
6008
|
200: {
|
|
5769
6009
|
headers: {
|
|
5770
6010
|
[name: string]: unknown;
|
|
5771
6011
|
};
|
|
5772
6012
|
content: {
|
|
5773
|
-
"application/json": components["schemas"]["
|
|
6013
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5774
6014
|
};
|
|
5775
6015
|
};
|
|
5776
6016
|
};
|
|
5777
6017
|
};
|
|
5778
|
-
|
|
6018
|
+
TablesController_findBySlug: {
|
|
5779
6019
|
parameters: {
|
|
5780
|
-
query?:
|
|
5781
|
-
/** @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 */
|
|
5782
|
-
expansion?: string;
|
|
5783
|
-
};
|
|
6020
|
+
query?: never;
|
|
5784
6021
|
header?: never;
|
|
5785
6022
|
path: {
|
|
5786
|
-
|
|
6023
|
+
slug: string;
|
|
5787
6024
|
};
|
|
5788
6025
|
cookie?: never;
|
|
5789
6026
|
};
|
|
5790
6027
|
requestBody?: never;
|
|
5791
6028
|
responses: {
|
|
5792
|
-
/** @description The
|
|
6029
|
+
/** @description The requested table. */
|
|
5793
6030
|
200: {
|
|
5794
6031
|
headers: {
|
|
5795
6032
|
[name: string]: unknown;
|
|
5796
6033
|
};
|
|
5797
6034
|
content: {
|
|
5798
|
-
"application/json": components["schemas"]["
|
|
6035
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5799
6036
|
};
|
|
5800
6037
|
};
|
|
5801
6038
|
};
|
|
5802
6039
|
};
|
|
5803
|
-
|
|
6040
|
+
TablesController_findOne: {
|
|
5804
6041
|
parameters: {
|
|
5805
6042
|
query?: never;
|
|
5806
6043
|
header?: never;
|
|
5807
6044
|
path: {
|
|
5808
|
-
|
|
6045
|
+
tableId: string;
|
|
5809
6046
|
};
|
|
5810
6047
|
cookie?: never;
|
|
5811
6048
|
};
|
|
5812
6049
|
requestBody?: never;
|
|
5813
6050
|
responses: {
|
|
5814
|
-
/** @description
|
|
6051
|
+
/** @description The requested table. */
|
|
5815
6052
|
200: {
|
|
5816
6053
|
headers: {
|
|
5817
6054
|
[name: string]: unknown;
|
|
5818
6055
|
};
|
|
5819
6056
|
content: {
|
|
5820
|
-
"
|
|
6057
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5821
6058
|
};
|
|
5822
6059
|
};
|
|
5823
6060
|
};
|
|
5824
6061
|
};
|
|
5825
|
-
|
|
6062
|
+
ConnectionsController_findAllForWorkspace: {
|
|
5826
6063
|
parameters: {
|
|
5827
|
-
query?:
|
|
6064
|
+
query?: {
|
|
6065
|
+
/** @description Comma-separated include flags. Available: all */
|
|
6066
|
+
includeType?: string;
|
|
6067
|
+
/** @description Comma-separated key:value filters. Available: workflowAppId. Example: filterBy=workflowAppId:gmail */
|
|
6068
|
+
filterBy?: string;
|
|
6069
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
6070
|
+
expansion?: string;
|
|
6071
|
+
};
|
|
5828
6072
|
header?: never;
|
|
5829
6073
|
path?: never;
|
|
5830
6074
|
cookie?: never;
|
|
5831
6075
|
};
|
|
5832
|
-
requestBody
|
|
5833
|
-
content: {
|
|
5834
|
-
"application/json": components["schemas"]["RunActionDto"];
|
|
5835
|
-
};
|
|
5836
|
-
};
|
|
6076
|
+
requestBody?: never;
|
|
5837
6077
|
responses: {
|
|
5838
|
-
/** @description
|
|
5839
|
-
|
|
6078
|
+
/** @description Connections available in the workspace. */
|
|
6079
|
+
200: {
|
|
5840
6080
|
headers: {
|
|
5841
6081
|
[name: string]: unknown;
|
|
5842
6082
|
};
|
|
5843
6083
|
content: {
|
|
5844
|
-
"application/json": components["schemas"]["
|
|
6084
|
+
"application/json": components["schemas"]["ConnectionResponseDto"][];
|
|
5845
6085
|
};
|
|
5846
6086
|
};
|
|
5847
6087
|
};
|
|
5848
6088
|
};
|
|
5849
|
-
|
|
6089
|
+
ConnectionsController_findOne: {
|
|
5850
6090
|
parameters: {
|
|
5851
|
-
query?:
|
|
6091
|
+
query?: {
|
|
6092
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
6093
|
+
expansion?: string;
|
|
6094
|
+
};
|
|
5852
6095
|
header?: never;
|
|
5853
|
-
path
|
|
5854
|
-
|
|
5855
|
-
};
|
|
5856
|
-
requestBody: {
|
|
5857
|
-
content: {
|
|
5858
|
-
"application/json": components["schemas"]["StartRunDto"];
|
|
6096
|
+
path: {
|
|
6097
|
+
connectionId: string;
|
|
5859
6098
|
};
|
|
6099
|
+
cookie?: never;
|
|
5860
6100
|
};
|
|
6101
|
+
requestBody?: never;
|
|
5861
6102
|
responses: {
|
|
5862
|
-
/** @description The
|
|
5863
|
-
|
|
6103
|
+
/** @description The requested connection. */
|
|
6104
|
+
200: {
|
|
5864
6105
|
headers: {
|
|
5865
6106
|
[name: string]: unknown;
|
|
5866
6107
|
};
|
|
5867
6108
|
content: {
|
|
5868
|
-
"application/json": components["schemas"]["
|
|
6109
|
+
"application/json": components["schemas"]["ConnectionResponseDto"];
|
|
5869
6110
|
};
|
|
5870
6111
|
};
|
|
5871
6112
|
};
|
|
@@ -6275,6 +6516,8 @@ type EntityStateTransitions = Schemas['ObjectStateTransitionsResponseDto'];
|
|
|
6275
6516
|
type ImportEntitiesResult = Schemas['ImportEntitiesResponseDto'];
|
|
6276
6517
|
type ImportTemplate = Schemas['ImportTemplateResponseDto'];
|
|
6277
6518
|
type EntityType = Schemas['ObjectTypeResponseDto'];
|
|
6519
|
+
type Table = Schemas['TableResponseDto'];
|
|
6520
|
+
type UpsertTableBySlugInput = Schemas['UpsertTableBySlugDto'];
|
|
6278
6521
|
type Knowledge = Schemas['KnowledgeResponseDto'];
|
|
6279
6522
|
type CreateKnowledgeInput = Schemas['CreateKnowledgeDto'];
|
|
6280
6523
|
type UpdateKnowledgeInput = Schemas['UpdateKnowledgeDto'];
|
|
@@ -6975,6 +7218,24 @@ declare class EntityTypesResource {
|
|
|
6975
7218
|
upsertBySlug(definition: EntityTypeDefinition | UpsertEntityTypeBySlugInput): Promise<EntityType>;
|
|
6976
7219
|
}
|
|
6977
7220
|
|
|
7221
|
+
declare class TablesResource {
|
|
7222
|
+
private readonly http;
|
|
7223
|
+
constructor(http: HttpClient);
|
|
7224
|
+
/** Lists tables in the API key's workspace (without columns and rows). */
|
|
7225
|
+
list(options?: {
|
|
7226
|
+
projectId?: string;
|
|
7227
|
+
}): Promise<Table[]>;
|
|
7228
|
+
/** Returns a single table by ID, including columns and rows. */
|
|
7229
|
+
get(id: string): Promise<Table>;
|
|
7230
|
+
/** Returns a single table by its workspace slug, including columns and rows. */
|
|
7231
|
+
getBySlug(slug: string): Promise<Table>;
|
|
7232
|
+
/**
|
|
7233
|
+
* Creates or updates a table by workspace slug. Omitted columns or rows
|
|
7234
|
+
* keep their current value. Marks `managedByCode` by default.
|
|
7235
|
+
*/
|
|
7236
|
+
upsertBySlug(input: UpsertTableBySlugInput): Promise<Table>;
|
|
7237
|
+
}
|
|
7238
|
+
|
|
6978
7239
|
type EligibleApprover = {
|
|
6979
7240
|
workspaceUserId: string;
|
|
6980
7241
|
email: string;
|
|
@@ -7426,6 +7687,8 @@ declare class LunnoaClient {
|
|
|
7426
7687
|
readonly approvals: ApprovalsResource;
|
|
7427
7688
|
readonly entities: EntitiesResource;
|
|
7428
7689
|
readonly entityTypes: EntityTypesResource;
|
|
7690
|
+
/** Small reference / lookup tables (rows stored inline; use entities for transactional data). */
|
|
7691
|
+
readonly tables: TablesResource;
|
|
7429
7692
|
readonly knowledge: KnowledgeResource;
|
|
7430
7693
|
readonly queues: QueuesResource;
|
|
7431
7694
|
readonly queueItems: QueueItemsResource;
|
|
@@ -7579,4 +7842,4 @@ interface CreateServerClientOptions {
|
|
|
7579
7842
|
*/
|
|
7580
7843
|
declare function createServerClient(options: CreateServerClientOptions): LunnoaClient;
|
|
7581
7844
|
|
|
7582
|
-
export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type AddQueueItemErrorInput, 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, type QueueItemStatus, QueueItemsResource, type QueueStats, QueuesResource, type RecordMeasureValueInput, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type Scorecard, type ScorecardMeasure, type ScorecardMeasureStatus, type ScorecardMeasureValue, type ScorecardObjective, type ScorecardSummary, ScorecardsResource, 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 };
|
|
7845
|
+
export { API_KEY_PREFIX, type ActionDefinition, ActionsResource, type AddQueueItemErrorInput, 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, type QueueItemStatus, QueueItemsResource, type QueueStats, QueuesResource, type RecordMeasureValueInput, type RequestOptions, type RunActionInput, type RunActionOptions, type RunActionResult, RunsResource, type SaveUploadedTextInput, type Scorecard, type ScorecardMeasure, type ScorecardMeasureStatus, type ScorecardMeasureValue, type ScorecardObjective, type ScorecardSummary, ScorecardsResource, type SseEvent, SsoAuthResource, type SsoProviderSummary, type SsoProvidersResponse, type StartRunInput, type StartRunInputDto, type StartRunOptions, type StartRunStep, type StopStreamOptions, type StreamMessageOptions, type Table, TablesResource, 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 UpsertTableBySlugInput, 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 };
|