asteroid-odyssey 1.8.174 → 1.8.176

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.
Files changed (3) hide show
  1. package/dist/index.d.mts +94 -1283
  2. package/dist/index.d.ts +94 -1283
  3. package/package.json +1 -1
package/dist/index.d.mts CHANGED
@@ -433,9 +433,6 @@ type AgentsAgentExecuteAgentRequest = {
433
433
  onCapacityLimit?: AgentsAgentOnCapacityLimit;
434
434
  };
435
435
  type AgentsAgentExecuteAgentResponse = {
436
- /**
437
- * The ID of the newly created execution
438
- */
439
436
  executionId: CommonUuid;
440
437
  /**
441
438
  * The execution's initial status: "starting" when it began immediately, "queued" when it
@@ -518,9 +515,6 @@ type AgentsAgentExecuteAgentSyncRequest = {
518
515
  timeoutSeconds?: number;
519
516
  };
520
517
  type AgentsAgentExecuteAgentSyncResponse = {
521
- /**
522
- * The ID of the newly created execution
523
- */
524
518
  executionId: CommonUuid;
525
519
  /**
526
520
  * The execution's status when the call returned: terminal on 200, the current status on 202
@@ -617,46 +611,28 @@ type AgentsCustomEnvironmentActiveHours = {
617
611
  * IANA time zone the windows are evaluated in, such as Europe/London
618
612
  */
619
613
  timezone: string;
620
- /**
621
- * The windows
622
- */
623
614
  windows: Array<AgentsCustomEnvironmentTimeWindow>;
624
615
  };
625
616
  /**
626
617
  * A cookie injected into every session of the environment
627
618
  */
628
619
  type AgentsCustomEnvironmentBrowserCookie = {
629
- /**
630
- * Display name for the cookie
631
- */
632
620
  name: string;
633
621
  /**
634
622
  * The cookie key as sent in HTTP headers
635
623
  */
636
624
  key: string;
637
- /**
638
- * The cookie value
639
- */
640
625
  value: string;
641
- /**
642
- * Domain the cookie applies to
643
- */
644
626
  domain: string;
645
627
  /**
646
628
  * When the cookie expires. Absent means a session cookie.
647
629
  */
648
630
  expiry?: string;
649
- /**
650
- * Only send over HTTPS
651
- */
652
631
  secure: boolean;
653
632
  /**
654
633
  * Hidden from page scripts
655
634
  */
656
635
  httpOnly: boolean;
657
- /**
658
- * SameSite policy
659
- */
660
636
  sameSite: AgentsProfileSameSite;
661
637
  };
662
638
  /**
@@ -664,9 +640,6 @@ type AgentsCustomEnvironmentBrowserCookie = {
664
640
  */
665
641
  type AgentsCustomEnvironmentBrowserSettings = {
666
642
  type: "browser";
667
- /**
668
- * How the browser egresses
669
- */
670
643
  proxy: AgentsCustomEnvironmentProxySettings;
671
644
  /**
672
645
  * Operating system the browser emulates
@@ -676,17 +649,11 @@ type AgentsCustomEnvironmentBrowserSettings = {
676
649
  * Extra anti-detection measures
677
650
  */
678
651
  extraStealth: boolean;
679
- /**
680
- * Allow third-party cookies
681
- */
682
652
  allow3rdCookies: boolean;
683
653
  /**
684
654
  * Persist the browser cache between sessions
685
655
  */
686
656
  cachePersistence: boolean;
687
- /**
688
- * Block ads
689
- */
690
657
  adblockActive: boolean;
691
658
  /**
692
659
  * Block popups. Requires adblock.
@@ -696,17 +663,8 @@ type AgentsCustomEnvironmentBrowserSettings = {
696
663
  * Open popups as tabs
697
664
  */
698
665
  forcePopupsAsTabsActive: boolean;
699
- /**
700
- * Block media downloads
701
- */
702
666
  mediaBlockerActive: boolean;
703
- /**
704
- * Render PDFs in the browser
705
- */
706
667
  pdfViewerActive: boolean;
707
- /**
708
- * Record the session trace
709
- */
710
668
  tracingEnabled: boolean;
711
669
  /**
712
670
  * Extensions loaded into every session
@@ -721,13 +679,7 @@ type AgentsCustomEnvironmentBrowserSettings = {
721
679
  * A custom environment: a reusable environment definition — base machine, profile source, and optionally a warm pool that keeps initialised copies ready. Any member of the organisation may manage it. An OS base may name the organisation's own snapshots or public ones; only admins may name any other.
722
680
  */
723
681
  type AgentsCustomEnvironmentCustomEnvironment = {
724
- /**
725
- * Unique identifier for the custom environment
726
- */
727
682
  id: CommonUuid;
728
- /**
729
- * Organisation the environment belongs to
730
- */
731
683
  organizationId: CommonUuid;
732
684
  /**
733
685
  * Name, unique within the organisation
@@ -769,13 +721,7 @@ type AgentsCustomEnvironmentCustomEnvironment = {
769
721
  * Live environments the warm pool owns that no member points at: provisioned by a warmup that never registered them. Nothing reclaims one before its expiry. Resolved when the environment is read.
770
722
  */
771
723
  orphanedEnvironmentIds: Array<CommonUuid>;
772
- /**
773
- * Creation timestamp
774
- */
775
724
  createdAt: string;
776
- /**
777
- * Last update timestamp
778
- */
779
725
  updatedAt: string;
780
726
  };
781
727
  /**
@@ -787,9 +733,6 @@ type AgentsCustomEnvironmentCustomProxySettings = {
787
733
  * Proxy server address including protocol and port, such as socks5://proxy.example.com:1080
788
734
  */
789
735
  server: string;
790
- /**
791
- * Proxy authentication username
792
- */
793
736
  username: string;
794
737
  /**
795
738
  * Proxy authentication password. Required on create; omit on update to keep the stored one.
@@ -800,31 +743,19 @@ type AgentsCustomEnvironmentCustomProxySettings = {
800
743
  * The machine a custom environment boots
801
744
  */
802
745
  type AgentsCustomEnvironmentEnvironmentBase = {
803
- /**
804
- * Type of environment (browser or os)
805
- */
806
746
  type: AgentsWorkflowEnvironmentType;
807
- /**
808
- * Environment-specific configuration
809
- */
810
747
  config: AgentsCustomEnvironmentEnvironmentBaseBrowserConfig | AgentsCustomEnvironmentEnvironmentBaseOsConfig;
811
748
  };
812
749
  /**
813
750
  * Browser base of a custom environment
814
751
  */
815
752
  type AgentsCustomEnvironmentEnvironmentBaseBrowserConfig = {
816
- /**
817
- * Browser provider type
818
- */
819
753
  provider: AgentsWorkflowBrowserProvider;
820
754
  };
821
755
  /**
822
756
  * OS base of a custom environment: the workflow OS configuration plus the snapshot it boots
823
757
  */
824
758
  type AgentsCustomEnvironmentEnvironmentBaseOsConfig = {
825
- /**
826
- * OS provider type
827
- */
828
759
  provider: AgentsWorkflowOsProvider;
829
760
  /**
830
761
  * Operating system the sandbox runs. Defaults to linux. Setting to windows is admin-only and selects the Windows snapshot/image.
@@ -854,9 +785,6 @@ type AgentsCustomEnvironmentEnvironmentSettings = ({
854
785
  */
855
786
  type AgentsCustomEnvironmentGatewayProxySettings = {
856
787
  mode: "gateway";
857
- /**
858
- * The proxy gateway preset
859
- */
860
788
  proxyGatewayPresetId: CommonUuid;
861
789
  };
862
790
  /**
@@ -918,9 +846,6 @@ type AgentsCustomEnvironmentInitialization = {
918
846
  */
919
847
  type AgentsCustomEnvironmentLinuxSettings = {
920
848
  type: "linux";
921
- /**
922
- * How the sandbox egresses
923
- */
924
849
  proxy: AgentsCustomEnvironmentSandboxProxySettings;
925
850
  };
926
851
  /**
@@ -970,9 +895,6 @@ type AgentsCustomEnvironmentProfilePoolSource = {
970
895
  * @deprecated
971
896
  */
972
897
  agentProfilePoolId?: CommonUuid;
973
- /**
974
- * The profile group
975
- */
976
898
  profileGroupId: CommonUuid;
977
899
  };
978
900
  /**
@@ -1022,9 +944,6 @@ type AgentsCustomEnvironmentSandboxCustomProxySettings = {
1022
944
  * SOCKS5 server address including port, such as socks5://proxy.example.com:1080
1023
945
  */
1024
946
  server: string;
1025
- /**
1026
- * Proxy authentication username
1027
- */
1028
947
  username: string;
1029
948
  /**
1030
949
  * Proxy authentication password. Required on create; omit on update to keep the stored one.
@@ -1080,9 +999,6 @@ type AgentsCustomEnvironmentSingleProfileSource = {
1080
999
  * @deprecated
1081
1000
  */
1082
1001
  agentProfileId?: CommonUuid;
1083
- /**
1084
- * The login profile
1085
- */
1086
1002
  profileId: CommonUuid;
1087
1003
  };
1088
1004
  /**
@@ -1095,9 +1011,6 @@ type AgentsCustomEnvironmentSingleUseReusePolicy = {
1095
1011
  * Hours on given days. A window never crosses midnight: express an overnight span as two windows.
1096
1012
  */
1097
1013
  type AgentsCustomEnvironmentTimeWindow = {
1098
- /**
1099
- * Days the window applies on
1100
- */
1101
1014
  days: Array<AgentsCustomEnvironmentWeekday>;
1102
1015
  /**
1103
1016
  * Start of the window as an ISO 8601 time of day (HH:MM:SS), inclusive
@@ -1133,9 +1046,6 @@ type AgentsCustomEnvironmentWarmCacheConfig = {
1133
1046
  * Warm cache login state of one profile
1134
1047
  */
1135
1048
  type AgentsCustomEnvironmentWarmCacheLogin = {
1136
- /**
1137
- * The profile
1138
- */
1139
1049
  profileId: CommonUuid;
1140
1050
  /**
1141
1051
  * When the profile last logged in successfully
@@ -1158,13 +1068,7 @@ type AgentsCustomEnvironmentWarmCacheLoginAttempt = {
1158
1068
  * The login execution. Absent until the run is dispatched, and when dispatch failed.
1159
1069
  */
1160
1070
  executionId?: CommonUuid;
1161
- /**
1162
- * The environment the login ran in
1163
- */
1164
1071
  environmentId: CommonUuid;
1165
- /**
1166
- * When the login started
1167
- */
1168
1072
  startedAt: string;
1169
1073
  /**
1170
1074
  * When the login failed or timed out. Absent while it runs.
@@ -1187,9 +1091,6 @@ type AgentsCustomEnvironmentWarmPoolConfig = {
1187
1091
  * Member max age in minutes, not a hard retirement time. The replacement boots ahead of it, by the pool's recent warmup time; the member stays claimable past it until the replacement is ready, for a grace of at most half the max age or 15 minutes.
1188
1092
  */
1189
1093
  maxAgeMins: number;
1190
- /**
1191
- * How long a pooled environment lives
1192
- */
1193
1094
  reuse: AgentsCustomEnvironmentReusePolicy;
1194
1095
  /**
1195
1096
  * Agent that initialises each member. Absent means a member is available as soon as it has booted.
@@ -1200,17 +1101,8 @@ type AgentsCustomEnvironmentWarmPoolConfig = {
1200
1101
  * A pre-warmed environment inside a warm pool
1201
1102
  */
1202
1103
  type AgentsCustomEnvironmentWarmPoolMember = {
1203
- /**
1204
- * The pooled environment
1205
- */
1206
1104
  environmentId: CommonUuid;
1207
- /**
1208
- * Lifecycle state of the member
1209
- */
1210
1105
  state: AgentsCustomEnvironmentWarmPoolMemberState;
1211
- /**
1212
- * Executions currently attached to the environment
1213
- */
1214
1106
  attachedExecutionIds: Array<CommonUuid>;
1215
1107
  /**
1216
1108
  * Deprecated: use profileId. Agent profile the member holds for its whole life.
@@ -1247,18 +1139,12 @@ type AgentsCustomEnvironmentWarmPoolSizeSchedule = {
1247
1139
  * IANA time zone the windows are evaluated in, such as Europe/London
1248
1140
  */
1249
1141
  timezone: string;
1250
- /**
1251
- * The windows
1252
- */
1253
1142
  windows: Array<AgentsCustomEnvironmentWarmPoolSizeWindow>;
1254
1143
  };
1255
1144
  /**
1256
1145
  * Hours on given days during which the pool holds a different target size
1257
1146
  */
1258
1147
  type AgentsCustomEnvironmentWarmPoolSizeWindow = {
1259
- /**
1260
- * Days the window applies on
1261
- */
1262
1148
  days: Array<AgentsCustomEnvironmentWeekday>;
1263
1149
  /**
1264
1150
  * Start of the window as an ISO 8601 time of day (HH:MM:SS), inclusive
@@ -1282,9 +1168,6 @@ type AgentsCustomEnvironmentWeekday = "mon" | "tue" | "wed" | "thu" | "fri" | "s
1282
1168
  */
1283
1169
  type AgentsCustomEnvironmentWindowsSettings = {
1284
1170
  type: "windows";
1285
- /**
1286
- * How the sandbox egresses
1287
- */
1288
1171
  proxy: AgentsCustomEnvironmentSandboxProxySettings;
1289
1172
  };
1290
1173
  /**
@@ -1382,9 +1265,6 @@ type AgentsCustomerActivityNotableActivityRow = {
1382
1265
  * Organisation ID (usersdb organisation UUID).
1383
1266
  */
1384
1267
  organisationId: CommonUuid;
1385
- /**
1386
- * Which event was tripped.
1387
- */
1388
1268
  kind: AgentsCustomerActivityNotableActivityKind;
1389
1269
  /**
1390
1270
  * When the event occurred (for friction: the most recent qualifying run).
@@ -1420,22 +1300,13 @@ type AgentsCustomerActivityRiskLevel = "red" | "amber" | "green";
1420
1300
  * Request to search Asteroid documentation
1421
1301
  */
1422
1302
  type AgentsDocsSearchDocsRequest = {
1423
- /**
1424
- * Search query to find relevant documentation
1425
- */
1426
1303
  query: string;
1427
- /**
1428
- * Content format
1429
- */
1430
1304
  format?: AgentsDocsSearchDocsReturnFormat;
1431
1305
  };
1432
1306
  /**
1433
1307
  * Response containing documentation search results
1434
1308
  */
1435
1309
  type AgentsDocsSearchDocsResponse = {
1436
- /**
1437
- * Search results matching the query
1438
- */
1439
1310
  results: Array<AgentsDocsSearchResult>;
1440
1311
  };
1441
1312
  /**
@@ -1446,17 +1317,8 @@ type AgentsDocsSearchDocsReturnFormat = "mdx" | "text";
1446
1317
  * A single documentation search result
1447
1318
  */
1448
1319
  type AgentsDocsSearchResult = {
1449
- /**
1450
- * Result title
1451
- */
1452
1320
  title: string;
1453
- /**
1454
- * Result content/snippet
1455
- */
1456
1321
  content: string;
1457
- /**
1458
- * Source URL
1459
- */
1460
1322
  url?: string;
1461
1323
  };
1462
1324
  /**
@@ -1474,30 +1336,15 @@ type AgentsEnvironmentAstroEnvironmentOwner = {
1474
1336
  * The workflow the conversation is building.
1475
1337
  */
1476
1338
  workflowId: CommonUuid;
1477
- /**
1478
- * The astro chat that booted the environment.
1479
- */
1480
1339
  chatId: CommonUuid;
1481
1340
  };
1482
1341
  /**
1483
1342
  * A single environment: what it is, its provider state, and how to drive it. `state` is the same shape the execution endpoint returns, so the LiveView/OsLiveView components render either without branching.
1484
1343
  */
1485
1344
  type AgentsEnvironmentEnvironment = {
1486
- /**
1487
- * Environment identifier.
1488
- */
1489
1345
  id: CommonUuid;
1490
- /**
1491
- * The organisation the environment belongs to.
1492
- */
1493
1346
  organizationId: CommonUuid;
1494
- /**
1495
- * Who the environment belongs to, and the identity that owner carries.
1496
- */
1497
1347
  owner: AgentsEnvironmentEnvironmentOwner;
1498
- /**
1499
- * Browser or OS.
1500
- */
1501
1348
  environmentType: AgentsWorkflowEnvironmentType;
1502
1349
  /**
1503
1350
  * Operating system for OS environments. Absent for browser environments; linux when an OS environment predates explicit osType storage.
@@ -1521,9 +1368,6 @@ type AgentsEnvironmentEnvironment = {
1521
1368
  * Whether a playable recording has been persisted (GCS object or provider URL). The playable URL itself is minted on the by-id read.
1522
1369
  */
1523
1370
  hasRecording: boolean;
1524
- /**
1525
- * When the environment row was created.
1526
- */
1527
1371
  createdAt: string;
1528
1372
  /**
1529
1373
  * When the environment first became ready, if it reached that state.
@@ -1541,9 +1385,6 @@ type AgentsEnvironmentEnvironment = {
1541
1385
  * Environment state (browser or OS): live-view URL, viewport, provider config and a freshly-minted recording URL when one exists.
1542
1386
  */
1543
1387
  state: AgentsExecutionEnvironmentState;
1544
- /**
1545
- * How to connect to it.
1546
- */
1547
1388
  connection: AgentsEnvironmentEnvironmentConnection;
1548
1389
  };
1549
1390
  /**
@@ -1589,21 +1430,9 @@ type AgentsEnvironmentEnvironmentStatus = "requested" | "provisioning" | "ready"
1589
1430
  * An environment as it appears in a list. Carries everything a row needs; the provider `state` is fetched with the environment itself, because resolving it mints a signed recording URL per environment and a list would mint one per row.
1590
1431
  */
1591
1432
  type AgentsEnvironmentEnvironmentSummary = {
1592
- /**
1593
- * Environment identifier.
1594
- */
1595
1433
  id: CommonUuid;
1596
- /**
1597
- * The organisation the environment belongs to.
1598
- */
1599
1434
  organizationId: CommonUuid;
1600
- /**
1601
- * Who the environment belongs to, and the identity that owner carries.
1602
- */
1603
1435
  owner: AgentsEnvironmentEnvironmentOwner;
1604
- /**
1605
- * Browser or OS.
1606
- */
1607
1436
  environmentType: AgentsWorkflowEnvironmentType;
1608
1437
  /**
1609
1438
  * Operating system for OS environments. Absent for browser environments; linux when an OS environment predates explicit osType storage.
@@ -1627,9 +1456,6 @@ type AgentsEnvironmentEnvironmentSummary = {
1627
1456
  * Whether a playable recording has been persisted (GCS object or provider URL). The playable URL itself is minted on the by-id read.
1628
1457
  */
1629
1458
  hasRecording: boolean;
1630
- /**
1631
- * When the environment row was created.
1632
- */
1633
1459
  createdAt: string;
1634
1460
  /**
1635
1461
  * When the environment first became ready, if it reached that state.
@@ -1655,13 +1481,7 @@ type AgentsEnvironmentExecutionEnvironmentOwner = {
1655
1481
  * @deprecated
1656
1482
  */
1657
1483
  agentId: CommonUuid;
1658
- /**
1659
- * The workflow the execution runs.
1660
- */
1661
1484
  workflowId: CommonUuid;
1662
- /**
1663
- * The execution that booted the environment.
1664
- */
1665
1485
  executionId: CommonUuid;
1666
1486
  };
1667
1487
  /**
@@ -1697,9 +1517,6 @@ type AgentsEnvironmentExternalEnvironmentOwner = {
1697
1517
  * @deprecated
1698
1518
  */
1699
1519
  agentId: CommonUuid;
1700
- /**
1701
- * The workflow the environment is bound to.
1702
- */
1703
1520
  workflowId: CommonUuid;
1704
1521
  /**
1705
1522
  * The API key that booted it, when one did. Absent for environments booted by a signed-in user.
@@ -1710,9 +1527,6 @@ type AgentsEnvironmentExternalEnvironmentOwner = {
1710
1527
  * Response for the list endpoint, ordered by createdAt DESC. Empty array when nothing matches the filters.
1711
1528
  */
1712
1529
  type AgentsEnvironmentListEnvironmentsResponse = {
1713
- /**
1714
- * The matching environments.
1715
- */
1716
1530
  environments: Array<AgentsEnvironmentEnvironmentSummary>;
1717
1531
  };
1718
1532
  /**
@@ -1799,9 +1613,6 @@ type AgentsEnvironmentStartEnvironmentRequest = {
1799
1613
  */
1800
1614
  type AgentsEnvironmentWarmPoolEnvironmentOwner = {
1801
1615
  type: "warm_pool";
1802
- /**
1803
- * The warm pool the environment belongs to.
1804
- */
1805
1616
  warmPoolId: CommonUuid;
1806
1617
  };
1807
1618
  /**
@@ -1818,26 +1629,14 @@ type AgentsEnvironmentWorkflowEnvironmentSource = {
1818
1629
  * API key reference used for authentication
1819
1630
  */
1820
1631
  type AgentsExecutionApiKeyRef = {
1821
- /**
1822
- * API key ID
1823
- */
1824
1632
  id: CommonUuid;
1825
- /**
1826
- * API key name
1827
- */
1828
1633
  name: string;
1829
1634
  };
1830
1635
  /**
1831
1636
  * API-triggered execution context
1832
1637
  */
1833
1638
  type AgentsExecutionApiTriggerContext = {
1834
- /**
1835
- * Trigger source discriminator
1836
- */
1837
1639
  source: "api";
1838
- /**
1839
- * Runner information
1840
- */
1841
1640
  runner: AgentsExecutionTriggerRunner;
1842
1641
  /**
1843
1642
  * Who started the execution. For an org key, read this and not `runner`: an org key has no user.
@@ -2166,17 +1965,8 @@ type AgentsExecutionAgentQueryContextStartedDetails = {
2166
1965
  * Anchor browser provider configuration
2167
1966
  */
2168
1967
  type AgentsExecutionAnchorProviderConfig = {
2169
- /**
2170
- * Provider type discriminator
2171
- */
2172
1968
  type: "anchor";
2173
- /**
2174
- * Anchor session ID
2175
- */
2176
1969
  sessionId?: CommonUuid;
2177
- /**
2178
- * Anchor session URL
2179
- */
2180
1970
  sessionUrl?: string;
2181
1971
  };
2182
1972
  type AgentsExecutionAskUserQuestion = {
@@ -2204,21 +1994,12 @@ type AgentsExecutionBrowserRunCodeStartedDetails = {
2204
1994
  * Browser environment state
2205
1995
  */
2206
1996
  type AgentsExecutionBrowserState = {
2207
- /**
2208
- * Environment type discriminator
2209
- */
2210
1997
  environmentType: "browser";
2211
1998
  /**
2212
1999
  * Browser provider name as stored on the environment. `anchor` for every environment this build can boot; an environment created by a provider that has since been removed reports that provider's name.
2213
2000
  */
2214
2001
  provider: string;
2215
- /**
2216
- * Browser viewport width
2217
- */
2218
2002
  width: number;
2219
- /**
2220
- * Browser viewport height
2221
- */
2222
2003
  height: number;
2223
2004
  /**
2224
2005
  * Live view/debugger URL
@@ -2240,9 +2021,6 @@ type AgentsExecutionBrowserState = {
2240
2021
  * Browser's public IP address (detected at startup)
2241
2022
  */
2242
2023
  browserIp?: string;
2243
- /**
2244
- * Provider-specific configuration
2245
- */
2246
2024
  providerConfig?: AgentsExecutionBrowserProviderConfig;
2247
2025
  };
2248
2026
  type AgentsExecutionCancelReason = "timeout" | "max_steps" | "user_requested" | "script_failed" | "no_activity" | "budget_exceeded" | "no_warm_environment";
@@ -2253,33 +2031,15 @@ type AgentsExecutionCancelledPayload = {
2253
2031
  * User comment on an execution
2254
2032
  */
2255
2033
  type AgentsExecutionComment = {
2256
- /**
2257
- * Unique identifier for the comment
2258
- */
2259
2034
  id: CommonUuid;
2260
- /**
2261
- * Execution this comment belongs to
2262
- */
2263
2035
  executionId: CommonUuid;
2264
2036
  /**
2265
2037
  * User who created the comment
2266
2038
  */
2267
2039
  userId: CommonUuid;
2268
- /**
2269
- * Comment content
2270
- */
2271
2040
  content: string;
2272
- /**
2273
- * Whether the comment is public
2274
- */
2275
2041
  public: boolean;
2276
- /**
2277
- * When the comment was created
2278
- */
2279
2042
  createdAt: string;
2280
- /**
2281
- * When the comment was last updated
2282
- */
2283
2043
  updatedAt?: string;
2284
2044
  };
2285
2045
  type AgentsExecutionCompletedPayload = {
@@ -2291,13 +2051,7 @@ type AgentsExecutionCompletedPayload = {
2291
2051
  * Daytona OS provider configuration
2292
2052
  */
2293
2053
  type AgentsExecutionDaytonaProviderConfig = {
2294
- /**
2295
- * Daytona sandbox ID
2296
- */
2297
2054
  sandboxId?: string;
2298
- /**
2299
- * Sandbox URL
2300
- */
2301
2055
  sandboxUrl?: string;
2302
2056
  };
2303
2057
  type AgentsExecutionElementFileUploadCompletedDetails = {
@@ -2309,9 +2063,6 @@ type AgentsExecutionElementFileUploadCompletedDetails = {
2309
2063
  */
2310
2064
  type AgentsExecutionEnvironmentState = AgentsExecutionBrowserState | AgentsExecutionOsState;
2311
2065
  type AgentsExecutionExecutionAggregates = {
2312
- /**
2313
- * Counts grouped by execution status
2314
- */
2315
2066
  status_counts: AgentsExecutionStatusCounts;
2316
2067
  /**
2317
2068
  * Top outcome labels and their counts
@@ -2328,42 +2079,21 @@ type AgentsExecutionExecutionOutcomeCounts = {
2328
2079
  * Execution result containing outcome, reasoning, and result data
2329
2080
  */
2330
2081
  type AgentsExecutionExecutionResult = {
2331
- /**
2332
- * Unique identifier for the result
2333
- */
2334
2082
  id: CommonUuid;
2335
- /**
2336
- * Execution this result belongs to
2337
- */
2338
2083
  executionId: CommonUuid;
2339
2084
  /**
2340
2085
  * Outcome of the execution (success or failure)
2341
2086
  */
2342
2087
  outcome: string;
2343
- /**
2344
- * AI reasoning for the outcome
2345
- */
2346
2088
  reasoning: string;
2347
- /**
2348
- * Result data as JSON
2349
- */
2350
2089
  result: unknown;
2351
- /**
2352
- * When the result was created
2353
- */
2354
2090
  createdAt: string;
2355
2091
  };
2356
2092
  /**
2357
2093
  * The status an execution was moved to
2358
2094
  */
2359
2095
  type AgentsExecutionExecutionStatusChange = {
2360
- /**
2361
- * The unique identifier of the execution
2362
- */
2363
2096
  executionId: CommonUuid;
2364
- /**
2365
- * The status the execution now has
2366
- */
2367
2097
  status: AgentsExecutionUpdateableStatus;
2368
2098
  };
2369
2099
  type AgentsExecutionExtApiCallCompletedDetails = {
@@ -2427,25 +2157,13 @@ type AgentsExecutionHandoffPrepareVariable = {
2427
2157
  * Human-applied label for categorizing executions
2428
2158
  */
2429
2159
  type AgentsExecutionHumanLabel = {
2430
- /**
2431
- * Unique identifier for the label
2432
- */
2433
2160
  id: CommonUuid;
2434
- /**
2435
- * Organization this label belongs to
2436
- */
2437
2161
  organizationId: CommonUuid;
2438
- /**
2439
- * Display name of the label
2440
- */
2441
2162
  name: string;
2442
2163
  /**
2443
2164
  * Hex color code for the label (e.g., #FF5733)
2444
2165
  */
2445
2166
  color: string;
2446
- /**
2447
- * When the label was created
2448
- */
2449
2167
  createdAt: string;
2450
2168
  };
2451
2169
  type AgentsExecutionInputResolutionSource = "workflow_input" | "node_output" | "llm";
@@ -2458,9 +2176,6 @@ type AgentsExecutionLlmCallStartedDetails = {
2458
2176
  * Represents a single execution in a list view
2459
2177
  */
2460
2178
  type AgentsExecutionListItem = {
2461
- /**
2462
- * The unique identifier of the execution
2463
- */
2464
2179
  id: CommonUuid;
2465
2180
  /**
2466
2181
  * Deprecated: use workflowId. The ID of the workflow that was executed
@@ -2468,33 +2183,15 @@ type AgentsExecutionListItem = {
2468
2183
  * @deprecated
2469
2184
  */
2470
2185
  agentId: CommonUuid;
2471
- /**
2472
- * The ID of the workflow that was executed
2473
- */
2474
2186
  workflowId: CommonUuid;
2475
- /**
2476
- * The ID of the workflow version that was executed
2477
- */
2478
2187
  workflowVersionId: CommonUuid;
2479
- /**
2480
- * The current status of the execution
2481
- */
2482
2188
  status: AgentsExecutionStatus;
2483
- /**
2484
- * When the execution was created
2485
- */
2486
2189
  createdAt: string;
2487
2190
  /**
2488
2191
  * When the execution actually started running; absent while queued. createdAt means "enqueued at" for executions that waited in the queue.
2489
2192
  */
2490
2193
  startedAt?: string;
2491
- /**
2492
- * When the execution reached a terminal state (if applicable)
2493
- */
2494
2194
  terminalAt?: string;
2495
- /**
2496
- * The organization this execution belongs to
2497
- */
2498
2195
  organizationId: CommonUuid;
2499
2196
  /**
2500
2197
  * Deprecated: use workflowName. The workflow display name
@@ -2502,9 +2199,6 @@ type AgentsExecutionListItem = {
2502
2199
  * @deprecated
2503
2200
  */
2504
2201
  agentName: string;
2505
- /**
2506
- * The workflow display name
2507
- */
2508
2202
  workflowName: string;
2509
2203
  /**
2510
2204
  * Deprecated: use profileName. The name of the agent profile used for this execution (if any)
@@ -2518,39 +2212,18 @@ type AgentsExecutionListItem = {
2518
2212
  * @deprecated
2519
2213
  */
2520
2214
  agentProfileId?: CommonUuid;
2521
- /**
2522
- * The name of the login profile used for this execution (if any)
2523
- */
2524
2215
  profileName?: string;
2525
- /**
2526
- * The ID of the login profile used for this execution (if any)
2527
- */
2528
2216
  profileId?: CommonUuid;
2529
- /**
2530
- * Input variables used for this execution
2531
- */
2532
2217
  inputs?: {
2533
2218
  [key: string]: unknown;
2534
2219
  };
2535
- /**
2536
- * Execution result with outcome, reasoning, and result data
2537
- */
2538
2220
  executionResult?: AgentsExecutionExecutionResult;
2539
2221
  /**
2540
2222
  * Execution duration in seconds (only present for terminal executions)
2541
2223
  */
2542
2224
  duration?: number;
2543
- /**
2544
- * Human-applied labels for this execution
2545
- */
2546
2225
  humanLabels: Array<AgentsExecutionHumanLabel>;
2547
- /**
2548
- * Comments on this execution
2549
- */
2550
2226
  comments: Array<AgentsExecutionComment>;
2551
- /**
2552
- * Optional metadata key-value pairs attached to this execution
2553
- */
2554
2227
  metadata?: {
2555
2228
  [key: string]: unknown;
2556
2229
  };
@@ -2586,9 +2259,6 @@ type AgentsExecutionListItem = {
2586
2259
  * Per-execution runtime options (e.g. variant key)
2587
2260
  */
2588
2261
  executionOptions?: AgentsAgentExecutionOptions;
2589
- /**
2590
- * Whether this execution has been rerun at least once
2591
- */
2592
2262
  hasBeenRerun: boolean;
2593
2263
  /**
2594
2264
  * ID of the execution this was rerun from, if applicable
@@ -2615,13 +2285,7 @@ type AgentsExecutionNavToStartedDetails = {
2615
2285
  * A single output variable with a name and value
2616
2286
  */
2617
2287
  type AgentsExecutionNodeOutputItem = {
2618
- /**
2619
- * The name of the output variable
2620
- */
2621
2288
  name: string;
2622
- /**
2623
- * The value of the output variable
2624
- */
2625
2289
  value: string;
2626
2290
  };
2627
2291
  type AgentsExecutionObsSnapshotWithSelectorsCompletedDetails = {
@@ -2633,29 +2297,11 @@ type AgentsExecutionObsSnapshotWithSelectorsCompletedDetails = {
2633
2297
  * OS environment state
2634
2298
  */
2635
2299
  type AgentsExecutionOsState = {
2636
- /**
2637
- * Environment type discriminator
2638
- */
2639
2300
  environmentType: "os";
2640
- /**
2641
- * OS provider name
2642
- */
2643
2301
  provider: AgentsWorkflowOsProvider;
2644
- /**
2645
- * Screen width
2646
- */
2647
2302
  width: number;
2648
- /**
2649
- * Screen height
2650
- */
2651
2303
  height: number;
2652
- /**
2653
- * Live view URL
2654
- */
2655
2304
  liveViewUrl?: string;
2656
- /**
2657
- * Recording URL
2658
- */
2659
2305
  recordingUrl?: string;
2660
2306
  /**
2661
2307
  * Whether a recording exists (provider URL or durable GCS object persisted). Use this to gate the player rather than recordingUrl, which is empty for GCS-only recordings.
@@ -2669,15 +2315,9 @@ type AgentsExecutionOsState = {
2669
2315
  * Environment's public egress IP address (detected at startup)
2670
2316
  */
2671
2317
  egressIp?: string;
2672
- /**
2673
- * Provider-specific configuration
2674
- */
2675
2318
  providerConfig?: AgentsExecutionDaytonaProviderConfig;
2676
2319
  };
2677
2320
  type AgentsExecutionOutcomeCount = {
2678
- /**
2679
- * The outcome label as set on the execution result
2680
- */
2681
2321
  label: string;
2682
2322
  /**
2683
2323
  * Number of executions with this outcome (within the requested filter)
@@ -2737,9 +2377,6 @@ type AgentsExecutionRerunExecutionRequest = {
2737
2377
  * Schedule reference for schedule-triggered executions
2738
2378
  */
2739
2379
  type AgentsExecutionScheduleRef = {
2740
- /**
2741
- * Schedule ID
2742
- */
2743
2380
  id: CommonUuid;
2744
2381
  /**
2745
2382
  * Cron expression of the schedule
@@ -2750,13 +2387,7 @@ type AgentsExecutionScheduleRef = {
2750
2387
  * Schedule-triggered execution context
2751
2388
  */
2752
2389
  type AgentsExecutionScheduleTriggerContext = {
2753
- /**
2754
- * Trigger source discriminator
2755
- */
2756
2390
  source: "schedule";
2757
- /**
2758
- * Schedule that triggered the execution
2759
- */
2760
2391
  schedule: AgentsExecutionScheduleRef;
2761
2392
  };
2762
2393
  type AgentsExecutionScratchpadReadCompletedDetails = {
@@ -2794,21 +2425,12 @@ type AgentsExecutionScriptEvalStartedDetails = {
2794
2425
  * A single failed run of a scripted iris node's script
2795
2426
  */
2796
2427
  type AgentsExecutionScriptFailure = {
2797
- /**
2798
- * ID of the node whose script failed
2799
- */
2800
2428
  nodeId?: string;
2801
- /**
2802
- * Display name of the node whose script failed
2803
- */
2804
2429
  nodeName?: string;
2805
2430
  /**
2806
2431
  * Relative path of the script file that failed
2807
2432
  */
2808
2433
  scriptFilepath?: string;
2809
- /**
2810
- * Error message reported by the failed script
2811
- */
2812
2434
  error?: string;
2813
2435
  /**
2814
2436
  * 1-based line number where the script failed, if known
@@ -2822,9 +2444,6 @@ type AgentsExecutionScriptFailure = {
2822
2444
  * Identifier correlating this failure to its activity event
2823
2445
  */
2824
2446
  actionId?: string;
2825
- /**
2826
- * When the failure occurred
2827
- */
2828
2447
  occurredAt: string;
2829
2448
  };
2830
2449
  type AgentsExecutionScriptHybridPlaywrightCompletedDetails = {
@@ -3005,13 +2624,7 @@ type AgentsExecutionTriggerContext = ({
3005
2624
  * Runner information - who triggered the execution
3006
2625
  */
3007
2626
  type AgentsExecutionTriggerRunner = {
3008
- /**
3009
- * User ID of the runner
3010
- */
3011
2627
  userId: CommonUuid;
3012
- /**
3013
- * Email of the runner
3014
- */
3015
2628
  email: string;
3016
2629
  /**
3017
2630
  * Whether the user is an admin (may be hidden for privacy)
@@ -3022,13 +2635,7 @@ type AgentsExecutionTriggerRunner = {
3022
2635
  * UI-triggered execution context
3023
2636
  */
3024
2637
  type AgentsExecutionUiTriggerContext = {
3025
- /**
3026
- * Trigger source discriminator
3027
- */
3028
2638
  source: "ui";
3029
- /**
3030
- * Runner information
3031
- */
3032
2639
  runner: AgentsExecutionTriggerRunner;
3033
2640
  /**
3034
2641
  * Who started the execution.
@@ -3036,9 +2643,6 @@ type AgentsExecutionUiTriggerContext = {
3036
2643
  actor?: CommonActor;
3037
2644
  };
3038
2645
  type AgentsExecutionUpdateExecutionStatusRequest = {
3039
- /**
3040
- * The new status to set for the execution
3041
- */
3042
2646
  status: AgentsExecutionUpdateableStatus;
3043
2647
  };
3044
2648
  /**
@@ -3046,6 +2650,9 @@ type AgentsExecutionUpdateExecutionStatusRequest = {
3046
2650
  */
3047
2651
  type AgentsExecutionUpdateableStatus = "running" | "paused" | "cancelled";
3048
2652
  type AgentsExecutionUserMessagesAddTextBody = {
2653
+ /**
2654
+ * The message the agent receives.
2655
+ */
3049
2656
  message: string;
3050
2657
  };
3051
2658
  type AgentsExecutionUtilGetDatetimeCompletedDetails = {
@@ -3062,9 +2669,6 @@ type AgentsExecutionUtilGetDatetimeStartedDetails = {
3062
2669
  * Warmup-triggered execution context: launched by a warm pool's replenisher
3063
2670
  */
3064
2671
  type AgentsExecutionWarmupTriggerContext = {
3065
- /**
3066
- * Trigger source discriminator
3067
- */
3068
2672
  source: "warmup";
3069
2673
  /**
3070
2674
  * Warm pool whose replenisher launched the execution
@@ -3075,9 +2679,6 @@ type AgentsExecutionWarmupTriggerContext = {
3075
2679
  * Execution batch with status counts
3076
2680
  */
3077
2681
  type AgentsExecutionBatchBase = {
3078
- /**
3079
- * Unique identifier for the batch
3080
- */
3081
2682
  id: CommonUuid;
3082
2683
  /**
3083
2684
  * Deprecated: use workflowId. Workflow ID this batch belongs to
@@ -3085,21 +2686,12 @@ type AgentsExecutionBatchBase = {
3085
2686
  * @deprecated
3086
2687
  */
3087
2688
  agentId: CommonUuid;
3088
- /**
3089
- * Workflow ID this batch belongs to
3090
- */
3091
2689
  workflowId: CommonUuid;
3092
- /**
3093
- * Human-readable name for the batch
3094
- */
3095
2690
  name: string;
3096
2691
  /**
3097
2692
  * When to start triggering executions
3098
2693
  */
3099
2694
  startAt: string;
3100
- /**
3101
- * Batch configuration
3102
- */
3103
2695
  config: AgentsExecutionBatchBatchConfig;
3104
2696
  /**
3105
2697
  * Batches sharing a group share one concurrency budget rather than each getting
@@ -3107,41 +2699,17 @@ type AgentsExecutionBatchBase = {
3107
2699
  * carries the id of the schedule that produced it.
3108
2700
  */
3109
2701
  concurrencyGroupId: CommonUuid;
3110
- /**
3111
- * Current batch status
3112
- */
3113
2702
  status: AgentsExecutionBatchStatus;
3114
- /**
3115
- * Number of pending items
3116
- */
3117
2703
  pendingCount: number;
3118
- /**
3119
- * Number of triggered items
3120
- */
3121
2704
  triggeredCount: number;
3122
- /**
3123
- * Number of cancelled items
3124
- */
3125
2705
  cancelledCount: number;
3126
- /**
3127
- * Number of items awaiting capacity
3128
- */
3129
2706
  awaitingCapacityCount: number;
3130
2707
  /**
3131
2708
  * Number of items that could not be triggered and will not be retried
3132
2709
  */
3133
2710
  failedCount: number;
3134
- /**
3135
- * Total number of items
3136
- */
3137
2711
  totalCount: number;
3138
- /**
3139
- * Creation timestamp
3140
- */
3141
2712
  createdAt: string;
3142
- /**
3143
- * Last update timestamp
3144
- */
3145
2713
  updatedAt: string;
3146
2714
  };
3147
2715
  /**
@@ -3160,9 +2728,6 @@ type AgentsExecutionBatchBatchItem = {
3160
2728
  * The workflow to execute. Its published version runs unless workflowVersionId is set. A workflow version ID is still accepted here and runs that version (deprecated). Defaults to the batch's workflow.
3161
2729
  */
3162
2730
  workflowId?: CommonUuid;
3163
- /**
3164
- * The workflow version to execute
3165
- */
3166
2731
  workflowVersionId?: CommonUuid;
3167
2732
  /**
3168
2733
  * Deprecated: use profileId. Optional agent profile to use.
@@ -3198,9 +2763,6 @@ type AgentsExecutionBatchBatchItem = {
3198
2763
  inputs?: {
3199
2764
  [key: string]: unknown;
3200
2765
  };
3201
- /**
3202
- * Metadata for the execution
3203
- */
3204
2766
  metadata?: {
3205
2767
  [key: string]: unknown;
3206
2768
  };
@@ -3223,34 +2785,19 @@ type AgentsExecutionBatchCreateRequest = {
3223
2785
  * Workflow ID for this batch. Set this or agentId.
3224
2786
  */
3225
2787
  workflowId?: CommonUuid;
3226
- /**
3227
- * Human-readable name for the batch
3228
- */
3229
2788
  name: string;
3230
2789
  /**
3231
2790
  * When to start triggering executions
3232
2791
  */
3233
2792
  startAt: string;
3234
- /**
3235
- * Batch configuration
3236
- */
3237
2793
  config: AgentsExecutionBatchBatchConfig;
3238
- /**
3239
- * Items to execute in this batch
3240
- */
3241
2794
  items: Array<AgentsExecutionBatchBatchItem>;
3242
2795
  };
3243
2796
  /**
3244
2797
  * Max concurrent execution configuration
3245
2798
  */
3246
2799
  type AgentsExecutionBatchMaxConcurrentConfig = {
3247
- /**
3248
- * Config type discriminator
3249
- */
3250
2800
  type: "maxConcurrent";
3251
- /**
3252
- * Maximum number of executions running at the same time
3253
- */
3254
2801
  maxConcurrent: number;
3255
2802
  };
3256
2803
  /**
@@ -3261,9 +2808,6 @@ type AgentsExecutionBatchStatus = "pending" | "running" | "paused" | "completed"
3261
2808
  * Time-based batching configuration
3262
2809
  */
3263
2810
  type AgentsExecutionBatchTimeBatchingConfig = {
3264
- /**
3265
- * Config type discriminator
3266
- */
3267
2811
  type: "timeBatching";
3268
2812
  /**
3269
2813
  * Maximum number of executions to trigger in each batch
@@ -3651,25 +3195,16 @@ type AgentsInsightUpdateInsightRequest = {
3651
3195
  * Metadata about a language model
3652
3196
  */
3653
3197
  type AgentsModelsModelMetadata = {
3654
- /**
3655
- * Unique identifier (UUID)
3656
- */
3657
3198
  id: CommonUuid;
3658
3199
  /**
3659
3200
  * Model slug (e.g., 'asteroid-fast')
3660
3201
  */
3661
3202
  slug: string;
3662
- /**
3663
- * Display name for the model
3664
- */
3665
3203
  displayName: string;
3666
3204
  /**
3667
3205
  * Detailed description of the model's characteristics and use cases
3668
3206
  */
3669
3207
  description: string;
3670
- /**
3671
- * Model supports computer use
3672
- */
3673
3208
  supportsComputerUse: boolean;
3674
3209
  /**
3675
3210
  * The provider. Absent for Asteroid aliases, which resolve to a concrete model at runtime.
@@ -3684,43 +3219,28 @@ type AgentsModelsModelProvider = "openai" | "anthropic" | "google";
3684
3219
  * Response containing all available models
3685
3220
  */
3686
3221
  type AgentsModelsModelsResponse = {
3687
- /**
3688
- * List of all available models
3689
- */
3690
3222
  models: Array<AgentsModelsModelMetadata>;
3691
3223
  };
3692
3224
  /**
3693
3225
  * Request to add profiles to a pool
3694
3226
  */
3695
3227
  type AgentsProfileAddProfilesToPoolRequest = {
3696
- /**
3697
- * Profile IDs to add to the pool
3698
- */
3699
3228
  profileIds: Array<CommonUuid>;
3700
3229
  };
3701
3230
  /**
3702
3231
  * An agent profile containing browser configuration and credentials
3703
3232
  */
3704
3233
  type AgentsProfileAgentProfile = {
3705
- /**
3706
- * Unique identifier for the agent profile
3707
- */
3708
3234
  id: CommonUuid;
3709
3235
  /**
3710
3236
  * Name of the agent profile (unique within organization)
3711
3237
  */
3712
3238
  name: string;
3713
- /**
3714
- * Description of the agent profile
3715
- */
3716
3239
  description: string;
3717
3240
  /**
3718
3241
  * The ID of the organization that owns this profile
3719
3242
  */
3720
3243
  organizationId: CommonUuid;
3721
- /**
3722
- * Proxy configuration mode
3723
- */
3724
3244
  proxyMode: AgentsProfileProxyMode;
3725
3245
  /**
3726
3246
  * Country code for proxy location (for managed proxy mode)
@@ -3746,13 +3266,7 @@ type AgentsProfileAgentProfile = {
3746
3266
  * Whether to use the same IP address for all executions (managed proxy only)
3747
3267
  */
3748
3268
  stickyIP: boolean;
3749
- /**
3750
- * Operating system to emulate
3751
- */
3752
3269
  operatingSystem?: AgentsProfileOperatingSystem;
3753
- /**
3754
- * Whether extra stealth mode is enabled
3755
- */
3756
3270
  extraStealth: boolean;
3757
3271
  /**
3758
3272
  * Whether to allow third-party cookies
@@ -3762,9 +3276,6 @@ type AgentsProfileAgentProfile = {
3762
3276
  * Whether to persist browser cache between sessions
3763
3277
  */
3764
3278
  cachePersistence: boolean;
3765
- /**
3766
- * Whether to enable ad blocking
3767
- */
3768
3279
  adblockActive: boolean;
3769
3280
  /**
3770
3281
  * Whether to enable popup blocking (requires adblock to be active)
@@ -3812,30 +3323,15 @@ type AgentsProfileAgentProfile = {
3812
3323
  * @deprecated
3813
3324
  */
3814
3325
  credentials: Array<AgentsProfileCredential>;
3815
- /**
3816
- * List of cookies associated with this profile
3817
- */
3818
3326
  cookies: Array<AgentsProfileCookie>;
3819
- /**
3820
- * When the profile was created
3821
- */
3822
3327
  createdAt: string;
3823
- /**
3824
- * When the profile was last updated
3825
- */
3826
3328
  updatedAt: string;
3827
3329
  };
3828
3330
  /**
3829
3331
  * Response for listing the emails in an agent profile's inbox
3830
3332
  */
3831
3333
  type AgentsProfileAgentProfileInboxEmailsResponse = {
3832
- /**
3833
- * Emails addressed to this profile's inbox
3834
- */
3835
3334
  emails: Array<AgentsProfileProfileInboxEmail>;
3836
- /**
3837
- * Number of emails returned
3838
- */
3839
3335
  emailCount: number;
3840
3336
  /**
3841
3337
  * Whether Resend has more emails beyond this page
@@ -3846,9 +3342,6 @@ type AgentsProfileAgentProfileInboxEmailsResponse = {
3846
3342
  * A pool of agent profiles that can be used for credential rotation
3847
3343
  */
3848
3344
  type AgentsProfileAgentProfilePool = {
3849
- /**
3850
- * Unique identifier for the agent profile pool
3851
- */
3852
3345
  id: CommonUuid;
3853
3346
  /**
3854
3347
  * Name of the agent profile pool (unique within organization)
@@ -3858,46 +3351,25 @@ type AgentsProfileAgentProfilePool = {
3858
3351
  * The ID of the organization that owns this pool
3859
3352
  */
3860
3353
  organizationId: CommonUuid;
3861
- /**
3862
- * Strategy for selecting an available profile from the pool
3863
- */
3864
3354
  selectionStrategy: AgentsProfileSelectionStrategy;
3865
3355
  /**
3866
3356
  * Whether multiple executions can use the same profile concurrently
3867
3357
  */
3868
3358
  allowConcurrentUse: boolean;
3869
- /**
3870
- * When the pool was created
3871
- */
3872
3359
  createdAt: string;
3873
- /**
3874
- * When the pool was last updated
3875
- */
3876
3360
  updatedAt: string;
3877
3361
  };
3878
3362
  /**
3879
3363
  * An agent profile that is a member of a pool
3880
3364
  */
3881
3365
  type AgentsProfileAgentProfilePoolMember = {
3882
- /**
3883
- * Unique identifier for the agent profile
3884
- */
3885
3366
  id: CommonUuid;
3886
- /**
3887
- * Name of the agent profile
3888
- */
3889
3367
  name: string;
3890
3368
  /**
3891
3369
  * The ID of the organization that owns this profile
3892
3370
  */
3893
3371
  organizationId: CommonUuid;
3894
- /**
3895
- * When the profile was created
3896
- */
3897
3372
  createdAt: string;
3898
- /**
3899
- * When the profile was last updated
3900
- */
3901
3373
  updatedAt: string;
3902
3374
  };
3903
3375
  /**
@@ -3929,45 +3401,24 @@ type AgentsProfileAgentProfileVaultItemRef = {
3929
3401
  * A browser cookie stored for an agent profile
3930
3402
  */
3931
3403
  type AgentsProfileCookie = {
3932
- /**
3933
- * Unique identifier for the cookie
3934
- */
3935
3404
  id?: CommonUuid;
3936
- /**
3937
- * Display name for the cookie
3938
- */
3939
3405
  name: string;
3940
3406
  /**
3941
3407
  * The cookie key/name as sent in HTTP headers
3942
3408
  */
3943
3409
  key: string;
3944
- /**
3945
- * The cookie value
3946
- */
3947
3410
  value: string;
3948
- /**
3949
- * When the cookie expires (optional)
3950
- */
3951
3411
  expiry?: string;
3952
- /**
3953
- * The domain for which the cookie is valid
3954
- */
3955
3412
  domain: string;
3956
3413
  /**
3957
3414
  * Whether the cookie should only be sent over HTTPS
3958
3415
  */
3959
3416
  secure: boolean;
3960
- /**
3961
- * SameSite attribute for the cookie
3962
- */
3963
3417
  sameSite: AgentsProfileSameSite;
3964
3418
  /**
3965
3419
  * Whether the cookie should be accessible only via HTTP(S)
3966
3420
  */
3967
3421
  httpOnly: boolean;
3968
- /**
3969
- * When the cookie was created
3970
- */
3971
3422
  createdAt?: string;
3972
3423
  };
3973
3424
  /**
@@ -3986,9 +3437,6 @@ type AgentsProfileCreateAgentProfilePoolRequest = {
3986
3437
  * The ID of the organization that the pool belongs to. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.
3987
3438
  */
3988
3439
  organizationId?: CommonUuid;
3989
- /**
3990
- * Strategy for selecting an available profile from the pool
3991
- */
3992
3440
  selectionStrategy?: AgentsProfileSelectionStrategy;
3993
3441
  /**
3994
3442
  * Whether multiple executions can use the same profile concurrently
@@ -4003,17 +3451,12 @@ type AgentsProfileCreateAgentProfileRequest = {
4003
3451
  * Name of the agent profile (must be unique within organization)
4004
3452
  */
4005
3453
  name: string;
4006
- /**
4007
- * Description of the agent profile
4008
- */
4009
3454
  description: string;
4010
3455
  /**
4011
3456
  * The ID of the organization that the profile belongs to. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.
4012
3457
  */
4013
3458
  organizationId?: CommonUuid;
4014
3459
  /**
4015
- * Proxy configuration mode
4016
- *
4017
3460
  * @deprecated
4018
3461
  */
4019
3462
  proxyMode?: AgentsProfileProxyMode;
@@ -4054,14 +3497,10 @@ type AgentsProfileCreateAgentProfileRequest = {
4054
3497
  */
4055
3498
  stickyIP?: boolean;
4056
3499
  /**
4057
- * Operating system to emulate
4058
- *
4059
3500
  * @deprecated
4060
3501
  */
4061
3502
  operatingSystem?: AgentsProfileOperatingSystem;
4062
3503
  /**
4063
- * Whether to enable extra stealth mode
4064
- *
4065
3504
  * @deprecated
4066
3505
  */
4067
3506
  extraStealth?: boolean;
@@ -4078,8 +3517,6 @@ type AgentsProfileCreateAgentProfileRequest = {
4078
3517
  */
4079
3518
  cachePersistence?: boolean;
4080
3519
  /**
4081
- * Whether to enable ad blocking
4082
- *
4083
3520
  * @deprecated
4084
3521
  */
4085
3522
  adblockActive?: boolean;
@@ -4142,8 +3579,6 @@ type AgentsProfileCreateAgentProfileRequest = {
4142
3579
  */
4143
3580
  credentials?: Array<AgentsProfileCredential>;
4144
3581
  /**
4145
- * Initial cookies to create with the profile
4146
- *
4147
3582
  * @deprecated
4148
3583
  */
4149
3584
  cookies?: Array<AgentsProfileCookie>;
@@ -4152,9 +3587,6 @@ type AgentsProfileCreateAgentProfileRequest = {
4152
3587
  * A credential stored for an agent profile
4153
3588
  */
4154
3589
  type AgentsProfileCredential = {
4155
- /**
4156
- * Unique identifier for the credential
4157
- */
4158
3590
  id?: CommonUuid;
4159
3591
  /**
4160
3592
  * Display name for the credential (will be uppercased)
@@ -4164,9 +3596,6 @@ type AgentsProfileCredential = {
4164
3596
  * The credential value (plaintext - will be encrypted server-side)
4165
3597
  */
4166
3598
  data: string;
4167
- /**
4168
- * When the credential was created
4169
- */
4170
3599
  createdAt?: string;
4171
3600
  };
4172
3601
  /**
@@ -4190,26 +3619,14 @@ type AgentsProfileCustomProxyConfigInput = {
4190
3619
  * Proxy server address including protocol and port (e.g., 'socks5://proxy.example.com:1080' or 'http://proxy.example.com:8080')
4191
3620
  */
4192
3621
  server: string;
4193
- /**
4194
- * Proxy authentication username
4195
- */
4196
3622
  username: string;
4197
- /**
4198
- * Proxy authentication password
4199
- */
4200
3623
  password: string;
4201
3624
  };
4202
3625
  /**
4203
3626
  * Custom proxy server configuration for output (excludes password)
4204
3627
  */
4205
3628
  type AgentsProfileCustomProxyConfigOutput = {
4206
- /**
4207
- * Proxy server address
4208
- */
4209
3629
  server: string;
4210
- /**
4211
- * Proxy authentication username
4212
- */
4213
3630
  username: string;
4214
3631
  };
4215
3632
  /**
@@ -4245,21 +3662,9 @@ type AgentsProfileProfileInboxEmail = {
4245
3662
  * Unique email ID from Resend
4246
3663
  */
4247
3664
  id: string;
4248
- /**
4249
- * Sender address
4250
- */
4251
3665
  from: string;
4252
- /**
4253
- * Recipient addresses
4254
- */
4255
3666
  to: Array<string>;
4256
- /**
4257
- * Email subject
4258
- */
4259
3667
  subject: string;
4260
- /**
4261
- * When the email was received
4262
- */
4263
3668
  createdAt: string;
4264
3669
  };
4265
3670
  /**
@@ -4270,41 +3675,14 @@ type AgentsProfileProfileInboxEmailDetail = {
4270
3675
  * Unique email ID from Resend
4271
3676
  */
4272
3677
  id: string;
4273
- /**
4274
- * Sender address
4275
- */
4276
3678
  from: string;
4277
- /**
4278
- * Recipient addresses
4279
- */
4280
3679
  to: Array<string>;
4281
- /**
4282
- * Email subject
4283
- */
4284
3680
  subject: string;
4285
- /**
4286
- * When the email was received
4287
- */
4288
3681
  createdAt: string;
4289
- /**
4290
- * Plain-text body, if available
4291
- */
4292
3682
  text?: string;
4293
- /**
4294
- * HTML body, if available
4295
- */
4296
3683
  html?: string;
4297
- /**
4298
- * CC recipients, if any
4299
- */
4300
3684
  cc?: Array<string>;
4301
- /**
4302
- * BCC recipients, if any
4303
- */
4304
3685
  bcc?: Array<string>;
4305
- /**
4306
- * Reply-to addresses, if any
4307
- */
4308
3686
  replyTo?: Array<string>;
4309
3687
  };
4310
3688
  /**
@@ -4319,9 +3697,6 @@ type AgentsProfileProxyType = "basic";
4319
3697
  * Request to remove profiles from a pool
4320
3698
  */
4321
3699
  type AgentsProfileRemoveProfilesFromPoolRequest = {
4322
- /**
4323
- * Profile IDs to remove from the pool
4324
- */
4325
3700
  profileIds: Array<CommonUuid>;
4326
3701
  };
4327
3702
  /**
@@ -4340,13 +3715,7 @@ type AgentsProfileSortField = "name" | "created_at" | "updated_at";
4340
3715
  * Request to update an existing agent profile pool
4341
3716
  */
4342
3717
  type AgentsProfileUpdateAgentProfilePoolRequest = {
4343
- /**
4344
- * New name for the pool
4345
- */
4346
3718
  name?: string;
4347
- /**
4348
- * New selection strategy for the pool
4349
- */
4350
3719
  selectionStrategy?: AgentsProfileSelectionStrategy;
4351
3720
  /**
4352
3721
  * Whether multiple executions can use the same profile concurrently
@@ -4357,17 +3726,9 @@ type AgentsProfileUpdateAgentProfilePoolRequest = {
4357
3726
  * Request to update an existing agent profile
4358
3727
  */
4359
3728
  type AgentsProfileUpdateAgentProfileRequest = {
4360
- /**
4361
- * New name for the profile
4362
- */
4363
3729
  name?: string;
4364
- /**
4365
- * New description for the profile
4366
- */
4367
3730
  description?: string;
4368
3731
  /**
4369
- * Proxy configuration mode
4370
- *
4371
3732
  * @deprecated
4372
3733
  */
4373
3734
  proxyMode?: AgentsProfileProxyMode;
@@ -4402,14 +3763,10 @@ type AgentsProfileUpdateAgentProfileRequest = {
4402
3763
  */
4403
3764
  captchaSolverActive?: boolean;
4404
3765
  /**
4405
- * Operating system to emulate
4406
- *
4407
3766
  * @deprecated
4408
3767
  */
4409
3768
  operatingSystem?: AgentsProfileOperatingSystem;
4410
3769
  /**
4411
- * Whether to enable extra stealth mode
4412
- *
4413
3770
  * @deprecated
4414
3771
  */
4415
3772
  extraStealth?: boolean;
@@ -4426,8 +3783,6 @@ type AgentsProfileUpdateAgentProfileRequest = {
4426
3783
  */
4427
3784
  cachePersistence?: boolean;
4428
3785
  /**
4429
- * Whether to enable ad blocking
4430
- *
4431
3786
  * @deprecated
4432
3787
  */
4433
3788
  adblockActive?: boolean;
@@ -4522,14 +3877,10 @@ type AgentsProfileUpdateAgentProfileRequest = {
4522
3877
  */
4523
3878
  credentialsToDelete?: Array<CommonUuid>;
4524
3879
  /**
4525
- * Cookies to add to the profile
4526
- *
4527
3880
  * @deprecated
4528
3881
  */
4529
3882
  cookiesToAdd?: Array<AgentsProfileCookie>;
4530
3883
  /**
4531
- * IDs of cookies to remove from the profile
4532
- *
4533
3884
  * @deprecated
4534
3885
  */
4535
3886
  cookiesToDelete?: Array<CommonUuid>;
@@ -4581,9 +3932,6 @@ type AgentsScheduleBase = {
4581
3932
  */
4582
3933
  executionOptions?: AgentsAgentExecutionOptions;
4583
3934
  nextRunAt?: string;
4584
- /**
4585
- * When the schedule last fired.
4586
- */
4587
3935
  lastRunAt?: string;
4588
3936
  /**
4589
3937
  * Why the last tick failed, or absent when it succeeded. Set when a tick could not start its execution or batch, for example a sheet with more rows than one run may queue.
@@ -4644,13 +3992,22 @@ type AgentsScheduleCreateRequest = {
4644
3992
  * Profile group to select a profile from for each execution. Mutually exclusive with profileId.
4645
3993
  */
4646
3994
  profileGroupId?: CommonUuid;
3995
+ /**
3996
+ * Five-field cron expression.
3997
+ */
4647
3998
  cronExpression: string;
4648
3999
  /**
4649
4000
  * IANA time zone the cron expression is evaluated in. Defaults to UTC.
4650
4001
  */
4651
4002
  timezone?: string;
4652
4003
  enabled?: boolean;
4004
+ /**
4005
+ * When true, enabling the schedule after it was disabled runs it once right away. Creating it does not.
4006
+ */
4653
4007
  runOnEnable?: boolean;
4008
+ /**
4009
+ * Workflow version number to run. Omit it to run the published version.
4010
+ */
4654
4011
  version?: number;
4655
4012
  inputs?: {
4656
4013
  [key: string]: unknown;
@@ -4686,13 +4043,22 @@ type AgentsScheduleUpdateRequest = {
4686
4043
  * Profile group to select a profile from for each execution. Mutually exclusive with profileId.
4687
4044
  */
4688
4045
  profileGroupId?: CommonUuid;
4046
+ /**
4047
+ * Five-field cron expression.
4048
+ */
4689
4049
  cronExpression?: string;
4690
4050
  /**
4691
4051
  * IANA time zone the cron expression is evaluated in.
4692
4052
  */
4693
4053
  timezone?: string;
4694
4054
  enabled?: boolean;
4055
+ /**
4056
+ * When true, enabling the schedule after it was disabled runs it once right away.
4057
+ */
4695
4058
  runOnEnable?: boolean;
4059
+ /**
4060
+ * Workflow version number to run. Omit it to keep the current one.
4061
+ */
4696
4062
  version?: number;
4697
4063
  inputs?: {
4698
4064
  [key: string]: unknown;
@@ -4717,13 +4083,7 @@ type AgentsScheduleUpdateRequest = {
4717
4083
  };
4718
4084
  type AgentsScheduledExecutionBase = {
4719
4085
  id: CommonUuid;
4720
- /**
4721
- * The ID of the workflow the scheduled execution runs
4722
- */
4723
4086
  workflowId: CommonUuid;
4724
- /**
4725
- * The ID of the workflow version the scheduled execution runs
4726
- */
4727
4087
  workflowVersionId: CommonUuid;
4728
4088
  /**
4729
4089
  * Deprecated: use workflowId. The ID of the workflow the scheduled execution runs
@@ -4760,15 +4120,18 @@ type AgentsScheduledExecutionBase = {
4760
4120
  inputVars: {
4761
4121
  [key: string]: unknown;
4762
4122
  };
4763
- /**
4764
- * Input variables for the execution
4765
- */
4766
4123
  inputs: {
4767
4124
  [key: string]: unknown;
4768
4125
  };
4126
+ /**
4127
+ * String key/value pairs to label and filter executions.
4128
+ */
4769
4129
  metadata: {
4770
4130
  [key: string]: unknown;
4771
4131
  };
4132
+ /**
4133
+ * When to start the run, in ISO 8601.
4134
+ */
4772
4135
  executeAt?: string;
4773
4136
  status: AgentsScheduledExecutionStatus;
4774
4137
  executionId?: CommonUuid;
@@ -4799,9 +4162,6 @@ type AgentsScheduledExecutionCreateRequest = {
4799
4162
  * @deprecated
4800
4163
  */
4801
4164
  agentProfileId?: CommonUuid;
4802
- /**
4803
- * Login profile the execution runs with
4804
- */
4805
4165
  profileId?: CommonUuid;
4806
4166
  /**
4807
4167
  * Deprecated: use inputs.
@@ -4811,15 +4171,18 @@ type AgentsScheduledExecutionCreateRequest = {
4811
4171
  inputVars?: {
4812
4172
  [key: string]: unknown;
4813
4173
  };
4814
- /**
4815
- * Input variables for the execution
4816
- */
4817
4174
  inputs?: {
4818
4175
  [key: string]: unknown;
4819
4176
  };
4177
+ /**
4178
+ * String key/value pairs to label and filter executions.
4179
+ */
4820
4180
  metadata?: {
4821
4181
  [key: string]: unknown;
4822
4182
  };
4183
+ /**
4184
+ * When to start the run, in ISO 8601.
4185
+ */
4823
4186
  executeAt: string;
4824
4187
  /**
4825
4188
  * Per-execution runtime options applied when this execution is triggered.
@@ -4827,6 +4190,9 @@ type AgentsScheduledExecutionCreateRequest = {
4827
4190
  executionOptions?: AgentsAgentExecutionOptions;
4828
4191
  };
4829
4192
  type AgentsScheduledExecutionRescheduleRequest = {
4193
+ /**
4194
+ * When to start the run, in ISO 8601.
4195
+ */
4830
4196
  executeAt: string;
4831
4197
  };
4832
4198
  type AgentsScheduledExecutionStatus = "pending" | "triggered" | "cancelled" | "awaiting_capacity" | "batch_paused" | "failed";
@@ -4834,9 +4200,6 @@ type AgentsScheduledExecutionStatus = "pending" | "triggered" | "cancelled" | "a
4834
4200
  * Request to validate a JSON schema against OpenAI structured output requirements
4835
4201
  */
4836
4202
  type AgentsSchemaValidateSchemaRequest = {
4837
- /**
4838
- * The JSON schema to validate
4839
- */
4840
4203
  schema: {
4841
4204
  [key: string]: unknown;
4842
4205
  };
@@ -4845,9 +4208,6 @@ type AgentsSchemaValidateSchemaRequest = {
4845
4208
  * Response from schema validation
4846
4209
  */
4847
4210
  type AgentsSchemaValidateSchemaResponse = {
4848
- /**
4849
- * Whether the schema is valid
4850
- */
4851
4211
  valid: boolean;
4852
4212
  /**
4853
4213
  * List of validation error messages (empty if valid)
@@ -4864,18 +4224,12 @@ type AgentsTagAgentWorkflowTagName = {
4864
4224
  * Group name. Protected group names resolve to the protected group; anything else is a user-defined group.
4865
4225
  */
4866
4226
  group: string;
4867
- /**
4868
- * Tag name
4869
- */
4870
4227
  name: string;
4871
4228
  };
4872
4229
  /**
4873
4230
  * Exactly one of groupId and protectedGroupKey selects the group.
4874
4231
  */
4875
4232
  type AgentsTagCreateWorkflowTagRequest = {
4876
- /**
4877
- * Group to create the tag in
4878
- */
4879
4233
  groupId?: CommonUuid;
4880
4234
  /**
4881
4235
  * Protected group to create the tag in, materializing its row if needed
@@ -4902,9 +4256,6 @@ type AgentsTagPatchAgentWorkflowTagsRequest = {
4902
4256
  * Tags to add by name, created when missing
4903
4257
  */
4904
4258
  create?: Array<AgentsTagAgentWorkflowTagName>;
4905
- /**
4906
- * Tag ids to remove
4907
- */
4908
4259
  remove?: Array<CommonUuid>;
4909
4260
  };
4910
4261
  type AgentsTagSetAgentWorkflowTagsRequest = {
@@ -4941,17 +4292,8 @@ type AgentsTagUpdateWorkflowTagRequest = {
4941
4292
  * Org-scoped workflow tag. Portal-group tags can link to a catalog portal, which supplies the logo.
4942
4293
  */
4943
4294
  type AgentsTagWorkflowTag = {
4944
- /**
4945
- * Unique identifier for the tag
4946
- */
4947
4295
  id: CommonUuid;
4948
- /**
4949
- * Organization this tag belongs to
4950
- */
4951
4296
  organizationId: CommonUuid;
4952
- /**
4953
- * Group the tag belongs to
4954
- */
4955
4297
  groupId: CommonUuid;
4956
4298
  /**
4957
4299
  * Name of the group the tag belongs to, so clients can render group::tag without listing groups
@@ -4979,26 +4321,14 @@ type AgentsTagWorkflowTag = {
4979
4321
  * Number of workflows carrying this tag. Present on the organization list only.
4980
4322
  */
4981
4323
  workflowCount?: number;
4982
- /**
4983
- * When the tag was created
4984
- */
4985
4324
  createdAt: string;
4986
- /**
4987
- * When the tag was last updated
4988
- */
4989
4325
  updatedAt: string;
4990
4326
  };
4991
4327
  /**
4992
4328
  * Org-scoped group of workflow tags. A tag renders as group::tag, so names may not contain '::'.
4993
4329
  */
4994
4330
  type AgentsTagWorkflowTagGroup = {
4995
- /**
4996
- * Unique identifier for the group
4997
- */
4998
4331
  id: CommonUuid;
4999
- /**
5000
- * Organization this group belongs to
5001
- */
5002
4332
  organizationId: CommonUuid;
5003
4333
  /**
5004
4334
  * Group name, unique per organization case-insensitively
@@ -5016,13 +4346,7 @@ type AgentsTagWorkflowTagGroup = {
5016
4346
  * Number of tags in the group. Present on the organization list only.
5017
4347
  */
5018
4348
  tagCount?: number;
5019
- /**
5020
- * When the group was created
5021
- */
5022
4349
  createdAt: string;
5023
- /**
5024
- * When the group was last updated
5025
- */
5026
4350
  updatedAt: string;
5027
4351
  };
5028
4352
  /**
@@ -5059,6 +4383,9 @@ type AgentsVaultCreateVaultItemRequest = {
5059
4383
  * Inline field blueprint. Required when templateId is omitted.
5060
4384
  */
5061
4385
  fields?: Array<AgentsVaultFieldSpecInput>;
4386
+ /**
4387
+ * Field values as `key`/`value` pairs.
4388
+ */
5062
4389
  values: Array<AgentsVaultFieldValue>;
5063
4390
  };
5064
4391
  type AgentsVaultCreateVaultShareLinkRequest = {
@@ -5066,8 +4393,17 @@ type AgentsVaultCreateVaultShareLinkRequest = {
5066
4393
  * The organization. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.
5067
4394
  */
5068
4395
  organizationId?: CommonUuid;
4396
+ /**
4397
+ * Title shown to the recipient of the secret request.
4398
+ */
5069
4399
  title: string;
4400
+ /**
4401
+ * Explanation shown to the recipient of the secret request.
4402
+ */
5070
4403
  description?: string;
4404
+ /**
4405
+ * Name of the secret the request creates.
4406
+ */
5071
4407
  name: string;
5072
4408
  /**
5073
4409
  * Optional UPPER_SNAKE key. Derived from name when omitted.
@@ -5099,6 +4435,9 @@ type AgentsVaultCreateVaultTemplateRequest = {
5099
4435
  name: string;
5100
4436
  description?: string;
5101
4437
  fields: Array<AgentsVaultFieldSpecInput>;
4438
+ /**
4439
+ * How the fields are laid out as steps when someone fills in a secret request.
4440
+ */
5102
4441
  steps?: Array<AgentsVaultTemplateStep>;
5103
4442
  };
5104
4443
  type AgentsVaultDuplicateVaultTemplateRequest = {
@@ -5194,6 +4533,9 @@ type AgentsVaultItemKey = string;
5194
4533
  */
5195
4534
  type AgentsVaultItemKind = "login" | "api_key" | "card" | "custom";
5196
4535
  type AgentsVaultRotateVaultItemRequest = {
4536
+ /**
4537
+ * New field values as `key`/`value` pairs.
4538
+ */
5197
4539
  values: Array<AgentsVaultFieldValue>;
5198
4540
  };
5199
4541
  /**
@@ -5242,6 +4584,9 @@ type AgentsVaultUpdateVaultTemplateRequest = {
5242
4584
  name?: string;
5243
4585
  description?: string;
5244
4586
  fields?: Array<AgentsVaultFieldSpecInput>;
4587
+ /**
4588
+ * How the fields are laid out as steps when someone fills in a secret request.
4589
+ */
5245
4590
  steps?: Array<AgentsVaultTemplateStep>;
5246
4591
  };
5247
4592
  /**
@@ -5319,9 +4664,6 @@ type AgentsVaultVaultShareLink = {
5319
4664
  * Submits that resolved this link but did not complete it: invalid values, a dead link, or a lost race.
5320
4665
  */
5321
4666
  failedSubmits: number;
5322
- /**
5323
- * When the most recent failed submit happened.
5324
- */
5325
4667
  lastFailedSubmitAt?: string;
5326
4668
  /**
5327
4669
  * Who made it. `createdBy` holds a user id only, so read this for a record an API key made.
@@ -5335,9 +4677,6 @@ type AgentsVaultVaultShareLink = {
5335
4677
  * Create response. token is the raw link secret and is returned once; the server stores only its hash.
5336
4678
  */
5337
4679
  type AgentsVaultVaultShareLinkCreated = {
5338
- /**
5339
- * The created share link.
5340
- */
5341
4680
  link: AgentsVaultVaultShareLink;
5342
4681
  /**
5343
4682
  * Raw token for the recipient URL. Returned once.
@@ -5425,9 +4764,6 @@ type AgentsWorkflowBrowserTemplateConfig = {
5425
4764
  * Response after creating a workflow
5426
4765
  */
5427
4766
  type AgentsWorkflowCreateWorkflowResponse = {
5428
- /**
5429
- * The ID of the newly created workflow
5430
- */
5431
4767
  workflowId: CommonUuid;
5432
4768
  };
5433
4769
  /**
@@ -5495,9 +4831,6 @@ type AgentsWorkflowExecuteWorkflowRequest = {
5495
4831
  * Response after starting workflow execution
5496
4832
  */
5497
4833
  type AgentsWorkflowExecuteWorkflowResponse = {
5498
- /**
5499
- * The ID of the newly created execution
5500
- */
5501
4834
  executionId: CommonUuid;
5502
4835
  };
5503
4836
  /**
@@ -5508,21 +4841,12 @@ type AgentsWorkflowExternalCreateWorkflowRequest = {
5508
4841
  * Optional parent workflow ID to derive from
5509
4842
  */
5510
4843
  parentId?: CommonUuid;
5511
- /**
5512
- * The rules/instructions for this workflow
5513
- */
5514
4844
  rules: string;
5515
- /**
5516
- * The workflow graph
5517
- */
5518
4845
  graph: AgentsGraphModelsAgentGraph;
5519
4846
  /**
5520
4847
  * Typed input definitions for this workflow. Names referenced in prompts but omitted here default to optional strings.
5521
4848
  */
5522
4849
  inputs?: Array<AgentsWorkflowInput>;
5523
- /**
5524
- * The settings for this workflow
5525
- */
5526
4850
  settings: AgentsGraphModelsExternalSettings;
5527
4851
  /**
5528
4852
  * Optional environment template. On a new version, omit it to keep the template of the workflow's latest version (its editable head); on a new workflow, omitting it means a browser. Omits admin-only OS fields.
@@ -5533,22 +4857,13 @@ type AgentsWorkflowExternalCreateWorkflowRequest = {
5533
4857
  * Environment template on the external API. Omits admin-only OS fields.
5534
4858
  */
5535
4859
  type AgentsWorkflowExternalEnvironmentTemplate = {
5536
- /**
5537
- * Type of environment (browser or os)
5538
- */
5539
4860
  type: AgentsWorkflowEnvironmentType;
5540
- /**
5541
- * Environment-specific configuration
5542
- */
5543
4861
  config: AgentsWorkflowBrowserTemplateConfig | AgentsWorkflowExternalOsTemplateConfig;
5544
4862
  };
5545
4863
  /**
5546
4864
  * Customer-facing OS environment template configuration. Admin-only fields live on OsTemplateConfig.
5547
4865
  */
5548
4866
  type AgentsWorkflowExternalOsTemplateConfig = {
5549
- /**
5550
- * OS provider type
5551
- */
5552
4867
  provider: AgentsWorkflowOsProvider;
5553
4868
  /**
5554
4869
  * Operating system the sandbox runs. Defaults to linux. Setting to windows is admin-only and selects the Windows snapshot/image.
@@ -5571,13 +4886,7 @@ type AgentsWorkflowExternalOsTemplateConfig = {
5571
4886
  * A workflow (commit) representing an immutable snapshot of agent configuration
5572
4887
  */
5573
4888
  type AgentsWorkflowExternalWorkflowSnapshot = {
5574
- /**
5575
- * The unique ID of this workflow
5576
- */
5577
4889
  id: CommonUuid;
5578
- /**
5579
- * The agent ID this workflow belongs to
5580
- */
5581
4890
  agentId: CommonUuid;
5582
4891
  /**
5583
4892
  * The ID of the parent workflow this was derived from (for lineage tracking)
@@ -5591,13 +4900,7 @@ type AgentsWorkflowExternalWorkflowSnapshot = {
5591
4900
  * Whether this is the workflow's published version (the API default). At most one version per workflow is published.
5592
4901
  */
5593
4902
  isPublished: boolean;
5594
- /**
5595
- * The rules/instructions for this workflow
5596
- */
5597
4903
  rules: string;
5598
- /**
5599
- * The workflow graph
5600
- */
5601
4904
  graph: AgentsGraphModelsAgentGraph;
5602
4905
  /**
5603
4906
  * Typed input definitions for workflow execution. Includes names referenced in prompts, which default to optional strings.
@@ -5619,9 +4922,6 @@ type AgentsWorkflowExternalWorkflowSnapshot = {
5619
4922
  * Monotonic optimistic-concurrency revision. Only meaningful for the editable head: supply it as baseRev on the next head patch. Agent-file-only patches overlay the current head if it has moved; structural-file patches are rejected with 409 when stale. Frozen snapshots never receive in-place patches.
5620
4923
  */
5621
4924
  rev: number;
5622
- /**
5623
- * The settings for this workflow
5624
- */
5625
4925
  settings: AgentsGraphModelsExternalSettings;
5626
4926
  /**
5627
4927
  * Optional environment template. Defaults to browser/anchor if not provided. Omits admin-only OS fields.
@@ -5650,9 +4950,6 @@ type AgentsWorkflowInput = {
5650
4950
  * Optional value used when the input is omitted at execution time.
5651
4951
  */
5652
4952
  defaultValue?: unknown;
5653
- /**
5654
- * Optional human-readable description of the input.
5655
- */
5656
4953
  description?: string;
5657
4954
  };
5658
4955
  /**
@@ -5671,13 +4968,7 @@ type AgentsWorkflowOsType = "linux" | "windows";
5671
4968
  * Response after publishing a workflow
5672
4969
  */
5673
4970
  type AgentsWorkflowPublishWorkflowResponse = {
5674
- /**
5675
- * The ID of the published workflow
5676
- */
5677
4971
  workflowId: CommonUuid;
5678
- /**
5679
- * The assigned version number
5680
- */
5681
4972
  version: number;
5682
4973
  };
5683
4974
  /**
@@ -5693,17 +4984,11 @@ type AgentsWorkflowRevertWorkflowHeadRequest = {
5693
4984
  * A file stored on a workflow version. Content is fetched via the workflow-scoped shared-file download endpoints using this id.
5694
4985
  */
5695
4986
  type AgentsWorkflowWorkflowFile = {
5696
- /**
5697
- * The unique ID of this file within the workflow version
5698
- */
5699
4987
  id: CommonUuid;
5700
4988
  /**
5701
4989
  * The file path, relative to the workflow's shared directory
5702
4990
  */
5703
4991
  filePath: string;
5704
- /**
5705
- * The file's base name
5706
- */
5707
4992
  fileName: string;
5708
4993
  /**
5709
4994
  * The file size in bytes
@@ -5721,9 +5006,6 @@ type AgentsWorkflowWorkflowFile = {
5721
5006
  * When this file was first added to the workflow lineage
5722
5007
  */
5723
5008
  createdAt: string;
5724
- /**
5725
- * When this file was last modified
5726
- */
5727
5009
  updatedAt: string;
5728
5010
  };
5729
5011
  /**
@@ -5841,18 +5123,12 @@ type AgentsWorkflowWorkflowFilesPatchRequest = {
5841
5123
  * Files to upsert.
5842
5124
  */
5843
5125
  writes: Array<AgentsWorkflowWorkflowFileWrite>;
5844
- /**
5845
- * Paths of files to delete.
5846
- */
5847
5126
  deletes: Array<string>;
5848
5127
  };
5849
5128
  /**
5850
5129
  * The typed inputs a workflow declares
5851
5130
  */
5852
5131
  type AgentsWorkflowWorkflowInputs = {
5853
- /**
5854
- * Typed input definitions the workflow accepts at execution time
5855
- */
5856
5132
  inputs: Array<AgentsWorkflowInput>;
5857
5133
  };
5858
5134
  /**
@@ -5865,9 +5141,6 @@ type AgentsWorkflowWorkflowOutputSchemas = {
5865
5141
  * Lightweight workflow reference for listing workflows without full data
5866
5142
  */
5867
5143
  type AgentsWorkflowWorkflowRef = {
5868
- /**
5869
- * The unique ID of this workflow
5870
- */
5871
5144
  id: CommonUuid;
5872
5145
  /**
5873
5146
  * The ID of the parent workflow this was derived from (for lineage tracking)
@@ -5881,9 +5154,6 @@ type AgentsWorkflowWorkflowRef = {
5881
5154
  * Whether this is the workflow's published version (the API default). At most one version per workflow is published.
5882
5155
  */
5883
5156
  isPublished: boolean;
5884
- /**
5885
- * When this workflow was created
5886
- */
5887
5157
  createdAt: string;
5888
5158
  /**
5889
5159
  * The email of the user who created this workflow.
@@ -5902,9 +5172,6 @@ type AgentsWorkflowWorkflowValidationIssue = {
5902
5172
  * Whether this issue blocks running the workflow (error) or is advisory (warning).
5903
5173
  */
5904
5174
  severity: AgentsWorkflowWorkflowValidationSeverity;
5905
- /**
5906
- * Human-readable description of the problem.
5907
- */
5908
5175
  message: string;
5909
5176
  /**
5910
5177
  * Path to the offending field, e.g. ["nodes", "My Node", "model"].
@@ -5949,9 +5216,6 @@ type CommonBadRequestErrorBody = {
5949
5216
  * Short summary of the problem type
5950
5217
  */
5951
5218
  title?: string;
5952
- /**
5953
- * The HTTP status code
5954
- */
5955
5219
  status?: number;
5956
5220
  /**
5957
5221
  * Explanation of this occurrence. Same text as message
@@ -5977,9 +5241,6 @@ type CommonConflictErrorBody = {
5977
5241
  * Short summary of the problem type
5978
5242
  */
5979
5243
  title?: string;
5980
- /**
5981
- * The HTTP status code
5982
- */
5983
5244
  status?: number;
5984
5245
  /**
5985
5246
  * Explanation of this occurrence. Same text as message
@@ -6001,9 +5262,6 @@ type CommonError = {
6001
5262
  * Short summary of the problem type
6002
5263
  */
6003
5264
  title?: string;
6004
- /**
6005
- * The HTTP status code
6006
- */
6007
5265
  status?: number;
6008
5266
  /**
6009
5267
  * Explanation of this occurrence. Same text as message
@@ -6042,9 +5300,6 @@ type CommonForbiddenErrorBody = {
6042
5300
  * Short summary of the problem type
6043
5301
  */
6044
5302
  title?: string;
6045
- /**
6046
- * The HTTP status code
6047
- */
6048
5303
  status?: number;
6049
5304
  /**
6050
5305
  * Explanation of this occurrence. Same text as message
@@ -6075,9 +5330,6 @@ type CommonInternalServerErrorBody = {
6075
5330
  * Short summary of the problem type
6076
5331
  */
6077
5332
  title?: string;
6078
- /**
6079
- * The HTTP status code
6080
- */
6081
5333
  status?: number;
6082
5334
  /**
6083
5335
  * Explanation of this occurrence. Same text as message
@@ -6099,9 +5351,6 @@ type CommonNotFoundErrorBody = {
6099
5351
  * Short summary of the problem type
6100
5352
  */
6101
5353
  title?: string;
6102
- /**
6103
- * The HTTP status code
6104
- */
6105
5354
  status?: number;
6106
5355
  /**
6107
5356
  * Explanation of this occurrence. Same text as message
@@ -6126,9 +5375,6 @@ type CommonPaymentRequiredErrorBody = {
6126
5375
  * Short summary of the problem type
6127
5376
  */
6128
5377
  title?: string;
6129
- /**
6130
- * The HTTP status code
6131
- */
6132
5378
  status?: number;
6133
5379
  /**
6134
5380
  * Explanation of this occurrence. Same text as message
@@ -6155,9 +5401,6 @@ type CommonTooManyRequestsErrorBody = {
6155
5401
  * Short summary of the problem type
6156
5402
  */
6157
5403
  title?: string;
6158
- /**
6159
- * The HTTP status code
6160
- */
6161
5404
  status?: number;
6162
5405
  /**
6163
5406
  * Explanation of this occurrence. Same text as message
@@ -6179,9 +5422,6 @@ type CommonUnauthorizedErrorBody = {
6179
5422
  * Short summary of the problem type
6180
5423
  */
6181
5424
  title?: string;
6182
- /**
6183
- * The HTTP status code
6184
- */
6185
5425
  status?: number;
6186
5426
  /**
6187
5427
  * Explanation of this occurrence. Same text as message
@@ -6202,21 +5442,12 @@ type WorkflowsVersionCreateRequest = {
6202
5442
  * Optional parent workflow ID to derive from
6203
5443
  */
6204
5444
  parentId?: CommonUuid;
6205
- /**
6206
- * The rules/instructions for this workflow
6207
- */
6208
5445
  rules: string;
6209
- /**
6210
- * The workflow graph
6211
- */
6212
5446
  graph: AgentsGraphModelsAgentGraph;
6213
5447
  /**
6214
5448
  * Typed input definitions for this workflow. Names referenced in prompts but omitted here default to optional strings.
6215
5449
  */
6216
5450
  inputs?: Array<AgentsWorkflowInput>;
6217
- /**
6218
- * The settings for this workflow
6219
- */
6220
5451
  settings: AgentsGraphModelsExternalSettings;
6221
5452
  /**
6222
5453
  * Optional environment template. On a new version, omit it to keep the template of the workflow's latest version (its editable head); on a new workflow, omitting it means a browser. Omits admin-only OS fields.
@@ -6227,9 +5458,6 @@ type WorkflowsVersionCreateRequest = {
6227
5458
  * Response after creating a workflow version
6228
5459
  */
6229
5460
  type WorkflowsVersionCreateResponse = {
6230
- /**
6231
- * The ID of the new version
6232
- */
6233
5461
  versionId: CommonUuid;
6234
5462
  };
6235
5463
  /**
@@ -6293,9 +5521,6 @@ type WorkflowsVersionExecuteRequest = {
6293
5521
  * Response after starting a workflow version execution
6294
5522
  */
6295
5523
  type WorkflowsVersionExecuteResponse = {
6296
- /**
6297
- * The ID of the newly created execution
6298
- */
6299
5524
  executionId: CommonUuid;
6300
5525
  };
6301
5526
  /**
@@ -6322,9 +5547,6 @@ type WorkflowsVersionFileTree = {
6322
5547
  * Every variant key the workflow's files carry, sorted, regardless of any variants filter on the read — a narrowed tree still names what it could ask for. Absent unless the workflow has variant mode enabled.
6323
5548
  */
6324
5549
  variantKeys?: Array<string>;
6325
- /**
6326
- * The ID of the version this tree renders
6327
- */
6328
5550
  versionId: CommonUuid;
6329
5551
  /**
6330
5552
  * The name of the workflow. A client that lays the directory out under a per-workflow folder derives the folder from it.
@@ -6343,18 +5565,12 @@ type WorkflowsVersionFilesPatchRequest = {
6343
5565
  * Files to upsert.
6344
5566
  */
6345
5567
  writes: Array<AgentsWorkflowWorkflowFileWrite>;
6346
- /**
6347
- * Paths of files to delete.
6348
- */
6349
5568
  deletes: Array<string>;
6350
5569
  };
6351
5570
  /**
6352
5571
  * The typed inputs a workflow version declares
6353
5572
  */
6354
5573
  type WorkflowsVersionInputs = {
6355
- /**
6356
- * Typed input definitions the workflow accepts at execution time
6357
- */
6358
5574
  inputs: Array<AgentsWorkflowInput>;
6359
5575
  };
6360
5576
  /**
@@ -6378,22 +5594,13 @@ type WorkflowsVersionOutputSchemas = {
6378
5594
  * Response after publishing a workflow version
6379
5595
  */
6380
5596
  type WorkflowsVersionPublishResponse = {
6381
- /**
6382
- * The ID of the published version
6383
- */
6384
5597
  versionId: CommonUuid;
6385
- /**
6386
- * The assigned version number
6387
- */
6388
5598
  version: number;
6389
5599
  };
6390
5600
  /**
6391
5601
  * Lightweight reference to a workflow version, for listing versions without their full content
6392
5602
  */
6393
5603
  type WorkflowsVersionRef = {
6394
- /**
6395
- * The unique ID of this workflow
6396
- */
6397
5604
  id: CommonUuid;
6398
5605
  /**
6399
5606
  * The ID of the parent workflow this was derived from (for lineage tracking)
@@ -6407,9 +5614,6 @@ type WorkflowsVersionRef = {
6407
5614
  * Whether this is the workflow's published version (the API default). At most one version per workflow is published.
6408
5615
  */
6409
5616
  isPublished: boolean;
6410
- /**
6411
- * When this workflow was created
6412
- */
6413
5617
  createdAt: string;
6414
5618
  /**
6415
5619
  * The email of the user who created this workflow.
@@ -6433,9 +5637,6 @@ type WorkflowsVersionRevertHeadRequest = {
6433
5637
  * An immutable snapshot of a workflow's configuration
6434
5638
  */
6435
5639
  type WorkflowsVersionSnapshot = {
6436
- /**
6437
- * The unique ID of this workflow
6438
- */
6439
5640
  id: CommonUuid;
6440
5641
  /**
6441
5642
  * The ID of the parent workflow this was derived from (for lineage tracking)
@@ -6449,13 +5650,7 @@ type WorkflowsVersionSnapshot = {
6449
5650
  * Whether this is the workflow's published version (the API default). At most one version per workflow is published.
6450
5651
  */
6451
5652
  isPublished: boolean;
6452
- /**
6453
- * The rules/instructions for this workflow
6454
- */
6455
5653
  rules: string;
6456
- /**
6457
- * The workflow graph
6458
- */
6459
5654
  graph: AgentsGraphModelsAgentGraph;
6460
5655
  /**
6461
5656
  * Typed input definitions for workflow execution. Includes names referenced in prompts, which default to optional strings.
@@ -6477,13 +5672,7 @@ type WorkflowsVersionSnapshot = {
6477
5672
  * Monotonic optimistic-concurrency revision. Only meaningful for the editable head: supply it as baseRev on the next head patch. Agent-file-only patches overlay the current head if it has moved; structural-file patches are rejected with 409 when stale. Frozen snapshots never receive in-place patches.
6478
5673
  */
6479
5674
  rev: number;
6480
- /**
6481
- * The ID of the workflow this version belongs to
6482
- */
6483
5675
  workflowId: CommonUuid;
6484
- /**
6485
- * The settings for this version
6486
- */
6487
5676
  settings: AgentsGraphModelsExternalSettings;
6488
5677
  /**
6489
5678
  * Optional environment template. Defaults to browser/anchor if not provided.
@@ -6542,9 +5731,6 @@ type WorkflowsWorkflowCreateResponse = {
6542
5731
  * A workflow and the selected version
6543
5732
  */
6544
5733
  type WorkflowsWorkflowDetail = {
6545
- /**
6546
- * The workflow
6547
- */
6548
5734
  workflow: WorkflowsWorkflowBase;
6549
5735
  /**
6550
5736
  * The selected version: the published one unless a version number was requested
@@ -6572,9 +5758,6 @@ type WorkflowsWorkflowDuplicateRequest = {
6572
5758
  * Response after duplicating a workflow
6573
5759
  */
6574
5760
  type WorkflowsWorkflowDuplicateResponse = {
6575
- /**
6576
- * The ID of the new workflow
6577
- */
6578
5761
  id: CommonUuid;
6579
5762
  /**
6580
5763
  * The ID of the new workflow's first version
@@ -6654,9 +5837,6 @@ type WorkflowsWorkflowExecuteRequest = {
6654
5837
  * Response after starting a workflow execution
6655
5838
  */
6656
5839
  type WorkflowsWorkflowExecuteResponse = {
6657
- /**
6658
- * The ID of the newly created execution
6659
- */
6660
5840
  executionId: CommonUuid;
6661
5841
  /**
6662
5842
  * The execution's initial status: "starting" when it began immediately, "queued" when it
@@ -6742,9 +5922,6 @@ type WorkflowsWorkflowExecuteSyncRequest = {
6742
5922
  * Response from executing a workflow and waiting for the result
6743
5923
  */
6744
5924
  type WorkflowsWorkflowExecuteSyncResponse = {
6745
- /**
6746
- * The ID of the newly created execution
6747
- */
6748
5925
  executionId: CommonUuid;
6749
5926
  /**
6750
5927
  * The execution's status when the call returned: terminal on 200, the current status on 202
@@ -6774,9 +5951,6 @@ type WorkflowsWorkflowPatchTagsRequest = {
6774
5951
  * Tags to add by name, created when missing
6775
5952
  */
6776
5953
  create?: Array<AgentsTagAgentWorkflowTagName>;
6777
- /**
6778
- * Tag ids to remove
6779
- */
6780
5954
  remove?: Array<CommonUuid>;
6781
5955
  };
6782
5956
  /**
@@ -6828,9 +6002,6 @@ type WorkflowsWorkflowSchedule = {
6828
6002
  */
6829
6003
  executionOptions?: AgentsAgentExecutionOptions;
6830
6004
  nextRunAt?: string;
6831
- /**
6832
- * When the schedule last fired.
6833
- */
6834
6005
  lastRunAt?: string;
6835
6006
  /**
6836
6007
  * Why the last tick failed, or absent when it succeeded. Set when a tick could not start its execution or batch, for example a sheet with more rows than one run may queue.
@@ -6842,9 +6013,6 @@ type WorkflowsWorkflowSchedule = {
6842
6013
  actor?: CommonActor;
6843
6014
  createdAt: string;
6844
6015
  updatedAt: string;
6845
- /**
6846
- * The ID of the workflow the schedule executes
6847
- */
6848
6016
  workflowId: CommonUuid;
6849
6017
  };
6850
6018
  /**
@@ -6872,13 +6040,22 @@ type WorkflowsWorkflowScheduleCreateRequest = {
6872
6040
  * Profile group to select a profile from for each execution. Mutually exclusive with profileId.
6873
6041
  */
6874
6042
  profileGroupId?: CommonUuid;
6043
+ /**
6044
+ * Five-field cron expression.
6045
+ */
6875
6046
  cronExpression: string;
6876
6047
  /**
6877
6048
  * IANA time zone the cron expression is evaluated in. Defaults to UTC.
6878
6049
  */
6879
6050
  timezone?: string;
6880
6051
  enabled?: boolean;
6052
+ /**
6053
+ * When true, enabling the schedule after it was disabled runs it once right away. Creating it does not.
6054
+ */
6881
6055
  runOnEnable?: boolean;
6056
+ /**
6057
+ * Workflow version number to run. Omit it to run the published version.
6058
+ */
6882
6059
  version?: number;
6883
6060
  inputs?: {
6884
6061
  [key: string]: unknown;
@@ -6917,13 +6094,22 @@ type WorkflowsWorkflowScheduleUpdateRequest = {
6917
6094
  * Profile group to select a profile from for each execution. Mutually exclusive with profileId.
6918
6095
  */
6919
6096
  profileGroupId?: CommonUuid;
6097
+ /**
6098
+ * Five-field cron expression.
6099
+ */
6920
6100
  cronExpression?: string;
6921
6101
  /**
6922
6102
  * IANA time zone the cron expression is evaluated in.
6923
6103
  */
6924
6104
  timezone?: string;
6925
6105
  enabled?: boolean;
6106
+ /**
6107
+ * When true, enabling the schedule after it was disabled runs it once right away.
6108
+ */
6926
6109
  runOnEnable?: boolean;
6110
+ /**
6111
+ * Workflow version number to run. Omit it to keep the current one.
6112
+ */
6927
6113
  version?: number;
6928
6114
  inputs?: {
6929
6115
  [key: string]: unknown;
@@ -6964,6 +6150,9 @@ type WorkflowsWorkflowUpdateRequest = {
6964
6150
  */
6965
6151
  name?: string;
6966
6152
  };
6153
+ /**
6154
+ * Return results whose name contains this text, case-insensitive.
6155
+ */
6967
6156
  type AgentsAgentSearch = string;
6968
6157
  /**
6969
6158
  * Filter executions created within this long before now: number-unit pairs with units w, d, h, m, longest first, e.g. 30m, 24h, 7d, 1d12h. Maximum 10 years. Cannot be combined with createdAfter
@@ -6989,21 +6178,12 @@ type AgentsExecutionSearchAgentId = CommonUuid;
6989
6178
  * @deprecated
6990
6179
  */
6991
6180
  type AgentsExecutionSearchAgentProfileIds = Array<CommonUuid>;
6992
- /**
6993
- * Filter executions created after this timestamp
6994
- */
6995
6181
  type AgentsExecutionSearchCreatedAfter = string;
6996
- /**
6997
- * Filter executions created before this timestamp
6998
- */
6999
6182
  type AgentsExecutionSearchCreatedBefore = string;
7000
6183
  /**
7001
6184
  * Search by execution ID (partial, case-insensitive match)
7002
6185
  */
7003
6186
  type AgentsExecutionSearchExecutionId = string;
7004
- /**
7005
- * Filter by whether the execution recorded any script failures
7006
- */
7007
6187
  type AgentsExecutionSearchHasScriptFailures = boolean;
7008
6188
  /**
7009
6189
  * Filter by human labels (can specify multiple label IDs, there is an 'OR' condition applied to these)
@@ -7041,13 +6221,7 @@ type AgentsExecutionSearchStatus = Array<AgentsExecutionStatus>;
7041
6221
  * Filter by how the execution was triggered (can specify multiple, there is an 'OR' condition applied to these)
7042
6222
  */
7043
6223
  type AgentsExecutionSearchTriggerSource = Array<"api" | "ui" | "schedule" | "warmup">;
7044
- /**
7045
- * Filter by workflow version number
7046
- */
7047
6224
  type AgentsExecutionSearchWorkflowVersion = number;
7048
- /**
7049
- * Filter by workflow ID
7050
- */
7051
6225
  type AgentsExecutionWorkflowFilter = CommonUuid;
7052
6226
  /**
7053
6227
  * Deprecated: use workflowId. Filter by workflow ID
@@ -7055,9 +6229,6 @@ type AgentsExecutionWorkflowFilter = CommonUuid;
7055
6229
  * @deprecated
7056
6230
  */
7057
6231
  type AgentsExecutionBatchListFilterAgentId = CommonUuid;
7058
- /**
7059
- * Filter by batch status
7060
- */
7061
6232
  type AgentsExecutionBatchListFilterStatus = AgentsExecutionBatchStatus;
7062
6233
  /**
7063
6234
  * Filter by workflow ID. Set this or agentId.
@@ -7099,9 +6270,6 @@ type AgentsScheduledExecutionListFilterStatus = AgentsScheduledExecutionStatus;
7099
6270
  * Filter by workflow ID. A workflow version ID is still accepted here and filters by that version (deprecated). Set this or workflowVersionId.
7100
6271
  */
7101
6272
  type AgentsScheduledExecutionListFilterWorkflowId = CommonUuid;
7102
- /**
7103
- * Filter by workflow version ID
7104
- */
7105
6273
  type AgentsScheduledExecutionListFilterWorkflowVersionId = CommonUuid;
7106
6274
  /**
7107
6275
  * Case-insensitive substring match on the secret name or item key
@@ -7242,9 +6410,6 @@ type AgentProfilePoolsListData = {
7242
6410
  body?: never;
7243
6411
  path?: never;
7244
6412
  query?: {
7245
- /**
7246
- * Filter by organization ID
7247
- */
7248
6413
  organizationId?: CommonUuid;
7249
6414
  pageSize?: number;
7250
6415
  page?: number;
@@ -7292,10 +6457,7 @@ type AgentProfilePoolsListResponses = {
7292
6457
  };
7293
6458
  };
7294
6459
  type AgentProfilePoolsListResponse = AgentProfilePoolsListResponses[keyof AgentProfilePoolsListResponses];
7295
- type AgentProfilePoolsCreateData = {
7296
- /**
7297
- * Agent profile pool to create
7298
- */
6460
+ type AgentProfilePoolsCreateData = {
7299
6461
  body: AgentsProfileCreateAgentProfilePoolRequest;
7300
6462
  path?: never;
7301
6463
  query?: never;
@@ -7334,9 +6496,6 @@ type AgentProfilePoolsCreateResponse = AgentProfilePoolsCreateResponses[keyof Ag
7334
6496
  type AgentProfilePoolDeleteData = {
7335
6497
  body?: never;
7336
6498
  path: {
7337
- /**
7338
- * The ID of the agent profile pool
7339
- */
7340
6499
  poolId: CommonUuid;
7341
6500
  };
7342
6501
  query?: never;
@@ -7375,9 +6534,6 @@ type AgentProfilePoolDeleteResponse = AgentProfilePoolDeleteResponses[keyof Agen
7375
6534
  type AgentProfilePoolGetData = {
7376
6535
  body?: never;
7377
6536
  path: {
7378
- /**
7379
- * The ID of the agent profile pool
7380
- */
7381
6537
  poolId: CommonUuid;
7382
6538
  };
7383
6539
  query?: never;
@@ -7414,14 +6570,8 @@ type AgentProfilePoolGetResponses = {
7414
6570
  };
7415
6571
  type AgentProfilePoolGetResponse = AgentProfilePoolGetResponses[keyof AgentProfilePoolGetResponses];
7416
6572
  type AgentProfilePoolUpdateData = {
7417
- /**
7418
- * Fields to update
7419
- */
7420
6573
  body: AgentsProfileUpdateAgentProfilePoolRequest;
7421
6574
  path: {
7422
- /**
7423
- * The ID of the agent profile pool
7424
- */
7425
6575
  poolId: CommonUuid;
7426
6576
  };
7427
6577
  query?: never;
@@ -7458,14 +6608,8 @@ type AgentProfilePoolUpdateResponses = {
7458
6608
  };
7459
6609
  type AgentProfilePoolUpdateResponse = AgentProfilePoolUpdateResponses[keyof AgentProfilePoolUpdateResponses];
7460
6610
  type AgentProfilePoolMembersRemoveData = {
7461
- /**
7462
- * Profile IDs to remove
7463
- */
7464
6611
  body: AgentsProfileRemoveProfilesFromPoolRequest;
7465
6612
  path: {
7466
- /**
7467
- * The ID of the agent profile pool
7468
- */
7469
6613
  poolId: CommonUuid;
7470
6614
  };
7471
6615
  query?: never;
@@ -7504,9 +6648,6 @@ type AgentProfilePoolMembersRemoveResponse = AgentProfilePoolMembersRemoveRespon
7504
6648
  type AgentProfilePoolMembersListData = {
7505
6649
  body?: never;
7506
6650
  path: {
7507
- /**
7508
- * The ID of the agent profile pool
7509
- */
7510
6651
  poolId: CommonUuid;
7511
6652
  };
7512
6653
  query?: {
@@ -7551,14 +6692,8 @@ type AgentProfilePoolMembersListResponses = {
7551
6692
  };
7552
6693
  type AgentProfilePoolMembersListResponse = AgentProfilePoolMembersListResponses[keyof AgentProfilePoolMembersListResponses];
7553
6694
  type AgentProfilePoolMembersAddData = {
7554
- /**
7555
- * Profile IDs to add
7556
- */
7557
6695
  body: AgentsProfileAddProfilesToPoolRequest;
7558
6696
  path: {
7559
- /**
7560
- * The ID of the agent profile pool
7561
- */
7562
6697
  poolId: CommonUuid;
7563
6698
  };
7564
6699
  query?: never;
@@ -7598,9 +6733,6 @@ type AgentProfilesListData = {
7598
6733
  body?: never;
7599
6734
  path?: never;
7600
6735
  query?: {
7601
- /**
7602
- * Filter by organization ID
7603
- */
7604
6736
  organizationId?: CommonUuid;
7605
6737
  pageSize?: number;
7606
6738
  page?: number;
@@ -7661,9 +6793,6 @@ type AgentProfilesListResponses = {
7661
6793
  };
7662
6794
  type AgentProfilesListResponse = AgentProfilesListResponses[keyof AgentProfilesListResponses];
7663
6795
  type AgentProfilesCreateData = {
7664
- /**
7665
- * Agent profile to create
7666
- */
7667
6796
  body: AgentsProfileCreateAgentProfileRequest;
7668
6797
  path?: never;
7669
6798
  query?: never;
@@ -7706,9 +6835,6 @@ type AgentProfilesCreateResponse = AgentProfilesCreateResponses[keyof AgentProfi
7706
6835
  type AgentProfileDeleteData = {
7707
6836
  body?: never;
7708
6837
  path: {
7709
- /**
7710
- * The ID of the agent profile
7711
- */
7712
6838
  profileId: CommonUuid;
7713
6839
  };
7714
6840
  query?: never;
@@ -7747,9 +6873,6 @@ type AgentProfileDeleteResponse = AgentProfileDeleteResponses[keyof AgentProfile
7747
6873
  type AgentProfileGetData = {
7748
6874
  body?: never;
7749
6875
  path: {
7750
- /**
7751
- * The ID of the agent profile
7752
- */
7753
6876
  profileId: CommonUuid;
7754
6877
  };
7755
6878
  query?: never;
@@ -7786,14 +6909,8 @@ type AgentProfileGetResponses = {
7786
6909
  };
7787
6910
  type AgentProfileGetResponse = AgentProfileGetResponses[keyof AgentProfileGetResponses];
7788
6911
  type AgentProfileUpdateData = {
7789
- /**
7790
- * Fields to update
7791
- */
7792
6912
  body: AgentsProfileUpdateAgentProfileRequest;
7793
6913
  path: {
7794
- /**
7795
- * The ID of the agent profile
7796
- */
7797
6914
  profileId: CommonUuid;
7798
6915
  };
7799
6916
  query?: never;
@@ -7836,9 +6953,6 @@ type AgentProfileUpdateResponse = AgentProfileUpdateResponses[keyof AgentProfile
7836
6953
  type AgentProfileClearBrowserCacheData = {
7837
6954
  body?: never;
7838
6955
  path: {
7839
- /**
7840
- * The ID of the agent profile
7841
- */
7842
6956
  profileId: CommonUuid;
7843
6957
  };
7844
6958
  query?: never;
@@ -7882,9 +6996,6 @@ type AgentProfileDuplicateData = {
7882
6996
  */
7883
6997
  body?: AgentsProfileDuplicateAgentProfileRequest;
7884
6998
  path: {
7885
- /**
7886
- * The ID of the agent profile to duplicate
7887
- */
7888
6999
  profileId: CommonUuid;
7889
7000
  };
7890
7001
  query?: never;
@@ -7923,15 +7034,9 @@ type AgentProfileDuplicateResponse = AgentProfileDuplicateResponses[keyof AgentP
7923
7034
  type AgentProfileGetInboxEmailsData = {
7924
7035
  body?: never;
7925
7036
  path: {
7926
- /**
7927
- * The ID of the agent profile
7928
- */
7929
7037
  profileId: CommonUuid;
7930
7038
  };
7931
7039
  query?: {
7932
- /**
7933
- * Maximum number of emails to return
7934
- */
7935
7040
  limit?: number;
7936
7041
  };
7937
7042
  url: "/agents/v2/agent-profiles/{profileId}/inbox-emails";
@@ -7969,9 +7074,6 @@ type AgentProfileGetInboxEmailsResponse = AgentProfileGetInboxEmailsResponses[ke
7969
7074
  type AgentProfileGetInboxEmailData = {
7970
7075
  body?: never;
7971
7076
  path: {
7972
- /**
7973
- * The ID of the agent profile
7974
- */
7975
7077
  profileId: CommonUuid;
7976
7078
  /**
7977
7079
  * The Resend email ID
@@ -8018,6 +7120,9 @@ type AgentListData = {
8018
7120
  organizationId?: CommonUuid;
8019
7121
  pageSize?: number;
8020
7122
  page?: number;
7123
+ /**
7124
+ * Return results whose name contains this text, case-insensitive.
7125
+ */
8021
7126
  searchName?: string;
8022
7127
  sortField?: AgentsAgentSortField;
8023
7128
  sortDirection?: CommonSortDirection;
@@ -8130,9 +7235,6 @@ type AvailableToolsListResponse = AvailableToolsListResponses[keyof AvailableToo
8130
7235
  type AgentByIdDeleteData = {
8131
7236
  body?: never;
8132
7237
  path: {
8133
- /**
8134
- * The ID of the agent
8135
- */
8136
7238
  agentId: CommonUuid;
8137
7239
  };
8138
7240
  query?: never;
@@ -8171,9 +7273,6 @@ type AgentByIdDeleteResponse = AgentByIdDeleteResponses[keyof AgentByIdDeleteRes
8171
7273
  type AgentByIdUpdateData = {
8172
7274
  body: AgentsAgentUpdateRequest;
8173
7275
  path: {
8174
- /**
8175
- * The ID of the agent
8176
- */
8177
7276
  agentId: CommonUuid;
8178
7277
  };
8179
7278
  query?: never;
@@ -8213,14 +7312,8 @@ type AgentByIdUpdateResponses = {
8213
7312
  200: unknown;
8214
7313
  };
8215
7314
  type AgentExecutePostData = {
8216
- /**
8217
- * Execution request parameters
8218
- */
8219
7315
  body: AgentsAgentExecuteAgentRequest;
8220
7316
  path: {
8221
- /**
8222
- * The ID of the agent to execute
8223
- */
8224
7317
  agentId: CommonUuid;
8225
7318
  };
8226
7319
  query?: never;
@@ -8241,14 +7334,8 @@ type AgentExecutePostResponses = {
8241
7334
  };
8242
7335
  type AgentExecutePostResponse = AgentExecutePostResponses[keyof AgentExecutePostResponses];
8243
7336
  type AgentExecuteSyncPostData = {
8244
- /**
8245
- * Execution request parameters
8246
- */
8247
7337
  body: AgentsAgentExecuteAgentSyncRequest;
8248
7338
  path: {
8249
- /**
8250
- * The ID of the agent to execute
8251
- */
8252
7339
  agentId: CommonUuid;
8253
7340
  };
8254
7341
  query?: never;
@@ -8275,9 +7362,6 @@ type AgentExecuteSyncPostResponse = AgentExecuteSyncPostResponses[keyof AgentExe
8275
7362
  type AgentWorkflowHeadGetFilesData = {
8276
7363
  body?: never;
8277
7364
  path: {
8278
- /**
8279
- * The ID of the agent
8280
- */
8281
7365
  agentId: CommonUuid;
8282
7366
  };
8283
7367
  query?: {
@@ -8335,14 +7419,8 @@ type AgentWorkflowHeadGetFilesResponses = {
8335
7419
  };
8336
7420
  type AgentWorkflowHeadGetFilesResponse = AgentWorkflowHeadGetFilesResponses[keyof AgentWorkflowHeadGetFilesResponses];
8337
7421
  type AgentWorkflowHeadPatchFilesData = {
8338
- /**
8339
- * The file writes and deletes to apply
8340
- */
8341
7422
  body: AgentsWorkflowWorkflowFilesPatchRequest;
8342
7423
  path: {
8343
- /**
8344
- * The ID of the agent
8345
- */
8346
7424
  agentId: CommonUuid;
8347
7425
  };
8348
7426
  query?: never;
@@ -8385,9 +7463,6 @@ type AgentWorkflowHeadPatchFilesResponse = AgentWorkflowHeadPatchFilesResponses[
8385
7463
  type AgentWorkflowHeadPublishHeadData = {
8386
7464
  body?: never;
8387
7465
  path: {
8388
- /**
8389
- * The ID of the agent
8390
- */
8391
7466
  agentId: CommonUuid;
8392
7467
  };
8393
7468
  query?: never;
@@ -8426,9 +7501,6 @@ type AgentWorkflowHeadPublishHeadResponse = AgentWorkflowHeadPublishHeadResponse
8426
7501
  type AgentWorkflowsListData = {
8427
7502
  body?: never;
8428
7503
  path: {
8429
- /**
8430
- * The ID of the agent
8431
- */
8432
7504
  agentId: CommonUuid;
8433
7505
  };
8434
7506
  query?: never;
@@ -8465,14 +7537,8 @@ type AgentWorkflowsListResponses = {
8465
7537
  };
8466
7538
  type AgentWorkflowsListResponse = AgentWorkflowsListResponses[keyof AgentWorkflowsListResponses];
8467
7539
  type AgentWorkflowsCreateData = {
8468
- /**
8469
- * Workflow creation request
8470
- */
8471
7540
  body: AgentsWorkflowExternalCreateWorkflowRequest;
8472
7541
  path: {
8473
- /**
8474
- * The ID of the agent
8475
- */
8476
7542
  agentId: CommonUuid;
8477
7543
  };
8478
7544
  query?: never;
@@ -8509,14 +7575,8 @@ type AgentWorkflowsCreateResponses = {
8509
7575
  };
8510
7576
  type AgentWorkflowsCreateResponse = AgentWorkflowsCreateResponses[keyof AgentWorkflowsCreateResponses];
8511
7577
  type AgentWorkflowsValidateData = {
8512
- /**
8513
- * The workflow spec to validate
8514
- */
8515
7578
  body: AgentsWorkflowExternalCreateWorkflowRequest;
8516
7579
  path: {
8517
- /**
8518
- * The ID of the agent
8519
- */
8520
7580
  agentId: CommonUuid;
8521
7581
  };
8522
7582
  query?: never;
@@ -8555,13 +7615,7 @@ type AgentWorkflowsValidateResponse = AgentWorkflowsValidateResponses[keyof Agen
8555
7615
  type AgentWorkflowsDeleteWorkflowData = {
8556
7616
  body?: never;
8557
7617
  path: {
8558
- /**
8559
- * The ID of the agent
8560
- */
8561
7618
  agentId: CommonUuid;
8562
- /**
8563
- * The ID of the workflow to delete
8564
- */
8565
7619
  workflowId: CommonUuid;
8566
7620
  };
8567
7621
  query?: never;
@@ -8600,13 +7654,7 @@ type AgentWorkflowsDeleteWorkflowResponse = AgentWorkflowsDeleteWorkflowResponse
8600
7654
  type AgentWorkflowsGetData = {
8601
7655
  body?: never;
8602
7656
  path: {
8603
- /**
8604
- * The ID of the agent
8605
- */
8606
7657
  agentId: CommonUuid;
8607
- /**
8608
- * The ID of the workflow
8609
- */
8610
7658
  workflowId: CommonUuid;
8611
7659
  };
8612
7660
  query?: never;
@@ -8643,18 +7691,9 @@ type AgentWorkflowsGetResponses = {
8643
7691
  };
8644
7692
  type AgentWorkflowsGetResponse = AgentWorkflowsGetResponses[keyof AgentWorkflowsGetResponses];
8645
7693
  type AgentWorkflowsExecuteData = {
8646
- /**
8647
- * Execution request parameters
8648
- */
8649
7694
  body: AgentsWorkflowExecuteWorkflowRequest;
8650
7695
  path: {
8651
- /**
8652
- * The ID of the agent
8653
- */
8654
7696
  agentId: CommonUuid;
8655
- /**
8656
- * The ID of the workflow to execute
8657
- */
8658
7697
  workflowId: CommonUuid;
8659
7698
  };
8660
7699
  query?: never;
@@ -8697,13 +7736,7 @@ type AgentWorkflowsExecuteResponse = AgentWorkflowsExecuteResponses[keyof AgentW
8697
7736
  type AgentWorkflowsGetFilesByVersionData = {
8698
7737
  body?: never;
8699
7738
  path: {
8700
- /**
8701
- * The ID of the agent
8702
- */
8703
7739
  agentId: CommonUuid;
8704
- /**
8705
- * The ID of the workflow
8706
- */
8707
7740
  workflowId: CommonUuid;
8708
7741
  };
8709
7742
  query?: {
@@ -8763,13 +7796,7 @@ type AgentWorkflowsGetFilesByVersionResponse = AgentWorkflowsGetFilesByVersionRe
8763
7796
  type AgentWorkflowsGetInputsData = {
8764
7797
  body?: never;
8765
7798
  path: {
8766
- /**
8767
- * The ID of the agent
8768
- */
8769
7799
  agentId: CommonUuid;
8770
- /**
8771
- * The ID of the workflow
8772
- */
8773
7800
  workflowId: CommonUuid;
8774
7801
  };
8775
7802
  query?: never;
@@ -8808,13 +7835,7 @@ type AgentWorkflowsGetInputsResponse = AgentWorkflowsGetInputsResponses[keyof Ag
8808
7835
  type AgentWorkflowsGetOutputSchemasData = {
8809
7836
  body?: never;
8810
7837
  path: {
8811
- /**
8812
- * The ID of the agent
8813
- */
8814
7838
  agentId: CommonUuid;
8815
- /**
8816
- * The ID of the workflow
8817
- */
8818
7839
  workflowId: CommonUuid;
8819
7840
  };
8820
7841
  query?: never;
@@ -8853,13 +7874,7 @@ type AgentWorkflowsGetOutputSchemasResponse = AgentWorkflowsGetOutputSchemasResp
8853
7874
  type AgentWorkflowsPublishData = {
8854
7875
  body?: never;
8855
7876
  path: {
8856
- /**
8857
- * The ID of the agent
8858
- */
8859
7877
  agentId: CommonUuid;
8860
- /**
8861
- * The ID of the workflow to publish
8862
- */
8863
7878
  workflowId: CommonUuid;
8864
7879
  };
8865
7880
  query?: never;
@@ -8932,9 +7947,6 @@ type ContextGetResponses = {
8932
7947
  };
8933
7948
  type ContextGetResponse = ContextGetResponses[keyof ContextGetResponses];
8934
7949
  type DocsSearchSearchData = {
8935
- /**
8936
- * The search request
8937
- */
8938
7950
  body: AgentsDocsSearchDocsRequest;
8939
7951
  path?: never;
8940
7952
  query?: never;
@@ -9000,13 +8012,7 @@ type ExecutionsListData = {
9000
8012
  * Filter by execution status (can specify multiple, there is an 'OR' condition applied to these)
9001
8013
  */
9002
8014
  status?: Array<AgentsExecutionStatus>;
9003
- /**
9004
- * Filter executions created after this timestamp
9005
- */
9006
8015
  createdAfter?: string;
9007
- /**
9008
- * Filter executions created before this timestamp
9009
- */
9010
8016
  createdBefore?: string;
9011
8017
  /**
9012
8018
  * Filter by human labels (can specify multiple label IDs, there is an 'OR' condition applied to these)
@@ -9032,13 +8038,7 @@ type ExecutionsListData = {
9032
8038
  * Filter by input variable value (partial, case-insensitive match) - must be used together with inputsKey
9033
8039
  */
9034
8040
  inputsValue?: string;
9035
- /**
9036
- * Filter by workflow version number
9037
- */
9038
8041
  workflowVersion?: number;
9039
- /**
9040
- * Filter by whether the execution recorded any script failures
9041
- */
9042
8042
  hasScriptFailures?: boolean;
9043
8043
  /**
9044
8044
  * Filter by how the execution was triggered (can specify multiple, there is an 'OR' condition applied to these)
@@ -9050,9 +8050,6 @@ type ExecutionsListData = {
9050
8050
  phase?: Array<AgentsExecutionPhase>;
9051
8051
  sortField?: AgentsExecutionSortField;
9052
8052
  sortDirection?: CommonSortDirection;
9053
- /**
9054
- * Filter by workflow ID
9055
- */
9056
8053
  workflowId?: CommonUuid;
9057
8054
  /**
9058
8055
  * Filter executions created within this long before now: number-unit pairs with units w, d, h, m, longest first, e.g. 30m, 24h, 7d, 1d12h. Maximum 10 years. Cannot be combined with createdAfter
@@ -9111,9 +8108,6 @@ type ExecutionsListResponse = ExecutionsListResponses[keyof ExecutionsListRespon
9111
8108
  type ExecutionGetData = {
9112
8109
  body?: never;
9113
8110
  path: {
9114
- /**
9115
- * The unique identifier of the execution
9116
- */
9117
8111
  executionId: CommonUuid;
9118
8112
  };
9119
8113
  query?: never;
@@ -9152,9 +8146,6 @@ type ExecutionGetResponse = ExecutionGetResponses[keyof ExecutionGetResponses];
9152
8146
  type ExecutionActivitiesGetData = {
9153
8147
  body?: never;
9154
8148
  path: {
9155
- /**
9156
- * The unique identifier of the execution
9157
- */
9158
8149
  executionId: CommonUuid;
9159
8150
  };
9160
8151
  query?: {
@@ -9162,9 +8153,6 @@ type ExecutionActivitiesGetData = {
9162
8153
  * Sort order for activities by timestamp
9163
8154
  */
9164
8155
  order?: "asc" | "desc";
9165
- /**
9166
- * Maximum number of activities to return
9167
- */
9168
8156
  limit?: number;
9169
8157
  };
9170
8158
  url: "/agents/v2/executions/{executionId}/activities";
@@ -9240,9 +8228,6 @@ type ExecutionAgentFileDownloadRedirectError = ExecutionAgentFileDownloadRedirec
9240
8228
  type ExecutionCancelData = {
9241
8229
  body?: never;
9242
8230
  path: {
9243
- /**
9244
- * The unique identifier of the execution
9245
- */
9246
8231
  executionId: CommonUuid;
9247
8232
  };
9248
8233
  query?: never;
@@ -9401,9 +8386,6 @@ type ExecutionFileDownloadRedirectError = ExecutionFileDownloadRedirectErrors[ke
9401
8386
  type ExecutionPauseData = {
9402
8387
  body?: never;
9403
8388
  path: {
9404
- /**
9405
- * The unique identifier of the execution
9406
- */
9407
8389
  executionId: CommonUuid;
9408
8390
  };
9409
8391
  query?: never;
@@ -9442,9 +8424,6 @@ type ExecutionPauseResponse = ExecutionPauseResponses[keyof ExecutionPauseRespon
9442
8424
  type ExecutionRecordingRedirectData = {
9443
8425
  body?: never;
9444
8426
  path: {
9445
- /**
9446
- * The unique identifier of the execution
9447
- */
9448
8427
  executionId: CommonUuid;
9449
8428
  };
9450
8429
  query?: {
@@ -9484,9 +8463,6 @@ type ExecutionRerunData = {
9484
8463
  */
9485
8464
  body?: AgentsExecutionRerunExecutionRequest;
9486
8465
  path: {
9487
- /**
9488
- * The unique identifier of the execution to rerun
9489
- */
9490
8466
  executionId: CommonUuid;
9491
8467
  };
9492
8468
  query?: never;
@@ -9529,9 +8505,6 @@ type ExecutionRerunResponse = ExecutionRerunResponses[keyof ExecutionRerunRespon
9529
8505
  type ExecutionResumeData = {
9530
8506
  body?: never;
9531
8507
  path: {
9532
- /**
9533
- * The unique identifier of the execution
9534
- */
9535
8508
  executionId: CommonUuid;
9536
8509
  };
9537
8510
  query?: never;
@@ -9568,14 +8541,8 @@ type ExecutionResumeResponses = {
9568
8541
  };
9569
8542
  type ExecutionResumeResponse = ExecutionResumeResponses[keyof ExecutionResumeResponses];
9570
8543
  type ExecutionStatusUpdateData = {
9571
- /**
9572
- * The status update request
9573
- */
9574
8544
  body: AgentsExecutionUpdateExecutionStatusRequest;
9575
8545
  path: {
9576
- /**
9577
- * The unique identifier of the execution
9578
- */
9579
8546
  executionId: CommonUuid;
9580
8547
  };
9581
8548
  query?: never;
@@ -9612,14 +8579,8 @@ type ExecutionStatusUpdateResponses = {
9612
8579
  };
9613
8580
  type ExecutionStatusUpdateResponse = ExecutionStatusUpdateResponses[keyof ExecutionStatusUpdateResponses];
9614
8581
  type ExecutionUserMessagesAddData = {
9615
- /**
9616
- * The message content to send
9617
- */
9618
8582
  body: AgentsExecutionUserMessagesAddTextBody;
9619
8583
  path: {
9620
- /**
9621
- * The unique identifier of the execution
9622
- */
9623
8584
  executionId: CommonUuid;
9624
8585
  };
9625
8586
  query?: never;
@@ -9659,9 +8620,6 @@ type ProfileGroupsListData = {
9659
8620
  body?: never;
9660
8621
  path?: never;
9661
8622
  query?: {
9662
- /**
9663
- * Filter by organization ID
9664
- */
9665
8623
  organizationId?: CommonUuid;
9666
8624
  pageSize?: number;
9667
8625
  page?: number;
@@ -9710,9 +8668,6 @@ type ProfileGroupsListResponses = {
9710
8668
  };
9711
8669
  type ProfileGroupsListResponse = ProfileGroupsListResponses[keyof ProfileGroupsListResponses];
9712
8670
  type ProfileGroupsCreateData = {
9713
- /**
9714
- * Profile group to create
9715
- */
9716
8671
  body: AgentsProfileCreateAgentProfilePoolRequest;
9717
8672
  path?: never;
9718
8673
  query?: never;
@@ -9751,9 +8706,6 @@ type ProfileGroupsCreateResponse = ProfileGroupsCreateResponses[keyof ProfileGro
9751
8706
  type ProfileGroupDeleteData = {
9752
8707
  body?: never;
9753
8708
  path: {
9754
- /**
9755
- * The ID of the profile group
9756
- */
9757
8709
  groupId: CommonUuid;
9758
8710
  };
9759
8711
  query?: never;
@@ -9792,9 +8744,6 @@ type ProfileGroupDeleteResponse = ProfileGroupDeleteResponses[keyof ProfileGroup
9792
8744
  type ProfileGroupGetData = {
9793
8745
  body?: never;
9794
8746
  path: {
9795
- /**
9796
- * The ID of the profile group
9797
- */
9798
8747
  groupId: CommonUuid;
9799
8748
  };
9800
8749
  query?: never;
@@ -9831,14 +8780,8 @@ type ProfileGroupGetResponses = {
9831
8780
  };
9832
8781
  type ProfileGroupGetResponse = ProfileGroupGetResponses[keyof ProfileGroupGetResponses];
9833
8782
  type ProfileGroupUpdateData = {
9834
- /**
9835
- * Fields to update
9836
- */
9837
8783
  body: AgentsProfileUpdateAgentProfilePoolRequest;
9838
8784
  path: {
9839
- /**
9840
- * The ID of the profile group
9841
- */
9842
8785
  groupId: CommonUuid;
9843
8786
  };
9844
8787
  query?: never;
@@ -9875,14 +8818,8 @@ type ProfileGroupUpdateResponses = {
9875
8818
  };
9876
8819
  type ProfileGroupUpdateResponse = ProfileGroupUpdateResponses[keyof ProfileGroupUpdateResponses];
9877
8820
  type ProfileGroupMembersRemoveData = {
9878
- /**
9879
- * Profile IDs to remove
9880
- */
9881
8821
  body: AgentsProfileRemoveProfilesFromPoolRequest;
9882
8822
  path: {
9883
- /**
9884
- * The ID of the profile group
9885
- */
9886
8823
  groupId: CommonUuid;
9887
8824
  };
9888
8825
  query?: never;
@@ -9921,9 +8858,6 @@ type ProfileGroupMembersRemoveResponse = ProfileGroupMembersRemoveResponses[keyo
9921
8858
  type ProfileGroupMembersListData = {
9922
8859
  body?: never;
9923
8860
  path: {
9924
- /**
9925
- * The ID of the profile group
9926
- */
9927
8861
  groupId: CommonUuid;
9928
8862
  };
9929
8863
  query?: {
@@ -9968,14 +8902,8 @@ type ProfileGroupMembersListResponses = {
9968
8902
  };
9969
8903
  type ProfileGroupMembersListResponse = ProfileGroupMembersListResponses[keyof ProfileGroupMembersListResponses];
9970
8904
  type ProfileGroupMembersAddData = {
9971
- /**
9972
- * Profile IDs to add
9973
- */
9974
8905
  body: AgentsProfileAddProfilesToPoolRequest;
9975
8906
  path: {
9976
- /**
9977
- * The ID of the profile group
9978
- */
9979
8907
  groupId: CommonUuid;
9980
8908
  };
9981
8909
  query?: never;
@@ -10015,9 +8943,6 @@ type ProfilesListData = {
10015
8943
  body?: never;
10016
8944
  path?: never;
10017
8945
  query?: {
10018
- /**
10019
- * Filter by organization ID
10020
- */
10021
8946
  organizationId?: CommonUuid;
10022
8947
  pageSize?: number;
10023
8948
  page?: number;
@@ -10078,9 +9003,6 @@ type ProfilesListResponses = {
10078
9003
  };
10079
9004
  type ProfilesListResponse = ProfilesListResponses[keyof ProfilesListResponses];
10080
9005
  type ProfilesCreateData = {
10081
- /**
10082
- * Profile to create
10083
- */
10084
9006
  body: AgentsProfileCreateAgentProfileRequest;
10085
9007
  path?: never;
10086
9008
  query?: never;
@@ -10123,9 +9045,6 @@ type ProfilesCreateResponse = ProfilesCreateResponses[keyof ProfilesCreateRespon
10123
9045
  type ProfileDeleteData = {
10124
9046
  body?: never;
10125
9047
  path: {
10126
- /**
10127
- * The ID of the profile
10128
- */
10129
9048
  profileId: CommonUuid;
10130
9049
  };
10131
9050
  query?: never;
@@ -10164,9 +9083,6 @@ type ProfileDeleteResponse = ProfileDeleteResponses[keyof ProfileDeleteResponses
10164
9083
  type ProfileGetData = {
10165
9084
  body?: never;
10166
9085
  path: {
10167
- /**
10168
- * The ID of the profile
10169
- */
10170
9086
  profileId: CommonUuid;
10171
9087
  };
10172
9088
  query?: never;
@@ -10203,14 +9119,8 @@ type ProfileGetResponses = {
10203
9119
  };
10204
9120
  type ProfileGetResponse = ProfileGetResponses[keyof ProfileGetResponses];
10205
9121
  type ProfileUpdateData = {
10206
- /**
10207
- * Fields to update
10208
- */
10209
9122
  body: AgentsProfileUpdateAgentProfileRequest;
10210
9123
  path: {
10211
- /**
10212
- * The ID of the profile
10213
- */
10214
9124
  profileId: CommonUuid;
10215
9125
  };
10216
9126
  query?: never;
@@ -10253,9 +9163,6 @@ type ProfileUpdateResponse = ProfileUpdateResponses[keyof ProfileUpdateResponses
10253
9163
  type ProfileClearBrowserCacheData = {
10254
9164
  body?: never;
10255
9165
  path: {
10256
- /**
10257
- * The ID of the profile
10258
- */
10259
9166
  profileId: CommonUuid;
10260
9167
  };
10261
9168
  query?: never;
@@ -10299,9 +9206,6 @@ type ProfileDuplicateData = {
10299
9206
  */
10300
9207
  body?: AgentsProfileDuplicateAgentProfileRequest;
10301
9208
  path: {
10302
- /**
10303
- * The ID of the profile to duplicate
10304
- */
10305
9209
  profileId: CommonUuid;
10306
9210
  };
10307
9211
  query?: never;
@@ -10340,15 +9244,9 @@ type ProfileDuplicateResponse = ProfileDuplicateResponses[keyof ProfileDuplicate
10340
9244
  type ProfileGetInboxEmailsData = {
10341
9245
  body?: never;
10342
9246
  path: {
10343
- /**
10344
- * The ID of the profile
10345
- */
10346
9247
  profileId: CommonUuid;
10347
9248
  };
10348
9249
  query?: {
10349
- /**
10350
- * Maximum number of emails to return
10351
- */
10352
9250
  limit?: number;
10353
9251
  };
10354
9252
  url: "/agents/v2/profiles/{profileId}/inbox-emails";
@@ -10386,9 +9284,6 @@ type ProfileGetInboxEmailsResponse = ProfileGetInboxEmailsResponses[keyof Profil
10386
9284
  type ProfileGetInboxEmailData = {
10387
9285
  body?: never;
10388
9286
  path: {
10389
- /**
10390
- * The ID of the profile
10391
- */
10392
9287
  profileId: CommonUuid;
10393
9288
  /**
10394
9289
  * The Resend email ID
@@ -10429,9 +9324,6 @@ type ProfileGetInboxEmailResponses = {
10429
9324
  };
10430
9325
  type ProfileGetInboxEmailResponse = ProfileGetInboxEmailResponses[keyof ProfileGetInboxEmailResponses];
10431
9326
  type SchemaValidationValidateData = {
10432
- /**
10433
- * The schema to validate
10434
- */
10435
9327
  body: AgentsSchemaValidateSchemaRequest;
10436
9328
  path?: never;
10437
9329
  query?: never;
@@ -10893,6 +9785,9 @@ type SecretsListResponse = SecretsListResponses[keyof SecretsListResponses];
10893
9785
  type SecretsCreateData = {
10894
9786
  body: AgentsVaultCreateVaultItemRequest;
10895
9787
  headers?: {
9788
+ /**
9789
+ * A key unique within the organization. Reusing it returns the secret already created with that key instead of creating a second one.
9790
+ */
10896
9791
  "Idempotency-Key"?: string;
10897
9792
  };
10898
9793
  path?: never;
@@ -11101,6 +9996,9 @@ type SecretFieldDeleteData = {
11101
9996
  body?: never;
11102
9997
  path: {
11103
9998
  secretId: CommonUuid;
9999
+ /**
10000
+ * The field's key, in UPPER_SNAKE case.
10001
+ */
11104
10002
  fieldKey: AgentsVaultFieldKey;
11105
10003
  };
11106
10004
  query?: never;
@@ -12018,9 +10916,15 @@ type WorkflowListData = {
12018
10916
  body?: never;
12019
10917
  path?: never;
12020
10918
  query?: {
10919
+ /**
10920
+ * The organization. Defaults to the one organization the caller acts in, such as an API key's. Required when the caller belongs to several.
10921
+ */
12021
10922
  organizationId?: CommonUuid;
12022
10923
  pageSize?: number;
12023
10924
  page?: number;
10925
+ /**
10926
+ * Return results whose name contains this text, case-insensitive.
10927
+ */
12024
10928
  searchName?: string;
12025
10929
  sortField?: AgentsAgentSortField;
12026
10930
  sortDirection?: CommonSortDirection;
@@ -12143,9 +11047,6 @@ type WorkflowAvailableToolsListResponses = {
12143
11047
  };
12144
11048
  type WorkflowAvailableToolsListResponse = WorkflowAvailableToolsListResponses[keyof WorkflowAvailableToolsListResponses];
12145
11049
  type WorkflowSpecValidationValidateData = {
12146
- /**
12147
- * The workflow spec to validate
12148
- */
12149
11050
  body: AgentsWorkflowExternalCreateWorkflowRequest;
12150
11051
  path?: never;
12151
11052
  query?: never;
@@ -12184,9 +11085,6 @@ type WorkflowSpecValidationValidateResponse = WorkflowSpecValidationValidateResp
12184
11085
  type WorkflowByIdDeleteData = {
12185
11086
  body?: never;
12186
11087
  path: {
12187
- /**
12188
- * The ID of the workflow
12189
- */
12190
11088
  workflowId: CommonUuid;
12191
11089
  };
12192
11090
  query?: never;
@@ -12225,9 +11123,6 @@ type WorkflowByIdDeleteResponse = WorkflowByIdDeleteResponses[keyof WorkflowById
12225
11123
  type WorkflowByIdUpdateData = {
12226
11124
  body: WorkflowsWorkflowUpdateRequest;
12227
11125
  path: {
12228
- /**
12229
- * The ID of the workflow
12230
- */
12231
11126
  workflowId: CommonUuid;
12232
11127
  };
12233
11128
  query?: never;
@@ -12267,14 +11162,8 @@ type WorkflowByIdUpdateResponses = {
12267
11162
  200: unknown;
12268
11163
  };
12269
11164
  type WorkflowExecutePostData = {
12270
- /**
12271
- * Execution request parameters
12272
- */
12273
11165
  body: WorkflowsWorkflowExecuteRequest;
12274
11166
  path: {
12275
- /**
12276
- * The ID of the workflow to execute
12277
- */
12278
11167
  workflowId: CommonUuid;
12279
11168
  };
12280
11169
  query?: never;
@@ -12295,14 +11184,8 @@ type WorkflowExecutePostResponses = {
12295
11184
  };
12296
11185
  type WorkflowExecutePostResponse = WorkflowExecutePostResponses[keyof WorkflowExecutePostResponses];
12297
11186
  type WorkflowExecuteSyncPostData = {
12298
- /**
12299
- * Execution request parameters
12300
- */
12301
11187
  body: WorkflowsWorkflowExecuteSyncRequest;
12302
11188
  path: {
12303
- /**
12304
- * The ID of the workflow to execute
12305
- */
12306
11189
  workflowId: CommonUuid;
12307
11190
  };
12308
11191
  query?: never;
@@ -12329,9 +11212,6 @@ type WorkflowExecuteSyncPostResponse = WorkflowExecuteSyncPostResponses[keyof Wo
12329
11212
  type WorkflowHeadGetFilesData = {
12330
11213
  body?: never;
12331
11214
  path: {
12332
- /**
12333
- * The ID of the workflow
12334
- */
12335
11215
  workflowId: CommonUuid;
12336
11216
  };
12337
11217
  query?: {
@@ -12389,14 +11269,8 @@ type WorkflowHeadGetFilesResponses = {
12389
11269
  };
12390
11270
  type WorkflowHeadGetFilesResponse = WorkflowHeadGetFilesResponses[keyof WorkflowHeadGetFilesResponses];
12391
11271
  type WorkflowHeadPatchFilesData = {
12392
- /**
12393
- * The file writes and deletes to apply
12394
- */
12395
11272
  body: WorkflowsVersionFilesPatchRequest;
12396
11273
  path: {
12397
- /**
12398
- * The ID of the workflow
12399
- */
12400
11274
  workflowId: CommonUuid;
12401
11275
  };
12402
11276
  query?: never;
@@ -12439,9 +11313,6 @@ type WorkflowHeadPatchFilesResponse = WorkflowHeadPatchFilesResponses[keyof Work
12439
11313
  type WorkflowHeadPublishData = {
12440
11314
  body?: never;
12441
11315
  path: {
12442
- /**
12443
- * The ID of the workflow
12444
- */
12445
11316
  workflowId: CommonUuid;
12446
11317
  };
12447
11318
  query?: never;
@@ -12480,9 +11351,6 @@ type WorkflowHeadPublishResponse = WorkflowHeadPublishResponses[keyof WorkflowHe
12480
11351
  type WorkflowVersionsListData = {
12481
11352
  body?: never;
12482
11353
  path: {
12483
- /**
12484
- * The ID of the workflow
12485
- */
12486
11354
  workflowId: CommonUuid;
12487
11355
  };
12488
11356
  query?: never;
@@ -12519,14 +11387,8 @@ type WorkflowVersionsListResponses = {
12519
11387
  };
12520
11388
  type WorkflowVersionsListResponse = WorkflowVersionsListResponses[keyof WorkflowVersionsListResponses];
12521
11389
  type WorkflowVersionsCreateData = {
12522
- /**
12523
- * Version creation request
12524
- */
12525
11390
  body: WorkflowsVersionCreateRequest;
12526
11391
  path: {
12527
- /**
12528
- * The ID of the workflow
12529
- */
12530
11392
  workflowId: CommonUuid;
12531
11393
  };
12532
11394
  query?: never;
@@ -12563,14 +11425,8 @@ type WorkflowVersionsCreateResponses = {
12563
11425
  };
12564
11426
  type WorkflowVersionsCreateResponse = WorkflowVersionsCreateResponses[keyof WorkflowVersionsCreateResponses];
12565
11427
  type WorkflowVersionsValidateData = {
12566
- /**
12567
- * The version spec to validate
12568
- */
12569
11428
  body: WorkflowsVersionCreateRequest;
12570
11429
  path: {
12571
- /**
12572
- * The ID of the workflow
12573
- */
12574
11430
  workflowId: CommonUuid;
12575
11431
  };
12576
11432
  query?: never;
@@ -12609,13 +11465,7 @@ type WorkflowVersionsValidateResponse = WorkflowVersionsValidateResponses[keyof
12609
11465
  type WorkflowVersionsDeleteData = {
12610
11466
  body?: never;
12611
11467
  path: {
12612
- /**
12613
- * The ID of the workflow
12614
- */
12615
11468
  workflowId: CommonUuid;
12616
- /**
12617
- * The ID of the version to delete
12618
- */
12619
11469
  versionId: CommonUuid;
12620
11470
  };
12621
11471
  query?: never;
@@ -12654,13 +11504,7 @@ type WorkflowVersionsDeleteResponse = WorkflowVersionsDeleteResponses[keyof Work
12654
11504
  type WorkflowVersionsGetData = {
12655
11505
  body?: never;
12656
11506
  path: {
12657
- /**
12658
- * The ID of the workflow
12659
- */
12660
11507
  workflowId: CommonUuid;
12661
- /**
12662
- * The ID of the version
12663
- */
12664
11508
  versionId: CommonUuid;
12665
11509
  };
12666
11510
  query?: never;
@@ -12697,18 +11541,9 @@ type WorkflowVersionsGetResponses = {
12697
11541
  };
12698
11542
  type WorkflowVersionsGetResponse = WorkflowVersionsGetResponses[keyof WorkflowVersionsGetResponses];
12699
11543
  type WorkflowVersionsExecuteData = {
12700
- /**
12701
- * Execution request parameters
12702
- */
12703
11544
  body: WorkflowsVersionExecuteRequest;
12704
11545
  path: {
12705
- /**
12706
- * The ID of the workflow
12707
- */
12708
11546
  workflowId: CommonUuid;
12709
- /**
12710
- * The ID of the version to execute
12711
- */
12712
11547
  versionId: CommonUuid;
12713
11548
  };
12714
11549
  query?: never;
@@ -12751,13 +11586,7 @@ type WorkflowVersionsExecuteResponse = WorkflowVersionsExecuteResponses[keyof Wo
12751
11586
  type WorkflowVersionsGetFilesData = {
12752
11587
  body?: never;
12753
11588
  path: {
12754
- /**
12755
- * The ID of the workflow
12756
- */
12757
11589
  workflowId: CommonUuid;
12758
- /**
12759
- * The ID of the version
12760
- */
12761
11590
  versionId: CommonUuid;
12762
11591
  };
12763
11592
  query?: {
@@ -12817,13 +11646,7 @@ type WorkflowVersionsGetFilesResponse = WorkflowVersionsGetFilesResponses[keyof
12817
11646
  type WorkflowVersionsGetInputsData = {
12818
11647
  body?: never;
12819
11648
  path: {
12820
- /**
12821
- * The ID of the workflow
12822
- */
12823
11649
  workflowId: CommonUuid;
12824
- /**
12825
- * The ID of the version
12826
- */
12827
11650
  versionId: CommonUuid;
12828
11651
  };
12829
11652
  query?: never;
@@ -12862,13 +11685,7 @@ type WorkflowVersionsGetInputsResponse = WorkflowVersionsGetInputsResponses[keyo
12862
11685
  type WorkflowVersionsGetOutputSchemasData = {
12863
11686
  body?: never;
12864
11687
  path: {
12865
- /**
12866
- * The ID of the workflow
12867
- */
12868
11688
  workflowId: CommonUuid;
12869
- /**
12870
- * The ID of the version
12871
- */
12872
11689
  versionId: CommonUuid;
12873
11690
  };
12874
11691
  query?: never;
@@ -12907,13 +11724,7 @@ type WorkflowVersionsGetOutputSchemasResponse = WorkflowVersionsGetOutputSchemas
12907
11724
  type WorkflowVersionsPublishData = {
12908
11725
  body?: never;
12909
11726
  path: {
12910
- /**
12911
- * The ID of the workflow
12912
- */
12913
11727
  workflowId: CommonUuid;
12914
- /**
12915
- * The ID of the version to publish
12916
- */
12917
11728
  versionId: CommonUuid;
12918
11729
  };
12919
11730
  query?: never;