@lunnoa/client 1.4.0 → 2.0.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 +17 -10
- package/dist/cli.js +219 -107
- package/dist/index.cjs +40 -37
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1327 -1333
- package/dist/index.d.ts +1327 -1333
- package/dist/index.js +40 -37
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +59 -37
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +665 -718
- package/dist/react.d.ts +665 -718
- package/dist/react.js +59 -37
- package/dist/react.js.map +1 -1
- package/package.json +2 -6
- package/skills/lunnoa-client/SKILL.md +23 -11
- package/skills/lunnoa-solution-design/SKILL.md +21 -5
package/dist/index.d.ts
CHANGED
|
@@ -249,50 +249,6 @@ interface paths {
|
|
|
249
249
|
patch?: never;
|
|
250
250
|
trace?: never;
|
|
251
251
|
};
|
|
252
|
-
"/api/projects": {
|
|
253
|
-
parameters: {
|
|
254
|
-
query?: never;
|
|
255
|
-
header?: never;
|
|
256
|
-
path?: never;
|
|
257
|
-
cookie?: never;
|
|
258
|
-
};
|
|
259
|
-
/**
|
|
260
|
-
* List projects in current workspace
|
|
261
|
-
* @description Returns all projects in the current workspace, ordered by most recently updated.
|
|
262
|
-
*/
|
|
263
|
-
get: operations["ProjectsController_findAllForWorkspace"];
|
|
264
|
-
put?: never;
|
|
265
|
-
/**
|
|
266
|
-
* Create a project in current workspace
|
|
267
|
-
* @description Creates a project in the current workspace. Projects are organisational containers accessible to all workspace users.
|
|
268
|
-
*/
|
|
269
|
-
post: operations["ProjectsController_create"];
|
|
270
|
-
delete?: never;
|
|
271
|
-
options?: never;
|
|
272
|
-
head?: never;
|
|
273
|
-
patch?: never;
|
|
274
|
-
trace?: never;
|
|
275
|
-
};
|
|
276
|
-
"/api/projects/{projectId}": {
|
|
277
|
-
parameters: {
|
|
278
|
-
query?: never;
|
|
279
|
-
header?: never;
|
|
280
|
-
path?: never;
|
|
281
|
-
cookie?: never;
|
|
282
|
-
};
|
|
283
|
-
/**
|
|
284
|
-
* Get project by ID
|
|
285
|
-
* @description Returns a single project.
|
|
286
|
-
*/
|
|
287
|
-
get: operations["ProjectsController_findOne"];
|
|
288
|
-
put?: never;
|
|
289
|
-
post?: never;
|
|
290
|
-
delete?: never;
|
|
291
|
-
options?: never;
|
|
292
|
-
head?: never;
|
|
293
|
-
patch?: never;
|
|
294
|
-
trace?: never;
|
|
295
|
-
};
|
|
296
252
|
"/api/queues": {
|
|
297
253
|
parameters: {
|
|
298
254
|
query?: never;
|
|
@@ -308,7 +264,7 @@ interface paths {
|
|
|
308
264
|
put?: never;
|
|
309
265
|
/**
|
|
310
266
|
* Create queue
|
|
311
|
-
* @description Creates a queue in the
|
|
267
|
+
* @description Creates a queue in the current workspace. Queues are the platform's human-in-the-loop work surface: items are added to a queue, then processed by workflows or reviewed by people.
|
|
312
268
|
*/
|
|
313
269
|
post: operations["QueuesController_create"];
|
|
314
270
|
delete?: never;
|
|
@@ -745,6 +701,26 @@ interface paths {
|
|
|
745
701
|
patch?: never;
|
|
746
702
|
trace?: never;
|
|
747
703
|
};
|
|
704
|
+
"/api/workflows/upsert": {
|
|
705
|
+
parameters: {
|
|
706
|
+
query?: never;
|
|
707
|
+
header?: never;
|
|
708
|
+
path?: never;
|
|
709
|
+
cookie?: never;
|
|
710
|
+
};
|
|
711
|
+
get?: never;
|
|
712
|
+
put?: never;
|
|
713
|
+
/**
|
|
714
|
+
* Upsert a workflow by slug from a linear step list
|
|
715
|
+
* @description Creates or updates a workflow identified by workspace-scoped `slug`. Builds a minimal valid graph (manual trigger → linear catalogue-action steps). Marks `managedByCode` by default. Prefer the CLI (`npx @lunnoa/client workflows deploy`) over calling this from application code.
|
|
716
|
+
*/
|
|
717
|
+
post: operations["WorkflowsController_upsertBySlug"];
|
|
718
|
+
delete?: never;
|
|
719
|
+
options?: never;
|
|
720
|
+
head?: never;
|
|
721
|
+
patch?: never;
|
|
722
|
+
trace?: never;
|
|
723
|
+
};
|
|
748
724
|
"/api/workflows/{workflowId}": {
|
|
749
725
|
parameters: {
|
|
750
726
|
query?: never;
|
|
@@ -765,7 +741,27 @@ interface paths {
|
|
|
765
741
|
patch?: never;
|
|
766
742
|
trace?: never;
|
|
767
743
|
};
|
|
768
|
-
"/api/
|
|
744
|
+
"/api/agents": {
|
|
745
|
+
parameters: {
|
|
746
|
+
query?: never;
|
|
747
|
+
header?: never;
|
|
748
|
+
path?: never;
|
|
749
|
+
cookie?: never;
|
|
750
|
+
};
|
|
751
|
+
/**
|
|
752
|
+
* List agents in current workspace
|
|
753
|
+
* @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.
|
|
754
|
+
*/
|
|
755
|
+
get: operations["AgentsController_findAllForWorkspace"];
|
|
756
|
+
put?: never;
|
|
757
|
+
post?: never;
|
|
758
|
+
delete?: never;
|
|
759
|
+
options?: never;
|
|
760
|
+
head?: never;
|
|
761
|
+
patch?: never;
|
|
762
|
+
trace?: never;
|
|
763
|
+
};
|
|
764
|
+
"/api/agents/upsert": {
|
|
769
765
|
parameters: {
|
|
770
766
|
query?: never;
|
|
771
767
|
header?: never;
|
|
@@ -775,10 +771,70 @@ interface paths {
|
|
|
775
771
|
get?: never;
|
|
776
772
|
put?: never;
|
|
777
773
|
/**
|
|
778
|
-
* Upsert
|
|
779
|
-
* @description Creates or updates
|
|
774
|
+
* Upsert an agent by slug
|
|
775
|
+
* @description Creates or updates an agent identified by workspace-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.
|
|
776
|
+
*/
|
|
777
|
+
post: operations["AgentsController_upsertBySlug"];
|
|
778
|
+
delete?: never;
|
|
779
|
+
options?: never;
|
|
780
|
+
head?: never;
|
|
781
|
+
patch?: never;
|
|
782
|
+
trace?: never;
|
|
783
|
+
};
|
|
784
|
+
"/api/agents/{agentId}": {
|
|
785
|
+
parameters: {
|
|
786
|
+
query?: never;
|
|
787
|
+
header?: never;
|
|
788
|
+
path?: never;
|
|
789
|
+
cookie?: never;
|
|
790
|
+
};
|
|
791
|
+
/**
|
|
792
|
+
* Get agent by ID
|
|
793
|
+
* @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.
|
|
794
|
+
*/
|
|
795
|
+
get: operations["AgentsController_findOne"];
|
|
796
|
+
put?: never;
|
|
797
|
+
post?: never;
|
|
798
|
+
delete?: never;
|
|
799
|
+
options?: never;
|
|
800
|
+
head?: never;
|
|
801
|
+
patch?: never;
|
|
802
|
+
trace?: never;
|
|
803
|
+
};
|
|
804
|
+
"/api/workflow-apps": {
|
|
805
|
+
parameters: {
|
|
806
|
+
query?: never;
|
|
807
|
+
header?: never;
|
|
808
|
+
path?: never;
|
|
809
|
+
cookie?: never;
|
|
810
|
+
};
|
|
811
|
+
/**
|
|
812
|
+
* List all workflow apps
|
|
813
|
+
* @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.
|
|
814
|
+
*/
|
|
815
|
+
get: operations["WorkflowAppsController_findAll"];
|
|
816
|
+
put?: never;
|
|
817
|
+
post?: never;
|
|
818
|
+
delete?: never;
|
|
819
|
+
options?: never;
|
|
820
|
+
head?: never;
|
|
821
|
+
patch?: never;
|
|
822
|
+
trace?: never;
|
|
823
|
+
};
|
|
824
|
+
"/api/workflow-apps/{appId}/connections/{connectionId}/connect": {
|
|
825
|
+
parameters: {
|
|
826
|
+
query?: never;
|
|
827
|
+
header?: never;
|
|
828
|
+
path?: never;
|
|
829
|
+
cookie?: never;
|
|
830
|
+
};
|
|
831
|
+
get?: never;
|
|
832
|
+
put?: never;
|
|
833
|
+
/**
|
|
834
|
+
* Connect workflow app
|
|
835
|
+
* @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.
|
|
780
836
|
*/
|
|
781
|
-
post: operations["
|
|
837
|
+
post: operations["WorkflowAppsController_connectApp"];
|
|
782
838
|
delete?: never;
|
|
783
839
|
options?: never;
|
|
784
840
|
head?: never;
|
|
@@ -794,7 +850,7 @@ interface paths {
|
|
|
794
850
|
};
|
|
795
851
|
/**
|
|
796
852
|
* Get all entity types for workspace
|
|
797
|
-
* @description Returns
|
|
853
|
+
* @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
854
|
*/
|
|
799
855
|
get: operations["ObjectTypesController_findAll"];
|
|
800
856
|
put?: never;
|
|
@@ -1025,106 +1081,6 @@ interface paths {
|
|
|
1025
1081
|
patch?: never;
|
|
1026
1082
|
trace?: never;
|
|
1027
1083
|
};
|
|
1028
|
-
"/api/workflow-apps": {
|
|
1029
|
-
parameters: {
|
|
1030
|
-
query?: never;
|
|
1031
|
-
header?: never;
|
|
1032
|
-
path?: never;
|
|
1033
|
-
cookie?: never;
|
|
1034
|
-
};
|
|
1035
|
-
/**
|
|
1036
|
-
* List all workflow apps
|
|
1037
|
-
* @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.
|
|
1038
|
-
*/
|
|
1039
|
-
get: operations["WorkflowAppsController_findAll"];
|
|
1040
|
-
put?: never;
|
|
1041
|
-
post?: never;
|
|
1042
|
-
delete?: never;
|
|
1043
|
-
options?: never;
|
|
1044
|
-
head?: never;
|
|
1045
|
-
patch?: never;
|
|
1046
|
-
trace?: never;
|
|
1047
|
-
};
|
|
1048
|
-
"/api/workflow-apps/{appId}/connections/{connectionId}/connect": {
|
|
1049
|
-
parameters: {
|
|
1050
|
-
query?: never;
|
|
1051
|
-
header?: never;
|
|
1052
|
-
path?: never;
|
|
1053
|
-
cookie?: never;
|
|
1054
|
-
};
|
|
1055
|
-
get?: never;
|
|
1056
|
-
put?: never;
|
|
1057
|
-
/**
|
|
1058
|
-
* Connect workflow app
|
|
1059
|
-
* @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.
|
|
1060
|
-
*/
|
|
1061
|
-
post: operations["WorkflowAppsController_connectApp"];
|
|
1062
|
-
delete?: never;
|
|
1063
|
-
options?: never;
|
|
1064
|
-
head?: never;
|
|
1065
|
-
patch?: never;
|
|
1066
|
-
trace?: never;
|
|
1067
|
-
};
|
|
1068
|
-
"/api/agents": {
|
|
1069
|
-
parameters: {
|
|
1070
|
-
query?: never;
|
|
1071
|
-
header?: never;
|
|
1072
|
-
path?: never;
|
|
1073
|
-
cookie?: never;
|
|
1074
|
-
};
|
|
1075
|
-
/**
|
|
1076
|
-
* List agents in current workspace
|
|
1077
|
-
* @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.
|
|
1078
|
-
*/
|
|
1079
|
-
get: operations["AgentsController_findAllForWorkspace"];
|
|
1080
|
-
put?: never;
|
|
1081
|
-
post?: never;
|
|
1082
|
-
delete?: never;
|
|
1083
|
-
options?: never;
|
|
1084
|
-
head?: never;
|
|
1085
|
-
patch?: never;
|
|
1086
|
-
trace?: never;
|
|
1087
|
-
};
|
|
1088
|
-
"/api/agents/{agentId}": {
|
|
1089
|
-
parameters: {
|
|
1090
|
-
query?: never;
|
|
1091
|
-
header?: never;
|
|
1092
|
-
path?: never;
|
|
1093
|
-
cookie?: never;
|
|
1094
|
-
};
|
|
1095
|
-
/**
|
|
1096
|
-
* Get agent by ID
|
|
1097
|
-
* @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.
|
|
1098
|
-
*/
|
|
1099
|
-
get: operations["AgentsController_findOne"];
|
|
1100
|
-
put?: never;
|
|
1101
|
-
post?: never;
|
|
1102
|
-
delete?: never;
|
|
1103
|
-
options?: never;
|
|
1104
|
-
head?: never;
|
|
1105
|
-
patch?: never;
|
|
1106
|
-
trace?: never;
|
|
1107
|
-
};
|
|
1108
|
-
"/api/projects/{projectId}/agents/upsert": {
|
|
1109
|
-
parameters: {
|
|
1110
|
-
query?: never;
|
|
1111
|
-
header?: never;
|
|
1112
|
-
path?: never;
|
|
1113
|
-
cookie?: never;
|
|
1114
|
-
};
|
|
1115
|
-
get?: never;
|
|
1116
|
-
put?: never;
|
|
1117
|
-
/**
|
|
1118
|
-
* Upsert an agent by slug
|
|
1119
|
-
* @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.
|
|
1120
|
-
*/
|
|
1121
|
-
post: operations["ProjectAgentsController_upsertBySlug"];
|
|
1122
|
-
delete?: never;
|
|
1123
|
-
options?: never;
|
|
1124
|
-
head?: never;
|
|
1125
|
-
patch?: never;
|
|
1126
|
-
trace?: never;
|
|
1127
|
-
};
|
|
1128
1084
|
"/api/knowledge": {
|
|
1129
1085
|
parameters: {
|
|
1130
1086
|
query?: never;
|
|
@@ -1241,31 +1197,27 @@ interface paths {
|
|
|
1241
1197
|
patch?: never;
|
|
1242
1198
|
trace?: never;
|
|
1243
1199
|
};
|
|
1244
|
-
"/api/
|
|
1200
|
+
"/api/executions/workflows/{workflowId}/execute": {
|
|
1245
1201
|
parameters: {
|
|
1246
1202
|
query?: never;
|
|
1247
1203
|
header?: never;
|
|
1248
1204
|
path?: never;
|
|
1249
1205
|
cookie?: never;
|
|
1250
1206
|
};
|
|
1251
|
-
|
|
1252
|
-
* List variables in current workspace
|
|
1253
|
-
* @description Returns all variables in the current workspace, ordered by most recently updated.
|
|
1254
|
-
*/
|
|
1255
|
-
get: operations["VariablesController_findAllForWorkspace"];
|
|
1207
|
+
get?: never;
|
|
1256
1208
|
put?: never;
|
|
1257
1209
|
/**
|
|
1258
|
-
*
|
|
1259
|
-
* @description
|
|
1210
|
+
* Manually execute workflow by ID
|
|
1211
|
+
* @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.
|
|
1260
1212
|
*/
|
|
1261
|
-
post: operations["
|
|
1213
|
+
post: operations["ExecutionsController_manuallyExecuteWorkflow"];
|
|
1262
1214
|
delete?: never;
|
|
1263
1215
|
options?: never;
|
|
1264
1216
|
head?: never;
|
|
1265
1217
|
patch?: never;
|
|
1266
1218
|
trace?: never;
|
|
1267
1219
|
};
|
|
1268
|
-
"/api/
|
|
1220
|
+
"/api/executions": {
|
|
1269
1221
|
parameters: {
|
|
1270
1222
|
query?: never;
|
|
1271
1223
|
header?: never;
|
|
@@ -1273,27 +1225,19 @@ interface paths {
|
|
|
1273
1225
|
cookie?: never;
|
|
1274
1226
|
};
|
|
1275
1227
|
/**
|
|
1276
|
-
*
|
|
1277
|
-
* @description Returns
|
|
1228
|
+
* List executions in current workspace
|
|
1229
|
+
* @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.
|
|
1278
1230
|
*/
|
|
1279
|
-
get: operations["
|
|
1231
|
+
get: operations["ExecutionsController_findAll"];
|
|
1280
1232
|
put?: never;
|
|
1281
1233
|
post?: never;
|
|
1282
|
-
|
|
1283
|
-
* Delete variable by ID
|
|
1284
|
-
* @description Deletes a variable. This action cannot be undone.
|
|
1285
|
-
*/
|
|
1286
|
-
delete: operations["VariablesController_delete"];
|
|
1234
|
+
delete?: never;
|
|
1287
1235
|
options?: never;
|
|
1288
1236
|
head?: never;
|
|
1289
|
-
|
|
1290
|
-
* Update variable by ID
|
|
1291
|
-
* @description Updates variable properties. All body fields are optional; only provided fields are changed.
|
|
1292
|
-
*/
|
|
1293
|
-
patch: operations["VariablesController_update"];
|
|
1237
|
+
patch?: never;
|
|
1294
1238
|
trace?: never;
|
|
1295
1239
|
};
|
|
1296
|
-
"/api/
|
|
1240
|
+
"/api/executions/{executionId}": {
|
|
1297
1241
|
parameters: {
|
|
1298
1242
|
query?: never;
|
|
1299
1243
|
header?: never;
|
|
@@ -1301,10 +1245,10 @@ interface paths {
|
|
|
1301
1245
|
cookie?: never;
|
|
1302
1246
|
};
|
|
1303
1247
|
/**
|
|
1304
|
-
*
|
|
1305
|
-
* @description Returns
|
|
1248
|
+
* Get execution by ID
|
|
1249
|
+
* @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.
|
|
1306
1250
|
*/
|
|
1307
|
-
get: operations["
|
|
1251
|
+
get: operations["ExecutionsController_findOne"];
|
|
1308
1252
|
put?: never;
|
|
1309
1253
|
post?: never;
|
|
1310
1254
|
delete?: never;
|
|
@@ -1313,7 +1257,7 @@ interface paths {
|
|
|
1313
1257
|
patch?: never;
|
|
1314
1258
|
trace?: never;
|
|
1315
1259
|
};
|
|
1316
|
-
"/api/
|
|
1260
|
+
"/api/executions/{executionId}/stream": {
|
|
1317
1261
|
parameters: {
|
|
1318
1262
|
query?: never;
|
|
1319
1263
|
header?: never;
|
|
@@ -1321,10 +1265,10 @@ interface paths {
|
|
|
1321
1265
|
cookie?: never;
|
|
1322
1266
|
};
|
|
1323
1267
|
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @description
|
|
1268
|
+
* Stream execution updates (SSE)
|
|
1269
|
+
* @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.
|
|
1326
1270
|
*/
|
|
1327
|
-
get: operations["
|
|
1271
|
+
get: operations["ExecutionsController_streamExecution"];
|
|
1328
1272
|
put?: never;
|
|
1329
1273
|
post?: never;
|
|
1330
1274
|
delete?: never;
|
|
@@ -1333,7 +1277,7 @@ interface paths {
|
|
|
1333
1277
|
patch?: never;
|
|
1334
1278
|
trace?: never;
|
|
1335
1279
|
};
|
|
1336
|
-
"/api/
|
|
1280
|
+
"/api/actions/run": {
|
|
1337
1281
|
parameters: {
|
|
1338
1282
|
query?: never;
|
|
1339
1283
|
header?: never;
|
|
@@ -1343,37 +1287,37 @@ interface paths {
|
|
|
1343
1287
|
get?: never;
|
|
1344
1288
|
put?: never;
|
|
1345
1289
|
/**
|
|
1346
|
-
*
|
|
1347
|
-
* @description
|
|
1290
|
+
* Run a single app action as an ad-hoc Execution
|
|
1291
|
+
* @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.
|
|
1348
1292
|
*/
|
|
1349
|
-
post: operations["
|
|
1293
|
+
post: operations["ActionsController_run"];
|
|
1350
1294
|
delete?: never;
|
|
1351
1295
|
options?: never;
|
|
1352
1296
|
head?: never;
|
|
1353
1297
|
patch?: never;
|
|
1354
1298
|
trace?: never;
|
|
1355
1299
|
};
|
|
1356
|
-
"/api/
|
|
1300
|
+
"/api/runs": {
|
|
1357
1301
|
parameters: {
|
|
1358
1302
|
query?: never;
|
|
1359
1303
|
header?: never;
|
|
1360
1304
|
path?: never;
|
|
1361
1305
|
cookie?: never;
|
|
1362
1306
|
};
|
|
1307
|
+
get?: never;
|
|
1308
|
+
put?: never;
|
|
1363
1309
|
/**
|
|
1364
|
-
*
|
|
1365
|
-
* @description
|
|
1310
|
+
* Start a multi-step ad-hoc Execution
|
|
1311
|
+
* @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.
|
|
1366
1312
|
*/
|
|
1367
|
-
|
|
1368
|
-
put?: never;
|
|
1369
|
-
post?: never;
|
|
1313
|
+
post: operations["RunsController_start"];
|
|
1370
1314
|
delete?: never;
|
|
1371
1315
|
options?: never;
|
|
1372
1316
|
head?: never;
|
|
1373
1317
|
patch?: never;
|
|
1374
1318
|
trace?: never;
|
|
1375
1319
|
};
|
|
1376
|
-
"/api/
|
|
1320
|
+
"/api/variables": {
|
|
1377
1321
|
parameters: {
|
|
1378
1322
|
query?: never;
|
|
1379
1323
|
header?: never;
|
|
@@ -1381,19 +1325,23 @@ interface paths {
|
|
|
1381
1325
|
cookie?: never;
|
|
1382
1326
|
};
|
|
1383
1327
|
/**
|
|
1384
|
-
*
|
|
1385
|
-
* @description Returns
|
|
1328
|
+
* List variables in current workspace
|
|
1329
|
+
* @description Returns all variables in the current workspace, ordered by most recently updated.
|
|
1386
1330
|
*/
|
|
1387
|
-
get: operations["
|
|
1331
|
+
get: operations["VariablesController_findAllForWorkspace"];
|
|
1388
1332
|
put?: never;
|
|
1389
|
-
|
|
1333
|
+
/**
|
|
1334
|
+
* Create variable in current workspace
|
|
1335
|
+
* @description Creates a variable in the current workspace.
|
|
1336
|
+
*/
|
|
1337
|
+
post: operations["VariablesController_create"];
|
|
1390
1338
|
delete?: never;
|
|
1391
1339
|
options?: never;
|
|
1392
1340
|
head?: never;
|
|
1393
1341
|
patch?: never;
|
|
1394
1342
|
trace?: never;
|
|
1395
1343
|
};
|
|
1396
|
-
"/api/
|
|
1344
|
+
"/api/variables/{variableId}": {
|
|
1397
1345
|
parameters: {
|
|
1398
1346
|
query?: never;
|
|
1399
1347
|
header?: never;
|
|
@@ -1401,10 +1349,38 @@ interface paths {
|
|
|
1401
1349
|
cookie?: never;
|
|
1402
1350
|
};
|
|
1403
1351
|
/**
|
|
1404
|
-
*
|
|
1405
|
-
* @description
|
|
1352
|
+
* Get variable by ID
|
|
1353
|
+
* @description Returns a single variable.
|
|
1406
1354
|
*/
|
|
1407
|
-
get: operations["
|
|
1355
|
+
get: operations["VariablesController_findOne"];
|
|
1356
|
+
put?: never;
|
|
1357
|
+
post?: never;
|
|
1358
|
+
/**
|
|
1359
|
+
* Delete variable by ID
|
|
1360
|
+
* @description Deletes a variable. This action cannot be undone.
|
|
1361
|
+
*/
|
|
1362
|
+
delete: operations["VariablesController_delete"];
|
|
1363
|
+
options?: never;
|
|
1364
|
+
head?: never;
|
|
1365
|
+
/**
|
|
1366
|
+
* Update variable by ID
|
|
1367
|
+
* @description Updates variable properties. All body fields are optional; only provided fields are changed.
|
|
1368
|
+
*/
|
|
1369
|
+
patch: operations["VariablesController_update"];
|
|
1370
|
+
trace?: never;
|
|
1371
|
+
};
|
|
1372
|
+
"/api/tables": {
|
|
1373
|
+
parameters: {
|
|
1374
|
+
query?: never;
|
|
1375
|
+
header?: never;
|
|
1376
|
+
path?: never;
|
|
1377
|
+
cookie?: never;
|
|
1378
|
+
};
|
|
1379
|
+
/**
|
|
1380
|
+
* List tables
|
|
1381
|
+
* @description Lists tables in the current workspace, without rows.
|
|
1382
|
+
*/
|
|
1383
|
+
get: operations["TablesController_findAll"];
|
|
1408
1384
|
put?: never;
|
|
1409
1385
|
post?: never;
|
|
1410
1386
|
delete?: never;
|
|
@@ -1413,7 +1389,7 @@ interface paths {
|
|
|
1413
1389
|
patch?: never;
|
|
1414
1390
|
trace?: never;
|
|
1415
1391
|
};
|
|
1416
|
-
"/api/
|
|
1392
|
+
"/api/tables/upsert": {
|
|
1417
1393
|
parameters: {
|
|
1418
1394
|
query?: never;
|
|
1419
1395
|
header?: never;
|
|
@@ -1423,30 +1399,90 @@ interface paths {
|
|
|
1423
1399
|
get?: never;
|
|
1424
1400
|
put?: never;
|
|
1425
1401
|
/**
|
|
1426
|
-
*
|
|
1427
|
-
* @description Creates
|
|
1402
|
+
* Upsert table by slug
|
|
1403
|
+
* @description Creates or updates the table with this workspace `slug`. Omitted columns or rows keep their current value. Marks `managedByCode` by default.
|
|
1428
1404
|
*/
|
|
1429
|
-
post: operations["
|
|
1405
|
+
post: operations["TablesController_upsertBySlug"];
|
|
1430
1406
|
delete?: never;
|
|
1431
1407
|
options?: never;
|
|
1432
1408
|
head?: never;
|
|
1433
1409
|
patch?: never;
|
|
1434
1410
|
trace?: never;
|
|
1435
1411
|
};
|
|
1436
|
-
"/api/
|
|
1412
|
+
"/api/tables/slug/{slug}": {
|
|
1437
1413
|
parameters: {
|
|
1438
1414
|
query?: never;
|
|
1439
1415
|
header?: never;
|
|
1440
1416
|
path?: never;
|
|
1441
1417
|
cookie?: never;
|
|
1442
1418
|
};
|
|
1443
|
-
|
|
1419
|
+
/**
|
|
1420
|
+
* Get table by slug
|
|
1421
|
+
* @description Returns a table, including columns and rows.
|
|
1422
|
+
*/
|
|
1423
|
+
get: operations["TablesController_findBySlug"];
|
|
1444
1424
|
put?: never;
|
|
1425
|
+
post?: never;
|
|
1426
|
+
delete?: never;
|
|
1427
|
+
options?: never;
|
|
1428
|
+
head?: never;
|
|
1429
|
+
patch?: never;
|
|
1430
|
+
trace?: never;
|
|
1431
|
+
};
|
|
1432
|
+
"/api/tables/{tableId}": {
|
|
1433
|
+
parameters: {
|
|
1434
|
+
query?: never;
|
|
1435
|
+
header?: never;
|
|
1436
|
+
path?: never;
|
|
1437
|
+
cookie?: never;
|
|
1438
|
+
};
|
|
1445
1439
|
/**
|
|
1446
|
-
*
|
|
1447
|
-
* @description
|
|
1440
|
+
* Get table
|
|
1441
|
+
* @description Returns a table, including columns and rows.
|
|
1448
1442
|
*/
|
|
1449
|
-
|
|
1443
|
+
get: operations["TablesController_findOne"];
|
|
1444
|
+
put?: never;
|
|
1445
|
+
post?: never;
|
|
1446
|
+
delete?: never;
|
|
1447
|
+
options?: never;
|
|
1448
|
+
head?: never;
|
|
1449
|
+
patch?: never;
|
|
1450
|
+
trace?: never;
|
|
1451
|
+
};
|
|
1452
|
+
"/api/connections": {
|
|
1453
|
+
parameters: {
|
|
1454
|
+
query?: never;
|
|
1455
|
+
header?: never;
|
|
1456
|
+
path?: never;
|
|
1457
|
+
cookie?: never;
|
|
1458
|
+
};
|
|
1459
|
+
/**
|
|
1460
|
+
* List connections in current workspace
|
|
1461
|
+
* @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.
|
|
1462
|
+
*/
|
|
1463
|
+
get: operations["ConnectionsController_findAllForWorkspace"];
|
|
1464
|
+
put?: never;
|
|
1465
|
+
post?: never;
|
|
1466
|
+
delete?: never;
|
|
1467
|
+
options?: never;
|
|
1468
|
+
head?: never;
|
|
1469
|
+
patch?: never;
|
|
1470
|
+
trace?: never;
|
|
1471
|
+
};
|
|
1472
|
+
"/api/connections/{connectionId}": {
|
|
1473
|
+
parameters: {
|
|
1474
|
+
query?: never;
|
|
1475
|
+
header?: never;
|
|
1476
|
+
path?: never;
|
|
1477
|
+
cookie?: never;
|
|
1478
|
+
};
|
|
1479
|
+
/**
|
|
1480
|
+
* Get connection by ID
|
|
1481
|
+
* @description Returns a single connection. Credential values are never returned.
|
|
1482
|
+
*/
|
|
1483
|
+
get: operations["ConnectionsController_findOne"];
|
|
1484
|
+
put?: never;
|
|
1485
|
+
post?: never;
|
|
1450
1486
|
delete?: never;
|
|
1451
1487
|
options?: never;
|
|
1452
1488
|
head?: never;
|
|
@@ -1678,64 +1714,6 @@ interface components {
|
|
|
1678
1714
|
/** @description Availability of authentication methods for this deployment. */
|
|
1679
1715
|
AUTH_METHODS: components["schemas"]["AuthMethodFlagsDto"];
|
|
1680
1716
|
};
|
|
1681
|
-
CreateProjectDto: {
|
|
1682
|
-
/** @description Name of the project. */
|
|
1683
|
-
name: string;
|
|
1684
|
-
/** @description Description of the project. */
|
|
1685
|
-
description?: string;
|
|
1686
|
-
};
|
|
1687
|
-
ProjectCountDto: {
|
|
1688
|
-
/** @description Number of agents in the project. */
|
|
1689
|
-
agents?: number;
|
|
1690
|
-
/** @description Number of variables in the project. */
|
|
1691
|
-
variables?: number;
|
|
1692
|
-
/** @description Number of workflows in the project. */
|
|
1693
|
-
workflows?: number;
|
|
1694
|
-
};
|
|
1695
|
-
ProjectCreatedByUserDto: {
|
|
1696
|
-
/** @description User ID. */
|
|
1697
|
-
id: string;
|
|
1698
|
-
/** @description User email address. */
|
|
1699
|
-
email: string;
|
|
1700
|
-
/** @description User display name. */
|
|
1701
|
-
name: string;
|
|
1702
|
-
};
|
|
1703
|
-
ProjectCreatedByWorkspaceUserDto: {
|
|
1704
|
-
/** @description Workspace user ID. */
|
|
1705
|
-
id: string;
|
|
1706
|
-
/** @description The underlying user. */
|
|
1707
|
-
user: components["schemas"]["ProjectCreatedByUserDto"];
|
|
1708
|
-
};
|
|
1709
|
-
ProjectWorkflowSummaryDto: {
|
|
1710
|
-
/** @description Workflow ID. */
|
|
1711
|
-
id: string;
|
|
1712
|
-
/** @description Workflow name. */
|
|
1713
|
-
name: string;
|
|
1714
|
-
};
|
|
1715
|
-
ProjectResponseDto: {
|
|
1716
|
-
/** @description Project ID. */
|
|
1717
|
-
id: string;
|
|
1718
|
-
/** @description Project name. */
|
|
1719
|
-
name: string;
|
|
1720
|
-
/** @description Project description. Included when `expansion=description` is requested. */
|
|
1721
|
-
description?: string;
|
|
1722
|
-
/**
|
|
1723
|
-
* Format: date-time
|
|
1724
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
1725
|
-
*/
|
|
1726
|
-
createdAt?: string;
|
|
1727
|
-
/**
|
|
1728
|
-
* Format: date-time
|
|
1729
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1730
|
-
*/
|
|
1731
|
-
updatedAt?: string;
|
|
1732
|
-
/** @description Aggregate counts. Included when `expansion=countAgents` is requested; countVariables and countWorkflows add their respective counts. */
|
|
1733
|
-
_count?: components["schemas"]["ProjectCountDto"];
|
|
1734
|
-
/** @description Workspace user who created the project. Included when `expansion=createdByWorkspaceUser` is requested. */
|
|
1735
|
-
createdByWorkspaceUser?: components["schemas"]["ProjectCreatedByWorkspaceUserDto"];
|
|
1736
|
-
/** @description Workflows in the project. Included when `expansion=workflows` is requested. */
|
|
1737
|
-
workflows?: components["schemas"]["ProjectWorkflowSummaryDto"][];
|
|
1738
|
-
};
|
|
1739
1717
|
CreateQueueDto: {
|
|
1740
1718
|
/** @description Human-readable name for the queue. */
|
|
1741
1719
|
name: string;
|
|
@@ -1752,12 +1730,6 @@ interface components {
|
|
|
1752
1730
|
/** @description Default priority for items in this queue. Higher values are processed first. Defaults to 0. */
|
|
1753
1731
|
priority?: number;
|
|
1754
1732
|
};
|
|
1755
|
-
QueueProjectSummaryDto: {
|
|
1756
|
-
/** @description Project ID. */
|
|
1757
|
-
id: string;
|
|
1758
|
-
/** @description Project name. */
|
|
1759
|
-
name: string;
|
|
1760
|
-
};
|
|
1761
1733
|
QueueWorkspaceSummaryDto: {
|
|
1762
1734
|
/** @description Workspace ID. */
|
|
1763
1735
|
id: string;
|
|
@@ -1827,8 +1799,6 @@ interface components {
|
|
|
1827
1799
|
successItems?: number;
|
|
1828
1800
|
/** @description Number of failed items. Included when `expansion=statistics` is requested. */
|
|
1829
1801
|
failedItems?: number;
|
|
1830
|
-
/** @description Owning project. Included when `expansion=project` is requested. */
|
|
1831
|
-
project?: components["schemas"]["QueueProjectSummaryDto"];
|
|
1832
1802
|
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1833
1803
|
workspace?: components["schemas"]["QueueWorkspaceSummaryDto"];
|
|
1834
1804
|
/** @description Workspace user who created the queue. Included when `expansion=createdByWorkspaceUser` is requested. */
|
|
@@ -2289,7 +2259,9 @@ interface components {
|
|
|
2289
2259
|
/** @description Error message to record against the queue item. */
|
|
2290
2260
|
error: string;
|
|
2291
2261
|
/** @description Additional structured error details, supplied as a JSON string. */
|
|
2292
|
-
errorDetails?:
|
|
2262
|
+
errorDetails?: {
|
|
2263
|
+
[key: string]: unknown;
|
|
2264
|
+
};
|
|
2293
2265
|
};
|
|
2294
2266
|
BulkDeleteItemsDto: {
|
|
2295
2267
|
/** @description IDs of the queue items to delete. */
|
|
@@ -2303,18 +2275,44 @@ interface components {
|
|
|
2303
2275
|
/** @description Number of item IDs submitted for deletion. */
|
|
2304
2276
|
requestedCount: number;
|
|
2305
2277
|
};
|
|
2306
|
-
|
|
2307
|
-
/** @description
|
|
2308
|
-
|
|
2309
|
-
/** @description
|
|
2310
|
-
|
|
2278
|
+
UpsertWorkflowStepDto: {
|
|
2279
|
+
/** @description Workflow app id (catalogue slug). */
|
|
2280
|
+
appId: string;
|
|
2281
|
+
/** @description Catalogue action id. */
|
|
2282
|
+
actionId: string;
|
|
2283
|
+
/** @description Connection instance UUID for this step. */
|
|
2284
|
+
connectionId?: string;
|
|
2285
|
+
/** @description Action input / config fields. */
|
|
2286
|
+
input?: {
|
|
2287
|
+
[key: string]: unknown;
|
|
2288
|
+
};
|
|
2289
|
+
/** @description Display name for the step node. */
|
|
2290
|
+
name?: string;
|
|
2291
|
+
/** @description Step description. */
|
|
2292
|
+
description?: string;
|
|
2293
|
+
};
|
|
2294
|
+
UpsertWorkflowBySlugDto: {
|
|
2295
|
+
/**
|
|
2296
|
+
* @description Stable workspace-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
2297
|
+
* @example sync-orders
|
|
2298
|
+
*/
|
|
2299
|
+
slug: string;
|
|
2300
|
+
/** @description Display name. Defaults to the slug when omitted. */
|
|
2301
|
+
name?: string;
|
|
2302
|
+
description?: string;
|
|
2303
|
+
/** @description Whether the workflow is active. */
|
|
2304
|
+
isActive?: boolean;
|
|
2305
|
+
/** @description Linear catalogue-action steps (v1; no branches). */
|
|
2306
|
+
steps: components["schemas"]["UpsertWorkflowStepDto"][];
|
|
2307
|
+
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
2308
|
+
managedByCode?: boolean;
|
|
2311
2309
|
};
|
|
2312
2310
|
WorkflowResponseDto: {
|
|
2313
2311
|
/** @description Workflow ID */
|
|
2314
2312
|
id: string;
|
|
2315
2313
|
/** @description Workflow name */
|
|
2316
2314
|
name: string;
|
|
2317
|
-
/** @description Stable
|
|
2315
|
+
/** @description Stable workspace-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
2318
2316
|
slug?: string | null;
|
|
2319
2317
|
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
2320
2318
|
managedByCode?: boolean;
|
|
@@ -2338,6 +2336,14 @@ interface components {
|
|
|
2338
2336
|
isActive?: boolean;
|
|
2339
2337
|
/** @description Whether the workflow is internal (hidden from default listings). Included when `expansion=isInternal` is requested. */
|
|
2340
2338
|
isInternal?: boolean;
|
|
2339
|
+
/** @description Object type whose records list this workflow's runs. Included when `expansion=objectLink` is requested. */
|
|
2340
|
+
objectTypeId?: string | null;
|
|
2341
|
+
/** @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. */
|
|
2342
|
+
objectIdPath?: string | null;
|
|
2343
|
+
/** @description Create a record when the unique key value is not found, then file the run on it. Included when `expansion=objectLink` is requested. */
|
|
2344
|
+
createObjectIfMissing?: boolean;
|
|
2345
|
+
/** @description Unique key on the linked object type (`name` or `attribute:<field>`). Included when `expansion=objectLink` is requested. */
|
|
2346
|
+
uniqueKeyField?: string | null;
|
|
2341
2347
|
/** @description Workflow node definitions (JSON). Included when `expansion=nodes` is requested. */
|
|
2342
2348
|
nodes?: {
|
|
2343
2349
|
[key: string]: unknown;
|
|
@@ -2368,474 +2374,104 @@ interface components {
|
|
|
2368
2374
|
* @enum {string}
|
|
2369
2375
|
*/
|
|
2370
2376
|
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
2371
|
-
/** @description The project the workflow belongs to. Included when `expansion=project` is requested. */
|
|
2372
|
-
project?: components["schemas"]["WorkflowProjectSummaryDto"];
|
|
2373
2377
|
/** @description AI provider connection used by the workflow builder chat. Always returned on GET /workflows/{workflowId}. */
|
|
2374
2378
|
aiConnectionId?: string | null;
|
|
2375
2379
|
/** @description Selected model ID within the AI provider connection for workflow builder chat. Always returned on GET /workflows/{workflowId}. */
|
|
2376
2380
|
selectedModelId?: string | null;
|
|
2377
2381
|
};
|
|
2378
|
-
|
|
2382
|
+
UpsertAgentToolDto: {
|
|
2379
2383
|
/** @description Workflow app id (catalogue slug). */
|
|
2380
2384
|
appId: string;
|
|
2381
2385
|
/** @description Catalogue action id. */
|
|
2382
2386
|
actionId: string;
|
|
2383
|
-
/** @description Connection instance UUID
|
|
2387
|
+
/** @description Connection instance UUID pre-bound on the tool. */
|
|
2384
2388
|
connectionId?: string;
|
|
2385
|
-
/** @description
|
|
2389
|
+
/** @description Tool display name for the model. */
|
|
2390
|
+
name?: string;
|
|
2391
|
+
/** @description Tool description shown to the model. */
|
|
2392
|
+
description?: string;
|
|
2393
|
+
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
2386
2394
|
input?: {
|
|
2387
2395
|
[key: string]: unknown;
|
|
2388
2396
|
};
|
|
2389
|
-
/** @description Display name for the step node. */
|
|
2390
|
-
name?: string;
|
|
2391
|
-
/** @description Step description. */
|
|
2392
|
-
description?: string;
|
|
2393
2397
|
};
|
|
2394
|
-
|
|
2398
|
+
UpsertAgentBySlugDto: {
|
|
2395
2399
|
/**
|
|
2396
|
-
* @description Stable
|
|
2397
|
-
* @example
|
|
2400
|
+
* @description Stable workspace-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
2401
|
+
* @example support-triage
|
|
2398
2402
|
*/
|
|
2399
2403
|
slug: string;
|
|
2400
2404
|
/** @description Display name. Defaults to the slug when omitted. */
|
|
2401
2405
|
name?: string;
|
|
2402
2406
|
description?: string;
|
|
2403
|
-
/** @description
|
|
2404
|
-
|
|
2405
|
-
/** @description
|
|
2406
|
-
|
|
2407
|
-
/** @description
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
/** @description
|
|
2412
|
-
|
|
2413
|
-
/** @description
|
|
2414
|
-
|
|
2415
|
-
/** @description
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
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;
|
|
2407
|
+
/** @description System instructions / prompt for the agent. */
|
|
2408
|
+
instructions: string;
|
|
2409
|
+
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
2410
|
+
model: string;
|
|
2411
|
+
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
2412
|
+
aiConnectionId?: string;
|
|
2413
|
+
/** @description App Connection UUIDs the agent may use for tools. */
|
|
2414
|
+
connectionIds?: string[];
|
|
2415
|
+
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
2416
|
+
workflowIds?: string[];
|
|
2417
|
+
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
2418
|
+
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
2419
|
+
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
2420
|
+
managedByCode?: boolean;
|
|
2421
|
+
};
|
|
2422
|
+
AgentResponseDto: {
|
|
2439
2423
|
/**
|
|
2440
|
-
* @description
|
|
2441
|
-
* @
|
|
2424
|
+
* @description Agent ID (UUID)
|
|
2425
|
+
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
2442
2426
|
*/
|
|
2443
|
-
|
|
2427
|
+
id: string;
|
|
2444
2428
|
/**
|
|
2445
|
-
* @description
|
|
2446
|
-
* @
|
|
2429
|
+
* @description Agent name
|
|
2430
|
+
* @example Invoice Triage Agent
|
|
2447
2431
|
*/
|
|
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
2432
|
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. */
|
|
2433
|
+
/** @description Stable workspace-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
2434
|
+
slug?: string | null;
|
|
2435
|
+
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
2436
|
+
managedByCode?: boolean;
|
|
2437
|
+
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
2438
|
+
FK_aiConnectionId: string | null;
|
|
2439
|
+
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
2489
2440
|
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;
|
|
2441
|
+
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
2442
|
+
profileImageUrl?: string | null;
|
|
2498
2443
|
/**
|
|
2499
2444
|
* Format: date-time
|
|
2500
|
-
* @description Included when `expansion=createdAt` is requested.
|
|
2445
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
2501
2446
|
*/
|
|
2502
2447
|
createdAt?: string;
|
|
2503
2448
|
/**
|
|
2504
2449
|
* Format: date-time
|
|
2505
|
-
* @description Included when `expansion=updatedAt` is requested.
|
|
2450
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2506
2451
|
*/
|
|
2507
2452
|
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;
|
|
2453
|
+
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
2454
|
+
instructions?: string | null;
|
|
2516
2455
|
/**
|
|
2517
|
-
*
|
|
2518
|
-
* @
|
|
2456
|
+
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
2457
|
+
* @example 1
|
|
2519
2458
|
*/
|
|
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;
|
|
2459
|
+
temperature?: number;
|
|
2460
|
+
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
2461
|
+
maxOutputTokens?: number | null;
|
|
2583
2462
|
/**
|
|
2584
|
-
*
|
|
2585
|
-
* @
|
|
2463
|
+
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
2464
|
+
* @example 1
|
|
2586
2465
|
*/
|
|
2587
|
-
|
|
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
|
-
};
|
|
2466
|
+
topP?: number;
|
|
2602
2467
|
/**
|
|
2603
|
-
*
|
|
2604
|
-
* @
|
|
2468
|
+
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
2469
|
+
* @example 0
|
|
2605
2470
|
*/
|
|
2606
|
-
|
|
2471
|
+
frequencyPenalty?: number;
|
|
2607
2472
|
/**
|
|
2608
|
-
*
|
|
2609
|
-
* @
|
|
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;
|
|
2826
|
-
/**
|
|
2827
|
-
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
2828
|
-
* @example 1
|
|
2829
|
-
*/
|
|
2830
|
-
topP?: number;
|
|
2831
|
-
/**
|
|
2832
|
-
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
2833
|
-
* @example 0
|
|
2834
|
-
*/
|
|
2835
|
-
frequencyPenalty?: number;
|
|
2836
|
-
/**
|
|
2837
|
-
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
2838
|
-
* @example 0
|
|
2473
|
+
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
2474
|
+
* @example 0
|
|
2839
2475
|
*/
|
|
2840
2476
|
presencePenalty?: number;
|
|
2841
2477
|
/**
|
|
@@ -3037,51 +2673,387 @@ interface components {
|
|
|
3037
2673
|
outboundCallsEnabled?: boolean;
|
|
3038
2674
|
inboundCallsEnabled?: boolean;
|
|
3039
2675
|
} | null;
|
|
3040
|
-
/** @description Project the agent belongs to. Included when `expansion=project` is requested. */
|
|
3041
|
-
project?: {
|
|
3042
|
-
id?: string;
|
|
3043
|
-
name?: string;
|
|
3044
|
-
};
|
|
3045
2676
|
};
|
|
3046
|
-
|
|
3047
|
-
/** @description
|
|
3048
|
-
|
|
3049
|
-
/** @description
|
|
3050
|
-
|
|
3051
|
-
/** @description
|
|
3052
|
-
|
|
3053
|
-
/** @description
|
|
3054
|
-
|
|
3055
|
-
/** @description
|
|
3056
|
-
|
|
3057
|
-
/** @description
|
|
3058
|
-
|
|
2677
|
+
WorkflowAppResponseDto: {
|
|
2678
|
+
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
2679
|
+
id: string;
|
|
2680
|
+
/** @description Human-readable app name. */
|
|
2681
|
+
name: string;
|
|
2682
|
+
/** @description App description. */
|
|
2683
|
+
description: string;
|
|
2684
|
+
/** @description URL of the app logo. */
|
|
2685
|
+
logoUrl: string;
|
|
2686
|
+
/** @description Whether the app is published and available for use. */
|
|
2687
|
+
isPublished: boolean;
|
|
2688
|
+
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
2689
|
+
needsConnection: boolean;
|
|
2690
|
+
/** @description Whether the app can be used by agents. */
|
|
2691
|
+
availableForAgent: boolean;
|
|
2692
|
+
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
2693
|
+
actions: {
|
|
3059
2694
|
[key: string]: unknown;
|
|
3060
|
-
};
|
|
2695
|
+
}[];
|
|
2696
|
+
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
2697
|
+
triggers: {
|
|
2698
|
+
[key: string]: unknown;
|
|
2699
|
+
}[];
|
|
2700
|
+
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
2701
|
+
connections: {
|
|
2702
|
+
[key: string]: unknown;
|
|
2703
|
+
}[];
|
|
3061
2704
|
};
|
|
3062
|
-
|
|
3063
|
-
/**
|
|
3064
|
-
* @description Stable project-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
3065
|
-
* @example support-triage
|
|
3066
|
-
*/
|
|
2705
|
+
UpsertObjectTypeBySlugDto: {
|
|
2706
|
+
/** @description Stable deployment-wide slug (lowercase, digits, hyphens). Used as the upsert key. Granted to the caller workspace when new. */
|
|
3067
2707
|
slug: string;
|
|
3068
|
-
/** @description
|
|
2708
|
+
/** @description Singular display name. */
|
|
3069
2709
|
name?: string;
|
|
2710
|
+
/** @description Plural display name. */
|
|
2711
|
+
namePlural?: string;
|
|
2712
|
+
/** @description Description. */
|
|
3070
2713
|
description?: string;
|
|
3071
|
-
/**
|
|
3072
|
-
|
|
3073
|
-
|
|
3074
|
-
|
|
3075
|
-
|
|
3076
|
-
|
|
3077
|
-
|
|
3078
|
-
|
|
3079
|
-
|
|
3080
|
-
|
|
3081
|
-
/** @description
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
|
|
2714
|
+
/**
|
|
2715
|
+
* @description Icon identifier.
|
|
2716
|
+
* @default box
|
|
2717
|
+
*/
|
|
2718
|
+
icon: string;
|
|
2719
|
+
/**
|
|
2720
|
+
* @description Hex colour.
|
|
2721
|
+
* @default #3B82F6
|
|
2722
|
+
*/
|
|
2723
|
+
color: string;
|
|
2724
|
+
/** @description Field definitions grouped into sections. */
|
|
2725
|
+
attributeSchema: {
|
|
2726
|
+
[key: string]: unknown;
|
|
2727
|
+
};
|
|
2728
|
+
/** @description Optional state machine definition. */
|
|
2729
|
+
stateSchema?: {
|
|
2730
|
+
[key: string]: unknown;
|
|
2731
|
+
} | null;
|
|
2732
|
+
/** @description Whether the type is enabled. */
|
|
2733
|
+
isEnabled?: boolean;
|
|
2734
|
+
/**
|
|
2735
|
+
* @description When false (default), reject unknown attribute keys on entity writes.
|
|
2736
|
+
* @default false
|
|
2737
|
+
*/
|
|
2738
|
+
allowUnknownAttributes: boolean;
|
|
2739
|
+
/**
|
|
2740
|
+
* @description Marks the type as code-managed. Defaults to true on upsert.
|
|
2741
|
+
* @default true
|
|
2742
|
+
*/
|
|
2743
|
+
managedByCode: boolean;
|
|
2744
|
+
};
|
|
2745
|
+
ObjectTypeUserSummaryDto: {
|
|
2746
|
+
/** @description User ID. */
|
|
2747
|
+
id: string;
|
|
2748
|
+
/** @description Email address of the user. */
|
|
2749
|
+
email: string;
|
|
2750
|
+
/** @description Display name of the user. */
|
|
2751
|
+
name: string;
|
|
2752
|
+
};
|
|
2753
|
+
ObjectTypeCreatedByDto: {
|
|
2754
|
+
/** @description Workspace user ID. */
|
|
2755
|
+
id: string;
|
|
2756
|
+
user: components["schemas"]["ObjectTypeUserSummaryDto"];
|
|
2757
|
+
};
|
|
2758
|
+
ObjectTypeCountDto: {
|
|
2759
|
+
/** @description Number of non-deleted entities of this type. */
|
|
2760
|
+
objects: number;
|
|
2761
|
+
};
|
|
2762
|
+
ObjectTypeResponseDto: {
|
|
2763
|
+
/** @description Entity type ID. */
|
|
2764
|
+
id: string;
|
|
2765
|
+
/** @description Singular display name of the entity type. */
|
|
2766
|
+
name: string;
|
|
2767
|
+
/** @description Plural display name of the entity type. */
|
|
2768
|
+
namePlural: string;
|
|
2769
|
+
/** @description URL-safe slug, unique across the deployment. */
|
|
2770
|
+
slug: string;
|
|
2771
|
+
/** @description Icon identifier for the entity type. */
|
|
2772
|
+
icon: string;
|
|
2773
|
+
/** @description Hex colour of the entity type. */
|
|
2774
|
+
color: string;
|
|
2775
|
+
/** @description Whether the entity type is enabled. */
|
|
2776
|
+
isEnabled: boolean;
|
|
2777
|
+
/** @description When false, entity create/update rejects attribute keys not declared on the type. Reserved key `extensions` is always allowed. */
|
|
2778
|
+
allowUnknownAttributes: boolean;
|
|
2779
|
+
/** @description True when last written by code (CLI / SDK upsert). */
|
|
2780
|
+
managedByCode: boolean;
|
|
2781
|
+
/** @description Incremented when attributeSchema, stateSchema, or allowUnknownAttributes changes. */
|
|
2782
|
+
schemaRevision: number;
|
|
2783
|
+
/** @description Field that identifies a record besides the Lunnoa id. `name`, or `attribute:<field name>`. */
|
|
2784
|
+
uniqueKeyField?: string | null;
|
|
2785
|
+
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
2786
|
+
description?: string | null;
|
|
2787
|
+
/** @description Field definitions grouped into sections. Included when `expansion=attributeSchema` is requested. */
|
|
2788
|
+
attributeSchema?: {
|
|
2789
|
+
[key: string]: unknown;
|
|
2790
|
+
};
|
|
2791
|
+
/** @description State machine definition. Included when `expansion=stateSchema` is requested. */
|
|
2792
|
+
stateSchema?: {
|
|
2793
|
+
[key: string]: unknown;
|
|
2794
|
+
} | null;
|
|
2795
|
+
/**
|
|
2796
|
+
* Format: date-time
|
|
2797
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
2798
|
+
*/
|
|
2799
|
+
createdAt?: string;
|
|
2800
|
+
/**
|
|
2801
|
+
* Format: date-time
|
|
2802
|
+
* @description Included when `expansion=updatedAt` is requested.
|
|
2803
|
+
*/
|
|
2804
|
+
updatedAt?: string;
|
|
2805
|
+
/** @description Workspace member who created the entity type. Included when `expansion=createdBy` is requested. */
|
|
2806
|
+
createdBy?: components["schemas"]["ObjectTypeCreatedByDto"];
|
|
2807
|
+
/** @description Included when `expansion=countObjects` is requested. */
|
|
2808
|
+
_count?: components["schemas"]["ObjectTypeCountDto"];
|
|
2809
|
+
};
|
|
2810
|
+
CreateObjectDto: {
|
|
2811
|
+
/** @description Display name of the entity. */
|
|
2812
|
+
name: string;
|
|
2813
|
+
/**
|
|
2814
|
+
* Format: uuid
|
|
2815
|
+
* @description Platform admin only. Workspace the record is created in. Builders always use their active workspace.
|
|
2816
|
+
*/
|
|
2817
|
+
workspaceId?: string;
|
|
2818
|
+
/**
|
|
2819
|
+
* Format: uuid
|
|
2820
|
+
* @description ID of the entity type to create the entity under.
|
|
2821
|
+
*/
|
|
2822
|
+
objectTypeId: string;
|
|
2823
|
+
/** @description Initial state ID. Must exist in the entity type state schema. Defaults to the schema initial state when omitted. */
|
|
2824
|
+
state?: string;
|
|
2825
|
+
/** @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. */
|
|
2826
|
+
attributes?: {
|
|
2827
|
+
[key: string]: unknown;
|
|
2828
|
+
};
|
|
2829
|
+
};
|
|
2830
|
+
ObjectTypeSummaryDto: {
|
|
2831
|
+
/** @description Entity type ID. */
|
|
2832
|
+
id: string;
|
|
2833
|
+
/** @description Singular display name of the entity type. */
|
|
2834
|
+
name: string;
|
|
2835
|
+
/** @description URL-safe slug of the entity type. */
|
|
2836
|
+
slug: string;
|
|
2837
|
+
/** @description Icon identifier for the entity type. */
|
|
2838
|
+
icon: string;
|
|
2839
|
+
/** @description Hex colour of the entity type. */
|
|
2840
|
+
color: string;
|
|
2841
|
+
/** @description Plural display name. Included when `expansion=objectType` is requested. */
|
|
2842
|
+
namePlural?: string;
|
|
2843
|
+
/** @description Field definitions grouped into sections. Included when `expansion=objectType` is requested on single-entity reads. */
|
|
2844
|
+
attributeSchema?: {
|
|
2845
|
+
[key: string]: unknown;
|
|
2846
|
+
};
|
|
2847
|
+
/** @description State machine definition. Included when `expansion=objectType` is requested. */
|
|
2848
|
+
stateSchema?: {
|
|
2849
|
+
[key: string]: unknown;
|
|
2850
|
+
} | null;
|
|
2851
|
+
};
|
|
2852
|
+
ObjectUserSummaryDto: {
|
|
2853
|
+
/** @description User ID. */
|
|
2854
|
+
id: string;
|
|
2855
|
+
/** @description Email address of the user. */
|
|
2856
|
+
email: string;
|
|
2857
|
+
/** @description Display name of the user. */
|
|
2858
|
+
name: string;
|
|
2859
|
+
};
|
|
2860
|
+
ObjectWorkspaceUserSummaryDto: {
|
|
2861
|
+
/** @description Workspace user ID. */
|
|
2862
|
+
id: string;
|
|
2863
|
+
user: components["schemas"]["ObjectUserSummaryDto"];
|
|
2864
|
+
};
|
|
2865
|
+
ObjectStateHistoryUserSummaryDto: {
|
|
2866
|
+
/** @description User ID. */
|
|
2867
|
+
id: string;
|
|
2868
|
+
/** @description Display name of the user. */
|
|
2869
|
+
name: string;
|
|
2870
|
+
};
|
|
2871
|
+
ObjectStateHistoryChangedByDto: {
|
|
2872
|
+
/** @description Workspace user ID. */
|
|
2873
|
+
id: string;
|
|
2874
|
+
user: components["schemas"]["ObjectStateHistoryUserSummaryDto"];
|
|
2875
|
+
};
|
|
2876
|
+
ObjectStateHistoryItemDto: {
|
|
2877
|
+
/** @description State history entry ID. */
|
|
2878
|
+
id: string;
|
|
2879
|
+
/** @description State the entity moved from. Null for the initial state. */
|
|
2880
|
+
fromState: string | null;
|
|
2881
|
+
/** @description State the entity moved to. */
|
|
2882
|
+
toState: string;
|
|
2883
|
+
/** @description Reason recorded for the state change, if any. */
|
|
2884
|
+
reason: string | null;
|
|
2885
|
+
/**
|
|
2886
|
+
* Format: date-time
|
|
2887
|
+
* @description When the state change occurred.
|
|
2888
|
+
*/
|
|
2889
|
+
createdAt: string;
|
|
2890
|
+
/** @description Workspace member who made the change, if recorded. */
|
|
2891
|
+
changedBy: components["schemas"]["ObjectStateHistoryChangedByDto"] | null;
|
|
2892
|
+
};
|
|
2893
|
+
ObjectResponseDto: {
|
|
2894
|
+
/** @description Entity ID. */
|
|
2895
|
+
id: string;
|
|
2896
|
+
/** @description Display name of the entity. */
|
|
2897
|
+
name: string;
|
|
2898
|
+
/** @description Current state of the entity, if the type defines states. */
|
|
2899
|
+
state: string | null;
|
|
2900
|
+
/** @description Dynamic attribute values keyed by field ID. */
|
|
2901
|
+
attributes: {
|
|
2902
|
+
[key: string]: unknown;
|
|
2903
|
+
};
|
|
2904
|
+
/**
|
|
2905
|
+
* Format: date-time
|
|
2906
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
2907
|
+
*/
|
|
2908
|
+
createdAt?: string;
|
|
2909
|
+
/**
|
|
2910
|
+
* Format: date-time
|
|
2911
|
+
* @description Included by default on list responses, otherwise when `expansion=updatedAt` is requested.
|
|
2912
|
+
*/
|
|
2913
|
+
updatedAt?: string;
|
|
2914
|
+
/** @description Included by default on list responses with a minimal shape, otherwise when `expansion=objectType` is requested. */
|
|
2915
|
+
objectType?: components["schemas"]["ObjectTypeSummaryDto"];
|
|
2916
|
+
/** @description Included when `expansion=createdBy` is requested. */
|
|
2917
|
+
createdBy?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
2918
|
+
/** @description Most recent state changes (up to 50, newest first). Included when `expansion=stateHistory` is requested. */
|
|
2919
|
+
stateHistory?: components["schemas"]["ObjectStateHistoryItemDto"][];
|
|
2920
|
+
};
|
|
2921
|
+
ObjectPaginationDto: {
|
|
2922
|
+
/** @description Current page number (1-based). */
|
|
2923
|
+
page: number;
|
|
2924
|
+
/** @description Number of items per page (maximum 100). */
|
|
2925
|
+
pageSize: number;
|
|
2926
|
+
/** @description Total number of matching entities. */
|
|
2927
|
+
totalCount: number;
|
|
2928
|
+
/** @description Total number of pages. */
|
|
2929
|
+
totalPages: number;
|
|
2930
|
+
};
|
|
2931
|
+
PaginatedObjectsResponseDto: {
|
|
2932
|
+
data: components["schemas"]["ObjectResponseDto"][];
|
|
2933
|
+
pagination: components["schemas"]["ObjectPaginationDto"];
|
|
2934
|
+
};
|
|
2935
|
+
UpdateObjectDto: {
|
|
2936
|
+
/** @description New display name of the entity. */
|
|
2937
|
+
name?: string;
|
|
2938
|
+
/** @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. */
|
|
2939
|
+
attributes?: {
|
|
2940
|
+
[key: string]: unknown;
|
|
2941
|
+
};
|
|
2942
|
+
};
|
|
2943
|
+
ChangeObjectStateDto: {
|
|
2944
|
+
/** @description ID of the target state. Must be a valid transition from the current state when the entity type defines transitions. */
|
|
2945
|
+
newState: string;
|
|
2946
|
+
/** @description Reason for the state change. Required when the transition is configured with requiresReason. */
|
|
2947
|
+
reason?: string;
|
|
2948
|
+
};
|
|
2949
|
+
ChangeObjectStateResponseDto: {
|
|
2950
|
+
/** @description Entity ID. */
|
|
2951
|
+
id: string;
|
|
2952
|
+
/** @description Display name of the entity. */
|
|
2953
|
+
name: string;
|
|
2954
|
+
/** @description State of the entity after the change. */
|
|
2955
|
+
state: string | null;
|
|
2956
|
+
/**
|
|
2957
|
+
* Format: date-time
|
|
2958
|
+
* @description When the entity was last updated.
|
|
2959
|
+
*/
|
|
2960
|
+
updatedAt: string;
|
|
2961
|
+
};
|
|
2962
|
+
StateHistoryUserSummaryDto: {
|
|
2963
|
+
/** @description User ID. */
|
|
2964
|
+
id: string;
|
|
2965
|
+
/** @description Display name of the user. */
|
|
2966
|
+
name: string;
|
|
2967
|
+
/** @description Email address of the user. */
|
|
2968
|
+
email: string;
|
|
2969
|
+
};
|
|
2970
|
+
StateHistoryChangedByDto: {
|
|
2971
|
+
/** @description Workspace user ID. */
|
|
2972
|
+
id: string;
|
|
2973
|
+
user: components["schemas"]["StateHistoryUserSummaryDto"];
|
|
2974
|
+
};
|
|
2975
|
+
ObjectStateHistoryEntryResponseDto: {
|
|
2976
|
+
/** @description State history entry ID. */
|
|
2977
|
+
id: string;
|
|
2978
|
+
/** @description State the entity moved from. Null for the initial state. */
|
|
2979
|
+
fromState: string | null;
|
|
2980
|
+
/** @description State the entity moved to. */
|
|
2981
|
+
toState: string;
|
|
2982
|
+
/** @description Reason recorded for the state change, if any. */
|
|
2983
|
+
reason: string | null;
|
|
2984
|
+
/**
|
|
2985
|
+
* Format: date-time
|
|
2986
|
+
* @description When the state change occurred.
|
|
2987
|
+
*/
|
|
2988
|
+
createdAt: string;
|
|
2989
|
+
/** @description Workspace member who made the change, if recorded. */
|
|
2990
|
+
changedBy: components["schemas"]["StateHistoryChangedByDto"] | null;
|
|
2991
|
+
};
|
|
2992
|
+
ObjectStateInfoDto: {
|
|
2993
|
+
/** @description State ID. */
|
|
2994
|
+
id: string;
|
|
2995
|
+
/** @description Display name of the state. */
|
|
2996
|
+
name: string;
|
|
2997
|
+
/** @description Colour associated with the state. */
|
|
2998
|
+
color?: string;
|
|
2999
|
+
/** @description Icon associated with the state. */
|
|
3000
|
+
icon?: string;
|
|
3001
|
+
/** @description Whether the state is a final state. */
|
|
3002
|
+
isFinal: boolean;
|
|
3003
|
+
};
|
|
3004
|
+
ObjectStateTransitionDto: {
|
|
3005
|
+
/** @description Transition ID from the state schema. */
|
|
3006
|
+
transitionId: string;
|
|
3007
|
+
/** @description ID of the target state. */
|
|
3008
|
+
toStateId: string;
|
|
3009
|
+
/** @description Display name of the target state. */
|
|
3010
|
+
toStateName: string;
|
|
3011
|
+
/** @description Colour of the target state. */
|
|
3012
|
+
toStateColor?: string;
|
|
3013
|
+
/** @description Icon of the target state. */
|
|
3014
|
+
toStateIcon?: string;
|
|
3015
|
+
/** @description Whether a reason must be supplied for this transition. */
|
|
3016
|
+
requiresReason: boolean;
|
|
3017
|
+
/** @description Confirmation message to show before applying the transition. */
|
|
3018
|
+
confirmationMessage?: string;
|
|
3019
|
+
};
|
|
3020
|
+
ObjectStateTransitionsResponseDto: {
|
|
3021
|
+
/** @description Current state of the entity. Null when the entity has no state or the type defines no state schema. */
|
|
3022
|
+
currentState: components["schemas"]["ObjectStateInfoDto"] | null;
|
|
3023
|
+
/** @description Transitions allowed from the current state. */
|
|
3024
|
+
validTransitions: components["schemas"]["ObjectStateTransitionDto"][];
|
|
3025
|
+
/** @description All states defined by the entity type, for cases where no transitions are defined. */
|
|
3026
|
+
allStates: components["schemas"]["ObjectStateInfoDto"][];
|
|
3027
|
+
};
|
|
3028
|
+
ImportRowErrorDto: {
|
|
3029
|
+
/** @description Row number the error relates to (1-based). */
|
|
3030
|
+
row: number;
|
|
3031
|
+
/** @description Field ID the error relates to, when applicable. */
|
|
3032
|
+
field?: string;
|
|
3033
|
+
/** @description Human-readable error message. */
|
|
3034
|
+
message: string;
|
|
3035
|
+
};
|
|
3036
|
+
ImportEntitiesResponseDto: {
|
|
3037
|
+
/** @description Total number of rows processed. */
|
|
3038
|
+
totalRows: number;
|
|
3039
|
+
/** @description Number of rows imported successfully. */
|
|
3040
|
+
successCount: number;
|
|
3041
|
+
/** @description Number of rows that failed to import. */
|
|
3042
|
+
errorCount: number;
|
|
3043
|
+
/** @description Per-row errors encountered during the import. */
|
|
3044
|
+
errors: components["schemas"]["ImportRowErrorDto"][];
|
|
3045
|
+
/** @description IDs of entities created by the import. */
|
|
3046
|
+
createdIds: string[];
|
|
3047
|
+
/** @description IDs of existing entities updated by the import. */
|
|
3048
|
+
updatedIds: string[];
|
|
3049
|
+
};
|
|
3050
|
+
ImportTemplateResponseDto: {
|
|
3051
|
+
/** @description Column headers for the import file. Always starts with "name". */
|
|
3052
|
+
columns: string[];
|
|
3053
|
+
/** @description Sample row with an example value for each column. */
|
|
3054
|
+
sampleRow: {
|
|
3055
|
+
[key: string]: string;
|
|
3056
|
+
};
|
|
3085
3057
|
};
|
|
3086
3058
|
CreateKnowledgeDto: {
|
|
3087
3059
|
/** @description Name of the knowledge base. */
|
|
@@ -3231,124 +3203,6 @@ interface components {
|
|
|
3231
3203
|
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
3232
3204
|
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
3233
3205
|
};
|
|
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;
|
|
3259
|
-
};
|
|
3260
|
-
VariableProjectDto: {
|
|
3261
|
-
/** @description Project ID. */
|
|
3262
|
-
id: string;
|
|
3263
|
-
/** @description Project name. */
|
|
3264
|
-
name: string;
|
|
3265
|
-
};
|
|
3266
|
-
VariableResponseDto: {
|
|
3267
|
-
/** @description Variable ID. */
|
|
3268
|
-
id: string;
|
|
3269
|
-
/** @description Variable name. */
|
|
3270
|
-
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
|
-
/**
|
|
3291
|
-
* Format: date-time
|
|
3292
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
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}
|
|
3308
|
-
*/
|
|
3309
|
-
type?: "system" | "workspace" | "project";
|
|
3310
|
-
/**
|
|
3311
|
-
* @description Data type of the variable value.
|
|
3312
|
-
* @enum {string}
|
|
3313
|
-
*/
|
|
3314
|
-
dataType?: "string" | "number" | "boolean" | "date" | "json";
|
|
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;
|
|
3325
|
-
};
|
|
3326
|
-
ConnectionResponseDto: {
|
|
3327
|
-
/** @description Connection ID. */
|
|
3328
|
-
id: string;
|
|
3329
|
-
/** @description Connection name. */
|
|
3330
|
-
name: string;
|
|
3331
|
-
/**
|
|
3332
|
-
* Format: date-time
|
|
3333
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3334
|
-
*/
|
|
3335
|
-
createdAt?: string;
|
|
3336
|
-
/**
|
|
3337
|
-
* Format: date-time
|
|
3338
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3339
|
-
*/
|
|
3340
|
-
updatedAt?: string;
|
|
3341
|
-
/** @description App connection type ID (e.g. the OAuth2 or API key connection definition of the app). Included when `expansion=connectionId` is requested. */
|
|
3342
|
-
connectionId?: string;
|
|
3343
|
-
/** @description ID of the workflow app this connection belongs to. Included when `expansion=workflowAppId` or `expansion=workflowApp` is requested. */
|
|
3344
|
-
workflowAppId?: string;
|
|
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"];
|
|
3351
|
-
};
|
|
3352
3206
|
ManuallyRunWorkflowInputDataDto: {
|
|
3353
3207
|
/**
|
|
3354
3208
|
* @description Values for the custom input fields configured on the workflow "Manually Run" trigger, keyed by field ID. Pass an empty object when the trigger defines no custom input fields.
|
|
@@ -3371,21 +3225,13 @@ interface components {
|
|
|
3371
3225
|
/** @description Workspace name */
|
|
3372
3226
|
name: string;
|
|
3373
3227
|
};
|
|
3374
|
-
ExecutionProjectSummaryDto: {
|
|
3375
|
-
/** @description Project ID */
|
|
3376
|
-
id: string;
|
|
3377
|
-
/** @description Project name */
|
|
3378
|
-
name: string;
|
|
3379
|
-
/** @description The workspace the project belongs to. Included when `expansion=workspace` is requested alongside `workflow` and `project`. */
|
|
3380
|
-
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
3381
|
-
};
|
|
3382
3228
|
ExecutionWorkflowSummaryDto: {
|
|
3383
3229
|
/** @description Workflow ID */
|
|
3384
3230
|
id: string;
|
|
3385
3231
|
/** @description Workflow name */
|
|
3386
3232
|
name: string;
|
|
3387
|
-
/** @description The
|
|
3388
|
-
|
|
3233
|
+
/** @description The workspace the workflow belongs to. Included when `expansion=workspace` is requested alongside `workflow`. */
|
|
3234
|
+
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
3389
3235
|
};
|
|
3390
3236
|
ExecutionPathStepDto: {
|
|
3391
3237
|
/** @description ID of the workflow node this step represents */
|
|
@@ -3533,8 +3379,6 @@ interface components {
|
|
|
3533
3379
|
actionId: string;
|
|
3534
3380
|
/** @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. */
|
|
3535
3381
|
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. */
|
|
3537
|
-
projectId?: string;
|
|
3538
3382
|
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
3539
3383
|
input?: {
|
|
3540
3384
|
[key: string]: unknown;
|
|
@@ -3542,44 +3386,194 @@ interface components {
|
|
|
3542
3386
|
/** @description Optional display name for the ad-hoc Execution. */
|
|
3543
3387
|
name?: string;
|
|
3544
3388
|
};
|
|
3545
|
-
RunActionResponseDto: {
|
|
3546
|
-
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
3389
|
+
RunActionResponseDto: {
|
|
3390
|
+
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
3391
|
+
id: string;
|
|
3392
|
+
/**
|
|
3393
|
+
* @description Final execution status after the single action step.
|
|
3394
|
+
* @enum {string}
|
|
3395
|
+
*/
|
|
3396
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
3397
|
+
/** @description Human-readable status detail. */
|
|
3398
|
+
statusMessage?: string | null;
|
|
3399
|
+
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
3400
|
+
output?: {
|
|
3401
|
+
[key: string]: unknown;
|
|
3402
|
+
} | null;
|
|
3403
|
+
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
3404
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3405
|
+
};
|
|
3406
|
+
RunStepDto: {
|
|
3407
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3408
|
+
appId: string;
|
|
3409
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
3410
|
+
actionId: string;
|
|
3411
|
+
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
3412
|
+
connectionId?: string;
|
|
3413
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
3414
|
+
input?: {
|
|
3415
|
+
[key: string]: unknown;
|
|
3416
|
+
};
|
|
3417
|
+
/** @description Optional display name for this step. */
|
|
3418
|
+
name?: string;
|
|
3419
|
+
};
|
|
3420
|
+
StartRunDto: {
|
|
3421
|
+
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
3422
|
+
steps: components["schemas"]["RunStepDto"][];
|
|
3423
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
3424
|
+
name?: string;
|
|
3425
|
+
};
|
|
3426
|
+
CreateVariableDto: {
|
|
3427
|
+
/** @description Name of the variable. */
|
|
3428
|
+
name: string;
|
|
3429
|
+
/** @description Description of the variable. */
|
|
3430
|
+
description?: string;
|
|
3431
|
+
/**
|
|
3432
|
+
* @description Scope of the variable (system or workspace).
|
|
3433
|
+
* @enum {string}
|
|
3434
|
+
*/
|
|
3435
|
+
type: "system" | "workspace";
|
|
3436
|
+
/**
|
|
3437
|
+
* @description Data type of the variable value.
|
|
3438
|
+
* @enum {string}
|
|
3439
|
+
*/
|
|
3440
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3441
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3442
|
+
value: string;
|
|
3443
|
+
};
|
|
3444
|
+
VariableWorkspaceDto: {
|
|
3445
|
+
/** @description Workspace ID. */
|
|
3446
|
+
id: string;
|
|
3447
|
+
/** @description Workspace name. */
|
|
3448
|
+
name: string;
|
|
3449
|
+
};
|
|
3450
|
+
VariableResponseDto: {
|
|
3451
|
+
/** @description Variable ID. */
|
|
3452
|
+
id: string;
|
|
3453
|
+
/** @description Variable name. */
|
|
3454
|
+
name: string;
|
|
3455
|
+
/**
|
|
3456
|
+
* @description Data type of the variable value.
|
|
3457
|
+
* @enum {string}
|
|
3458
|
+
*/
|
|
3459
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
3460
|
+
/**
|
|
3461
|
+
* @description Scope of the variable (system or workspace).
|
|
3462
|
+
* @enum {string}
|
|
3463
|
+
*/
|
|
3464
|
+
type: "system" | "workspace";
|
|
3465
|
+
/** @description Variable value. Included when `expansion=value` is requested. */
|
|
3466
|
+
value?: Record<string, never>;
|
|
3467
|
+
/** @description Variable description. Included when `expansion=description` is requested. */
|
|
3468
|
+
description?: string;
|
|
3469
|
+
/**
|
|
3470
|
+
* Format: date-time
|
|
3471
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3472
|
+
*/
|
|
3473
|
+
createdAt?: string;
|
|
3474
|
+
/**
|
|
3475
|
+
* Format: date-time
|
|
3476
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3477
|
+
*/
|
|
3478
|
+
updatedAt?: string;
|
|
3479
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3480
|
+
workspace?: components["schemas"]["VariableWorkspaceDto"];
|
|
3481
|
+
};
|
|
3482
|
+
UpdateVariableDto: {
|
|
3483
|
+
/** @description Name of the variable. */
|
|
3484
|
+
name?: string;
|
|
3485
|
+
/** @description Description of the variable. */
|
|
3486
|
+
description?: string;
|
|
3487
|
+
/**
|
|
3488
|
+
* @description Scope of the variable (system or workspace).
|
|
3489
|
+
* @enum {string}
|
|
3490
|
+
*/
|
|
3491
|
+
type?: "system" | "workspace";
|
|
3492
|
+
/**
|
|
3493
|
+
* @description Data type of the variable value.
|
|
3494
|
+
* @enum {string}
|
|
3495
|
+
*/
|
|
3496
|
+
dataType?: "string" | "number" | "boolean" | "date" | "json";
|
|
3497
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
3498
|
+
value?: string;
|
|
3499
|
+
};
|
|
3500
|
+
UpsertTableBySlugDto: {
|
|
3501
|
+
/** @description Display name of the table. */
|
|
3502
|
+
name?: string;
|
|
3503
|
+
/** @description What the table contains. Agents use this to choose a table. */
|
|
3504
|
+
description?: string;
|
|
3505
|
+
/** @description Column names: [{ key }]. */
|
|
3506
|
+
columns?: {
|
|
3507
|
+
[key: string]: unknown;
|
|
3508
|
+
}[];
|
|
3509
|
+
/** @description Rows as objects keyed by column name. */
|
|
3510
|
+
rows?: {
|
|
3511
|
+
[key: string]: unknown;
|
|
3512
|
+
}[];
|
|
3513
|
+
/** @description Stable workspace-unique key. Used as the upsert key. */
|
|
3514
|
+
slug: string;
|
|
3515
|
+
/** @description Marks the table as code-managed. Defaults to true on upsert. */
|
|
3516
|
+
managedByCode?: boolean;
|
|
3517
|
+
};
|
|
3518
|
+
TableColumnDto: {
|
|
3519
|
+
/** @description Column key used in rows. */
|
|
3520
|
+
key: string;
|
|
3521
|
+
/** @description Display label. */
|
|
3522
|
+
label: string;
|
|
3523
|
+
};
|
|
3524
|
+
TableResponseDto: {
|
|
3525
|
+
/** @description Table ID. */
|
|
3526
|
+
id: string;
|
|
3527
|
+
/** @description Display name. */
|
|
3528
|
+
name: string;
|
|
3529
|
+
/** @description Stable key, unique within the workspace. */
|
|
3530
|
+
slug: string;
|
|
3531
|
+
/** @description What the table contains. */
|
|
3532
|
+
description?: string | null;
|
|
3533
|
+
/** @description Whether the table is managed by code (CLI / API upsert). */
|
|
3534
|
+
managedByCode: boolean;
|
|
3535
|
+
/** @description Columns. Returned by get and upsert, not by list. */
|
|
3536
|
+
columns?: components["schemas"]["TableColumnDto"][];
|
|
3537
|
+
/** @description Rows keyed by column key. Returned by get and upsert, not by list. */
|
|
3538
|
+
rows?: {
|
|
3539
|
+
[key: string]: unknown;
|
|
3540
|
+
}[];
|
|
3541
|
+
/** Format: date-time */
|
|
3542
|
+
createdAt: string;
|
|
3543
|
+
/** Format: date-time */
|
|
3544
|
+
updatedAt: string;
|
|
3545
|
+
};
|
|
3546
|
+
ConnectionWorkspaceDto: {
|
|
3547
|
+
/** @description Workspace ID. */
|
|
3548
|
+
id: string;
|
|
3549
|
+
/** @description Workspace name. */
|
|
3550
|
+
name: string;
|
|
3551
|
+
};
|
|
3552
|
+
ConnectionResponseDto: {
|
|
3553
|
+
/** @description Connection ID. */
|
|
3547
3554
|
id: string;
|
|
3555
|
+
/** @description Connection name. */
|
|
3556
|
+
name: string;
|
|
3548
3557
|
/**
|
|
3549
|
-
*
|
|
3550
|
-
* @
|
|
3558
|
+
* Format: date-time
|
|
3559
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
3551
3560
|
*/
|
|
3552
|
-
|
|
3553
|
-
/**
|
|
3554
|
-
|
|
3555
|
-
|
|
3556
|
-
|
|
3557
|
-
|
|
3558
|
-
|
|
3559
|
-
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
3560
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
3561
|
-
};
|
|
3562
|
-
RunStepDto: {
|
|
3563
|
-
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
3564
|
-
appId: string;
|
|
3565
|
-
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
3566
|
-
actionId: string;
|
|
3567
|
-
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
3561
|
+
createdAt?: string;
|
|
3562
|
+
/**
|
|
3563
|
+
* Format: date-time
|
|
3564
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
3565
|
+
*/
|
|
3566
|
+
updatedAt?: string;
|
|
3567
|
+
/** @description App connection type ID (e.g. the OAuth2 or API key connection definition of the app). Included when `expansion=connectionId` is requested. */
|
|
3568
3568
|
connectionId?: string;
|
|
3569
|
-
/** @description
|
|
3570
|
-
|
|
3569
|
+
/** @description ID of the workflow app this connection belongs to. Included when `expansion=workflowAppId` or `expansion=workflowApp` is requested. */
|
|
3570
|
+
workflowAppId?: string;
|
|
3571
|
+
/** @description Full workflow app definition for this connection. Included when `expansion=workflowApp` is requested on the list endpoint. */
|
|
3572
|
+
workflowApp?: {
|
|
3571
3573
|
[key: string]: unknown;
|
|
3572
3574
|
};
|
|
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;
|
|
3575
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
3576
|
+
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
3583
3577
|
};
|
|
3584
3578
|
TaskListItemResponseDto: {
|
|
3585
3579
|
/**
|
|
@@ -3623,14 +3617,10 @@ interface components {
|
|
|
3623
3617
|
[key: string]: unknown;
|
|
3624
3618
|
} | null;
|
|
3625
3619
|
}[];
|
|
3626
|
-
/** @description Agent the task belongs to. Included when `expansion=agent` is requested.
|
|
3620
|
+
/** @description Agent the task belongs to. Included when `expansion=agent` is requested. */
|
|
3627
3621
|
agent?: {
|
|
3628
3622
|
id?: string;
|
|
3629
3623
|
name?: string;
|
|
3630
|
-
project?: {
|
|
3631
|
-
id?: string;
|
|
3632
|
-
name?: string;
|
|
3633
|
-
};
|
|
3634
3624
|
};
|
|
3635
3625
|
};
|
|
3636
3626
|
TaskLatestRunDto: {
|
|
@@ -3705,14 +3695,10 @@ interface components {
|
|
|
3705
3695
|
[key: string]: unknown;
|
|
3706
3696
|
} | null;
|
|
3707
3697
|
}[];
|
|
3708
|
-
/** @description Agent the task belongs to. Included when `expansion=agent` is requested.
|
|
3698
|
+
/** @description Agent the task belongs to. Included when `expansion=agent` is requested. */
|
|
3709
3699
|
agent?: {
|
|
3710
3700
|
id?: string;
|
|
3711
3701
|
name?: string;
|
|
3712
|
-
project?: {
|
|
3713
|
-
id?: string;
|
|
3714
|
-
name?: string;
|
|
3715
|
-
};
|
|
3716
3702
|
};
|
|
3717
3703
|
};
|
|
3718
3704
|
UpdateTaskDto: {
|
|
@@ -3800,12 +3786,9 @@ interface components {
|
|
|
3800
3786
|
* "imageUrl": "https://example.com/image.png"
|
|
3801
3787
|
* }
|
|
3802
3788
|
*/
|
|
3803
|
-
data?:
|
|
3804
|
-
/** @description URL of an image attached to the message. */
|
|
3805
|
-
imageUrl?: string;
|
|
3806
|
-
};
|
|
3789
|
+
data?: Record<string, never>;
|
|
3807
3790
|
/**
|
|
3808
|
-
* @description Answer to an ask
|
|
3791
|
+
* @description Answer to an "ask before sending" personal-data prompt. Applies to this message only.
|
|
3809
3792
|
* @enum {string}
|
|
3810
3793
|
*/
|
|
3811
3794
|
piiResolution?: "anonymize" | "fallback";
|
|
@@ -3844,85 +3827,10 @@ interface operations {
|
|
|
3844
3827
|
};
|
|
3845
3828
|
};
|
|
3846
3829
|
};
|
|
3847
|
-
ProjectsController_findAllForWorkspace: {
|
|
3848
|
-
parameters: {
|
|
3849
|
-
query?: {
|
|
3850
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, description, workflows, createdByWorkspaceUser, countAgents, countVariables, countWorkflows */
|
|
3851
|
-
expansion?: string;
|
|
3852
|
-
};
|
|
3853
|
-
header?: never;
|
|
3854
|
-
path?: never;
|
|
3855
|
-
cookie?: never;
|
|
3856
|
-
};
|
|
3857
|
-
requestBody?: never;
|
|
3858
|
-
responses: {
|
|
3859
|
-
/** @description Projects in the workspace. */
|
|
3860
|
-
200: {
|
|
3861
|
-
headers: {
|
|
3862
|
-
[name: string]: unknown;
|
|
3863
|
-
};
|
|
3864
|
-
content: {
|
|
3865
|
-
"application/json": components["schemas"]["ProjectResponseDto"][];
|
|
3866
|
-
};
|
|
3867
|
-
};
|
|
3868
|
-
};
|
|
3869
|
-
};
|
|
3870
|
-
ProjectsController_create: {
|
|
3871
|
-
parameters: {
|
|
3872
|
-
query?: {
|
|
3873
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, description, workflows, createdByWorkspaceUser, countAgents, countVariables, countWorkflows */
|
|
3874
|
-
expansion?: string;
|
|
3875
|
-
};
|
|
3876
|
-
header?: never;
|
|
3877
|
-
path?: never;
|
|
3878
|
-
cookie?: never;
|
|
3879
|
-
};
|
|
3880
|
-
requestBody: {
|
|
3881
|
-
content: {
|
|
3882
|
-
"application/json": components["schemas"]["CreateProjectDto"];
|
|
3883
|
-
};
|
|
3884
|
-
};
|
|
3885
|
-
responses: {
|
|
3886
|
-
/** @description The created project. */
|
|
3887
|
-
201: {
|
|
3888
|
-
headers: {
|
|
3889
|
-
[name: string]: unknown;
|
|
3890
|
-
};
|
|
3891
|
-
content: {
|
|
3892
|
-
"application/json": components["schemas"]["ProjectResponseDto"];
|
|
3893
|
-
};
|
|
3894
|
-
};
|
|
3895
|
-
};
|
|
3896
|
-
};
|
|
3897
|
-
ProjectsController_findOne: {
|
|
3898
|
-
parameters: {
|
|
3899
|
-
query?: {
|
|
3900
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, description, workflows, createdByWorkspaceUser, countAgents, countVariables, countWorkflows */
|
|
3901
|
-
expansion?: string;
|
|
3902
|
-
};
|
|
3903
|
-
header?: never;
|
|
3904
|
-
path: {
|
|
3905
|
-
projectId: string;
|
|
3906
|
-
};
|
|
3907
|
-
cookie?: never;
|
|
3908
|
-
};
|
|
3909
|
-
requestBody?: never;
|
|
3910
|
-
responses: {
|
|
3911
|
-
/** @description The requested project. */
|
|
3912
|
-
200: {
|
|
3913
|
-
headers: {
|
|
3914
|
-
[name: string]: unknown;
|
|
3915
|
-
};
|
|
3916
|
-
content: {
|
|
3917
|
-
"application/json": components["schemas"]["ProjectResponseDto"];
|
|
3918
|
-
};
|
|
3919
|
-
};
|
|
3920
|
-
};
|
|
3921
|
-
};
|
|
3922
3830
|
QueuesController_findAllForWorkspace: {
|
|
3923
3831
|
parameters: {
|
|
3924
3832
|
query?: {
|
|
3925
|
-
/** @description Comma-separated key:value filter pairs. Available keys:
|
|
3833
|
+
/** @description Comma-separated key:value filter pairs. Available keys: isActive, search, priority. */
|
|
3926
3834
|
filterBy?: string;
|
|
3927
3835
|
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, description, project, workspace, createdByWorkspaceUser, statistics, itemCounts. */
|
|
3928
3836
|
expansion?: string;
|
|
@@ -3948,9 +3856,7 @@ interface operations {
|
|
|
3948
3856
|
};
|
|
3949
3857
|
QueuesController_create: {
|
|
3950
3858
|
parameters: {
|
|
3951
|
-
query
|
|
3952
|
-
/** @description ID of the project the queue belongs to. */
|
|
3953
|
-
projectId: string;
|
|
3859
|
+
query?: {
|
|
3954
3860
|
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, description, project, workspace, createdByWorkspaceUser, statistics, itemCounts. */
|
|
3955
3861
|
expansion?: string;
|
|
3956
3862
|
};
|
|
@@ -4578,183 +4484,308 @@ interface operations {
|
|
|
4578
4484
|
};
|
|
4579
4485
|
requestBody: {
|
|
4580
4486
|
content: {
|
|
4581
|
-
"application/json": components["schemas"]["LinkExecutionDto"];
|
|
4487
|
+
"application/json": components["schemas"]["LinkExecutionDto"];
|
|
4488
|
+
};
|
|
4489
|
+
};
|
|
4490
|
+
responses: {
|
|
4491
|
+
/** @description The queue item with the linked execution. */
|
|
4492
|
+
200: {
|
|
4493
|
+
headers: {
|
|
4494
|
+
[name: string]: unknown;
|
|
4495
|
+
};
|
|
4496
|
+
content: {
|
|
4497
|
+
"application/json": components["schemas"]["QueueItemResponseDto"];
|
|
4498
|
+
};
|
|
4499
|
+
};
|
|
4500
|
+
};
|
|
4501
|
+
};
|
|
4502
|
+
QueueItemsController_retryItem: {
|
|
4503
|
+
parameters: {
|
|
4504
|
+
query?: {
|
|
4505
|
+
/** @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). */
|
|
4506
|
+
expansion?: string;
|
|
4507
|
+
};
|
|
4508
|
+
header?: never;
|
|
4509
|
+
path: {
|
|
4510
|
+
queueId: string;
|
|
4511
|
+
itemId: string;
|
|
4512
|
+
};
|
|
4513
|
+
cookie?: never;
|
|
4514
|
+
};
|
|
4515
|
+
requestBody?: never;
|
|
4516
|
+
responses: {
|
|
4517
|
+
/** @description The queue item transitioned to RETRYING. */
|
|
4518
|
+
201: {
|
|
4519
|
+
headers: {
|
|
4520
|
+
[name: string]: unknown;
|
|
4521
|
+
};
|
|
4522
|
+
content: {
|
|
4523
|
+
"application/json": components["schemas"]["QueueItemResponseDto"];
|
|
4524
|
+
};
|
|
4525
|
+
};
|
|
4526
|
+
};
|
|
4527
|
+
};
|
|
4528
|
+
QueueItemsController_addError: {
|
|
4529
|
+
parameters: {
|
|
4530
|
+
query?: {
|
|
4531
|
+
/** @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). */
|
|
4532
|
+
expansion?: string;
|
|
4533
|
+
};
|
|
4534
|
+
header?: never;
|
|
4535
|
+
path: {
|
|
4536
|
+
queueId: string;
|
|
4537
|
+
itemId: string;
|
|
4538
|
+
};
|
|
4539
|
+
cookie?: never;
|
|
4540
|
+
};
|
|
4541
|
+
requestBody: {
|
|
4542
|
+
content: {
|
|
4543
|
+
"application/json": components["schemas"]["AddErrorDto"];
|
|
4544
|
+
};
|
|
4545
|
+
};
|
|
4546
|
+
responses: {
|
|
4547
|
+
/** @description The queue item after the error was recorded. */
|
|
4548
|
+
201: {
|
|
4549
|
+
headers: {
|
|
4550
|
+
[name: string]: unknown;
|
|
4551
|
+
};
|
|
4552
|
+
content: {
|
|
4553
|
+
"application/json": components["schemas"]["QueueItemResponseDto"];
|
|
4554
|
+
};
|
|
4555
|
+
};
|
|
4556
|
+
};
|
|
4557
|
+
};
|
|
4558
|
+
ObjectQueueItemsController_listForObject: {
|
|
4559
|
+
parameters: {
|
|
4560
|
+
query?: {
|
|
4561
|
+
/** @description Optional status filter */
|
|
4562
|
+
status?: "PENDING" | "PROCESSING" | "SUCCESS" | "FAILED" | "RETRYING";
|
|
4563
|
+
/** @description Maximum number of items to return. */
|
|
4564
|
+
limit?: number;
|
|
4565
|
+
/** @description Number of items to skip for pagination. */
|
|
4566
|
+
offset?: number;
|
|
4567
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Defaults include queue and object. */
|
|
4568
|
+
expansion?: string;
|
|
4569
|
+
};
|
|
4570
|
+
header?: never;
|
|
4571
|
+
path: {
|
|
4572
|
+
/** @description Object (entity) ID */
|
|
4573
|
+
objectId: string;
|
|
4574
|
+
};
|
|
4575
|
+
cookie?: never;
|
|
4576
|
+
};
|
|
4577
|
+
requestBody?: never;
|
|
4578
|
+
responses: {
|
|
4579
|
+
/** @description Queue items linked to the Object. */
|
|
4580
|
+
200: {
|
|
4581
|
+
headers: {
|
|
4582
|
+
[name: string]: unknown;
|
|
4583
|
+
};
|
|
4584
|
+
content: {
|
|
4585
|
+
"application/json": components["schemas"]["QueueItemListResponseDto"];
|
|
4586
|
+
};
|
|
4587
|
+
};
|
|
4588
|
+
};
|
|
4589
|
+
};
|
|
4590
|
+
WorkflowsController_findAllForWorkspace: {
|
|
4591
|
+
parameters: {
|
|
4592
|
+
query?: {
|
|
4593
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include internal workflows, which are excluded by default. */
|
|
4594
|
+
includeType?: string;
|
|
4595
|
+
/** @description Comma-separated key:value filters. Available: agentCanTrigger. Example: filterBy=agentCanTrigger:true */
|
|
4596
|
+
filterBy?: string;
|
|
4597
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, isActive, isInternal, description, output, nodes, edges, triggerNode, triggerAndActionIds, pollStorage, nextScheduledExecution, orientation. Example: expansion=description,isActive */
|
|
4598
|
+
expansion?: string;
|
|
4599
|
+
};
|
|
4600
|
+
header?: never;
|
|
4601
|
+
path?: never;
|
|
4602
|
+
cookie?: never;
|
|
4603
|
+
};
|
|
4604
|
+
requestBody?: never;
|
|
4605
|
+
responses: {
|
|
4606
|
+
/** @description List of workflows. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4607
|
+
200: {
|
|
4608
|
+
headers: {
|
|
4609
|
+
[name: string]: unknown;
|
|
4610
|
+
};
|
|
4611
|
+
content: {
|
|
4612
|
+
"application/json": components["schemas"]["WorkflowResponseDto"][];
|
|
4613
|
+
};
|
|
4614
|
+
};
|
|
4615
|
+
};
|
|
4616
|
+
};
|
|
4617
|
+
WorkflowsController_upsertBySlug: {
|
|
4618
|
+
parameters: {
|
|
4619
|
+
query?: never;
|
|
4620
|
+
header?: never;
|
|
4621
|
+
path?: never;
|
|
4622
|
+
cookie?: never;
|
|
4623
|
+
};
|
|
4624
|
+
requestBody: {
|
|
4625
|
+
content: {
|
|
4626
|
+
"application/json": components["schemas"]["UpsertWorkflowBySlugDto"];
|
|
4582
4627
|
};
|
|
4583
4628
|
};
|
|
4584
4629
|
responses: {
|
|
4585
|
-
/** @description The
|
|
4630
|
+
/** @description The created or updated workflow. */
|
|
4586
4631
|
200: {
|
|
4587
4632
|
headers: {
|
|
4588
4633
|
[name: string]: unknown;
|
|
4589
4634
|
};
|
|
4590
4635
|
content: {
|
|
4591
|
-
"application/json": components["schemas"]["
|
|
4636
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4592
4637
|
};
|
|
4593
4638
|
};
|
|
4594
4639
|
};
|
|
4595
4640
|
};
|
|
4596
|
-
|
|
4641
|
+
WorkflowsController_findOne: {
|
|
4597
4642
|
parameters: {
|
|
4598
4643
|
query?: {
|
|
4599
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt,
|
|
4644
|
+
/** @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
4645
|
expansion?: string;
|
|
4601
4646
|
};
|
|
4602
4647
|
header?: never;
|
|
4603
4648
|
path: {
|
|
4604
|
-
|
|
4605
|
-
itemId: string;
|
|
4649
|
+
workflowId: string;
|
|
4606
4650
|
};
|
|
4607
4651
|
cookie?: never;
|
|
4608
4652
|
};
|
|
4609
4653
|
requestBody?: never;
|
|
4610
4654
|
responses: {
|
|
4611
|
-
/** @description The
|
|
4612
|
-
|
|
4655
|
+
/** @description The workflow. Fields beyond the ID and name are included according to the expansion query parameter. */
|
|
4656
|
+
200: {
|
|
4613
4657
|
headers: {
|
|
4614
4658
|
[name: string]: unknown;
|
|
4615
4659
|
};
|
|
4616
4660
|
content: {
|
|
4617
|
-
"application/json": components["schemas"]["
|
|
4661
|
+
"application/json": components["schemas"]["WorkflowResponseDto"];
|
|
4618
4662
|
};
|
|
4619
4663
|
};
|
|
4620
4664
|
};
|
|
4621
4665
|
};
|
|
4622
|
-
|
|
4666
|
+
AgentsController_findAllForWorkspace: {
|
|
4623
4667
|
parameters: {
|
|
4624
4668
|
query?: {
|
|
4625
|
-
/** @description Comma-separated
|
|
4669
|
+
/** @description Comma-separated include flags, e.g. `includeType=all`. Available: all */
|
|
4670
|
+
includeType?: string;
|
|
4671
|
+
/** @description Filters in `key:value` format, comma-separated. */
|
|
4672
|
+
filterBy?: string;
|
|
4673
|
+
/** @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, 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 */
|
|
4626
4674
|
expansion?: string;
|
|
4627
4675
|
};
|
|
4628
4676
|
header?: never;
|
|
4629
|
-
path
|
|
4630
|
-
queueId: string;
|
|
4631
|
-
itemId: string;
|
|
4632
|
-
};
|
|
4677
|
+
path?: never;
|
|
4633
4678
|
cookie?: never;
|
|
4634
4679
|
};
|
|
4635
|
-
requestBody
|
|
4636
|
-
content: {
|
|
4637
|
-
"application/json": components["schemas"]["AddErrorDto"];
|
|
4638
|
-
};
|
|
4639
|
-
};
|
|
4680
|
+
requestBody?: never;
|
|
4640
4681
|
responses: {
|
|
4641
|
-
/** @description
|
|
4642
|
-
|
|
4682
|
+
/** @description Agents in the current workspace */
|
|
4683
|
+
200: {
|
|
4643
4684
|
headers: {
|
|
4644
4685
|
[name: string]: unknown;
|
|
4645
4686
|
};
|
|
4646
4687
|
content: {
|
|
4647
|
-
"application/json": components["schemas"]["
|
|
4688
|
+
"application/json": components["schemas"]["AgentResponseDto"][];
|
|
4648
4689
|
};
|
|
4649
4690
|
};
|
|
4650
4691
|
};
|
|
4651
4692
|
};
|
|
4652
|
-
|
|
4693
|
+
AgentsController_upsertBySlug: {
|
|
4653
4694
|
parameters: {
|
|
4654
|
-
query?:
|
|
4655
|
-
/** @description Optional status filter */
|
|
4656
|
-
status?: "PENDING" | "PROCESSING" | "SUCCESS" | "FAILED" | "RETRYING";
|
|
4657
|
-
/** @description Maximum number of items to return. */
|
|
4658
|
-
limit?: number;
|
|
4659
|
-
/** @description Number of items to skip for pagination. */
|
|
4660
|
-
offset?: number;
|
|
4661
|
-
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, queue, lastExecution, errorHistory, object. Defaults include queue and object. */
|
|
4662
|
-
expansion?: string;
|
|
4663
|
-
};
|
|
4695
|
+
query?: never;
|
|
4664
4696
|
header?: never;
|
|
4665
|
-
path
|
|
4666
|
-
/** @description Object (entity) ID */
|
|
4667
|
-
objectId: string;
|
|
4668
|
-
};
|
|
4697
|
+
path?: never;
|
|
4669
4698
|
cookie?: never;
|
|
4670
4699
|
};
|
|
4671
|
-
requestBody
|
|
4700
|
+
requestBody: {
|
|
4701
|
+
content: {
|
|
4702
|
+
"application/json": components["schemas"]["UpsertAgentBySlugDto"];
|
|
4703
|
+
};
|
|
4704
|
+
};
|
|
4672
4705
|
responses: {
|
|
4673
|
-
/** @description
|
|
4706
|
+
/** @description The created or updated agent. */
|
|
4674
4707
|
200: {
|
|
4675
4708
|
headers: {
|
|
4676
4709
|
[name: string]: unknown;
|
|
4677
4710
|
};
|
|
4678
4711
|
content: {
|
|
4679
|
-
"application/json": components["schemas"]["
|
|
4712
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
4680
4713
|
};
|
|
4681
4714
|
};
|
|
4682
4715
|
};
|
|
4683
4716
|
};
|
|
4684
|
-
|
|
4717
|
+
AgentsController_findOne: {
|
|
4685
4718
|
parameters: {
|
|
4686
4719
|
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 */
|
|
4720
|
+
/** @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, 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
4721
|
expansion?: string;
|
|
4693
4722
|
};
|
|
4694
4723
|
header?: never;
|
|
4695
|
-
path
|
|
4724
|
+
path: {
|
|
4725
|
+
agentId: string;
|
|
4726
|
+
};
|
|
4696
4727
|
cookie?: never;
|
|
4697
4728
|
};
|
|
4698
4729
|
requestBody?: never;
|
|
4699
4730
|
responses: {
|
|
4700
|
-
/** @description
|
|
4731
|
+
/** @description The requested agent */
|
|
4701
4732
|
200: {
|
|
4702
4733
|
headers: {
|
|
4703
4734
|
[name: string]: unknown;
|
|
4704
4735
|
};
|
|
4705
4736
|
content: {
|
|
4706
|
-
"application/json": components["schemas"]["
|
|
4737
|
+
"application/json": components["schemas"]["AgentResponseDto"];
|
|
4707
4738
|
};
|
|
4708
4739
|
};
|
|
4709
4740
|
};
|
|
4710
4741
|
};
|
|
4711
|
-
|
|
4742
|
+
WorkflowAppsController_findAll: {
|
|
4712
4743
|
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
|
-
};
|
|
4744
|
+
query?: never;
|
|
4717
4745
|
header?: never;
|
|
4718
|
-
path
|
|
4719
|
-
workflowId: string;
|
|
4720
|
-
};
|
|
4746
|
+
path?: never;
|
|
4721
4747
|
cookie?: never;
|
|
4722
4748
|
};
|
|
4723
4749
|
requestBody?: never;
|
|
4724
4750
|
responses: {
|
|
4725
|
-
/** @description
|
|
4751
|
+
/** @description All workflow app definitions. */
|
|
4726
4752
|
200: {
|
|
4727
4753
|
headers: {
|
|
4728
4754
|
[name: string]: unknown;
|
|
4729
4755
|
};
|
|
4730
4756
|
content: {
|
|
4731
|
-
"application/json": components["schemas"]["
|
|
4757
|
+
"application/json": components["schemas"]["WorkflowAppResponseDto"][];
|
|
4732
4758
|
};
|
|
4733
4759
|
};
|
|
4734
4760
|
};
|
|
4735
4761
|
};
|
|
4736
|
-
|
|
4762
|
+
WorkflowAppsController_connectApp: {
|
|
4737
4763
|
parameters: {
|
|
4738
4764
|
query?: never;
|
|
4739
4765
|
header?: never;
|
|
4740
4766
|
path: {
|
|
4741
|
-
|
|
4767
|
+
appId: string;
|
|
4768
|
+
connectionId: string;
|
|
4742
4769
|
};
|
|
4743
4770
|
cookie?: never;
|
|
4744
4771
|
};
|
|
4745
4772
|
requestBody: {
|
|
4746
4773
|
content: {
|
|
4747
|
-
"application/json":
|
|
4774
|
+
"application/json": {
|
|
4775
|
+
[key: string]: unknown;
|
|
4776
|
+
};
|
|
4748
4777
|
};
|
|
4749
4778
|
};
|
|
4750
4779
|
responses: {
|
|
4751
|
-
/** @description
|
|
4780
|
+
/** @description Result of the connection attempt, written by the app connection handler. */
|
|
4752
4781
|
200: {
|
|
4753
4782
|
headers: {
|
|
4754
4783
|
[name: string]: unknown;
|
|
4755
4784
|
};
|
|
4756
4785
|
content: {
|
|
4757
|
-
"application/json":
|
|
4786
|
+
"application/json": {
|
|
4787
|
+
[key: string]: unknown;
|
|
4788
|
+
};
|
|
4758
4789
|
};
|
|
4759
4790
|
};
|
|
4760
4791
|
};
|
|
@@ -4762,8 +4793,10 @@ interface operations {
|
|
|
4762
4793
|
ObjectTypesController_findAll: {
|
|
4763
4794
|
parameters: {
|
|
4764
4795
|
query?: {
|
|
4765
|
-
/** @description Set to true to include disabled entity types. */
|
|
4796
|
+
/** @description Set to true to include disabled entity types the workspace is granted. */
|
|
4766
4797
|
includeDisabled?: boolean;
|
|
4798
|
+
/** @description Set to true to include enabled types that are not granted to the active workspace. */
|
|
4799
|
+
includeCatalog?: boolean;
|
|
4767
4800
|
/** @description Comma-separated fields to expand. Available: description, attributeSchema, stateSchema, createdAt, updatedAt, createdBy, countObjects. */
|
|
4768
4801
|
expansion?: string;
|
|
4769
4802
|
};
|
|
@@ -4866,6 +4899,8 @@ interface operations {
|
|
|
4866
4899
|
query?: {
|
|
4867
4900
|
/** @description Filter by entity type ID. */
|
|
4868
4901
|
objectTypeId?: string;
|
|
4902
|
+
/** @description Platform admin only. Limit records to this workspace. Omit to list every workspace. */
|
|
4903
|
+
workspaceId?: string;
|
|
4869
4904
|
/** @description Filter by entity type slug. */
|
|
4870
4905
|
objectTypeSlug?: string;
|
|
4871
4906
|
/** @description Filter by a single state ID. */
|
|
@@ -4882,7 +4917,7 @@ interface operations {
|
|
|
4882
4917
|
page?: number;
|
|
4883
4918
|
/** @description Items per page. Defaults to 25, capped at 100. */
|
|
4884
4919
|
pageSize?: number;
|
|
4885
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
4920
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4886
4921
|
expansion?: string;
|
|
4887
4922
|
};
|
|
4888
4923
|
header?: never;
|
|
@@ -4905,7 +4940,7 @@ interface operations {
|
|
|
4905
4940
|
ObjectsController_create: {
|
|
4906
4941
|
parameters: {
|
|
4907
4942
|
query?: {
|
|
4908
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
4943
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4909
4944
|
expansion?: string;
|
|
4910
4945
|
};
|
|
4911
4946
|
header?: never;
|
|
@@ -4932,7 +4967,7 @@ interface operations {
|
|
|
4932
4967
|
ObjectsController_findOne: {
|
|
4933
4968
|
parameters: {
|
|
4934
4969
|
query?: {
|
|
4935
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
4970
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4936
4971
|
expansion?: string;
|
|
4937
4972
|
};
|
|
4938
4973
|
header?: never;
|
|
@@ -4979,7 +5014,7 @@ interface operations {
|
|
|
4979
5014
|
ObjectsController_update: {
|
|
4980
5015
|
parameters: {
|
|
4981
5016
|
query?: {
|
|
4982
|
-
/** @description Comma-separated fields to expand. Available: attributes, objectType,
|
|
5017
|
+
/** @description Comma-separated fields to expand. Available: attributes, objectType, createdBy, createdAt, updatedAt, stateHistory. */
|
|
4983
5018
|
expansion?: string;
|
|
4984
5019
|
};
|
|
4985
5020
|
header?: never;
|
|
@@ -5192,350 +5227,369 @@ interface operations {
|
|
|
5192
5227
|
};
|
|
5193
5228
|
};
|
|
5194
5229
|
};
|
|
5195
|
-
|
|
5230
|
+
KnowledgeController_findAllForWorkspace: {
|
|
5196
5231
|
parameters: {
|
|
5197
|
-
query?:
|
|
5232
|
+
query?: {
|
|
5233
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5234
|
+
expansion?: string;
|
|
5235
|
+
};
|
|
5198
5236
|
header?: never;
|
|
5199
5237
|
path?: never;
|
|
5200
5238
|
cookie?: never;
|
|
5201
5239
|
};
|
|
5202
5240
|
requestBody?: never;
|
|
5203
5241
|
responses: {
|
|
5204
|
-
/** @description
|
|
5242
|
+
/** @description Knowledge bases in the workspace. */
|
|
5205
5243
|
200: {
|
|
5206
5244
|
headers: {
|
|
5207
5245
|
[name: string]: unknown;
|
|
5208
5246
|
};
|
|
5209
5247
|
content: {
|
|
5210
|
-
"application/json": components["schemas"]["
|
|
5248
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"][];
|
|
5211
5249
|
};
|
|
5212
5250
|
};
|
|
5213
5251
|
};
|
|
5214
5252
|
};
|
|
5215
|
-
|
|
5253
|
+
KnowledgeController_create: {
|
|
5216
5254
|
parameters: {
|
|
5217
|
-
query?:
|
|
5218
|
-
|
|
5219
|
-
|
|
5220
|
-
appId: string;
|
|
5221
|
-
connectionId: string;
|
|
5255
|
+
query?: {
|
|
5256
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5257
|
+
expansion?: string;
|
|
5222
5258
|
};
|
|
5259
|
+
header?: never;
|
|
5260
|
+
path?: never;
|
|
5223
5261
|
cookie?: never;
|
|
5224
5262
|
};
|
|
5225
5263
|
requestBody: {
|
|
5226
5264
|
content: {
|
|
5227
|
-
"application/json":
|
|
5228
|
-
[key: string]: unknown;
|
|
5229
|
-
};
|
|
5265
|
+
"application/json": components["schemas"]["CreateKnowledgeDto"];
|
|
5230
5266
|
};
|
|
5231
5267
|
};
|
|
5232
5268
|
responses: {
|
|
5233
|
-
/** @description
|
|
5234
|
-
|
|
5269
|
+
/** @description The created knowledge base. */
|
|
5270
|
+
201: {
|
|
5235
5271
|
headers: {
|
|
5236
5272
|
[name: string]: unknown;
|
|
5237
5273
|
};
|
|
5238
5274
|
content: {
|
|
5239
|
-
"application/json":
|
|
5240
|
-
[key: string]: unknown;
|
|
5241
|
-
};
|
|
5275
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5242
5276
|
};
|
|
5243
5277
|
};
|
|
5244
5278
|
};
|
|
5245
5279
|
};
|
|
5246
|
-
|
|
5280
|
+
KnowledgeController_findOne: {
|
|
5247
5281
|
parameters: {
|
|
5248
5282
|
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 */
|
|
5283
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5254
5284
|
expansion?: string;
|
|
5255
5285
|
};
|
|
5256
5286
|
header?: never;
|
|
5257
|
-
path
|
|
5287
|
+
path: {
|
|
5288
|
+
knowledgeId: string;
|
|
5289
|
+
};
|
|
5258
5290
|
cookie?: never;
|
|
5259
5291
|
};
|
|
5260
5292
|
requestBody?: never;
|
|
5261
5293
|
responses: {
|
|
5262
|
-
/** @description
|
|
5294
|
+
/** @description The requested knowledge base. */
|
|
5263
5295
|
200: {
|
|
5264
5296
|
headers: {
|
|
5265
5297
|
[name: string]: unknown;
|
|
5266
5298
|
};
|
|
5267
5299
|
content: {
|
|
5268
|
-
"application/json": components["schemas"]["
|
|
5300
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5269
5301
|
};
|
|
5270
5302
|
};
|
|
5271
5303
|
};
|
|
5272
5304
|
};
|
|
5273
|
-
|
|
5305
|
+
KnowledgeController_delete: {
|
|
5274
5306
|
parameters: {
|
|
5275
|
-
query?:
|
|
5276
|
-
/** @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 */
|
|
5277
|
-
expansion?: string;
|
|
5278
|
-
};
|
|
5307
|
+
query?: never;
|
|
5279
5308
|
header?: never;
|
|
5280
5309
|
path: {
|
|
5281
|
-
|
|
5310
|
+
knowledgeId: string;
|
|
5282
5311
|
};
|
|
5283
5312
|
cookie?: never;
|
|
5284
5313
|
};
|
|
5285
5314
|
requestBody?: never;
|
|
5286
5315
|
responses: {
|
|
5287
|
-
/** @description
|
|
5316
|
+
/** @description Returns true when the knowledge base was deleted. */
|
|
5288
5317
|
200: {
|
|
5289
5318
|
headers: {
|
|
5290
5319
|
[name: string]: unknown;
|
|
5291
5320
|
};
|
|
5292
5321
|
content: {
|
|
5293
|
-
"application/json":
|
|
5322
|
+
"application/json": boolean;
|
|
5294
5323
|
};
|
|
5295
5324
|
};
|
|
5296
5325
|
};
|
|
5297
5326
|
};
|
|
5298
|
-
|
|
5327
|
+
KnowledgeController_update: {
|
|
5299
5328
|
parameters: {
|
|
5300
|
-
query?:
|
|
5329
|
+
query?: {
|
|
5330
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, workspace, indexName, chunkSize, chunkOverlap, usage, vectorRefs, countVectorRefs, embeddingProvider, embeddingModel, dimensions */
|
|
5331
|
+
expansion?: string;
|
|
5332
|
+
};
|
|
5301
5333
|
header?: never;
|
|
5302
5334
|
path: {
|
|
5303
|
-
|
|
5335
|
+
knowledgeId: string;
|
|
5304
5336
|
};
|
|
5305
5337
|
cookie?: never;
|
|
5306
5338
|
};
|
|
5307
5339
|
requestBody: {
|
|
5308
5340
|
content: {
|
|
5309
|
-
"application/json": components["schemas"]["
|
|
5341
|
+
"application/json": components["schemas"]["UpdateKnowledgeDto"];
|
|
5310
5342
|
};
|
|
5311
5343
|
};
|
|
5312
5344
|
responses: {
|
|
5313
|
-
/** @description The
|
|
5345
|
+
/** @description The updated knowledge base. */
|
|
5314
5346
|
200: {
|
|
5315
5347
|
headers: {
|
|
5316
5348
|
[name: string]: unknown;
|
|
5317
5349
|
};
|
|
5318
5350
|
content: {
|
|
5319
|
-
"application/json": components["schemas"]["
|
|
5351
|
+
"application/json": components["schemas"]["KnowledgeResponseDto"];
|
|
5320
5352
|
};
|
|
5321
5353
|
};
|
|
5322
5354
|
};
|
|
5323
5355
|
};
|
|
5324
|
-
|
|
5356
|
+
KnowledgeController_saveUploadedTextToKnowledge: {
|
|
5325
5357
|
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
|
-
};
|
|
5358
|
+
query?: never;
|
|
5330
5359
|
header?: never;
|
|
5331
|
-
path
|
|
5360
|
+
path: {
|
|
5361
|
+
knowledgeId: string;
|
|
5362
|
+
};
|
|
5332
5363
|
cookie?: never;
|
|
5333
5364
|
};
|
|
5334
|
-
requestBody
|
|
5365
|
+
requestBody: {
|
|
5366
|
+
content: {
|
|
5367
|
+
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5368
|
+
};
|
|
5369
|
+
};
|
|
5335
5370
|
responses: {
|
|
5336
|
-
/** @description
|
|
5337
|
-
|
|
5371
|
+
/** @description Returns true when the text was embedded and stored. */
|
|
5372
|
+
201: {
|
|
5338
5373
|
headers: {
|
|
5339
5374
|
[name: string]: unknown;
|
|
5340
5375
|
};
|
|
5341
5376
|
content: {
|
|
5342
|
-
"application/json":
|
|
5377
|
+
"application/json": boolean;
|
|
5343
5378
|
};
|
|
5344
5379
|
};
|
|
5345
5380
|
};
|
|
5346
5381
|
};
|
|
5347
|
-
|
|
5382
|
+
KnowledgeController_getDocuments: {
|
|
5348
5383
|
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
|
-
};
|
|
5384
|
+
query?: never;
|
|
5353
5385
|
header?: never;
|
|
5354
|
-
path
|
|
5355
|
-
|
|
5356
|
-
};
|
|
5357
|
-
requestBody: {
|
|
5358
|
-
content: {
|
|
5359
|
-
"application/json": components["schemas"]["CreateKnowledgeDto"];
|
|
5386
|
+
path: {
|
|
5387
|
+
knowledgeId: string;
|
|
5360
5388
|
};
|
|
5389
|
+
cookie?: never;
|
|
5361
5390
|
};
|
|
5391
|
+
requestBody?: never;
|
|
5362
5392
|
responses: {
|
|
5363
|
-
/** @description
|
|
5364
|
-
|
|
5393
|
+
/** @description Documents in the knowledge base, newest first. */
|
|
5394
|
+
200: {
|
|
5365
5395
|
headers: {
|
|
5366
5396
|
[name: string]: unknown;
|
|
5367
5397
|
};
|
|
5368
5398
|
content: {
|
|
5369
|
-
"application/json": components["schemas"]["
|
|
5399
|
+
"application/json": components["schemas"]["KnowledgeDocumentResponseDto"][];
|
|
5370
5400
|
};
|
|
5371
5401
|
};
|
|
5372
5402
|
};
|
|
5373
5403
|
};
|
|
5374
|
-
|
|
5404
|
+
KnowledgeController_getDocumentGroup: {
|
|
5375
5405
|
parameters: {
|
|
5376
|
-
query?:
|
|
5377
|
-
|
|
5378
|
-
|
|
5406
|
+
query?: never;
|
|
5407
|
+
header?: never;
|
|
5408
|
+
path: {
|
|
5409
|
+
groupId: string;
|
|
5410
|
+
};
|
|
5411
|
+
cookie?: never;
|
|
5412
|
+
};
|
|
5413
|
+
requestBody?: never;
|
|
5414
|
+
responses: {
|
|
5415
|
+
/** @description The requested document group. */
|
|
5416
|
+
200: {
|
|
5417
|
+
headers: {
|
|
5418
|
+
[name: string]: unknown;
|
|
5419
|
+
};
|
|
5420
|
+
content: {
|
|
5421
|
+
"application/json": components["schemas"]["KnowledgeDocumentGroupResponseDto"];
|
|
5422
|
+
};
|
|
5379
5423
|
};
|
|
5424
|
+
};
|
|
5425
|
+
};
|
|
5426
|
+
KnowledgeController_deleteDocumentGroup: {
|
|
5427
|
+
parameters: {
|
|
5428
|
+
query?: never;
|
|
5380
5429
|
header?: never;
|
|
5381
5430
|
path: {
|
|
5382
5431
|
knowledgeId: string;
|
|
5432
|
+
groupId: string;
|
|
5383
5433
|
};
|
|
5384
5434
|
cookie?: never;
|
|
5385
5435
|
};
|
|
5386
5436
|
requestBody?: never;
|
|
5387
5437
|
responses: {
|
|
5388
|
-
/** @description
|
|
5438
|
+
/** @description Returns true when the document group was deleted. */
|
|
5389
5439
|
200: {
|
|
5390
5440
|
headers: {
|
|
5391
5441
|
[name: string]: unknown;
|
|
5392
5442
|
};
|
|
5393
5443
|
content: {
|
|
5394
|
-
"application/json":
|
|
5444
|
+
"application/json": boolean;
|
|
5395
5445
|
};
|
|
5396
5446
|
};
|
|
5397
5447
|
};
|
|
5398
5448
|
};
|
|
5399
|
-
|
|
5449
|
+
ExecutionsController_manuallyExecuteWorkflow: {
|
|
5400
5450
|
parameters: {
|
|
5401
5451
|
query?: never;
|
|
5402
5452
|
header?: never;
|
|
5403
5453
|
path: {
|
|
5404
|
-
|
|
5454
|
+
workflowId: string;
|
|
5405
5455
|
};
|
|
5406
5456
|
cookie?: never;
|
|
5407
5457
|
};
|
|
5408
|
-
requestBody
|
|
5458
|
+
requestBody: {
|
|
5459
|
+
content: {
|
|
5460
|
+
"application/json": components["schemas"]["ManuallyRunWorkflowInputDataDto"];
|
|
5461
|
+
};
|
|
5462
|
+
};
|
|
5409
5463
|
responses: {
|
|
5410
|
-
/** @description
|
|
5411
|
-
|
|
5464
|
+
/** @description The newly created execution. Only the execution ID is returned; poll GET /executions/{executionId} to track progress. */
|
|
5465
|
+
201: {
|
|
5412
5466
|
headers: {
|
|
5413
5467
|
[name: string]: unknown;
|
|
5414
5468
|
};
|
|
5415
5469
|
content: {
|
|
5416
|
-
"application/json":
|
|
5470
|
+
"application/json": components["schemas"]["ExecuteWorkflowResponseDto"];
|
|
5417
5471
|
};
|
|
5418
5472
|
};
|
|
5419
5473
|
};
|
|
5420
5474
|
};
|
|
5421
|
-
|
|
5475
|
+
ExecutionsController_findAll: {
|
|
5422
5476
|
parameters: {
|
|
5423
5477
|
query?: {
|
|
5424
|
-
/** @description Comma-separated
|
|
5478
|
+
/** @description Comma-separated inclusion flags. Available: all, internal. Pass internal to include executions of internal workflows, which are excluded by default. */
|
|
5479
|
+
includeType?: string;
|
|
5480
|
+
/** @description Comma-separated key:value filters. Available: projectId, workflowId, source (WORKFLOW|SDK), objectId. Example: filterBy=workflowId:wf_123 or filterBy=objectId:<uuid> */
|
|
5481
|
+
filterBy?: string;
|
|
5482
|
+
/** @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
5483
|
expansion?: string;
|
|
5426
5484
|
};
|
|
5427
5485
|
header?: never;
|
|
5428
|
-
path
|
|
5429
|
-
knowledgeId: string;
|
|
5430
|
-
};
|
|
5486
|
+
path?: never;
|
|
5431
5487
|
cookie?: never;
|
|
5432
5488
|
};
|
|
5433
|
-
requestBody
|
|
5434
|
-
content: {
|
|
5435
|
-
"application/json": components["schemas"]["UpdateKnowledgeDto"];
|
|
5436
|
-
};
|
|
5437
|
-
};
|
|
5489
|
+
requestBody?: never;
|
|
5438
5490
|
responses: {
|
|
5439
|
-
/** @description
|
|
5491
|
+
/** @description List of executions. Fields beyond the ID are included according to the expansion query parameter. */
|
|
5440
5492
|
200: {
|
|
5441
5493
|
headers: {
|
|
5442
5494
|
[name: string]: unknown;
|
|
5443
5495
|
};
|
|
5444
5496
|
content: {
|
|
5445
|
-
"application/json": components["schemas"]["
|
|
5497
|
+
"application/json": components["schemas"]["ExecutionResponseDto"][];
|
|
5446
5498
|
};
|
|
5447
5499
|
};
|
|
5448
5500
|
};
|
|
5449
5501
|
};
|
|
5450
|
-
|
|
5502
|
+
ExecutionsController_findOne: {
|
|
5451
5503
|
parameters: {
|
|
5452
|
-
query?:
|
|
5504
|
+
query?: {
|
|
5505
|
+
/** @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 */
|
|
5506
|
+
expansion?: string;
|
|
5507
|
+
};
|
|
5453
5508
|
header?: never;
|
|
5454
5509
|
path: {
|
|
5455
|
-
|
|
5510
|
+
executionId: string;
|
|
5456
5511
|
};
|
|
5457
5512
|
cookie?: never;
|
|
5458
5513
|
};
|
|
5459
|
-
requestBody
|
|
5460
|
-
content: {
|
|
5461
|
-
"application/json": components["schemas"]["SaveUploadedTextToKnowledgeDto"];
|
|
5462
|
-
};
|
|
5463
|
-
};
|
|
5514
|
+
requestBody?: never;
|
|
5464
5515
|
responses: {
|
|
5465
|
-
/** @description
|
|
5466
|
-
|
|
5516
|
+
/** @description The execution. Fields beyond the ID and startedAt are included according to the expansion query parameter. */
|
|
5517
|
+
200: {
|
|
5467
5518
|
headers: {
|
|
5468
5519
|
[name: string]: unknown;
|
|
5469
5520
|
};
|
|
5470
5521
|
content: {
|
|
5471
|
-
"application/json":
|
|
5522
|
+
"application/json": components["schemas"]["ExecutionResponseDto"];
|
|
5472
5523
|
};
|
|
5473
5524
|
};
|
|
5474
5525
|
};
|
|
5475
5526
|
};
|
|
5476
|
-
|
|
5527
|
+
ExecutionsController_streamExecution: {
|
|
5477
5528
|
parameters: {
|
|
5478
5529
|
query?: never;
|
|
5479
5530
|
header?: never;
|
|
5480
5531
|
path: {
|
|
5481
|
-
|
|
5532
|
+
executionId: string;
|
|
5482
5533
|
};
|
|
5483
5534
|
cookie?: never;
|
|
5484
5535
|
};
|
|
5485
5536
|
requestBody?: never;
|
|
5486
5537
|
responses: {
|
|
5487
|
-
/** @description
|
|
5538
|
+
/** @description SSE stream of execution progress, loop progress, finished, and heartbeat events */
|
|
5488
5539
|
200: {
|
|
5489
5540
|
headers: {
|
|
5490
5541
|
[name: string]: unknown;
|
|
5491
5542
|
};
|
|
5492
5543
|
content: {
|
|
5493
|
-
"
|
|
5544
|
+
"text/event-stream": string;
|
|
5494
5545
|
};
|
|
5495
5546
|
};
|
|
5496
5547
|
};
|
|
5497
5548
|
};
|
|
5498
|
-
|
|
5549
|
+
ActionsController_run: {
|
|
5499
5550
|
parameters: {
|
|
5500
5551
|
query?: never;
|
|
5501
5552
|
header?: never;
|
|
5502
|
-
path
|
|
5503
|
-
groupId: string;
|
|
5504
|
-
};
|
|
5553
|
+
path?: never;
|
|
5505
5554
|
cookie?: never;
|
|
5506
5555
|
};
|
|
5507
|
-
requestBody
|
|
5556
|
+
requestBody: {
|
|
5557
|
+
content: {
|
|
5558
|
+
"application/json": components["schemas"]["RunActionDto"];
|
|
5559
|
+
};
|
|
5560
|
+
};
|
|
5508
5561
|
responses: {
|
|
5509
|
-
/** @description The
|
|
5510
|
-
|
|
5562
|
+
/** @description The ad-hoc Execution id plus the synchronous action result (status, output, single-step executionPath). */
|
|
5563
|
+
201: {
|
|
5511
5564
|
headers: {
|
|
5512
5565
|
[name: string]: unknown;
|
|
5513
5566
|
};
|
|
5514
5567
|
content: {
|
|
5515
|
-
"application/json": components["schemas"]["
|
|
5568
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5516
5569
|
};
|
|
5517
5570
|
};
|
|
5518
5571
|
};
|
|
5519
5572
|
};
|
|
5520
|
-
|
|
5573
|
+
RunsController_start: {
|
|
5521
5574
|
parameters: {
|
|
5522
5575
|
query?: never;
|
|
5523
5576
|
header?: never;
|
|
5524
|
-
path
|
|
5525
|
-
knowledgeId: string;
|
|
5526
|
-
groupId: string;
|
|
5527
|
-
};
|
|
5577
|
+
path?: never;
|
|
5528
5578
|
cookie?: never;
|
|
5529
5579
|
};
|
|
5530
|
-
requestBody
|
|
5580
|
+
requestBody: {
|
|
5581
|
+
content: {
|
|
5582
|
+
"application/json": components["schemas"]["StartRunDto"];
|
|
5583
|
+
};
|
|
5584
|
+
};
|
|
5531
5585
|
responses: {
|
|
5532
|
-
/** @description
|
|
5533
|
-
|
|
5586
|
+
/** @description The ad-hoc Execution id plus the synchronous multi-step result (status, last-step output, executionPath). */
|
|
5587
|
+
201: {
|
|
5534
5588
|
headers: {
|
|
5535
5589
|
[name: string]: unknown;
|
|
5536
5590
|
};
|
|
5537
5591
|
content: {
|
|
5538
|
-
"application/json":
|
|
5592
|
+
"application/json": components["schemas"]["RunActionResponseDto"];
|
|
5539
5593
|
};
|
|
5540
5594
|
};
|
|
5541
5595
|
};
|
|
@@ -5545,9 +5599,9 @@ interface operations {
|
|
|
5545
5599
|
query?: {
|
|
5546
5600
|
/** @description Comma-separated include flags. Available: all */
|
|
5547
5601
|
includeType?: string;
|
|
5548
|
-
/** @description Comma-separated key:value filters.
|
|
5602
|
+
/** @description Comma-separated key:value filters. Variables are workspace-scoped; this list has no project filter. */
|
|
5549
5603
|
filterBy?: string;
|
|
5550
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace
|
|
5604
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace */
|
|
5551
5605
|
expansion?: string;
|
|
5552
5606
|
};
|
|
5553
5607
|
header?: never;
|
|
@@ -5570,7 +5624,7 @@ interface operations {
|
|
|
5570
5624
|
VariablesController_create: {
|
|
5571
5625
|
parameters: {
|
|
5572
5626
|
query?: {
|
|
5573
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace
|
|
5627
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace */
|
|
5574
5628
|
expansion?: string;
|
|
5575
5629
|
};
|
|
5576
5630
|
header?: never;
|
|
@@ -5597,7 +5651,7 @@ interface operations {
|
|
|
5597
5651
|
VariablesController_findOne: {
|
|
5598
5652
|
parameters: {
|
|
5599
5653
|
query?: {
|
|
5600
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace
|
|
5654
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace */
|
|
5601
5655
|
expansion?: string;
|
|
5602
5656
|
};
|
|
5603
5657
|
header?: never;
|
|
@@ -5644,7 +5698,7 @@ interface operations {
|
|
|
5644
5698
|
VariablesController_update: {
|
|
5645
5699
|
parameters: {
|
|
5646
5700
|
query?: {
|
|
5647
|
-
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace
|
|
5701
|
+
/** @description Comma-separated fields to expand. Available: description, createdAt, updatedAt, value, workspace */
|
|
5648
5702
|
expansion?: string;
|
|
5649
5703
|
};
|
|
5650
5704
|
header?: never;
|
|
@@ -5670,202 +5724,142 @@ interface operations {
|
|
|
5670
5724
|
};
|
|
5671
5725
|
};
|
|
5672
5726
|
};
|
|
5673
|
-
|
|
5727
|
+
TablesController_findAll: {
|
|
5674
5728
|
parameters: {
|
|
5675
|
-
query?:
|
|
5676
|
-
/** @description Comma-separated include flags. Available: all */
|
|
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;
|
|
5682
|
-
};
|
|
5729
|
+
query?: never;
|
|
5683
5730
|
header?: never;
|
|
5684
5731
|
path?: never;
|
|
5685
5732
|
cookie?: never;
|
|
5686
5733
|
};
|
|
5687
5734
|
requestBody?: never;
|
|
5688
5735
|
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. */
|
|
5736
|
+
/** @description Tables in the workspace. */
|
|
5715
5737
|
200: {
|
|
5716
5738
|
headers: {
|
|
5717
5739
|
[name: string]: unknown;
|
|
5718
5740
|
};
|
|
5719
5741
|
content: {
|
|
5720
|
-
"application/json": components["schemas"]["
|
|
5742
|
+
"application/json": components["schemas"]["TableResponseDto"][];
|
|
5721
5743
|
};
|
|
5722
5744
|
};
|
|
5723
5745
|
};
|
|
5724
5746
|
};
|
|
5725
|
-
|
|
5747
|
+
TablesController_upsertBySlug: {
|
|
5726
5748
|
parameters: {
|
|
5727
5749
|
query?: never;
|
|
5728
5750
|
header?: never;
|
|
5729
|
-
path
|
|
5730
|
-
workflowId: string;
|
|
5731
|
-
};
|
|
5751
|
+
path?: never;
|
|
5732
5752
|
cookie?: never;
|
|
5733
5753
|
};
|
|
5734
5754
|
requestBody: {
|
|
5735
5755
|
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;
|
|
5756
|
+
"application/json": components["schemas"]["UpsertTableBySlugDto"];
|
|
5760
5757
|
};
|
|
5761
|
-
header?: never;
|
|
5762
|
-
path?: never;
|
|
5763
|
-
cookie?: never;
|
|
5764
5758
|
};
|
|
5765
|
-
requestBody?: never;
|
|
5766
5759
|
responses: {
|
|
5767
|
-
/** @description
|
|
5760
|
+
/** @description The created or updated table, including columns and rows. */
|
|
5768
5761
|
200: {
|
|
5769
5762
|
headers: {
|
|
5770
5763
|
[name: string]: unknown;
|
|
5771
5764
|
};
|
|
5772
5765
|
content: {
|
|
5773
|
-
"application/json": components["schemas"]["
|
|
5766
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5774
5767
|
};
|
|
5775
5768
|
};
|
|
5776
5769
|
};
|
|
5777
5770
|
};
|
|
5778
|
-
|
|
5771
|
+
TablesController_findBySlug: {
|
|
5779
5772
|
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
|
-
};
|
|
5773
|
+
query?: never;
|
|
5784
5774
|
header?: never;
|
|
5785
5775
|
path: {
|
|
5786
|
-
|
|
5776
|
+
slug: string;
|
|
5787
5777
|
};
|
|
5788
5778
|
cookie?: never;
|
|
5789
5779
|
};
|
|
5790
5780
|
requestBody?: never;
|
|
5791
5781
|
responses: {
|
|
5792
|
-
/** @description The
|
|
5782
|
+
/** @description The requested table. */
|
|
5793
5783
|
200: {
|
|
5794
5784
|
headers: {
|
|
5795
5785
|
[name: string]: unknown;
|
|
5796
5786
|
};
|
|
5797
5787
|
content: {
|
|
5798
|
-
"application/json": components["schemas"]["
|
|
5788
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5799
5789
|
};
|
|
5800
5790
|
};
|
|
5801
5791
|
};
|
|
5802
5792
|
};
|
|
5803
|
-
|
|
5793
|
+
TablesController_findOne: {
|
|
5804
5794
|
parameters: {
|
|
5805
5795
|
query?: never;
|
|
5806
5796
|
header?: never;
|
|
5807
5797
|
path: {
|
|
5808
|
-
|
|
5798
|
+
tableId: string;
|
|
5809
5799
|
};
|
|
5810
5800
|
cookie?: never;
|
|
5811
5801
|
};
|
|
5812
5802
|
requestBody?: never;
|
|
5813
5803
|
responses: {
|
|
5814
|
-
/** @description
|
|
5804
|
+
/** @description The requested table. */
|
|
5815
5805
|
200: {
|
|
5816
5806
|
headers: {
|
|
5817
5807
|
[name: string]: unknown;
|
|
5818
5808
|
};
|
|
5819
5809
|
content: {
|
|
5820
|
-
"
|
|
5810
|
+
"application/json": components["schemas"]["TableResponseDto"];
|
|
5821
5811
|
};
|
|
5822
5812
|
};
|
|
5823
5813
|
};
|
|
5824
5814
|
};
|
|
5825
|
-
|
|
5815
|
+
ConnectionsController_findAllForWorkspace: {
|
|
5826
5816
|
parameters: {
|
|
5827
|
-
query?:
|
|
5817
|
+
query?: {
|
|
5818
|
+
/** @description Comma-separated include flags. Available: all */
|
|
5819
|
+
includeType?: string;
|
|
5820
|
+
/** @description Comma-separated key:value filters. Available: workflowAppId. Example: filterBy=workflowAppId:gmail */
|
|
5821
|
+
filterBy?: string;
|
|
5822
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
5823
|
+
expansion?: string;
|
|
5824
|
+
};
|
|
5828
5825
|
header?: never;
|
|
5829
5826
|
path?: never;
|
|
5830
5827
|
cookie?: never;
|
|
5831
5828
|
};
|
|
5832
|
-
requestBody
|
|
5833
|
-
content: {
|
|
5834
|
-
"application/json": components["schemas"]["RunActionDto"];
|
|
5835
|
-
};
|
|
5836
|
-
};
|
|
5829
|
+
requestBody?: never;
|
|
5837
5830
|
responses: {
|
|
5838
|
-
/** @description
|
|
5839
|
-
|
|
5831
|
+
/** @description Connections available in the workspace. */
|
|
5832
|
+
200: {
|
|
5840
5833
|
headers: {
|
|
5841
5834
|
[name: string]: unknown;
|
|
5842
5835
|
};
|
|
5843
5836
|
content: {
|
|
5844
|
-
"application/json": components["schemas"]["
|
|
5837
|
+
"application/json": components["schemas"]["ConnectionResponseDto"][];
|
|
5845
5838
|
};
|
|
5846
5839
|
};
|
|
5847
5840
|
};
|
|
5848
5841
|
};
|
|
5849
|
-
|
|
5842
|
+
ConnectionsController_findOne: {
|
|
5850
5843
|
parameters: {
|
|
5851
|
-
query?:
|
|
5844
|
+
query?: {
|
|
5845
|
+
/** @description Comma-separated fields to expand. Available: createdAt, updatedAt, connectionId, workflowAppId, workflowApp, workspace. Credentials are never returned. */
|
|
5846
|
+
expansion?: string;
|
|
5847
|
+
};
|
|
5852
5848
|
header?: never;
|
|
5853
|
-
path
|
|
5854
|
-
|
|
5855
|
-
};
|
|
5856
|
-
requestBody: {
|
|
5857
|
-
content: {
|
|
5858
|
-
"application/json": components["schemas"]["StartRunDto"];
|
|
5849
|
+
path: {
|
|
5850
|
+
connectionId: string;
|
|
5859
5851
|
};
|
|
5852
|
+
cookie?: never;
|
|
5860
5853
|
};
|
|
5854
|
+
requestBody?: never;
|
|
5861
5855
|
responses: {
|
|
5862
|
-
/** @description The
|
|
5863
|
-
|
|
5856
|
+
/** @description The requested connection. */
|
|
5857
|
+
200: {
|
|
5864
5858
|
headers: {
|
|
5865
5859
|
[name: string]: unknown;
|
|
5866
5860
|
};
|
|
5867
5861
|
content: {
|
|
5868
|
-
"application/json": components["schemas"]["
|
|
5862
|
+
"application/json": components["schemas"]["ConnectionResponseDto"];
|
|
5869
5863
|
};
|
|
5870
5864
|
};
|
|
5871
5865
|
};
|
|
@@ -5990,7 +5984,7 @@ interface operations {
|
|
|
5990
5984
|
query?: {
|
|
5991
5985
|
/** @description Comma-separated include flags, e.g. `includeType=all`. Available: all */
|
|
5992
5986
|
includeType?: string;
|
|
5993
|
-
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=agentId:<uuid>`. Available:
|
|
5987
|
+
/** @description Filters in `key:value` format, comma-separated, e.g. `filterBy=agentId:<uuid>`. Available: agentId */
|
|
5994
5988
|
filterBy?: string;
|
|
5995
5989
|
/** @description Comma-separated fields to expand, e.g. `expansion=description,createdAt`. Available: createdAt, updatedAt, description, agent, project, messages, messageCreatedAt, messageUsage, finishReason, customIdentifier */
|
|
5996
5990
|
expansion?: string;
|
|
@@ -6243,8 +6237,6 @@ interface operations {
|
|
|
6243
6237
|
|
|
6244
6238
|
type Schemas = components['schemas'];
|
|
6245
6239
|
type EnabledFeatures = Schemas['EnabledFeaturesResponseDto'];
|
|
6246
|
-
type Project = Schemas['ProjectResponseDto'];
|
|
6247
|
-
type CreateProjectInput = Schemas['CreateProjectDto'];
|
|
6248
6240
|
type Agent = Schemas['AgentResponseDto'];
|
|
6249
6241
|
type Task = Schemas['TaskResponseDto'];
|
|
6250
6242
|
type TaskListItem = Schemas['TaskListItemResponseDto'];
|
|
@@ -6275,6 +6267,8 @@ type EntityStateTransitions = Schemas['ObjectStateTransitionsResponseDto'];
|
|
|
6275
6267
|
type ImportEntitiesResult = Schemas['ImportEntitiesResponseDto'];
|
|
6276
6268
|
type ImportTemplate = Schemas['ImportTemplateResponseDto'];
|
|
6277
6269
|
type EntityType = Schemas['ObjectTypeResponseDto'];
|
|
6270
|
+
type Table = Schemas['TableResponseDto'];
|
|
6271
|
+
type UpsertTableBySlugInput = Schemas['UpsertTableBySlugDto'];
|
|
6278
6272
|
type Knowledge = Schemas['KnowledgeResponseDto'];
|
|
6279
6273
|
type CreateKnowledgeInput = Schemas['CreateKnowledgeDto'];
|
|
6280
6274
|
type UpdateKnowledgeInput = Schemas['UpdateKnowledgeDto'];
|
|
@@ -6498,11 +6492,6 @@ interface RunActionOptions {
|
|
|
6498
6492
|
* and exactly one connection exists, the platform uses that connection.
|
|
6499
6493
|
*/
|
|
6500
6494
|
connectionId?: string;
|
|
6501
|
-
/**
|
|
6502
|
-
* Project UUID for variable/project scoping. Required when the workspace has
|
|
6503
|
-
* more than one project.
|
|
6504
|
-
*/
|
|
6505
|
-
projectId?: string;
|
|
6506
6495
|
/** Action input fields (keys from the action `inputConfig`). */
|
|
6507
6496
|
input?: Record<string, unknown>;
|
|
6508
6497
|
/** Optional display name for the ad-hoc Execution. */
|
|
@@ -6591,7 +6580,7 @@ interface WorkflowStepDefinition {
|
|
|
6591
6580
|
}
|
|
6592
6581
|
interface WorkflowDefinition {
|
|
6593
6582
|
kind: typeof DEFINE_KINDS.workflow;
|
|
6594
|
-
/** Stable
|
|
6583
|
+
/** Stable slug, unique in the workspace (upsert key). */
|
|
6595
6584
|
slug: string;
|
|
6596
6585
|
name?: string;
|
|
6597
6586
|
description?: string;
|
|
@@ -6604,7 +6593,7 @@ type AgentToolDefinition = ActionDefinition | WorkflowDefinition | {
|
|
|
6604
6593
|
};
|
|
6605
6594
|
interface AgentDefinition {
|
|
6606
6595
|
kind: typeof DEFINE_KINDS.agent;
|
|
6607
|
-
/** Stable
|
|
6596
|
+
/** Stable slug, unique in the workspace (upsert key). */
|
|
6608
6597
|
slug: string;
|
|
6609
6598
|
name?: string;
|
|
6610
6599
|
description?: string;
|
|
@@ -6674,10 +6663,10 @@ declare class AgentsResource {
|
|
|
6674
6663
|
/** Returns a single agent. */
|
|
6675
6664
|
get(agentId: string, options?: Pick<ListQueryOptions, 'expansion'>): Promise<Agent>;
|
|
6676
6665
|
/**
|
|
6677
|
-
* Upsert an agent by
|
|
6666
|
+
* Upsert an agent by slug inside the workspace on the API key.
|
|
6678
6667
|
* Prefer the CLI (`npx @lunnoa/client agents deploy`) for happy-path deploy.
|
|
6679
6668
|
*/
|
|
6680
|
-
upsertBySlug(
|
|
6669
|
+
upsertBySlug(body: UpsertAgentBySlugInput | AgentDefinition, options?: {
|
|
6681
6670
|
workflowIds?: string[];
|
|
6682
6671
|
}): Promise<Agent>;
|
|
6683
6672
|
}
|
|
@@ -6975,6 +6964,22 @@ declare class EntityTypesResource {
|
|
|
6975
6964
|
upsertBySlug(definition: EntityTypeDefinition | UpsertEntityTypeBySlugInput): Promise<EntityType>;
|
|
6976
6965
|
}
|
|
6977
6966
|
|
|
6967
|
+
declare class TablesResource {
|
|
6968
|
+
private readonly http;
|
|
6969
|
+
constructor(http: HttpClient);
|
|
6970
|
+
/** Lists tables in the API key's workspace (without columns and rows). */
|
|
6971
|
+
list(): Promise<Table[]>;
|
|
6972
|
+
/** Returns a single table by ID, including columns and rows. */
|
|
6973
|
+
get(id: string): Promise<Table>;
|
|
6974
|
+
/** Returns a single table by its workspace slug, including columns and rows. */
|
|
6975
|
+
getBySlug(slug: string): Promise<Table>;
|
|
6976
|
+
/**
|
|
6977
|
+
* Creates or updates a table by workspace slug. Omitted columns or rows
|
|
6978
|
+
* keep their current value. Marks `managedByCode` by default.
|
|
6979
|
+
*/
|
|
6980
|
+
upsertBySlug(input: UpsertTableBySlugInput): Promise<Table>;
|
|
6981
|
+
}
|
|
6982
|
+
|
|
6978
6983
|
type EligibleApprover = {
|
|
6979
6984
|
workspaceUserId: string;
|
|
6980
6985
|
email: string;
|
|
@@ -7064,17 +7069,6 @@ declare class KnowledgeResource {
|
|
|
7064
7069
|
deleteDocumentGroup(knowledgeId: string, groupId: string): Promise<boolean>;
|
|
7065
7070
|
}
|
|
7066
7071
|
|
|
7067
|
-
declare class ProjectsResource {
|
|
7068
|
-
private readonly http;
|
|
7069
|
-
constructor(http: HttpClient);
|
|
7070
|
-
/** Lists projects in the workspace, most recently updated first. */
|
|
7071
|
-
list(options?: ListQueryOptions): Promise<Project[]>;
|
|
7072
|
-
/** Returns a single project. */
|
|
7073
|
-
get(projectId: string, options?: Pick<ListQueryOptions, 'expansion'>): Promise<Project>;
|
|
7074
|
-
/** Creates a project. */
|
|
7075
|
-
create(data: CreateProjectInput): Promise<Project>;
|
|
7076
|
-
}
|
|
7077
|
-
|
|
7078
7072
|
type QueueItemStatus = 'PENDING' | 'PROCESSING' | 'SUCCESS' | 'FAILED' | 'RETRYING';
|
|
7079
7073
|
interface AddQueueItemErrorInput {
|
|
7080
7074
|
/** Error message recorded on the item. */
|
|
@@ -7188,7 +7182,6 @@ interface StartRunStep {
|
|
|
7188
7182
|
}
|
|
7189
7183
|
interface StartRunOptions {
|
|
7190
7184
|
steps: StartRunStep[];
|
|
7191
|
-
projectId?: string;
|
|
7192
7185
|
name?: string;
|
|
7193
7186
|
}
|
|
7194
7187
|
type StartRunInput = StartRunOptions | WorkflowDefinition | WorkflowStepDefinition[] | StartRunStep[];
|
|
@@ -7203,7 +7196,7 @@ declare class RunsResource {
|
|
|
7203
7196
|
* Start a linear multi-step ad-hoc Execution.
|
|
7204
7197
|
*
|
|
7205
7198
|
* Accepts a `defineWorkflow` result, a step array, or an explicit
|
|
7206
|
-
* `{ steps,
|
|
7199
|
+
* `{ steps, name? }` payload.
|
|
7207
7200
|
*/
|
|
7208
7201
|
start(input: StartRunInput): Promise<RunActionResult>;
|
|
7209
7202
|
/** Convenience: start and wait until terminal / NEEDS_INPUT. */
|
|
@@ -7360,10 +7353,10 @@ declare class WorkflowsResource {
|
|
|
7360
7353
|
*/
|
|
7361
7354
|
get(workflowId: string, options?: Pick<ListQueryOptions, 'expansion'>): Promise<Workflow>;
|
|
7362
7355
|
/**
|
|
7363
|
-
* Upsert a workflow by
|
|
7356
|
+
* Upsert a workflow by slug inside the workspace on the API key.
|
|
7364
7357
|
* Prefer the CLI (`npx @lunnoa/client workflows deploy`) for happy-path deploy.
|
|
7365
7358
|
*/
|
|
7366
|
-
upsertBySlug(
|
|
7359
|
+
upsertBySlug(body: UpsertWorkflowBySlugInput | WorkflowDefinition): Promise<Workflow>;
|
|
7367
7360
|
/**
|
|
7368
7361
|
* Starts a new execution of the workflow with the given trigger inputs.
|
|
7369
7362
|
* Returns immediately with the execution ID.
|
|
@@ -7426,13 +7419,14 @@ declare class LunnoaClient {
|
|
|
7426
7419
|
readonly approvals: ApprovalsResource;
|
|
7427
7420
|
readonly entities: EntitiesResource;
|
|
7428
7421
|
readonly entityTypes: EntityTypesResource;
|
|
7422
|
+
/** Small reference / lookup tables (rows stored inline; use entities for transactional data). */
|
|
7423
|
+
readonly tables: TablesResource;
|
|
7429
7424
|
readonly knowledge: KnowledgeResource;
|
|
7430
7425
|
readonly queues: QueuesResource;
|
|
7431
7426
|
readonly queueItems: QueueItemsResource;
|
|
7432
7427
|
readonly variables: VariablesResource;
|
|
7433
7428
|
readonly scorecards: ScorecardsResource;
|
|
7434
7429
|
readonly connections: ConnectionsResource;
|
|
7435
|
-
readonly projects: ProjectsResource;
|
|
7436
7430
|
readonly workflowApps: WorkflowAppsResource;
|
|
7437
7431
|
readonly discovery: DiscoveryResource;
|
|
7438
7432
|
constructor(options: LunnoaClientOptions);
|
|
@@ -7579,4 +7573,4 @@ interface CreateServerClientOptions {
|
|
|
7579
7573
|
*/
|
|
7580
7574
|
declare function createServerClient(options: CreateServerClientOptions): LunnoaClient;
|
|
7581
7575
|
|
|
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
|
|
7576
|
+
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 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 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 };
|