@scenario-labs/sdk 0.1.3 → 0.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 (243) hide show
  1. package/CHANGELOG.md +49 -0
  2. package/LICENSE +1 -1
  3. package/README.md +29 -27
  4. package/client.d.mts +33 -16
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +33 -16
  7. package/client.d.ts.map +1 -1
  8. package/client.js +88 -50
  9. package/client.js.map +1 -1
  10. package/client.mjs +86 -48
  11. package/client.mjs.map +1 -1
  12. package/core/api-promise.d.mts +2 -2
  13. package/core/api-promise.d.mts.map +1 -1
  14. package/core/api-promise.d.ts +2 -2
  15. package/core/api-promise.d.ts.map +1 -1
  16. package/core/api-promise.js.map +1 -1
  17. package/core/api-promise.mjs.map +1 -1
  18. package/core/error.d.mts +2 -2
  19. package/core/error.d.mts.map +1 -1
  20. package/core/error.d.ts +2 -2
  21. package/core/error.d.ts.map +1 -1
  22. package/core/error.js +4 -4
  23. package/core/error.js.map +1 -1
  24. package/core/error.mjs +2 -2
  25. package/core/error.mjs.map +1 -1
  26. package/core/resource.d.mts +3 -3
  27. package/core/resource.d.mts.map +1 -1
  28. package/core/resource.d.ts +3 -3
  29. package/core/resource.d.ts.map +1 -1
  30. package/core/resource.js.map +1 -1
  31. package/core/resource.mjs.map +1 -1
  32. package/index.d.mts +9 -3
  33. package/index.d.mts.map +1 -1
  34. package/index.d.ts +9 -3
  35. package/index.d.ts.map +1 -1
  36. package/index.js +18 -6
  37. package/index.js.map +1 -1
  38. package/index.mjs +8 -3
  39. package/index.mjs.map +1 -1
  40. package/internal/parse.d.mts +2 -2
  41. package/internal/parse.d.mts.map +1 -1
  42. package/internal/parse.d.ts +2 -2
  43. package/internal/parse.d.ts.map +1 -1
  44. package/internal/parse.js.map +1 -1
  45. package/internal/parse.mjs.map +1 -1
  46. package/internal/request-options.d.mts +4 -0
  47. package/internal/request-options.d.mts.map +1 -1
  48. package/internal/request-options.d.ts +4 -0
  49. package/internal/request-options.d.ts.map +1 -1
  50. package/internal/request-options.js.map +1 -1
  51. package/internal/request-options.mjs.map +1 -1
  52. package/internal/shims.js +1 -1
  53. package/internal/shims.js.map +1 -1
  54. package/internal/shims.mjs +1 -1
  55. package/internal/shims.mjs.map +1 -1
  56. package/internal/uploads.d.mts +4 -4
  57. package/internal/uploads.d.mts.map +1 -1
  58. package/internal/uploads.d.ts +4 -4
  59. package/internal/uploads.d.ts.map +1 -1
  60. package/internal/uploads.js.map +1 -1
  61. package/internal/uploads.mjs.map +1 -1
  62. package/internal/utils/base64.js +2 -2
  63. package/internal/utils/base64.js.map +1 -1
  64. package/internal/utils/base64.mjs +3 -3
  65. package/internal/utils/base64.mjs.map +1 -1
  66. package/internal/utils/log.d.mts +3 -3
  67. package/internal/utils/log.d.mts.map +1 -1
  68. package/internal/utils/log.d.ts +3 -3
  69. package/internal/utils/log.d.ts.map +1 -1
  70. package/internal/utils/log.js.map +1 -1
  71. package/internal/utils/log.mjs.map +1 -1
  72. package/internal/utils/path.js +1 -1
  73. package/internal/utils/path.js.map +1 -1
  74. package/internal/utils/path.mjs +2 -2
  75. package/internal/utils/path.mjs.map +1 -1
  76. package/internal/utils/values.js +5 -5
  77. package/internal/utils/values.js.map +1 -1
  78. package/internal/utils/values.mjs +6 -6
  79. package/internal/utils/values.mjs.map +1 -1
  80. package/lib/generate.d.mts +19 -0
  81. package/lib/generate.d.mts.map +1 -0
  82. package/lib/generate.d.ts +19 -0
  83. package/lib/generate.d.ts.map +1 -0
  84. package/lib/generate.js +35 -0
  85. package/lib/generate.js.map +1 -0
  86. package/lib/generate.mjs +31 -0
  87. package/lib/generate.mjs.map +1 -0
  88. package/lib/job.d.mts +48 -0
  89. package/lib/job.d.mts.map +1 -0
  90. package/lib/job.d.ts +48 -0
  91. package/lib/job.d.ts.map +1 -0
  92. package/lib/job.js +50 -0
  93. package/lib/job.js.map +1 -0
  94. package/lib/job.mjs +45 -0
  95. package/lib/job.mjs.map +1 -0
  96. package/lib/models.d.mts +20 -0
  97. package/lib/models.d.mts.map +1 -0
  98. package/lib/models.d.ts +20 -0
  99. package/lib/models.d.ts.map +1 -0
  100. package/lib/models.js +28 -0
  101. package/lib/models.js.map +1 -0
  102. package/lib/models.mjs +23 -0
  103. package/lib/models.mjs.map +1 -0
  104. package/lib/scenario.d.mts +39 -0
  105. package/lib/scenario.d.mts.map +1 -0
  106. package/lib/scenario.d.ts +39 -0
  107. package/lib/scenario.d.ts.map +1 -0
  108. package/lib/scenario.js +46 -0
  109. package/lib/scenario.js.map +1 -0
  110. package/lib/scenario.mjs +42 -0
  111. package/lib/scenario.mjs.map +1 -0
  112. package/lib/workflow.d.mts +53 -0
  113. package/lib/workflow.d.mts.map +1 -0
  114. package/lib/workflow.d.ts +53 -0
  115. package/lib/workflow.d.ts.map +1 -0
  116. package/lib/workflow.js +67 -0
  117. package/lib/workflow.js.map +1 -0
  118. package/lib/workflow.mjs +62 -0
  119. package/lib/workflow.mjs.map +1 -0
  120. package/lib/workflow_validator.d.mts +22 -0
  121. package/lib/workflow_validator.d.mts.map +1 -0
  122. package/lib/workflow_validator.d.ts +22 -0
  123. package/lib/workflow_validator.d.ts.map +1 -0
  124. package/lib/workflow_validator.js +124 -0
  125. package/lib/workflow_validator.js.map +1 -0
  126. package/lib/workflow_validator.mjs +121 -0
  127. package/lib/workflow_validator.mjs.map +1 -0
  128. package/package.json +13 -3
  129. package/resources/assets/assets.d.mts +399 -88
  130. package/resources/assets/assets.d.mts.map +1 -1
  131. package/resources/assets/assets.d.ts +399 -88
  132. package/resources/assets/assets.d.ts.map +1 -1
  133. package/resources/assets/assets.js.map +1 -1
  134. package/resources/assets/assets.mjs.map +1 -1
  135. package/resources/assets/public.d.mts +30 -27
  136. package/resources/assets/public.d.mts.map +1 -1
  137. package/resources/assets/public.d.ts +30 -27
  138. package/resources/assets/public.d.ts.map +1 -1
  139. package/resources/assets/public.js +2 -2
  140. package/resources/assets/public.js.map +1 -1
  141. package/resources/assets/public.mjs +2 -2
  142. package/resources/assets/public.mjs.map +1 -1
  143. package/resources/collections/collections.d.mts +1 -1
  144. package/resources/collections/collections.d.ts +1 -1
  145. package/resources/generate.d.mts +4188 -1370
  146. package/resources/generate.d.mts.map +1 -1
  147. package/resources/generate.d.ts +4188 -1370
  148. package/resources/generate.d.ts.map +1 -1
  149. package/resources/index.d.mts +1 -1
  150. package/resources/index.d.mts.map +1 -1
  151. package/resources/index.d.ts +1 -1
  152. package/resources/index.d.ts.map +1 -1
  153. package/resources/jobs.d.mts +943 -33
  154. package/resources/jobs.d.mts.map +1 -1
  155. package/resources/jobs.d.ts +943 -33
  156. package/resources/jobs.d.ts.map +1 -1
  157. package/resources/jobs.js +3 -2
  158. package/resources/jobs.js.map +1 -1
  159. package/resources/jobs.mjs +3 -2
  160. package/resources/jobs.mjs.map +1 -1
  161. package/resources/models/description.d.mts +8 -8
  162. package/resources/models/description.d.mts.map +1 -1
  163. package/resources/models/description.d.ts +8 -8
  164. package/resources/models/description.d.ts.map +1 -1
  165. package/resources/models/examples.d.mts +640 -34
  166. package/resources/models/examples.d.mts.map +1 -1
  167. package/resources/models/examples.d.ts +640 -34
  168. package/resources/models/examples.d.ts.map +1 -1
  169. package/resources/models/models.d.mts +1323 -301
  170. package/resources/models/models.d.mts.map +1 -1
  171. package/resources/models/models.d.ts +1323 -301
  172. package/resources/models/models.d.ts.map +1 -1
  173. package/resources/models/models.js.map +1 -1
  174. package/resources/models/models.mjs.map +1 -1
  175. package/resources/models/train.d.mts +718 -90
  176. package/resources/models/train.d.mts.map +1 -1
  177. package/resources/models/train.d.ts +718 -90
  178. package/resources/models/train.d.ts.map +1 -1
  179. package/resources/models/train.js +9 -4
  180. package/resources/models/train.js.map +1 -1
  181. package/resources/models/train.mjs +9 -4
  182. package/resources/models/train.mjs.map +1 -1
  183. package/resources/models/training-images.d.mts +2 -2
  184. package/resources/models/training-images.d.mts.map +1 -1
  185. package/resources/models/training-images.d.ts +2 -2
  186. package/resources/models/training-images.d.ts.map +1 -1
  187. package/resources/search.d.mts +6 -31
  188. package/resources/search.d.mts.map +1 -1
  189. package/resources/search.d.ts +6 -31
  190. package/resources/search.d.ts.map +1 -1
  191. package/resources/search.js +6 -2
  192. package/resources/search.js.map +1 -1
  193. package/resources/search.mjs +6 -2
  194. package/resources/search.mjs.map +1 -1
  195. package/resources/tags.d.mts +1 -1
  196. package/resources/tags.d.ts +1 -1
  197. package/resources/usages.d.mts +401 -16
  198. package/resources/usages.d.mts.map +1 -1
  199. package/resources/usages.d.ts +401 -16
  200. package/resources/usages.d.ts.map +1 -1
  201. package/resources/workflows.d.mts +2738 -101
  202. package/resources/workflows.d.mts.map +1 -1
  203. package/resources/workflows.d.ts +2738 -101
  204. package/resources/workflows.d.ts.map +1 -1
  205. package/src/client.ts +102 -42
  206. package/src/core/api-promise.ts +4 -4
  207. package/src/core/error.ts +2 -2
  208. package/src/core/resource.ts +3 -3
  209. package/src/index.ts +9 -3
  210. package/src/internal/parse.ts +2 -2
  211. package/src/internal/request-options.ts +2 -0
  212. package/src/internal/shims.ts +1 -1
  213. package/src/internal/uploads.ts +5 -5
  214. package/src/internal/utils/base64.ts +3 -3
  215. package/src/internal/utils/log.ts +3 -3
  216. package/src/internal/utils/path.ts +2 -2
  217. package/src/internal/utils/values.ts +6 -6
  218. package/src/lib/generate.ts +77 -0
  219. package/src/lib/job.ts +78 -0
  220. package/src/lib/models.ts +27 -0
  221. package/src/lib/scenario.ts +39 -0
  222. package/src/lib/workflow.ts +99 -0
  223. package/src/lib/workflow_validator.ts +167 -0
  224. package/src/resources/assets/assets.ts +788 -177
  225. package/src/resources/assets/public.ts +151 -29
  226. package/src/resources/collections/collections.ts +1 -1
  227. package/src/resources/generate.ts +6254 -2217
  228. package/src/resources/index.ts +2 -2
  229. package/src/resources/jobs.ts +1355 -26
  230. package/src/resources/models/description.ts +50 -8
  231. package/src/resources/models/examples.ts +906 -56
  232. package/src/resources/models/models.ts +1867 -330
  233. package/src/resources/models/train.ts +976 -98
  234. package/src/resources/models/training-images.ts +2 -2
  235. package/src/resources/search.ts +13 -39
  236. package/src/resources/tags.ts +1 -1
  237. package/src/resources/usages.ts +544 -11
  238. package/src/resources/workflows.ts +4586 -914
  239. package/src/version.ts +1 -1
  240. package/version.d.mts +1 -1
  241. package/version.d.ts +1 -1
  242. package/version.js +1 -1
  243. package/version.mjs +1 -1
@@ -90,7 +90,7 @@ export declare namespace ExampleUpdateResponse {
90
90
  /**
91
91
  * source of the asset
92
92
  */
93
- source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
93
+ source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2img' | 'video2video' | 'voice-clone';
94
94
  /**
95
95
  * The actual status
96
96
  */
@@ -183,7 +183,7 @@ export declare namespace ExampleUpdateResponse {
183
183
  * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
184
184
  * from a text to image model
185
185
  */
186
- type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
186
+ type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2img' | 'video2video' | 'voice-clone';
187
187
  /**
188
188
  * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
189
189
  */
@@ -205,7 +205,7 @@ export declare namespace ExampleUpdateResponse {
205
205
  /**
206
206
  * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
207
207
  */
208
- bbox?: Array<unknown>;
208
+ bbox?: Array<number>;
209
209
  /**
210
210
  * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
211
211
  */
@@ -387,7 +387,7 @@ export declare namespace ExampleUpdateResponse {
387
387
  /**
388
388
  * The type of the generator used
389
389
  */
390
- modelType?: 'custom' | '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' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
390
+ modelType?: '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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
391
391
  name?: string;
392
392
  nbMasks?: number;
393
393
  /**
@@ -426,7 +426,7 @@ export declare namespace ExampleUpdateResponse {
426
426
  * List of points (label, x, y) in the image where label = 0 for background and 1
427
427
  * for object.
428
428
  */
429
- points?: Array<Array<unknown>>;
429
+ points?: Array<Array<number>>;
430
430
  /**
431
431
  * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
432
432
  */
@@ -493,7 +493,8 @@ export declare namespace ExampleUpdateResponse {
493
493
  */
494
494
  scheduler?: string;
495
495
  /**
496
- * The seed used to generate this asset
496
+ * The seed used to generate this asset. <!> Can be a string or a number in some
497
+ * cases <!>.
497
498
  */
498
499
  seed?: string;
499
500
  /**
@@ -645,7 +646,7 @@ export declare namespace ExampleUpdateResponse {
645
646
  /**
646
647
  * Bounding box dimensions [width, height, depth]
647
648
  */
648
- dimensions?: Array<unknown>;
649
+ dimensions?: Array<number>;
649
650
  /**
650
651
  * Duration of the media in seconds
651
652
  */
@@ -943,7 +944,7 @@ export declare namespace ExampleUpdateResponse {
943
944
  * Note: if you use a value that is not supported by the model family, this will
944
945
  * result in an error.
945
946
  */
946
- modality?: 'blur' | 'canny' | 'depth' | 'gray' | 'illusion' | 'lineart' | 'lines' | 'low-quality' | 'normal-map' | 'pose' | 'scribble' | 'seg' | 'sketch' | 'tile';
947
+ modality?: string;
947
948
  /**
948
949
  * The epoch of the model to use for the inference. Only available for Flux Lora
949
950
  * Trained models.
@@ -1045,7 +1046,7 @@ export declare namespace ExampleUpdateResponse {
1045
1046
  /**
1046
1047
  * The type of job
1047
1048
  */
1048
- 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' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
1049
+ 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' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
1049
1050
  /**
1050
1051
  * Metadata of the job with some additional information
1051
1052
  */
@@ -1089,18 +1090,36 @@ export declare namespace ExampleUpdateResponse {
1089
1090
  * List of produced assets for this job
1090
1091
  */
1091
1092
  assetIds?: Array<string>;
1093
+ /**
1094
+ * Eventual error for the job
1095
+ */
1096
+ error?: string | null;
1092
1097
  /**
1093
1098
  * The flow of the job. Only available for workflow jobs.
1094
1099
  */
1095
1100
  flow?: Array<Metadata.Flow>;
1101
+ /**
1102
+ * Actionable hint for the user explaining what went wrong and how to resolve it.
1103
+ */
1104
+ hint?: string;
1096
1105
  /**
1097
1106
  * The inputs for the job
1098
1107
  */
1099
- input?: unknown;
1108
+ input?: {
1109
+ [key: string]: unknown;
1110
+ };
1100
1111
  /**
1101
- * The output of the job
1112
+ * May contain the output of the job for specific custom models jobs. Only
1113
+ * available for custom models which generate non-assets outputs. Example: LLM text
1114
+ * results.
1102
1115
  */
1103
- output?: unknown;
1116
+ output?: {
1117
+ [key: string]: unknown;
1118
+ };
1119
+ /**
1120
+ * For voice-clone jobs: the ID of the model being trained.
1121
+ */
1122
+ outputModelId?: string;
1104
1123
  /**
1105
1124
  * The workflow ID of the job if job is part of a workflow.
1106
1125
  */
@@ -1123,20 +1142,45 @@ export declare namespace ExampleUpdateResponse {
1123
1142
  /**
1124
1143
  * The type of the job for the node.
1125
1144
  */
1126
- type: 'custom-model' | 'generate-prompt' | 'logic' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
1145
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
1127
1146
  /**
1128
1147
  * List of produced assets for this node.
1129
1148
  */
1130
1149
  assets?: Array<Flow.Asset>;
1150
+ /**
1151
+ * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
1152
+ * `count` times regardless of array input. When not set, the loop iterates over
1153
+ * the resolved array input. Only available for ForEach nodes.
1154
+ */
1155
+ count?: number;
1131
1156
  /**
1132
1157
  * The nodes that this node depends on. Only available for nodes that have
1133
1158
  * dependencies. Mainly used for user approval nodes.
1134
1159
  */
1135
1160
  dependsOn?: Array<string>;
1161
+ /**
1162
+ * If true, the outputs of this node will be included in the workflow job's final
1163
+ * output. Only applicable to producing nodes (custom-model, inference, etc.). By
1164
+ * default, only last nodes (nodes not referenced by other nodes) contribute to
1165
+ * outputs. Set this to true to also include intermediate nodes in the final
1166
+ * output. Note: This should only be set to `true` or left undefined.
1167
+ */
1168
+ includeOutputsInWorkflowJob?: true;
1136
1169
  /**
1137
1170
  * The inputs of the node.
1138
1171
  */
1139
1172
  inputs?: Array<Flow.Input>;
1173
+ /**
1174
+ * Statically-configured items for a List node. The node outputs this array as-is
1175
+ * when executed. Only available for List nodes. The values can be strings,
1176
+ * numbers, or asset IDs.
1177
+ */
1178
+ items?: Array<string>;
1179
+ /**
1180
+ * Zero-based index of the iteration this node copy belongs to. Set on
1181
+ * dynamically-created copies of loop body nodes.
1182
+ */
1183
+ iterationIndex?: number;
1140
1184
  /**
1141
1185
  * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
1142
1186
  * only available for nodes started. A node "Pending" for a running workflow job is
@@ -1151,10 +1195,25 @@ export declare namespace ExampleUpdateResponse {
1151
1195
  * The type of the logic for the node. Only available for logic nodes.
1152
1196
  */
1153
1197
  logicType?: 'if-else';
1198
+ /**
1199
+ * IDs of the body template nodes that belong to this ForEach loop. At runtime
1200
+ * these templates are cloned once per iteration and marked Skipped. Only available
1201
+ * for ForEach nodes.
1202
+ */
1203
+ loopBodyNodeIds?: Array<string>;
1204
+ /**
1205
+ * ID of the ForEach node that spawned this iteration copy. Set on
1206
+ * dynamically-created copies of loop body nodes.
1207
+ */
1208
+ loopNodeId?: string;
1154
1209
  /**
1155
1210
  * The model id for the node. Mainly used for custom model tasks.
1156
1211
  */
1157
1212
  modelId?: string;
1213
+ /**
1214
+ * The output of the node. Only available for logic nodes.
1215
+ */
1216
+ output?: unknown;
1158
1217
  /**
1159
1218
  * The workflow id for the node. Mainly used for workflow tasks.
1160
1219
  */
@@ -1196,6 +1255,10 @@ export declare namespace ExampleUpdateResponse {
1196
1255
  * Whether this input affects the model's cost calculation
1197
1256
  */
1198
1257
  costImpact?: boolean;
1258
+ /**
1259
+ * The default value for the input
1260
+ */
1261
+ default?: unknown;
1199
1262
  /**
1200
1263
  * Help text displayed in the UI to provide additional information about the input
1201
1264
  */
@@ -1214,10 +1277,20 @@ export declare namespace ExampleUpdateResponse {
1214
1277
  * the same as the current object. This is only available for type inputs_array
1215
1278
  * inputs.
1216
1279
  */
1217
- inputs?: Array<unknown>;
1280
+ inputs?: Array<{
1281
+ [key: string]: unknown;
1282
+ }>;
1283
+ /**
1284
+ * The configured items for inputs_array type inputs. Each item is an array of
1285
+ * SubNodeInput that need ref/value resolution. Only available for inputs_array
1286
+ * type.
1287
+ */
1288
+ items?: Array<Array<Input.Item>>;
1218
1289
  /**
1219
1290
  * The asset kind of the input. Only taken into account for \`file\` and
1220
- * \`file_array\` input types.
1291
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
1292
+ * not able to create the asset on the flight on API side with dataurl without
1293
+ * data:kind, prefix
1221
1294
  */
1222
1295
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1223
1296
  /**
@@ -1238,6 +1311,12 @@ export declare namespace ExampleUpdateResponse {
1238
1311
  * \`string_array\`.
1239
1312
  */
1240
1313
  maxLength?: number;
1314
+ /**
1315
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
1316
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
1317
+ * creation time.
1318
+ */
1319
+ maxSize?: number;
1241
1320
  /**
1242
1321
  * The minimum allowed value. Only available for \`number\` and array input types.
1243
1322
  */
@@ -1251,7 +1330,7 @@ export declare namespace ExampleUpdateResponse {
1251
1330
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
1252
1331
  * available for \`model_array\` input type.
1253
1332
  */
1254
- modelTypes?: Array<'custom' | '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' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
1333
+ 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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
1255
1334
  /**
1256
1335
  * Whether this input represents a parent asset to assign to the produced assets.
1257
1336
  * Only available for \`file\` and \`file_array\` input types.
@@ -1295,8 +1374,232 @@ export declare namespace ExampleUpdateResponse {
1295
1374
  * The step increment for numeric inputs. Only available for \`number\` input type.
1296
1375
  */
1297
1376
  step?: number;
1377
+ /**
1378
+ * The value of the input. This is the value of the input that will be used to run
1379
+ * the node. Only available for flows managed by a WorkflowJob.
1380
+ */
1381
+ value?: unknown;
1298
1382
  }
1299
1383
  namespace Input {
1384
+ /**
1385
+ * A sub-input within an inputs_array item. Same as NodeInput but without the
1386
+ * recursive items field.
1387
+ */
1388
+ interface Item {
1389
+ /**
1390
+ * The name that must be user to call the model through the API
1391
+ */
1392
+ name: string;
1393
+ /**
1394
+ * The data type of the input
1395
+ */
1396
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
1397
+ /**
1398
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
1399
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
1400
+ * dropdown.
1401
+ */
1402
+ allowedValues?: Array<unknown>;
1403
+ /**
1404
+ * Specifies the background behavior for the input. Only available for \`file\` and
1405
+ * \`file_array\` input types with kind \`image\`.
1406
+ */
1407
+ backgroundBehavior?: 'opaque' | 'transparent';
1408
+ /**
1409
+ * Whether the input is a color or not. Only available for \`string\` input type.
1410
+ */
1411
+ color?: boolean;
1412
+ /**
1413
+ * Whether this input affects the model's cost calculation
1414
+ */
1415
+ costImpact?: boolean;
1416
+ /**
1417
+ * The default value for the input
1418
+ */
1419
+ default?: unknown;
1420
+ /**
1421
+ * Help text displayed in the UI to provide additional information about the input
1422
+ */
1423
+ description?: string;
1424
+ /**
1425
+ * Used to visually group inputs together in the UI. Inputs with the same group
1426
+ * value appear consecutively in the UI.
1427
+ */
1428
+ group?: string;
1429
+ /**
1430
+ * Hint text displayed in the UI as a tooltip to guide the user
1431
+ */
1432
+ hint?: string;
1433
+ /**
1434
+ * The list of inputs which form an object within a container array. All inputs are
1435
+ * the same as the current object. This is only available for type inputs_array
1436
+ * inputs.
1437
+ */
1438
+ inputs?: Array<{
1439
+ [key: string]: unknown;
1440
+ }>;
1441
+ /**
1442
+ * The asset kind of the input. Only taken into account for \`file\` and
1443
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
1444
+ * not able to create the asset on the flight on API side with dataurl without
1445
+ * data:kind, prefix
1446
+ */
1447
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1448
+ /**
1449
+ * The label displayed in the UI for this input
1450
+ */
1451
+ label?: string;
1452
+ /**
1453
+ * The name of the file input field to use as the mask source
1454
+ */
1455
+ maskFrom?: string;
1456
+ /**
1457
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
1458
+ * types.
1459
+ */
1460
+ max?: number;
1461
+ /**
1462
+ * The maximum allowed length for \`string\` inputs. Also applies to each item in
1463
+ * \`string_array\`.
1464
+ */
1465
+ maxLength?: number;
1466
+ /**
1467
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
1468
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
1469
+ * creation time.
1470
+ */
1471
+ maxSize?: number;
1472
+ /**
1473
+ * The minimum allowed value. Only available for \`number\` and array input types.
1474
+ */
1475
+ min?: number;
1476
+ /**
1477
+ * The minimum allowed length for string inputs. Also applies to each item in
1478
+ * \`string_array\`.
1479
+ */
1480
+ minLength?: number;
1481
+ /**
1482
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
1483
+ * available for \`model_array\` input type.
1484
+ */
1485
+ 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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
1486
+ /**
1487
+ * Whether this input represents a parent asset to assign to the produced assets.
1488
+ * Only available for \`file\` and \`file_array\` input types.
1489
+ *
1490
+ * For \`file_array\`, the parent asset is the first item in the array.
1491
+ */
1492
+ parent?: boolean;
1493
+ /**
1494
+ * Placeholder text for the input. Only available for 'string' input type.
1495
+ */
1496
+ placeholder?: string;
1497
+ /**
1498
+ * Whether the input is a prompt. When true, displays as a text area with prompt
1499
+ * spark feature. Only available for \`string\` input type.
1500
+ */
1501
+ prompt?: boolean;
1502
+ /**
1503
+ * Whether the input is used with prompt spark. Only available for \`string\` input
1504
+ * type.
1505
+ */
1506
+ promptSpark?: boolean;
1507
+ /**
1508
+ * The reference to another input or output of the same workflow. Must have at
1509
+ * least one of node or conditional.
1510
+ */
1511
+ ref?: Item.Ref;
1512
+ /**
1513
+ * Set of rules that describes when this input is required:
1514
+ *
1515
+ * - \`always\`: Input is always required
1516
+ * - \`ifNotDefined\`: Input is required when another specified input is not
1517
+ * defined
1518
+ * - \`ifDefined\`: Input is required when another specified input is defined
1519
+ * - \`conditionalValues\`: Input is required when another input has a specific
1520
+ * value
1521
+ *
1522
+ * By default, the input is not required.
1523
+ */
1524
+ required?: Item.Required;
1525
+ /**
1526
+ * The step increment for numeric inputs. Only available for \`number\` input type.
1527
+ */
1528
+ step?: number;
1529
+ /**
1530
+ * The value of the input. This is the value of the input that will be used to run
1531
+ * the node. Only available for flows managed by a WorkflowJob.
1532
+ */
1533
+ value?: unknown;
1534
+ }
1535
+ namespace Item {
1536
+ /**
1537
+ * The reference to another input or output of the same workflow. Must have at
1538
+ * least one of node or conditional.
1539
+ */
1540
+ interface Ref {
1541
+ /**
1542
+ * The conditional nodes to reference. If the conditional nodes are successful, the
1543
+ * node will be successful. If the conditional nodes are skipped, the node will be
1544
+ * skipped. Contains an array of node ids used to check the status of the nodes.
1545
+ */
1546
+ conditional?: Array<string>;
1547
+ /**
1548
+ * This is the desired node output value if ref is an if/else node.
1549
+ */
1550
+ equal?: string;
1551
+ /**
1552
+ * The name of the input or output to reference. If the type is 'workflow', the
1553
+ * name is the name of the input of the workflow is required If the type is 'node',
1554
+ * the name is not mandatory, except if you want all outputs of the node. To get
1555
+ * all outputs of a node, you can use the name 'all'.
1556
+ */
1557
+ name?: string;
1558
+ /**
1559
+ * The node id or 'workflow' if the source is a workflow input.
1560
+ */
1561
+ node?: string;
1562
+ }
1563
+ /**
1564
+ * Set of rules that describes when this input is required:
1565
+ *
1566
+ * - \`always\`: Input is always required
1567
+ * - \`ifNotDefined\`: Input is required when another specified input is not
1568
+ * defined
1569
+ * - \`ifDefined\`: Input is required when another specified input is defined
1570
+ * - \`conditionalValues\`: Input is required when another input has a specific
1571
+ * value
1572
+ *
1573
+ * By default, the input is not required.
1574
+ */
1575
+ interface Required {
1576
+ /**
1577
+ * Whether the input is always required
1578
+ */
1579
+ always?: boolean;
1580
+ /**
1581
+ * Makes this input required when another input has a specific value:
1582
+ *
1583
+ * - Key: name of the input to check
1584
+ * - Value: operation and allowed values that trigger the requirement
1585
+ */
1586
+ conditionalValues?: unknown;
1587
+ /**
1588
+ * Makes this input required when another input is defined:
1589
+ *
1590
+ * - Key: name of the input that must be defined
1591
+ * - Value: message to display when this input is required
1592
+ */
1593
+ ifDefined?: unknown;
1594
+ /**
1595
+ * Makes this input required when another input is not defined:
1596
+ *
1597
+ * - Key: name of the input that must be undefined
1598
+ * - Value: message to display when this input is required
1599
+ */
1600
+ ifNotDefined?: unknown;
1601
+ }
1602
+ }
1300
1603
  /**
1301
1604
  * The reference to another input or output of the same workflow. Must have at
1302
1605
  * least one of node or conditional.
@@ -1483,7 +1786,7 @@ export declare namespace ExampleListResponse {
1483
1786
  /**
1484
1787
  * source of the asset
1485
1788
  */
1486
- source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
1789
+ source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2img' | 'video2video' | 'voice-clone';
1487
1790
  /**
1488
1791
  * The actual status
1489
1792
  */
@@ -1576,7 +1879,7 @@ export declare namespace ExampleListResponse {
1576
1879
  * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
1577
1880
  * from a text to image model
1578
1881
  */
1579
- type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
1882
+ type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2img' | 'video2video' | 'voice-clone';
1580
1883
  /**
1581
1884
  * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
1582
1885
  */
@@ -1598,7 +1901,7 @@ export declare namespace ExampleListResponse {
1598
1901
  /**
1599
1902
  * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
1600
1903
  */
1601
- bbox?: Array<unknown>;
1904
+ bbox?: Array<number>;
1602
1905
  /**
1603
1906
  * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
1604
1907
  */
@@ -1780,7 +2083,7 @@ export declare namespace ExampleListResponse {
1780
2083
  /**
1781
2084
  * The type of the generator used
1782
2085
  */
1783
- modelType?: 'custom' | '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' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora';
2086
+ modelType?: '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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
1784
2087
  name?: string;
1785
2088
  nbMasks?: number;
1786
2089
  /**
@@ -1819,7 +2122,7 @@ export declare namespace ExampleListResponse {
1819
2122
  * List of points (label, x, y) in the image where label = 0 for background and 1
1820
2123
  * for object.
1821
2124
  */
1822
- points?: Array<Array<unknown>>;
2125
+ points?: Array<Array<number>>;
1823
2126
  /**
1824
2127
  * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1825
2128
  */
@@ -1886,7 +2189,8 @@ export declare namespace ExampleListResponse {
1886
2189
  */
1887
2190
  scheduler?: string;
1888
2191
  /**
1889
- * The seed used to generate this asset
2192
+ * The seed used to generate this asset. <!> Can be a string or a number in some
2193
+ * cases <!>.
1890
2194
  */
1891
2195
  seed?: string;
1892
2196
  /**
@@ -2038,7 +2342,7 @@ export declare namespace ExampleListResponse {
2038
2342
  /**
2039
2343
  * Bounding box dimensions [width, height, depth]
2040
2344
  */
2041
- dimensions?: Array<unknown>;
2345
+ dimensions?: Array<number>;
2042
2346
  /**
2043
2347
  * Duration of the media in seconds
2044
2348
  */
@@ -2336,7 +2640,7 @@ export declare namespace ExampleListResponse {
2336
2640
  * Note: if you use a value that is not supported by the model family, this will
2337
2641
  * result in an error.
2338
2642
  */
2339
- modality?: 'blur' | 'canny' | 'depth' | 'gray' | 'illusion' | 'lineart' | 'lines' | 'low-quality' | 'normal-map' | 'pose' | 'scribble' | 'seg' | 'sketch' | 'tile';
2643
+ modality?: string;
2340
2644
  /**
2341
2645
  * The epoch of the model to use for the inference. Only available for Flux Lora
2342
2646
  * Trained models.
@@ -2438,7 +2742,7 @@ export declare namespace ExampleListResponse {
2438
2742
  /**
2439
2743
  * The type of job
2440
2744
  */
2441
- 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' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
2745
+ 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' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
2442
2746
  /**
2443
2747
  * Metadata of the job with some additional information
2444
2748
  */
@@ -2482,18 +2786,36 @@ export declare namespace ExampleListResponse {
2482
2786
  * List of produced assets for this job
2483
2787
  */
2484
2788
  assetIds?: Array<string>;
2789
+ /**
2790
+ * Eventual error for the job
2791
+ */
2792
+ error?: string | null;
2485
2793
  /**
2486
2794
  * The flow of the job. Only available for workflow jobs.
2487
2795
  */
2488
2796
  flow?: Array<Metadata.Flow>;
2797
+ /**
2798
+ * Actionable hint for the user explaining what went wrong and how to resolve it.
2799
+ */
2800
+ hint?: string;
2489
2801
  /**
2490
2802
  * The inputs for the job
2491
2803
  */
2492
- input?: unknown;
2804
+ input?: {
2805
+ [key: string]: unknown;
2806
+ };
2493
2807
  /**
2494
- * The output of the job
2808
+ * May contain the output of the job for specific custom models jobs. Only
2809
+ * available for custom models which generate non-assets outputs. Example: LLM text
2810
+ * results.
2495
2811
  */
2496
- output?: unknown;
2812
+ output?: {
2813
+ [key: string]: unknown;
2814
+ };
2815
+ /**
2816
+ * For voice-clone jobs: the ID of the model being trained.
2817
+ */
2818
+ outputModelId?: string;
2497
2819
  /**
2498
2820
  * The workflow ID of the job if job is part of a workflow.
2499
2821
  */
@@ -2516,20 +2838,45 @@ export declare namespace ExampleListResponse {
2516
2838
  /**
2517
2839
  * The type of the job for the node.
2518
2840
  */
2519
- type: 'custom-model' | 'generate-prompt' | 'logic' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
2841
+ type: 'custom-model' | 'for-each' | 'generate-prompt' | 'list' | 'logic' | 'model' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
2520
2842
  /**
2521
2843
  * List of produced assets for this node.
2522
2844
  */
2523
2845
  assets?: Array<Flow.Asset>;
2846
+ /**
2847
+ * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
2848
+ * `count` times regardless of array input. When not set, the loop iterates over
2849
+ * the resolved array input. Only available for ForEach nodes.
2850
+ */
2851
+ count?: number;
2524
2852
  /**
2525
2853
  * The nodes that this node depends on. Only available for nodes that have
2526
2854
  * dependencies. Mainly used for user approval nodes.
2527
2855
  */
2528
2856
  dependsOn?: Array<string>;
2857
+ /**
2858
+ * If true, the outputs of this node will be included in the workflow job's final
2859
+ * output. Only applicable to producing nodes (custom-model, inference, etc.). By
2860
+ * default, only last nodes (nodes not referenced by other nodes) contribute to
2861
+ * outputs. Set this to true to also include intermediate nodes in the final
2862
+ * output. Note: This should only be set to `true` or left undefined.
2863
+ */
2864
+ includeOutputsInWorkflowJob?: true;
2529
2865
  /**
2530
2866
  * The inputs of the node.
2531
2867
  */
2532
2868
  inputs?: Array<Flow.Input>;
2869
+ /**
2870
+ * Statically-configured items for a List node. The node outputs this array as-is
2871
+ * when executed. Only available for List nodes. The values can be strings,
2872
+ * numbers, or asset IDs.
2873
+ */
2874
+ items?: Array<string>;
2875
+ /**
2876
+ * Zero-based index of the iteration this node copy belongs to. Set on
2877
+ * dynamically-created copies of loop body nodes.
2878
+ */
2879
+ iterationIndex?: number;
2533
2880
  /**
2534
2881
  * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
2535
2882
  * only available for nodes started. A node "Pending" for a running workflow job is
@@ -2544,10 +2891,25 @@ export declare namespace ExampleListResponse {
2544
2891
  * The type of the logic for the node. Only available for logic nodes.
2545
2892
  */
2546
2893
  logicType?: 'if-else';
2894
+ /**
2895
+ * IDs of the body template nodes that belong to this ForEach loop. At runtime
2896
+ * these templates are cloned once per iteration and marked Skipped. Only available
2897
+ * for ForEach nodes.
2898
+ */
2899
+ loopBodyNodeIds?: Array<string>;
2900
+ /**
2901
+ * ID of the ForEach node that spawned this iteration copy. Set on
2902
+ * dynamically-created copies of loop body nodes.
2903
+ */
2904
+ loopNodeId?: string;
2547
2905
  /**
2548
2906
  * The model id for the node. Mainly used for custom model tasks.
2549
2907
  */
2550
2908
  modelId?: string;
2909
+ /**
2910
+ * The output of the node. Only available for logic nodes.
2911
+ */
2912
+ output?: unknown;
2551
2913
  /**
2552
2914
  * The workflow id for the node. Mainly used for workflow tasks.
2553
2915
  */
@@ -2589,6 +2951,10 @@ export declare namespace ExampleListResponse {
2589
2951
  * Whether this input affects the model's cost calculation
2590
2952
  */
2591
2953
  costImpact?: boolean;
2954
+ /**
2955
+ * The default value for the input
2956
+ */
2957
+ default?: unknown;
2592
2958
  /**
2593
2959
  * Help text displayed in the UI to provide additional information about the input
2594
2960
  */
@@ -2607,10 +2973,20 @@ export declare namespace ExampleListResponse {
2607
2973
  * the same as the current object. This is only available for type inputs_array
2608
2974
  * inputs.
2609
2975
  */
2610
- inputs?: Array<unknown>;
2976
+ inputs?: Array<{
2977
+ [key: string]: unknown;
2978
+ }>;
2979
+ /**
2980
+ * The configured items for inputs_array type inputs. Each item is an array of
2981
+ * SubNodeInput that need ref/value resolution. Only available for inputs_array
2982
+ * type.
2983
+ */
2984
+ items?: Array<Array<Input.Item>>;
2611
2985
  /**
2612
2986
  * The asset kind of the input. Only taken into account for \`file\` and
2613
- * \`file_array\` input types.
2987
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
2988
+ * not able to create the asset on the flight on API side with dataurl without
2989
+ * data:kind, prefix
2614
2990
  */
2615
2991
  kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
2616
2992
  /**
@@ -2631,6 +3007,12 @@ export declare namespace ExampleListResponse {
2631
3007
  * \`string_array\`.
2632
3008
  */
2633
3009
  maxLength?: number;
3010
+ /**
3011
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
3012
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
3013
+ * creation time.
3014
+ */
3015
+ maxSize?: number;
2634
3016
  /**
2635
3017
  * The minimum allowed value. Only available for \`number\` and array input types.
2636
3018
  */
@@ -2644,7 +3026,7 @@ export declare namespace ExampleListResponse {
2644
3026
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
2645
3027
  * available for \`model_array\` input type.
2646
3028
  */
2647
- modelTypes?: Array<'custom' | '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' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
3029
+ 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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
2648
3030
  /**
2649
3031
  * Whether this input represents a parent asset to assign to the produced assets.
2650
3032
  * Only available for \`file\` and \`file_array\` input types.
@@ -2688,8 +3070,232 @@ export declare namespace ExampleListResponse {
2688
3070
  * The step increment for numeric inputs. Only available for \`number\` input type.
2689
3071
  */
2690
3072
  step?: number;
3073
+ /**
3074
+ * The value of the input. This is the value of the input that will be used to run
3075
+ * the node. Only available for flows managed by a WorkflowJob.
3076
+ */
3077
+ value?: unknown;
2691
3078
  }
2692
3079
  namespace Input {
3080
+ /**
3081
+ * A sub-input within an inputs_array item. Same as NodeInput but without the
3082
+ * recursive items field.
3083
+ */
3084
+ interface Item {
3085
+ /**
3086
+ * The name that must be user to call the model through the API
3087
+ */
3088
+ name: string;
3089
+ /**
3090
+ * The data type of the input
3091
+ */
3092
+ type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
3093
+ /**
3094
+ * The allowed values for the input. For \`string\` or \`number\` types, creates a
3095
+ * single-select dropdown. For \`string_array\` type, creates a multi-select
3096
+ * dropdown.
3097
+ */
3098
+ allowedValues?: Array<unknown>;
3099
+ /**
3100
+ * Specifies the background behavior for the input. Only available for \`file\` and
3101
+ * \`file_array\` input types with kind \`image\`.
3102
+ */
3103
+ backgroundBehavior?: 'opaque' | 'transparent';
3104
+ /**
3105
+ * Whether the input is a color or not. Only available for \`string\` input type.
3106
+ */
3107
+ color?: boolean;
3108
+ /**
3109
+ * Whether this input affects the model's cost calculation
3110
+ */
3111
+ costImpact?: boolean;
3112
+ /**
3113
+ * The default value for the input
3114
+ */
3115
+ default?: unknown;
3116
+ /**
3117
+ * Help text displayed in the UI to provide additional information about the input
3118
+ */
3119
+ description?: string;
3120
+ /**
3121
+ * Used to visually group inputs together in the UI. Inputs with the same group
3122
+ * value appear consecutively in the UI.
3123
+ */
3124
+ group?: string;
3125
+ /**
3126
+ * Hint text displayed in the UI as a tooltip to guide the user
3127
+ */
3128
+ hint?: string;
3129
+ /**
3130
+ * The list of inputs which form an object within a container array. All inputs are
3131
+ * the same as the current object. This is only available for type inputs_array
3132
+ * inputs.
3133
+ */
3134
+ inputs?: Array<{
3135
+ [key: string]: unknown;
3136
+ }>;
3137
+ /**
3138
+ * The asset kind of the input. Only taken into account for \`file\` and
3139
+ * \`file_array\` input types. If model provides multiple kinds, the input will be
3140
+ * not able to create the asset on the flight on API side with dataurl without
3141
+ * data:kind, prefix
3142
+ */
3143
+ kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
3144
+ /**
3145
+ * The label displayed in the UI for this input
3146
+ */
3147
+ label?: string;
3148
+ /**
3149
+ * The name of the file input field to use as the mask source
3150
+ */
3151
+ maskFrom?: string;
3152
+ /**
3153
+ * The maximum allowed value. Only available for \`number\` and \`array\` input
3154
+ * types.
3155
+ */
3156
+ max?: number;
3157
+ /**
3158
+ * The maximum allowed length for \`string\` inputs. Also applies to each item in
3159
+ * \`string_array\`.
3160
+ */
3161
+ maxLength?: number;
3162
+ /**
3163
+ * The maximum allowed file size in bytes. Only applies to \`file\` and
3164
+ * \`file_array\` input types. Validated against \`asset.properties.size\` at job
3165
+ * creation time.
3166
+ */
3167
+ maxSize?: number;
3168
+ /**
3169
+ * The minimum allowed value. Only available for \`number\` and array input types.
3170
+ */
3171
+ min?: number;
3172
+ /**
3173
+ * The minimum allowed length for string inputs. Also applies to each item in
3174
+ * \`string_array\`.
3175
+ */
3176
+ minLength?: number;
3177
+ /**
3178
+ * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
3179
+ * available for \`model_array\` input type.
3180
+ */
3181
+ 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' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
3182
+ /**
3183
+ * Whether this input represents a parent asset to assign to the produced assets.
3184
+ * Only available for \`file\` and \`file_array\` input types.
3185
+ *
3186
+ * For \`file_array\`, the parent asset is the first item in the array.
3187
+ */
3188
+ parent?: boolean;
3189
+ /**
3190
+ * Placeholder text for the input. Only available for 'string' input type.
3191
+ */
3192
+ placeholder?: string;
3193
+ /**
3194
+ * Whether the input is a prompt. When true, displays as a text area with prompt
3195
+ * spark feature. Only available for \`string\` input type.
3196
+ */
3197
+ prompt?: boolean;
3198
+ /**
3199
+ * Whether the input is used with prompt spark. Only available for \`string\` input
3200
+ * type.
3201
+ */
3202
+ promptSpark?: boolean;
3203
+ /**
3204
+ * The reference to another input or output of the same workflow. Must have at
3205
+ * least one of node or conditional.
3206
+ */
3207
+ ref?: Item.Ref;
3208
+ /**
3209
+ * Set of rules that describes when this input is required:
3210
+ *
3211
+ * - \`always\`: Input is always required
3212
+ * - \`ifNotDefined\`: Input is required when another specified input is not
3213
+ * defined
3214
+ * - \`ifDefined\`: Input is required when another specified input is defined
3215
+ * - \`conditionalValues\`: Input is required when another input has a specific
3216
+ * value
3217
+ *
3218
+ * By default, the input is not required.
3219
+ */
3220
+ required?: Item.Required;
3221
+ /**
3222
+ * The step increment for numeric inputs. Only available for \`number\` input type.
3223
+ */
3224
+ step?: number;
3225
+ /**
3226
+ * The value of the input. This is the value of the input that will be used to run
3227
+ * the node. Only available for flows managed by a WorkflowJob.
3228
+ */
3229
+ value?: unknown;
3230
+ }
3231
+ namespace Item {
3232
+ /**
3233
+ * The reference to another input or output of the same workflow. Must have at
3234
+ * least one of node or conditional.
3235
+ */
3236
+ interface Ref {
3237
+ /**
3238
+ * The conditional nodes to reference. If the conditional nodes are successful, the
3239
+ * node will be successful. If the conditional nodes are skipped, the node will be
3240
+ * skipped. Contains an array of node ids used to check the status of the nodes.
3241
+ */
3242
+ conditional?: Array<string>;
3243
+ /**
3244
+ * This is the desired node output value if ref is an if/else node.
3245
+ */
3246
+ equal?: string;
3247
+ /**
3248
+ * The name of the input or output to reference. If the type is 'workflow', the
3249
+ * name is the name of the input of the workflow is required If the type is 'node',
3250
+ * the name is not mandatory, except if you want all outputs of the node. To get
3251
+ * all outputs of a node, you can use the name 'all'.
3252
+ */
3253
+ name?: string;
3254
+ /**
3255
+ * The node id or 'workflow' if the source is a workflow input.
3256
+ */
3257
+ node?: string;
3258
+ }
3259
+ /**
3260
+ * Set of rules that describes when this input is required:
3261
+ *
3262
+ * - \`always\`: Input is always required
3263
+ * - \`ifNotDefined\`: Input is required when another specified input is not
3264
+ * defined
3265
+ * - \`ifDefined\`: Input is required when another specified input is defined
3266
+ * - \`conditionalValues\`: Input is required when another input has a specific
3267
+ * value
3268
+ *
3269
+ * By default, the input is not required.
3270
+ */
3271
+ interface Required {
3272
+ /**
3273
+ * Whether the input is always required
3274
+ */
3275
+ always?: boolean;
3276
+ /**
3277
+ * Makes this input required when another input has a specific value:
3278
+ *
3279
+ * - Key: name of the input to check
3280
+ * - Value: operation and allowed values that trigger the requirement
3281
+ */
3282
+ conditionalValues?: unknown;
3283
+ /**
3284
+ * Makes this input required when another input is defined:
3285
+ *
3286
+ * - Key: name of the input that must be defined
3287
+ * - Value: message to display when this input is required
3288
+ */
3289
+ ifDefined?: unknown;
3290
+ /**
3291
+ * Makes this input required when another input is not defined:
3292
+ *
3293
+ * - Key: name of the input that must be undefined
3294
+ * - Value: message to display when this input is required
3295
+ */
3296
+ ifNotDefined?: unknown;
3297
+ }
3298
+ }
2693
3299
  /**
2694
3300
  * The reference to another input or output of the same workflow. Must have at
2695
3301
  * least one of node or conditional.
@@ -2805,13 +3411,13 @@ export interface ExampleUpdateParams {
2805
3411
  /**
2806
3412
  * Query param: If set to true, returns the original asset without transformation
2807
3413
  */
2808
- originalAssets?: string;
3414
+ originalAssets?: boolean;
2809
3415
  }
2810
3416
  export interface ExampleListParams {
2811
3417
  /**
2812
3418
  * If set to true, returns the original asset without transformation
2813
3419
  */
2814
- originalAssets?: string;
3420
+ originalAssets?: boolean;
2815
3421
  }
2816
3422
  export declare namespace Examples {
2817
3423
  export { type ExampleUpdateResponse as ExampleUpdateResponse, type ExampleListResponse as ExampleListResponse, type ExampleUpdateParams as ExampleUpdateParams, type ExampleListParams as ExampleListParams, };