@scenario-labs/sdk 1.0.0 → 1.2.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 (209) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/README.md +0 -2
  3. package/client.d.mts +8 -8
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +8 -8
  6. package/client.d.ts.map +1 -1
  7. package/client.js +17 -6
  8. package/client.js.map +1 -1
  9. package/client.mjs +17 -6
  10. package/client.mjs.map +1 -1
  11. package/index.d.mts +3 -1
  12. package/index.d.mts.map +1 -1
  13. package/index.d.ts +3 -1
  14. package/index.d.ts.map +1 -1
  15. package/index.js +8 -1
  16. package/index.js.map +1 -1
  17. package/index.mjs +3 -1
  18. package/index.mjs.map +1 -1
  19. package/internal/request-options.d.mts +0 -4
  20. package/internal/request-options.d.mts.map +1 -1
  21. package/internal/request-options.d.ts +0 -4
  22. package/internal/request-options.d.ts.map +1 -1
  23. package/internal/request-options.js.map +1 -1
  24. package/internal/request-options.mjs.map +1 -1
  25. package/lib/asset.d.mts +55 -0
  26. package/lib/asset.d.mts.map +1 -0
  27. package/lib/asset.d.ts +55 -0
  28. package/lib/asset.d.ts.map +1 -0
  29. package/lib/asset.js +60 -0
  30. package/lib/asset.js.map +1 -0
  31. package/lib/asset.mjs +54 -0
  32. package/lib/asset.mjs.map +1 -0
  33. package/lib/job.d.mts +13 -1
  34. package/lib/job.d.mts.map +1 -1
  35. package/lib/job.d.ts +13 -1
  36. package/lib/job.d.ts.map +1 -1
  37. package/lib/job.js +18 -1
  38. package/lib/job.js.map +1 -1
  39. package/lib/job.mjs +16 -0
  40. package/lib/job.mjs.map +1 -1
  41. package/lib/scenario.d.mts +12 -0
  42. package/lib/scenario.d.mts.map +1 -1
  43. package/lib/scenario.d.ts +12 -0
  44. package/lib/scenario.d.ts.map +1 -1
  45. package/lib/scenario.js +12 -0
  46. package/lib/scenario.js.map +1 -1
  47. package/lib/scenario.mjs +12 -0
  48. package/lib/scenario.mjs.map +1 -1
  49. package/lib/upload.d.mts +56 -2
  50. package/lib/upload.d.mts.map +1 -1
  51. package/lib/upload.d.ts +56 -2
  52. package/lib/upload.d.ts.map +1 -1
  53. package/lib/upload.js +51 -2
  54. package/lib/upload.js.map +1 -1
  55. package/lib/upload.mjs +48 -1
  56. package/lib/upload.mjs.map +1 -1
  57. package/lib/workflow.d.mts +2 -2
  58. package/lib/workflow.d.mts.map +1 -1
  59. package/lib/workflow.d.ts +2 -2
  60. package/lib/workflow.d.ts.map +1 -1
  61. package/lib/workflow.js +2 -2
  62. package/lib/workflow.js.map +1 -1
  63. package/lib/workflow.mjs +2 -2
  64. package/lib/workflow.mjs.map +1 -1
  65. package/package.json +1 -1
  66. package/resources/assets/assets.d.mts +25 -29
  67. package/resources/assets/assets.d.mts.map +1 -1
  68. package/resources/assets/assets.d.ts +25 -29
  69. package/resources/assets/assets.d.ts.map +1 -1
  70. package/resources/assets/assets.js +0 -4
  71. package/resources/assets/assets.js.map +1 -1
  72. package/resources/assets/assets.mjs +0 -4
  73. package/resources/assets/assets.mjs.map +1 -1
  74. package/resources/assets/index.d.mts +0 -1
  75. package/resources/assets/index.d.mts.map +1 -1
  76. package/resources/assets/index.d.ts +0 -1
  77. package/resources/assets/index.d.ts.map +1 -1
  78. package/resources/assets/index.js +1 -3
  79. package/resources/assets/index.js.map +1 -1
  80. package/resources/assets/index.mjs +0 -1
  81. package/resources/assets/index.mjs.map +1 -1
  82. package/resources/generate.d.mts +1027 -242
  83. package/resources/generate.d.mts.map +1 -1
  84. package/resources/generate.d.ts +1027 -242
  85. package/resources/generate.d.ts.map +1 -1
  86. package/resources/generate.js +7 -0
  87. package/resources/generate.js.map +1 -1
  88. package/resources/generate.mjs +7 -0
  89. package/resources/generate.mjs.map +1 -1
  90. package/resources/index.d.mts +3 -2
  91. package/resources/index.d.mts.map +1 -1
  92. package/resources/index.d.ts +3 -2
  93. package/resources/index.d.ts.map +1 -1
  94. package/resources/index.js +3 -1
  95. package/resources/index.js.map +1 -1
  96. package/resources/index.mjs +1 -0
  97. package/resources/index.mjs.map +1 -1
  98. package/resources/jobs.d.mts +10 -3
  99. package/resources/jobs.d.mts.map +1 -1
  100. package/resources/jobs.d.ts +10 -3
  101. package/resources/jobs.d.ts.map +1 -1
  102. package/resources/models/description.d.mts +2 -2
  103. package/resources/models/description.d.mts.map +1 -1
  104. package/resources/models/description.d.ts +2 -2
  105. package/resources/models/description.d.ts.map +1 -1
  106. package/resources/models/examples.d.mts +4 -4
  107. package/resources/models/examples.d.mts.map +1 -1
  108. package/resources/models/examples.d.ts +4 -4
  109. package/resources/models/examples.d.ts.map +1 -1
  110. package/resources/models/models.d.mts +20 -18
  111. package/resources/models/models.d.mts.map +1 -1
  112. package/resources/models/models.d.ts +20 -18
  113. package/resources/models/models.d.ts.map +1 -1
  114. package/resources/models/models.js.map +1 -1
  115. package/resources/models/models.mjs.map +1 -1
  116. package/resources/models/train.d.mts +2 -2
  117. package/resources/models/train.d.mts.map +1 -1
  118. package/resources/models/train.d.ts +2 -2
  119. package/resources/models/train.d.ts.map +1 -1
  120. package/resources/oscu.d.mts +5 -0
  121. package/resources/oscu.d.mts.map +1 -1
  122. package/resources/oscu.d.ts +5 -0
  123. package/resources/oscu.d.ts.map +1 -1
  124. package/resources/oscu.js +5 -0
  125. package/resources/oscu.js.map +1 -1
  126. package/resources/oscu.mjs +5 -0
  127. package/resources/oscu.mjs.map +1 -1
  128. package/resources/pricing/index.d.mts +3 -0
  129. package/resources/pricing/index.d.mts.map +1 -0
  130. package/resources/pricing/index.d.ts +3 -0
  131. package/resources/pricing/index.d.ts.map +1 -0
  132. package/resources/pricing/index.js +9 -0
  133. package/resources/pricing/index.js.map +1 -0
  134. package/resources/pricing/index.mjs +4 -0
  135. package/resources/pricing/index.mjs.map +1 -0
  136. package/resources/pricing/oscu.d.mts +25 -0
  137. package/resources/pricing/oscu.d.mts.map +1 -0
  138. package/resources/pricing/oscu.d.ts +25 -0
  139. package/resources/pricing/oscu.d.ts.map +1 -0
  140. package/resources/pricing/oscu.js +16 -0
  141. package/resources/pricing/oscu.js.map +1 -0
  142. package/resources/pricing/oscu.mjs +12 -0
  143. package/resources/pricing/oscu.mjs.map +1 -0
  144. package/resources/pricing/pricing.d.mts +10 -0
  145. package/resources/pricing/pricing.d.mts.map +1 -0
  146. package/resources/pricing/pricing.d.ts +10 -0
  147. package/resources/pricing/pricing.d.ts.map +1 -0
  148. package/resources/pricing/pricing.js +17 -0
  149. package/resources/pricing/pricing.js.map +1 -0
  150. package/resources/pricing/pricing.mjs +12 -0
  151. package/resources/pricing/pricing.mjs.map +1 -0
  152. package/resources/pricing.d.mts +2 -0
  153. package/resources/pricing.d.mts.map +1 -0
  154. package/resources/pricing.d.ts +2 -0
  155. package/resources/pricing.d.ts.map +1 -0
  156. package/resources/pricing.js +6 -0
  157. package/resources/pricing.js.map +1 -0
  158. package/resources/pricing.mjs +3 -0
  159. package/resources/pricing.mjs.map +1 -0
  160. package/resources/usages.d.mts +8 -6
  161. package/resources/usages.d.mts.map +1 -1
  162. package/resources/usages.d.ts +8 -6
  163. package/resources/usages.d.ts.map +1 -1
  164. package/resources/workflows.d.mts +1156 -1142
  165. package/resources/workflows.d.mts.map +1 -1
  166. package/resources/workflows.d.ts +1156 -1142
  167. package/resources/workflows.d.ts.map +1 -1
  168. package/resources/workflows.js +13 -6
  169. package/resources/workflows.js.map +1 -1
  170. package/resources/workflows.mjs +13 -6
  171. package/resources/workflows.mjs.map +1 -1
  172. package/src/client.ts +28 -11
  173. package/src/index.ts +3 -1
  174. package/src/internal/request-options.ts +0 -2
  175. package/src/lib/asset.ts +85 -0
  176. package/src/lib/job.ts +28 -1
  177. package/src/lib/scenario.ts +12 -0
  178. package/src/lib/upload.ts +96 -2
  179. package/src/lib/workflow.ts +4 -4
  180. package/src/resources/assets/assets.ts +46 -20
  181. package/src/resources/assets/index.ts +0 -6
  182. package/src/resources/generate.ts +1227 -136
  183. package/src/resources/index.ts +5 -1
  184. package/src/resources/jobs.ts +12 -4
  185. package/src/resources/models/description.ts +4 -0
  186. package/src/resources/models/examples.ts +8 -0
  187. package/src/resources/models/models.ts +65 -11
  188. package/src/resources/models/train.ts +4 -0
  189. package/src/resources/oscu.ts +5 -0
  190. package/src/resources/pricing/index.ts +4 -0
  191. package/src/resources/pricing/oscu.ts +35 -0
  192. package/src/resources/pricing/pricing.ts +15 -0
  193. package/src/resources/pricing.ts +3 -0
  194. package/src/resources/usages.ts +12 -3
  195. package/src/resources/workflows.ts +1540 -1522
  196. package/src/version.ts +1 -1
  197. package/version.d.mts +1 -1
  198. package/version.d.ts +1 -1
  199. package/version.js +1 -1
  200. package/version.mjs +1 -1
  201. package/resources/assets/public.d.mts +0 -1538
  202. package/resources/assets/public.d.mts.map +0 -1
  203. package/resources/assets/public.d.ts +0 -1538
  204. package/resources/assets/public.d.ts.map +0 -1
  205. package/resources/assets/public.js +0 -28
  206. package/resources/assets/public.js.map +0 -1
  207. package/resources/assets/public.mjs +0 -24
  208. package/resources/assets/public.mjs.map +0 -1
  209. package/src/resources/assets/public.ts +0 -2451
@@ -1,2451 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- import { APIResource } from '../../core/resource';
4
- import { APIPromise } from '../../core/api-promise';
5
- import { RequestOptions } from '../../internal/request-options';
6
- import { path } from '../../internal/utils/path';
7
-
8
- export class Public extends APIResource {
9
- /**
10
- * Get the details of an asset. @deprecated Use GET /assets/{assetId} with
11
- * Authorization: public-auth-token header instead.
12
- *
13
- * @deprecated
14
- */
15
- retrieve(assetID: string, options?: RequestOptions): APIPromise<PublicRetrieveResponse> {
16
- return this._client.get(path`/assets/public/${assetID}`, { ...options, __security: {} });
17
- }
18
-
19
- /**
20
- * List all public assets. @deprecated Use GET /assets with Authorization:
21
- * public-auth-token header instead.
22
- *
23
- * @deprecated
24
- */
25
- list(
26
- query: PublicListParams | null | undefined = {},
27
- options?: RequestOptions,
28
- ): APIPromise<PublicListResponse> {
29
- return this._client.get('/assets/public', { query, ...options, __security: {} });
30
- }
31
- }
32
-
33
- export interface PublicRetrieveResponse {
34
- asset: PublicRetrieveResponse.Asset;
35
- }
36
-
37
- export namespace PublicRetrieveResponse {
38
- export interface Asset {
39
- /**
40
- * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
41
- */
42
- id: string;
43
-
44
- /**
45
- * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
46
- */
47
- authorId: string;
48
-
49
- /**
50
- * A list of CollectionId this asset belongs to
51
- */
52
- collectionIds: Array<string>;
53
-
54
- /**
55
- * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
56
- */
57
- createdAt: string;
58
-
59
- /**
60
- * List of edit capabilities
61
- */
62
- editCapabilities: Array<
63
- | 'DETECTION'
64
- | 'GENERATIVE_FILL'
65
- | 'PIXELATE'
66
- | 'PROMPT_EDITING'
67
- | 'REFINE'
68
- | 'REFRAME'
69
- | 'REMOVE_BACKGROUND'
70
- | 'SEGMENTATION'
71
- | 'UPSCALE'
72
- | 'UPSCALE_360'
73
- | 'VECTORIZATION'
74
- >;
75
-
76
- /**
77
- * The kind of asset
78
- */
79
- kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
80
-
81
- /**
82
- * Metadata of the asset with some additional information
83
- */
84
- metadata: Asset.Metadata;
85
-
86
- /**
87
- * The mime type of the asset (example: "image/png")
88
- */
89
- mimeType: string;
90
-
91
- /**
92
- * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
93
- * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
94
- */
95
- ownerId: string;
96
-
97
- /**
98
- * The privacy of the asset
99
- */
100
- privacy: 'private' | 'public' | 'unlisted';
101
-
102
- /**
103
- * The properties of the asset, content may depend on the kind of asset returned
104
- */
105
- properties: Asset.Properties;
106
-
107
- /**
108
- * source of the asset
109
- */
110
- source:
111
- | '3d23d'
112
- | '3d23d:texture'
113
- | '3d:texture'
114
- | '3d:texture:albedo'
115
- | '3d:texture:metallic'
116
- | '3d:texture:mtl'
117
- | '3d:texture:normal'
118
- | '3d:texture:roughness'
119
- | 'audio2audio'
120
- | 'background-removal'
121
- | 'canvas'
122
- | 'canvas-drawing'
123
- | 'canvas-export'
124
- | 'detection'
125
- | 'generative-fill'
126
- | 'image-prompt-editing'
127
- | 'img23d'
128
- | 'img2img'
129
- | 'img2video'
130
- | 'inference-control-net'
131
- | 'inference-control-net-img'
132
- | 'inference-control-net-inpainting'
133
- | 'inference-control-net-inpainting-ip-adapter'
134
- | 'inference-control-net-ip-adapter'
135
- | 'inference-control-net-reference'
136
- | 'inference-control-net-texture'
137
- | 'inference-img'
138
- | 'inference-img-ip-adapter'
139
- | 'inference-img-texture'
140
- | 'inference-in-paint'
141
- | 'inference-in-paint-ip-adapter'
142
- | 'inference-reference'
143
- | 'inference-reference-texture'
144
- | 'inference-txt'
145
- | 'inference-txt-ip-adapter'
146
- | 'inference-txt-texture'
147
- | 'patch'
148
- | 'pixelization'
149
- | 'reframe'
150
- | 'restyle'
151
- | 'segment'
152
- | 'segmentation-image'
153
- | 'segmentation-mask'
154
- | 'skybox-3d'
155
- | 'skybox-base-360'
156
- | 'skybox-hdri'
157
- | 'texture'
158
- | 'texture:albedo'
159
- | 'texture:ao'
160
- | 'texture:edge'
161
- | 'texture:height'
162
- | 'texture:metallic'
163
- | 'texture:normal'
164
- | 'texture:smoothness'
165
- | 'txt23d'
166
- | 'txt2audio'
167
- | 'txt2img'
168
- | 'txt2video'
169
- | 'unknown'
170
- | 'uploaded'
171
- | 'uploaded-3d'
172
- | 'uploaded-audio'
173
- | 'uploaded-avatar'
174
- | 'uploaded-video'
175
- | 'upscale'
176
- | 'upscale-skybox'
177
- | 'upscale-texture'
178
- | 'upscale-video'
179
- | 'vectorization'
180
- | 'video23d'
181
- | 'video2img'
182
- | 'video2video'
183
- | 'voice-clone';
184
-
185
- /**
186
- * The actual status
187
- */
188
- status: 'error' | 'pending' | 'success';
189
-
190
- /**
191
- * The associated tags (example: ["sci-fi", "landscape"])
192
- */
193
- tags: Array<string>;
194
-
195
- /**
196
- * The asset last update date as an ISO string (example:
197
- * "2023-02-03T11:19:41.579Z")
198
- */
199
- updatedAt: string;
200
-
201
- /**
202
- * Signed URL to get the asset content
203
- */
204
- url: string;
205
-
206
- /**
207
- * Automatic captioning of the asset
208
- */
209
- automaticCaptioning?: string;
210
-
211
- /**
212
- * The description, it will contain in priority:
213
- *
214
- * - the manual description
215
- * - the advanced captioning when the asset is used in training flow
216
- * - the automatic captioning
217
- */
218
- description?: string;
219
-
220
- /**
221
- * The embedding of the asset when requested.
222
- *
223
- * Only available when an asset can be embedded (ie: not Detection maps)
224
- */
225
- embedding?: Array<number>;
226
-
227
- /**
228
- * The video asset's first frame.
229
- *
230
- * Contains the assetId and the url of the first frame.
231
- */
232
- firstFrame?: Asset.FirstFrame;
233
-
234
- /**
235
- * Whether the asset is hidden.
236
- */
237
- isHidden?: boolean;
238
-
239
- /**
240
- * The video asset's last frame.
241
- *
242
- * Contains the assetId and the url of the last frame.
243
- */
244
- lastFrame?: Asset.LastFrame;
245
-
246
- /**
247
- * The NSFW labels
248
- */
249
- nsfw?: Array<string>;
250
-
251
- /**
252
- * The original file url.
253
- *
254
- * Contains the url of the original file. without any conversion. Only available
255
- * for some specific video, audio and threeD assets. Is only specified if the given
256
- * asset data has been replaced with a new file during the creation of the asset.
257
- */
258
- originalFileUrl?: string;
259
-
260
- /**
261
- * The output index of the asset within a job This index is an positive integer
262
- * that starts at 0 It is used to differentiate between multiple outputs of the
263
- * same job If the job has only one output, this index is 0
264
- */
265
- outputIndex?: number;
266
-
267
- /**
268
- * The asset's preview.
269
- *
270
- * Contains the assetId and the url of the preview.
271
- */
272
- preview?: Asset.Preview;
273
-
274
- /**
275
- * The asset's thumbnail.
276
- *
277
- * Contains the assetId and the url of the thumbnail.
278
- */
279
- thumbnail?: Asset.Thumbnail;
280
- }
281
-
282
- export namespace Asset {
283
- /**
284
- * Metadata of the asset with some additional information
285
- */
286
- export interface Metadata {
287
- kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
288
-
289
- /**
290
- * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
291
- * from a text to image model
292
- */
293
- type:
294
- | '3d-texture'
295
- | '3d-texture-albedo'
296
- | '3d-texture-metallic'
297
- | '3d-texture-mtl'
298
- | '3d-texture-normal'
299
- | '3d-texture-roughness'
300
- | '3d23d'
301
- | '3d23d-texture'
302
- | 'audio2audio'
303
- | 'background-removal'
304
- | 'canvas'
305
- | 'canvas-drawing'
306
- | 'canvas-export'
307
- | 'detection'
308
- | 'generative-fill'
309
- | 'image-prompt-editing'
310
- | 'img23d'
311
- | 'img2img'
312
- | 'img2video'
313
- | 'inference-controlnet'
314
- | 'inference-controlnet-img2img'
315
- | 'inference-controlnet-inpaint'
316
- | 'inference-controlnet-inpaint-ip-adapter'
317
- | 'inference-controlnet-ip-adapter'
318
- | 'inference-controlnet-reference'
319
- | 'inference-controlnet-texture'
320
- | 'inference-img2img'
321
- | 'inference-img2img-ip-adapter'
322
- | 'inference-img2img-texture'
323
- | 'inference-inpaint'
324
- | 'inference-inpaint-ip-adapter'
325
- | 'inference-reference'
326
- | 'inference-reference-texture'
327
- | 'inference-txt2img'
328
- | 'inference-txt2img-ip-adapter'
329
- | 'inference-txt2img-texture'
330
- | 'patch'
331
- | 'pixelization'
332
- | 'reframe'
333
- | 'restyle'
334
- | 'segment'
335
- | 'segmentation-image'
336
- | 'segmentation-mask'
337
- | 'skybox-3d'
338
- | 'skybox-base-360'
339
- | 'skybox-hdri'
340
- | 'texture'
341
- | 'texture-albedo'
342
- | 'texture-ao'
343
- | 'texture-edge'
344
- | 'texture-height'
345
- | 'texture-metallic'
346
- | 'texture-normal'
347
- | 'texture-smoothness'
348
- | 'txt23d'
349
- | 'txt2audio'
350
- | 'txt2img'
351
- | 'txt2video'
352
- | 'unknown'
353
- | 'uploaded'
354
- | 'uploaded-3d'
355
- | 'uploaded-audio'
356
- | 'uploaded-avatar'
357
- | 'uploaded-video'
358
- | 'upscale'
359
- | 'upscale-skybox'
360
- | 'upscale-texture'
361
- | 'upscale-video'
362
- | 'vectorization'
363
- | 'video23d'
364
- | 'video2img'
365
- | 'video2video'
366
- | 'voice-clone';
367
-
368
- /**
369
- * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
370
- */
371
- angular?: number;
372
-
373
- /**
374
- * The optional aspect ratio given for the generation, only applicable for some
375
- * models
376
- */
377
- aspectRatio?: string;
378
-
379
- /**
380
- * Int to set between 0 and 255 for the opacity of the background in the result
381
- * images.
382
- */
383
- backgroundOpacity?: number;
384
-
385
- /**
386
- * The baseModelId that maybe changed at inference time
387
- */
388
- baseModelId?: string;
389
-
390
- /**
391
- * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
392
- */
393
- bbox?: Array<number>;
394
-
395
- /**
396
- * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
397
- */
398
- betterQuality?: boolean;
399
-
400
- /**
401
- * The control image already processed by canny detector. Must reference an
402
- * existing AssetId.
403
- */
404
- cannyStructureImage?: string;
405
-
406
- /**
407
- * Activate clustering.
408
- */
409
- clustering?: boolean;
410
-
411
- /**
412
- * Ensure upscaled tile have the same color histogram as original tile.
413
- */
414
- colorCorrection?: boolean;
415
-
416
- colorMode?: string;
417
-
418
- colorPrecision?: number;
419
-
420
- /**
421
- * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
422
- */
423
- concepts?: Array<Metadata.Concept>;
424
-
425
- contours?: Array<Array<Array<Array<number>>>>;
426
-
427
- /**
428
- * End step for control.
429
- */
430
- controlEnd?: number;
431
-
432
- /**
433
- * The date when the asset was copied to a project
434
- */
435
- copiedAt?: string;
436
-
437
- cornerThreshold?: number;
438
-
439
- /**
440
- * Allow the generation of "hallucinations" during the upscale process, which adds
441
- * additional details and deviates from the original image. Default: optimized for
442
- * your preset and style.
443
- */
444
- creativity?: number;
445
-
446
- /**
447
- * Amount of decay in creativity over the upscale process. The lowest the value,
448
- * the less the creativity will be preserved over the upscale process.
449
- */
450
- creativityDecay?: number;
451
-
452
- /**
453
- * If true, use the default parameters
454
- */
455
- defaultParameters?: boolean;
456
-
457
- /**
458
- * The depth fidelity if a depth image provided
459
- */
460
- depthFidelity?: number;
461
-
462
- /**
463
- * The control image processed by depth estimator. Must reference an existing
464
- * AssetId.
465
- */
466
- depthImage?: string;
467
-
468
- /**
469
- * Amount of details to remove or add
470
- */
471
- detailsLevel?: number;
472
-
473
- /**
474
- * The number of pixels to dilate the result masks.
475
- */
476
- dilate?: number;
477
-
478
- /**
479
- * Contrast factor for Grayscale detector
480
- */
481
- factor?: number;
482
-
483
- filterSpeckle?: number;
484
-
485
- /**
486
- * Determine the scale at which the upscale process works.
487
- *
488
- * - With a small value, the upscale works at the largest scale, resulting in fewer
489
- * added details and more coherent images. Ideal for portraits, for example.
490
- * - With a large value, the upscale works at the smallest scale, resulting in more
491
- * added details and more hallucinations. Ideal for landscapes, for example.
492
- *
493
- * (info): A small value is slower and more expensive to run.
494
- */
495
- fractality?: number;
496
-
497
- /**
498
- * Apply extra control to the Skybox 360 geometry. The higher the value, the more
499
- * the 360 geometry will influence the generated skybox image.
500
- *
501
- * Use with caution. Default is adapted to the other parameters.
502
- */
503
- geometryEnforcement?: number;
504
-
505
- /**
506
- * The guidance used to generate this asset
507
- */
508
- guidance?: number;
509
-
510
- halfMode?: boolean;
511
-
512
- hdr?: number;
513
-
514
- height?: number;
515
-
516
- /**
517
- * High threshold for Canny detector
518
- */
519
- highThreshold?: number;
520
-
521
- /**
522
- * (deprecated) Horizontal expansion ratio.
523
- */
524
- horizontalExpansionRatio?: number;
525
-
526
- /**
527
- * The input image to process. Must reference an existing AssetId or be a data URL.
528
- */
529
- image?: string;
530
-
531
- /**
532
- * Strengthen the similarity to the original image during the upscale. Default:
533
- * optimized for your preset and style.
534
- */
535
- imageFidelity?: number;
536
-
537
- /**
538
- * Preserve the seamless properties of skybox or texture images. Input has to be of
539
- * same type (seamless).
540
- */
541
- imageType?: 'seamfull' | 'skybox' | 'texture';
542
-
543
- /**
544
- * The id of the Inference describing how this image was generated
545
- */
546
- inferenceId?: string;
547
-
548
- /**
549
- * When set to `high`, allows to better preserve details from the input images in
550
- * the output. This is especially useful when using images that contain elements
551
- * like faces or logos that require accurate preservation in the generated image.
552
- *
553
- * You can provide multiple input images that will all be preserved with high
554
- * fidelity, but keep in mind that the first image will be preserved with richer
555
- * textures and finer details, so if you include elements such as faces, consider
556
- * placing them in the first image.
557
- *
558
- * Only available for the `gpt-image-1` model.
559
- */
560
- inputFidelity?: 'high' | 'low';
561
-
562
- /**
563
- * Location of the input image in the output.
564
- */
565
- inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
566
-
567
- /**
568
- * To invert the relief
569
- */
570
- invert?: boolean;
571
-
572
- /**
573
- * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
574
- */
575
- keypointThreshold?: number;
576
-
577
- layerDifference?: number;
578
-
579
- lengthThreshold?: number;
580
-
581
- /**
582
- * The ISO timestamp when the lock on the canvas will expire
583
- */
584
- lockExpiresAt?: string;
585
-
586
- /**
587
- * Low threshold for Canny detector
588
- */
589
- lowThreshold?: number;
590
-
591
- /**
592
- * The mask used for the asset generation or editing
593
- */
594
- mask?: string;
595
-
596
- maxIterations?: number;
597
-
598
- /**
599
- * Maximum threshold for Grayscale conversion
600
- */
601
- maxThreshold?: number;
602
-
603
- /**
604
- * Minimum threshold for Grayscale conversion
605
- */
606
- minThreshold?: number;
607
-
608
- /**
609
- * Modality to detect
610
- */
611
- modality?:
612
- | 'canny'
613
- | 'depth'
614
- | 'grayscale'
615
- | 'lineart_anime'
616
- | 'mlsd'
617
- | 'normal'
618
- | 'pose'
619
- | 'scribble'
620
- | 'segmentation'
621
- | 'sketch';
622
-
623
- mode?: string;
624
-
625
- /**
626
- * The modelId used to generate this asset
627
- */
628
- modelId?: string;
629
-
630
- /**
631
- * The type of the generator used
632
- */
633
- modelType?:
634
- | 'custom'
635
- | 'elevenlabs-voice'
636
- | 'flux.1'
637
- | 'flux.1-composition'
638
- | 'flux.1-kontext-dev'
639
- | 'flux.1-kontext-lora'
640
- | 'flux.1-krea-dev'
641
- | 'flux.1-krea-lora'
642
- | 'flux.1-lora'
643
- | 'flux.1-pro'
644
- | 'flux.1.1-pro-ultra'
645
- | 'flux.2-dev-edit-lora'
646
- | 'flux.2-dev-lora'
647
- | 'flux.2-klein-4b-edit-lora'
648
- | 'flux.2-klein-4b-lora'
649
- | 'flux.2-klein-9b-edit-lora'
650
- | 'flux.2-klein-9b-lora'
651
- | 'flux.2-klein-base-4b-edit-lora'
652
- | 'flux.2-klein-base-4b-lora'
653
- | 'flux.2-klein-base-9b-edit-lora'
654
- | 'flux.2-klein-base-9b-lora'
655
- | 'flux1.1-pro'
656
- | 'gpt-image-1'
657
- | 'qwen-image-2512-lora'
658
- | 'qwen-image-edit-2509-lora'
659
- | 'qwen-image-edit-2511-lora'
660
- | 'qwen-image-edit-lora'
661
- | 'qwen-image-lora'
662
- | 'sd-1_5'
663
- | 'sd-1_5-composition'
664
- | 'sd-1_5-lora'
665
- | 'sd-xl'
666
- | 'sd-xl-composition'
667
- | 'sd-xl-lora'
668
- | 'zimage-de-turbo-lora'
669
- | 'zimage-lora'
670
- | 'zimage-turbo-lora';
671
-
672
- name?: string;
673
-
674
- nbMasks?: number;
675
-
676
- /**
677
- * The negative prompt used to generate this asset
678
- */
679
- negativePrompt?: string;
680
-
681
- /**
682
- * Controls the influence of the negative prompt. Default 0 means the negative
683
- * prompt has no effect. Higher values increase negative prompt influence. Must
684
- * be > 0 if negativePrompt is provided.
685
- */
686
- negativePromptStrength?: number;
687
-
688
- /**
689
- * The number of denoising steps for each image generation.
690
- */
691
- numInferenceSteps?: number;
692
-
693
- /**
694
- * The number of outputs to generate.
695
- */
696
- numOutputs?: number;
697
-
698
- originalAssetId?: string;
699
-
700
- outputIndex?: number;
701
-
702
- /**
703
- * Overlap percentage for the output image.
704
- */
705
- overlapPercentage?: number;
706
-
707
- /**
708
- * Override the embeddings of the model. Only your prompt and negativePrompt will
709
- * be used. Use with caution.
710
- */
711
- overrideEmbeddings?: boolean;
712
-
713
- parentId?: string;
714
-
715
- parentJobId?: string;
716
-
717
- pathPrecision?: number;
718
-
719
- /**
720
- * List of points (label, x, y) in the image where label = 0 for background and 1
721
- * for object.
722
- */
723
- points?: Array<Array<number>>;
724
-
725
- /**
726
- * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
727
- */
728
- polished?: number;
729
-
730
- preset?: string;
731
-
732
- progressPercent?: number;
733
-
734
- /**
735
- * The prompt that guided the asset generation or editing
736
- */
737
- prompt?: string;
738
-
739
- /**
740
- * Increase the fidelity to the prompt during upscale. Default: optimized for your
741
- * preset and style.
742
- */
743
- promptFidelity?: number;
744
-
745
- /**
746
- * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
747
- */
748
- raised?: number;
749
-
750
- /**
751
- * The reference images used for the asset generation or editing
752
- */
753
- referenceImages?: Array<string>;
754
-
755
- /**
756
- * Additional refinement steps before scaling.
757
- *
758
- * If scalingFactor == 1, the refinement process will be applied (1 +
759
- * refinementSteps) times. If scalingFactor > 1, the refinement process will be
760
- * applied refinementSteps times.
761
- */
762
- refinementSteps?: number;
763
-
764
- /**
765
- * Remove background for Grayscale detector
766
- */
767
- removeBackground?: boolean;
768
-
769
- /**
770
- * Size proportion of the input image in the output.
771
- */
772
- resizeOption?: number;
773
-
774
- /**
775
- * Boolean to output the contours.
776
- */
777
- resultContours?: boolean;
778
-
779
- /**
780
- * Boolean to able output the cut out object.
781
- */
782
- resultImage?: boolean;
783
-
784
- /**
785
- * Boolean to able return the masks (binary image) in the response.
786
- */
787
- resultMask?: boolean;
788
-
789
- rootParentId?: string;
790
-
791
- /**
792
- * Save a flipbook of the texture. Deactivated when the input texture is larger
793
- * than 2048x2048px
794
- */
795
- saveFlipbook?: boolean;
796
-
797
- /**
798
- * Scaling factor (when `targetWidth` not specified)
799
- */
800
- scalingFactor?: number;
801
-
802
- /**
803
- * The scheduler used to generate this asset
804
- */
805
- scheduler?: string;
806
-
807
- /**
808
- * The seed used to generate this asset. <!> Can be a string or a number in some
809
- * cases <!>.
810
- */
811
- seed?: string;
812
-
813
- /**
814
- * Sharpen tiles.
815
- */
816
- sharpen?: boolean;
817
-
818
- /**
819
- * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
820
- */
821
- shiny?: number;
822
-
823
- size?: number;
824
-
825
- /**
826
- * Activate sketch detection instead of canny.
827
- */
828
- sketch?: boolean;
829
-
830
- sourceProjectId?: string;
831
-
832
- spliceThreshold?: number;
833
-
834
- /**
835
- * The strength
836
- *
837
- * Only available for the `flux-kontext` LoRA model.
838
- */
839
- strength?: number;
840
-
841
- /**
842
- * Strength for the input image structure preservation
843
- */
844
- structureFidelity?: number;
845
-
846
- /**
847
- * The control image for structure. A canny detector will be applied to this image.
848
- * Must reference an existing AssetId.
849
- */
850
- structureImage?: string;
851
-
852
- style?:
853
- | '3d-cartoon'
854
- | '3d-rendered'
855
- | 'anime'
856
- | 'cartoon'
857
- | 'cinematic'
858
- | 'claymation'
859
- | 'cloud-skydome'
860
- | 'comic'
861
- | 'cyberpunk'
862
- | 'enchanted'
863
- | 'fantasy'
864
- | 'ink'
865
- | 'manga'
866
- | 'manga-color'
867
- | 'minimalist'
868
- | 'neon-tron'
869
- | 'oil-painting'
870
- | 'pastel'
871
- | 'photo'
872
- | 'photography'
873
- | 'psychedelic'
874
- | 'retro-fantasy'
875
- | 'scifi-concept-art'
876
- | 'space'
877
- | 'standard'
878
- | 'whimsical';
879
-
880
- /**
881
- * The higher the value the more it will look like the style image(s)
882
- */
883
- styleFidelity?: number;
884
-
885
- /**
886
- * List of style images. Most of the time, only one image is enough. It must be
887
- * existing AssetIds.
888
- */
889
- styleImages?: Array<string>;
890
-
891
- /**
892
- * Condition the influence of the style image(s). The higher the value, the more
893
- * the style images will influence the upscaled image.
894
- */
895
- styleImagesFidelity?: number;
896
-
897
- /**
898
- * The target height of the output image.
899
- */
900
- targetHeight?: number;
901
-
902
- /**
903
- * Target width for the upscaled image, take priority over scaling factor
904
- */
905
- targetWidth?: number;
906
-
907
- /**
908
- * A textual description / keywords describing the object of interest.
909
- */
910
- text?: string;
911
-
912
- /**
913
- * The asset to convert in texture maps. Must reference an existing AssetId.
914
- */
915
- texture?: string;
916
-
917
- /**
918
- * The thumbnail of the canvas
919
- */
920
- thumbnail?: Metadata.Thumbnail;
921
-
922
- /**
923
- * If set to true, during the upscaling process, the model will match tiles of the
924
- * source image with tiles of the style image(s). This will result in a more
925
- * coherent restyle. Works best with style images that have a similar composition.
926
- */
927
- tileStyle?: boolean;
928
-
929
- trainingImage?: boolean;
930
-
931
- /**
932
- * (deprecated) Vertical expansion ratio.
933
- */
934
- verticalExpansionRatio?: number;
935
-
936
- /**
937
- * The width of the rendered image.
938
- */
939
- width?: number;
940
- }
941
-
942
- export namespace Metadata {
943
- export interface Concept {
944
- /**
945
- * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
946
- */
947
- modelId: string;
948
-
949
- /**
950
- * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
951
- * is between 0 and 2.
952
- */
953
- scale: number;
954
-
955
- /**
956
- * The epoch of the model (example: "000001") Only available for Flux Lora Trained
957
- * models
958
- */
959
- modelEpoch?: string;
960
- }
961
-
962
- /**
963
- * The thumbnail of the canvas
964
- */
965
- export interface Thumbnail {
966
- /**
967
- * The AssetId of the image used as a thumbnail for the canvas (example:
968
- * "asset_GTrL3mq4SXWyMxkOHRxlpw")
969
- */
970
- assetId: string;
971
-
972
- /**
973
- * The url of the image used as a thumbnail for the canvas
974
- */
975
- url: string;
976
- }
977
- }
978
-
979
- /**
980
- * The properties of the asset, content may depend on the kind of asset returned
981
- */
982
- export interface Properties {
983
- size: number;
984
-
985
- /**
986
- * Number of animation frames if animations exist
987
- */
988
- animationFrameCount?: number;
989
-
990
- /**
991
- * Bitrate of the media in bits per second
992
- */
993
- bitrate?: number;
994
-
995
- /**
996
- * Number of bones if skeleton exists
997
- */
998
- boneCount?: number;
999
-
1000
- /**
1001
- * Number of channels of the audio
1002
- */
1003
- channels?: number;
1004
-
1005
- /**
1006
- * Classification of the audio
1007
- */
1008
- classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
1009
-
1010
- /**
1011
- * Codec name of the media
1012
- */
1013
- codecName?: string;
1014
-
1015
- /**
1016
- * Description of the audio
1017
- */
1018
- description?: string;
1019
-
1020
- /**
1021
- * Bounding box dimensions [width, height, depth]
1022
- */
1023
- dimensions?: Array<number>;
1024
-
1025
- /**
1026
- * Duration of the media in seconds
1027
- */
1028
- duration?: number;
1029
-
1030
- /**
1031
- * Number of faces/triangles in the mesh
1032
- */
1033
- faceCount?: number;
1034
-
1035
- /**
1036
- * Format of the mesh file (e.g. 'glb', etc.)
1037
- */
1038
- format?: string;
1039
-
1040
- /**
1041
- * Frame rate of the video in frames per second
1042
- */
1043
- frameRate?: number;
1044
-
1045
- /**
1046
- * Whether the mesh has animations
1047
- */
1048
- hasAnimations?: boolean;
1049
-
1050
- /**
1051
- * Whether the mesh has normal vectors
1052
- */
1053
- hasNormals?: boolean;
1054
-
1055
- /**
1056
- * Whether the mesh has bones/skeleton
1057
- */
1058
- hasSkeleton?: boolean;
1059
-
1060
- /**
1061
- * Whether the mesh has UV coordinates
1062
- */
1063
- hasUVs?: boolean;
1064
-
1065
- height?: number;
1066
-
1067
- /**
1068
- * Number of frames in the video
1069
- */
1070
- nbFrames?: number;
1071
-
1072
- /**
1073
- * Sample rate of the media in Hz
1074
- */
1075
- sampleRate?: number;
1076
-
1077
- /**
1078
- * Transcription of the audio
1079
- */
1080
- transcription?: Properties.Transcription;
1081
-
1082
- /**
1083
- * Number of vertices in the mesh
1084
- */
1085
- vertexCount?: number;
1086
-
1087
- width?: number;
1088
- }
1089
-
1090
- export namespace Properties {
1091
- /**
1092
- * Transcription of the audio
1093
- */
1094
- export interface Transcription {
1095
- text: string;
1096
- }
1097
- }
1098
-
1099
- /**
1100
- * The video asset's first frame.
1101
- *
1102
- * Contains the assetId and the url of the first frame.
1103
- */
1104
- export interface FirstFrame {
1105
- assetId: string;
1106
-
1107
- url: string;
1108
- }
1109
-
1110
- /**
1111
- * The video asset's last frame.
1112
- *
1113
- * Contains the assetId and the url of the last frame.
1114
- */
1115
- export interface LastFrame {
1116
- assetId: string;
1117
-
1118
- url: string;
1119
- }
1120
-
1121
- /**
1122
- * The asset's preview.
1123
- *
1124
- * Contains the assetId and the url of the preview.
1125
- */
1126
- export interface Preview {
1127
- assetId: string;
1128
-
1129
- url: string;
1130
- }
1131
-
1132
- /**
1133
- * The asset's thumbnail.
1134
- *
1135
- * Contains the assetId and the url of the thumbnail.
1136
- */
1137
- export interface Thumbnail {
1138
- assetId: string;
1139
-
1140
- url: string;
1141
- }
1142
- }
1143
- }
1144
-
1145
- export interface PublicListResponse {
1146
- assets: Array<PublicListResponse.Asset>;
1147
-
1148
- /**
1149
- * A token to query the next page of assets
1150
- */
1151
- nextPaginationToken?: string;
1152
- }
1153
-
1154
- export namespace PublicListResponse {
1155
- export interface Asset {
1156
- /**
1157
- * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
1158
- */
1159
- id: string;
1160
-
1161
- /**
1162
- * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
1163
- */
1164
- authorId: string;
1165
-
1166
- /**
1167
- * A list of CollectionId this asset belongs to
1168
- */
1169
- collectionIds: Array<string>;
1170
-
1171
- /**
1172
- * The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
1173
- */
1174
- createdAt: string;
1175
-
1176
- /**
1177
- * List of edit capabilities
1178
- */
1179
- editCapabilities: Array<
1180
- | 'DETECTION'
1181
- | 'GENERATIVE_FILL'
1182
- | 'PIXELATE'
1183
- | 'PROMPT_EDITING'
1184
- | 'REFINE'
1185
- | 'REFRAME'
1186
- | 'REMOVE_BACKGROUND'
1187
- | 'SEGMENTATION'
1188
- | 'UPSCALE'
1189
- | 'UPSCALE_360'
1190
- | 'VECTORIZATION'
1191
- >;
1192
-
1193
- /**
1194
- * The kind of asset
1195
- */
1196
- kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1197
-
1198
- /**
1199
- * Metadata of the asset with some additional information
1200
- */
1201
- metadata: Asset.Metadata;
1202
-
1203
- /**
1204
- * The mime type of the asset (example: "image/png")
1205
- */
1206
- mimeType: string;
1207
-
1208
- /**
1209
- * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
1210
- * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
1211
- */
1212
- ownerId: string;
1213
-
1214
- /**
1215
- * The privacy of the asset
1216
- */
1217
- privacy: 'private' | 'public' | 'unlisted';
1218
-
1219
- /**
1220
- * The properties of the asset, content may depend on the kind of asset returned
1221
- */
1222
- properties: Asset.Properties;
1223
-
1224
- /**
1225
- * source of the asset
1226
- */
1227
- source:
1228
- | '3d23d'
1229
- | '3d23d:texture'
1230
- | '3d:texture'
1231
- | '3d:texture:albedo'
1232
- | '3d:texture:metallic'
1233
- | '3d:texture:mtl'
1234
- | '3d:texture:normal'
1235
- | '3d:texture:roughness'
1236
- | 'audio2audio'
1237
- | 'background-removal'
1238
- | 'canvas'
1239
- | 'canvas-drawing'
1240
- | 'canvas-export'
1241
- | 'detection'
1242
- | 'generative-fill'
1243
- | 'image-prompt-editing'
1244
- | 'img23d'
1245
- | 'img2img'
1246
- | 'img2video'
1247
- | 'inference-control-net'
1248
- | 'inference-control-net-img'
1249
- | 'inference-control-net-inpainting'
1250
- | 'inference-control-net-inpainting-ip-adapter'
1251
- | 'inference-control-net-ip-adapter'
1252
- | 'inference-control-net-reference'
1253
- | 'inference-control-net-texture'
1254
- | 'inference-img'
1255
- | 'inference-img-ip-adapter'
1256
- | 'inference-img-texture'
1257
- | 'inference-in-paint'
1258
- | 'inference-in-paint-ip-adapter'
1259
- | 'inference-reference'
1260
- | 'inference-reference-texture'
1261
- | 'inference-txt'
1262
- | 'inference-txt-ip-adapter'
1263
- | 'inference-txt-texture'
1264
- | 'patch'
1265
- | 'pixelization'
1266
- | 'reframe'
1267
- | 'restyle'
1268
- | 'segment'
1269
- | 'segmentation-image'
1270
- | 'segmentation-mask'
1271
- | 'skybox-3d'
1272
- | 'skybox-base-360'
1273
- | 'skybox-hdri'
1274
- | 'texture'
1275
- | 'texture:albedo'
1276
- | 'texture:ao'
1277
- | 'texture:edge'
1278
- | 'texture:height'
1279
- | 'texture:metallic'
1280
- | 'texture:normal'
1281
- | 'texture:smoothness'
1282
- | 'txt23d'
1283
- | 'txt2audio'
1284
- | 'txt2img'
1285
- | 'txt2video'
1286
- | 'unknown'
1287
- | 'uploaded'
1288
- | 'uploaded-3d'
1289
- | 'uploaded-audio'
1290
- | 'uploaded-avatar'
1291
- | 'uploaded-video'
1292
- | 'upscale'
1293
- | 'upscale-skybox'
1294
- | 'upscale-texture'
1295
- | 'upscale-video'
1296
- | 'vectorization'
1297
- | 'video23d'
1298
- | 'video2img'
1299
- | 'video2video'
1300
- | 'voice-clone';
1301
-
1302
- /**
1303
- * The actual status
1304
- */
1305
- status: 'error' | 'pending' | 'success';
1306
-
1307
- /**
1308
- * The associated tags (example: ["sci-fi", "landscape"])
1309
- */
1310
- tags: Array<string>;
1311
-
1312
- /**
1313
- * The asset last update date as an ISO string (example:
1314
- * "2023-02-03T11:19:41.579Z")
1315
- */
1316
- updatedAt: string;
1317
-
1318
- /**
1319
- * Signed URL to get the asset content
1320
- */
1321
- url: string;
1322
-
1323
- /**
1324
- * Automatic captioning of the asset
1325
- */
1326
- automaticCaptioning?: string;
1327
-
1328
- /**
1329
- * The description, it will contain in priority:
1330
- *
1331
- * - the manual description
1332
- * - the advanced captioning when the asset is used in training flow
1333
- * - the automatic captioning
1334
- */
1335
- description?: string;
1336
-
1337
- /**
1338
- * The embedding of the asset when requested.
1339
- *
1340
- * Only available when an asset can be embedded (ie: not Detection maps)
1341
- */
1342
- embedding?: Array<number>;
1343
-
1344
- /**
1345
- * The video asset's first frame.
1346
- *
1347
- * Contains the assetId and the url of the first frame.
1348
- */
1349
- firstFrame?: Asset.FirstFrame;
1350
-
1351
- /**
1352
- * Whether the asset is hidden.
1353
- */
1354
- isHidden?: boolean;
1355
-
1356
- /**
1357
- * The video asset's last frame.
1358
- *
1359
- * Contains the assetId and the url of the last frame.
1360
- */
1361
- lastFrame?: Asset.LastFrame;
1362
-
1363
- /**
1364
- * The NSFW labels
1365
- */
1366
- nsfw?: Array<string>;
1367
-
1368
- /**
1369
- * The original file url.
1370
- *
1371
- * Contains the url of the original file. without any conversion. Only available
1372
- * for some specific video, audio and threeD assets. Is only specified if the given
1373
- * asset data has been replaced with a new file during the creation of the asset.
1374
- */
1375
- originalFileUrl?: string;
1376
-
1377
- /**
1378
- * The output index of the asset within a job This index is an positive integer
1379
- * that starts at 0 It is used to differentiate between multiple outputs of the
1380
- * same job If the job has only one output, this index is 0
1381
- */
1382
- outputIndex?: number;
1383
-
1384
- /**
1385
- * The asset's preview.
1386
- *
1387
- * Contains the assetId and the url of the preview.
1388
- */
1389
- preview?: Asset.Preview;
1390
-
1391
- /**
1392
- * The asset's thumbnail.
1393
- *
1394
- * Contains the assetId and the url of the thumbnail.
1395
- */
1396
- thumbnail?: Asset.Thumbnail;
1397
- }
1398
-
1399
- export namespace Asset {
1400
- /**
1401
- * Metadata of the asset with some additional information
1402
- */
1403
- export interface Metadata {
1404
- kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
1405
-
1406
- /**
1407
- * The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
1408
- * from a text to image model
1409
- */
1410
- type:
1411
- | '3d-texture'
1412
- | '3d-texture-albedo'
1413
- | '3d-texture-metallic'
1414
- | '3d-texture-mtl'
1415
- | '3d-texture-normal'
1416
- | '3d-texture-roughness'
1417
- | '3d23d'
1418
- | '3d23d-texture'
1419
- | 'audio2audio'
1420
- | 'background-removal'
1421
- | 'canvas'
1422
- | 'canvas-drawing'
1423
- | 'canvas-export'
1424
- | 'detection'
1425
- | 'generative-fill'
1426
- | 'image-prompt-editing'
1427
- | 'img23d'
1428
- | 'img2img'
1429
- | 'img2video'
1430
- | 'inference-controlnet'
1431
- | 'inference-controlnet-img2img'
1432
- | 'inference-controlnet-inpaint'
1433
- | 'inference-controlnet-inpaint-ip-adapter'
1434
- | 'inference-controlnet-ip-adapter'
1435
- | 'inference-controlnet-reference'
1436
- | 'inference-controlnet-texture'
1437
- | 'inference-img2img'
1438
- | 'inference-img2img-ip-adapter'
1439
- | 'inference-img2img-texture'
1440
- | 'inference-inpaint'
1441
- | 'inference-inpaint-ip-adapter'
1442
- | 'inference-reference'
1443
- | 'inference-reference-texture'
1444
- | 'inference-txt2img'
1445
- | 'inference-txt2img-ip-adapter'
1446
- | 'inference-txt2img-texture'
1447
- | 'patch'
1448
- | 'pixelization'
1449
- | 'reframe'
1450
- | 'restyle'
1451
- | 'segment'
1452
- | 'segmentation-image'
1453
- | 'segmentation-mask'
1454
- | 'skybox-3d'
1455
- | 'skybox-base-360'
1456
- | 'skybox-hdri'
1457
- | 'texture'
1458
- | 'texture-albedo'
1459
- | 'texture-ao'
1460
- | 'texture-edge'
1461
- | 'texture-height'
1462
- | 'texture-metallic'
1463
- | 'texture-normal'
1464
- | 'texture-smoothness'
1465
- | 'txt23d'
1466
- | 'txt2audio'
1467
- | 'txt2img'
1468
- | 'txt2video'
1469
- | 'unknown'
1470
- | 'uploaded'
1471
- | 'uploaded-3d'
1472
- | 'uploaded-audio'
1473
- | 'uploaded-avatar'
1474
- | 'uploaded-video'
1475
- | 'upscale'
1476
- | 'upscale-skybox'
1477
- | 'upscale-texture'
1478
- | 'upscale-video'
1479
- | 'vectorization'
1480
- | 'video23d'
1481
- | 'video2img'
1482
- | 'video2video'
1483
- | 'voice-clone';
1484
-
1485
- /**
1486
- * How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
1487
- */
1488
- angular?: number;
1489
-
1490
- /**
1491
- * The optional aspect ratio given for the generation, only applicable for some
1492
- * models
1493
- */
1494
- aspectRatio?: string;
1495
-
1496
- /**
1497
- * Int to set between 0 and 255 for the opacity of the background in the result
1498
- * images.
1499
- */
1500
- backgroundOpacity?: number;
1501
-
1502
- /**
1503
- * The baseModelId that maybe changed at inference time
1504
- */
1505
- baseModelId?: string;
1506
-
1507
- /**
1508
- * A bounding box around the object of interest, in the format [x1, y1, x2, y2].
1509
- */
1510
- bbox?: Array<number>;
1511
-
1512
- /**
1513
- * Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
1514
- */
1515
- betterQuality?: boolean;
1516
-
1517
- /**
1518
- * The control image already processed by canny detector. Must reference an
1519
- * existing AssetId.
1520
- */
1521
- cannyStructureImage?: string;
1522
-
1523
- /**
1524
- * Activate clustering.
1525
- */
1526
- clustering?: boolean;
1527
-
1528
- /**
1529
- * Ensure upscaled tile have the same color histogram as original tile.
1530
- */
1531
- colorCorrection?: boolean;
1532
-
1533
- colorMode?: string;
1534
-
1535
- colorPrecision?: number;
1536
-
1537
- /**
1538
- * Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
1539
- */
1540
- concepts?: Array<Metadata.Concept>;
1541
-
1542
- contours?: Array<Array<Array<Array<number>>>>;
1543
-
1544
- /**
1545
- * End step for control.
1546
- */
1547
- controlEnd?: number;
1548
-
1549
- /**
1550
- * The date when the asset was copied to a project
1551
- */
1552
- copiedAt?: string;
1553
-
1554
- cornerThreshold?: number;
1555
-
1556
- /**
1557
- * Allow the generation of "hallucinations" during the upscale process, which adds
1558
- * additional details and deviates from the original image. Default: optimized for
1559
- * your preset and style.
1560
- */
1561
- creativity?: number;
1562
-
1563
- /**
1564
- * Amount of decay in creativity over the upscale process. The lowest the value,
1565
- * the less the creativity will be preserved over the upscale process.
1566
- */
1567
- creativityDecay?: number;
1568
-
1569
- /**
1570
- * If true, use the default parameters
1571
- */
1572
- defaultParameters?: boolean;
1573
-
1574
- /**
1575
- * The depth fidelity if a depth image provided
1576
- */
1577
- depthFidelity?: number;
1578
-
1579
- /**
1580
- * The control image processed by depth estimator. Must reference an existing
1581
- * AssetId.
1582
- */
1583
- depthImage?: string;
1584
-
1585
- /**
1586
- * Amount of details to remove or add
1587
- */
1588
- detailsLevel?: number;
1589
-
1590
- /**
1591
- * The number of pixels to dilate the result masks.
1592
- */
1593
- dilate?: number;
1594
-
1595
- /**
1596
- * Contrast factor for Grayscale detector
1597
- */
1598
- factor?: number;
1599
-
1600
- filterSpeckle?: number;
1601
-
1602
- /**
1603
- * Determine the scale at which the upscale process works.
1604
- *
1605
- * - With a small value, the upscale works at the largest scale, resulting in fewer
1606
- * added details and more coherent images. Ideal for portraits, for example.
1607
- * - With a large value, the upscale works at the smallest scale, resulting in more
1608
- * added details and more hallucinations. Ideal for landscapes, for example.
1609
- *
1610
- * (info): A small value is slower and more expensive to run.
1611
- */
1612
- fractality?: number;
1613
-
1614
- /**
1615
- * Apply extra control to the Skybox 360 geometry. The higher the value, the more
1616
- * the 360 geometry will influence the generated skybox image.
1617
- *
1618
- * Use with caution. Default is adapted to the other parameters.
1619
- */
1620
- geometryEnforcement?: number;
1621
-
1622
- /**
1623
- * The guidance used to generate this asset
1624
- */
1625
- guidance?: number;
1626
-
1627
- halfMode?: boolean;
1628
-
1629
- hdr?: number;
1630
-
1631
- height?: number;
1632
-
1633
- /**
1634
- * High threshold for Canny detector
1635
- */
1636
- highThreshold?: number;
1637
-
1638
- /**
1639
- * (deprecated) Horizontal expansion ratio.
1640
- */
1641
- horizontalExpansionRatio?: number;
1642
-
1643
- /**
1644
- * The input image to process. Must reference an existing AssetId or be a data URL.
1645
- */
1646
- image?: string;
1647
-
1648
- /**
1649
- * Strengthen the similarity to the original image during the upscale. Default:
1650
- * optimized for your preset and style.
1651
- */
1652
- imageFidelity?: number;
1653
-
1654
- /**
1655
- * Preserve the seamless properties of skybox or texture images. Input has to be of
1656
- * same type (seamless).
1657
- */
1658
- imageType?: 'seamfull' | 'skybox' | 'texture';
1659
-
1660
- /**
1661
- * The id of the Inference describing how this image was generated
1662
- */
1663
- inferenceId?: string;
1664
-
1665
- /**
1666
- * When set to `high`, allows to better preserve details from the input images in
1667
- * the output. This is especially useful when using images that contain elements
1668
- * like faces or logos that require accurate preservation in the generated image.
1669
- *
1670
- * You can provide multiple input images that will all be preserved with high
1671
- * fidelity, but keep in mind that the first image will be preserved with richer
1672
- * textures and finer details, so if you include elements such as faces, consider
1673
- * placing them in the first image.
1674
- *
1675
- * Only available for the `gpt-image-1` model.
1676
- */
1677
- inputFidelity?: 'high' | 'low';
1678
-
1679
- /**
1680
- * Location of the input image in the output.
1681
- */
1682
- inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
1683
-
1684
- /**
1685
- * To invert the relief
1686
- */
1687
- invert?: boolean;
1688
-
1689
- /**
1690
- * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1691
- */
1692
- keypointThreshold?: number;
1693
-
1694
- layerDifference?: number;
1695
-
1696
- lengthThreshold?: number;
1697
-
1698
- /**
1699
- * The ISO timestamp when the lock on the canvas will expire
1700
- */
1701
- lockExpiresAt?: string;
1702
-
1703
- /**
1704
- * Low threshold for Canny detector
1705
- */
1706
- lowThreshold?: number;
1707
-
1708
- /**
1709
- * The mask used for the asset generation or editing
1710
- */
1711
- mask?: string;
1712
-
1713
- maxIterations?: number;
1714
-
1715
- /**
1716
- * Maximum threshold for Grayscale conversion
1717
- */
1718
- maxThreshold?: number;
1719
-
1720
- /**
1721
- * Minimum threshold for Grayscale conversion
1722
- */
1723
- minThreshold?: number;
1724
-
1725
- /**
1726
- * Modality to detect
1727
- */
1728
- modality?:
1729
- | 'canny'
1730
- | 'depth'
1731
- | 'grayscale'
1732
- | 'lineart_anime'
1733
- | 'mlsd'
1734
- | 'normal'
1735
- | 'pose'
1736
- | 'scribble'
1737
- | 'segmentation'
1738
- | 'sketch';
1739
-
1740
- mode?: string;
1741
-
1742
- /**
1743
- * The modelId used to generate this asset
1744
- */
1745
- modelId?: string;
1746
-
1747
- /**
1748
- * The type of the generator used
1749
- */
1750
- modelType?:
1751
- | 'custom'
1752
- | 'elevenlabs-voice'
1753
- | 'flux.1'
1754
- | 'flux.1-composition'
1755
- | 'flux.1-kontext-dev'
1756
- | 'flux.1-kontext-lora'
1757
- | 'flux.1-krea-dev'
1758
- | 'flux.1-krea-lora'
1759
- | 'flux.1-lora'
1760
- | 'flux.1-pro'
1761
- | 'flux.1.1-pro-ultra'
1762
- | 'flux.2-dev-edit-lora'
1763
- | 'flux.2-dev-lora'
1764
- | 'flux.2-klein-4b-edit-lora'
1765
- | 'flux.2-klein-4b-lora'
1766
- | 'flux.2-klein-9b-edit-lora'
1767
- | 'flux.2-klein-9b-lora'
1768
- | 'flux.2-klein-base-4b-edit-lora'
1769
- | 'flux.2-klein-base-4b-lora'
1770
- | 'flux.2-klein-base-9b-edit-lora'
1771
- | 'flux.2-klein-base-9b-lora'
1772
- | 'flux1.1-pro'
1773
- | 'gpt-image-1'
1774
- | 'qwen-image-2512-lora'
1775
- | 'qwen-image-edit-2509-lora'
1776
- | 'qwen-image-edit-2511-lora'
1777
- | 'qwen-image-edit-lora'
1778
- | 'qwen-image-lora'
1779
- | 'sd-1_5'
1780
- | 'sd-1_5-composition'
1781
- | 'sd-1_5-lora'
1782
- | 'sd-xl'
1783
- | 'sd-xl-composition'
1784
- | 'sd-xl-lora'
1785
- | 'zimage-de-turbo-lora'
1786
- | 'zimage-lora'
1787
- | 'zimage-turbo-lora';
1788
-
1789
- name?: string;
1790
-
1791
- nbMasks?: number;
1792
-
1793
- /**
1794
- * The negative prompt used to generate this asset
1795
- */
1796
- negativePrompt?: string;
1797
-
1798
- /**
1799
- * Controls the influence of the negative prompt. Default 0 means the negative
1800
- * prompt has no effect. Higher values increase negative prompt influence. Must
1801
- * be > 0 if negativePrompt is provided.
1802
- */
1803
- negativePromptStrength?: number;
1804
-
1805
- /**
1806
- * The number of denoising steps for each image generation.
1807
- */
1808
- numInferenceSteps?: number;
1809
-
1810
- /**
1811
- * The number of outputs to generate.
1812
- */
1813
- numOutputs?: number;
1814
-
1815
- originalAssetId?: string;
1816
-
1817
- outputIndex?: number;
1818
-
1819
- /**
1820
- * Overlap percentage for the output image.
1821
- */
1822
- overlapPercentage?: number;
1823
-
1824
- /**
1825
- * Override the embeddings of the model. Only your prompt and negativePrompt will
1826
- * be used. Use with caution.
1827
- */
1828
- overrideEmbeddings?: boolean;
1829
-
1830
- parentId?: string;
1831
-
1832
- parentJobId?: string;
1833
-
1834
- pathPrecision?: number;
1835
-
1836
- /**
1837
- * List of points (label, x, y) in the image where label = 0 for background and 1
1838
- * for object.
1839
- */
1840
- points?: Array<Array<number>>;
1841
-
1842
- /**
1843
- * How polished is the surface? 0 is like a rough surface, 1 is like a mirror
1844
- */
1845
- polished?: number;
1846
-
1847
- preset?: string;
1848
-
1849
- progressPercent?: number;
1850
-
1851
- /**
1852
- * The prompt that guided the asset generation or editing
1853
- */
1854
- prompt?: string;
1855
-
1856
- /**
1857
- * Increase the fidelity to the prompt during upscale. Default: optimized for your
1858
- * preset and style.
1859
- */
1860
- promptFidelity?: number;
1861
-
1862
- /**
1863
- * How raised is the surface? 0 is flat like water, 1 is like a very rough rock
1864
- */
1865
- raised?: number;
1866
-
1867
- /**
1868
- * The reference images used for the asset generation or editing
1869
- */
1870
- referenceImages?: Array<string>;
1871
-
1872
- /**
1873
- * Additional refinement steps before scaling.
1874
- *
1875
- * If scalingFactor == 1, the refinement process will be applied (1 +
1876
- * refinementSteps) times. If scalingFactor > 1, the refinement process will be
1877
- * applied refinementSteps times.
1878
- */
1879
- refinementSteps?: number;
1880
-
1881
- /**
1882
- * Remove background for Grayscale detector
1883
- */
1884
- removeBackground?: boolean;
1885
-
1886
- /**
1887
- * Size proportion of the input image in the output.
1888
- */
1889
- resizeOption?: number;
1890
-
1891
- /**
1892
- * Boolean to output the contours.
1893
- */
1894
- resultContours?: boolean;
1895
-
1896
- /**
1897
- * Boolean to able output the cut out object.
1898
- */
1899
- resultImage?: boolean;
1900
-
1901
- /**
1902
- * Boolean to able return the masks (binary image) in the response.
1903
- */
1904
- resultMask?: boolean;
1905
-
1906
- rootParentId?: string;
1907
-
1908
- /**
1909
- * Save a flipbook of the texture. Deactivated when the input texture is larger
1910
- * than 2048x2048px
1911
- */
1912
- saveFlipbook?: boolean;
1913
-
1914
- /**
1915
- * Scaling factor (when `targetWidth` not specified)
1916
- */
1917
- scalingFactor?: number;
1918
-
1919
- /**
1920
- * The scheduler used to generate this asset
1921
- */
1922
- scheduler?: string;
1923
-
1924
- /**
1925
- * The seed used to generate this asset. <!> Can be a string or a number in some
1926
- * cases <!>.
1927
- */
1928
- seed?: string;
1929
-
1930
- /**
1931
- * Sharpen tiles.
1932
- */
1933
- sharpen?: boolean;
1934
-
1935
- /**
1936
- * How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
1937
- */
1938
- shiny?: number;
1939
-
1940
- size?: number;
1941
-
1942
- /**
1943
- * Activate sketch detection instead of canny.
1944
- */
1945
- sketch?: boolean;
1946
-
1947
- sourceProjectId?: string;
1948
-
1949
- spliceThreshold?: number;
1950
-
1951
- /**
1952
- * The strength
1953
- *
1954
- * Only available for the `flux-kontext` LoRA model.
1955
- */
1956
- strength?: number;
1957
-
1958
- /**
1959
- * Strength for the input image structure preservation
1960
- */
1961
- structureFidelity?: number;
1962
-
1963
- /**
1964
- * The control image for structure. A canny detector will be applied to this image.
1965
- * Must reference an existing AssetId.
1966
- */
1967
- structureImage?: string;
1968
-
1969
- style?:
1970
- | '3d-cartoon'
1971
- | '3d-rendered'
1972
- | 'anime'
1973
- | 'cartoon'
1974
- | 'cinematic'
1975
- | 'claymation'
1976
- | 'cloud-skydome'
1977
- | 'comic'
1978
- | 'cyberpunk'
1979
- | 'enchanted'
1980
- | 'fantasy'
1981
- | 'ink'
1982
- | 'manga'
1983
- | 'manga-color'
1984
- | 'minimalist'
1985
- | 'neon-tron'
1986
- | 'oil-painting'
1987
- | 'pastel'
1988
- | 'photo'
1989
- | 'photography'
1990
- | 'psychedelic'
1991
- | 'retro-fantasy'
1992
- | 'scifi-concept-art'
1993
- | 'space'
1994
- | 'standard'
1995
- | 'whimsical';
1996
-
1997
- /**
1998
- * The higher the value the more it will look like the style image(s)
1999
- */
2000
- styleFidelity?: number;
2001
-
2002
- /**
2003
- * List of style images. Most of the time, only one image is enough. It must be
2004
- * existing AssetIds.
2005
- */
2006
- styleImages?: Array<string>;
2007
-
2008
- /**
2009
- * Condition the influence of the style image(s). The higher the value, the more
2010
- * the style images will influence the upscaled image.
2011
- */
2012
- styleImagesFidelity?: number;
2013
-
2014
- /**
2015
- * The target height of the output image.
2016
- */
2017
- targetHeight?: number;
2018
-
2019
- /**
2020
- * Target width for the upscaled image, take priority over scaling factor
2021
- */
2022
- targetWidth?: number;
2023
-
2024
- /**
2025
- * A textual description / keywords describing the object of interest.
2026
- */
2027
- text?: string;
2028
-
2029
- /**
2030
- * The asset to convert in texture maps. Must reference an existing AssetId.
2031
- */
2032
- texture?: string;
2033
-
2034
- /**
2035
- * The thumbnail of the canvas
2036
- */
2037
- thumbnail?: Metadata.Thumbnail;
2038
-
2039
- /**
2040
- * If set to true, during the upscaling process, the model will match tiles of the
2041
- * source image with tiles of the style image(s). This will result in a more
2042
- * coherent restyle. Works best with style images that have a similar composition.
2043
- */
2044
- tileStyle?: boolean;
2045
-
2046
- trainingImage?: boolean;
2047
-
2048
- /**
2049
- * (deprecated) Vertical expansion ratio.
2050
- */
2051
- verticalExpansionRatio?: number;
2052
-
2053
- /**
2054
- * The width of the rendered image.
2055
- */
2056
- width?: number;
2057
- }
2058
-
2059
- export namespace Metadata {
2060
- export interface Concept {
2061
- /**
2062
- * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
2063
- */
2064
- modelId: string;
2065
-
2066
- /**
2067
- * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
2068
- * is between 0 and 2.
2069
- */
2070
- scale: number;
2071
-
2072
- /**
2073
- * The epoch of the model (example: "000001") Only available for Flux Lora Trained
2074
- * models
2075
- */
2076
- modelEpoch?: string;
2077
- }
2078
-
2079
- /**
2080
- * The thumbnail of the canvas
2081
- */
2082
- export interface Thumbnail {
2083
- /**
2084
- * The AssetId of the image used as a thumbnail for the canvas (example:
2085
- * "asset_GTrL3mq4SXWyMxkOHRxlpw")
2086
- */
2087
- assetId: string;
2088
-
2089
- /**
2090
- * The url of the image used as a thumbnail for the canvas
2091
- */
2092
- url: string;
2093
- }
2094
- }
2095
-
2096
- /**
2097
- * The properties of the asset, content may depend on the kind of asset returned
2098
- */
2099
- export interface Properties {
2100
- size: number;
2101
-
2102
- /**
2103
- * Number of animation frames if animations exist
2104
- */
2105
- animationFrameCount?: number;
2106
-
2107
- /**
2108
- * Bitrate of the media in bits per second
2109
- */
2110
- bitrate?: number;
2111
-
2112
- /**
2113
- * Number of bones if skeleton exists
2114
- */
2115
- boneCount?: number;
2116
-
2117
- /**
2118
- * Number of channels of the audio
2119
- */
2120
- channels?: number;
2121
-
2122
- /**
2123
- * Classification of the audio
2124
- */
2125
- classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
2126
-
2127
- /**
2128
- * Codec name of the media
2129
- */
2130
- codecName?: string;
2131
-
2132
- /**
2133
- * Description of the audio
2134
- */
2135
- description?: string;
2136
-
2137
- /**
2138
- * Bounding box dimensions [width, height, depth]
2139
- */
2140
- dimensions?: Array<number>;
2141
-
2142
- /**
2143
- * Duration of the media in seconds
2144
- */
2145
- duration?: number;
2146
-
2147
- /**
2148
- * Number of faces/triangles in the mesh
2149
- */
2150
- faceCount?: number;
2151
-
2152
- /**
2153
- * Format of the mesh file (e.g. 'glb', etc.)
2154
- */
2155
- format?: string;
2156
-
2157
- /**
2158
- * Frame rate of the video in frames per second
2159
- */
2160
- frameRate?: number;
2161
-
2162
- /**
2163
- * Whether the mesh has animations
2164
- */
2165
- hasAnimations?: boolean;
2166
-
2167
- /**
2168
- * Whether the mesh has normal vectors
2169
- */
2170
- hasNormals?: boolean;
2171
-
2172
- /**
2173
- * Whether the mesh has bones/skeleton
2174
- */
2175
- hasSkeleton?: boolean;
2176
-
2177
- /**
2178
- * Whether the mesh has UV coordinates
2179
- */
2180
- hasUVs?: boolean;
2181
-
2182
- height?: number;
2183
-
2184
- /**
2185
- * Number of frames in the video
2186
- */
2187
- nbFrames?: number;
2188
-
2189
- /**
2190
- * Sample rate of the media in Hz
2191
- */
2192
- sampleRate?: number;
2193
-
2194
- /**
2195
- * Transcription of the audio
2196
- */
2197
- transcription?: Properties.Transcription;
2198
-
2199
- /**
2200
- * Number of vertices in the mesh
2201
- */
2202
- vertexCount?: number;
2203
-
2204
- width?: number;
2205
- }
2206
-
2207
- export namespace Properties {
2208
- /**
2209
- * Transcription of the audio
2210
- */
2211
- export interface Transcription {
2212
- text: string;
2213
- }
2214
- }
2215
-
2216
- /**
2217
- * The video asset's first frame.
2218
- *
2219
- * Contains the assetId and the url of the first frame.
2220
- */
2221
- export interface FirstFrame {
2222
- assetId: string;
2223
-
2224
- url: string;
2225
- }
2226
-
2227
- /**
2228
- * The video asset's last frame.
2229
- *
2230
- * Contains the assetId and the url of the last frame.
2231
- */
2232
- export interface LastFrame {
2233
- assetId: string;
2234
-
2235
- url: string;
2236
- }
2237
-
2238
- /**
2239
- * The asset's preview.
2240
- *
2241
- * Contains the assetId and the url of the preview.
2242
- */
2243
- export interface Preview {
2244
- assetId: string;
2245
-
2246
- url: string;
2247
- }
2248
-
2249
- /**
2250
- * The asset's thumbnail.
2251
- *
2252
- * Contains the assetId and the url of the thumbnail.
2253
- */
2254
- export interface Thumbnail {
2255
- assetId: string;
2256
-
2257
- url: string;
2258
- }
2259
- }
2260
- }
2261
-
2262
- export interface PublicListParams {
2263
- /**
2264
- * Filter results to only return assets created after the specified ISO string date
2265
- * (exclusive). Requires the sortBy parameter to be "createdAt"
2266
- */
2267
- createdAfter?: string;
2268
-
2269
- /**
2270
- * Filter results to only return assets created before the specified ISO string
2271
- * date (exclusive). Requires the sortBy parameter to be "createdAt"
2272
- */
2273
- createdBefore?: string;
2274
-
2275
- /**
2276
- * List assets generated from all inferences coming from a specific model (this is
2277
- * not the training images)
2278
- */
2279
- modelId?: string;
2280
-
2281
- /**
2282
- * If set to true, returns the original asset without transformation
2283
- */
2284
- originalAssets?: boolean;
2285
-
2286
- /**
2287
- * The number of items to return in the response. The default value is 50, maximum
2288
- * value is 100, minimum value is 1
2289
- */
2290
- pageSize?: number;
2291
-
2292
- /**
2293
- * A token you received in a previous request to query the next page of items
2294
- */
2295
- paginationToken?: string;
2296
-
2297
- /**
2298
- * Sort results by the createdAt or updatedAt
2299
- */
2300
- sortBy?: string;
2301
-
2302
- /**
2303
- * Sort results in ascending (asc) or descending (desc) order
2304
- */
2305
- sortDirection?: string;
2306
-
2307
- /**
2308
- * List of tags, comma separated. Only for public assets on all teams.
2309
- */
2310
- tags?: string;
2311
-
2312
- /**
2313
- * List all the assets of a specific type. The parameter "type" and "types" cannot
2314
- * be used together. Can be any of the following values: inference-txt2img,
2315
- * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
2316
- * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
2317
- * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
2318
- * inference-controlnet, inference-controlnet-ip-adapter,
2319
- * inference-controlnet-img2img, inference-controlnet-reference,
2320
- * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
2321
- * inference-controlnet-texture, background-removal, canvas, canvas-export,
2322
- * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
2323
- * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
2324
- * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
2325
- * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
2326
- * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
2327
- * txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl,
2328
- * 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
2329
- * img2video, txt2audio, audio2audio, voice-clone, video2video, video2img, txt2img,
2330
- * img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d,
2331
- * uploaded-avatar, upscale-video, assets with a type starting with "inference-"
2332
- * will be returned
2333
- */
2334
- type?:
2335
- | 'inference-txt2img'
2336
- | 'inference-txt2img-ip-adapter'
2337
- | 'inference-txt2img-texture'
2338
- | 'inference-img2img'
2339
- | 'inference-img2img-ip-adapter'
2340
- | 'inference-img2img-texture'
2341
- | 'inference-inpaint'
2342
- | 'inference-inpaint-ip-adapter'
2343
- | 'inference-reference'
2344
- | 'inference-reference-texture'
2345
- | 'inference-controlnet'
2346
- | 'inference-controlnet-ip-adapter'
2347
- | 'inference-controlnet-img2img'
2348
- | 'inference-controlnet-reference'
2349
- | 'inference-controlnet-inpaint'
2350
- | 'inference-controlnet-inpaint-ip-adapter'
2351
- | 'inference-controlnet-texture'
2352
- | 'background-removal'
2353
- | 'canvas'
2354
- | 'canvas-export'
2355
- | 'canvas-drawing'
2356
- | 'detection'
2357
- | 'patch'
2358
- | 'pixelization'
2359
- | 'upscale'
2360
- | 'upscale-texture'
2361
- | 'upscale-skybox'
2362
- | 'vectorization'
2363
- | 'segment'
2364
- | 'segmentation-image'
2365
- | 'segmentation-mask'
2366
- | 'skybox-base-360'
2367
- | 'skybox-hdri'
2368
- | 'skybox-3d'
2369
- | 'restyle'
2370
- | 'reframe'
2371
- | 'generative-fill'
2372
- | 'texture'
2373
- | 'texture-height'
2374
- | 'texture-normal'
2375
- | 'texture-smoothness'
2376
- | 'texture-metallic'
2377
- | 'texture-edge'
2378
- | 'texture-ao'
2379
- | 'texture-albedo'
2380
- | 'image-prompt-editing'
2381
- | 'unknown'
2382
- | 'img23d'
2383
- | 'txt23d'
2384
- | 'video23d'
2385
- | '3d23d'
2386
- | '3d23d-texture'
2387
- | '3d-texture'
2388
- | '3d-texture-mtl'
2389
- | '3d-texture-albedo'
2390
- | '3d-texture-normal'
2391
- | '3d-texture-roughness'
2392
- | '3d-texture-metallic'
2393
- | 'img2video'
2394
- | 'txt2audio'
2395
- | 'audio2audio'
2396
- | 'voice-clone'
2397
- | 'video2video'
2398
- | 'video2img'
2399
- | 'txt2img'
2400
- | 'img2img'
2401
- | 'txt2video'
2402
- | 'uploaded'
2403
- | 'uploaded-video'
2404
- | 'uploaded-audio'
2405
- | 'uploaded-3d'
2406
- | 'uploaded-avatar'
2407
- | 'upscale-video';
2408
-
2409
- /**
2410
- * List of the asset types to request. The parameter "type" and "types" cannot be
2411
- * used together. Can be any of the following values: inference-txt2img,
2412
- * inference-txt2img-ip-adapter, inference-txt2img-texture, inference-img2img,
2413
- * inference-img2img-ip-adapter, inference-img2img-texture, inference-inpaint,
2414
- * inference-inpaint-ip-adapter, inference-reference, inference-reference-texture,
2415
- * inference-controlnet, inference-controlnet-ip-adapter,
2416
- * inference-controlnet-img2img, inference-controlnet-reference,
2417
- * inference-controlnet-inpaint, inference-controlnet-inpaint-ip-adapter,
2418
- * inference-controlnet-texture, background-removal, canvas, canvas-export,
2419
- * canvas-drawing, detection, patch, pixelization, upscale, upscale-texture,
2420
- * upscale-skybox, vectorization, segment, segmentation-image, segmentation-mask,
2421
- * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
2422
- * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
2423
- * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
2424
- * txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl,
2425
- * 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
2426
- * img2video, txt2audio, audio2audio, voice-clone, video2video, video2img, txt2img,
2427
- * img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d,
2428
- * uploaded-avatar, upscale-video
2429
- */
2430
- types?: string;
2431
-
2432
- /**
2433
- * Filter results to only return assets updated after the specified ISO string date
2434
- * (exclusive). Requires the sortBy parameter to be "updatedAt"
2435
- */
2436
- updatedAfter?: string;
2437
-
2438
- /**
2439
- * Filter results to only return assets updated before the specified ISO string
2440
- * date (exclusive). Requires the sortBy parameter to be "updatedAt"
2441
- */
2442
- updatedBefore?: string;
2443
- }
2444
-
2445
- export declare namespace Public {
2446
- export {
2447
- type PublicRetrieveResponse as PublicRetrieveResponse,
2448
- type PublicListResponse as PublicListResponse,
2449
- type PublicListParams as PublicListParams,
2450
- };
2451
- }