@lunnoa/client 0.0.0-development → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +202 -202
- package/README.md +378 -338
- package/dist/cli.js +128 -4
- package/dist/index.cjs +76 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1333 -1055
- package/dist/index.d.ts +1333 -1055
- package/dist/index.js +75 -3
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +59 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +768 -596
- package/dist/react.d.ts +768 -596
- package/dist/react.js +59 -1
- package/dist/react.js.map +1 -1
- package/package.json +7 -5
- package/skills/lunnoa-client/SKILL.md +517 -0
- package/skills/lunnoa-solution-design/SKILL.md +190 -0
package/dist/react.d.cts
CHANGED
|
@@ -227,6 +227,8 @@ interface components {
|
|
|
227
227
|
SKILLS: boolean;
|
|
228
228
|
/** @description Whether the hexagonal agent builder canvas UI is enabled. */
|
|
229
229
|
AGENT_BUILDER_CANVAS: boolean;
|
|
230
|
+
/** @description Whether the Solution Designer UI is enabled. */
|
|
231
|
+
SOLUTION_DESIGNER: boolean;
|
|
230
232
|
/** @description Whether isolated code execution for agents is enabled. */
|
|
231
233
|
CODE_EXECUTION: boolean;
|
|
232
234
|
/** @description Whether SSO (OIDC) login is enabled. Requires at least one enabled SSO provider. */
|
|
@@ -297,6 +299,8 @@ interface components {
|
|
|
297
299
|
CreateQueueDto: {
|
|
298
300
|
/** @description Human-readable name for the queue. */
|
|
299
301
|
name: string;
|
|
302
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
303
|
+
allowedObjectTypeIds?: string[];
|
|
300
304
|
/** @description Description of what the queue is used for. */
|
|
301
305
|
description?: string;
|
|
302
306
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -338,6 +342,14 @@ interface components {
|
|
|
338
342
|
/** @description Number of items in the queue. */
|
|
339
343
|
items: number;
|
|
340
344
|
};
|
|
345
|
+
QueueAllowedObjectTypeDto: {
|
|
346
|
+
/** @description Object type ID. */
|
|
347
|
+
id: string;
|
|
348
|
+
/** @description Object type name. */
|
|
349
|
+
name: string;
|
|
350
|
+
/** @description Object type slug. */
|
|
351
|
+
slug: string;
|
|
352
|
+
};
|
|
341
353
|
QueueResponseDto: {
|
|
342
354
|
/** @description Queue ID. */
|
|
343
355
|
id: string;
|
|
@@ -383,6 +395,8 @@ interface components {
|
|
|
383
395
|
createdByWorkspaceUser?: components["schemas"]["QueueCreatedByWorkspaceUserDto"];
|
|
384
396
|
/** @description Relation counts. Included when `expansion=itemCounts` is requested. */
|
|
385
397
|
_count?: components["schemas"]["QueueItemCountsDto"];
|
|
398
|
+
/** @description ObjectTypes this queue accepts for linked items. Empty means any type is allowed. Included when `expansion=allowedObjectTypes` is requested. */
|
|
399
|
+
allowedObjectTypes?: components["schemas"]["QueueAllowedObjectTypeDto"][];
|
|
386
400
|
};
|
|
387
401
|
QueueStatsResponseDto: {
|
|
388
402
|
/** @description Total number of items in the queue. */
|
|
@@ -401,6 +415,8 @@ interface components {
|
|
|
401
415
|
UpdateQueueDto: {
|
|
402
416
|
/** @description Human-readable name for the queue. */
|
|
403
417
|
name?: string;
|
|
418
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
419
|
+
allowedObjectTypeIds?: string[];
|
|
404
420
|
/** @description Description of what the queue is used for. */
|
|
405
421
|
description?: string;
|
|
406
422
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -421,6 +437,8 @@ interface components {
|
|
|
421
437
|
CreateQueueItemDto: {
|
|
422
438
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
423
439
|
externalId?: string;
|
|
440
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
441
|
+
objectId?: string;
|
|
424
442
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
425
443
|
data?: {
|
|
426
444
|
[key: string]: unknown;
|
|
@@ -467,11 +485,31 @@ interface components {
|
|
|
467
485
|
/** @description Workflow the execution belongs to. */
|
|
468
486
|
workflow: components["schemas"]["QueueItemExecutionWorkflowDto"];
|
|
469
487
|
};
|
|
488
|
+
QueueItemObjectTypeSummaryDto: {
|
|
489
|
+
/** @description Object type ID. */
|
|
490
|
+
id: string;
|
|
491
|
+
/** @description Object type name. */
|
|
492
|
+
name: string;
|
|
493
|
+
/** @description Object type slug. */
|
|
494
|
+
slug: string;
|
|
495
|
+
};
|
|
496
|
+
QueueItemObjectSummaryDto: {
|
|
497
|
+
/** @description Object ID. */
|
|
498
|
+
id: string;
|
|
499
|
+
/** @description Object display name. */
|
|
500
|
+
name: string;
|
|
501
|
+
/** @description Current object state ID. */
|
|
502
|
+
state: string | null;
|
|
503
|
+
/** @description Object type summary. */
|
|
504
|
+
objectType: components["schemas"]["QueueItemObjectTypeSummaryDto"];
|
|
505
|
+
};
|
|
470
506
|
QueueItemCreateResponseDto: {
|
|
471
507
|
/** @description Queue item ID. */
|
|
472
508
|
id: string;
|
|
473
509
|
/** @description External identifier used for deduplication. */
|
|
474
510
|
externalId: string | null;
|
|
511
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
512
|
+
objectId: string | null;
|
|
475
513
|
/** @description JSON payload for the item. */
|
|
476
514
|
data: {
|
|
477
515
|
[key: string]: unknown;
|
|
@@ -534,6 +572,8 @@ interface components {
|
|
|
534
572
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
535
573
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
536
574
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
575
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
576
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
537
577
|
/** @description True when an existing item with the same externalId was returned instead of creating a new one. */
|
|
538
578
|
isDuplicate: boolean;
|
|
539
579
|
};
|
|
@@ -554,6 +594,8 @@ interface components {
|
|
|
554
594
|
id: string;
|
|
555
595
|
/** @description External identifier used for deduplication. */
|
|
556
596
|
externalId: string | null;
|
|
597
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
598
|
+
objectId: string | null;
|
|
557
599
|
/** @description JSON payload for the item. */
|
|
558
600
|
data: {
|
|
559
601
|
[key: string]: unknown;
|
|
@@ -616,6 +658,8 @@ interface components {
|
|
|
616
658
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
617
659
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
618
660
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
661
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
662
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
619
663
|
};
|
|
620
664
|
BulkCreateQueueItemsSummaryDto: {
|
|
621
665
|
/** @description Number of items created. */
|
|
@@ -666,6 +710,8 @@ interface components {
|
|
|
666
710
|
updatedAt: string;
|
|
667
711
|
/** @description External identifier used for deduplication. */
|
|
668
712
|
externalId: string | null;
|
|
713
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
714
|
+
FK_objectId: string | null;
|
|
669
715
|
/** @description JSON payload for the item. */
|
|
670
716
|
data: {
|
|
671
717
|
[key: string]: unknown;
|
|
@@ -756,6 +802,8 @@ interface components {
|
|
|
756
802
|
UpdateQueueItemDto: {
|
|
757
803
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
758
804
|
externalId?: string;
|
|
805
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
806
|
+
objectId?: string;
|
|
759
807
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
760
808
|
data?: {
|
|
761
809
|
[key: string]: unknown;
|
|
@@ -921,33 +969,45 @@ interface components {
|
|
|
921
969
|
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
922
970
|
managedByCode?: boolean;
|
|
923
971
|
};
|
|
924
|
-
|
|
925
|
-
/** @description
|
|
926
|
-
|
|
927
|
-
/** @description
|
|
928
|
-
name
|
|
929
|
-
/** @description
|
|
930
|
-
|
|
931
|
-
/** @description
|
|
932
|
-
|
|
933
|
-
/**
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
|
|
943
|
-
/** @description
|
|
944
|
-
|
|
972
|
+
UpsertObjectTypeBySlugDto: {
|
|
973
|
+
/** @description Stable workspace-scoped slug (lowercase, digits, hyphens). Used as the upsert key. */
|
|
974
|
+
slug: string;
|
|
975
|
+
/** @description Singular display name. */
|
|
976
|
+
name?: string;
|
|
977
|
+
/** @description Plural display name. */
|
|
978
|
+
namePlural?: string;
|
|
979
|
+
/** @description Description. */
|
|
980
|
+
description?: string;
|
|
981
|
+
/**
|
|
982
|
+
* @description Icon identifier.
|
|
983
|
+
* @default box
|
|
984
|
+
*/
|
|
985
|
+
icon: string;
|
|
986
|
+
/**
|
|
987
|
+
* @description Hex colour.
|
|
988
|
+
* @default #3B82F6
|
|
989
|
+
*/
|
|
990
|
+
color: string;
|
|
991
|
+
/** @description Field definitions grouped into sections. */
|
|
992
|
+
attributeSchema: {
|
|
945
993
|
[key: string]: unknown;
|
|
946
|
-
}
|
|
947
|
-
/** @description
|
|
948
|
-
|
|
994
|
+
};
|
|
995
|
+
/** @description Optional state machine definition. */
|
|
996
|
+
stateSchema?: {
|
|
949
997
|
[key: string]: unknown;
|
|
950
|
-
}
|
|
998
|
+
} | null;
|
|
999
|
+
/** @description Whether the type is enabled. */
|
|
1000
|
+
isEnabled?: boolean;
|
|
1001
|
+
/**
|
|
1002
|
+
* @description When false (default), reject unknown attribute keys on entity writes.
|
|
1003
|
+
* @default false
|
|
1004
|
+
*/
|
|
1005
|
+
allowUnknownAttributes: boolean;
|
|
1006
|
+
/**
|
|
1007
|
+
* @description Marks the type as code-managed. Defaults to true on upsert.
|
|
1008
|
+
* @default true
|
|
1009
|
+
*/
|
|
1010
|
+
managedByCode: boolean;
|
|
951
1011
|
};
|
|
952
1012
|
ObjectTypeUserSummaryDto: {
|
|
953
1013
|
/** @description User ID. */
|
|
@@ -981,6 +1041,12 @@ interface components {
|
|
|
981
1041
|
color: string;
|
|
982
1042
|
/** @description Whether the entity type is enabled. */
|
|
983
1043
|
isEnabled: boolean;
|
|
1044
|
+
/** @description When false, entity create/update rejects attribute keys not declared on the type. Reserved key `extensions` is always allowed. */
|
|
1045
|
+
allowUnknownAttributes: boolean;
|
|
1046
|
+
/** @description True when last written by code (CLI / SDK upsert). */
|
|
1047
|
+
managedByCode: boolean;
|
|
1048
|
+
/** @description Incremented when attributeSchema, stateSchema, or allowUnknownAttributes changes. */
|
|
1049
|
+
schemaRevision: number;
|
|
984
1050
|
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
985
1051
|
description?: string | null;
|
|
986
1052
|
/** @description Field definitions grouped into sections. Included when `expansion=attributeSchema` is requested. */
|
|
@@ -1258,49 +1324,55 @@ interface components {
|
|
|
1258
1324
|
[key: string]: string;
|
|
1259
1325
|
};
|
|
1260
1326
|
};
|
|
1261
|
-
|
|
1262
|
-
/** @description
|
|
1263
|
-
name: string;
|
|
1264
|
-
/** @description Description of the knowledge base. */
|
|
1265
|
-
description?: string;
|
|
1266
|
-
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
1267
|
-
chunkOverlap?: number;
|
|
1268
|
-
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
1269
|
-
chunkSize?: number;
|
|
1270
|
-
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
1271
|
-
embeddingModel?: string;
|
|
1272
|
-
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
1273
|
-
embeddingProvider?: string;
|
|
1274
|
-
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
1275
|
-
dimensions?: number;
|
|
1276
|
-
};
|
|
1277
|
-
KnowledgeCountDto: {
|
|
1278
|
-
/** @description Number of vector references stored in this knowledge base. */
|
|
1279
|
-
vectorRefs: number;
|
|
1280
|
-
};
|
|
1281
|
-
KnowledgeVectorRefSummaryDto: {
|
|
1282
|
-
/** @description Vector reference ID. */
|
|
1283
|
-
id: string;
|
|
1284
|
-
/** @description ID of the knowledge base the vector reference belongs to. */
|
|
1285
|
-
FK_knowledgeId: string;
|
|
1286
|
-
};
|
|
1287
|
-
KnowledgeUsageDto: {
|
|
1288
|
-
/** @description Total prompt tokens consumed when embedding content into this knowledge base. */
|
|
1289
|
-
promptTokens: number;
|
|
1290
|
-
};
|
|
1291
|
-
KnowledgeWorkspaceDto: {
|
|
1292
|
-
/** @description Workspace ID. */
|
|
1327
|
+
WorkflowAppResponseDto: {
|
|
1328
|
+
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
1293
1329
|
id: string;
|
|
1294
|
-
/** @description
|
|
1330
|
+
/** @description Human-readable app name. */
|
|
1295
1331
|
name: string;
|
|
1332
|
+
/** @description App description. */
|
|
1333
|
+
description: string;
|
|
1334
|
+
/** @description URL of the app logo. */
|
|
1335
|
+
logoUrl: string;
|
|
1336
|
+
/** @description Whether the app is published and available for use. */
|
|
1337
|
+
isPublished: boolean;
|
|
1338
|
+
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
1339
|
+
needsConnection: boolean;
|
|
1340
|
+
/** @description Whether the app can be used by agents. */
|
|
1341
|
+
availableForAgent: boolean;
|
|
1342
|
+
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
1343
|
+
actions: {
|
|
1344
|
+
[key: string]: unknown;
|
|
1345
|
+
}[];
|
|
1346
|
+
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
1347
|
+
triggers: {
|
|
1348
|
+
[key: string]: unknown;
|
|
1349
|
+
}[];
|
|
1350
|
+
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
1351
|
+
connections: {
|
|
1352
|
+
[key: string]: unknown;
|
|
1353
|
+
}[];
|
|
1296
1354
|
};
|
|
1297
|
-
|
|
1298
|
-
/**
|
|
1355
|
+
AgentResponseDto: {
|
|
1356
|
+
/**
|
|
1357
|
+
* @description Agent ID (UUID)
|
|
1358
|
+
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
1359
|
+
*/
|
|
1299
1360
|
id: string;
|
|
1300
|
-
/**
|
|
1361
|
+
/**
|
|
1362
|
+
* @description Agent name
|
|
1363
|
+
* @example Invoice Triage Agent
|
|
1364
|
+
*/
|
|
1301
1365
|
name: string;
|
|
1302
|
-
/** @description
|
|
1303
|
-
|
|
1366
|
+
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
1367
|
+
slug?: string | null;
|
|
1368
|
+
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
1369
|
+
managedByCode?: boolean;
|
|
1370
|
+
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
1371
|
+
FK_aiConnectionId: string | null;
|
|
1372
|
+
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
1373
|
+
description?: string | null;
|
|
1374
|
+
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
1375
|
+
profileImageUrl?: string | null;
|
|
1304
1376
|
/**
|
|
1305
1377
|
* Format: date-time
|
|
1306
1378
|
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
@@ -1311,219 +1383,318 @@ interface components {
|
|
|
1311
1383
|
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1312
1384
|
*/
|
|
1313
1385
|
updatedAt?: string;
|
|
1314
|
-
/** @description
|
|
1315
|
-
|
|
1316
|
-
/** @description Default chunk size in words used when uploading text. Included when `expansion=chunkSize` is requested. */
|
|
1317
|
-
chunkSize?: number;
|
|
1318
|
-
/** @description Default chunk overlap in words used when uploading text. Included when `expansion=chunkOverlap` is requested. */
|
|
1319
|
-
chunkOverlap?: number;
|
|
1320
|
-
/** @description Embedding model used for this knowledge base. Included when `expansion=embeddingModel` is requested. */
|
|
1321
|
-
embeddingModel?: string;
|
|
1322
|
-
/** @description Embedding provider used for this knowledge base. Included when `expansion=embeddingProvider` is requested. */
|
|
1323
|
-
embeddingProvider?: string;
|
|
1324
|
-
/** @description Embedding vector dimensions. Included when `expansion=dimensions` is requested. */
|
|
1325
|
-
dimensions?: number;
|
|
1326
|
-
/** @description Aggregate counts. Included when `expansion=countVectorRefs` is requested. */
|
|
1327
|
-
_count?: components["schemas"]["KnowledgeCountDto"];
|
|
1328
|
-
/** @description Vector references stored in this knowledge base. Included when `expansion=vectorRefs` is requested. */
|
|
1329
|
-
vectorRefs?: components["schemas"]["KnowledgeVectorRefSummaryDto"][];
|
|
1330
|
-
/** @description Embedding token usage. Included when `expansion=usage` is requested. */
|
|
1331
|
-
usage?: components["schemas"]["KnowledgeUsageDto"];
|
|
1332
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1333
|
-
workspace?: components["schemas"]["KnowledgeWorkspaceDto"];
|
|
1334
|
-
};
|
|
1335
|
-
UpdateKnowledgeDto: {
|
|
1336
|
-
/** @description Name of the knowledge base. */
|
|
1337
|
-
name?: string;
|
|
1338
|
-
/** @description Description of the knowledge base. */
|
|
1339
|
-
description?: string;
|
|
1340
|
-
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
1341
|
-
chunkOverlap?: number;
|
|
1342
|
-
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
1343
|
-
chunkSize?: number;
|
|
1344
|
-
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
1345
|
-
embeddingModel?: string;
|
|
1346
|
-
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
1347
|
-
embeddingProvider?: string;
|
|
1348
|
-
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
1349
|
-
dimensions?: number;
|
|
1350
|
-
};
|
|
1351
|
-
SaveUploadedTextToKnowledgeDto: {
|
|
1352
|
-
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
1353
|
-
name: string;
|
|
1354
|
-
/** @description Raw text content to embed into the knowledge base. */
|
|
1355
|
-
text: string;
|
|
1356
|
-
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
1357
|
-
chunkOverlap: number;
|
|
1358
|
-
/** @description Chunk size in words used to split the text before embedding. */
|
|
1359
|
-
chunkSize: number;
|
|
1360
|
-
};
|
|
1361
|
-
KnowledgeDocumentResponseDto: {
|
|
1362
|
-
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
1363
|
-
id: string;
|
|
1364
|
-
/** @description Document name. */
|
|
1365
|
-
name: string;
|
|
1386
|
+
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
1387
|
+
instructions?: string | null;
|
|
1366
1388
|
/**
|
|
1367
|
-
*
|
|
1368
|
-
* @
|
|
1389
|
+
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
1390
|
+
* @example 1
|
|
1369
1391
|
*/
|
|
1370
|
-
|
|
1371
|
-
/** @description
|
|
1372
|
-
|
|
1392
|
+
temperature?: number;
|
|
1393
|
+
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
1394
|
+
maxOutputTokens?: number | null;
|
|
1373
1395
|
/**
|
|
1374
|
-
* @description
|
|
1375
|
-
* @
|
|
1396
|
+
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
1397
|
+
* @example 1
|
|
1376
1398
|
*/
|
|
1377
|
-
|
|
1378
|
-
};
|
|
1379
|
-
KnowledgeDocumentGroupVectorRefDto: {
|
|
1380
|
-
/** @description Vector reference ID. */
|
|
1381
|
-
id: string;
|
|
1382
|
-
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
1383
|
-
name: string;
|
|
1399
|
+
topP?: number;
|
|
1384
1400
|
/**
|
|
1385
|
-
*
|
|
1386
|
-
* @
|
|
1401
|
+
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
1402
|
+
* @example 0
|
|
1387
1403
|
*/
|
|
1388
|
-
|
|
1389
|
-
/** @description Part number within the group, or null for single-part uploads. */
|
|
1390
|
-
part: number | null;
|
|
1391
|
-
/** @description Storage path of the raw text for this part. */
|
|
1392
|
-
s3Link: string | null;
|
|
1393
|
-
};
|
|
1394
|
-
KnowledgeDocumentGroupResponseDto: {
|
|
1395
|
-
/** @description Document group ID. */
|
|
1396
|
-
id: string;
|
|
1397
|
-
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
1398
|
-
name: string | null;
|
|
1404
|
+
frequencyPenalty?: number;
|
|
1399
1405
|
/**
|
|
1400
|
-
*
|
|
1401
|
-
* @
|
|
1406
|
+
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
1407
|
+
* @example 0
|
|
1402
1408
|
*/
|
|
1403
|
-
|
|
1404
|
-
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
1405
|
-
FK_knowledgeId: string | null;
|
|
1406
|
-
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
1407
|
-
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
1408
|
-
};
|
|
1409
|
-
ManuallyRunWorkflowInputDataDto: {
|
|
1409
|
+
presencePenalty?: number;
|
|
1410
1410
|
/**
|
|
1411
|
-
* @description
|
|
1412
|
-
* @example
|
|
1413
|
-
* "customerEmail": "jane@example.com",
|
|
1414
|
-
* "priority": "high"
|
|
1415
|
-
* }
|
|
1411
|
+
* @description Maximum retries for a failed model call. Included when `expansion=maxRetries` is requested.
|
|
1412
|
+
* @example 0
|
|
1416
1413
|
*/
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
};
|
|
1421
|
-
ExecuteWorkflowResponseDto: {
|
|
1422
|
-
/** @description ID of the newly created execution. Poll GET /executions/{executionId} to track progress. */
|
|
1423
|
-
id: string;
|
|
1424
|
-
};
|
|
1425
|
-
ExecutionWorkspaceSummaryDto: {
|
|
1426
|
-
/** @description Workspace ID */
|
|
1427
|
-
id: string;
|
|
1428
|
-
/** @description Workspace name */
|
|
1429
|
-
name: string;
|
|
1430
|
-
};
|
|
1431
|
-
ExecutionProjectSummaryDto: {
|
|
1432
|
-
/** @description Project ID */
|
|
1433
|
-
id: string;
|
|
1434
|
-
/** @description Project name */
|
|
1435
|
-
name: string;
|
|
1436
|
-
/** @description The workspace the project belongs to. Included when `expansion=workspace` is requested alongside `workflow` and `project`. */
|
|
1437
|
-
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
1438
|
-
};
|
|
1439
|
-
ExecutionWorkflowSummaryDto: {
|
|
1440
|
-
/** @description Workflow ID */
|
|
1441
|
-
id: string;
|
|
1442
|
-
/** @description Workflow name */
|
|
1443
|
-
name: string;
|
|
1444
|
-
/** @description The project the workflow belongs to. Included when `expansion=project` is requested alongside `workflow`. */
|
|
1445
|
-
project?: components["schemas"]["ExecutionProjectSummaryDto"];
|
|
1446
|
-
};
|
|
1447
|
-
ExecutionPathStepDto: {
|
|
1448
|
-
/** @description ID of the workflow node this step represents */
|
|
1449
|
-
nodeId: string;
|
|
1450
|
-
/** @description Human-friendly node name */
|
|
1451
|
-
label: string;
|
|
1452
|
-
/** @description ID of the app the node belongs to */
|
|
1453
|
-
appId: string;
|
|
1454
|
-
/** @description Action ID, present when the step is an action node */
|
|
1455
|
-
actionId?: string;
|
|
1456
|
-
/** @description Trigger ID, present when the step is the trigger node */
|
|
1457
|
-
triggerId?: string;
|
|
1414
|
+
maxRetries?: number;
|
|
1415
|
+
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
1416
|
+
seed?: number | null;
|
|
1458
1417
|
/**
|
|
1459
|
-
* @description
|
|
1460
|
-
* @
|
|
1418
|
+
* @description Maximum tool roundtrips per turn. Included when `expansion=maxToolRoundtrips` is requested.
|
|
1419
|
+
* @example 5
|
|
1461
1420
|
*/
|
|
1462
|
-
|
|
1463
|
-
/** @description Status detail message for the step */
|
|
1464
|
-
statusMessage?: string;
|
|
1465
|
-
/** @description Timestamp when the step started */
|
|
1466
|
-
startTime?: string;
|
|
1467
|
-
/** @description Timestamp when the step finished */
|
|
1468
|
-
endTime?: string;
|
|
1469
|
-
/** @description nodeId this step is an iteration of (set on loop child entries) */
|
|
1470
|
-
iterationOf?: string;
|
|
1471
|
-
/** @description Index of the loop iteration this step belongs to */
|
|
1472
|
-
iterationIndex?: number;
|
|
1473
|
-
/** @description On the collapsed loop parent entry: how many times the loop ran (or is planned to run) */
|
|
1474
|
-
iterationCount?: number;
|
|
1421
|
+
maxToolRoundtrips?: number;
|
|
1475
1422
|
/**
|
|
1476
|
-
* @description
|
|
1423
|
+
* @description How many previous messages are sent to the model. Included when `expansion=messageLookbackLimit` is requested.
|
|
1424
|
+
* @example 40
|
|
1425
|
+
*/
|
|
1426
|
+
messageLookbackLimit?: number;
|
|
1427
|
+
/** @description Configured tool nodes (app actions) for the agent. Included when `expansion=tools` is requested. */
|
|
1428
|
+
tools?: {
|
|
1429
|
+
[key: string]: unknown;
|
|
1430
|
+
}[] | null;
|
|
1431
|
+
/** @description Action IDs of the configured tools. Included when `expansion=toolIds` is requested. */
|
|
1432
|
+
toolIds?: string[];
|
|
1433
|
+
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
1434
|
+
taskNamingInstructions?: string | null;
|
|
1435
|
+
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
1436
|
+
enabledBuiltInTools?: string[];
|
|
1437
|
+
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
1438
|
+
enabledPlatformTools?: string[];
|
|
1439
|
+
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
1440
|
+
dynamicActionDiscoveryEnabled?: boolean;
|
|
1441
|
+
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
1442
|
+
dynamicMcpDiscoveryEnabled?: boolean;
|
|
1443
|
+
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
1444
|
+
dynamicSelfInstructionsEnabled?: boolean;
|
|
1445
|
+
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
1446
|
+
memoryEnabled?: boolean;
|
|
1447
|
+
/** @description Whether runtime planning tools are enabled. Included when `expansion=enablePlanning` is requested. */
|
|
1448
|
+
enablePlanning?: boolean;
|
|
1449
|
+
/** @description Whether oversized tool-result offload is enabled. Included when `expansion=enableToolResultOffload` is requested. */
|
|
1450
|
+
enableToolResultOffload?: boolean;
|
|
1451
|
+
/** @description Byte threshold for tool-result offload. Included when `expansion=toolResultOffloadThresholdBytes` is requested. */
|
|
1452
|
+
toolResultOffloadThresholdBytes?: number;
|
|
1453
|
+
/** @description Whether long-horizon mode is enabled. Included when `expansion=longHorizonMode` is requested. */
|
|
1454
|
+
longHorizonMode?: boolean;
|
|
1455
|
+
/** @description prepareStep safety-net policy ids. Included when `expansion=enabledToolPolicies` is requested. */
|
|
1456
|
+
enabledToolPolicies?: string[];
|
|
1457
|
+
/** @description Per-tool force overrides. Included when `expansion=forcedTools` is requested. */
|
|
1458
|
+
forcedTools?: string[];
|
|
1459
|
+
/** @description When true with planning, gate heavy tools until plan approval. Included when `expansion=requirePlanApproval` is requested. */
|
|
1460
|
+
requirePlanApproval?: boolean;
|
|
1461
|
+
/** @description Optional elevated max steps for long-horizon mode. Included when `expansion=longHorizonMaxSteps` is requested. */
|
|
1462
|
+
longHorizonMaxSteps?: number | null;
|
|
1463
|
+
/** @description Optional max tokens per run hint for long-horizon mode. Included when `expansion=longHorizonMaxTokensPerRun` is requested. */
|
|
1464
|
+
longHorizonMaxTokensPerRun?: number | null;
|
|
1465
|
+
/**
|
|
1466
|
+
* @description Memory partitioning scope. Included when `expansion=memoryScope` is requested.
|
|
1477
1467
|
* @enum {string}
|
|
1478
1468
|
*/
|
|
1479
|
-
|
|
1480
|
-
/** @description Number of approve decisions received so far */
|
|
1481
|
-
approvalsReceived?: number;
|
|
1482
|
-
/** @description Number of approvals required for quorum / current stage */
|
|
1483
|
-
approvalsRequired?: number;
|
|
1484
|
-
};
|
|
1485
|
-
PendingInputFieldDto: {
|
|
1486
|
-
/** @description Field ID used as the key when submitting input */
|
|
1487
|
-
id: string;
|
|
1488
|
-
/** @description Human-readable field label */
|
|
1489
|
-
label: string;
|
|
1490
|
-
/** @description Field input type from the workflow builder (e.g. text, number, select) */
|
|
1491
|
-
inputType: string;
|
|
1492
|
-
/** @description Whether the field must be provided to resume */
|
|
1493
|
-
required: boolean;
|
|
1494
|
-
/** @description Optional helper text for the field */
|
|
1495
|
-
description?: string;
|
|
1496
|
-
/** @description Selectable options when the field is a select-like input */
|
|
1497
|
-
options?: {
|
|
1498
|
-
label?: string;
|
|
1499
|
-
value?: string;
|
|
1500
|
-
}[];
|
|
1501
|
-
};
|
|
1502
|
-
PendingInputDto: {
|
|
1503
|
-
/** @description ID of the waiting workflow node */
|
|
1504
|
-
nodeId: string;
|
|
1505
|
-
/** @description Human-friendly node name */
|
|
1506
|
-
label: string;
|
|
1507
|
-
/** @description Action ID of the waiting node, when it is an action step */
|
|
1508
|
-
actionId?: string;
|
|
1509
|
-
/** @description Optional instructions configured on the waiting node */
|
|
1510
|
-
instructions?: string;
|
|
1511
|
-
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
1512
|
-
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
1513
|
-
};
|
|
1514
|
-
ExecutionResponseDto: {
|
|
1515
|
-
/** @description Execution ID */
|
|
1516
|
-
id: string;
|
|
1469
|
+
memoryScope?: "PER_USER" | "PER_AGENT" | "PER_USER_PER_AGENT";
|
|
1517
1470
|
/**
|
|
1518
|
-
*
|
|
1519
|
-
* @
|
|
1471
|
+
* @description Days memories are retained. Included when `expansion=memoryRetentionDays` is requested.
|
|
1472
|
+
* @example 90
|
|
1520
1473
|
*/
|
|
1521
|
-
|
|
1474
|
+
memoryRetentionDays?: number;
|
|
1475
|
+
/** @description Suggested prompts shown to users starting a conversation. Included when `expansion=suggestedPrompts` is requested. */
|
|
1476
|
+
suggestedPrompts?: string[];
|
|
1522
1477
|
/**
|
|
1523
1478
|
* Format: date-time
|
|
1524
|
-
* @description
|
|
1479
|
+
* @description When the first-time builder setup wizard was completed. Included when `expansion=builderSetupCompletedAt` is requested.
|
|
1525
1480
|
*/
|
|
1526
|
-
|
|
1481
|
+
builderSetupCompletedAt?: string | null;
|
|
1482
|
+
/** @description Saved canvas node positions for the agent builder. Included when `expansion=builderCanvasPositions` is requested. */
|
|
1483
|
+
builderCanvasPositions?: {
|
|
1484
|
+
[key: string]: unknown;
|
|
1485
|
+
} | null;
|
|
1486
|
+
/** @description Selected model ID within the AI provider connection. Included when `expansion=selectedModelId` is requested. */
|
|
1487
|
+
selectedModelId?: string | null;
|
|
1488
|
+
/** @description Assigned AI provider connection. Included when `expansion=aiConnection` is requested. */
|
|
1489
|
+
aiConnection?: {
|
|
1490
|
+
id?: string;
|
|
1491
|
+
name?: string;
|
|
1492
|
+
providerConfig?: {
|
|
1493
|
+
id?: string;
|
|
1494
|
+
providerSlug?: string;
|
|
1495
|
+
};
|
|
1496
|
+
} | null;
|
|
1497
|
+
/** @description Knowledge notebooks attached to the agent. Included when `expansion=knowledge` is requested. */
|
|
1498
|
+
agentKnowledge?: {
|
|
1499
|
+
id?: string;
|
|
1500
|
+
knowledge?: {
|
|
1501
|
+
id?: string;
|
|
1502
|
+
name?: string;
|
|
1503
|
+
};
|
|
1504
|
+
}[];
|
|
1505
|
+
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
1506
|
+
agentObjectTypes?: {
|
|
1507
|
+
id?: string;
|
|
1508
|
+
scope?: string;
|
|
1509
|
+
objectType?: {
|
|
1510
|
+
id?: string;
|
|
1511
|
+
name?: string;
|
|
1512
|
+
slug?: string;
|
|
1513
|
+
icon?: string | null;
|
|
1514
|
+
color?: string | null;
|
|
1515
|
+
};
|
|
1516
|
+
}[];
|
|
1517
|
+
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
1518
|
+
agentObjects?: {
|
|
1519
|
+
id?: string;
|
|
1520
|
+
scope?: string;
|
|
1521
|
+
object?: {
|
|
1522
|
+
id?: string;
|
|
1523
|
+
name?: string;
|
|
1524
|
+
state?: string;
|
|
1525
|
+
objectType?: {
|
|
1526
|
+
id?: string;
|
|
1527
|
+
name?: string;
|
|
1528
|
+
slug?: string;
|
|
1529
|
+
icon?: string | null;
|
|
1530
|
+
color?: string | null;
|
|
1531
|
+
};
|
|
1532
|
+
};
|
|
1533
|
+
}[];
|
|
1534
|
+
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
1535
|
+
connections?: {
|
|
1536
|
+
id?: string;
|
|
1537
|
+
name?: string;
|
|
1538
|
+
}[];
|
|
1539
|
+
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
1540
|
+
agentVariables?: {
|
|
1541
|
+
id?: string;
|
|
1542
|
+
variable?: {
|
|
1543
|
+
id?: string;
|
|
1544
|
+
name?: string;
|
|
1545
|
+
};
|
|
1546
|
+
}[];
|
|
1547
|
+
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
1548
|
+
agentWorkflows?: {
|
|
1549
|
+
id?: string;
|
|
1550
|
+
workflow?: {
|
|
1551
|
+
id?: string;
|
|
1552
|
+
name?: string;
|
|
1553
|
+
};
|
|
1554
|
+
}[];
|
|
1555
|
+
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
1556
|
+
agentSubAgents?: {
|
|
1557
|
+
id?: string;
|
|
1558
|
+
subagent?: {
|
|
1559
|
+
id?: string;
|
|
1560
|
+
name?: string;
|
|
1561
|
+
};
|
|
1562
|
+
parentAgent?: {
|
|
1563
|
+
id?: string;
|
|
1564
|
+
name?: string;
|
|
1565
|
+
};
|
|
1566
|
+
}[];
|
|
1567
|
+
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
1568
|
+
agentMcpServers?: {
|
|
1569
|
+
id?: string;
|
|
1570
|
+
mcpServer?: {
|
|
1571
|
+
id?: string;
|
|
1572
|
+
slug?: string;
|
|
1573
|
+
name?: string;
|
|
1574
|
+
provider?: string;
|
|
1575
|
+
logoUrl?: string | null;
|
|
1576
|
+
description?: string | null;
|
|
1577
|
+
};
|
|
1578
|
+
toolOverrides?: {
|
|
1579
|
+
id?: string;
|
|
1580
|
+
toolName?: string;
|
|
1581
|
+
enabled?: boolean;
|
|
1582
|
+
requireApproval?: boolean;
|
|
1583
|
+
}[];
|
|
1584
|
+
}[];
|
|
1585
|
+
/** @description A2A (agent-to-agent) endpoints attached to the agent. Included when `expansion=a2aAgents` is requested. */
|
|
1586
|
+
agentA2aAgents?: {
|
|
1587
|
+
id?: string;
|
|
1588
|
+
a2aAgent?: {
|
|
1589
|
+
id?: string;
|
|
1590
|
+
slug?: string;
|
|
1591
|
+
name?: string;
|
|
1592
|
+
logoUrl?: string | null;
|
|
1593
|
+
description?: string | null;
|
|
1594
|
+
authType?: string;
|
|
1595
|
+
};
|
|
1596
|
+
}[];
|
|
1597
|
+
/** @description Web access configuration. Included when `expansion=webAccess` is requested. */
|
|
1598
|
+
agentWebAccess?: {
|
|
1599
|
+
service?: string;
|
|
1600
|
+
webSearchEnabled?: boolean;
|
|
1601
|
+
websiteAccessEnabled?: boolean;
|
|
1602
|
+
} | null;
|
|
1603
|
+
/** @description Phone access configuration. Included when `expansion=phoneAccess` is requested. */
|
|
1604
|
+
agentPhoneAccess?: {
|
|
1605
|
+
service?: string;
|
|
1606
|
+
outboundCallsEnabled?: boolean;
|
|
1607
|
+
inboundCallsEnabled?: boolean;
|
|
1608
|
+
} | null;
|
|
1609
|
+
/** @description Project the agent belongs to. Included when `expansion=project` is requested. */
|
|
1610
|
+
project?: {
|
|
1611
|
+
id?: string;
|
|
1612
|
+
name?: string;
|
|
1613
|
+
};
|
|
1614
|
+
};
|
|
1615
|
+
UpsertAgentToolDto: {
|
|
1616
|
+
/** @description Workflow app id (catalogue slug). */
|
|
1617
|
+
appId: string;
|
|
1618
|
+
/** @description Catalogue action id. */
|
|
1619
|
+
actionId: string;
|
|
1620
|
+
/** @description Connection instance UUID pre-bound on the tool. */
|
|
1621
|
+
connectionId?: string;
|
|
1622
|
+
/** @description Tool display name for the model. */
|
|
1623
|
+
name?: string;
|
|
1624
|
+
/** @description Tool description shown to the model. */
|
|
1625
|
+
description?: string;
|
|
1626
|
+
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
1627
|
+
input?: {
|
|
1628
|
+
[key: string]: unknown;
|
|
1629
|
+
};
|
|
1630
|
+
};
|
|
1631
|
+
UpsertAgentBySlugDto: {
|
|
1632
|
+
/**
|
|
1633
|
+
* @description Stable project-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
1634
|
+
* @example support-triage
|
|
1635
|
+
*/
|
|
1636
|
+
slug: string;
|
|
1637
|
+
/** @description Display name. Defaults to the slug when omitted. */
|
|
1638
|
+
name?: string;
|
|
1639
|
+
description?: string;
|
|
1640
|
+
/** @description System instructions / prompt for the agent. */
|
|
1641
|
+
instructions: string;
|
|
1642
|
+
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
1643
|
+
model: string;
|
|
1644
|
+
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
1645
|
+
aiConnectionId?: string;
|
|
1646
|
+
/** @description App Connection UUIDs the agent may use for tools. */
|
|
1647
|
+
connectionIds?: string[];
|
|
1648
|
+
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
1649
|
+
workflowIds?: string[];
|
|
1650
|
+
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
1651
|
+
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
1652
|
+
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
1653
|
+
managedByCode?: boolean;
|
|
1654
|
+
};
|
|
1655
|
+
CreateKnowledgeDto: {
|
|
1656
|
+
/** @description Name of the knowledge base. */
|
|
1657
|
+
name: string;
|
|
1658
|
+
/** @description Description of the knowledge base. */
|
|
1659
|
+
description?: string;
|
|
1660
|
+
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
1661
|
+
chunkOverlap?: number;
|
|
1662
|
+
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
1663
|
+
chunkSize?: number;
|
|
1664
|
+
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
1665
|
+
embeddingModel?: string;
|
|
1666
|
+
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
1667
|
+
embeddingProvider?: string;
|
|
1668
|
+
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
1669
|
+
dimensions?: number;
|
|
1670
|
+
};
|
|
1671
|
+
KnowledgeCountDto: {
|
|
1672
|
+
/** @description Number of vector references stored in this knowledge base. */
|
|
1673
|
+
vectorRefs: number;
|
|
1674
|
+
};
|
|
1675
|
+
KnowledgeVectorRefSummaryDto: {
|
|
1676
|
+
/** @description Vector reference ID. */
|
|
1677
|
+
id: string;
|
|
1678
|
+
/** @description ID of the knowledge base the vector reference belongs to. */
|
|
1679
|
+
FK_knowledgeId: string;
|
|
1680
|
+
};
|
|
1681
|
+
KnowledgeUsageDto: {
|
|
1682
|
+
/** @description Total prompt tokens consumed when embedding content into this knowledge base. */
|
|
1683
|
+
promptTokens: number;
|
|
1684
|
+
};
|
|
1685
|
+
KnowledgeWorkspaceDto: {
|
|
1686
|
+
/** @description Workspace ID. */
|
|
1687
|
+
id: string;
|
|
1688
|
+
/** @description Workspace name. */
|
|
1689
|
+
name: string;
|
|
1690
|
+
};
|
|
1691
|
+
KnowledgeResponseDto: {
|
|
1692
|
+
/** @description Knowledge base ID. */
|
|
1693
|
+
id: string;
|
|
1694
|
+
/** @description Knowledge base name. */
|
|
1695
|
+
name: string;
|
|
1696
|
+
/** @description Knowledge base description. Included when `expansion=description` is requested. */
|
|
1697
|
+
description?: string;
|
|
1527
1698
|
/**
|
|
1528
1699
|
* Format: date-time
|
|
1529
1700
|
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
@@ -1533,110 +1704,101 @@ interface components {
|
|
|
1533
1704
|
* Format: date-time
|
|
1534
1705
|
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1535
1706
|
*/
|
|
1536
|
-
updatedAt?: string
|
|
1537
|
-
/** @description
|
|
1538
|
-
|
|
1539
|
-
/** @description
|
|
1540
|
-
|
|
1541
|
-
|
|
1542
|
-
|
|
1543
|
-
/** @description
|
|
1544
|
-
|
|
1545
|
-
|
|
1546
|
-
|
|
1547
|
-
/**
|
|
1548
|
-
|
|
1549
|
-
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
|
|
1557
|
-
|
|
1707
|
+
updatedAt?: string;
|
|
1708
|
+
/** @description Name of the underlying vector index collection. Included when `expansion=indexName` is requested. */
|
|
1709
|
+
indexName?: string;
|
|
1710
|
+
/** @description Default chunk size in words used when uploading text. Included when `expansion=chunkSize` is requested. */
|
|
1711
|
+
chunkSize?: number;
|
|
1712
|
+
/** @description Default chunk overlap in words used when uploading text. Included when `expansion=chunkOverlap` is requested. */
|
|
1713
|
+
chunkOverlap?: number;
|
|
1714
|
+
/** @description Embedding model used for this knowledge base. Included when `expansion=embeddingModel` is requested. */
|
|
1715
|
+
embeddingModel?: string;
|
|
1716
|
+
/** @description Embedding provider used for this knowledge base. Included when `expansion=embeddingProvider` is requested. */
|
|
1717
|
+
embeddingProvider?: string;
|
|
1718
|
+
/** @description Embedding vector dimensions. Included when `expansion=dimensions` is requested. */
|
|
1719
|
+
dimensions?: number;
|
|
1720
|
+
/** @description Aggregate counts. Included when `expansion=countVectorRefs` is requested. */
|
|
1721
|
+
_count?: components["schemas"]["KnowledgeCountDto"];
|
|
1722
|
+
/** @description Vector references stored in this knowledge base. Included when `expansion=vectorRefs` is requested. */
|
|
1723
|
+
vectorRefs?: components["schemas"]["KnowledgeVectorRefSummaryDto"][];
|
|
1724
|
+
/** @description Embedding token usage. Included when `expansion=usage` is requested. */
|
|
1725
|
+
usage?: components["schemas"]["KnowledgeUsageDto"];
|
|
1726
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1727
|
+
workspace?: components["schemas"]["KnowledgeWorkspaceDto"];
|
|
1728
|
+
};
|
|
1729
|
+
UpdateKnowledgeDto: {
|
|
1730
|
+
/** @description Name of the knowledge base. */
|
|
1731
|
+
name?: string;
|
|
1732
|
+
/** @description Description of the knowledge base. */
|
|
1733
|
+
description?: string;
|
|
1734
|
+
/** @description Default chunk overlap in words. Must be provided together with chunkSize and cannot exceed 50% of it. */
|
|
1735
|
+
chunkOverlap?: number;
|
|
1736
|
+
/** @description Default chunk size in words (50 to 2000). Must be provided together with chunkOverlap. */
|
|
1737
|
+
chunkSize?: number;
|
|
1738
|
+
/** @description Embedding model to use. Defaults to the platform-configured embedding model. */
|
|
1739
|
+
embeddingModel?: string;
|
|
1740
|
+
/** @description Embedding provider to use. Defaults to the platform-configured embedding provider. */
|
|
1741
|
+
embeddingProvider?: string;
|
|
1742
|
+
/** @description Embedding vector dimensions. Defaults to the platform-configured dimensions. */
|
|
1743
|
+
dimensions?: number;
|
|
1744
|
+
};
|
|
1745
|
+
SaveUploadedTextToKnowledgeDto: {
|
|
1746
|
+
/** @description Name of the document. Multi-part uploads are suffixed with the part number. */
|
|
1747
|
+
name: string;
|
|
1748
|
+
/** @description Raw text content to embed into the knowledge base. */
|
|
1749
|
+
text: string;
|
|
1750
|
+
/** @description Chunk overlap in words. Roughly 10% of chunkSize is recommended. */
|
|
1751
|
+
chunkOverlap: number;
|
|
1752
|
+
/** @description Chunk size in words used to split the text before embedding. */
|
|
1753
|
+
chunkSize: number;
|
|
1754
|
+
};
|
|
1755
|
+
KnowledgeDocumentResponseDto: {
|
|
1756
|
+
/** @description Document ID. For `group` documents this is the vector reference group ID; for `standalone` documents it is the vector reference ID. */
|
|
1757
|
+
id: string;
|
|
1758
|
+
/** @description Document name. */
|
|
1759
|
+
name: string;
|
|
1558
1760
|
/**
|
|
1559
1761
|
* Format: date-time
|
|
1560
|
-
* @description
|
|
1561
|
-
*/
|
|
1562
|
-
continueExecutionAt?: string | null;
|
|
1563
|
-
/**
|
|
1564
|
-
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
1565
|
-
* @enum {string}
|
|
1762
|
+
* @description Creation timestamp.
|
|
1566
1763
|
*/
|
|
1567
|
-
|
|
1568
|
-
/** @description
|
|
1569
|
-
|
|
1570
|
-
[key: string]: unknown;
|
|
1571
|
-
} | null;
|
|
1572
|
-
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
1573
|
-
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
1574
|
-
/** @description Business-readable, ordered representation of the executed (or queued) steps, derived from the raw node and edge state: step labels, per-step status (including NEEDS_INPUT for steps paused awaiting user input), start and end timings, and loop iteration metadata. Custom UIs render execution progress from this field. Included when `expansion=executionPath` is requested. Only returned by GET /executions/{executionId}. */
|
|
1575
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1576
|
-
/** @description Field schemas for steps currently paused in NEEDS_INPUT. Each entry includes the waiting nodeId, label, optional instructions, and the fields to collect. Submit values keyed by field id to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. Included when `expansion=pendingInput` is requested. Only returned by GET /executions/{executionId}. Null when no step is waiting for input. */
|
|
1577
|
-
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
1764
|
+
createdAt: string;
|
|
1765
|
+
/** @description Number of parts (chunks) the document was split into. */
|
|
1766
|
+
partCount: number;
|
|
1578
1767
|
/**
|
|
1579
|
-
* @description
|
|
1768
|
+
* @description Whether the document is a multi-part group or a standalone single-part upload.
|
|
1580
1769
|
* @enum {string}
|
|
1581
1770
|
*/
|
|
1582
|
-
|
|
1583
|
-
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
1584
|
-
name?: string | null;
|
|
1771
|
+
type: "group" | "standalone";
|
|
1585
1772
|
};
|
|
1586
|
-
|
|
1587
|
-
/** @description
|
|
1588
|
-
|
|
1589
|
-
/** @description
|
|
1590
|
-
|
|
1591
|
-
/**
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
name?: string;
|
|
1773
|
+
KnowledgeDocumentGroupVectorRefDto: {
|
|
1774
|
+
/** @description Vector reference ID. */
|
|
1775
|
+
id: string;
|
|
1776
|
+
/** @description Vector reference name, including the part suffix for multi-part uploads. */
|
|
1777
|
+
name: string;
|
|
1778
|
+
/**
|
|
1779
|
+
* Format: date-time
|
|
1780
|
+
* @description Creation timestamp.
|
|
1781
|
+
*/
|
|
1782
|
+
createdAt: string;
|
|
1783
|
+
/** @description Part number within the group, or null for single-part uploads. */
|
|
1784
|
+
part: number | null;
|
|
1785
|
+
/** @description Storage path of the raw text for this part. */
|
|
1786
|
+
s3Link: string | null;
|
|
1601
1787
|
};
|
|
1602
|
-
|
|
1603
|
-
/** @description
|
|
1788
|
+
KnowledgeDocumentGroupResponseDto: {
|
|
1789
|
+
/** @description Document group ID. */
|
|
1604
1790
|
id: string;
|
|
1791
|
+
/** @description Document group name, or null for legacy groups without a stored name. */
|
|
1792
|
+
name: string | null;
|
|
1605
1793
|
/**
|
|
1606
|
-
*
|
|
1607
|
-
* @
|
|
1794
|
+
* Format: date-time
|
|
1795
|
+
* @description Creation timestamp.
|
|
1608
1796
|
*/
|
|
1609
|
-
|
|
1610
|
-
/** @description
|
|
1611
|
-
|
|
1612
|
-
/** @description
|
|
1613
|
-
|
|
1614
|
-
[key: string]: unknown;
|
|
1615
|
-
} | null;
|
|
1616
|
-
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
1617
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1618
|
-
};
|
|
1619
|
-
RunStepDto: {
|
|
1620
|
-
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
1621
|
-
appId: string;
|
|
1622
|
-
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
1623
|
-
actionId: string;
|
|
1624
|
-
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
1625
|
-
connectionId?: string;
|
|
1626
|
-
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
1627
|
-
input?: {
|
|
1628
|
-
[key: string]: unknown;
|
|
1629
|
-
};
|
|
1630
|
-
/** @description Optional display name for this step. */
|
|
1631
|
-
name?: string;
|
|
1632
|
-
};
|
|
1633
|
-
StartRunDto: {
|
|
1634
|
-
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
1635
|
-
steps: components["schemas"]["RunStepDto"][];
|
|
1636
|
-
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
1637
|
-
projectId?: string;
|
|
1638
|
-
/** @description Optional display name for the ad-hoc Execution. */
|
|
1639
|
-
name?: string;
|
|
1797
|
+
createdAt: string;
|
|
1798
|
+
/** @description ID of the knowledge base the group belongs to, or null for legacy groups. */
|
|
1799
|
+
FK_knowledgeId: string | null;
|
|
1800
|
+
/** @description Vector references (parts) in the group, ordered by part number. */
|
|
1801
|
+
vectorRefs: components["schemas"]["KnowledgeDocumentGroupVectorRefDto"][];
|
|
1640
1802
|
};
|
|
1641
1803
|
CreateVariableDto: {
|
|
1642
1804
|
/** @description Name of the variable. */
|
|
@@ -1756,287 +1918,237 @@ interface components {
|
|
|
1756
1918
|
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1757
1919
|
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
1758
1920
|
};
|
|
1759
|
-
|
|
1921
|
+
ManuallyRunWorkflowInputDataDto: {
|
|
1760
1922
|
/**
|
|
1761
|
-
* @description
|
|
1762
|
-
* @example
|
|
1923
|
+
* @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.
|
|
1924
|
+
* @example {
|
|
1925
|
+
* "customerEmail": "jane@example.com",
|
|
1926
|
+
* "priority": "high"
|
|
1927
|
+
* }
|
|
1763
1928
|
*/
|
|
1929
|
+
inputData: {
|
|
1930
|
+
[key: string]: unknown;
|
|
1931
|
+
};
|
|
1932
|
+
};
|
|
1933
|
+
ExecuteWorkflowResponseDto: {
|
|
1934
|
+
/** @description ID of the newly created execution. Poll GET /executions/{executionId} to track progress. */
|
|
1764
1935
|
id: string;
|
|
1765
|
-
|
|
1766
|
-
|
|
1767
|
-
|
|
1768
|
-
|
|
1936
|
+
};
|
|
1937
|
+
ExecutionWorkspaceSummaryDto: {
|
|
1938
|
+
/** @description Workspace ID */
|
|
1939
|
+
id: string;
|
|
1940
|
+
/** @description Workspace name */
|
|
1769
1941
|
name: string;
|
|
1770
|
-
|
|
1771
|
-
|
|
1772
|
-
/** @description
|
|
1773
|
-
|
|
1774
|
-
/** @description
|
|
1775
|
-
|
|
1776
|
-
/** @description
|
|
1777
|
-
|
|
1778
|
-
|
|
1779
|
-
|
|
1780
|
-
/**
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1786
|
-
|
|
1787
|
-
|
|
1788
|
-
|
|
1789
|
-
|
|
1790
|
-
/** @description
|
|
1791
|
-
|
|
1942
|
+
};
|
|
1943
|
+
ExecutionProjectSummaryDto: {
|
|
1944
|
+
/** @description Project ID */
|
|
1945
|
+
id: string;
|
|
1946
|
+
/** @description Project name */
|
|
1947
|
+
name: string;
|
|
1948
|
+
/** @description The workspace the project belongs to. Included when `expansion=workspace` is requested alongside `workflow` and `project`. */
|
|
1949
|
+
workspace?: components["schemas"]["ExecutionWorkspaceSummaryDto"];
|
|
1950
|
+
};
|
|
1951
|
+
ExecutionWorkflowSummaryDto: {
|
|
1952
|
+
/** @description Workflow ID */
|
|
1953
|
+
id: string;
|
|
1954
|
+
/** @description Workflow name */
|
|
1955
|
+
name: string;
|
|
1956
|
+
/** @description The project the workflow belongs to. Included when `expansion=project` is requested alongside `workflow`. */
|
|
1957
|
+
project?: components["schemas"]["ExecutionProjectSummaryDto"];
|
|
1958
|
+
};
|
|
1959
|
+
ExecutionPathStepDto: {
|
|
1960
|
+
/** @description ID of the workflow node this step represents */
|
|
1961
|
+
nodeId: string;
|
|
1962
|
+
/** @description Human-friendly node name */
|
|
1963
|
+
label: string;
|
|
1964
|
+
/** @description ID of the app the node belongs to */
|
|
1965
|
+
appId: string;
|
|
1966
|
+
/** @description Action ID, present when the step is an action node */
|
|
1967
|
+
actionId?: string;
|
|
1968
|
+
/** @description Trigger ID, present when the step is the trigger node */
|
|
1969
|
+
triggerId?: string;
|
|
1792
1970
|
/**
|
|
1793
|
-
* @description
|
|
1794
|
-
* @
|
|
1971
|
+
* @description Step status. NEEDS_INPUT indicates the step is paused waiting for user input.
|
|
1972
|
+
* @enum {string}
|
|
1795
1973
|
*/
|
|
1796
|
-
|
|
1797
|
-
/** @description
|
|
1798
|
-
|
|
1974
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "RETRYING" | "WAITING";
|
|
1975
|
+
/** @description Status detail message for the step */
|
|
1976
|
+
statusMessage?: string;
|
|
1977
|
+
/** @description Timestamp when the step started */
|
|
1978
|
+
startTime?: string;
|
|
1979
|
+
/** @description Timestamp when the step finished */
|
|
1980
|
+
endTime?: string;
|
|
1981
|
+
/** @description nodeId this step is an iteration of (set on loop child entries) */
|
|
1982
|
+
iterationOf?: string;
|
|
1983
|
+
/** @description Index of the loop iteration this step belongs to */
|
|
1984
|
+
iterationIndex?: number;
|
|
1985
|
+
/** @description On the collapsed loop parent entry: how many times the loop ran (or is planned to run) */
|
|
1986
|
+
iterationCount?: number;
|
|
1799
1987
|
/**
|
|
1800
|
-
* @description
|
|
1801
|
-
* @
|
|
1988
|
+
* @description Approval status when this step is a Request Approval node awaiting or past a decision
|
|
1989
|
+
* @enum {string}
|
|
1802
1990
|
*/
|
|
1803
|
-
|
|
1991
|
+
approvalStatus?: "pending" | "partially_approved" | "approved" | "rejected" | "expired";
|
|
1992
|
+
/** @description Number of approve decisions received so far */
|
|
1993
|
+
approvalsReceived?: number;
|
|
1994
|
+
/** @description Number of approvals required for quorum / current stage */
|
|
1995
|
+
approvalsRequired?: number;
|
|
1996
|
+
};
|
|
1997
|
+
PendingInputFieldDto: {
|
|
1998
|
+
/** @description Field ID used as the key when submitting input */
|
|
1999
|
+
id: string;
|
|
2000
|
+
/** @description Human-readable field label */
|
|
2001
|
+
label: string;
|
|
2002
|
+
/** @description Field input type from the workflow builder (e.g. text, number, select) */
|
|
2003
|
+
inputType: string;
|
|
2004
|
+
/** @description Whether the field must be provided to resume */
|
|
2005
|
+
required: boolean;
|
|
2006
|
+
/** @description Optional helper text for the field */
|
|
2007
|
+
description?: string;
|
|
2008
|
+
/** @description Selectable options when the field is a select-like input */
|
|
2009
|
+
options?: {
|
|
2010
|
+
label?: string;
|
|
2011
|
+
value?: string;
|
|
2012
|
+
}[];
|
|
2013
|
+
};
|
|
2014
|
+
PendingInputDto: {
|
|
2015
|
+
/** @description ID of the waiting workflow node */
|
|
2016
|
+
nodeId: string;
|
|
2017
|
+
/** @description Human-friendly node name */
|
|
2018
|
+
label: string;
|
|
2019
|
+
/** @description Action ID of the waiting node, when it is an action step */
|
|
2020
|
+
actionId?: string;
|
|
2021
|
+
/** @description Optional instructions configured on the waiting node */
|
|
2022
|
+
instructions?: string;
|
|
2023
|
+
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
2024
|
+
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
2025
|
+
};
|
|
2026
|
+
ExecutionResponseDto: {
|
|
2027
|
+
/** @description Execution ID */
|
|
2028
|
+
id: string;
|
|
1804
2029
|
/**
|
|
1805
|
-
*
|
|
1806
|
-
* @
|
|
2030
|
+
* Format: date-time
|
|
2031
|
+
* @description Timestamp when the execution started. Always returned by GET /executions/{executionId}; included in list responses when `expansion=startedAt` is requested.
|
|
1807
2032
|
*/
|
|
1808
|
-
|
|
2033
|
+
startedAt?: string;
|
|
1809
2034
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
* @
|
|
2035
|
+
* Format: date-time
|
|
2036
|
+
* @description Timestamp when the execution stopped. Included when `expansion=stoppedAt` is requested.
|
|
1812
2037
|
*/
|
|
1813
|
-
|
|
2038
|
+
stoppedAt?: string | null;
|
|
1814
2039
|
/**
|
|
1815
|
-
*
|
|
1816
|
-
* @
|
|
2040
|
+
* Format: date-time
|
|
2041
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
1817
2042
|
*/
|
|
1818
|
-
|
|
1819
|
-
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
1820
|
-
seed?: number | null;
|
|
2043
|
+
createdAt?: string;
|
|
1821
2044
|
/**
|
|
1822
|
-
*
|
|
1823
|
-
* @
|
|
2045
|
+
* Format: date-time
|
|
2046
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1824
2047
|
*/
|
|
1825
|
-
|
|
2048
|
+
updatedAt?: string | null;
|
|
2049
|
+
/** @description Sequential execution number within the workflow. Included when `expansion=executionNumber` is requested. */
|
|
2050
|
+
executionNumber?: number;
|
|
2051
|
+
/** @description Raw execution node state (JSON). Included when `expansion=nodes` is requested. Most integrations should prefer the `executionPath` expansion instead. */
|
|
2052
|
+
nodes?: {
|
|
2053
|
+
[key: string]: unknown;
|
|
2054
|
+
}[];
|
|
2055
|
+
/** @description Raw execution edge state (JSON). Included when `expansion=edges` is requested. */
|
|
2056
|
+
edges?: {
|
|
2057
|
+
[key: string]: unknown;
|
|
2058
|
+
}[];
|
|
1826
2059
|
/**
|
|
1827
|
-
* @description
|
|
1828
|
-
* @
|
|
2060
|
+
* @description Overall execution status. Included when `expansion=status` is requested.
|
|
2061
|
+
* @enum {string}
|
|
1829
2062
|
*/
|
|
1830
|
-
|
|
1831
|
-
/** @description
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
1838
|
-
taskNamingInstructions?: string | null;
|
|
1839
|
-
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
1840
|
-
enabledBuiltInTools?: string[];
|
|
1841
|
-
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
1842
|
-
enabledPlatformTools?: string[];
|
|
1843
|
-
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
1844
|
-
dynamicActionDiscoveryEnabled?: boolean;
|
|
1845
|
-
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
1846
|
-
dynamicMcpDiscoveryEnabled?: boolean;
|
|
1847
|
-
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
1848
|
-
dynamicSelfInstructionsEnabled?: boolean;
|
|
1849
|
-
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
1850
|
-
memoryEnabled?: boolean;
|
|
2063
|
+
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
2064
|
+
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
2065
|
+
statusMessage?: string | null;
|
|
2066
|
+
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
2067
|
+
output?: {
|
|
2068
|
+
[key: string]: unknown;
|
|
2069
|
+
} | null;
|
|
1851
2070
|
/**
|
|
1852
|
-
*
|
|
2071
|
+
* Format: date-time
|
|
2072
|
+
* @description Timestamp when a waiting execution is scheduled to continue. Included when `expansion=continueExecutionAt` is requested.
|
|
2073
|
+
*/
|
|
2074
|
+
continueExecutionAt?: string | null;
|
|
2075
|
+
/**
|
|
2076
|
+
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
1853
2077
|
* @enum {string}
|
|
1854
2078
|
*/
|
|
1855
|
-
|
|
2079
|
+
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
2080
|
+
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
2081
|
+
executionVariables?: {
|
|
2082
|
+
[key: string]: unknown;
|
|
2083
|
+
} | null;
|
|
2084
|
+
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
2085
|
+
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
2086
|
+
/** @description Business-readable, ordered representation of the executed (or queued) steps, derived from the raw node and edge state: step labels, per-step status (including NEEDS_INPUT for steps paused awaiting user input), start and end timings, and loop iteration metadata. Custom UIs render execution progress from this field. Included when `expansion=executionPath` is requested. Only returned by GET /executions/{executionId}. */
|
|
2087
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
2088
|
+
/** @description Field schemas for steps currently paused in NEEDS_INPUT. Each entry includes the waiting nodeId, label, optional instructions, and the fields to collect. Submit values keyed by field id to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. Included when `expansion=pendingInput` is requested. Only returned by GET /executions/{executionId}. Null when no step is waiting for input. */
|
|
2089
|
+
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
1856
2090
|
/**
|
|
1857
|
-
* @description
|
|
1858
|
-
* @
|
|
2091
|
+
* @description How the execution was started. `WORKFLOW` for graph runs; `SDK` for ad-hoc single-action runs from the Public API / client SDK. Included when `expansion=source` is requested.
|
|
2092
|
+
* @enum {string}
|
|
1859
2093
|
*/
|
|
1860
|
-
|
|
1861
|
-
/** @description
|
|
1862
|
-
|
|
2094
|
+
source?: "WORKFLOW" | "SDK";
|
|
2095
|
+
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
2096
|
+
name?: string | null;
|
|
2097
|
+
};
|
|
2098
|
+
RunActionDto: {
|
|
2099
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
2100
|
+
appId: string;
|
|
2101
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
2102
|
+
actionId: string;
|
|
2103
|
+
/** @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. */
|
|
2104
|
+
connectionId?: string;
|
|
2105
|
+
/** @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. */
|
|
2106
|
+
projectId?: string;
|
|
2107
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
2108
|
+
input?: {
|
|
2109
|
+
[key: string]: unknown;
|
|
2110
|
+
};
|
|
2111
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
2112
|
+
name?: string;
|
|
2113
|
+
};
|
|
2114
|
+
RunActionResponseDto: {
|
|
2115
|
+
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
2116
|
+
id: string;
|
|
1863
2117
|
/**
|
|
1864
|
-
*
|
|
1865
|
-
* @
|
|
2118
|
+
* @description Final execution status after the single action step.
|
|
2119
|
+
* @enum {string}
|
|
1866
2120
|
*/
|
|
1867
|
-
|
|
1868
|
-
/** @description
|
|
1869
|
-
|
|
2121
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
2122
|
+
/** @description Human-readable status detail. */
|
|
2123
|
+
statusMessage?: string | null;
|
|
2124
|
+
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
2125
|
+
output?: {
|
|
1870
2126
|
[key: string]: unknown;
|
|
1871
2127
|
} | null;
|
|
1872
|
-
/** @description
|
|
1873
|
-
|
|
1874
|
-
/** @description Assigned AI provider connection. Included when `expansion=aiConnection` is requested. */
|
|
1875
|
-
aiConnection?: {
|
|
1876
|
-
id?: string;
|
|
1877
|
-
name?: string;
|
|
1878
|
-
providerConfig?: {
|
|
1879
|
-
id?: string;
|
|
1880
|
-
providerSlug?: string;
|
|
1881
|
-
};
|
|
1882
|
-
} | null;
|
|
1883
|
-
/** @description Knowledge notebooks attached to the agent. Included when `expansion=knowledge` is requested. */
|
|
1884
|
-
agentKnowledge?: {
|
|
1885
|
-
id?: string;
|
|
1886
|
-
knowledge?: {
|
|
1887
|
-
id?: string;
|
|
1888
|
-
name?: string;
|
|
1889
|
-
};
|
|
1890
|
-
}[];
|
|
1891
|
-
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
1892
|
-
agentObjectTypes?: {
|
|
1893
|
-
id?: string;
|
|
1894
|
-
scope?: string;
|
|
1895
|
-
objectType?: {
|
|
1896
|
-
id?: string;
|
|
1897
|
-
name?: string;
|
|
1898
|
-
slug?: string;
|
|
1899
|
-
icon?: string | null;
|
|
1900
|
-
color?: string | null;
|
|
1901
|
-
};
|
|
1902
|
-
}[];
|
|
1903
|
-
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
1904
|
-
agentObjects?: {
|
|
1905
|
-
id?: string;
|
|
1906
|
-
scope?: string;
|
|
1907
|
-
object?: {
|
|
1908
|
-
id?: string;
|
|
1909
|
-
name?: string;
|
|
1910
|
-
state?: string;
|
|
1911
|
-
objectType?: {
|
|
1912
|
-
id?: string;
|
|
1913
|
-
name?: string;
|
|
1914
|
-
slug?: string;
|
|
1915
|
-
icon?: string | null;
|
|
1916
|
-
color?: string | null;
|
|
1917
|
-
};
|
|
1918
|
-
};
|
|
1919
|
-
}[];
|
|
1920
|
-
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
1921
|
-
connections?: {
|
|
1922
|
-
id?: string;
|
|
1923
|
-
name?: string;
|
|
1924
|
-
}[];
|
|
1925
|
-
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
1926
|
-
agentVariables?: {
|
|
1927
|
-
id?: string;
|
|
1928
|
-
variable?: {
|
|
1929
|
-
id?: string;
|
|
1930
|
-
name?: string;
|
|
1931
|
-
};
|
|
1932
|
-
}[];
|
|
1933
|
-
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
1934
|
-
agentWorkflows?: {
|
|
1935
|
-
id?: string;
|
|
1936
|
-
workflow?: {
|
|
1937
|
-
id?: string;
|
|
1938
|
-
name?: string;
|
|
1939
|
-
};
|
|
1940
|
-
}[];
|
|
1941
|
-
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
1942
|
-
agentSubAgents?: {
|
|
1943
|
-
id?: string;
|
|
1944
|
-
subagent?: {
|
|
1945
|
-
id?: string;
|
|
1946
|
-
name?: string;
|
|
1947
|
-
};
|
|
1948
|
-
parentAgent?: {
|
|
1949
|
-
id?: string;
|
|
1950
|
-
name?: string;
|
|
1951
|
-
};
|
|
1952
|
-
}[];
|
|
1953
|
-
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
1954
|
-
agentMcpServers?: {
|
|
1955
|
-
id?: string;
|
|
1956
|
-
mcpServer?: {
|
|
1957
|
-
id?: string;
|
|
1958
|
-
slug?: string;
|
|
1959
|
-
name?: string;
|
|
1960
|
-
provider?: string;
|
|
1961
|
-
logoUrl?: string | null;
|
|
1962
|
-
description?: string | null;
|
|
1963
|
-
};
|
|
1964
|
-
toolOverrides?: {
|
|
1965
|
-
id?: string;
|
|
1966
|
-
toolName?: string;
|
|
1967
|
-
enabled?: boolean;
|
|
1968
|
-
requireApproval?: boolean;
|
|
1969
|
-
}[];
|
|
1970
|
-
}[];
|
|
1971
|
-
/** @description A2A (agent-to-agent) endpoints attached to the agent. Included when `expansion=a2aAgents` is requested. */
|
|
1972
|
-
agentA2aAgents?: {
|
|
1973
|
-
id?: string;
|
|
1974
|
-
a2aAgent?: {
|
|
1975
|
-
id?: string;
|
|
1976
|
-
slug?: string;
|
|
1977
|
-
name?: string;
|
|
1978
|
-
logoUrl?: string | null;
|
|
1979
|
-
description?: string | null;
|
|
1980
|
-
authType?: string;
|
|
1981
|
-
};
|
|
1982
|
-
}[];
|
|
1983
|
-
/** @description Web access configuration. Included when `expansion=webAccess` is requested. */
|
|
1984
|
-
agentWebAccess?: {
|
|
1985
|
-
service?: string;
|
|
1986
|
-
webSearchEnabled?: boolean;
|
|
1987
|
-
websiteAccessEnabled?: boolean;
|
|
1988
|
-
} | null;
|
|
1989
|
-
/** @description Phone access configuration. Included when `expansion=phoneAccess` is requested. */
|
|
1990
|
-
agentPhoneAccess?: {
|
|
1991
|
-
service?: string;
|
|
1992
|
-
outboundCallsEnabled?: boolean;
|
|
1993
|
-
inboundCallsEnabled?: boolean;
|
|
1994
|
-
} | null;
|
|
1995
|
-
/** @description Project the agent belongs to. Included when `expansion=project` is requested. */
|
|
1996
|
-
project?: {
|
|
1997
|
-
id?: string;
|
|
1998
|
-
name?: string;
|
|
1999
|
-
};
|
|
2128
|
+
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
2129
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
2000
2130
|
};
|
|
2001
|
-
|
|
2002
|
-
/** @description Workflow app id (catalogue slug). */
|
|
2131
|
+
RunStepDto: {
|
|
2132
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
2003
2133
|
appId: string;
|
|
2004
|
-
/** @description
|
|
2134
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
2005
2135
|
actionId: string;
|
|
2006
|
-
/** @description Connection instance UUID
|
|
2136
|
+
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
2007
2137
|
connectionId?: string;
|
|
2008
|
-
/** @description
|
|
2009
|
-
name?: string;
|
|
2010
|
-
/** @description Tool description shown to the model. */
|
|
2011
|
-
description?: string;
|
|
2012
|
-
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
2138
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
2013
2139
|
input?: {
|
|
2014
2140
|
[key: string]: unknown;
|
|
2015
2141
|
};
|
|
2142
|
+
/** @description Optional display name for this step. */
|
|
2143
|
+
name?: string;
|
|
2016
2144
|
};
|
|
2017
|
-
|
|
2018
|
-
/**
|
|
2019
|
-
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
|
|
2023
|
-
/** @description Display name. Defaults to the slug when omitted. */
|
|
2145
|
+
StartRunDto: {
|
|
2146
|
+
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
2147
|
+
steps: components["schemas"]["RunStepDto"][];
|
|
2148
|
+
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
2149
|
+
projectId?: string;
|
|
2150
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
2024
2151
|
name?: string;
|
|
2025
|
-
description?: string;
|
|
2026
|
-
/** @description System instructions / prompt for the agent. */
|
|
2027
|
-
instructions: string;
|
|
2028
|
-
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
2029
|
-
model: string;
|
|
2030
|
-
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
2031
|
-
aiConnectionId?: string;
|
|
2032
|
-
/** @description App Connection UUIDs the agent may use for tools. */
|
|
2033
|
-
connectionIds?: string[];
|
|
2034
|
-
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
2035
|
-
workflowIds?: string[];
|
|
2036
|
-
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
2037
|
-
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
2038
|
-
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
2039
|
-
managedByCode?: boolean;
|
|
2040
2152
|
};
|
|
2041
2153
|
TaskListItemResponseDto: {
|
|
2042
2154
|
/**
|
|
@@ -2183,6 +2295,8 @@ interface components {
|
|
|
2183
2295
|
* @example Conversation covering the Q3 regional sales report
|
|
2184
2296
|
*/
|
|
2185
2297
|
description?: string;
|
|
2298
|
+
/** @description Approve (true) or clear (false) the current runtime plan for plan-before-execute gating. */
|
|
2299
|
+
approvePlan?: boolean;
|
|
2186
2300
|
};
|
|
2187
2301
|
DeletedTaskResponseDto: {
|
|
2188
2302
|
/**
|
|
@@ -2256,6 +2370,10 @@ interface components {
|
|
|
2256
2370
|
* }
|
|
2257
2371
|
*/
|
|
2258
2372
|
data?: Record<string, never>;
|
|
2373
|
+
/** @description Solution Designer handoff */
|
|
2374
|
+
solutionId?: string;
|
|
2375
|
+
planStepId?: string;
|
|
2376
|
+
delegationId?: string;
|
|
2259
2377
|
};
|
|
2260
2378
|
StreamMessageStopDto: {
|
|
2261
2379
|
/** @description Partial assistant message to persist when stopping a stream */
|
|
@@ -2319,6 +2437,7 @@ type UpdateQueueInput = Schemas['UpdateQueueDto'];
|
|
|
2319
2437
|
type QueueStats = Schemas['QueueStatsResponseDto'];
|
|
2320
2438
|
type QueueItem = Schemas['QueueItemResponseDto'];
|
|
2321
2439
|
type QueueItemFull = Schemas['QueueItemFullResponseDto'];
|
|
2440
|
+
type QueueItemCreated = Schemas['QueueItemCreateResponseDto'];
|
|
2322
2441
|
type CreateQueueItemInput = Schemas['CreateQueueItemDto'];
|
|
2323
2442
|
type UpdateQueueItemInput = Schemas['UpdateQueueItemDto'];
|
|
2324
2443
|
type QueueItemList = Schemas['QueueItemListResponseDto'];
|
|
@@ -2561,6 +2680,7 @@ declare const DEFINE_KINDS: {
|
|
|
2561
2680
|
readonly action: "action";
|
|
2562
2681
|
readonly workflow: "workflow";
|
|
2563
2682
|
readonly agent: "agent";
|
|
2683
|
+
readonly entityType: "entityType";
|
|
2564
2684
|
};
|
|
2565
2685
|
/** Ref to an existing app Connection (credentials stay on Lunnoa). */
|
|
2566
2686
|
interface ConnectionDefinition {
|
|
@@ -2627,6 +2747,25 @@ interface AgentDefinition {
|
|
|
2627
2747
|
/** Action and/or workflow tool refs. */
|
|
2628
2748
|
tools?: AgentToolDefinition[];
|
|
2629
2749
|
}
|
|
2750
|
+
interface EntityTypeDefinition {
|
|
2751
|
+
kind: typeof DEFINE_KINDS.entityType;
|
|
2752
|
+
/** Stable workspace-scoped slug (upsert key). */
|
|
2753
|
+
slug: string;
|
|
2754
|
+
name?: string;
|
|
2755
|
+
namePlural?: string;
|
|
2756
|
+
description?: string;
|
|
2757
|
+
icon?: string;
|
|
2758
|
+
color?: string;
|
|
2759
|
+
/** Field definitions grouped into sections (same contract as Adminspace). */
|
|
2760
|
+
attributeSchema: Record<string, unknown>;
|
|
2761
|
+
stateSchema?: Record<string, unknown> | null;
|
|
2762
|
+
isEnabled?: boolean;
|
|
2763
|
+
/**
|
|
2764
|
+
* When false (default), entity writes reject undeclared attribute keys.
|
|
2765
|
+
* Reserved key `extensions` is always allowed as a JSON object.
|
|
2766
|
+
*/
|
|
2767
|
+
allowUnknownAttributes?: boolean;
|
|
2768
|
+
}
|
|
2630
2769
|
|
|
2631
2770
|
interface UpsertAgentToolInput {
|
|
2632
2771
|
appId: string;
|
|
@@ -2920,6 +3059,20 @@ interface EntityTypeReadOptions {
|
|
|
2920
3059
|
/** Fields to expand, e.g. `['attributeSchema', 'stateSchema', 'description']`. */
|
|
2921
3060
|
expansion?: string | string[];
|
|
2922
3061
|
}
|
|
3062
|
+
/** Payload for `POST /api/object-types/upsert`. */
|
|
3063
|
+
interface UpsertEntityTypeBySlugInput {
|
|
3064
|
+
slug: string;
|
|
3065
|
+
name?: string;
|
|
3066
|
+
namePlural?: string;
|
|
3067
|
+
description?: string;
|
|
3068
|
+
icon?: string;
|
|
3069
|
+
color?: string;
|
|
3070
|
+
attributeSchema: Record<string, unknown>;
|
|
3071
|
+
stateSchema?: Record<string, unknown> | null;
|
|
3072
|
+
isEnabled?: boolean;
|
|
3073
|
+
allowUnknownAttributes?: boolean;
|
|
3074
|
+
managedByCode?: boolean;
|
|
3075
|
+
}
|
|
2923
3076
|
declare class EntityTypesResource {
|
|
2924
3077
|
private readonly http;
|
|
2925
3078
|
constructor(http: HttpClient);
|
|
@@ -2935,6 +3088,11 @@ declare class EntityTypesResource {
|
|
|
2935
3088
|
get(id: string, options?: EntityTypeReadOptions): Promise<EntityType>;
|
|
2936
3089
|
/** Returns a single entity type by its URL-safe slug. */
|
|
2937
3090
|
getBySlug(slug: string, options?: EntityTypeReadOptions): Promise<EntityType>;
|
|
3091
|
+
/**
|
|
3092
|
+
* Creates or updates an entity type by workspace-scoped slug.
|
|
3093
|
+
* Prefer the CLI (`npx @lunnoa/client entity-types deploy`) for happy-path deploy.
|
|
3094
|
+
*/
|
|
3095
|
+
upsertBySlug(definition: EntityTypeDefinition | UpsertEntityTypeBySlugInput): Promise<EntityType>;
|
|
2938
3096
|
}
|
|
2939
3097
|
|
|
2940
3098
|
type EligibleApprover = {
|
|
@@ -3042,8 +3200,15 @@ interface ListQueueItemsOptions {
|
|
|
3042
3200
|
limit?: number;
|
|
3043
3201
|
offset?: number;
|
|
3044
3202
|
expansion?: string | string[];
|
|
3203
|
+
/** Supports keys including `status`, `externalId`, `objectId`, `priority`. */
|
|
3045
3204
|
filterBy?: string | Record<string, string>;
|
|
3046
3205
|
}
|
|
3206
|
+
interface ListQueueItemsByObjectOptions {
|
|
3207
|
+
status?: string;
|
|
3208
|
+
limit?: number;
|
|
3209
|
+
offset?: number;
|
|
3210
|
+
expansion?: string | string[];
|
|
3211
|
+
}
|
|
3047
3212
|
declare class QueueItemsResource {
|
|
3048
3213
|
private readonly http;
|
|
3049
3214
|
constructor(http: HttpClient);
|
|
@@ -3053,8 +3218,15 @@ declare class QueueItemsResource {
|
|
|
3053
3218
|
iterate(queueId: string, options?: Omit<ListQueueItemsOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
3054
3219
|
/** Returns a single queue item. */
|
|
3055
3220
|
get(queueId: string, itemId: string): Promise<QueueItemFull>;
|
|
3056
|
-
/** Adds an item to a queue. */
|
|
3057
|
-
create(queueId: string, data: CreateQueueItemInput): Promise<
|
|
3221
|
+
/** Adds an item to a queue. Pass `objectId` to link the item to an entity. */
|
|
3222
|
+
create(queueId: string, data: CreateQueueItemInput): Promise<QueueItemCreated>;
|
|
3223
|
+
/**
|
|
3224
|
+
* Lists queue items linked to an Object across all queues in the workspace.
|
|
3225
|
+
* Use for Object detail "Work" panels.
|
|
3226
|
+
*/
|
|
3227
|
+
listByObject(objectId: string, options?: ListQueueItemsByObjectOptions): Promise<QueueItemList>;
|
|
3228
|
+
/** Async-iterates every queue item linked to an Object. */
|
|
3229
|
+
iterateByObject(objectId: string, options?: Omit<ListQueueItemsByObjectOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
3058
3230
|
/** Adds many items to a queue in one call. */
|
|
3059
3231
|
bulkCreate(queueId: string, data: BulkCreateQueueItemsInput): Promise<BulkCreateQueueItemsResult>;
|
|
3060
3232
|
/** Updates a queue item. */
|