@scenario-labs/sdk 3.1.0 → 3.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (529) hide show
  1. package/CHANGELOG.md +119 -0
  2. package/client.d.mts +22 -7
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +22 -7
  5. package/client.d.ts.map +1 -1
  6. package/client.js +9 -0
  7. package/client.js.map +1 -1
  8. package/client.mjs +9 -0
  9. package/client.mjs.map +1 -1
  10. package/core/pagination.d.mts +42 -0
  11. package/core/pagination.d.mts.map +1 -1
  12. package/core/pagination.d.ts +42 -0
  13. package/core/pagination.d.ts.map +1 -1
  14. package/core/pagination.js +79 -1
  15. package/core/pagination.js.map +1 -1
  16. package/core/pagination.mjs +75 -0
  17. package/core/pagination.mjs.map +1 -1
  18. package/internal/utils/values.d.mts +6 -0
  19. package/internal/utils/values.d.mts.map +1 -1
  20. package/internal/utils/values.d.ts +6 -0
  21. package/internal/utils/values.d.ts.map +1 -1
  22. package/internal/utils/values.js +11 -0
  23. package/internal/utils/values.js.map +1 -1
  24. package/internal/utils/values.mjs +10 -0
  25. package/internal/utils/values.mjs.map +1 -1
  26. package/lib/generate.js +7 -7
  27. package/lib/generate.js.map +1 -1
  28. package/lib/generate.mjs +7 -7
  29. package/lib/generate.mjs.map +1 -1
  30. package/lib/job.d.mts +1 -1
  31. package/lib/job.d.mts.map +1 -1
  32. package/lib/job.d.ts +1 -1
  33. package/lib/job.d.ts.map +1 -1
  34. package/lib/job.js +5 -6
  35. package/lib/job.js.map +1 -1
  36. package/lib/job.mjs +6 -7
  37. package/lib/job.mjs.map +1 -1
  38. package/lib/models.d.mts.map +1 -1
  39. package/lib/models.d.ts.map +1 -1
  40. package/lib/models.js +7 -5
  41. package/lib/models.js.map +1 -1
  42. package/lib/models.mjs +8 -6
  43. package/lib/models.mjs.map +1 -1
  44. package/lib/query.d.mts +21 -0
  45. package/lib/query.d.mts.map +1 -0
  46. package/lib/query.d.ts +21 -0
  47. package/lib/query.d.ts.map +1 -0
  48. package/lib/query.js +36 -0
  49. package/lib/query.js.map +1 -0
  50. package/lib/query.mjs +33 -0
  51. package/lib/query.mjs.map +1 -0
  52. package/lib/scenario.d.mts +3 -0
  53. package/lib/scenario.d.mts.map +1 -1
  54. package/lib/scenario.d.ts +3 -0
  55. package/lib/scenario.d.ts.map +1 -1
  56. package/lib/scenario.js +6 -0
  57. package/lib/scenario.js.map +1 -1
  58. package/lib/scenario.mjs +6 -0
  59. package/lib/scenario.mjs.map +1 -1
  60. package/lib/scope.d.mts +27 -7
  61. package/lib/scope.d.mts.map +1 -1
  62. package/lib/scope.d.ts +27 -7
  63. package/lib/scope.d.ts.map +1 -1
  64. package/lib/scope.js +40 -7
  65. package/lib/scope.js.map +1 -1
  66. package/lib/scope.mjs +37 -7
  67. package/lib/scope.mjs.map +1 -1
  68. package/lib/upload.d.mts +1 -1
  69. package/lib/upload.d.mts.map +1 -1
  70. package/lib/upload.d.ts +1 -1
  71. package/lib/upload.d.ts.map +1 -1
  72. package/lib/upload.js +6 -7
  73. package/lib/upload.js.map +1 -1
  74. package/lib/upload.mjs +7 -8
  75. package/lib/upload.mjs.map +1 -1
  76. package/lib/workflow.d.mts.map +1 -1
  77. package/lib/workflow.d.ts.map +1 -1
  78. package/lib/workflow.js +8 -6
  79. package/lib/workflow.js.map +1 -1
  80. package/lib/workflow.mjs +9 -7
  81. package/lib/workflow.mjs.map +1 -1
  82. package/lib/workflow_converter.d.mts +6 -0
  83. package/lib/workflow_converter.d.mts.map +1 -1
  84. package/lib/workflow_converter.d.ts +6 -0
  85. package/lib/workflow_converter.d.ts.map +1 -1
  86. package/lib/workflow_converter.js +99 -12
  87. package/lib/workflow_converter.js.map +1 -1
  88. package/lib/workflow_converter.mjs +99 -12
  89. package/lib/workflow_converter.mjs.map +1 -1
  90. package/lib/workflow_validator.d.mts +8 -1
  91. package/lib/workflow_validator.d.mts.map +1 -1
  92. package/lib/workflow_validator.d.ts +8 -1
  93. package/lib/workflow_validator.d.ts.map +1 -1
  94. package/lib/workflow_validator.js +154 -1
  95. package/lib/workflow_validator.js.map +1 -1
  96. package/lib/workflow_validator.mjs +154 -1
  97. package/lib/workflow_validator.mjs.map +1 -1
  98. package/package.json +1 -1
  99. package/resources/assets/assets.d.mts +304 -122
  100. package/resources/assets/assets.d.mts.map +1 -1
  101. package/resources/assets/assets.d.ts +304 -122
  102. package/resources/assets/assets.d.ts.map +1 -1
  103. package/resources/assets/assets.js +34 -11
  104. package/resources/assets/assets.js.map +1 -1
  105. package/resources/assets/assets.mjs +34 -11
  106. package/resources/assets/assets.mjs.map +1 -1
  107. package/resources/assets/download.d.mts +39 -5
  108. package/resources/assets/download.d.mts.map +1 -1
  109. package/resources/assets/download.d.ts +39 -5
  110. package/resources/assets/download.d.ts.map +1 -1
  111. package/resources/assets/download.js +16 -4
  112. package/resources/assets/download.js.map +1 -1
  113. package/resources/assets/download.mjs +16 -4
  114. package/resources/assets/download.mjs.map +1 -1
  115. package/resources/collections/assets.d.mts.map +1 -1
  116. package/resources/collections/assets.d.ts.map +1 -1
  117. package/resources/collections/assets.js +3 -2
  118. package/resources/collections/assets.js.map +1 -1
  119. package/resources/collections/assets.mjs +3 -2
  120. package/resources/collections/assets.mjs.map +1 -1
  121. package/resources/collections/collections.d.mts.map +1 -1
  122. package/resources/collections/collections.d.ts.map +1 -1
  123. package/resources/collections/collections.js +20 -5
  124. package/resources/collections/collections.js.map +1 -1
  125. package/resources/collections/collections.mjs +20 -5
  126. package/resources/collections/collections.mjs.map +1 -1
  127. package/resources/collections/models.d.mts.map +1 -1
  128. package/resources/collections/models.d.ts.map +1 -1
  129. package/resources/collections/models.js +3 -2
  130. package/resources/collections/models.js.map +1 -1
  131. package/resources/collections/models.mjs +3 -2
  132. package/resources/collections/models.mjs.map +1 -1
  133. package/resources/generate.d.mts +2089 -437
  134. package/resources/generate.d.mts.map +1 -1
  135. package/resources/generate.d.ts +2089 -437
  136. package/resources/generate.d.ts.map +1 -1
  137. package/resources/generate.js +62 -9
  138. package/resources/generate.js.map +1 -1
  139. package/resources/generate.mjs +62 -9
  140. package/resources/generate.mjs.map +1 -1
  141. package/resources/index.d.mts +6 -3
  142. package/resources/index.d.mts.map +1 -1
  143. package/resources/index.d.ts +6 -3
  144. package/resources/index.d.ts.map +1 -1
  145. package/resources/index.js +7 -1
  146. package/resources/index.js.map +1 -1
  147. package/resources/index.mjs +3 -0
  148. package/resources/index.mjs.map +1 -1
  149. package/resources/jobs.d.mts +253 -120
  150. package/resources/jobs.d.mts.map +1 -1
  151. package/resources/jobs.d.ts +253 -120
  152. package/resources/jobs.d.ts.map +1 -1
  153. package/resources/jobs.js +13 -5
  154. package/resources/jobs.js.map +1 -1
  155. package/resources/jobs.mjs +13 -5
  156. package/resources/jobs.mjs.map +1 -1
  157. package/resources/models/description.d.mts +18 -0
  158. package/resources/models/description.d.mts.map +1 -1
  159. package/resources/models/description.d.ts +18 -0
  160. package/resources/models/description.d.ts.map +1 -1
  161. package/resources/models/description.js +6 -2
  162. package/resources/models/description.js.map +1 -1
  163. package/resources/models/description.mjs +6 -2
  164. package/resources/models/description.mjs.map +1 -1
  165. package/resources/models/examples.d.mts +198 -92
  166. package/resources/models/examples.d.mts.map +1 -1
  167. package/resources/models/examples.d.ts +198 -92
  168. package/resources/models/examples.d.ts.map +1 -1
  169. package/resources/models/examples.js +6 -2
  170. package/resources/models/examples.js.map +1 -1
  171. package/resources/models/examples.mjs +6 -2
  172. package/resources/models/examples.mjs.map +1 -1
  173. package/resources/models/index.d.mts +3 -0
  174. package/resources/models/index.d.mts.map +1 -1
  175. package/resources/models/index.d.ts +3 -0
  176. package/resources/models/index.d.ts.map +1 -1
  177. package/resources/models/index.js +7 -1
  178. package/resources/models/index.js.map +1 -1
  179. package/resources/models/index.mjs +3 -0
  180. package/resources/models/index.mjs.map +1 -1
  181. package/resources/models/models.d.mts +346 -112
  182. package/resources/models/models.d.mts.map +1 -1
  183. package/resources/models/models.d.ts +346 -112
  184. package/resources/models/models.d.ts.map +1 -1
  185. package/resources/models/models.js +57 -12
  186. package/resources/models/models.js.map +1 -1
  187. package/resources/models/models.mjs +57 -12
  188. package/resources/models/models.mjs.map +1 -1
  189. package/resources/models/presets.d.mts +1016 -0
  190. package/resources/models/presets.d.mts.map +1 -0
  191. package/resources/models/presets.d.ts +1016 -0
  192. package/resources/models/presets.d.ts.map +1 -0
  193. package/resources/models/presets.js +52 -0
  194. package/resources/models/presets.js.map +1 -0
  195. package/resources/models/presets.mjs +48 -0
  196. package/resources/models/presets.mjs.map +1 -0
  197. package/resources/models/prompt-guide.d.mts +64 -0
  198. package/resources/models/prompt-guide.d.mts.map +1 -0
  199. package/resources/models/prompt-guide.d.ts +64 -0
  200. package/resources/models/prompt-guide.d.ts.map +1 -0
  201. package/resources/models/prompt-guide.js +31 -0
  202. package/resources/models/prompt-guide.js.map +1 -0
  203. package/resources/models/prompt-guide.mjs +27 -0
  204. package/resources/models/prompt-guide.mjs.map +1 -0
  205. package/resources/models/scores.d.mts +278 -0
  206. package/resources/models/scores.d.mts.map +1 -0
  207. package/resources/models/scores.d.ts +278 -0
  208. package/resources/models/scores.d.ts.map +1 -0
  209. package/resources/models/scores.js +29 -0
  210. package/resources/models/scores.js.map +1 -0
  211. package/resources/models/scores.mjs +25 -0
  212. package/resources/models/scores.mjs.map +1 -0
  213. package/resources/models/train.d.mts +186 -83
  214. package/resources/models/train.d.mts.map +1 -1
  215. package/resources/models/train.d.ts +186 -83
  216. package/resources/models/train.d.ts.map +1 -1
  217. package/resources/models/train.js +4 -3
  218. package/resources/models/train.js.map +1 -1
  219. package/resources/models/train.mjs +4 -3
  220. package/resources/models/train.mjs.map +1 -1
  221. package/resources/models/training-images.d.mts.map +1 -1
  222. package/resources/models/training-images.d.ts.map +1 -1
  223. package/resources/models/training-images.js +5 -4
  224. package/resources/models/training-images.js.map +1 -1
  225. package/resources/models/training-images.mjs +5 -4
  226. package/resources/models/training-images.mjs.map +1 -1
  227. package/resources/projects/api-keys.d.mts +54 -0
  228. package/resources/projects/api-keys.d.mts.map +1 -0
  229. package/resources/projects/api-keys.d.ts +54 -0
  230. package/resources/projects/api-keys.d.ts.map +1 -0
  231. package/resources/projects/api-keys.js +23 -0
  232. package/resources/projects/api-keys.js.map +1 -0
  233. package/resources/projects/api-keys.mjs +19 -0
  234. package/resources/projects/api-keys.mjs.map +1 -0
  235. package/resources/projects/brief.d.mts +149 -0
  236. package/resources/projects/brief.d.mts.map +1 -0
  237. package/resources/projects/brief.d.ts +149 -0
  238. package/resources/projects/brief.d.ts.map +1 -0
  239. package/resources/projects/brief.js +28 -0
  240. package/resources/projects/brief.js.map +1 -0
  241. package/resources/projects/brief.mjs +24 -0
  242. package/resources/projects/brief.mjs.map +1 -0
  243. package/resources/projects/index.d.mts +9 -0
  244. package/resources/projects/index.d.mts.map +1 -0
  245. package/resources/projects/index.d.ts +9 -0
  246. package/resources/projects/index.d.ts.map +1 -0
  247. package/resources/projects/index.js +21 -0
  248. package/resources/projects/index.js.map +1 -0
  249. package/resources/projects/index.mjs +10 -0
  250. package/resources/projects/index.mjs.map +1 -0
  251. package/resources/projects/instructions.d.mts +102 -0
  252. package/resources/projects/instructions.d.mts.map +1 -0
  253. package/resources/projects/instructions.d.ts +102 -0
  254. package/resources/projects/instructions.d.ts.map +1 -0
  255. package/resources/projects/instructions.js +24 -0
  256. package/resources/projects/instructions.js.map +1 -0
  257. package/resources/projects/instructions.mjs +20 -0
  258. package/resources/projects/instructions.mjs.map +1 -0
  259. package/resources/projects/members.d.mts +788 -0
  260. package/resources/projects/members.d.mts.map +1 -0
  261. package/resources/projects/members.d.ts +788 -0
  262. package/resources/projects/members.d.ts.map +1 -0
  263. package/resources/projects/members.js +30 -0
  264. package/resources/projects/members.js.map +1 -0
  265. package/resources/projects/members.mjs +26 -0
  266. package/resources/projects/members.mjs.map +1 -0
  267. package/resources/projects/memory.d.mts +102 -0
  268. package/resources/projects/memory.d.mts.map +1 -0
  269. package/resources/projects/memory.d.ts +102 -0
  270. package/resources/projects/memory.d.ts.map +1 -0
  271. package/resources/projects/memory.js +24 -0
  272. package/resources/projects/memory.js.map +1 -0
  273. package/resources/projects/memory.mjs +20 -0
  274. package/resources/projects/memory.mjs.map +1 -0
  275. package/resources/projects/projects.d.mts +1129 -0
  276. package/resources/projects/projects.d.mts.map +1 -0
  277. package/resources/projects/projects.d.ts +1129 -0
  278. package/resources/projects/projects.d.ts.map +1 -0
  279. package/resources/projects/projects.js +79 -0
  280. package/resources/projects/projects.js.map +1 -0
  281. package/resources/projects/projects.mjs +74 -0
  282. package/resources/projects/projects.mjs.map +1 -0
  283. package/resources/projects/watermark.d.mts +459 -0
  284. package/resources/projects/watermark.d.mts.map +1 -0
  285. package/resources/projects/watermark.d.ts +459 -0
  286. package/resources/projects/watermark.d.ts.map +1 -0
  287. package/resources/projects/watermark.js +46 -0
  288. package/resources/projects/watermark.js.map +1 -0
  289. package/resources/projects/watermark.mjs +42 -0
  290. package/resources/projects/watermark.mjs.map +1 -0
  291. package/resources/projects/webhook-endpoints/events.d.mts +87 -0
  292. package/resources/projects/webhook-endpoints/events.d.mts.map +1 -0
  293. package/resources/projects/webhook-endpoints/events.d.ts +87 -0
  294. package/resources/projects/webhook-endpoints/events.d.ts.map +1 -0
  295. package/resources/projects/webhook-endpoints/events.js +28 -0
  296. package/resources/projects/webhook-endpoints/events.js.map +1 -0
  297. package/resources/projects/webhook-endpoints/events.mjs +24 -0
  298. package/resources/projects/webhook-endpoints/events.mjs.map +1 -0
  299. package/resources/projects/webhook-endpoints/index.d.mts +3 -0
  300. package/resources/projects/webhook-endpoints/index.d.mts.map +1 -0
  301. package/resources/projects/webhook-endpoints/index.d.ts +3 -0
  302. package/resources/projects/webhook-endpoints/index.d.ts.map +1 -0
  303. package/resources/projects/webhook-endpoints/index.js +9 -0
  304. package/resources/projects/webhook-endpoints/index.js.map +1 -0
  305. package/resources/projects/webhook-endpoints/index.mjs +4 -0
  306. package/resources/projects/webhook-endpoints/index.mjs.map +1 -0
  307. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts +249 -0
  308. package/resources/projects/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  309. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts +249 -0
  310. package/resources/projects/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  311. package/resources/projects/webhook-endpoints/webhook-endpoints.js +44 -0
  312. package/resources/projects/webhook-endpoints/webhook-endpoints.js.map +1 -0
  313. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs +39 -0
  314. package/resources/projects/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  315. package/resources/projects/webhook-endpoints.d.mts +2 -0
  316. package/resources/projects/webhook-endpoints.d.mts.map +1 -0
  317. package/resources/projects/webhook-endpoints.d.ts +2 -0
  318. package/resources/projects/webhook-endpoints.d.ts.map +1 -0
  319. package/resources/projects/webhook-endpoints.js +6 -0
  320. package/resources/projects/webhook-endpoints.js.map +1 -0
  321. package/resources/projects/webhook-endpoints.mjs +3 -0
  322. package/resources/projects/webhook-endpoints.mjs.map +1 -0
  323. package/resources/projects.d.mts +2 -0
  324. package/resources/projects.d.mts.map +1 -0
  325. package/resources/projects.d.ts +2 -0
  326. package/resources/projects.d.ts.map +1 -0
  327. package/resources/projects.js +6 -0
  328. package/resources/projects.js.map +1 -0
  329. package/resources/projects.mjs +3 -0
  330. package/resources/projects.mjs.map +1 -0
  331. package/resources/recommendations.d.mts +1107 -0
  332. package/resources/recommendations.d.mts.map +1 -0
  333. package/resources/recommendations.d.ts +1107 -0
  334. package/resources/recommendations.d.ts.map +1 -0
  335. package/resources/recommendations.js +17 -0
  336. package/resources/recommendations.js.map +1 -0
  337. package/resources/recommendations.mjs +13 -0
  338. package/resources/recommendations.mjs.map +1 -0
  339. package/resources/search.d.mts +168 -5
  340. package/resources/search.d.mts.map +1 -1
  341. package/resources/search.d.ts +168 -5
  342. package/resources/search.d.ts.map +1 -1
  343. package/resources/search.js +17 -3
  344. package/resources/search.js.map +1 -1
  345. package/resources/search.mjs +17 -3
  346. package/resources/search.mjs.map +1 -1
  347. package/resources/tags.d.mts.map +1 -1
  348. package/resources/tags.d.ts.map +1 -1
  349. package/resources/tags.js +5 -1
  350. package/resources/tags.js.map +1 -1
  351. package/resources/tags.mjs +5 -1
  352. package/resources/tags.mjs.map +1 -1
  353. package/resources/teams/brief.d.mts +149 -0
  354. package/resources/teams/brief.d.mts.map +1 -0
  355. package/resources/teams/brief.d.ts +149 -0
  356. package/resources/teams/brief.d.ts.map +1 -0
  357. package/resources/teams/brief.js +28 -0
  358. package/resources/teams/brief.js.map +1 -0
  359. package/resources/teams/brief.mjs +24 -0
  360. package/resources/teams/brief.mjs.map +1 -0
  361. package/resources/teams/index.d.mts +7 -0
  362. package/resources/teams/index.d.mts.map +1 -0
  363. package/resources/teams/index.d.ts +7 -0
  364. package/resources/teams/index.d.ts.map +1 -0
  365. package/resources/teams/index.js +17 -0
  366. package/resources/teams/index.js.map +1 -0
  367. package/resources/teams/index.mjs +8 -0
  368. package/resources/teams/index.mjs.map +1 -0
  369. package/resources/teams/ip-filters.d.mts +115 -0
  370. package/resources/teams/ip-filters.d.mts.map +1 -0
  371. package/resources/teams/ip-filters.d.ts +115 -0
  372. package/resources/teams/ip-filters.d.ts.map +1 -0
  373. package/resources/teams/ip-filters.js +45 -0
  374. package/resources/teams/ip-filters.js.map +1 -0
  375. package/resources/teams/ip-filters.mjs +41 -0
  376. package/resources/teams/ip-filters.mjs.map +1 -0
  377. package/resources/teams/members.d.mts +204 -0
  378. package/resources/teams/members.d.mts.map +1 -0
  379. package/resources/teams/members.d.ts +204 -0
  380. package/resources/teams/members.d.ts.map +1 -0
  381. package/resources/teams/members.js +30 -0
  382. package/resources/teams/members.js.map +1 -0
  383. package/resources/teams/members.mjs +26 -0
  384. package/resources/teams/members.mjs.map +1 -0
  385. package/resources/teams/teams.d.mts +878 -0
  386. package/resources/teams/teams.d.mts.map +1 -0
  387. package/resources/teams/teams.d.ts +878 -0
  388. package/resources/teams/teams.d.ts.map +1 -0
  389. package/resources/teams/teams.js +66 -0
  390. package/resources/teams/teams.js.map +1 -0
  391. package/resources/teams/teams.mjs +61 -0
  392. package/resources/teams/teams.mjs.map +1 -0
  393. package/resources/teams/watermark.d.mts +459 -0
  394. package/resources/teams/watermark.d.mts.map +1 -0
  395. package/resources/teams/watermark.d.ts +459 -0
  396. package/resources/teams/watermark.d.ts.map +1 -0
  397. package/resources/teams/watermark.js +46 -0
  398. package/resources/teams/watermark.js.map +1 -0
  399. package/resources/teams/watermark.mjs +42 -0
  400. package/resources/teams/watermark.mjs.map +1 -0
  401. package/resources/teams/webhook-endpoints/events.d.mts +87 -0
  402. package/resources/teams/webhook-endpoints/events.d.mts.map +1 -0
  403. package/resources/teams/webhook-endpoints/events.d.ts +87 -0
  404. package/resources/teams/webhook-endpoints/events.d.ts.map +1 -0
  405. package/resources/teams/webhook-endpoints/events.js +28 -0
  406. package/resources/teams/webhook-endpoints/events.js.map +1 -0
  407. package/resources/teams/webhook-endpoints/events.mjs +24 -0
  408. package/resources/teams/webhook-endpoints/events.mjs.map +1 -0
  409. package/resources/teams/webhook-endpoints/index.d.mts +3 -0
  410. package/resources/teams/webhook-endpoints/index.d.mts.map +1 -0
  411. package/resources/teams/webhook-endpoints/index.d.ts +3 -0
  412. package/resources/teams/webhook-endpoints/index.d.ts.map +1 -0
  413. package/resources/teams/webhook-endpoints/index.js +9 -0
  414. package/resources/teams/webhook-endpoints/index.js.map +1 -0
  415. package/resources/teams/webhook-endpoints/index.mjs +4 -0
  416. package/resources/teams/webhook-endpoints/index.mjs.map +1 -0
  417. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts +250 -0
  418. package/resources/teams/webhook-endpoints/webhook-endpoints.d.mts.map +1 -0
  419. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts +250 -0
  420. package/resources/teams/webhook-endpoints/webhook-endpoints.d.ts.map +1 -0
  421. package/resources/teams/webhook-endpoints/webhook-endpoints.js +45 -0
  422. package/resources/teams/webhook-endpoints/webhook-endpoints.js.map +1 -0
  423. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs +40 -0
  424. package/resources/teams/webhook-endpoints/webhook-endpoints.mjs.map +1 -0
  425. package/resources/teams/webhook-endpoints.d.mts +2 -0
  426. package/resources/teams/webhook-endpoints.d.mts.map +1 -0
  427. package/resources/teams/webhook-endpoints.d.ts +2 -0
  428. package/resources/teams/webhook-endpoints.d.ts.map +1 -0
  429. package/resources/teams/webhook-endpoints.js +6 -0
  430. package/resources/teams/webhook-endpoints.js.map +1 -0
  431. package/resources/teams/webhook-endpoints.mjs +3 -0
  432. package/resources/teams/webhook-endpoints.mjs.map +1 -0
  433. package/resources/teams.d.mts +2 -0
  434. package/resources/teams.d.mts.map +1 -0
  435. package/resources/teams.d.ts +2 -0
  436. package/resources/teams.d.ts.map +1 -0
  437. package/resources/teams.js +6 -0
  438. package/resources/teams.js.map +1 -0
  439. package/resources/teams.mjs +3 -0
  440. package/resources/teams.mjs.map +1 -0
  441. package/resources/uploads.d.mts +13 -3
  442. package/resources/uploads.d.mts.map +1 -1
  443. package/resources/uploads.d.ts +13 -3
  444. package/resources/uploads.d.ts.map +1 -1
  445. package/resources/uploads.js +16 -4
  446. package/resources/uploads.js.map +1 -1
  447. package/resources/uploads.mjs +16 -4
  448. package/resources/uploads.mjs.map +1 -1
  449. package/resources/usages.d.mts +85 -51
  450. package/resources/usages.d.mts.map +1 -1
  451. package/resources/usages.d.ts +85 -51
  452. package/resources/usages.d.ts.map +1 -1
  453. package/resources/usages.js +2 -1
  454. package/resources/usages.js.map +1 -1
  455. package/resources/usages.mjs +2 -1
  456. package/resources/usages.mjs.map +1 -1
  457. package/resources/workflows.d.mts +1639 -385
  458. package/resources/workflows.d.mts.map +1 -1
  459. package/resources/workflows.d.ts +1639 -385
  460. package/resources/workflows.d.ts.map +1 -1
  461. package/resources/workflows.js +39 -8
  462. package/resources/workflows.js.map +1 -1
  463. package/resources/workflows.mjs +39 -8
  464. package/resources/workflows.mjs.map +1 -1
  465. package/src/client.ts +107 -0
  466. package/src/core/pagination.ts +144 -0
  467. package/src/internal/utils/values.ts +10 -0
  468. package/src/lib/generate.ts +7 -7
  469. package/src/lib/job.ts +9 -7
  470. package/src/lib/models.ts +8 -6
  471. package/src/lib/query.ts +42 -0
  472. package/src/lib/scenario.ts +8 -0
  473. package/src/lib/scope.ts +42 -7
  474. package/src/lib/upload.ts +10 -8
  475. package/src/lib/workflow.ts +9 -7
  476. package/src/lib/workflow_converter.ts +126 -12
  477. package/src/lib/workflow_validator.ts +183 -1
  478. package/src/resources/assets/assets.ts +766 -132
  479. package/src/resources/assets/download.ts +61 -9
  480. package/src/resources/collections/assets.ts +3 -2
  481. package/src/resources/collections/collections.ts +20 -5
  482. package/src/resources/collections/models.ts +3 -2
  483. package/src/resources/generate.ts +2935 -512
  484. package/src/resources/index.ts +37 -0
  485. package/src/resources/jobs.ts +277 -121
  486. package/src/resources/models/description.ts +126 -2
  487. package/src/resources/models/examples.ts +318 -92
  488. package/src/resources/models/index.ts +25 -0
  489. package/src/resources/models/models.ts +463 -124
  490. package/src/resources/models/presets.ts +1335 -0
  491. package/src/resources/models/prompt-guide.ts +102 -0
  492. package/src/resources/models/scores.ts +383 -0
  493. package/src/resources/models/train.ts +202 -87
  494. package/src/resources/models/training-images.ts +5 -4
  495. package/src/resources/projects/api-keys.ts +86 -0
  496. package/src/resources/projects/brief.ts +197 -0
  497. package/src/resources/projects/index.ts +71 -0
  498. package/src/resources/projects/instructions.ts +134 -0
  499. package/src/resources/projects/members.ts +958 -0
  500. package/src/resources/projects/memory.ts +134 -0
  501. package/src/resources/projects/projects.ts +1478 -0
  502. package/src/resources/projects/watermark.ts +590 -0
  503. package/src/resources/projects/webhook-endpoints/events.ts +179 -0
  504. package/src/resources/projects/webhook-endpoints/index.ts +19 -0
  505. package/src/resources/projects/webhook-endpoints/webhook-endpoints.ts +452 -0
  506. package/src/resources/projects/webhook-endpoints.ts +3 -0
  507. package/src/resources/projects.ts +3 -0
  508. package/src/resources/recommendations.ts +1502 -0
  509. package/src/resources/search.ts +220 -8
  510. package/src/resources/tags.ts +5 -1
  511. package/src/resources/teams/brief.ts +193 -0
  512. package/src/resources/teams/index.ts +62 -0
  513. package/src/resources/teams/ip-filters.ts +177 -0
  514. package/src/resources/teams/members.ts +282 -0
  515. package/src/resources/teams/teams.ts +1255 -0
  516. package/src/resources/teams/watermark.ts +590 -0
  517. package/src/resources/teams/webhook-endpoints/events.ts +179 -0
  518. package/src/resources/teams/webhook-endpoints/index.ts +19 -0
  519. package/src/resources/teams/webhook-endpoints/webhook-endpoints.ts +453 -0
  520. package/src/resources/teams/webhook-endpoints.ts +3 -0
  521. package/src/resources/teams.ts +3 -0
  522. package/src/resources/uploads.ts +30 -7
  523. package/src/resources/usages.ts +98 -50
  524. package/src/resources/workflows.ts +2053 -434
  525. package/src/version.ts +1 -1
  526. package/version.d.mts +1 -1
  527. package/version.d.ts +1 -1
  528. package/version.js +1 -1
  529. package/version.mjs +1 -1
@@ -39,6 +39,12 @@ export declare class Workflows extends APIResource {
39
39
  * cascades to the surrounding loop.
40
40
  */
41
41
  userApproval(workflowID: string, params: WorkflowUserApprovalParams, options?: RequestOptions): APIPromise<WorkflowUserApprovalResponse>;
42
+ /**
43
+ * Respond to a user-selection node in a workflow. Pass action="select" with
44
+ * selectedIndices to pick items and resume the workflow, or action="reject" to
45
+ * mark the node Rejected and cancel the workflow.
46
+ */
47
+ userSelection(workflowID: string, params: WorkflowUserSelectionParams, options?: RequestOptions): APIPromise<WorkflowUserSelectionResponse>;
42
48
  /**
43
49
  * @deprecated Use `userApproval()` instead
44
50
  */
@@ -171,7 +177,7 @@ export declare namespace WorkflowCreateResponse {
171
177
  /**
172
178
  * The type of the job for the node.
173
179
  */
174
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
180
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
175
181
  /**
176
182
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
177
183
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -192,13 +198,14 @@ export declare namespace WorkflowCreateResponse {
192
198
  */
193
199
  includeOutputsInWorkflowJob?: true;
194
200
  /**
195
- * The inputs of the node.
201
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
202
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
203
+ * connections may be present as additional inputs.
196
204
  */
197
205
  inputs?: Array<Flow.Input>;
198
206
  /**
199
- * Statically-configured items for a List node. The node outputs this array as-is
200
- * when executed. Only available for List nodes. The values can be strings,
201
- * numbers, or asset IDs.
207
+ * Statically-configured items for a List node, or the frozen candidate list of a
208
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
202
209
  */
203
210
  items?: Array<string>;
204
211
  /**
@@ -301,7 +308,9 @@ export declare namespace WorkflowCreateResponse {
301
308
  * The asset kind of the input. Only taken into account for \`file\` and
302
309
  * \`file_array\` input types. If model provides multiple kinds, the input will be
303
310
  * not able to create the asset on the flight on API side with dataurl without
304
- * data:kind, prefix
311
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
312
+ * a model does not declare one, \`image\` is returned, which is the kind used at
313
+ * generation time.
305
314
  */
306
315
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
307
316
  /**
@@ -324,8 +333,9 @@ export declare namespace WorkflowCreateResponse {
324
333
  */
325
334
  maxDuration?: number;
326
335
  /**
327
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
328
- * \`string_array\`.
336
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
337
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
338
+ * ITEMS instead — the length of each item is not constrained.
329
339
  */
330
340
  maxLength?: number;
331
341
  /**
@@ -339,8 +349,9 @@ export declare namespace WorkflowCreateResponse {
339
349
  */
340
350
  min?: number;
341
351
  /**
342
- * The minimum allowed length for string inputs. Also applies to each item in
343
- * \`string_array\`.
352
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
353
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
354
+ * ITEMS instead — the length of each item is not constrained.
344
355
  */
345
356
  minLength?: number;
346
357
  /**
@@ -381,8 +392,7 @@ export declare namespace WorkflowCreateResponse {
381
392
  * - \`ifNotDefined\`: Input is required when another specified input is not
382
393
  * defined
383
394
  * - \`ifDefined\`: Input is required when another specified input is defined
384
- * - \`conditionalValues\`: Input is required when another input has a specific
385
- * value
395
+ * - \`conditional\`: Input is required when other inputs have specific values
386
396
  *
387
397
  * By default, the input is not required.
388
398
  */
@@ -459,7 +469,9 @@ export declare namespace WorkflowCreateResponse {
459
469
  * The asset kind of the input. Only taken into account for \`file\` and
460
470
  * \`file_array\` input types. If model provides multiple kinds, the input will be
461
471
  * not able to create the asset on the flight on API side with dataurl without
462
- * data:kind, prefix
472
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
473
+ * a model does not declare one, \`image\` is returned, which is the kind used at
474
+ * generation time.
463
475
  */
464
476
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
465
477
  /**
@@ -482,8 +494,9 @@ export declare namespace WorkflowCreateResponse {
482
494
  */
483
495
  maxDuration?: number;
484
496
  /**
485
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
486
- * \`string_array\`.
497
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
498
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
499
+ * ITEMS instead — the length of each item is not constrained.
487
500
  */
488
501
  maxLength?: number;
489
502
  /**
@@ -497,8 +510,9 @@ export declare namespace WorkflowCreateResponse {
497
510
  */
498
511
  min?: number;
499
512
  /**
500
- * The minimum allowed length for string inputs. Also applies to each item in
501
- * \`string_array\`.
513
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
514
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
515
+ * ITEMS instead — the length of each item is not constrained.
502
516
  */
503
517
  minLength?: number;
504
518
  /**
@@ -539,8 +553,7 @@ export declare namespace WorkflowCreateResponse {
539
553
  * - \`ifNotDefined\`: Input is required when another specified input is not
540
554
  * defined
541
555
  * - \`ifDefined\`: Input is required when another specified input is defined
542
- * - \`conditionalValues\`: Input is required when another input has a specific
543
- * value
556
+ * - \`conditional\`: Input is required when other inputs have specific values
544
557
  *
545
558
  * By default, the input is not required.
546
559
  */
@@ -590,8 +603,7 @@ export declare namespace WorkflowCreateResponse {
590
603
  * - \`ifNotDefined\`: Input is required when another specified input is not
591
604
  * defined
592
605
  * - \`ifDefined\`: Input is required when another specified input is defined
593
- * - \`conditionalValues\`: Input is required when another input has a specific
594
- * value
606
+ * - \`conditional\`: Input is required when other inputs have specific values
595
607
  *
596
608
  * By default, the input is not required.
597
609
  */
@@ -601,12 +613,9 @@ export declare namespace WorkflowCreateResponse {
601
613
  */
602
614
  always?: boolean;
603
615
  /**
604
- * Makes this input required when another input has a specific value:
605
- *
606
- * - Key: name of the input to check
607
- * - Value: operation and allowed values that trigger the requirement
616
+ * Makes this input required when other inputs have one of the listed values
608
617
  */
609
- conditionalValues?: unknown;
618
+ conditional?: Required.Conditional;
610
619
  /**
611
620
  * Makes this input required when another input is defined:
612
621
  *
@@ -622,6 +631,24 @@ export declare namespace WorkflowCreateResponse {
622
631
  */
623
632
  ifNotDefined?: unknown;
624
633
  }
634
+ namespace Required {
635
+ /**
636
+ * Makes this input required when other inputs have one of the listed values
637
+ */
638
+ interface Conditional {
639
+ /**
640
+ * The conditions to check:
641
+ *
642
+ * - Key: name of the input to check
643
+ * - Value: values of that input that satisfy the condition
644
+ */
645
+ values: unknown;
646
+ /**
647
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
648
+ */
649
+ operator?: 'and' | 'or';
650
+ }
651
+ }
625
652
  }
626
653
  /**
627
654
  * The reference to another input or output of the same workflow. Must have at
@@ -657,8 +684,7 @@ export declare namespace WorkflowCreateResponse {
657
684
  * - \`ifNotDefined\`: Input is required when another specified input is not
658
685
  * defined
659
686
  * - \`ifDefined\`: Input is required when another specified input is defined
660
- * - \`conditionalValues\`: Input is required when another input has a specific
661
- * value
687
+ * - \`conditional\`: Input is required when other inputs have specific values
662
688
  *
663
689
  * By default, the input is not required.
664
690
  */
@@ -668,12 +694,9 @@ export declare namespace WorkflowCreateResponse {
668
694
  */
669
695
  always?: boolean;
670
696
  /**
671
- * Makes this input required when another input has a specific value:
672
- *
673
- * - Key: name of the input to check
674
- * - Value: operation and allowed values that trigger the requirement
697
+ * Makes this input required when other inputs have one of the listed values
675
698
  */
676
- conditionalValues?: unknown;
699
+ conditional?: Required.Conditional;
677
700
  /**
678
701
  * Makes this input required when another input is defined:
679
702
  *
@@ -689,6 +712,24 @@ export declare namespace WorkflowCreateResponse {
689
712
  */
690
713
  ifNotDefined?: unknown;
691
714
  }
715
+ namespace Required {
716
+ /**
717
+ * Makes this input required when other inputs have one of the listed values
718
+ */
719
+ interface Conditional {
720
+ /**
721
+ * The conditions to check:
722
+ *
723
+ * - Key: name of the input to check
724
+ * - Value: values of that input that satisfy the condition
725
+ */
726
+ values: unknown;
727
+ /**
728
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
729
+ */
730
+ operator?: 'and' | 'or';
731
+ }
732
+ }
692
733
  }
693
734
  /**
694
735
  * The logic of the node. Only available for logic nodes.
@@ -778,7 +819,9 @@ export declare namespace WorkflowCreateResponse {
778
819
  * The asset kind of the input. Only taken into account for \`file\` and
779
820
  * \`file_array\` input types. If model provides multiple kinds, the input will be
780
821
  * not able to create the asset on the flight on API side with dataurl without
781
- * data:kind, prefix
822
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
823
+ * a model does not declare one, \`image\` is returned, which is the kind used at
824
+ * generation time.
782
825
  */
783
826
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
784
827
  /**
@@ -801,8 +844,9 @@ export declare namespace WorkflowCreateResponse {
801
844
  */
802
845
  maxDuration?: number;
803
846
  /**
804
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
805
- * \`string_array\`.
847
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
848
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
849
+ * ITEMS instead — the length of each item is not constrained.
806
850
  */
807
851
  maxLength?: number;
808
852
  /**
@@ -816,8 +860,9 @@ export declare namespace WorkflowCreateResponse {
816
860
  */
817
861
  min?: number;
818
862
  /**
819
- * The minimum allowed length for string inputs. Also applies to each item in
820
- * \`string_array\`.
863
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
864
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
865
+ * ITEMS instead — the length of each item is not constrained.
821
866
  */
822
867
  minLength?: number;
823
868
  /**
@@ -853,8 +898,7 @@ export declare namespace WorkflowCreateResponse {
853
898
  * - \`ifNotDefined\`: Input is required when another specified input is not
854
899
  * defined
855
900
  * - \`ifDefined\`: Input is required when another specified input is defined
856
- * - \`conditionalValues\`: Input is required when another input has a specific
857
- * value
901
+ * - \`conditional\`: Input is required when other inputs have specific values
858
902
  *
859
903
  * By default, the input is not required.
860
904
  */
@@ -872,8 +916,7 @@ export declare namespace WorkflowCreateResponse {
872
916
  * - \`ifNotDefined\`: Input is required when another specified input is not
873
917
  * defined
874
918
  * - \`ifDefined\`: Input is required when another specified input is defined
875
- * - \`conditionalValues\`: Input is required when another input has a specific
876
- * value
919
+ * - \`conditional\`: Input is required when other inputs have specific values
877
920
  *
878
921
  * By default, the input is not required.
879
922
  */
@@ -883,12 +926,9 @@ export declare namespace WorkflowCreateResponse {
883
926
  */
884
927
  always?: boolean;
885
928
  /**
886
- * Makes this input required when another input has a specific value:
887
- *
888
- * - Key: name of the input to check
889
- * - Value: operation and allowed values that trigger the requirement
929
+ * Makes this input required when other inputs have one of the listed values
890
930
  */
891
- conditionalValues?: unknown;
931
+ conditional?: Required.Conditional;
892
932
  /**
893
933
  * Makes this input required when another input is defined:
894
934
  *
@@ -904,6 +944,24 @@ export declare namespace WorkflowCreateResponse {
904
944
  */
905
945
  ifNotDefined?: unknown;
906
946
  }
947
+ namespace Required {
948
+ /**
949
+ * Makes this input required when other inputs have one of the listed values
950
+ */
951
+ interface Conditional {
952
+ /**
953
+ * The conditions to check:
954
+ *
955
+ * - Key: name of the input to check
956
+ * - Value: values of that input that satisfy the condition
957
+ */
958
+ values: unknown;
959
+ /**
960
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
961
+ */
962
+ operator?: 'and' | 'or';
963
+ }
964
+ }
907
965
  }
908
966
  /**
909
967
  * A representation of an asset after being processed by the workflow
@@ -954,6 +1012,12 @@ export declare namespace WorkflowCreateResponse {
954
1012
  * Configuration for the loras component
955
1013
  */
956
1014
  lorasComponent?: UiConfig.LorasComponent;
1015
+ /**
1016
+ * Configuration for the provider outputs exposed by `exposeOutput`
1017
+ */
1018
+ outputProperties?: {
1019
+ [key: string]: UiConfig.OutputProperties;
1020
+ };
957
1021
  /**
958
1022
  * Configuration for the presets
959
1023
  */
@@ -1001,6 +1065,9 @@ export declare namespace WorkflowCreateResponse {
1001
1065
  */
1002
1066
  modelIdInput?: string;
1003
1067
  }
1068
+ interface OutputProperties {
1069
+ label: string;
1070
+ }
1004
1071
  interface Preset {
1005
1072
  fields: Array<string>;
1006
1073
  presets: unknown;
@@ -1179,7 +1246,7 @@ export declare namespace WorkflowRetrieveResponse {
1179
1246
  /**
1180
1247
  * The type of the job for the node.
1181
1248
  */
1182
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
1249
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
1183
1250
  /**
1184
1251
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
1185
1252
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -1200,13 +1267,14 @@ export declare namespace WorkflowRetrieveResponse {
1200
1267
  */
1201
1268
  includeOutputsInWorkflowJob?: true;
1202
1269
  /**
1203
- * The inputs of the node.
1270
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
1271
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
1272
+ * connections may be present as additional inputs.
1204
1273
  */
1205
1274
  inputs?: Array<Flow.Input>;
1206
1275
  /**
1207
- * Statically-configured items for a List node. The node outputs this array as-is
1208
- * when executed. Only available for List nodes. The values can be strings,
1209
- * numbers, or asset IDs.
1276
+ * Statically-configured items for a List node, or the frozen candidate list of a
1277
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
1210
1278
  */
1211
1279
  items?: Array<string>;
1212
1280
  /**
@@ -1309,7 +1377,9 @@ export declare namespace WorkflowRetrieveResponse {
1309
1377
  * The asset kind of the input. Only taken into account for \`file\` and
1310
1378
  * \`file_array\` input types. If model provides multiple kinds, the input will be
1311
1379
  * not able to create the asset on the flight on API side with dataurl without
1312
- * data:kind, prefix
1380
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
1381
+ * a model does not declare one, \`image\` is returned, which is the kind used at
1382
+ * generation time.
1313
1383
  */
1314
1384
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
1315
1385
  /**
@@ -1332,8 +1402,9 @@ export declare namespace WorkflowRetrieveResponse {
1332
1402
  */
1333
1403
  maxDuration?: number;
1334
1404
  /**
1335
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
1336
- * \`string_array\`.
1405
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
1406
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1407
+ * ITEMS instead — the length of each item is not constrained.
1337
1408
  */
1338
1409
  maxLength?: number;
1339
1410
  /**
@@ -1347,8 +1418,9 @@ export declare namespace WorkflowRetrieveResponse {
1347
1418
  */
1348
1419
  min?: number;
1349
1420
  /**
1350
- * The minimum allowed length for string inputs. Also applies to each item in
1351
- * \`string_array\`.
1421
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
1422
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1423
+ * ITEMS instead — the length of each item is not constrained.
1352
1424
  */
1353
1425
  minLength?: number;
1354
1426
  /**
@@ -1389,8 +1461,7 @@ export declare namespace WorkflowRetrieveResponse {
1389
1461
  * - \`ifNotDefined\`: Input is required when another specified input is not
1390
1462
  * defined
1391
1463
  * - \`ifDefined\`: Input is required when another specified input is defined
1392
- * - \`conditionalValues\`: Input is required when another input has a specific
1393
- * value
1464
+ * - \`conditional\`: Input is required when other inputs have specific values
1394
1465
  *
1395
1466
  * By default, the input is not required.
1396
1467
  */
@@ -1467,7 +1538,9 @@ export declare namespace WorkflowRetrieveResponse {
1467
1538
  * The asset kind of the input. Only taken into account for \`file\` and
1468
1539
  * \`file_array\` input types. If model provides multiple kinds, the input will be
1469
1540
  * not able to create the asset on the flight on API side with dataurl without
1470
- * data:kind, prefix
1541
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
1542
+ * a model does not declare one, \`image\` is returned, which is the kind used at
1543
+ * generation time.
1471
1544
  */
1472
1545
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
1473
1546
  /**
@@ -1490,8 +1563,9 @@ export declare namespace WorkflowRetrieveResponse {
1490
1563
  */
1491
1564
  maxDuration?: number;
1492
1565
  /**
1493
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
1494
- * \`string_array\`.
1566
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
1567
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1568
+ * ITEMS instead — the length of each item is not constrained.
1495
1569
  */
1496
1570
  maxLength?: number;
1497
1571
  /**
@@ -1505,8 +1579,9 @@ export declare namespace WorkflowRetrieveResponse {
1505
1579
  */
1506
1580
  min?: number;
1507
1581
  /**
1508
- * The minimum allowed length for string inputs. Also applies to each item in
1509
- * \`string_array\`.
1582
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
1583
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1584
+ * ITEMS instead — the length of each item is not constrained.
1510
1585
  */
1511
1586
  minLength?: number;
1512
1587
  /**
@@ -1547,8 +1622,7 @@ export declare namespace WorkflowRetrieveResponse {
1547
1622
  * - \`ifNotDefined\`: Input is required when another specified input is not
1548
1623
  * defined
1549
1624
  * - \`ifDefined\`: Input is required when another specified input is defined
1550
- * - \`conditionalValues\`: Input is required when another input has a specific
1551
- * value
1625
+ * - \`conditional\`: Input is required when other inputs have specific values
1552
1626
  *
1553
1627
  * By default, the input is not required.
1554
1628
  */
@@ -1598,8 +1672,7 @@ export declare namespace WorkflowRetrieveResponse {
1598
1672
  * - \`ifNotDefined\`: Input is required when another specified input is not
1599
1673
  * defined
1600
1674
  * - \`ifDefined\`: Input is required when another specified input is defined
1601
- * - \`conditionalValues\`: Input is required when another input has a specific
1602
- * value
1675
+ * - \`conditional\`: Input is required when other inputs have specific values
1603
1676
  *
1604
1677
  * By default, the input is not required.
1605
1678
  */
@@ -1609,12 +1682,9 @@ export declare namespace WorkflowRetrieveResponse {
1609
1682
  */
1610
1683
  always?: boolean;
1611
1684
  /**
1612
- * Makes this input required when another input has a specific value:
1613
- *
1614
- * - Key: name of the input to check
1615
- * - Value: operation and allowed values that trigger the requirement
1685
+ * Makes this input required when other inputs have one of the listed values
1616
1686
  */
1617
- conditionalValues?: unknown;
1687
+ conditional?: Required.Conditional;
1618
1688
  /**
1619
1689
  * Makes this input required when another input is defined:
1620
1690
  *
@@ -1630,6 +1700,24 @@ export declare namespace WorkflowRetrieveResponse {
1630
1700
  */
1631
1701
  ifNotDefined?: unknown;
1632
1702
  }
1703
+ namespace Required {
1704
+ /**
1705
+ * Makes this input required when other inputs have one of the listed values
1706
+ */
1707
+ interface Conditional {
1708
+ /**
1709
+ * The conditions to check:
1710
+ *
1711
+ * - Key: name of the input to check
1712
+ * - Value: values of that input that satisfy the condition
1713
+ */
1714
+ values: unknown;
1715
+ /**
1716
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
1717
+ */
1718
+ operator?: 'and' | 'or';
1719
+ }
1720
+ }
1633
1721
  }
1634
1722
  /**
1635
1723
  * The reference to another input or output of the same workflow. Must have at
@@ -1665,8 +1753,7 @@ export declare namespace WorkflowRetrieveResponse {
1665
1753
  * - \`ifNotDefined\`: Input is required when another specified input is not
1666
1754
  * defined
1667
1755
  * - \`ifDefined\`: Input is required when another specified input is defined
1668
- * - \`conditionalValues\`: Input is required when another input has a specific
1669
- * value
1756
+ * - \`conditional\`: Input is required when other inputs have specific values
1670
1757
  *
1671
1758
  * By default, the input is not required.
1672
1759
  */
@@ -1676,12 +1763,9 @@ export declare namespace WorkflowRetrieveResponse {
1676
1763
  */
1677
1764
  always?: boolean;
1678
1765
  /**
1679
- * Makes this input required when another input has a specific value:
1680
- *
1681
- * - Key: name of the input to check
1682
- * - Value: operation and allowed values that trigger the requirement
1766
+ * Makes this input required when other inputs have one of the listed values
1683
1767
  */
1684
- conditionalValues?: unknown;
1768
+ conditional?: Required.Conditional;
1685
1769
  /**
1686
1770
  * Makes this input required when another input is defined:
1687
1771
  *
@@ -1697,6 +1781,24 @@ export declare namespace WorkflowRetrieveResponse {
1697
1781
  */
1698
1782
  ifNotDefined?: unknown;
1699
1783
  }
1784
+ namespace Required {
1785
+ /**
1786
+ * Makes this input required when other inputs have one of the listed values
1787
+ */
1788
+ interface Conditional {
1789
+ /**
1790
+ * The conditions to check:
1791
+ *
1792
+ * - Key: name of the input to check
1793
+ * - Value: values of that input that satisfy the condition
1794
+ */
1795
+ values: unknown;
1796
+ /**
1797
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
1798
+ */
1799
+ operator?: 'and' | 'or';
1800
+ }
1801
+ }
1700
1802
  }
1701
1803
  /**
1702
1804
  * The logic of the node. Only available for logic nodes.
@@ -1786,7 +1888,9 @@ export declare namespace WorkflowRetrieveResponse {
1786
1888
  * The asset kind of the input. Only taken into account for \`file\` and
1787
1889
  * \`file_array\` input types. If model provides multiple kinds, the input will be
1788
1890
  * not able to create the asset on the flight on API side with dataurl without
1789
- * data:kind, prefix
1891
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
1892
+ * a model does not declare one, \`image\` is returned, which is the kind used at
1893
+ * generation time.
1790
1894
  */
1791
1895
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
1792
1896
  /**
@@ -1809,8 +1913,9 @@ export declare namespace WorkflowRetrieveResponse {
1809
1913
  */
1810
1914
  maxDuration?: number;
1811
1915
  /**
1812
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
1813
- * \`string_array\`.
1916
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
1917
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1918
+ * ITEMS instead — the length of each item is not constrained.
1814
1919
  */
1815
1920
  maxLength?: number;
1816
1921
  /**
@@ -1824,8 +1929,9 @@ export declare namespace WorkflowRetrieveResponse {
1824
1929
  */
1825
1930
  min?: number;
1826
1931
  /**
1827
- * The minimum allowed length for string inputs. Also applies to each item in
1828
- * \`string_array\`.
1932
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
1933
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
1934
+ * ITEMS instead — the length of each item is not constrained.
1829
1935
  */
1830
1936
  minLength?: number;
1831
1937
  /**
@@ -1861,8 +1967,7 @@ export declare namespace WorkflowRetrieveResponse {
1861
1967
  * - \`ifNotDefined\`: Input is required when another specified input is not
1862
1968
  * defined
1863
1969
  * - \`ifDefined\`: Input is required when another specified input is defined
1864
- * - \`conditionalValues\`: Input is required when another input has a specific
1865
- * value
1970
+ * - \`conditional\`: Input is required when other inputs have specific values
1866
1971
  *
1867
1972
  * By default, the input is not required.
1868
1973
  */
@@ -1880,8 +1985,7 @@ export declare namespace WorkflowRetrieveResponse {
1880
1985
  * - \`ifNotDefined\`: Input is required when another specified input is not
1881
1986
  * defined
1882
1987
  * - \`ifDefined\`: Input is required when another specified input is defined
1883
- * - \`conditionalValues\`: Input is required when another input has a specific
1884
- * value
1988
+ * - \`conditional\`: Input is required when other inputs have specific values
1885
1989
  *
1886
1990
  * By default, the input is not required.
1887
1991
  */
@@ -1891,12 +1995,9 @@ export declare namespace WorkflowRetrieveResponse {
1891
1995
  */
1892
1996
  always?: boolean;
1893
1997
  /**
1894
- * Makes this input required when another input has a specific value:
1895
- *
1896
- * - Key: name of the input to check
1897
- * - Value: operation and allowed values that trigger the requirement
1998
+ * Makes this input required when other inputs have one of the listed values
1898
1999
  */
1899
- conditionalValues?: unknown;
2000
+ conditional?: Required.Conditional;
1900
2001
  /**
1901
2002
  * Makes this input required when another input is defined:
1902
2003
  *
@@ -1912,6 +2013,24 @@ export declare namespace WorkflowRetrieveResponse {
1912
2013
  */
1913
2014
  ifNotDefined?: unknown;
1914
2015
  }
2016
+ namespace Required {
2017
+ /**
2018
+ * Makes this input required when other inputs have one of the listed values
2019
+ */
2020
+ interface Conditional {
2021
+ /**
2022
+ * The conditions to check:
2023
+ *
2024
+ * - Key: name of the input to check
2025
+ * - Value: values of that input that satisfy the condition
2026
+ */
2027
+ values: unknown;
2028
+ /**
2029
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2030
+ */
2031
+ operator?: 'and' | 'or';
2032
+ }
2033
+ }
1915
2034
  }
1916
2035
  /**
1917
2036
  * A representation of an asset after being processed by the workflow
@@ -1962,6 +2081,12 @@ export declare namespace WorkflowRetrieveResponse {
1962
2081
  * Configuration for the loras component
1963
2082
  */
1964
2083
  lorasComponent?: UiConfig.LorasComponent;
2084
+ /**
2085
+ * Configuration for the provider outputs exposed by `exposeOutput`
2086
+ */
2087
+ outputProperties?: {
2088
+ [key: string]: UiConfig.OutputProperties;
2089
+ };
1965
2090
  /**
1966
2091
  * Configuration for the presets
1967
2092
  */
@@ -2009,6 +2134,9 @@ export declare namespace WorkflowRetrieveResponse {
2009
2134
  */
2010
2135
  modelIdInput?: string;
2011
2136
  }
2137
+ interface OutputProperties {
2138
+ label: string;
2139
+ }
2012
2140
  interface Preset {
2013
2141
  fields: Array<string>;
2014
2142
  presets: unknown;
@@ -2187,7 +2315,7 @@ export declare namespace WorkflowUpdateResponse {
2187
2315
  /**
2188
2316
  * The type of the job for the node.
2189
2317
  */
2190
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
2318
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
2191
2319
  /**
2192
2320
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
2193
2321
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -2208,13 +2336,14 @@ export declare namespace WorkflowUpdateResponse {
2208
2336
  */
2209
2337
  includeOutputsInWorkflowJob?: true;
2210
2338
  /**
2211
- * The inputs of the node.
2339
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
2340
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
2341
+ * connections may be present as additional inputs.
2212
2342
  */
2213
2343
  inputs?: Array<Flow.Input>;
2214
2344
  /**
2215
- * Statically-configured items for a List node. The node outputs this array as-is
2216
- * when executed. Only available for List nodes. The values can be strings,
2217
- * numbers, or asset IDs.
2345
+ * Statically-configured items for a List node, or the frozen candidate list of a
2346
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
2218
2347
  */
2219
2348
  items?: Array<string>;
2220
2349
  /**
@@ -2317,7 +2446,9 @@ export declare namespace WorkflowUpdateResponse {
2317
2446
  * The asset kind of the input. Only taken into account for \`file\` and
2318
2447
  * \`file_array\` input types. If model provides multiple kinds, the input will be
2319
2448
  * not able to create the asset on the flight on API side with dataurl without
2320
- * data:kind, prefix
2449
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
2450
+ * a model does not declare one, \`image\` is returned, which is the kind used at
2451
+ * generation time.
2321
2452
  */
2322
2453
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
2323
2454
  /**
@@ -2340,8 +2471,9 @@ export declare namespace WorkflowUpdateResponse {
2340
2471
  */
2341
2472
  maxDuration?: number;
2342
2473
  /**
2343
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
2344
- * \`string_array\`.
2474
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
2475
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
2476
+ * ITEMS instead — the length of each item is not constrained.
2345
2477
  */
2346
2478
  maxLength?: number;
2347
2479
  /**
@@ -2355,8 +2487,9 @@ export declare namespace WorkflowUpdateResponse {
2355
2487
  */
2356
2488
  min?: number;
2357
2489
  /**
2358
- * The minimum allowed length for string inputs. Also applies to each item in
2359
- * \`string_array\`.
2490
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
2491
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
2492
+ * ITEMS instead — the length of each item is not constrained.
2360
2493
  */
2361
2494
  minLength?: number;
2362
2495
  /**
@@ -2397,8 +2530,7 @@ export declare namespace WorkflowUpdateResponse {
2397
2530
  * - \`ifNotDefined\`: Input is required when another specified input is not
2398
2531
  * defined
2399
2532
  * - \`ifDefined\`: Input is required when another specified input is defined
2400
- * - \`conditionalValues\`: Input is required when another input has a specific
2401
- * value
2533
+ * - \`conditional\`: Input is required when other inputs have specific values
2402
2534
  *
2403
2535
  * By default, the input is not required.
2404
2536
  */
@@ -2475,7 +2607,9 @@ export declare namespace WorkflowUpdateResponse {
2475
2607
  * The asset kind of the input. Only taken into account for \`file\` and
2476
2608
  * \`file_array\` input types. If model provides multiple kinds, the input will be
2477
2609
  * not able to create the asset on the flight on API side with dataurl without
2478
- * data:kind, prefix
2610
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
2611
+ * a model does not declare one, \`image\` is returned, which is the kind used at
2612
+ * generation time.
2479
2613
  */
2480
2614
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
2481
2615
  /**
@@ -2498,8 +2632,9 @@ export declare namespace WorkflowUpdateResponse {
2498
2632
  */
2499
2633
  maxDuration?: number;
2500
2634
  /**
2501
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
2502
- * \`string_array\`.
2635
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
2636
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
2637
+ * ITEMS instead — the length of each item is not constrained.
2503
2638
  */
2504
2639
  maxLength?: number;
2505
2640
  /**
@@ -2513,8 +2648,9 @@ export declare namespace WorkflowUpdateResponse {
2513
2648
  */
2514
2649
  min?: number;
2515
2650
  /**
2516
- * The minimum allowed length for string inputs. Also applies to each item in
2517
- * \`string_array\`.
2651
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
2652
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
2653
+ * ITEMS instead — the length of each item is not constrained.
2518
2654
  */
2519
2655
  minLength?: number;
2520
2656
  /**
@@ -2555,8 +2691,7 @@ export declare namespace WorkflowUpdateResponse {
2555
2691
  * - \`ifNotDefined\`: Input is required when another specified input is not
2556
2692
  * defined
2557
2693
  * - \`ifDefined\`: Input is required when another specified input is defined
2558
- * - \`conditionalValues\`: Input is required when another input has a specific
2559
- * value
2694
+ * - \`conditional\`: Input is required when other inputs have specific values
2560
2695
  *
2561
2696
  * By default, the input is not required.
2562
2697
  */
@@ -2606,8 +2741,7 @@ export declare namespace WorkflowUpdateResponse {
2606
2741
  * - \`ifNotDefined\`: Input is required when another specified input is not
2607
2742
  * defined
2608
2743
  * - \`ifDefined\`: Input is required when another specified input is defined
2609
- * - \`conditionalValues\`: Input is required when another input has a specific
2610
- * value
2744
+ * - \`conditional\`: Input is required when other inputs have specific values
2611
2745
  *
2612
2746
  * By default, the input is not required.
2613
2747
  */
@@ -2617,12 +2751,9 @@ export declare namespace WorkflowUpdateResponse {
2617
2751
  */
2618
2752
  always?: boolean;
2619
2753
  /**
2620
- * Makes this input required when another input has a specific value:
2621
- *
2622
- * - Key: name of the input to check
2623
- * - Value: operation and allowed values that trigger the requirement
2754
+ * Makes this input required when other inputs have one of the listed values
2624
2755
  */
2625
- conditionalValues?: unknown;
2756
+ conditional?: Required.Conditional;
2626
2757
  /**
2627
2758
  * Makes this input required when another input is defined:
2628
2759
  *
@@ -2638,6 +2769,24 @@ export declare namespace WorkflowUpdateResponse {
2638
2769
  */
2639
2770
  ifNotDefined?: unknown;
2640
2771
  }
2772
+ namespace Required {
2773
+ /**
2774
+ * Makes this input required when other inputs have one of the listed values
2775
+ */
2776
+ interface Conditional {
2777
+ /**
2778
+ * The conditions to check:
2779
+ *
2780
+ * - Key: name of the input to check
2781
+ * - Value: values of that input that satisfy the condition
2782
+ */
2783
+ values: unknown;
2784
+ /**
2785
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2786
+ */
2787
+ operator?: 'and' | 'or';
2788
+ }
2789
+ }
2641
2790
  }
2642
2791
  /**
2643
2792
  * The reference to another input or output of the same workflow. Must have at
@@ -2673,8 +2822,7 @@ export declare namespace WorkflowUpdateResponse {
2673
2822
  * - \`ifNotDefined\`: Input is required when another specified input is not
2674
2823
  * defined
2675
2824
  * - \`ifDefined\`: Input is required when another specified input is defined
2676
- * - \`conditionalValues\`: Input is required when another input has a specific
2677
- * value
2825
+ * - \`conditional\`: Input is required when other inputs have specific values
2678
2826
  *
2679
2827
  * By default, the input is not required.
2680
2828
  */
@@ -2684,12 +2832,9 @@ export declare namespace WorkflowUpdateResponse {
2684
2832
  */
2685
2833
  always?: boolean;
2686
2834
  /**
2687
- * Makes this input required when another input has a specific value:
2688
- *
2689
- * - Key: name of the input to check
2690
- * - Value: operation and allowed values that trigger the requirement
2835
+ * Makes this input required when other inputs have one of the listed values
2691
2836
  */
2692
- conditionalValues?: unknown;
2837
+ conditional?: Required.Conditional;
2693
2838
  /**
2694
2839
  * Makes this input required when another input is defined:
2695
2840
  *
@@ -2705,6 +2850,24 @@ export declare namespace WorkflowUpdateResponse {
2705
2850
  */
2706
2851
  ifNotDefined?: unknown;
2707
2852
  }
2853
+ namespace Required {
2854
+ /**
2855
+ * Makes this input required when other inputs have one of the listed values
2856
+ */
2857
+ interface Conditional {
2858
+ /**
2859
+ * The conditions to check:
2860
+ *
2861
+ * - Key: name of the input to check
2862
+ * - Value: values of that input that satisfy the condition
2863
+ */
2864
+ values: unknown;
2865
+ /**
2866
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
2867
+ */
2868
+ operator?: 'and' | 'or';
2869
+ }
2870
+ }
2708
2871
  }
2709
2872
  /**
2710
2873
  * The logic of the node. Only available for logic nodes.
@@ -2794,7 +2957,9 @@ export declare namespace WorkflowUpdateResponse {
2794
2957
  * The asset kind of the input. Only taken into account for \`file\` and
2795
2958
  * \`file_array\` input types. If model provides multiple kinds, the input will be
2796
2959
  * not able to create the asset on the flight on API side with dataurl without
2797
- * data:kind, prefix
2960
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
2961
+ * a model does not declare one, \`image\` is returned, which is the kind used at
2962
+ * generation time.
2798
2963
  */
2799
2964
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
2800
2965
  /**
@@ -2817,8 +2982,9 @@ export declare namespace WorkflowUpdateResponse {
2817
2982
  */
2818
2983
  maxDuration?: number;
2819
2984
  /**
2820
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
2821
- * \`string_array\`.
2985
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
2986
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
2987
+ * ITEMS instead — the length of each item is not constrained.
2822
2988
  */
2823
2989
  maxLength?: number;
2824
2990
  /**
@@ -2832,8 +2998,9 @@ export declare namespace WorkflowUpdateResponse {
2832
2998
  */
2833
2999
  min?: number;
2834
3000
  /**
2835
- * The minimum allowed length for string inputs. Also applies to each item in
2836
- * \`string_array\`.
3001
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
3002
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3003
+ * ITEMS instead — the length of each item is not constrained.
2837
3004
  */
2838
3005
  minLength?: number;
2839
3006
  /**
@@ -2869,8 +3036,7 @@ export declare namespace WorkflowUpdateResponse {
2869
3036
  * - \`ifNotDefined\`: Input is required when another specified input is not
2870
3037
  * defined
2871
3038
  * - \`ifDefined\`: Input is required when another specified input is defined
2872
- * - \`conditionalValues\`: Input is required when another input has a specific
2873
- * value
3039
+ * - \`conditional\`: Input is required when other inputs have specific values
2874
3040
  *
2875
3041
  * By default, the input is not required.
2876
3042
  */
@@ -2888,8 +3054,7 @@ export declare namespace WorkflowUpdateResponse {
2888
3054
  * - \`ifNotDefined\`: Input is required when another specified input is not
2889
3055
  * defined
2890
3056
  * - \`ifDefined\`: Input is required when another specified input is defined
2891
- * - \`conditionalValues\`: Input is required when another input has a specific
2892
- * value
3057
+ * - \`conditional\`: Input is required when other inputs have specific values
2893
3058
  *
2894
3059
  * By default, the input is not required.
2895
3060
  */
@@ -2899,12 +3064,9 @@ export declare namespace WorkflowUpdateResponse {
2899
3064
  */
2900
3065
  always?: boolean;
2901
3066
  /**
2902
- * Makes this input required when another input has a specific value:
2903
- *
2904
- * - Key: name of the input to check
2905
- * - Value: operation and allowed values that trigger the requirement
3067
+ * Makes this input required when other inputs have one of the listed values
2906
3068
  */
2907
- conditionalValues?: unknown;
3069
+ conditional?: Required.Conditional;
2908
3070
  /**
2909
3071
  * Makes this input required when another input is defined:
2910
3072
  *
@@ -2920,6 +3082,24 @@ export declare namespace WorkflowUpdateResponse {
2920
3082
  */
2921
3083
  ifNotDefined?: unknown;
2922
3084
  }
3085
+ namespace Required {
3086
+ /**
3087
+ * Makes this input required when other inputs have one of the listed values
3088
+ */
3089
+ interface Conditional {
3090
+ /**
3091
+ * The conditions to check:
3092
+ *
3093
+ * - Key: name of the input to check
3094
+ * - Value: values of that input that satisfy the condition
3095
+ */
3096
+ values: unknown;
3097
+ /**
3098
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
3099
+ */
3100
+ operator?: 'and' | 'or';
3101
+ }
3102
+ }
2923
3103
  }
2924
3104
  /**
2925
3105
  * A representation of an asset after being processed by the workflow
@@ -2970,6 +3150,12 @@ export declare namespace WorkflowUpdateResponse {
2970
3150
  * Configuration for the loras component
2971
3151
  */
2972
3152
  lorasComponent?: UiConfig.LorasComponent;
3153
+ /**
3154
+ * Configuration for the provider outputs exposed by `exposeOutput`
3155
+ */
3156
+ outputProperties?: {
3157
+ [key: string]: UiConfig.OutputProperties;
3158
+ };
2973
3159
  /**
2974
3160
  * Configuration for the presets
2975
3161
  */
@@ -3017,6 +3203,9 @@ export declare namespace WorkflowUpdateResponse {
3017
3203
  */
3018
3204
  modelIdInput?: string;
3019
3205
  }
3206
+ interface OutputProperties {
3207
+ label: string;
3208
+ }
3020
3209
  interface Preset {
3021
3210
  fields: Array<string>;
3022
3211
  presets: unknown;
@@ -3254,7 +3443,9 @@ export declare namespace WorkflowListResponse {
3254
3443
  * The asset kind of the input. Only taken into account for \`file\` and
3255
3444
  * \`file_array\` input types. If model provides multiple kinds, the input will be
3256
3445
  * not able to create the asset on the flight on API side with dataurl without
3257
- * data:kind, prefix
3446
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
3447
+ * a model does not declare one, \`image\` is returned, which is the kind used at
3448
+ * generation time.
3258
3449
  */
3259
3450
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
3260
3451
  /**
@@ -3277,8 +3468,9 @@ export declare namespace WorkflowListResponse {
3277
3468
  */
3278
3469
  maxDuration?: number;
3279
3470
  /**
3280
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
3281
- * \`string_array\`.
3471
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
3472
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3473
+ * ITEMS instead — the length of each item is not constrained.
3282
3474
  */
3283
3475
  maxLength?: number;
3284
3476
  /**
@@ -3292,8 +3484,9 @@ export declare namespace WorkflowListResponse {
3292
3484
  */
3293
3485
  min?: number;
3294
3486
  /**
3295
- * The minimum allowed length for string inputs. Also applies to each item in
3296
- * \`string_array\`.
3487
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
3488
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3489
+ * ITEMS instead — the length of each item is not constrained.
3297
3490
  */
3298
3491
  minLength?: number;
3299
3492
  /**
@@ -3329,8 +3522,7 @@ export declare namespace WorkflowListResponse {
3329
3522
  * - \`ifNotDefined\`: Input is required when another specified input is not
3330
3523
  * defined
3331
3524
  * - \`ifDefined\`: Input is required when another specified input is defined
3332
- * - \`conditionalValues\`: Input is required when another input has a specific
3333
- * value
3525
+ * - \`conditional\`: Input is required when other inputs have specific values
3334
3526
  *
3335
3527
  * By default, the input is not required.
3336
3528
  */
@@ -3348,8 +3540,7 @@ export declare namespace WorkflowListResponse {
3348
3540
  * - \`ifNotDefined\`: Input is required when another specified input is not
3349
3541
  * defined
3350
3542
  * - \`ifDefined\`: Input is required when another specified input is defined
3351
- * - \`conditionalValues\`: Input is required when another input has a specific
3352
- * value
3543
+ * - \`conditional\`: Input is required when other inputs have specific values
3353
3544
  *
3354
3545
  * By default, the input is not required.
3355
3546
  */
@@ -3359,12 +3550,9 @@ export declare namespace WorkflowListResponse {
3359
3550
  */
3360
3551
  always?: boolean;
3361
3552
  /**
3362
- * Makes this input required when another input has a specific value:
3363
- *
3364
- * - Key: name of the input to check
3365
- * - Value: operation and allowed values that trigger the requirement
3553
+ * Makes this input required when other inputs have one of the listed values
3366
3554
  */
3367
- conditionalValues?: unknown;
3555
+ conditional?: Required.Conditional;
3368
3556
  /**
3369
3557
  * Makes this input required when another input is defined:
3370
3558
  *
@@ -3380,6 +3568,24 @@ export declare namespace WorkflowListResponse {
3380
3568
  */
3381
3569
  ifNotDefined?: unknown;
3382
3570
  }
3571
+ namespace Required {
3572
+ /**
3573
+ * Makes this input required when other inputs have one of the listed values
3574
+ */
3575
+ interface Conditional {
3576
+ /**
3577
+ * The conditions to check:
3578
+ *
3579
+ * - Key: name of the input to check
3580
+ * - Value: values of that input that satisfy the condition
3581
+ */
3582
+ values: unknown;
3583
+ /**
3584
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
3585
+ */
3586
+ operator?: 'and' | 'or';
3587
+ }
3588
+ }
3383
3589
  }
3384
3590
  /**
3385
3591
  * A representation of an asset after being processed by the workflow
@@ -3417,7 +3623,7 @@ export declare namespace WorkflowListResponse {
3417
3623
  /**
3418
3624
  * The type of the job for the node.
3419
3625
  */
3420
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
3626
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
3421
3627
  /**
3422
3628
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
3423
3629
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -3438,13 +3644,14 @@ export declare namespace WorkflowListResponse {
3438
3644
  */
3439
3645
  includeOutputsInWorkflowJob?: true;
3440
3646
  /**
3441
- * The inputs of the node.
3647
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
3648
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
3649
+ * connections may be present as additional inputs.
3442
3650
  */
3443
3651
  inputs?: Array<Flow.Input>;
3444
3652
  /**
3445
- * Statically-configured items for a List node. The node outputs this array as-is
3446
- * when executed. Only available for List nodes. The values can be strings,
3447
- * numbers, or asset IDs.
3653
+ * Statically-configured items for a List node, or the frozen candidate list of a
3654
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
3448
3655
  */
3449
3656
  items?: Array<string>;
3450
3657
  /**
@@ -3547,7 +3754,9 @@ export declare namespace WorkflowListResponse {
3547
3754
  * The asset kind of the input. Only taken into account for \`file\` and
3548
3755
  * \`file_array\` input types. If model provides multiple kinds, the input will be
3549
3756
  * not able to create the asset on the flight on API side with dataurl without
3550
- * data:kind, prefix
3757
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
3758
+ * a model does not declare one, \`image\` is returned, which is the kind used at
3759
+ * generation time.
3551
3760
  */
3552
3761
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
3553
3762
  /**
@@ -3570,8 +3779,9 @@ export declare namespace WorkflowListResponse {
3570
3779
  */
3571
3780
  maxDuration?: number;
3572
3781
  /**
3573
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
3574
- * \`string_array\`.
3782
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
3783
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3784
+ * ITEMS instead — the length of each item is not constrained.
3575
3785
  */
3576
3786
  maxLength?: number;
3577
3787
  /**
@@ -3585,8 +3795,9 @@ export declare namespace WorkflowListResponse {
3585
3795
  */
3586
3796
  min?: number;
3587
3797
  /**
3588
- * The minimum allowed length for string inputs. Also applies to each item in
3589
- * \`string_array\`.
3798
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
3799
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3800
+ * ITEMS instead — the length of each item is not constrained.
3590
3801
  */
3591
3802
  minLength?: number;
3592
3803
  /**
@@ -3627,8 +3838,7 @@ export declare namespace WorkflowListResponse {
3627
3838
  * - \`ifNotDefined\`: Input is required when another specified input is not
3628
3839
  * defined
3629
3840
  * - \`ifDefined\`: Input is required when another specified input is defined
3630
- * - \`conditionalValues\`: Input is required when another input has a specific
3631
- * value
3841
+ * - \`conditional\`: Input is required when other inputs have specific values
3632
3842
  *
3633
3843
  * By default, the input is not required.
3634
3844
  */
@@ -3705,7 +3915,9 @@ export declare namespace WorkflowListResponse {
3705
3915
  * The asset kind of the input. Only taken into account for \`file\` and
3706
3916
  * \`file_array\` input types. If model provides multiple kinds, the input will be
3707
3917
  * not able to create the asset on the flight on API side with dataurl without
3708
- * data:kind, prefix
3918
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
3919
+ * a model does not declare one, \`image\` is returned, which is the kind used at
3920
+ * generation time.
3709
3921
  */
3710
3922
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
3711
3923
  /**
@@ -3728,8 +3940,9 @@ export declare namespace WorkflowListResponse {
3728
3940
  */
3729
3941
  maxDuration?: number;
3730
3942
  /**
3731
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
3732
- * \`string_array\`.
3943
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
3944
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3945
+ * ITEMS instead — the length of each item is not constrained.
3733
3946
  */
3734
3947
  maxLength?: number;
3735
3948
  /**
@@ -3743,8 +3956,9 @@ export declare namespace WorkflowListResponse {
3743
3956
  */
3744
3957
  min?: number;
3745
3958
  /**
3746
- * The minimum allowed length for string inputs. Also applies to each item in
3747
- * \`string_array\`.
3959
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
3960
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
3961
+ * ITEMS instead — the length of each item is not constrained.
3748
3962
  */
3749
3963
  minLength?: number;
3750
3964
  /**
@@ -3785,8 +3999,7 @@ export declare namespace WorkflowListResponse {
3785
3999
  * - \`ifNotDefined\`: Input is required when another specified input is not
3786
4000
  * defined
3787
4001
  * - \`ifDefined\`: Input is required when another specified input is defined
3788
- * - \`conditionalValues\`: Input is required when another input has a specific
3789
- * value
4002
+ * - \`conditional\`: Input is required when other inputs have specific values
3790
4003
  *
3791
4004
  * By default, the input is not required.
3792
4005
  */
@@ -3836,8 +4049,7 @@ export declare namespace WorkflowListResponse {
3836
4049
  * - \`ifNotDefined\`: Input is required when another specified input is not
3837
4050
  * defined
3838
4051
  * - \`ifDefined\`: Input is required when another specified input is defined
3839
- * - \`conditionalValues\`: Input is required when another input has a specific
3840
- * value
4052
+ * - \`conditional\`: Input is required when other inputs have specific values
3841
4053
  *
3842
4054
  * By default, the input is not required.
3843
4055
  */
@@ -3847,12 +4059,9 @@ export declare namespace WorkflowListResponse {
3847
4059
  */
3848
4060
  always?: boolean;
3849
4061
  /**
3850
- * Makes this input required when another input has a specific value:
3851
- *
3852
- * - Key: name of the input to check
3853
- * - Value: operation and allowed values that trigger the requirement
4062
+ * Makes this input required when other inputs have one of the listed values
3854
4063
  */
3855
- conditionalValues?: unknown;
4064
+ conditional?: Required.Conditional;
3856
4065
  /**
3857
4066
  * Makes this input required when another input is defined:
3858
4067
  *
@@ -3868,6 +4077,24 @@ export declare namespace WorkflowListResponse {
3868
4077
  */
3869
4078
  ifNotDefined?: unknown;
3870
4079
  }
4080
+ namespace Required {
4081
+ /**
4082
+ * Makes this input required when other inputs have one of the listed values
4083
+ */
4084
+ interface Conditional {
4085
+ /**
4086
+ * The conditions to check:
4087
+ *
4088
+ * - Key: name of the input to check
4089
+ * - Value: values of that input that satisfy the condition
4090
+ */
4091
+ values: unknown;
4092
+ /**
4093
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4094
+ */
4095
+ operator?: 'and' | 'or';
4096
+ }
4097
+ }
3871
4098
  }
3872
4099
  /**
3873
4100
  * The reference to another input or output of the same workflow. Must have at
@@ -3903,8 +4130,7 @@ export declare namespace WorkflowListResponse {
3903
4130
  * - \`ifNotDefined\`: Input is required when another specified input is not
3904
4131
  * defined
3905
4132
  * - \`ifDefined\`: Input is required when another specified input is defined
3906
- * - \`conditionalValues\`: Input is required when another input has a specific
3907
- * value
4133
+ * - \`conditional\`: Input is required when other inputs have specific values
3908
4134
  *
3909
4135
  * By default, the input is not required.
3910
4136
  */
@@ -3914,12 +4140,9 @@ export declare namespace WorkflowListResponse {
3914
4140
  */
3915
4141
  always?: boolean;
3916
4142
  /**
3917
- * Makes this input required when another input has a specific value:
3918
- *
3919
- * - Key: name of the input to check
3920
- * - Value: operation and allowed values that trigger the requirement
4143
+ * Makes this input required when other inputs have one of the listed values
3921
4144
  */
3922
- conditionalValues?: unknown;
4145
+ conditional?: Required.Conditional;
3923
4146
  /**
3924
4147
  * Makes this input required when another input is defined:
3925
4148
  *
@@ -3935,6 +4158,24 @@ export declare namespace WorkflowListResponse {
3935
4158
  */
3936
4159
  ifNotDefined?: unknown;
3937
4160
  }
4161
+ namespace Required {
4162
+ /**
4163
+ * Makes this input required when other inputs have one of the listed values
4164
+ */
4165
+ interface Conditional {
4166
+ /**
4167
+ * The conditions to check:
4168
+ *
4169
+ * - Key: name of the input to check
4170
+ * - Value: values of that input that satisfy the condition
4171
+ */
4172
+ values: unknown;
4173
+ /**
4174
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4175
+ */
4176
+ operator?: 'and' | 'or';
4177
+ }
4178
+ }
3938
4179
  }
3939
4180
  /**
3940
4181
  * The logic of the node. Only available for logic nodes.
@@ -3985,6 +4226,12 @@ export declare namespace WorkflowListResponse {
3985
4226
  * Configuration for the loras component
3986
4227
  */
3987
4228
  lorasComponent?: UiConfig.LorasComponent;
4229
+ /**
4230
+ * Configuration for the provider outputs exposed by `exposeOutput`
4231
+ */
4232
+ outputProperties?: {
4233
+ [key: string]: UiConfig.OutputProperties;
4234
+ };
3988
4235
  /**
3989
4236
  * Configuration for the presets
3990
4237
  */
@@ -4032,6 +4279,9 @@ export declare namespace WorkflowListResponse {
4032
4279
  */
4033
4280
  modelIdInput?: string;
4034
4281
  }
4282
+ interface OutputProperties {
4283
+ label: string;
4284
+ }
4035
4285
  interface Preset {
4036
4286
  fields: Array<string>;
4037
4287
  presets: unknown;
@@ -4203,7 +4453,7 @@ export declare namespace WorkflowRunResponse {
4203
4453
  /**
4204
4454
  * The type of the job for the node.
4205
4455
  */
4206
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
4456
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
4207
4457
  /**
4208
4458
  * List of produced assets for this node.
4209
4459
  */
@@ -4228,13 +4478,14 @@ export declare namespace WorkflowRunResponse {
4228
4478
  */
4229
4479
  includeOutputsInWorkflowJob?: true;
4230
4480
  /**
4231
- * The inputs of the node.
4481
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
4482
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
4483
+ * connections may be present as additional inputs.
4232
4484
  */
4233
4485
  inputs?: Array<Flow.Input>;
4234
4486
  /**
4235
- * Statically-configured items for a List node. The node outputs this array as-is
4236
- * when executed. Only available for List nodes. The values can be strings,
4237
- * numbers, or asset IDs.
4487
+ * Statically-configured items for a List node, or the frozen candidate list of a
4488
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
4238
4489
  */
4239
4490
  items?: Array<string>;
4240
4491
  /**
@@ -4351,7 +4602,9 @@ export declare namespace WorkflowRunResponse {
4351
4602
  * The asset kind of the input. Only taken into account for \`file\` and
4352
4603
  * \`file_array\` input types. If model provides multiple kinds, the input will be
4353
4604
  * not able to create the asset on the flight on API side with dataurl without
4354
- * data:kind, prefix
4605
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
4606
+ * a model does not declare one, \`image\` is returned, which is the kind used at
4607
+ * generation time.
4355
4608
  */
4356
4609
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
4357
4610
  /**
@@ -4374,8 +4627,9 @@ export declare namespace WorkflowRunResponse {
4374
4627
  */
4375
4628
  maxDuration?: number;
4376
4629
  /**
4377
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
4378
- * \`string_array\`.
4630
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
4631
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
4632
+ * ITEMS instead — the length of each item is not constrained.
4379
4633
  */
4380
4634
  maxLength?: number;
4381
4635
  /**
@@ -4389,8 +4643,9 @@ export declare namespace WorkflowRunResponse {
4389
4643
  */
4390
4644
  min?: number;
4391
4645
  /**
4392
- * The minimum allowed length for string inputs. Also applies to each item in
4393
- * \`string_array\`.
4646
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
4647
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
4648
+ * ITEMS instead — the length of each item is not constrained.
4394
4649
  */
4395
4650
  minLength?: number;
4396
4651
  /**
@@ -4431,8 +4686,7 @@ export declare namespace WorkflowRunResponse {
4431
4686
  * - \`ifNotDefined\`: Input is required when another specified input is not
4432
4687
  * defined
4433
4688
  * - \`ifDefined\`: Input is required when another specified input is defined
4434
- * - \`conditionalValues\`: Input is required when another input has a specific
4435
- * value
4689
+ * - \`conditional\`: Input is required when other inputs have specific values
4436
4690
  *
4437
4691
  * By default, the input is not required.
4438
4692
  */
@@ -4509,7 +4763,9 @@ export declare namespace WorkflowRunResponse {
4509
4763
  * The asset kind of the input. Only taken into account for \`file\` and
4510
4764
  * \`file_array\` input types. If model provides multiple kinds, the input will be
4511
4765
  * not able to create the asset on the flight on API side with dataurl without
4512
- * data:kind, prefix
4766
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
4767
+ * a model does not declare one, \`image\` is returned, which is the kind used at
4768
+ * generation time.
4513
4769
  */
4514
4770
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
4515
4771
  /**
@@ -4532,8 +4788,9 @@ export declare namespace WorkflowRunResponse {
4532
4788
  */
4533
4789
  maxDuration?: number;
4534
4790
  /**
4535
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
4536
- * \`string_array\`.
4791
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
4792
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
4793
+ * ITEMS instead — the length of each item is not constrained.
4537
4794
  */
4538
4795
  maxLength?: number;
4539
4796
  /**
@@ -4547,8 +4804,9 @@ export declare namespace WorkflowRunResponse {
4547
4804
  */
4548
4805
  min?: number;
4549
4806
  /**
4550
- * The minimum allowed length for string inputs. Also applies to each item in
4551
- * \`string_array\`.
4807
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
4808
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
4809
+ * ITEMS instead — the length of each item is not constrained.
4552
4810
  */
4553
4811
  minLength?: number;
4554
4812
  /**
@@ -4589,8 +4847,7 @@ export declare namespace WorkflowRunResponse {
4589
4847
  * - \`ifNotDefined\`: Input is required when another specified input is not
4590
4848
  * defined
4591
4849
  * - \`ifDefined\`: Input is required when another specified input is defined
4592
- * - \`conditionalValues\`: Input is required when another input has a specific
4593
- * value
4850
+ * - \`conditional\`: Input is required when other inputs have specific values
4594
4851
  *
4595
4852
  * By default, the input is not required.
4596
4853
  */
@@ -4640,8 +4897,7 @@ export declare namespace WorkflowRunResponse {
4640
4897
  * - \`ifNotDefined\`: Input is required when another specified input is not
4641
4898
  * defined
4642
4899
  * - \`ifDefined\`: Input is required when another specified input is defined
4643
- * - \`conditionalValues\`: Input is required when another input has a specific
4644
- * value
4900
+ * - \`conditional\`: Input is required when other inputs have specific values
4645
4901
  *
4646
4902
  * By default, the input is not required.
4647
4903
  */
@@ -4651,12 +4907,9 @@ export declare namespace WorkflowRunResponse {
4651
4907
  */
4652
4908
  always?: boolean;
4653
4909
  /**
4654
- * Makes this input required when another input has a specific value:
4655
- *
4656
- * - Key: name of the input to check
4657
- * - Value: operation and allowed values that trigger the requirement
4910
+ * Makes this input required when other inputs have one of the listed values
4658
4911
  */
4659
- conditionalValues?: unknown;
4912
+ conditional?: Required.Conditional;
4660
4913
  /**
4661
4914
  * Makes this input required when another input is defined:
4662
4915
  *
@@ -4672,6 +4925,24 @@ export declare namespace WorkflowRunResponse {
4672
4925
  */
4673
4926
  ifNotDefined?: unknown;
4674
4927
  }
4928
+ namespace Required {
4929
+ /**
4930
+ * Makes this input required when other inputs have one of the listed values
4931
+ */
4932
+ interface Conditional {
4933
+ /**
4934
+ * The conditions to check:
4935
+ *
4936
+ * - Key: name of the input to check
4937
+ * - Value: values of that input that satisfy the condition
4938
+ */
4939
+ values: unknown;
4940
+ /**
4941
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
4942
+ */
4943
+ operator?: 'and' | 'or';
4944
+ }
4945
+ }
4675
4946
  }
4676
4947
  /**
4677
4948
  * The reference to another input or output of the same workflow. Must have at
@@ -4707,8 +4978,7 @@ export declare namespace WorkflowRunResponse {
4707
4978
  * - \`ifNotDefined\`: Input is required when another specified input is not
4708
4979
  * defined
4709
4980
  * - \`ifDefined\`: Input is required when another specified input is defined
4710
- * - \`conditionalValues\`: Input is required when another input has a specific
4711
- * value
4981
+ * - \`conditional\`: Input is required when other inputs have specific values
4712
4982
  *
4713
4983
  * By default, the input is not required.
4714
4984
  */
@@ -4718,12 +4988,9 @@ export declare namespace WorkflowRunResponse {
4718
4988
  */
4719
4989
  always?: boolean;
4720
4990
  /**
4721
- * Makes this input required when another input has a specific value:
4722
- *
4723
- * - Key: name of the input to check
4724
- * - Value: operation and allowed values that trigger the requirement
4991
+ * Makes this input required when other inputs have one of the listed values
4725
4992
  */
4726
- conditionalValues?: unknown;
4993
+ conditional?: Required.Conditional;
4727
4994
  /**
4728
4995
  * Makes this input required when another input is defined:
4729
4996
  *
@@ -4739,6 +5006,24 @@ export declare namespace WorkflowRunResponse {
4739
5006
  */
4740
5007
  ifNotDefined?: unknown;
4741
5008
  }
5009
+ namespace Required {
5010
+ /**
5011
+ * Makes this input required when other inputs have one of the listed values
5012
+ */
5013
+ interface Conditional {
5014
+ /**
5015
+ * The conditions to check:
5016
+ *
5017
+ * - Key: name of the input to check
5018
+ * - Value: values of that input that satisfy the condition
5019
+ */
5020
+ values: unknown;
5021
+ /**
5022
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5023
+ */
5024
+ operator?: 'and' | 'or';
5025
+ }
5026
+ }
4742
5027
  }
4743
5028
  /**
4744
5029
  * The logic of the node. Only available for logic nodes.
@@ -4778,7 +5063,7 @@ export declare namespace WorkflowRunResponse {
4778
5063
  cuDiscount: number;
4779
5064
  /**
4780
5065
  * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
4781
- * top of the generation itself, such as `slop-detection`.
5066
+ * top of the generation itself, such as `quality-gate`.
4782
5067
  *
4783
5068
  * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
4784
5069
  * values here.
@@ -4806,7 +5091,7 @@ export declare namespace WorkflowRunResponse {
4806
5091
  namespace Billing {
4807
5092
  /**
4808
5093
  * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
4809
- * top of the generation itself, such as `slop-detection`.
5094
+ * top of the generation itself, such as `quality-gate`.
4810
5095
  *
4811
5096
  * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
4812
5097
  * values here.
@@ -4825,7 +5110,7 @@ export declare namespace WorkflowRunResponse {
4825
5110
  */
4826
5111
  interface CuCostDetails {
4827
5112
  'ip-detection'?: number;
4828
- 'slop-detection'?: number;
5113
+ 'quality-gate'?: number;
4829
5114
  }
4830
5115
  }
4831
5116
  }
@@ -4951,7 +5236,7 @@ export declare namespace WorkflowRunResponse {
4951
5236
  /**
4952
5237
  * The type of the job for the node.
4953
5238
  */
4954
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
5239
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
4955
5240
  /**
4956
5241
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
4957
5242
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -4972,13 +5257,14 @@ export declare namespace WorkflowRunResponse {
4972
5257
  */
4973
5258
  includeOutputsInWorkflowJob?: true;
4974
5259
  /**
4975
- * The inputs of the node.
5260
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
5261
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
5262
+ * connections may be present as additional inputs.
4976
5263
  */
4977
5264
  inputs?: Array<Flow.Input>;
4978
5265
  /**
4979
- * Statically-configured items for a List node. The node outputs this array as-is
4980
- * when executed. Only available for List nodes. The values can be strings,
4981
- * numbers, or asset IDs.
5266
+ * Statically-configured items for a List node, or the frozen candidate list of a
5267
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
4982
5268
  */
4983
5269
  items?: Array<string>;
4984
5270
  /**
@@ -5081,7 +5367,9 @@ export declare namespace WorkflowRunResponse {
5081
5367
  * The asset kind of the input. Only taken into account for \`file\` and
5082
5368
  * \`file_array\` input types. If model provides multiple kinds, the input will be
5083
5369
  * not able to create the asset on the flight on API side with dataurl without
5084
- * data:kind, prefix
5370
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
5371
+ * a model does not declare one, \`image\` is returned, which is the kind used at
5372
+ * generation time.
5085
5373
  */
5086
5374
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
5087
5375
  /**
@@ -5104,8 +5392,9 @@ export declare namespace WorkflowRunResponse {
5104
5392
  */
5105
5393
  maxDuration?: number;
5106
5394
  /**
5107
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
5108
- * \`string_array\`.
5395
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
5396
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5397
+ * ITEMS instead — the length of each item is not constrained.
5109
5398
  */
5110
5399
  maxLength?: number;
5111
5400
  /**
@@ -5119,8 +5408,9 @@ export declare namespace WorkflowRunResponse {
5119
5408
  */
5120
5409
  min?: number;
5121
5410
  /**
5122
- * The minimum allowed length for string inputs. Also applies to each item in
5123
- * \`string_array\`.
5411
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
5412
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5413
+ * ITEMS instead — the length of each item is not constrained.
5124
5414
  */
5125
5415
  minLength?: number;
5126
5416
  /**
@@ -5161,8 +5451,7 @@ export declare namespace WorkflowRunResponse {
5161
5451
  * - \`ifNotDefined\`: Input is required when another specified input is not
5162
5452
  * defined
5163
5453
  * - \`ifDefined\`: Input is required when another specified input is defined
5164
- * - \`conditionalValues\`: Input is required when another input has a specific
5165
- * value
5454
+ * - \`conditional\`: Input is required when other inputs have specific values
5166
5455
  *
5167
5456
  * By default, the input is not required.
5168
5457
  */
@@ -5239,7 +5528,9 @@ export declare namespace WorkflowRunResponse {
5239
5528
  * The asset kind of the input. Only taken into account for \`file\` and
5240
5529
  * \`file_array\` input types. If model provides multiple kinds, the input will be
5241
5530
  * not able to create the asset on the flight on API side with dataurl without
5242
- * data:kind, prefix
5531
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
5532
+ * a model does not declare one, \`image\` is returned, which is the kind used at
5533
+ * generation time.
5243
5534
  */
5244
5535
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
5245
5536
  /**
@@ -5262,8 +5553,9 @@ export declare namespace WorkflowRunResponse {
5262
5553
  */
5263
5554
  maxDuration?: number;
5264
5555
  /**
5265
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
5266
- * \`string_array\`.
5556
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
5557
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5558
+ * ITEMS instead — the length of each item is not constrained.
5267
5559
  */
5268
5560
  maxLength?: number;
5269
5561
  /**
@@ -5277,8 +5569,9 @@ export declare namespace WorkflowRunResponse {
5277
5569
  */
5278
5570
  min?: number;
5279
5571
  /**
5280
- * The minimum allowed length for string inputs. Also applies to each item in
5281
- * \`string_array\`.
5572
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
5573
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5574
+ * ITEMS instead — the length of each item is not constrained.
5282
5575
  */
5283
5576
  minLength?: number;
5284
5577
  /**
@@ -5319,8 +5612,7 @@ export declare namespace WorkflowRunResponse {
5319
5612
  * - \`ifNotDefined\`: Input is required when another specified input is not
5320
5613
  * defined
5321
5614
  * - \`ifDefined\`: Input is required when another specified input is defined
5322
- * - \`conditionalValues\`: Input is required when another input has a specific
5323
- * value
5615
+ * - \`conditional\`: Input is required when other inputs have specific values
5324
5616
  *
5325
5617
  * By default, the input is not required.
5326
5618
  */
@@ -5370,8 +5662,7 @@ export declare namespace WorkflowRunResponse {
5370
5662
  * - \`ifNotDefined\`: Input is required when another specified input is not
5371
5663
  * defined
5372
5664
  * - \`ifDefined\`: Input is required when another specified input is defined
5373
- * - \`conditionalValues\`: Input is required when another input has a specific
5374
- * value
5665
+ * - \`conditional\`: Input is required when other inputs have specific values
5375
5666
  *
5376
5667
  * By default, the input is not required.
5377
5668
  */
@@ -5381,12 +5672,9 @@ export declare namespace WorkflowRunResponse {
5381
5672
  */
5382
5673
  always?: boolean;
5383
5674
  /**
5384
- * Makes this input required when another input has a specific value:
5385
- *
5386
- * - Key: name of the input to check
5387
- * - Value: operation and allowed values that trigger the requirement
5675
+ * Makes this input required when other inputs have one of the listed values
5388
5676
  */
5389
- conditionalValues?: unknown;
5677
+ conditional?: Required.Conditional;
5390
5678
  /**
5391
5679
  * Makes this input required when another input is defined:
5392
5680
  *
@@ -5402,6 +5690,24 @@ export declare namespace WorkflowRunResponse {
5402
5690
  */
5403
5691
  ifNotDefined?: unknown;
5404
5692
  }
5693
+ namespace Required {
5694
+ /**
5695
+ * Makes this input required when other inputs have one of the listed values
5696
+ */
5697
+ interface Conditional {
5698
+ /**
5699
+ * The conditions to check:
5700
+ *
5701
+ * - Key: name of the input to check
5702
+ * - Value: values of that input that satisfy the condition
5703
+ */
5704
+ values: unknown;
5705
+ /**
5706
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5707
+ */
5708
+ operator?: 'and' | 'or';
5709
+ }
5710
+ }
5405
5711
  }
5406
5712
  /**
5407
5713
  * The reference to another input or output of the same workflow. Must have at
@@ -5437,8 +5743,7 @@ export declare namespace WorkflowRunResponse {
5437
5743
  * - \`ifNotDefined\`: Input is required when another specified input is not
5438
5744
  * defined
5439
5745
  * - \`ifDefined\`: Input is required when another specified input is defined
5440
- * - \`conditionalValues\`: Input is required when another input has a specific
5441
- * value
5746
+ * - \`conditional\`: Input is required when other inputs have specific values
5442
5747
  *
5443
5748
  * By default, the input is not required.
5444
5749
  */
@@ -5448,12 +5753,9 @@ export declare namespace WorkflowRunResponse {
5448
5753
  */
5449
5754
  always?: boolean;
5450
5755
  /**
5451
- * Makes this input required when another input has a specific value:
5452
- *
5453
- * - Key: name of the input to check
5454
- * - Value: operation and allowed values that trigger the requirement
5756
+ * Makes this input required when other inputs have one of the listed values
5455
5757
  */
5456
- conditionalValues?: unknown;
5758
+ conditional?: Required.Conditional;
5457
5759
  /**
5458
5760
  * Makes this input required when another input is defined:
5459
5761
  *
@@ -5469,6 +5771,24 @@ export declare namespace WorkflowRunResponse {
5469
5771
  */
5470
5772
  ifNotDefined?: unknown;
5471
5773
  }
5774
+ namespace Required {
5775
+ /**
5776
+ * Makes this input required when other inputs have one of the listed values
5777
+ */
5778
+ interface Conditional {
5779
+ /**
5780
+ * The conditions to check:
5781
+ *
5782
+ * - Key: name of the input to check
5783
+ * - Value: values of that input that satisfy the condition
5784
+ */
5785
+ values: unknown;
5786
+ /**
5787
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
5788
+ */
5789
+ operator?: 'and' | 'or';
5790
+ }
5791
+ }
5472
5792
  }
5473
5793
  /**
5474
5794
  * The logic of the node. Only available for logic nodes.
@@ -5558,7 +5878,9 @@ export declare namespace WorkflowRunResponse {
5558
5878
  * The asset kind of the input. Only taken into account for \`file\` and
5559
5879
  * \`file_array\` input types. If model provides multiple kinds, the input will be
5560
5880
  * not able to create the asset on the flight on API side with dataurl without
5561
- * data:kind, prefix
5881
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
5882
+ * a model does not declare one, \`image\` is returned, which is the kind used at
5883
+ * generation time.
5562
5884
  */
5563
5885
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
5564
5886
  /**
@@ -5581,8 +5903,9 @@ export declare namespace WorkflowRunResponse {
5581
5903
  */
5582
5904
  maxDuration?: number;
5583
5905
  /**
5584
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
5585
- * \`string_array\`.
5906
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
5907
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5908
+ * ITEMS instead — the length of each item is not constrained.
5586
5909
  */
5587
5910
  maxLength?: number;
5588
5911
  /**
@@ -5596,8 +5919,9 @@ export declare namespace WorkflowRunResponse {
5596
5919
  */
5597
5920
  min?: number;
5598
5921
  /**
5599
- * The minimum allowed length for string inputs. Also applies to each item in
5600
- * \`string_array\`.
5922
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
5923
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
5924
+ * ITEMS instead — the length of each item is not constrained.
5601
5925
  */
5602
5926
  minLength?: number;
5603
5927
  /**
@@ -5633,8 +5957,7 @@ export declare namespace WorkflowRunResponse {
5633
5957
  * - \`ifNotDefined\`: Input is required when another specified input is not
5634
5958
  * defined
5635
5959
  * - \`ifDefined\`: Input is required when another specified input is defined
5636
- * - \`conditionalValues\`: Input is required when another input has a specific
5637
- * value
5960
+ * - \`conditional\`: Input is required when other inputs have specific values
5638
5961
  *
5639
5962
  * By default, the input is not required.
5640
5963
  */
@@ -5652,8 +5975,7 @@ export declare namespace WorkflowRunResponse {
5652
5975
  * - \`ifNotDefined\`: Input is required when another specified input is not
5653
5976
  * defined
5654
5977
  * - \`ifDefined\`: Input is required when another specified input is defined
5655
- * - \`conditionalValues\`: Input is required when another input has a specific
5656
- * value
5978
+ * - \`conditional\`: Input is required when other inputs have specific values
5657
5979
  *
5658
5980
  * By default, the input is not required.
5659
5981
  */
@@ -5663,12 +5985,9 @@ export declare namespace WorkflowRunResponse {
5663
5985
  */
5664
5986
  always?: boolean;
5665
5987
  /**
5666
- * Makes this input required when another input has a specific value:
5667
- *
5668
- * - Key: name of the input to check
5669
- * - Value: operation and allowed values that trigger the requirement
5988
+ * Makes this input required when other inputs have one of the listed values
5670
5989
  */
5671
- conditionalValues?: unknown;
5990
+ conditional?: Required.Conditional;
5672
5991
  /**
5673
5992
  * Makes this input required when another input is defined:
5674
5993
  *
@@ -5684,6 +6003,24 @@ export declare namespace WorkflowRunResponse {
5684
6003
  */
5685
6004
  ifNotDefined?: unknown;
5686
6005
  }
6006
+ namespace Required {
6007
+ /**
6008
+ * Makes this input required when other inputs have one of the listed values
6009
+ */
6010
+ interface Conditional {
6011
+ /**
6012
+ * The conditions to check:
6013
+ *
6014
+ * - Key: name of the input to check
6015
+ * - Value: values of that input that satisfy the condition
6016
+ */
6017
+ values: unknown;
6018
+ /**
6019
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6020
+ */
6021
+ operator?: 'and' | 'or';
6022
+ }
6023
+ }
5687
6024
  }
5688
6025
  /**
5689
6026
  * A representation of an asset after being processed by the workflow
@@ -5734,6 +6071,12 @@ export declare namespace WorkflowRunResponse {
5734
6071
  * Configuration for the loras component
5735
6072
  */
5736
6073
  lorasComponent?: UiConfig.LorasComponent;
6074
+ /**
6075
+ * Configuration for the provider outputs exposed by `exposeOutput`
6076
+ */
6077
+ outputProperties?: {
6078
+ [key: string]: UiConfig.OutputProperties;
6079
+ };
5737
6080
  /**
5738
6081
  * Configuration for the presets
5739
6082
  */
@@ -5781,6 +6124,9 @@ export declare namespace WorkflowRunResponse {
5781
6124
  */
5782
6125
  modelIdInput?: string;
5783
6126
  }
6127
+ interface OutputProperties {
6128
+ label: string;
6129
+ }
5784
6130
  interface Preset {
5785
6131
  fields: Array<string>;
5786
6132
  presets: unknown;
@@ -5945,7 +6291,7 @@ export declare namespace WorkflowUserApprovalResponse {
5945
6291
  /**
5946
6292
  * The type of the job for the node.
5947
6293
  */
5948
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
6294
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
5949
6295
  /**
5950
6296
  * List of produced assets for this node.
5951
6297
  */
@@ -5970,13 +6316,14 @@ export declare namespace WorkflowUserApprovalResponse {
5970
6316
  */
5971
6317
  includeOutputsInWorkflowJob?: true;
5972
6318
  /**
5973
- * The inputs of the node.
6319
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
6320
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
6321
+ * connections may be present as additional inputs.
5974
6322
  */
5975
6323
  inputs?: Array<Flow.Input>;
5976
6324
  /**
5977
- * Statically-configured items for a List node. The node outputs this array as-is
5978
- * when executed. Only available for List nodes. The values can be strings,
5979
- * numbers, or asset IDs.
6325
+ * Statically-configured items for a List node, or the frozen candidate list of a
6326
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
5980
6327
  */
5981
6328
  items?: Array<string>;
5982
6329
  /**
@@ -6093,7 +6440,9 @@ export declare namespace WorkflowUserApprovalResponse {
6093
6440
  * The asset kind of the input. Only taken into account for \`file\` and
6094
6441
  * \`file_array\` input types. If model provides multiple kinds, the input will be
6095
6442
  * not able to create the asset on the flight on API side with dataurl without
6096
- * data:kind, prefix
6443
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
6444
+ * a model does not declare one, \`image\` is returned, which is the kind used at
6445
+ * generation time.
6097
6446
  */
6098
6447
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
6099
6448
  /**
@@ -6116,8 +6465,9 @@ export declare namespace WorkflowUserApprovalResponse {
6116
6465
  */
6117
6466
  maxDuration?: number;
6118
6467
  /**
6119
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
6120
- * \`string_array\`.
6468
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
6469
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
6470
+ * ITEMS instead — the length of each item is not constrained.
6121
6471
  */
6122
6472
  maxLength?: number;
6123
6473
  /**
@@ -6131,8 +6481,9 @@ export declare namespace WorkflowUserApprovalResponse {
6131
6481
  */
6132
6482
  min?: number;
6133
6483
  /**
6134
- * The minimum allowed length for string inputs. Also applies to each item in
6135
- * \`string_array\`.
6484
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
6485
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
6486
+ * ITEMS instead — the length of each item is not constrained.
6136
6487
  */
6137
6488
  minLength?: number;
6138
6489
  /**
@@ -6173,8 +6524,7 @@ export declare namespace WorkflowUserApprovalResponse {
6173
6524
  * - \`ifNotDefined\`: Input is required when another specified input is not
6174
6525
  * defined
6175
6526
  * - \`ifDefined\`: Input is required when another specified input is defined
6176
- * - \`conditionalValues\`: Input is required when another input has a specific
6177
- * value
6527
+ * - \`conditional\`: Input is required when other inputs have specific values
6178
6528
  *
6179
6529
  * By default, the input is not required.
6180
6530
  */
@@ -6251,7 +6601,9 @@ export declare namespace WorkflowUserApprovalResponse {
6251
6601
  * The asset kind of the input. Only taken into account for \`file\` and
6252
6602
  * \`file_array\` input types. If model provides multiple kinds, the input will be
6253
6603
  * not able to create the asset on the flight on API side with dataurl without
6254
- * data:kind, prefix
6604
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
6605
+ * a model does not declare one, \`image\` is returned, which is the kind used at
6606
+ * generation time.
6255
6607
  */
6256
6608
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
6257
6609
  /**
@@ -6274,8 +6626,9 @@ export declare namespace WorkflowUserApprovalResponse {
6274
6626
  */
6275
6627
  maxDuration?: number;
6276
6628
  /**
6277
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
6278
- * \`string_array\`.
6629
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
6630
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
6631
+ * ITEMS instead — the length of each item is not constrained.
6279
6632
  */
6280
6633
  maxLength?: number;
6281
6634
  /**
@@ -6289,8 +6642,9 @@ export declare namespace WorkflowUserApprovalResponse {
6289
6642
  */
6290
6643
  min?: number;
6291
6644
  /**
6292
- * The minimum allowed length for string inputs. Also applies to each item in
6293
- * \`string_array\`.
6645
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
6646
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
6647
+ * ITEMS instead — the length of each item is not constrained.
6294
6648
  */
6295
6649
  minLength?: number;
6296
6650
  /**
@@ -6331,8 +6685,7 @@ export declare namespace WorkflowUserApprovalResponse {
6331
6685
  * - \`ifNotDefined\`: Input is required when another specified input is not
6332
6686
  * defined
6333
6687
  * - \`ifDefined\`: Input is required when another specified input is defined
6334
- * - \`conditionalValues\`: Input is required when another input has a specific
6335
- * value
6688
+ * - \`conditional\`: Input is required when other inputs have specific values
6336
6689
  *
6337
6690
  * By default, the input is not required.
6338
6691
  */
@@ -6382,8 +6735,7 @@ export declare namespace WorkflowUserApprovalResponse {
6382
6735
  * - \`ifNotDefined\`: Input is required when another specified input is not
6383
6736
  * defined
6384
6737
  * - \`ifDefined\`: Input is required when another specified input is defined
6385
- * - \`conditionalValues\`: Input is required when another input has a specific
6386
- * value
6738
+ * - \`conditional\`: Input is required when other inputs have specific values
6387
6739
  *
6388
6740
  * By default, the input is not required.
6389
6741
  */
@@ -6393,12 +6745,9 @@ export declare namespace WorkflowUserApprovalResponse {
6393
6745
  */
6394
6746
  always?: boolean;
6395
6747
  /**
6396
- * Makes this input required when another input has a specific value:
6397
- *
6398
- * - Key: name of the input to check
6399
- * - Value: operation and allowed values that trigger the requirement
6748
+ * Makes this input required when other inputs have one of the listed values
6400
6749
  */
6401
- conditionalValues?: unknown;
6750
+ conditional?: Required.Conditional;
6402
6751
  /**
6403
6752
  * Makes this input required when another input is defined:
6404
6753
  *
@@ -6414,6 +6763,24 @@ export declare namespace WorkflowUserApprovalResponse {
6414
6763
  */
6415
6764
  ifNotDefined?: unknown;
6416
6765
  }
6766
+ namespace Required {
6767
+ /**
6768
+ * Makes this input required when other inputs have one of the listed values
6769
+ */
6770
+ interface Conditional {
6771
+ /**
6772
+ * The conditions to check:
6773
+ *
6774
+ * - Key: name of the input to check
6775
+ * - Value: values of that input that satisfy the condition
6776
+ */
6777
+ values: unknown;
6778
+ /**
6779
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6780
+ */
6781
+ operator?: 'and' | 'or';
6782
+ }
6783
+ }
6417
6784
  }
6418
6785
  /**
6419
6786
  * The reference to another input or output of the same workflow. Must have at
@@ -6449,8 +6816,7 @@ export declare namespace WorkflowUserApprovalResponse {
6449
6816
  * - \`ifNotDefined\`: Input is required when another specified input is not
6450
6817
  * defined
6451
6818
  * - \`ifDefined\`: Input is required when another specified input is defined
6452
- * - \`conditionalValues\`: Input is required when another input has a specific
6453
- * value
6819
+ * - \`conditional\`: Input is required when other inputs have specific values
6454
6820
  *
6455
6821
  * By default, the input is not required.
6456
6822
  */
@@ -6460,12 +6826,9 @@ export declare namespace WorkflowUserApprovalResponse {
6460
6826
  */
6461
6827
  always?: boolean;
6462
6828
  /**
6463
- * Makes this input required when another input has a specific value:
6464
- *
6465
- * - Key: name of the input to check
6466
- * - Value: operation and allowed values that trigger the requirement
6829
+ * Makes this input required when other inputs have one of the listed values
6467
6830
  */
6468
- conditionalValues?: unknown;
6831
+ conditional?: Required.Conditional;
6469
6832
  /**
6470
6833
  * Makes this input required when another input is defined:
6471
6834
  *
@@ -6481,6 +6844,24 @@ export declare namespace WorkflowUserApprovalResponse {
6481
6844
  */
6482
6845
  ifNotDefined?: unknown;
6483
6846
  }
6847
+ namespace Required {
6848
+ /**
6849
+ * Makes this input required when other inputs have one of the listed values
6850
+ */
6851
+ interface Conditional {
6852
+ /**
6853
+ * The conditions to check:
6854
+ *
6855
+ * - Key: name of the input to check
6856
+ * - Value: values of that input that satisfy the condition
6857
+ */
6858
+ values: unknown;
6859
+ /**
6860
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
6861
+ */
6862
+ operator?: 'and' | 'or';
6863
+ }
6864
+ }
6484
6865
  }
6485
6866
  /**
6486
6867
  * The logic of the node. Only available for logic nodes.
@@ -6520,7 +6901,7 @@ export declare namespace WorkflowUserApprovalResponse {
6520
6901
  cuDiscount: number;
6521
6902
  /**
6522
6903
  * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
6523
- * top of the generation itself, such as `slop-detection`.
6904
+ * top of the generation itself, such as `quality-gate`.
6524
6905
  *
6525
6906
  * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
6526
6907
  * values here.
@@ -6548,7 +6929,7 @@ export declare namespace WorkflowUserApprovalResponse {
6548
6929
  namespace Billing {
6549
6930
  /**
6550
6931
  * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
6551
- * top of the generation itself, such as `slop-detection`.
6932
+ * top of the generation itself, such as `quality-gate`.
6552
6933
  *
6553
6934
  * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
6554
6935
  * values here.
@@ -6567,34 +6948,813 @@ export declare namespace WorkflowUserApprovalResponse {
6567
6948
  */
6568
6949
  interface CuCostDetails {
6569
6950
  'ip-detection'?: number;
6570
- 'slop-detection'?: number;
6951
+ 'quality-gate'?: number;
6571
6952
  }
6572
6953
  }
6573
6954
  }
6574
6955
  }
6575
- export interface WorkflowCreateParams {
6576
- /**
6577
- * Body param
6578
- */
6579
- description: string;
6580
- /**
6581
- * Body param
6582
- */
6583
- name: string;
6584
- /**
6585
- * Query param: The projectId used for ownership resource management. Either to
6586
- * assert ownership or to set the owner of the resource(s)
6587
- */
6588
- projectId?: string;
6589
- }
6590
- export interface WorkflowRetrieveParams {
6591
- projectId?: unknown;
6956
+ export interface WorkflowUserSelectionResponse {
6957
+ job: WorkflowUserSelectionResponse.Job;
6958
+ }
6959
+ export declare namespace WorkflowUserSelectionResponse {
6960
+ interface Job {
6961
+ /**
6962
+ * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
6963
+ */
6964
+ createdAt: string;
6965
+ /**
6966
+ * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
6967
+ */
6968
+ jobId: string;
6969
+ /**
6970
+ * The type of job
6971
+ */
6972
+ jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'musubi-model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'splat' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
6973
+ /**
6974
+ * Metadata of the job with some additional information
6975
+ */
6976
+ metadata: Job.Metadata;
6977
+ /**
6978
+ * Progress of the job (between 0 and 1)
6979
+ */
6980
+ progress: number;
6981
+ /**
6982
+ * The current status of the job
6983
+ */
6984
+ status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
6985
+ /**
6986
+ * The history of the different statuses the job went through with the ISO string
6987
+ * date of when the job reached each statuses.
6988
+ */
6989
+ statusHistory: Array<Job.StatusHistory>;
6990
+ /**
6991
+ * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
6992
+ */
6993
+ updatedAt: string;
6994
+ /**
6995
+ * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
6996
+ */
6997
+ authorId?: string;
6998
+ /**
6999
+ * The billing of the job
7000
+ */
7001
+ billing?: Job.Billing;
7002
+ /**
7003
+ * The owner ID (example: "team_U3Qmc8PCdWXwAQJ4Dvw4tV6D")
7004
+ */
7005
+ ownerId?: string;
7006
+ }
7007
+ namespace Job {
7008
+ /**
7009
+ * Metadata of the job with some additional information
7010
+ */
7011
+ interface Metadata {
7012
+ /**
7013
+ * List of produced assets for this job
7014
+ */
7015
+ assetIds?: Array<string>;
7016
+ /**
7017
+ * Eventual error for the job
7018
+ */
7019
+ error?: string | null;
7020
+ /**
7021
+ * The flow of the job. Only available for workflow jobs.
7022
+ */
7023
+ flow?: Array<Metadata.Flow>;
7024
+ /**
7025
+ * Actionable hint for the user explaining what went wrong and how to resolve it.
7026
+ */
7027
+ hint?: string;
7028
+ /**
7029
+ * The inputs for the job
7030
+ */
7031
+ input?: {
7032
+ [key: string]: unknown;
7033
+ };
7034
+ /**
7035
+ * May contain the output of the job for specific custom models jobs. Only
7036
+ * available for custom models which generate non-assets outputs. Example: LLM text
7037
+ * results.
7038
+ */
7039
+ output?: {
7040
+ [key: string]: unknown;
7041
+ };
7042
+ /**
7043
+ * For voice-clone jobs: the ID of the model being trained.
7044
+ */
7045
+ outputModelId?: string;
7046
+ /**
7047
+ * The workflow ID of the job if job is part of a workflow.
7048
+ */
7049
+ workflowId?: string;
7050
+ /**
7051
+ * The workflow job ID of the job if job is part of a workflow job.
7052
+ */
7053
+ workflowJobId?: string;
7054
+ }
7055
+ namespace Metadata {
7056
+ interface Flow {
7057
+ /**
7058
+ * The id of the node.
7059
+ */
7060
+ id: string;
7061
+ /**
7062
+ * The status of the node. Only available for WorkflowJob nodes.
7063
+ */
7064
+ status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
7065
+ /**
7066
+ * The type of the job for the node.
7067
+ */
7068
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
7069
+ /**
7070
+ * List of produced assets for this node.
7071
+ */
7072
+ assets?: Array<Flow.Asset>;
7073
+ /**
7074
+ * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
7075
+ * `count` times regardless of array input. When not set, the loop iterates over
7076
+ * the resolved array input. Only available for ForEach nodes.
7077
+ */
7078
+ count?: number;
7079
+ /**
7080
+ * The nodes that this node depends on. Only available for nodes that have
7081
+ * dependencies. Mainly used for user approval nodes.
7082
+ */
7083
+ dependsOn?: Array<string>;
7084
+ /**
7085
+ * If true, the outputs of this node will be included in the workflow job's final
7086
+ * output. Only applicable to producing nodes (custom-model, inference, etc.). By
7087
+ * default, only last nodes (nodes not referenced by other nodes) contribute to
7088
+ * outputs. Set this to true to also include intermediate nodes in the final
7089
+ * output. Note: This should only be set to `true` or left undefined.
7090
+ */
7091
+ includeOutputsInWorkflowJob?: true;
7092
+ /**
7093
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
7094
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
7095
+ * connections may be present as additional inputs.
7096
+ */
7097
+ inputs?: Array<Flow.Input>;
7098
+ /**
7099
+ * Statically-configured items for a List node, or the frozen candidate list of a
7100
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
7101
+ */
7102
+ items?: Array<string>;
7103
+ /**
7104
+ * Zero-based index of the iteration this node copy belongs to. Set on
7105
+ * dynamically-created copies of loop body nodes.
7106
+ */
7107
+ iterationIndex?: number;
7108
+ /**
7109
+ * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
7110
+ * only available for nodes started. A node "Pending" for a running workflow job is
7111
+ * not started.
7112
+ */
7113
+ jobId?: string;
7114
+ /**
7115
+ * The logic of the node. Only available for logic nodes.
7116
+ */
7117
+ logic?: Flow.Logic;
7118
+ /**
7119
+ * The type of the logic for the node. Only available for logic nodes.
7120
+ */
7121
+ logicType?: 'if-else';
7122
+ /**
7123
+ * IDs of the body template nodes that belong to this ForEach loop. At runtime
7124
+ * these templates are cloned once per iteration and marked Skipped. Only available
7125
+ * for ForEach nodes.
7126
+ */
7127
+ loopBodyNodeIds?: Array<string>;
7128
+ /**
7129
+ * ID of the ForEach node that spawned this iteration copy. Set on
7130
+ * dynamically-created copies of loop body nodes.
7131
+ */
7132
+ loopNodeId?: string;
7133
+ /**
7134
+ * The model id for the node. Mainly used for custom model tasks.
7135
+ */
7136
+ modelId?: string;
7137
+ /**
7138
+ * The output of the node. Only available for logic nodes.
7139
+ */
7140
+ output?: unknown;
7141
+ /**
7142
+ * The workflow id for the node. Mainly used for workflow tasks.
7143
+ */
7144
+ workflowId?: string;
7145
+ }
7146
+ namespace Flow {
7147
+ interface Asset {
7148
+ assetId: string;
7149
+ url: string;
7150
+ }
7151
+ /**
7152
+ * This is used to run the flow.
7153
+ */
7154
+ interface Input {
7155
+ /**
7156
+ * The name that must be user to call the model through the API
7157
+ */
7158
+ name: string;
7159
+ /**
7160
+ * The data type of the input
7161
+ */
7162
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
7163
+ /**
7164
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
7165
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
7166
+ * dropdown.
7167
+ */
7168
+ allowedValues?: Array<unknown>;
7169
+ /**
7170
+ * Specifies the background behavior for the input. Only available for \`file\` and
7171
+ * \`file_array\` input types with kind \`image\`.
7172
+ */
7173
+ backgroundBehavior?: 'opaque' | 'transparent';
7174
+ /**
7175
+ * Whether the input is a color or not. Only available for \`string\` input type.
7176
+ */
7177
+ color?: boolean;
7178
+ /**
7179
+ * Whether this input affects the model's cost calculation
7180
+ */
7181
+ costImpact?: boolean;
7182
+ /**
7183
+ * The default value for the input
7184
+ */
7185
+ default?: unknown;
7186
+ /**
7187
+ * Help text displayed in the UI to provide additional information about the input
7188
+ */
7189
+ description?: string;
7190
+ /**
7191
+ * Used to visually group inputs together in the UI. Inputs with the same group
7192
+ * value appear consecutively in the UI.
7193
+ */
7194
+ group?: string;
7195
+ /**
7196
+ * Hint text displayed in the UI as a tooltip to guide the user
7197
+ */
7198
+ hint?: string;
7199
+ /**
7200
+ * The list of inputs which form an object within a container array. All inputs are
7201
+ * the same as the current object. This is only available for type inputs_array
7202
+ * inputs.
7203
+ */
7204
+ inputs?: Array<{
7205
+ [key: string]: unknown;
7206
+ }>;
7207
+ /**
7208
+ * The configured items for inputs_array type inputs. Each item is an array of
7209
+ * SubNodeInput that need ref/value resolution. Only available for inputs_array
7210
+ * type.
7211
+ */
7212
+ items?: Array<Array<Input.Item>>;
7213
+ /**
7214
+ * The asset kind of the input. Only taken into account for \`file\` and
7215
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
7216
+ * not able to create the asset on the flight on API side with dataurl without
7217
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
7218
+ * a model does not declare one, \`image\` is returned, which is the kind used at
7219
+ * generation time.
7220
+ */
7221
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
7222
+ /**
7223
+ * The label displayed in the UI for this input
7224
+ */
7225
+ label?: string;
7226
+ /**
7227
+ * The name of the file input field to use as the mask source
7228
+ */
7229
+ maskFrom?: string;
7230
+ /**
7231
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
7232
+ * types.
7233
+ */
7234
+ max?: number;
7235
+ /**
7236
+ * The maximum allowed media duration in seconds. Only applies to \`file\` and
7237
+ * \`file_array\` input types for video and audio assets. Validated against
7238
+ * \`asset.properties.duration\` at job creation time.
7239
+ */
7240
+ maxDuration?: number;
7241
+ /**
7242
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
7243
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7244
+ * ITEMS instead — the length of each item is not constrained.
7245
+ */
7246
+ maxLength?: number;
7247
+ /**
7248
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
7249
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
7250
+ * creation time.
7251
+ */
7252
+ maxSize?: number;
7253
+ /**
7254
+ * The minimum allowed value. Only available for \`number\` and array input types.
7255
+ */
7256
+ min?: number;
7257
+ /**
7258
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
7259
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7260
+ * ITEMS instead — the length of each item is not constrained.
7261
+ */
7262
+ minLength?: number;
7263
+ /**
7264
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
7265
+ * available for \`model_array\` input type.
7266
+ */
7267
+ modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
7268
+ /**
7269
+ * Whether this input represents a parent asset to assign to the produced assets.
7270
+ * Only available for \`file\` and \`file_array\` input types.
7271
+ *
7272
+ * For \`file_array\`, the parent asset is the first item in the array.
7273
+ */
7274
+ parent?: boolean;
7275
+ /**
7276
+ * Placeholder text for the input. Only available for 'string' input type.
7277
+ */
7278
+ placeholder?: string;
7279
+ /**
7280
+ * Whether the input is a prompt. When true, displays as a text area with prompt
7281
+ * spark feature. Only available for \`string\` input type.
7282
+ */
7283
+ prompt?: boolean;
7284
+ /**
7285
+ * Whether the input is used with prompt spark. Only available for \`string\` input
7286
+ * type.
7287
+ */
7288
+ promptSpark?: boolean;
7289
+ /**
7290
+ * The reference to another input or output of the same workflow. Must have at
7291
+ * least one of node or conditional.
7292
+ */
7293
+ ref?: Input.Ref;
7294
+ /**
7295
+ * Set of rules that describes when this input is required:
7296
+ *
7297
+ * - \`always\`: Input is always required
7298
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7299
+ * defined
7300
+ * - \`ifDefined\`: Input is required when another specified input is defined
7301
+ * - \`conditional\`: Input is required when other inputs have specific values
7302
+ *
7303
+ * By default, the input is not required.
7304
+ */
7305
+ required?: Input.Required;
7306
+ /**
7307
+ * The step increment for numeric inputs. Only available for \`number\` input type.
7308
+ */
7309
+ step?: number;
7310
+ /**
7311
+ * The value of the input. This is the value of the input that will be used to run
7312
+ * the node. Only available for flows managed by a WorkflowJob.
7313
+ */
7314
+ value?: unknown;
7315
+ }
7316
+ namespace Input {
7317
+ /**
7318
+ * A sub-input within an inputs_array item. Same as NodeInput but without the
7319
+ * recursive items field.
7320
+ */
7321
+ interface Item {
7322
+ /**
7323
+ * The name that must be user to call the model through the API
7324
+ */
7325
+ name: string;
7326
+ /**
7327
+ * The data type of the input
7328
+ */
7329
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
7330
+ /**
7331
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
7332
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
7333
+ * dropdown.
7334
+ */
7335
+ allowedValues?: Array<unknown>;
7336
+ /**
7337
+ * Specifies the background behavior for the input. Only available for \`file\` and
7338
+ * \`file_array\` input types with kind \`image\`.
7339
+ */
7340
+ backgroundBehavior?: 'opaque' | 'transparent';
7341
+ /**
7342
+ * Whether the input is a color or not. Only available for \`string\` input type.
7343
+ */
7344
+ color?: boolean;
7345
+ /**
7346
+ * Whether this input affects the model's cost calculation
7347
+ */
7348
+ costImpact?: boolean;
7349
+ /**
7350
+ * The default value for the input
7351
+ */
7352
+ default?: unknown;
7353
+ /**
7354
+ * Help text displayed in the UI to provide additional information about the input
7355
+ */
7356
+ description?: string;
7357
+ /**
7358
+ * Used to visually group inputs together in the UI. Inputs with the same group
7359
+ * value appear consecutively in the UI.
7360
+ */
7361
+ group?: string;
7362
+ /**
7363
+ * Hint text displayed in the UI as a tooltip to guide the user
7364
+ */
7365
+ hint?: string;
7366
+ /**
7367
+ * The list of inputs which form an object within a container array. All inputs are
7368
+ * the same as the current object. This is only available for type inputs_array
7369
+ * inputs.
7370
+ */
7371
+ inputs?: Array<{
7372
+ [key: string]: unknown;
7373
+ }>;
7374
+ /**
7375
+ * The asset kind of the input. Only taken into account for \`file\` and
7376
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
7377
+ * not able to create the asset on the flight on API side with dataurl without
7378
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
7379
+ * a model does not declare one, \`image\` is returned, which is the kind used at
7380
+ * generation time.
7381
+ */
7382
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
7383
+ /**
7384
+ * The label displayed in the UI for this input
7385
+ */
7386
+ label?: string;
7387
+ /**
7388
+ * The name of the file input field to use as the mask source
7389
+ */
7390
+ maskFrom?: string;
7391
+ /**
7392
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
7393
+ * types.
7394
+ */
7395
+ max?: number;
7396
+ /**
7397
+ * The maximum allowed media duration in seconds. Only applies to \`file\` and
7398
+ * \`file_array\` input types for video and audio assets. Validated against
7399
+ * \`asset.properties.duration\` at job creation time.
7400
+ */
7401
+ maxDuration?: number;
7402
+ /**
7403
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
7404
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7405
+ * ITEMS instead — the length of each item is not constrained.
7406
+ */
7407
+ maxLength?: number;
7408
+ /**
7409
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
7410
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
7411
+ * creation time.
7412
+ */
7413
+ maxSize?: number;
7414
+ /**
7415
+ * The minimum allowed value. Only available for \`number\` and array input types.
7416
+ */
7417
+ min?: number;
7418
+ /**
7419
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
7420
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7421
+ * ITEMS instead — the length of each item is not constrained.
7422
+ */
7423
+ minLength?: number;
7424
+ /**
7425
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
7426
+ * available for \`model_array\` input type.
7427
+ */
7428
+ modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
7429
+ /**
7430
+ * Whether this input represents a parent asset to assign to the produced assets.
7431
+ * Only available for \`file\` and \`file_array\` input types.
7432
+ *
7433
+ * For \`file_array\`, the parent asset is the first item in the array.
7434
+ */
7435
+ parent?: boolean;
7436
+ /**
7437
+ * Placeholder text for the input. Only available for 'string' input type.
7438
+ */
7439
+ placeholder?: string;
7440
+ /**
7441
+ * Whether the input is a prompt. When true, displays as a text area with prompt
7442
+ * spark feature. Only available for \`string\` input type.
7443
+ */
7444
+ prompt?: boolean;
7445
+ /**
7446
+ * Whether the input is used with prompt spark. Only available for \`string\` input
7447
+ * type.
7448
+ */
7449
+ promptSpark?: boolean;
7450
+ /**
7451
+ * The reference to another input or output of the same workflow. Must have at
7452
+ * least one of node or conditional.
7453
+ */
7454
+ ref?: Item.Ref;
7455
+ /**
7456
+ * Set of rules that describes when this input is required:
7457
+ *
7458
+ * - \`always\`: Input is always required
7459
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7460
+ * defined
7461
+ * - \`ifDefined\`: Input is required when another specified input is defined
7462
+ * - \`conditional\`: Input is required when other inputs have specific values
7463
+ *
7464
+ * By default, the input is not required.
7465
+ */
7466
+ required?: Item.Required;
7467
+ /**
7468
+ * The step increment for numeric inputs. Only available for \`number\` input type.
7469
+ */
7470
+ step?: number;
7471
+ /**
7472
+ * The value of the input. This is the value of the input that will be used to run
7473
+ * the node. Only available for flows managed by a WorkflowJob.
7474
+ */
7475
+ value?: unknown;
7476
+ }
7477
+ namespace Item {
7478
+ /**
7479
+ * The reference to another input or output of the same workflow. Must have at
7480
+ * least one of node or conditional.
7481
+ */
7482
+ interface Ref {
7483
+ /**
7484
+ * The conditional nodes to reference. If the conditional nodes are successful, the
7485
+ * node will be successful. If the conditional nodes are skipped, the node will be
7486
+ * skipped. Contains an array of node ids used to check the status of the nodes.
7487
+ */
7488
+ conditional?: Array<string>;
7489
+ /**
7490
+ * This is the desired node output value if ref is an if/else node.
7491
+ */
7492
+ equal?: string;
7493
+ /**
7494
+ * The name of the input or output to reference. If the type is 'workflow', the
7495
+ * name is the name of the input of the workflow is required If the type is 'node',
7496
+ * the name is not mandatory, except if you want all outputs of the node. To get
7497
+ * all outputs of a node, you can use the name 'all'.
7498
+ */
7499
+ name?: string;
7500
+ /**
7501
+ * The node id or 'workflow' if the source is a workflow input.
7502
+ */
7503
+ node?: string;
7504
+ }
7505
+ /**
7506
+ * Set of rules that describes when this input is required:
7507
+ *
7508
+ * - \`always\`: Input is always required
7509
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7510
+ * defined
7511
+ * - \`ifDefined\`: Input is required when another specified input is defined
7512
+ * - \`conditional\`: Input is required when other inputs have specific values
7513
+ *
7514
+ * By default, the input is not required.
7515
+ */
7516
+ interface Required {
7517
+ /**
7518
+ * Whether the input is always required
7519
+ */
7520
+ always?: boolean;
7521
+ /**
7522
+ * Makes this input required when other inputs have one of the listed values
7523
+ */
7524
+ conditional?: Required.Conditional;
7525
+ /**
7526
+ * Makes this input required when another input is defined:
7527
+ *
7528
+ * - Key: name of the input that must be defined
7529
+ * - Value: message to display when this input is required
7530
+ */
7531
+ ifDefined?: unknown;
7532
+ /**
7533
+ * Makes this input required when another input is not defined:
7534
+ *
7535
+ * - Key: name of the input that must be undefined
7536
+ * - Value: message to display when this input is required
7537
+ */
7538
+ ifNotDefined?: unknown;
7539
+ }
7540
+ namespace Required {
7541
+ /**
7542
+ * Makes this input required when other inputs have one of the listed values
7543
+ */
7544
+ interface Conditional {
7545
+ /**
7546
+ * The conditions to check:
7547
+ *
7548
+ * - Key: name of the input to check
7549
+ * - Value: values of that input that satisfy the condition
7550
+ */
7551
+ values: unknown;
7552
+ /**
7553
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
7554
+ */
7555
+ operator?: 'and' | 'or';
7556
+ }
7557
+ }
7558
+ }
7559
+ /**
7560
+ * The reference to another input or output of the same workflow. Must have at
7561
+ * least one of node or conditional.
7562
+ */
7563
+ interface Ref {
7564
+ /**
7565
+ * The conditional nodes to reference. If the conditional nodes are successful, the
7566
+ * node will be successful. If the conditional nodes are skipped, the node will be
7567
+ * skipped. Contains an array of node ids used to check the status of the nodes.
7568
+ */
7569
+ conditional?: Array<string>;
7570
+ /**
7571
+ * This is the desired node output value if ref is an if/else node.
7572
+ */
7573
+ equal?: string;
7574
+ /**
7575
+ * The name of the input or output to reference. If the type is 'workflow', the
7576
+ * name is the name of the input of the workflow is required If the type is 'node',
7577
+ * the name is not mandatory, except if you want all outputs of the node. To get
7578
+ * all outputs of a node, you can use the name 'all'.
7579
+ */
7580
+ name?: string;
7581
+ /**
7582
+ * The node id or 'workflow' if the source is a workflow input.
7583
+ */
7584
+ node?: string;
7585
+ }
7586
+ /**
7587
+ * Set of rules that describes when this input is required:
7588
+ *
7589
+ * - \`always\`: Input is always required
7590
+ * - \`ifNotDefined\`: Input is required when another specified input is not
7591
+ * defined
7592
+ * - \`ifDefined\`: Input is required when another specified input is defined
7593
+ * - \`conditional\`: Input is required when other inputs have specific values
7594
+ *
7595
+ * By default, the input is not required.
7596
+ */
7597
+ interface Required {
7598
+ /**
7599
+ * Whether the input is always required
7600
+ */
7601
+ always?: boolean;
7602
+ /**
7603
+ * Makes this input required when other inputs have one of the listed values
7604
+ */
7605
+ conditional?: Required.Conditional;
7606
+ /**
7607
+ * Makes this input required when another input is defined:
7608
+ *
7609
+ * - Key: name of the input that must be defined
7610
+ * - Value: message to display when this input is required
7611
+ */
7612
+ ifDefined?: unknown;
7613
+ /**
7614
+ * Makes this input required when another input is not defined:
7615
+ *
7616
+ * - Key: name of the input that must be undefined
7617
+ * - Value: message to display when this input is required
7618
+ */
7619
+ ifNotDefined?: unknown;
7620
+ }
7621
+ namespace Required {
7622
+ /**
7623
+ * Makes this input required when other inputs have one of the listed values
7624
+ */
7625
+ interface Conditional {
7626
+ /**
7627
+ * The conditions to check:
7628
+ *
7629
+ * - Key: name of the input to check
7630
+ * - Value: values of that input that satisfy the condition
7631
+ */
7632
+ values: unknown;
7633
+ /**
7634
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
7635
+ */
7636
+ operator?: 'and' | 'or';
7637
+ }
7638
+ }
7639
+ }
7640
+ /**
7641
+ * The logic of the node. Only available for logic nodes.
7642
+ */
7643
+ interface Logic {
7644
+ /**
7645
+ * The cases of the logic. Only available for if/else nodes.
7646
+ */
7647
+ cases?: Array<Logic.Case>;
7648
+ /**
7649
+ * The default case of the logic. Contains the id/output of the node to execute if
7650
+ * no case is matched. Only available for if/else nodes.
7651
+ */
7652
+ default?: string;
7653
+ /**
7654
+ * The transform of the logic. Only available for transform nodes.
7655
+ */
7656
+ transform?: string;
7657
+ }
7658
+ namespace Logic {
7659
+ interface Case {
7660
+ condition: string;
7661
+ value: string;
7662
+ }
7663
+ }
7664
+ }
7665
+ }
7666
+ interface StatusHistory {
7667
+ date: string;
7668
+ status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
7669
+ }
7670
+ /**
7671
+ * The billing of the job
7672
+ */
7673
+ interface Billing {
7674
+ cuCost: number;
7675
+ cuDiscount: number;
7676
+ /**
7677
+ * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
7678
+ * top of the generation itself, such as `quality-gate`.
7679
+ *
7680
+ * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
7681
+ * values here.
7682
+ *
7683
+ * Two caveats when displaying it:
7684
+ *
7685
+ * - These are a remaining refundable balance, not a receipt: a job that failed or
7686
+ * was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
7687
+ * still shows the main action's original charge.
7688
+ * - `ip-detection` is part of the shape but is never populated today: that fee is
7689
+ * charged outside the job and reported once, as
7690
+ * `ipDetection.creativeUnitsCharged`, in the response of the request that ran
7691
+ * it.
7692
+ *
7693
+ * Absent when the job paid for no add-on.
7694
+ */
7695
+ cuCostDetails?: Billing.CuCostDetails;
7696
+ /**
7697
+ * When true, the credits charged for this job are not automatically refunded if
7698
+ * the generation fails, because the model used does not support refund-on-failure.
7699
+ * Absent or false means a failed generation is refunded as usual.
7700
+ */
7701
+ disableRefund?: boolean;
7702
+ }
7703
+ namespace Billing {
7704
+ /**
7705
+ * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
7706
+ * top of the generation itself, such as `quality-gate`.
7707
+ *
7708
+ * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
7709
+ * values here.
7710
+ *
7711
+ * Two caveats when displaying it:
7712
+ *
7713
+ * - These are a remaining refundable balance, not a receipt: a job that failed or
7714
+ * was cancelled has had its add-ons refunded, so they read 0 while `cuCost`
7715
+ * still shows the main action's original charge.
7716
+ * - `ip-detection` is part of the shape but is never populated today: that fee is
7717
+ * charged outside the job and reported once, as
7718
+ * `ipDetection.creativeUnitsCharged`, in the response of the request that ran
7719
+ * it.
7720
+ *
7721
+ * Absent when the job paid for no add-on.
7722
+ */
7723
+ interface CuCostDetails {
7724
+ 'ip-detection'?: number;
7725
+ 'quality-gate'?: number;
7726
+ }
7727
+ }
7728
+ }
7729
+ }
7730
+ export interface WorkflowCreateParams {
7731
+ /**
7732
+ * Body param
7733
+ */
7734
+ description: string;
7735
+ /**
7736
+ * Body param
7737
+ */
7738
+ name: string;
7739
+ /**
7740
+ * Query param: The projectId used for ownership resource management. Either to
7741
+ * assert ownership or to set the owner of the resource(s)
7742
+ */
7743
+ projectId?: string;
7744
+ }
7745
+ export interface WorkflowRetrieveParams {
7746
+ /**
7747
+ * The projectId used for ownership resource management. Either to assert ownership
7748
+ * or to set the owner of the resource(s)
7749
+ */
7750
+ projectId?: string;
6592
7751
  }
6593
7752
  export interface WorkflowUpdateParams {
6594
7753
  /**
6595
- * Query param
7754
+ * Query param: The projectId used for ownership resource management. Either to
7755
+ * assert ownership or to set the owner of the resource(s)
6596
7756
  */
6597
- projectId?: unknown;
7757
+ projectId?: string;
6598
7758
  /**
6599
7759
  * Body param: The after asset of the workflow. Set to null to unset the after
6600
7760
  * asset.
@@ -6674,7 +7834,7 @@ export declare namespace WorkflowUpdateParams {
6674
7834
  /**
6675
7835
  * The type of the job for the node.
6676
7836
  */
6677
- type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
7837
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'user-selection' | 'workflow';
6678
7838
  /**
6679
7839
  * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
6680
7840
  * `count` times regardless of array input. When not set, the loop iterates over
@@ -6695,13 +7855,14 @@ export declare namespace WorkflowUpdateParams {
6695
7855
  */
6696
7856
  includeOutputsInWorkflowJob?: true;
6697
7857
  /**
6698
- * The inputs of the node.
7858
+ * The inputs of the node. For a user-selection node, the array input's `min`/`max`
7859
+ * bound how many items the user may pick (defaults: 1 and 100); conditional
7860
+ * connections may be present as additional inputs.
6699
7861
  */
6700
7862
  inputs?: Array<Flow.Input>;
6701
7863
  /**
6702
- * Statically-configured items for a List node. The node outputs this array as-is
6703
- * when executed. Only available for List nodes. The values can be strings,
6704
- * numbers, or asset IDs.
7864
+ * Statically-configured items for a List node, or the frozen candidate list of a
7865
+ * UserSelection node. The values can be strings, numbers, or asset IDs.
6705
7866
  */
6706
7867
  items?: Array<string>;
6707
7868
  /**
@@ -6804,7 +7965,9 @@ export declare namespace WorkflowUpdateParams {
6804
7965
  * The asset kind of the input. Only taken into account for \`file\` and
6805
7966
  * \`file_array\` input types. If model provides multiple kinds, the input will be
6806
7967
  * not able to create the asset on the flight on API side with dataurl without
6807
- * data:kind, prefix
7968
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
7969
+ * a model does not declare one, \`image\` is returned, which is the kind used at
7970
+ * generation time.
6808
7971
  */
6809
7972
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
6810
7973
  /**
@@ -6827,8 +7990,9 @@ export declare namespace WorkflowUpdateParams {
6827
7990
  */
6828
7991
  maxDuration?: number;
6829
7992
  /**
6830
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
6831
- * \`string_array\`.
7993
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
7994
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
7995
+ * ITEMS instead — the length of each item is not constrained.
6832
7996
  */
6833
7997
  maxLength?: number;
6834
7998
  /**
@@ -6842,8 +8006,9 @@ export declare namespace WorkflowUpdateParams {
6842
8006
  */
6843
8007
  min?: number;
6844
8008
  /**
6845
- * The minimum allowed length for string inputs. Also applies to each item in
6846
- * \`string_array\`.
8009
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
8010
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
8011
+ * ITEMS instead — the length of each item is not constrained.
6847
8012
  */
6848
8013
  minLength?: number;
6849
8014
  /**
@@ -6884,8 +8049,7 @@ export declare namespace WorkflowUpdateParams {
6884
8049
  * - \`ifNotDefined\`: Input is required when another specified input is not
6885
8050
  * defined
6886
8051
  * - \`ifDefined\`: Input is required when another specified input is defined
6887
- * - \`conditionalValues\`: Input is required when another input has a specific
6888
- * value
8052
+ * - \`conditional\`: Input is required when other inputs have specific values
6889
8053
  *
6890
8054
  * By default, the input is not required.
6891
8055
  */
@@ -6962,7 +8126,9 @@ export declare namespace WorkflowUpdateParams {
6962
8126
  * The asset kind of the input. Only taken into account for \`file\` and
6963
8127
  * \`file_array\` input types. If model provides multiple kinds, the input will be
6964
8128
  * not able to create the asset on the flight on API side with dataurl without
6965
- * data:kind, prefix
8129
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
8130
+ * a model does not declare one, \`image\` is returned, which is the kind used at
8131
+ * generation time.
6966
8132
  */
6967
8133
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
6968
8134
  /**
@@ -6985,8 +8151,9 @@ export declare namespace WorkflowUpdateParams {
6985
8151
  */
6986
8152
  maxDuration?: number;
6987
8153
  /**
6988
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
6989
- * \`string_array\`.
8154
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
8155
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
8156
+ * ITEMS instead — the length of each item is not constrained.
6990
8157
  */
6991
8158
  maxLength?: number;
6992
8159
  /**
@@ -7000,8 +8167,9 @@ export declare namespace WorkflowUpdateParams {
7000
8167
  */
7001
8168
  min?: number;
7002
8169
  /**
7003
- * The minimum allowed length for string inputs. Also applies to each item in
7004
- * \`string_array\`.
8170
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
8171
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
8172
+ * ITEMS instead — the length of each item is not constrained.
7005
8173
  */
7006
8174
  minLength?: number;
7007
8175
  /**
@@ -7042,8 +8210,7 @@ export declare namespace WorkflowUpdateParams {
7042
8210
  * - \`ifNotDefined\`: Input is required when another specified input is not
7043
8211
  * defined
7044
8212
  * - \`ifDefined\`: Input is required when another specified input is defined
7045
- * - \`conditionalValues\`: Input is required when another input has a specific
7046
- * value
8213
+ * - \`conditional\`: Input is required when other inputs have specific values
7047
8214
  *
7048
8215
  * By default, the input is not required.
7049
8216
  */
@@ -7093,8 +8260,7 @@ export declare namespace WorkflowUpdateParams {
7093
8260
  * - \`ifNotDefined\`: Input is required when another specified input is not
7094
8261
  * defined
7095
8262
  * - \`ifDefined\`: Input is required when another specified input is defined
7096
- * - \`conditionalValues\`: Input is required when another input has a specific
7097
- * value
8263
+ * - \`conditional\`: Input is required when other inputs have specific values
7098
8264
  *
7099
8265
  * By default, the input is not required.
7100
8266
  */
@@ -7104,12 +8270,9 @@ export declare namespace WorkflowUpdateParams {
7104
8270
  */
7105
8271
  always?: boolean;
7106
8272
  /**
7107
- * Makes this input required when another input has a specific value:
7108
- *
7109
- * - Key: name of the input to check
7110
- * - Value: operation and allowed values that trigger the requirement
8273
+ * Makes this input required when other inputs have one of the listed values
7111
8274
  */
7112
- conditionalValues?: unknown;
8275
+ conditional?: Required.Conditional;
7113
8276
  /**
7114
8277
  * Makes this input required when another input is defined:
7115
8278
  *
@@ -7125,6 +8288,24 @@ export declare namespace WorkflowUpdateParams {
7125
8288
  */
7126
8289
  ifNotDefined?: unknown;
7127
8290
  }
8291
+ namespace Required {
8292
+ /**
8293
+ * Makes this input required when other inputs have one of the listed values
8294
+ */
8295
+ interface Conditional {
8296
+ /**
8297
+ * The conditions to check:
8298
+ *
8299
+ * - Key: name of the input to check
8300
+ * - Value: values of that input that satisfy the condition
8301
+ */
8302
+ values: unknown;
8303
+ /**
8304
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8305
+ */
8306
+ operator?: 'and' | 'or';
8307
+ }
8308
+ }
7128
8309
  }
7129
8310
  /**
7130
8311
  * The reference to another input or output of the same workflow. Must have at
@@ -7160,8 +8341,7 @@ export declare namespace WorkflowUpdateParams {
7160
8341
  * - \`ifNotDefined\`: Input is required when another specified input is not
7161
8342
  * defined
7162
8343
  * - \`ifDefined\`: Input is required when another specified input is defined
7163
- * - \`conditionalValues\`: Input is required when another input has a specific
7164
- * value
8344
+ * - \`conditional\`: Input is required when other inputs have specific values
7165
8345
  *
7166
8346
  * By default, the input is not required.
7167
8347
  */
@@ -7171,12 +8351,9 @@ export declare namespace WorkflowUpdateParams {
7171
8351
  */
7172
8352
  always?: boolean;
7173
8353
  /**
7174
- * Makes this input required when another input has a specific value:
7175
- *
7176
- * - Key: name of the input to check
7177
- * - Value: operation and allowed values that trigger the requirement
8354
+ * Makes this input required when other inputs have one of the listed values
7178
8355
  */
7179
- conditionalValues?: unknown;
8356
+ conditional?: Required.Conditional;
7180
8357
  /**
7181
8358
  * Makes this input required when another input is defined:
7182
8359
  *
@@ -7192,6 +8369,24 @@ export declare namespace WorkflowUpdateParams {
7192
8369
  */
7193
8370
  ifNotDefined?: unknown;
7194
8371
  }
8372
+ namespace Required {
8373
+ /**
8374
+ * Makes this input required when other inputs have one of the listed values
8375
+ */
8376
+ interface Conditional {
8377
+ /**
8378
+ * The conditions to check:
8379
+ *
8380
+ * - Key: name of the input to check
8381
+ * - Value: values of that input that satisfy the condition
8382
+ */
8383
+ values: unknown;
8384
+ /**
8385
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8386
+ */
8387
+ operator?: 'and' | 'or';
8388
+ }
8389
+ }
7195
8390
  }
7196
8391
  /**
7197
8392
  * The logic of the node. Only available for logic nodes.
@@ -7281,7 +8476,9 @@ export declare namespace WorkflowUpdateParams {
7281
8476
  * The asset kind of the input. Only taken into account for \`file\` and
7282
8477
  * \`file_array\` input types. If model provides multiple kinds, the input will be
7283
8478
  * not able to create the asset on the flight on API side with dataurl without
7284
- * data:kind, prefix
8479
+ * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
8480
+ * a model does not declare one, \`image\` is returned, which is the kind used at
8481
+ * generation time.
7285
8482
  */
7286
8483
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
7287
8484
  /**
@@ -7304,8 +8501,9 @@ export declare namespace WorkflowUpdateParams {
7304
8501
  */
7305
8502
  maxDuration?: number;
7306
8503
  /**
7307
- * The maximum allowed length for \`string\` inputs. Also applies to each item in
7308
- * \`string_array\`.
8504
+ * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
8505
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
8506
+ * ITEMS instead — the length of each item is not constrained.
7309
8507
  */
7310
8508
  maxLength?: number;
7311
8509
  /**
@@ -7319,8 +8517,9 @@ export declare namespace WorkflowUpdateParams {
7319
8517
  */
7320
8518
  min?: number;
7321
8519
  /**
7322
- * The minimum allowed length for string inputs. Also applies to each item in
7323
- * \`string_array\`.
8520
+ * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
8521
+ * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
8522
+ * ITEMS instead — the length of each item is not constrained.
7324
8523
  */
7325
8524
  minLength?: number;
7326
8525
  /**
@@ -7356,8 +8555,7 @@ export declare namespace WorkflowUpdateParams {
7356
8555
  * - \`ifNotDefined\`: Input is required when another specified input is not
7357
8556
  * defined
7358
8557
  * - \`ifDefined\`: Input is required when another specified input is defined
7359
- * - \`conditionalValues\`: Input is required when another input has a specific
7360
- * value
8558
+ * - \`conditional\`: Input is required when other inputs have specific values
7361
8559
  *
7362
8560
  * By default, the input is not required.
7363
8561
  */
@@ -7375,8 +8573,7 @@ export declare namespace WorkflowUpdateParams {
7375
8573
  * - \`ifNotDefined\`: Input is required when another specified input is not
7376
8574
  * defined
7377
8575
  * - \`ifDefined\`: Input is required when another specified input is defined
7378
- * - \`conditionalValues\`: Input is required when another input has a specific
7379
- * value
8576
+ * - \`conditional\`: Input is required when other inputs have specific values
7380
8577
  *
7381
8578
  * By default, the input is not required.
7382
8579
  */
@@ -7386,12 +8583,9 @@ export declare namespace WorkflowUpdateParams {
7386
8583
  */
7387
8584
  always?: boolean;
7388
8585
  /**
7389
- * Makes this input required when another input has a specific value:
7390
- *
7391
- * - Key: name of the input to check
7392
- * - Value: operation and allowed values that trigger the requirement
8586
+ * Makes this input required when other inputs have one of the listed values
7393
8587
  */
7394
- conditionalValues?: unknown;
8588
+ conditional?: Required.Conditional;
7395
8589
  /**
7396
8590
  * Makes this input required when another input is defined:
7397
8591
  *
@@ -7407,6 +8601,24 @@ export declare namespace WorkflowUpdateParams {
7407
8601
  */
7408
8602
  ifNotDefined?: unknown;
7409
8603
  }
8604
+ namespace Required {
8605
+ /**
8606
+ * Makes this input required when other inputs have one of the listed values
8607
+ */
8608
+ interface Conditional {
8609
+ /**
8610
+ * The conditions to check:
8611
+ *
8612
+ * - Key: name of the input to check
8613
+ * - Value: values of that input that satisfy the condition
8614
+ */
8615
+ values: unknown;
8616
+ /**
8617
+ * How the conditions combine: \`and\` (all must match) or \`or\` (any must match)
8618
+ */
8619
+ operator?: 'and' | 'or';
8620
+ }
8621
+ }
7410
8622
  }
7411
8623
  }
7412
8624
  export interface WorkflowListParams extends WorkflowsCursorParams {
@@ -7445,10 +8657,18 @@ export interface WorkflowListParams extends WorkflowsCursorParams {
7445
8657
  * private, `ready` for public.
7446
8658
  */
7447
8659
  status?: 'draft' | 'ready';
7448
- tags?: unknown;
8660
+ /**
8661
+ * The tags of the workflows to return, separated by commas. Example:
8662
+ * `tag1,tag2,tag3` or `tag1`. Optional.
8663
+ */
8664
+ tags?: string;
7449
8665
  }
7450
8666
  export interface WorkflowDeleteParams {
7451
- projectId?: unknown;
8667
+ /**
8668
+ * The projectId used for ownership resource management. Either to assert ownership
8669
+ * or to set the owner of the resource(s)
8670
+ */
8671
+ projectId?: string;
7452
8672
  }
7453
8673
  export interface WorkflowGetTagsParams {
7454
8674
  /**
@@ -7456,7 +8676,10 @@ export interface WorkflowGetTagsParams {
7456
8676
  * or to set the owner of the resource(s)
7457
8677
  */
7458
8678
  projectId?: string;
7459
- status?: unknown;
8679
+ /**
8680
+ * Only collect tags from workflows in this status. Default `ready`.
8681
+ */
8682
+ status?: 'draft' | 'ready' | 'deleted';
7460
8683
  }
7461
8684
  export interface WorkflowRunParams {
7462
8685
  /**
@@ -7465,19 +8688,22 @@ export interface WorkflowRunParams {
7465
8688
  */
7466
8689
  body: unknown;
7467
8690
  /**
7468
- * Query param
8691
+ * Query param: Estimate the operation instead of running it: the call returns a
8692
+ * 269 response carrying the creative units cost. `api` estimates at the API tier.
7469
8693
  */
7470
- dryRun?: unknown;
8694
+ dryRun?: 'true' | 'api';
7471
8695
  /**
7472
- * Query param
8696
+ * Query param: The projectId used for ownership resource management. Either to
8697
+ * assert ownership or to set the owner of the resource(s)
7473
8698
  */
7474
- projectId?: unknown;
8699
+ projectId?: string;
7475
8700
  }
7476
8701
  export interface WorkflowUserApprovalParams {
7477
8702
  /**
7478
- * Query param
8703
+ * Query param: The projectId used for ownership resource management. Either to
8704
+ * assert ownership or to set the owner of the resource(s)
7479
8705
  */
7480
- projectId: unknown;
8706
+ projectId: string;
7481
8707
  /**
7482
8708
  * Body param: The ID of the user approval node to act on in the workflow
7483
8709
  */
@@ -7494,11 +8720,39 @@ export interface WorkflowUserApprovalParams {
7494
8720
  */
7495
8721
  action?: 'approve' | 'reject';
7496
8722
  }
8723
+ export interface WorkflowUserSelectionParams {
8724
+ /**
8725
+ * Query param: The projectId used for ownership resource management. Either to
8726
+ * assert ownership or to set the owner of the resource(s)
8727
+ */
8728
+ projectId: string;
8729
+ /**
8730
+ * Body param: Decision taken on the selection node. "select" persists the picked
8731
+ * items and advances the workflow; "reject" marks it Rejected and cancels the
8732
+ * workflow.
8733
+ */
8734
+ action: 'select' | 'reject';
8735
+ /**
8736
+ * Body param: The ID of the user selection node to act on in the workflow
8737
+ */
8738
+ nodeId: string;
8739
+ /**
8740
+ * Body param: The ID of the workflow job that contains the user selection node
8741
+ */
8742
+ workflowJobId: string;
8743
+ /**
8744
+ * Body param: Zero-based indices into the node's `items` (the candidate list
8745
+ * frozen when the node started processing). Required when action is "select".
8746
+ * Order is preserved in the node output.
8747
+ */
8748
+ selectedIndices?: Array<number>;
8749
+ }
7497
8750
  export interface WorkflowApproveUserParams {
7498
8751
  /**
7499
- * Query param
8752
+ * Query param: The projectId used for ownership resource management. Either to
8753
+ * assert ownership or to set the owner of the resource(s)
7500
8754
  */
7501
- projectId: unknown;
8755
+ projectId: string;
7502
8756
  /**
7503
8757
  * Body param: The ID of the user approval node to act on in the workflow
7504
8758
  */
@@ -7516,6 +8770,6 @@ export interface WorkflowApproveUserParams {
7516
8770
  action?: 'approve' | 'reject';
7517
8771
  }
7518
8772
  export declare namespace Workflows {
7519
- export { type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponse as WorkflowListResponse, type WorkflowDeleteResponse as WorkflowDeleteResponse, type WorkflowGetTagsResponse as WorkflowGetTagsResponse, type WorkflowRunResponse as WorkflowRunResponse, type WorkflowUserApprovalResponse as WorkflowUserApprovalResponse, type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, type WorkflowListParams as WorkflowListParams, type WorkflowDeleteParams as WorkflowDeleteParams, type WorkflowGetTagsParams as WorkflowGetTagsParams, type WorkflowRunParams as WorkflowRunParams, type WorkflowUserApprovalParams as WorkflowUserApprovalParams, type WorkflowApproveUserParams as WorkflowApproveUserParams, };
8773
+ export { type WorkflowCreateResponse as WorkflowCreateResponse, type WorkflowRetrieveResponse as WorkflowRetrieveResponse, type WorkflowUpdateResponse as WorkflowUpdateResponse, type WorkflowListResponse as WorkflowListResponse, type WorkflowDeleteResponse as WorkflowDeleteResponse, type WorkflowGetTagsResponse as WorkflowGetTagsResponse, type WorkflowRunResponse as WorkflowRunResponse, type WorkflowUserApprovalResponse as WorkflowUserApprovalResponse, type WorkflowUserSelectionResponse as WorkflowUserSelectionResponse, type WorkflowListResponsesWorkflowsCursor as WorkflowListResponsesWorkflowsCursor, type WorkflowCreateParams as WorkflowCreateParams, type WorkflowRetrieveParams as WorkflowRetrieveParams, type WorkflowUpdateParams as WorkflowUpdateParams, type WorkflowListParams as WorkflowListParams, type WorkflowDeleteParams as WorkflowDeleteParams, type WorkflowGetTagsParams as WorkflowGetTagsParams, type WorkflowRunParams as WorkflowRunParams, type WorkflowUserApprovalParams as WorkflowUserApprovalParams, type WorkflowUserSelectionParams as WorkflowUserSelectionParams, type WorkflowApproveUserParams as WorkflowApproveUserParams, };
7520
8774
  }
7521
8775
  //# sourceMappingURL=workflows.d.ts.map