@scenario-labs/sdk 0.1.3 → 0.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.
- package/CHANGELOG.md +23 -0
- package/LICENSE +1 -1
- package/README.md +29 -29
- package/client.d.mts +35 -18
- package/client.d.mts.map +1 -1
- package/client.d.ts +35 -18
- package/client.d.ts.map +1 -1
- package/client.js +88 -50
- package/client.js.map +1 -1
- package/client.mjs +86 -48
- package/client.mjs.map +1 -1
- package/core/api-promise.d.mts +2 -2
- package/core/api-promise.d.mts.map +1 -1
- package/core/api-promise.d.ts +2 -2
- package/core/api-promise.d.ts.map +1 -1
- package/core/api-promise.js.map +1 -1
- package/core/api-promise.mjs.map +1 -1
- package/core/error.d.mts +2 -2
- package/core/error.d.mts.map +1 -1
- package/core/error.d.ts +2 -2
- package/core/error.d.ts.map +1 -1
- package/core/error.js +4 -4
- package/core/error.js.map +1 -1
- package/core/error.mjs +2 -2
- package/core/error.mjs.map +1 -1
- package/core/resource.d.mts +3 -3
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts +3 -3
- package/core/resource.d.ts.map +1 -1
- package/core/resource.js.map +1 -1
- package/core/resource.mjs.map +1 -1
- package/index.d.mts +8 -3
- package/index.d.mts.map +1 -1
- package/index.d.ts +8 -3
- package/index.d.ts.map +1 -1
- package/index.js +16 -6
- package/index.js.map +1 -1
- package/index.mjs +7 -3
- package/index.mjs.map +1 -1
- package/internal/parse.d.mts +2 -2
- package/internal/parse.d.mts.map +1 -1
- package/internal/parse.d.ts +2 -2
- package/internal/parse.d.ts.map +1 -1
- package/internal/parse.js.map +1 -1
- package/internal/parse.mjs.map +1 -1
- package/internal/request-options.d.mts +4 -0
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts +4 -0
- package/internal/request-options.d.ts.map +1 -1
- package/internal/request-options.js.map +1 -1
- package/internal/request-options.mjs.map +1 -1
- package/internal/shims.js +1 -1
- package/internal/shims.js.map +1 -1
- package/internal/shims.mjs +1 -1
- package/internal/shims.mjs.map +1 -1
- package/internal/uploads.d.mts +4 -4
- package/internal/uploads.d.mts.map +1 -1
- package/internal/uploads.d.ts +4 -4
- package/internal/uploads.d.ts.map +1 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/base64.js +2 -2
- package/internal/utils/base64.js.map +1 -1
- package/internal/utils/base64.mjs +3 -3
- package/internal/utils/base64.mjs.map +1 -1
- package/internal/utils/log.d.mts +3 -3
- package/internal/utils/log.d.mts.map +1 -1
- package/internal/utils/log.d.ts +3 -3
- package/internal/utils/log.d.ts.map +1 -1
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.js +1 -1
- package/internal/utils/path.js.map +1 -1
- package/internal/utils/path.mjs +2 -2
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/values.js +5 -5
- package/internal/utils/values.js.map +1 -1
- package/internal/utils/values.mjs +6 -6
- package/internal/utils/values.mjs.map +1 -1
- package/lib/generate.d.mts +19 -0
- package/lib/generate.d.mts.map +1 -0
- package/lib/generate.d.ts +19 -0
- package/lib/generate.d.ts.map +1 -0
- package/lib/generate.js +35 -0
- package/lib/generate.js.map +1 -0
- package/lib/generate.mjs +31 -0
- package/lib/generate.mjs.map +1 -0
- package/lib/job.d.mts +48 -0
- package/lib/job.d.mts.map +1 -0
- package/lib/job.d.ts +48 -0
- package/lib/job.d.ts.map +1 -0
- package/lib/job.js +50 -0
- package/lib/job.js.map +1 -0
- package/lib/job.mjs +45 -0
- package/lib/job.mjs.map +1 -0
- package/lib/models.d.mts +20 -0
- package/lib/models.d.mts.map +1 -0
- package/lib/models.d.ts +20 -0
- package/lib/models.d.ts.map +1 -0
- package/lib/models.js +28 -0
- package/lib/models.js.map +1 -0
- package/lib/models.mjs +23 -0
- package/lib/models.mjs.map +1 -0
- package/lib/scenario.d.mts +39 -0
- package/lib/scenario.d.mts.map +1 -0
- package/lib/scenario.d.ts +39 -0
- package/lib/scenario.d.ts.map +1 -0
- package/lib/scenario.js +46 -0
- package/lib/scenario.js.map +1 -0
- package/lib/scenario.mjs +42 -0
- package/lib/scenario.mjs.map +1 -0
- package/lib/workflow.d.mts +48 -0
- package/lib/workflow.d.mts.map +1 -0
- package/lib/workflow.d.ts +48 -0
- package/lib/workflow.d.ts.map +1 -0
- package/lib/workflow.js +59 -0
- package/lib/workflow.js.map +1 -0
- package/lib/workflow.mjs +54 -0
- package/lib/workflow.mjs.map +1 -0
- package/package.json +13 -3
- package/resources/assets/assets.d.mts +401 -96
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +401 -96
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js +2 -2
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs +2 -2
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/assets/index.d.mts +1 -1
- package/resources/assets/index.d.mts.map +1 -1
- package/resources/assets/index.d.ts +1 -1
- package/resources/assets/index.d.ts.map +1 -1
- package/resources/assets/index.js.map +1 -1
- package/resources/assets/index.mjs.map +1 -1
- package/resources/assets/public.d.mts +30 -27
- package/resources/assets/public.d.mts.map +1 -1
- package/resources/assets/public.d.ts +30 -27
- package/resources/assets/public.d.ts.map +1 -1
- package/resources/assets/public.js +2 -2
- package/resources/assets/public.js.map +1 -1
- package/resources/assets/public.mjs +2 -2
- package/resources/assets/public.mjs.map +1 -1
- package/resources/collections/assets.d.mts +2 -8
- package/resources/collections/assets.d.mts.map +1 -1
- package/resources/collections/assets.d.ts +2 -8
- package/resources/collections/assets.d.ts.map +1 -1
- package/resources/collections/assets.js +2 -2
- package/resources/collections/assets.js.map +1 -1
- package/resources/collections/assets.mjs +2 -2
- package/resources/collections/assets.mjs.map +1 -1
- package/resources/collections/collections.d.mts +5 -5
- package/resources/collections/collections.d.mts.map +1 -1
- package/resources/collections/collections.d.ts +5 -5
- package/resources/collections/collections.d.ts.map +1 -1
- package/resources/collections/collections.js.map +1 -1
- package/resources/collections/collections.mjs.map +1 -1
- package/resources/collections/index.d.mts +2 -2
- package/resources/collections/index.d.mts.map +1 -1
- package/resources/collections/index.d.ts +2 -2
- package/resources/collections/index.d.ts.map +1 -1
- package/resources/collections/index.js.map +1 -1
- package/resources/collections/index.mjs +2 -2
- package/resources/collections/index.mjs.map +1 -1
- package/resources/collections/models.d.mts +2 -8
- package/resources/collections/models.d.mts.map +1 -1
- package/resources/collections/models.d.ts +2 -8
- package/resources/collections/models.d.ts.map +1 -1
- package/resources/collections/models.js +2 -2
- package/resources/collections/models.js.map +1 -1
- package/resources/collections/models.mjs +2 -2
- package/resources/collections/models.mjs.map +1 -1
- package/resources/generate.d.mts +4188 -1370
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +4188 -1370
- package/resources/generate.d.ts.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/jobs.d.mts +943 -33
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +943 -33
- package/resources/jobs.d.ts.map +1 -1
- package/resources/jobs.js +3 -2
- package/resources/jobs.js.map +1 -1
- package/resources/jobs.mjs +3 -2
- package/resources/jobs.mjs.map +1 -1
- package/resources/models/description.d.mts +8 -8
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +8 -8
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +640 -34
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +640 -34
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/models.d.mts +1323 -301
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +1323 -301
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/models/train.d.mts +718 -90
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +718 -90
- package/resources/models/train.d.ts.map +1 -1
- package/resources/models/train.js +9 -4
- package/resources/models/train.js.map +1 -1
- package/resources/models/train.mjs +9 -4
- package/resources/models/train.mjs.map +1 -1
- package/resources/models/training-images.d.mts +2 -2
- package/resources/models/training-images.d.mts.map +1 -1
- package/resources/models/training-images.d.ts +2 -2
- package/resources/models/training-images.d.ts.map +1 -1
- package/resources/search.d.mts +6 -31
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +6 -31
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +6 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +6 -2
- package/resources/search.mjs.map +1 -1
- package/resources/tags.d.mts +1 -1
- package/resources/tags.d.ts +1 -1
- package/resources/usages.d.mts +401 -16
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +401 -16
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +2738 -101
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +2738 -101
- package/resources/workflows.d.ts.map +1 -1
- package/src/client.ts +102 -44
- package/src/core/api-promise.ts +4 -4
- package/src/core/error.ts +2 -2
- package/src/core/resource.ts +3 -3
- package/src/index.ts +8 -3
- package/src/internal/parse.ts +2 -2
- package/src/internal/request-options.ts +2 -0
- package/src/internal/shims.ts +1 -1
- package/src/internal/uploads.ts +5 -5
- package/src/internal/utils/base64.ts +3 -3
- package/src/internal/utils/log.ts +3 -3
- package/src/internal/utils/path.ts +2 -2
- package/src/internal/utils/values.ts +6 -6
- package/src/lib/generate.ts +77 -0
- package/src/lib/job.ts +78 -0
- package/src/lib/models.ts +27 -0
- package/src/lib/scenario.ts +39 -0
- package/src/lib/workflow.ts +90 -0
- package/src/resources/assets/assets.ts +742 -212
- package/src/resources/assets/index.ts +0 -1
- package/src/resources/assets/public.ts +151 -29
- package/src/resources/collections/assets.ts +2 -14
- package/src/resources/collections/collections.ts +3 -5
- package/src/resources/collections/index.ts +2 -14
- package/src/resources/collections/models.ts +2 -14
- package/src/resources/generate.ts +6254 -2217
- package/src/resources/index.ts +2 -3
- package/src/resources/jobs.ts +1355 -26
- package/src/resources/models/description.ts +50 -8
- package/src/resources/models/examples.ts +906 -56
- package/src/resources/models/models.ts +1867 -330
- package/src/resources/models/train.ts +976 -98
- package/src/resources/models/training-images.ts +2 -2
- package/src/resources/search.ts +13 -39
- package/src/resources/tags.ts +1 -1
- package/src/resources/usages.ts +544 -11
- package/src/resources/workflows.ts +4586 -914
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -78,7 +78,7 @@ export declare namespace ModelCreateResponse {
|
|
|
78
78
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
79
79
|
* "txt2img_ip_adapter", ...])
|
|
80
80
|
*/
|
|
81
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
81
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
82
82
|
/**
|
|
83
83
|
* A list of CollectionId this model belongs to
|
|
84
84
|
*/
|
|
@@ -119,7 +119,7 @@ export declare namespace ModelCreateResponse {
|
|
|
119
119
|
/**
|
|
120
120
|
* The model type (example: "flux.1-lora")
|
|
121
121
|
*/
|
|
122
|
-
type: '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';
|
|
122
|
+
type: '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';
|
|
123
123
|
/**
|
|
124
124
|
* The model last update date as an ISO string (example:
|
|
125
125
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -129,7 +129,7 @@ export declare namespace ModelCreateResponse {
|
|
|
129
129
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
130
130
|
* 75: Team plan 100: Enterprise plan
|
|
131
131
|
*/
|
|
132
|
-
accessRestrictions?:
|
|
132
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
133
133
|
/**
|
|
134
134
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
135
135
|
*/
|
|
@@ -138,10 +138,6 @@ export declare namespace ModelCreateResponse {
|
|
|
138
138
|
* The class of the model
|
|
139
139
|
*/
|
|
140
140
|
class?: Model.Class;
|
|
141
|
-
/**
|
|
142
|
-
* Compliance and regulatory metadata for the model
|
|
143
|
-
*/
|
|
144
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
145
141
|
/**
|
|
146
142
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
147
143
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -190,6 +186,10 @@ export declare namespace ModelCreateResponse {
|
|
|
190
186
|
* The id of the parent model
|
|
191
187
|
*/
|
|
192
188
|
parentModelId?: string;
|
|
189
|
+
/**
|
|
190
|
+
* Aggregated performance stats
|
|
191
|
+
*/
|
|
192
|
+
performanceStats?: Model.PerformanceStats;
|
|
193
193
|
/**
|
|
194
194
|
* Fine-tune the model's inferences with prompt embedding
|
|
195
195
|
*/
|
|
@@ -272,31 +272,6 @@ export declare namespace ModelCreateResponse {
|
|
|
272
272
|
*/
|
|
273
273
|
thumbnails: Array<string>;
|
|
274
274
|
}
|
|
275
|
-
/**
|
|
276
|
-
* Compliance and regulatory metadata for the model
|
|
277
|
-
*/
|
|
278
|
-
interface ComplianceMetadata {
|
|
279
|
-
/**
|
|
280
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
281
|
-
*/
|
|
282
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
283
|
-
/**
|
|
284
|
-
* URL to license terms
|
|
285
|
-
*/
|
|
286
|
-
licenseTerms?: string;
|
|
287
|
-
/**
|
|
288
|
-
* The maintainer of the model
|
|
289
|
-
*/
|
|
290
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
291
|
-
/**
|
|
292
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
293
|
-
*/
|
|
294
|
-
modelProvider?: string;
|
|
295
|
-
/**
|
|
296
|
-
* The sub-processor used for the model
|
|
297
|
-
*/
|
|
298
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
299
|
-
}
|
|
300
275
|
interface Concept {
|
|
301
276
|
/**
|
|
302
277
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -370,6 +345,10 @@ export declare namespace ModelCreateResponse {
|
|
|
370
345
|
* Whether this input affects the model's cost calculation
|
|
371
346
|
*/
|
|
372
347
|
costImpact?: boolean;
|
|
348
|
+
/**
|
|
349
|
+
* The default value for the input
|
|
350
|
+
*/
|
|
351
|
+
default?: unknown;
|
|
373
352
|
/**
|
|
374
353
|
* Help text displayed in the UI to provide additional information about the input
|
|
375
354
|
*/
|
|
@@ -388,10 +367,14 @@ export declare namespace ModelCreateResponse {
|
|
|
388
367
|
* the same as the current object. This is only available for type inputs_array
|
|
389
368
|
* inputs.
|
|
390
369
|
*/
|
|
391
|
-
inputs?: Array<
|
|
370
|
+
inputs?: Array<{
|
|
371
|
+
[key: string]: unknown;
|
|
372
|
+
}>;
|
|
392
373
|
/**
|
|
393
374
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
394
|
-
* \`file_array\` input types.
|
|
375
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
376
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
377
|
+
* data:kind, prefix
|
|
395
378
|
*/
|
|
396
379
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
397
380
|
/**
|
|
@@ -412,6 +395,12 @@ export declare namespace ModelCreateResponse {
|
|
|
412
395
|
* \`string_array\`.
|
|
413
396
|
*/
|
|
414
397
|
maxLength?: number;
|
|
398
|
+
/**
|
|
399
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
400
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
401
|
+
* creation time.
|
|
402
|
+
*/
|
|
403
|
+
maxSize?: number;
|
|
415
404
|
/**
|
|
416
405
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
417
406
|
*/
|
|
@@ -425,7 +414,7 @@ export declare namespace ModelCreateResponse {
|
|
|
425
414
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
426
415
|
* available for \`model_array\` input type.
|
|
427
416
|
*/
|
|
428
|
-
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'>;
|
|
417
|
+
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'>;
|
|
429
418
|
/**
|
|
430
419
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
431
420
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -510,6 +499,12 @@ export declare namespace ModelCreateResponse {
|
|
|
510
499
|
* The parameters of the model
|
|
511
500
|
*/
|
|
512
501
|
interface Parameters {
|
|
502
|
+
/**
|
|
503
|
+
* Age group of the voice (for professional cloning)
|
|
504
|
+
*
|
|
505
|
+
* Only available for ElevenLabs voice training
|
|
506
|
+
*/
|
|
507
|
+
age?: string;
|
|
513
508
|
/**
|
|
514
509
|
* The batch size Less steps, and will increase the learning rate
|
|
515
510
|
*
|
|
@@ -522,6 +517,13 @@ export declare namespace ModelCreateResponse {
|
|
|
522
517
|
* Only available for SD15 training
|
|
523
518
|
*/
|
|
524
519
|
classPrompt?: string;
|
|
520
|
+
/**
|
|
521
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
522
|
+
* requires captcha)
|
|
523
|
+
*
|
|
524
|
+
* Only available for ElevenLabs voice training
|
|
525
|
+
*/
|
|
526
|
+
cloneType?: string;
|
|
525
527
|
/**
|
|
526
528
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
527
529
|
* (example: "a daiton dog")
|
|
@@ -533,6 +535,18 @@ export declare namespace ModelCreateResponse {
|
|
|
533
535
|
* - For Flux: ""
|
|
534
536
|
*/
|
|
535
537
|
conceptPrompt?: string;
|
|
538
|
+
/**
|
|
539
|
+
* Gender of the voice (for professional cloning)
|
|
540
|
+
*
|
|
541
|
+
* Only available for ElevenLabs voice training
|
|
542
|
+
*/
|
|
543
|
+
gender?: string;
|
|
544
|
+
/**
|
|
545
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
546
|
+
*
|
|
547
|
+
* Only available for ElevenLabs voice training
|
|
548
|
+
*/
|
|
549
|
+
language?: string;
|
|
536
550
|
/**
|
|
537
551
|
* Initial learning rate (after the potential warmup period)
|
|
538
552
|
*
|
|
@@ -647,14 +661,25 @@ export declare namespace ModelCreateResponse {
|
|
|
647
661
|
/**
|
|
648
662
|
* The dimension of the LoRA update matrices
|
|
649
663
|
*
|
|
650
|
-
* Only available for SDXL
|
|
664
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
651
665
|
*
|
|
652
666
|
* Default value varies depending on the model type:
|
|
653
667
|
*
|
|
654
|
-
* - For SDXL: 64
|
|
668
|
+
* - For SDXL (deprecated): 64
|
|
655
669
|
* - For Flux: 16
|
|
670
|
+
* - For Musubi: 64
|
|
671
|
+
*
|
|
672
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
673
|
+
* 128])
|
|
656
674
|
*/
|
|
657
675
|
rank?: number;
|
|
676
|
+
/**
|
|
677
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
678
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
679
|
+
*
|
|
680
|
+
* Only available for ElevenLabs voice training
|
|
681
|
+
*/
|
|
682
|
+
removeBackgroundNoise?: boolean;
|
|
658
683
|
/**
|
|
659
684
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
660
685
|
*/
|
|
@@ -701,11 +726,124 @@ export declare namespace ModelCreateResponse {
|
|
|
701
726
|
* Only available for SD15 and SDXL LoRA training
|
|
702
727
|
*/
|
|
703
728
|
validationPrompt?: string;
|
|
729
|
+
/**
|
|
730
|
+
* Description of the voice characteristics
|
|
731
|
+
*
|
|
732
|
+
* Only available for ElevenLabs voice training
|
|
733
|
+
*/
|
|
734
|
+
voiceDescription?: string;
|
|
704
735
|
/**
|
|
705
736
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
706
737
|
*/
|
|
707
738
|
wandbKey?: string;
|
|
708
739
|
}
|
|
740
|
+
/**
|
|
741
|
+
* Aggregated performance stats
|
|
742
|
+
*/
|
|
743
|
+
interface PerformanceStats {
|
|
744
|
+
/**
|
|
745
|
+
* Performance metrics per variant
|
|
746
|
+
*/
|
|
747
|
+
variants: Array<PerformanceStats.Variant>;
|
|
748
|
+
/**
|
|
749
|
+
* Default variant key for quick model comparison
|
|
750
|
+
*/
|
|
751
|
+
default?: string;
|
|
752
|
+
}
|
|
753
|
+
namespace PerformanceStats {
|
|
754
|
+
/**
|
|
755
|
+
* Performance stats for a model variant
|
|
756
|
+
*/
|
|
757
|
+
interface Variant {
|
|
758
|
+
/**
|
|
759
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
760
|
+
*/
|
|
761
|
+
capability: string;
|
|
762
|
+
/**
|
|
763
|
+
* When these stats were last computed (ISO date)
|
|
764
|
+
*/
|
|
765
|
+
computedAt: string;
|
|
766
|
+
/**
|
|
767
|
+
* Maximum cost per output asset (CU)
|
|
768
|
+
*/
|
|
769
|
+
costPerAssetMaxCU: number;
|
|
770
|
+
/**
|
|
771
|
+
* Minimum cost per output asset (CU)
|
|
772
|
+
*/
|
|
773
|
+
costPerAssetMinCU: number;
|
|
774
|
+
/**
|
|
775
|
+
* Median cost per output asset (CU)
|
|
776
|
+
*/
|
|
777
|
+
costPerAssetP50CU: number;
|
|
778
|
+
/**
|
|
779
|
+
* Inference latency P50 per output asset (seconds)
|
|
780
|
+
*/
|
|
781
|
+
inferenceLatencyP50Sec: number;
|
|
782
|
+
/**
|
|
783
|
+
* Inference latency P75 per output asset (seconds)
|
|
784
|
+
*/
|
|
785
|
+
inferenceLatencyP75Sec: number;
|
|
786
|
+
/**
|
|
787
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
788
|
+
*/
|
|
789
|
+
totalLatencyP50Sec: number;
|
|
790
|
+
/**
|
|
791
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
792
|
+
*/
|
|
793
|
+
totalLatencyP75Sec: number;
|
|
794
|
+
/**
|
|
795
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
796
|
+
*/
|
|
797
|
+
variantKey: string;
|
|
798
|
+
/**
|
|
799
|
+
* External quality score from arena.ai leaderboard
|
|
800
|
+
*/
|
|
801
|
+
arenaScore?: Variant.ArenaScore;
|
|
802
|
+
/**
|
|
803
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
804
|
+
*/
|
|
805
|
+
resolution?: string;
|
|
806
|
+
}
|
|
807
|
+
namespace Variant {
|
|
808
|
+
/**
|
|
809
|
+
* External quality score from arena.ai leaderboard
|
|
810
|
+
*/
|
|
811
|
+
interface ArenaScore {
|
|
812
|
+
/**
|
|
813
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
814
|
+
*/
|
|
815
|
+
arenaCategory: string;
|
|
816
|
+
/**
|
|
817
|
+
* Model name on arena.ai
|
|
818
|
+
*/
|
|
819
|
+
arenaModelName: string;
|
|
820
|
+
/**
|
|
821
|
+
* When this score was last fetched (ISO date)
|
|
822
|
+
*/
|
|
823
|
+
fetchedAt: string;
|
|
824
|
+
/**
|
|
825
|
+
* Rank in the arena category
|
|
826
|
+
*/
|
|
827
|
+
rank: number;
|
|
828
|
+
/**
|
|
829
|
+
* ELO rating
|
|
830
|
+
*/
|
|
831
|
+
rating: number;
|
|
832
|
+
/**
|
|
833
|
+
* ELO rating confidence interval lower bound
|
|
834
|
+
*/
|
|
835
|
+
ratingLower: number;
|
|
836
|
+
/**
|
|
837
|
+
* ELO rating confidence interval upper bound
|
|
838
|
+
*/
|
|
839
|
+
ratingUpper: number;
|
|
840
|
+
/**
|
|
841
|
+
* Number of human votes
|
|
842
|
+
*/
|
|
843
|
+
votes: number;
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
}
|
|
709
847
|
/**
|
|
710
848
|
* A thumbnail for your model
|
|
711
849
|
*/
|
|
@@ -768,7 +906,7 @@ export declare namespace ModelCreateResponse {
|
|
|
768
906
|
/**
|
|
769
907
|
* The stage of the request
|
|
770
908
|
*/
|
|
771
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
909
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
772
910
|
/**
|
|
773
911
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
774
912
|
*/
|
|
@@ -938,7 +1076,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
938
1076
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
939
1077
|
* "txt2img_ip_adapter", ...])
|
|
940
1078
|
*/
|
|
941
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
1079
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
942
1080
|
/**
|
|
943
1081
|
* A list of CollectionId this model belongs to
|
|
944
1082
|
*/
|
|
@@ -979,7 +1117,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
979
1117
|
/**
|
|
980
1118
|
* The model type (example: "flux.1-lora")
|
|
981
1119
|
*/
|
|
982
|
-
type: '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';
|
|
1120
|
+
type: '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';
|
|
983
1121
|
/**
|
|
984
1122
|
* The model last update date as an ISO string (example:
|
|
985
1123
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -989,7 +1127,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
989
1127
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
990
1128
|
* 75: Team plan 100: Enterprise plan
|
|
991
1129
|
*/
|
|
992
|
-
accessRestrictions?:
|
|
1130
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
993
1131
|
/**
|
|
994
1132
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
995
1133
|
*/
|
|
@@ -998,10 +1136,6 @@ export declare namespace ModelRetrieveResponse {
|
|
|
998
1136
|
* The class of the model
|
|
999
1137
|
*/
|
|
1000
1138
|
class?: Model.Class;
|
|
1001
|
-
/**
|
|
1002
|
-
* Compliance and regulatory metadata for the model
|
|
1003
|
-
*/
|
|
1004
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
1005
1139
|
/**
|
|
1006
1140
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
1007
1141
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -1050,6 +1184,10 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1050
1184
|
* The id of the parent model
|
|
1051
1185
|
*/
|
|
1052
1186
|
parentModelId?: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* Aggregated performance stats
|
|
1189
|
+
*/
|
|
1190
|
+
performanceStats?: Model.PerformanceStats;
|
|
1053
1191
|
/**
|
|
1054
1192
|
* Fine-tune the model's inferences with prompt embedding
|
|
1055
1193
|
*/
|
|
@@ -1132,31 +1270,6 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1132
1270
|
*/
|
|
1133
1271
|
thumbnails: Array<string>;
|
|
1134
1272
|
}
|
|
1135
|
-
/**
|
|
1136
|
-
* Compliance and regulatory metadata for the model
|
|
1137
|
-
*/
|
|
1138
|
-
interface ComplianceMetadata {
|
|
1139
|
-
/**
|
|
1140
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
1141
|
-
*/
|
|
1142
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
1143
|
-
/**
|
|
1144
|
-
* URL to license terms
|
|
1145
|
-
*/
|
|
1146
|
-
licenseTerms?: string;
|
|
1147
|
-
/**
|
|
1148
|
-
* The maintainer of the model
|
|
1149
|
-
*/
|
|
1150
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
1151
|
-
/**
|
|
1152
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
1153
|
-
*/
|
|
1154
|
-
modelProvider?: string;
|
|
1155
|
-
/**
|
|
1156
|
-
* The sub-processor used for the model
|
|
1157
|
-
*/
|
|
1158
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
1159
|
-
}
|
|
1160
1273
|
interface Concept {
|
|
1161
1274
|
/**
|
|
1162
1275
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -1230,6 +1343,10 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1230
1343
|
* Whether this input affects the model's cost calculation
|
|
1231
1344
|
*/
|
|
1232
1345
|
costImpact?: boolean;
|
|
1346
|
+
/**
|
|
1347
|
+
* The default value for the input
|
|
1348
|
+
*/
|
|
1349
|
+
default?: unknown;
|
|
1233
1350
|
/**
|
|
1234
1351
|
* Help text displayed in the UI to provide additional information about the input
|
|
1235
1352
|
*/
|
|
@@ -1248,10 +1365,14 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1248
1365
|
* the same as the current object. This is only available for type inputs_array
|
|
1249
1366
|
* inputs.
|
|
1250
1367
|
*/
|
|
1251
|
-
inputs?: Array<
|
|
1368
|
+
inputs?: Array<{
|
|
1369
|
+
[key: string]: unknown;
|
|
1370
|
+
}>;
|
|
1252
1371
|
/**
|
|
1253
1372
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
1254
|
-
* \`file_array\` input types.
|
|
1373
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
1374
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
1375
|
+
* data:kind, prefix
|
|
1255
1376
|
*/
|
|
1256
1377
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
1257
1378
|
/**
|
|
@@ -1272,6 +1393,12 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1272
1393
|
* \`string_array\`.
|
|
1273
1394
|
*/
|
|
1274
1395
|
maxLength?: number;
|
|
1396
|
+
/**
|
|
1397
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
1398
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
1399
|
+
* creation time.
|
|
1400
|
+
*/
|
|
1401
|
+
maxSize?: number;
|
|
1275
1402
|
/**
|
|
1276
1403
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
1277
1404
|
*/
|
|
@@ -1285,7 +1412,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1285
1412
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
1286
1413
|
* available for \`model_array\` input type.
|
|
1287
1414
|
*/
|
|
1288
|
-
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'>;
|
|
1415
|
+
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'>;
|
|
1289
1416
|
/**
|
|
1290
1417
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
1291
1418
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -1370,6 +1497,12 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1370
1497
|
* The parameters of the model
|
|
1371
1498
|
*/
|
|
1372
1499
|
interface Parameters {
|
|
1500
|
+
/**
|
|
1501
|
+
* Age group of the voice (for professional cloning)
|
|
1502
|
+
*
|
|
1503
|
+
* Only available for ElevenLabs voice training
|
|
1504
|
+
*/
|
|
1505
|
+
age?: string;
|
|
1373
1506
|
/**
|
|
1374
1507
|
* The batch size Less steps, and will increase the learning rate
|
|
1375
1508
|
*
|
|
@@ -1382,6 +1515,13 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1382
1515
|
* Only available for SD15 training
|
|
1383
1516
|
*/
|
|
1384
1517
|
classPrompt?: string;
|
|
1518
|
+
/**
|
|
1519
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
1520
|
+
* requires captcha)
|
|
1521
|
+
*
|
|
1522
|
+
* Only available for ElevenLabs voice training
|
|
1523
|
+
*/
|
|
1524
|
+
cloneType?: string;
|
|
1385
1525
|
/**
|
|
1386
1526
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
1387
1527
|
* (example: "a daiton dog")
|
|
@@ -1393,6 +1533,18 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1393
1533
|
* - For Flux: ""
|
|
1394
1534
|
*/
|
|
1395
1535
|
conceptPrompt?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Gender of the voice (for professional cloning)
|
|
1538
|
+
*
|
|
1539
|
+
* Only available for ElevenLabs voice training
|
|
1540
|
+
*/
|
|
1541
|
+
gender?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
1544
|
+
*
|
|
1545
|
+
* Only available for ElevenLabs voice training
|
|
1546
|
+
*/
|
|
1547
|
+
language?: string;
|
|
1396
1548
|
/**
|
|
1397
1549
|
* Initial learning rate (after the potential warmup period)
|
|
1398
1550
|
*
|
|
@@ -1507,14 +1659,25 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1507
1659
|
/**
|
|
1508
1660
|
* The dimension of the LoRA update matrices
|
|
1509
1661
|
*
|
|
1510
|
-
* Only available for SDXL
|
|
1662
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
1511
1663
|
*
|
|
1512
1664
|
* Default value varies depending on the model type:
|
|
1513
1665
|
*
|
|
1514
|
-
* - For SDXL: 64
|
|
1666
|
+
* - For SDXL (deprecated): 64
|
|
1515
1667
|
* - For Flux: 16
|
|
1668
|
+
* - For Musubi: 64
|
|
1669
|
+
*
|
|
1670
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
1671
|
+
* 128])
|
|
1516
1672
|
*/
|
|
1517
1673
|
rank?: number;
|
|
1674
|
+
/**
|
|
1675
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
1676
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
1677
|
+
*
|
|
1678
|
+
* Only available for ElevenLabs voice training
|
|
1679
|
+
*/
|
|
1680
|
+
removeBackgroundNoise?: boolean;
|
|
1518
1681
|
/**
|
|
1519
1682
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
1520
1683
|
*/
|
|
@@ -1561,11 +1724,124 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1561
1724
|
* Only available for SD15 and SDXL LoRA training
|
|
1562
1725
|
*/
|
|
1563
1726
|
validationPrompt?: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* Description of the voice characteristics
|
|
1729
|
+
*
|
|
1730
|
+
* Only available for ElevenLabs voice training
|
|
1731
|
+
*/
|
|
1732
|
+
voiceDescription?: string;
|
|
1564
1733
|
/**
|
|
1565
1734
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
1566
1735
|
*/
|
|
1567
1736
|
wandbKey?: string;
|
|
1568
1737
|
}
|
|
1738
|
+
/**
|
|
1739
|
+
* Aggregated performance stats
|
|
1740
|
+
*/
|
|
1741
|
+
interface PerformanceStats {
|
|
1742
|
+
/**
|
|
1743
|
+
* Performance metrics per variant
|
|
1744
|
+
*/
|
|
1745
|
+
variants: Array<PerformanceStats.Variant>;
|
|
1746
|
+
/**
|
|
1747
|
+
* Default variant key for quick model comparison
|
|
1748
|
+
*/
|
|
1749
|
+
default?: string;
|
|
1750
|
+
}
|
|
1751
|
+
namespace PerformanceStats {
|
|
1752
|
+
/**
|
|
1753
|
+
* Performance stats for a model variant
|
|
1754
|
+
*/
|
|
1755
|
+
interface Variant {
|
|
1756
|
+
/**
|
|
1757
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
1758
|
+
*/
|
|
1759
|
+
capability: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* When these stats were last computed (ISO date)
|
|
1762
|
+
*/
|
|
1763
|
+
computedAt: string;
|
|
1764
|
+
/**
|
|
1765
|
+
* Maximum cost per output asset (CU)
|
|
1766
|
+
*/
|
|
1767
|
+
costPerAssetMaxCU: number;
|
|
1768
|
+
/**
|
|
1769
|
+
* Minimum cost per output asset (CU)
|
|
1770
|
+
*/
|
|
1771
|
+
costPerAssetMinCU: number;
|
|
1772
|
+
/**
|
|
1773
|
+
* Median cost per output asset (CU)
|
|
1774
|
+
*/
|
|
1775
|
+
costPerAssetP50CU: number;
|
|
1776
|
+
/**
|
|
1777
|
+
* Inference latency P50 per output asset (seconds)
|
|
1778
|
+
*/
|
|
1779
|
+
inferenceLatencyP50Sec: number;
|
|
1780
|
+
/**
|
|
1781
|
+
* Inference latency P75 per output asset (seconds)
|
|
1782
|
+
*/
|
|
1783
|
+
inferenceLatencyP75Sec: number;
|
|
1784
|
+
/**
|
|
1785
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
1786
|
+
*/
|
|
1787
|
+
totalLatencyP50Sec: number;
|
|
1788
|
+
/**
|
|
1789
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
1790
|
+
*/
|
|
1791
|
+
totalLatencyP75Sec: number;
|
|
1792
|
+
/**
|
|
1793
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
1794
|
+
*/
|
|
1795
|
+
variantKey: string;
|
|
1796
|
+
/**
|
|
1797
|
+
* External quality score from arena.ai leaderboard
|
|
1798
|
+
*/
|
|
1799
|
+
arenaScore?: Variant.ArenaScore;
|
|
1800
|
+
/**
|
|
1801
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
1802
|
+
*/
|
|
1803
|
+
resolution?: string;
|
|
1804
|
+
}
|
|
1805
|
+
namespace Variant {
|
|
1806
|
+
/**
|
|
1807
|
+
* External quality score from arena.ai leaderboard
|
|
1808
|
+
*/
|
|
1809
|
+
interface ArenaScore {
|
|
1810
|
+
/**
|
|
1811
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
1812
|
+
*/
|
|
1813
|
+
arenaCategory: string;
|
|
1814
|
+
/**
|
|
1815
|
+
* Model name on arena.ai
|
|
1816
|
+
*/
|
|
1817
|
+
arenaModelName: string;
|
|
1818
|
+
/**
|
|
1819
|
+
* When this score was last fetched (ISO date)
|
|
1820
|
+
*/
|
|
1821
|
+
fetchedAt: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* Rank in the arena category
|
|
1824
|
+
*/
|
|
1825
|
+
rank: number;
|
|
1826
|
+
/**
|
|
1827
|
+
* ELO rating
|
|
1828
|
+
*/
|
|
1829
|
+
rating: number;
|
|
1830
|
+
/**
|
|
1831
|
+
* ELO rating confidence interval lower bound
|
|
1832
|
+
*/
|
|
1833
|
+
ratingLower: number;
|
|
1834
|
+
/**
|
|
1835
|
+
* ELO rating confidence interval upper bound
|
|
1836
|
+
*/
|
|
1837
|
+
ratingUpper: number;
|
|
1838
|
+
/**
|
|
1839
|
+
* Number of human votes
|
|
1840
|
+
*/
|
|
1841
|
+
votes: number;
|
|
1842
|
+
}
|
|
1843
|
+
}
|
|
1844
|
+
}
|
|
1569
1845
|
/**
|
|
1570
1846
|
* A thumbnail for your model
|
|
1571
1847
|
*/
|
|
@@ -1628,7 +1904,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1628
1904
|
/**
|
|
1629
1905
|
* The stage of the request
|
|
1630
1906
|
*/
|
|
1631
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
1907
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
1632
1908
|
/**
|
|
1633
1909
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
1634
1910
|
*/
|
|
@@ -1798,7 +2074,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
1798
2074
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
1799
2075
|
* "txt2img_ip_adapter", ...])
|
|
1800
2076
|
*/
|
|
1801
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
2077
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
1802
2078
|
/**
|
|
1803
2079
|
* A list of CollectionId this model belongs to
|
|
1804
2080
|
*/
|
|
@@ -1839,7 +2115,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
1839
2115
|
/**
|
|
1840
2116
|
* The model type (example: "flux.1-lora")
|
|
1841
2117
|
*/
|
|
1842
|
-
type: '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';
|
|
2118
|
+
type: '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';
|
|
1843
2119
|
/**
|
|
1844
2120
|
* The model last update date as an ISO string (example:
|
|
1845
2121
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -1849,7 +2125,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
1849
2125
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
1850
2126
|
* 75: Team plan 100: Enterprise plan
|
|
1851
2127
|
*/
|
|
1852
|
-
accessRestrictions?:
|
|
2128
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
1853
2129
|
/**
|
|
1854
2130
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
1855
2131
|
*/
|
|
@@ -1858,10 +2134,6 @@ export declare namespace ModelUpdateResponse {
|
|
|
1858
2134
|
* The class of the model
|
|
1859
2135
|
*/
|
|
1860
2136
|
class?: Model.Class;
|
|
1861
|
-
/**
|
|
1862
|
-
* Compliance and regulatory metadata for the model
|
|
1863
|
-
*/
|
|
1864
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
1865
2137
|
/**
|
|
1866
2138
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
1867
2139
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -1910,6 +2182,10 @@ export declare namespace ModelUpdateResponse {
|
|
|
1910
2182
|
* The id of the parent model
|
|
1911
2183
|
*/
|
|
1912
2184
|
parentModelId?: string;
|
|
2185
|
+
/**
|
|
2186
|
+
* Aggregated performance stats
|
|
2187
|
+
*/
|
|
2188
|
+
performanceStats?: Model.PerformanceStats;
|
|
1913
2189
|
/**
|
|
1914
2190
|
* Fine-tune the model's inferences with prompt embedding
|
|
1915
2191
|
*/
|
|
@@ -1992,31 +2268,6 @@ export declare namespace ModelUpdateResponse {
|
|
|
1992
2268
|
*/
|
|
1993
2269
|
thumbnails: Array<string>;
|
|
1994
2270
|
}
|
|
1995
|
-
/**
|
|
1996
|
-
* Compliance and regulatory metadata for the model
|
|
1997
|
-
*/
|
|
1998
|
-
interface ComplianceMetadata {
|
|
1999
|
-
/**
|
|
2000
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
2001
|
-
*/
|
|
2002
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
2003
|
-
/**
|
|
2004
|
-
* URL to license terms
|
|
2005
|
-
*/
|
|
2006
|
-
licenseTerms?: string;
|
|
2007
|
-
/**
|
|
2008
|
-
* The maintainer of the model
|
|
2009
|
-
*/
|
|
2010
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
2011
|
-
/**
|
|
2012
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
2013
|
-
*/
|
|
2014
|
-
modelProvider?: string;
|
|
2015
|
-
/**
|
|
2016
|
-
* The sub-processor used for the model
|
|
2017
|
-
*/
|
|
2018
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
2019
|
-
}
|
|
2020
2271
|
interface Concept {
|
|
2021
2272
|
/**
|
|
2022
2273
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -2090,6 +2341,10 @@ export declare namespace ModelUpdateResponse {
|
|
|
2090
2341
|
* Whether this input affects the model's cost calculation
|
|
2091
2342
|
*/
|
|
2092
2343
|
costImpact?: boolean;
|
|
2344
|
+
/**
|
|
2345
|
+
* The default value for the input
|
|
2346
|
+
*/
|
|
2347
|
+
default?: unknown;
|
|
2093
2348
|
/**
|
|
2094
2349
|
* Help text displayed in the UI to provide additional information about the input
|
|
2095
2350
|
*/
|
|
@@ -2108,10 +2363,14 @@ export declare namespace ModelUpdateResponse {
|
|
|
2108
2363
|
* the same as the current object. This is only available for type inputs_array
|
|
2109
2364
|
* inputs.
|
|
2110
2365
|
*/
|
|
2111
|
-
inputs?: Array<
|
|
2366
|
+
inputs?: Array<{
|
|
2367
|
+
[key: string]: unknown;
|
|
2368
|
+
}>;
|
|
2112
2369
|
/**
|
|
2113
2370
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
2114
|
-
* \`file_array\` input types.
|
|
2371
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
2372
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
2373
|
+
* data:kind, prefix
|
|
2115
2374
|
*/
|
|
2116
2375
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2117
2376
|
/**
|
|
@@ -2132,6 +2391,12 @@ export declare namespace ModelUpdateResponse {
|
|
|
2132
2391
|
* \`string_array\`.
|
|
2133
2392
|
*/
|
|
2134
2393
|
maxLength?: number;
|
|
2394
|
+
/**
|
|
2395
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
2396
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
2397
|
+
* creation time.
|
|
2398
|
+
*/
|
|
2399
|
+
maxSize?: number;
|
|
2135
2400
|
/**
|
|
2136
2401
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
2137
2402
|
*/
|
|
@@ -2145,7 +2410,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2145
2410
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
2146
2411
|
* available for \`model_array\` input type.
|
|
2147
2412
|
*/
|
|
2148
|
-
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'>;
|
|
2413
|
+
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'>;
|
|
2149
2414
|
/**
|
|
2150
2415
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
2151
2416
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -2230,6 +2495,12 @@ export declare namespace ModelUpdateResponse {
|
|
|
2230
2495
|
* The parameters of the model
|
|
2231
2496
|
*/
|
|
2232
2497
|
interface Parameters {
|
|
2498
|
+
/**
|
|
2499
|
+
* Age group of the voice (for professional cloning)
|
|
2500
|
+
*
|
|
2501
|
+
* Only available for ElevenLabs voice training
|
|
2502
|
+
*/
|
|
2503
|
+
age?: string;
|
|
2233
2504
|
/**
|
|
2234
2505
|
* The batch size Less steps, and will increase the learning rate
|
|
2235
2506
|
*
|
|
@@ -2242,6 +2513,13 @@ export declare namespace ModelUpdateResponse {
|
|
|
2242
2513
|
* Only available for SD15 training
|
|
2243
2514
|
*/
|
|
2244
2515
|
classPrompt?: string;
|
|
2516
|
+
/**
|
|
2517
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
2518
|
+
* requires captcha)
|
|
2519
|
+
*
|
|
2520
|
+
* Only available for ElevenLabs voice training
|
|
2521
|
+
*/
|
|
2522
|
+
cloneType?: string;
|
|
2245
2523
|
/**
|
|
2246
2524
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
2247
2525
|
* (example: "a daiton dog")
|
|
@@ -2253,6 +2531,18 @@ export declare namespace ModelUpdateResponse {
|
|
|
2253
2531
|
* - For Flux: ""
|
|
2254
2532
|
*/
|
|
2255
2533
|
conceptPrompt?: string;
|
|
2534
|
+
/**
|
|
2535
|
+
* Gender of the voice (for professional cloning)
|
|
2536
|
+
*
|
|
2537
|
+
* Only available for ElevenLabs voice training
|
|
2538
|
+
*/
|
|
2539
|
+
gender?: string;
|
|
2540
|
+
/**
|
|
2541
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
2542
|
+
*
|
|
2543
|
+
* Only available for ElevenLabs voice training
|
|
2544
|
+
*/
|
|
2545
|
+
language?: string;
|
|
2256
2546
|
/**
|
|
2257
2547
|
* Initial learning rate (after the potential warmup period)
|
|
2258
2548
|
*
|
|
@@ -2367,14 +2657,25 @@ export declare namespace ModelUpdateResponse {
|
|
|
2367
2657
|
/**
|
|
2368
2658
|
* The dimension of the LoRA update matrices
|
|
2369
2659
|
*
|
|
2370
|
-
* Only available for SDXL
|
|
2660
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
2371
2661
|
*
|
|
2372
2662
|
* Default value varies depending on the model type:
|
|
2373
2663
|
*
|
|
2374
|
-
* - For SDXL: 64
|
|
2664
|
+
* - For SDXL (deprecated): 64
|
|
2375
2665
|
* - For Flux: 16
|
|
2666
|
+
* - For Musubi: 64
|
|
2667
|
+
*
|
|
2668
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
2669
|
+
* 128])
|
|
2376
2670
|
*/
|
|
2377
2671
|
rank?: number;
|
|
2672
|
+
/**
|
|
2673
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
2674
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
2675
|
+
*
|
|
2676
|
+
* Only available for ElevenLabs voice training
|
|
2677
|
+
*/
|
|
2678
|
+
removeBackgroundNoise?: boolean;
|
|
2378
2679
|
/**
|
|
2379
2680
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
2380
2681
|
*/
|
|
@@ -2421,11 +2722,124 @@ export declare namespace ModelUpdateResponse {
|
|
|
2421
2722
|
* Only available for SD15 and SDXL LoRA training
|
|
2422
2723
|
*/
|
|
2423
2724
|
validationPrompt?: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* Description of the voice characteristics
|
|
2727
|
+
*
|
|
2728
|
+
* Only available for ElevenLabs voice training
|
|
2729
|
+
*/
|
|
2730
|
+
voiceDescription?: string;
|
|
2424
2731
|
/**
|
|
2425
2732
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
2426
2733
|
*/
|
|
2427
2734
|
wandbKey?: string;
|
|
2428
2735
|
}
|
|
2736
|
+
/**
|
|
2737
|
+
* Aggregated performance stats
|
|
2738
|
+
*/
|
|
2739
|
+
interface PerformanceStats {
|
|
2740
|
+
/**
|
|
2741
|
+
* Performance metrics per variant
|
|
2742
|
+
*/
|
|
2743
|
+
variants: Array<PerformanceStats.Variant>;
|
|
2744
|
+
/**
|
|
2745
|
+
* Default variant key for quick model comparison
|
|
2746
|
+
*/
|
|
2747
|
+
default?: string;
|
|
2748
|
+
}
|
|
2749
|
+
namespace PerformanceStats {
|
|
2750
|
+
/**
|
|
2751
|
+
* Performance stats for a model variant
|
|
2752
|
+
*/
|
|
2753
|
+
interface Variant {
|
|
2754
|
+
/**
|
|
2755
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
2756
|
+
*/
|
|
2757
|
+
capability: string;
|
|
2758
|
+
/**
|
|
2759
|
+
* When these stats were last computed (ISO date)
|
|
2760
|
+
*/
|
|
2761
|
+
computedAt: string;
|
|
2762
|
+
/**
|
|
2763
|
+
* Maximum cost per output asset (CU)
|
|
2764
|
+
*/
|
|
2765
|
+
costPerAssetMaxCU: number;
|
|
2766
|
+
/**
|
|
2767
|
+
* Minimum cost per output asset (CU)
|
|
2768
|
+
*/
|
|
2769
|
+
costPerAssetMinCU: number;
|
|
2770
|
+
/**
|
|
2771
|
+
* Median cost per output asset (CU)
|
|
2772
|
+
*/
|
|
2773
|
+
costPerAssetP50CU: number;
|
|
2774
|
+
/**
|
|
2775
|
+
* Inference latency P50 per output asset (seconds)
|
|
2776
|
+
*/
|
|
2777
|
+
inferenceLatencyP50Sec: number;
|
|
2778
|
+
/**
|
|
2779
|
+
* Inference latency P75 per output asset (seconds)
|
|
2780
|
+
*/
|
|
2781
|
+
inferenceLatencyP75Sec: number;
|
|
2782
|
+
/**
|
|
2783
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
2784
|
+
*/
|
|
2785
|
+
totalLatencyP50Sec: number;
|
|
2786
|
+
/**
|
|
2787
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
2788
|
+
*/
|
|
2789
|
+
totalLatencyP75Sec: number;
|
|
2790
|
+
/**
|
|
2791
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
2792
|
+
*/
|
|
2793
|
+
variantKey: string;
|
|
2794
|
+
/**
|
|
2795
|
+
* External quality score from arena.ai leaderboard
|
|
2796
|
+
*/
|
|
2797
|
+
arenaScore?: Variant.ArenaScore;
|
|
2798
|
+
/**
|
|
2799
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
2800
|
+
*/
|
|
2801
|
+
resolution?: string;
|
|
2802
|
+
}
|
|
2803
|
+
namespace Variant {
|
|
2804
|
+
/**
|
|
2805
|
+
* External quality score from arena.ai leaderboard
|
|
2806
|
+
*/
|
|
2807
|
+
interface ArenaScore {
|
|
2808
|
+
/**
|
|
2809
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
2810
|
+
*/
|
|
2811
|
+
arenaCategory: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* Model name on arena.ai
|
|
2814
|
+
*/
|
|
2815
|
+
arenaModelName: string;
|
|
2816
|
+
/**
|
|
2817
|
+
* When this score was last fetched (ISO date)
|
|
2818
|
+
*/
|
|
2819
|
+
fetchedAt: string;
|
|
2820
|
+
/**
|
|
2821
|
+
* Rank in the arena category
|
|
2822
|
+
*/
|
|
2823
|
+
rank: number;
|
|
2824
|
+
/**
|
|
2825
|
+
* ELO rating
|
|
2826
|
+
*/
|
|
2827
|
+
rating: number;
|
|
2828
|
+
/**
|
|
2829
|
+
* ELO rating confidence interval lower bound
|
|
2830
|
+
*/
|
|
2831
|
+
ratingLower: number;
|
|
2832
|
+
/**
|
|
2833
|
+
* ELO rating confidence interval upper bound
|
|
2834
|
+
*/
|
|
2835
|
+
ratingUpper: number;
|
|
2836
|
+
/**
|
|
2837
|
+
* Number of human votes
|
|
2838
|
+
*/
|
|
2839
|
+
votes: number;
|
|
2840
|
+
}
|
|
2841
|
+
}
|
|
2842
|
+
}
|
|
2429
2843
|
/**
|
|
2430
2844
|
* A thumbnail for your model
|
|
2431
2845
|
*/
|
|
@@ -2488,7 +2902,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2488
2902
|
/**
|
|
2489
2903
|
* The stage of the request
|
|
2490
2904
|
*/
|
|
2491
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
2905
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
2492
2906
|
/**
|
|
2493
2907
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
2494
2908
|
*/
|
|
@@ -2662,7 +3076,7 @@ export declare namespace ModelListResponse {
|
|
|
2662
3076
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
2663
3077
|
* "txt2img_ip_adapter", ...])
|
|
2664
3078
|
*/
|
|
2665
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
3079
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
2666
3080
|
/**
|
|
2667
3081
|
* A list of CollectionId this model belongs to
|
|
2668
3082
|
*/
|
|
@@ -2703,7 +3117,7 @@ export declare namespace ModelListResponse {
|
|
|
2703
3117
|
/**
|
|
2704
3118
|
* The model type (example: "flux.1-lora")
|
|
2705
3119
|
*/
|
|
2706
|
-
type: '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';
|
|
3120
|
+
type: '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';
|
|
2707
3121
|
/**
|
|
2708
3122
|
* The model last update date as an ISO string (example:
|
|
2709
3123
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -2713,7 +3127,7 @@ export declare namespace ModelListResponse {
|
|
|
2713
3127
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
2714
3128
|
* 75: Team plan 100: Enterprise plan
|
|
2715
3129
|
*/
|
|
2716
|
-
accessRestrictions?:
|
|
3130
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
2717
3131
|
/**
|
|
2718
3132
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
2719
3133
|
*/
|
|
@@ -2722,10 +3136,6 @@ export declare namespace ModelListResponse {
|
|
|
2722
3136
|
* The class of the model
|
|
2723
3137
|
*/
|
|
2724
3138
|
class?: Model.Class;
|
|
2725
|
-
/**
|
|
2726
|
-
* Compliance and regulatory metadata for the model
|
|
2727
|
-
*/
|
|
2728
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
2729
3139
|
/**
|
|
2730
3140
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
2731
3141
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -2774,6 +3184,10 @@ export declare namespace ModelListResponse {
|
|
|
2774
3184
|
* The id of the parent model
|
|
2775
3185
|
*/
|
|
2776
3186
|
parentModelId?: string;
|
|
3187
|
+
/**
|
|
3188
|
+
* Aggregated performance stats
|
|
3189
|
+
*/
|
|
3190
|
+
performanceStats?: Model.PerformanceStats;
|
|
2777
3191
|
/**
|
|
2778
3192
|
* Fine-tune the model's inferences with prompt embedding
|
|
2779
3193
|
*/
|
|
@@ -2856,31 +3270,6 @@ export declare namespace ModelListResponse {
|
|
|
2856
3270
|
*/
|
|
2857
3271
|
thumbnails: Array<string>;
|
|
2858
3272
|
}
|
|
2859
|
-
/**
|
|
2860
|
-
* Compliance and regulatory metadata for the model
|
|
2861
|
-
*/
|
|
2862
|
-
interface ComplianceMetadata {
|
|
2863
|
-
/**
|
|
2864
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
2865
|
-
*/
|
|
2866
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
2867
|
-
/**
|
|
2868
|
-
* URL to license terms
|
|
2869
|
-
*/
|
|
2870
|
-
licenseTerms?: string;
|
|
2871
|
-
/**
|
|
2872
|
-
* The maintainer of the model
|
|
2873
|
-
*/
|
|
2874
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
2875
|
-
/**
|
|
2876
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
2877
|
-
*/
|
|
2878
|
-
modelProvider?: string;
|
|
2879
|
-
/**
|
|
2880
|
-
* The sub-processor used for the model
|
|
2881
|
-
*/
|
|
2882
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
2883
|
-
}
|
|
2884
3273
|
interface Concept {
|
|
2885
3274
|
/**
|
|
2886
3275
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -2954,6 +3343,10 @@ export declare namespace ModelListResponse {
|
|
|
2954
3343
|
* Whether this input affects the model's cost calculation
|
|
2955
3344
|
*/
|
|
2956
3345
|
costImpact?: boolean;
|
|
3346
|
+
/**
|
|
3347
|
+
* The default value for the input
|
|
3348
|
+
*/
|
|
3349
|
+
default?: unknown;
|
|
2957
3350
|
/**
|
|
2958
3351
|
* Help text displayed in the UI to provide additional information about the input
|
|
2959
3352
|
*/
|
|
@@ -2972,10 +3365,14 @@ export declare namespace ModelListResponse {
|
|
|
2972
3365
|
* the same as the current object. This is only available for type inputs_array
|
|
2973
3366
|
* inputs.
|
|
2974
3367
|
*/
|
|
2975
|
-
inputs?: Array<
|
|
3368
|
+
inputs?: Array<{
|
|
3369
|
+
[key: string]: unknown;
|
|
3370
|
+
}>;
|
|
2976
3371
|
/**
|
|
2977
3372
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
2978
|
-
* \`file_array\` input types.
|
|
3373
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
3374
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
3375
|
+
* data:kind, prefix
|
|
2979
3376
|
*/
|
|
2980
3377
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2981
3378
|
/**
|
|
@@ -2996,6 +3393,12 @@ export declare namespace ModelListResponse {
|
|
|
2996
3393
|
* \`string_array\`.
|
|
2997
3394
|
*/
|
|
2998
3395
|
maxLength?: number;
|
|
3396
|
+
/**
|
|
3397
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
3398
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
3399
|
+
* creation time.
|
|
3400
|
+
*/
|
|
3401
|
+
maxSize?: number;
|
|
2999
3402
|
/**
|
|
3000
3403
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
3001
3404
|
*/
|
|
@@ -3009,7 +3412,7 @@ export declare namespace ModelListResponse {
|
|
|
3009
3412
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
3010
3413
|
* available for \`model_array\` input type.
|
|
3011
3414
|
*/
|
|
3012
|
-
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'>;
|
|
3415
|
+
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'>;
|
|
3013
3416
|
/**
|
|
3014
3417
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
3015
3418
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -3094,6 +3497,12 @@ export declare namespace ModelListResponse {
|
|
|
3094
3497
|
* The parameters of the model
|
|
3095
3498
|
*/
|
|
3096
3499
|
interface Parameters {
|
|
3500
|
+
/**
|
|
3501
|
+
* Age group of the voice (for professional cloning)
|
|
3502
|
+
*
|
|
3503
|
+
* Only available for ElevenLabs voice training
|
|
3504
|
+
*/
|
|
3505
|
+
age?: string;
|
|
3097
3506
|
/**
|
|
3098
3507
|
* The batch size Less steps, and will increase the learning rate
|
|
3099
3508
|
*
|
|
@@ -3106,6 +3515,13 @@ export declare namespace ModelListResponse {
|
|
|
3106
3515
|
* Only available for SD15 training
|
|
3107
3516
|
*/
|
|
3108
3517
|
classPrompt?: string;
|
|
3518
|
+
/**
|
|
3519
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
3520
|
+
* requires captcha)
|
|
3521
|
+
*
|
|
3522
|
+
* Only available for ElevenLabs voice training
|
|
3523
|
+
*/
|
|
3524
|
+
cloneType?: string;
|
|
3109
3525
|
/**
|
|
3110
3526
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
3111
3527
|
* (example: "a daiton dog")
|
|
@@ -3117,6 +3533,18 @@ export declare namespace ModelListResponse {
|
|
|
3117
3533
|
* - For Flux: ""
|
|
3118
3534
|
*/
|
|
3119
3535
|
conceptPrompt?: string;
|
|
3536
|
+
/**
|
|
3537
|
+
* Gender of the voice (for professional cloning)
|
|
3538
|
+
*
|
|
3539
|
+
* Only available for ElevenLabs voice training
|
|
3540
|
+
*/
|
|
3541
|
+
gender?: string;
|
|
3542
|
+
/**
|
|
3543
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
3544
|
+
*
|
|
3545
|
+
* Only available for ElevenLabs voice training
|
|
3546
|
+
*/
|
|
3547
|
+
language?: string;
|
|
3120
3548
|
/**
|
|
3121
3549
|
* Initial learning rate (after the potential warmup period)
|
|
3122
3550
|
*
|
|
@@ -3231,14 +3659,25 @@ export declare namespace ModelListResponse {
|
|
|
3231
3659
|
/**
|
|
3232
3660
|
* The dimension of the LoRA update matrices
|
|
3233
3661
|
*
|
|
3234
|
-
* Only available for SDXL
|
|
3662
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
3235
3663
|
*
|
|
3236
3664
|
* Default value varies depending on the model type:
|
|
3237
3665
|
*
|
|
3238
|
-
* - For SDXL: 64
|
|
3666
|
+
* - For SDXL (deprecated): 64
|
|
3239
3667
|
* - For Flux: 16
|
|
3668
|
+
* - For Musubi: 64
|
|
3669
|
+
*
|
|
3670
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
3671
|
+
* 128])
|
|
3240
3672
|
*/
|
|
3241
3673
|
rank?: number;
|
|
3674
|
+
/**
|
|
3675
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
3676
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
3677
|
+
*
|
|
3678
|
+
* Only available for ElevenLabs voice training
|
|
3679
|
+
*/
|
|
3680
|
+
removeBackgroundNoise?: boolean;
|
|
3242
3681
|
/**
|
|
3243
3682
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
3244
3683
|
*/
|
|
@@ -3285,11 +3724,124 @@ export declare namespace ModelListResponse {
|
|
|
3285
3724
|
* Only available for SD15 and SDXL LoRA training
|
|
3286
3725
|
*/
|
|
3287
3726
|
validationPrompt?: string;
|
|
3727
|
+
/**
|
|
3728
|
+
* Description of the voice characteristics
|
|
3729
|
+
*
|
|
3730
|
+
* Only available for ElevenLabs voice training
|
|
3731
|
+
*/
|
|
3732
|
+
voiceDescription?: string;
|
|
3288
3733
|
/**
|
|
3289
3734
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
3290
3735
|
*/
|
|
3291
3736
|
wandbKey?: string;
|
|
3292
3737
|
}
|
|
3738
|
+
/**
|
|
3739
|
+
* Aggregated performance stats
|
|
3740
|
+
*/
|
|
3741
|
+
interface PerformanceStats {
|
|
3742
|
+
/**
|
|
3743
|
+
* Performance metrics per variant
|
|
3744
|
+
*/
|
|
3745
|
+
variants: Array<PerformanceStats.Variant>;
|
|
3746
|
+
/**
|
|
3747
|
+
* Default variant key for quick model comparison
|
|
3748
|
+
*/
|
|
3749
|
+
default?: string;
|
|
3750
|
+
}
|
|
3751
|
+
namespace PerformanceStats {
|
|
3752
|
+
/**
|
|
3753
|
+
* Performance stats for a model variant
|
|
3754
|
+
*/
|
|
3755
|
+
interface Variant {
|
|
3756
|
+
/**
|
|
3757
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
3758
|
+
*/
|
|
3759
|
+
capability: string;
|
|
3760
|
+
/**
|
|
3761
|
+
* When these stats were last computed (ISO date)
|
|
3762
|
+
*/
|
|
3763
|
+
computedAt: string;
|
|
3764
|
+
/**
|
|
3765
|
+
* Maximum cost per output asset (CU)
|
|
3766
|
+
*/
|
|
3767
|
+
costPerAssetMaxCU: number;
|
|
3768
|
+
/**
|
|
3769
|
+
* Minimum cost per output asset (CU)
|
|
3770
|
+
*/
|
|
3771
|
+
costPerAssetMinCU: number;
|
|
3772
|
+
/**
|
|
3773
|
+
* Median cost per output asset (CU)
|
|
3774
|
+
*/
|
|
3775
|
+
costPerAssetP50CU: number;
|
|
3776
|
+
/**
|
|
3777
|
+
* Inference latency P50 per output asset (seconds)
|
|
3778
|
+
*/
|
|
3779
|
+
inferenceLatencyP50Sec: number;
|
|
3780
|
+
/**
|
|
3781
|
+
* Inference latency P75 per output asset (seconds)
|
|
3782
|
+
*/
|
|
3783
|
+
inferenceLatencyP75Sec: number;
|
|
3784
|
+
/**
|
|
3785
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
3786
|
+
*/
|
|
3787
|
+
totalLatencyP50Sec: number;
|
|
3788
|
+
/**
|
|
3789
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
3790
|
+
*/
|
|
3791
|
+
totalLatencyP75Sec: number;
|
|
3792
|
+
/**
|
|
3793
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
3794
|
+
*/
|
|
3795
|
+
variantKey: string;
|
|
3796
|
+
/**
|
|
3797
|
+
* External quality score from arena.ai leaderboard
|
|
3798
|
+
*/
|
|
3799
|
+
arenaScore?: Variant.ArenaScore;
|
|
3800
|
+
/**
|
|
3801
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
3802
|
+
*/
|
|
3803
|
+
resolution?: string;
|
|
3804
|
+
}
|
|
3805
|
+
namespace Variant {
|
|
3806
|
+
/**
|
|
3807
|
+
* External quality score from arena.ai leaderboard
|
|
3808
|
+
*/
|
|
3809
|
+
interface ArenaScore {
|
|
3810
|
+
/**
|
|
3811
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
3812
|
+
*/
|
|
3813
|
+
arenaCategory: string;
|
|
3814
|
+
/**
|
|
3815
|
+
* Model name on arena.ai
|
|
3816
|
+
*/
|
|
3817
|
+
arenaModelName: string;
|
|
3818
|
+
/**
|
|
3819
|
+
* When this score was last fetched (ISO date)
|
|
3820
|
+
*/
|
|
3821
|
+
fetchedAt: string;
|
|
3822
|
+
/**
|
|
3823
|
+
* Rank in the arena category
|
|
3824
|
+
*/
|
|
3825
|
+
rank: number;
|
|
3826
|
+
/**
|
|
3827
|
+
* ELO rating
|
|
3828
|
+
*/
|
|
3829
|
+
rating: number;
|
|
3830
|
+
/**
|
|
3831
|
+
* ELO rating confidence interval lower bound
|
|
3832
|
+
*/
|
|
3833
|
+
ratingLower: number;
|
|
3834
|
+
/**
|
|
3835
|
+
* ELO rating confidence interval upper bound
|
|
3836
|
+
*/
|
|
3837
|
+
ratingUpper: number;
|
|
3838
|
+
/**
|
|
3839
|
+
* Number of human votes
|
|
3840
|
+
*/
|
|
3841
|
+
votes: number;
|
|
3842
|
+
}
|
|
3843
|
+
}
|
|
3844
|
+
}
|
|
3293
3845
|
/**
|
|
3294
3846
|
* A thumbnail for your model
|
|
3295
3847
|
*/
|
|
@@ -3352,7 +3904,7 @@ export declare namespace ModelListResponse {
|
|
|
3352
3904
|
/**
|
|
3353
3905
|
* The stage of the request
|
|
3354
3906
|
*/
|
|
3355
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
3907
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
3356
3908
|
/**
|
|
3357
3909
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
3358
3910
|
*/
|
|
@@ -3523,7 +4075,7 @@ export declare namespace ModelCopyResponse {
|
|
|
3523
4075
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
3524
4076
|
* "txt2img_ip_adapter", ...])
|
|
3525
4077
|
*/
|
|
3526
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
4078
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
3527
4079
|
/**
|
|
3528
4080
|
* A list of CollectionId this model belongs to
|
|
3529
4081
|
*/
|
|
@@ -3564,7 +4116,7 @@ export declare namespace ModelCopyResponse {
|
|
|
3564
4116
|
/**
|
|
3565
4117
|
* The model type (example: "flux.1-lora")
|
|
3566
4118
|
*/
|
|
3567
|
-
type: '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';
|
|
4119
|
+
type: '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';
|
|
3568
4120
|
/**
|
|
3569
4121
|
* The model last update date as an ISO string (example:
|
|
3570
4122
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -3574,7 +4126,7 @@ export declare namespace ModelCopyResponse {
|
|
|
3574
4126
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
3575
4127
|
* 75: Team plan 100: Enterprise plan
|
|
3576
4128
|
*/
|
|
3577
|
-
accessRestrictions?:
|
|
4129
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
3578
4130
|
/**
|
|
3579
4131
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
3580
4132
|
*/
|
|
@@ -3583,10 +4135,6 @@ export declare namespace ModelCopyResponse {
|
|
|
3583
4135
|
* The class of the model
|
|
3584
4136
|
*/
|
|
3585
4137
|
class?: Model.Class;
|
|
3586
|
-
/**
|
|
3587
|
-
* Compliance and regulatory metadata for the model
|
|
3588
|
-
*/
|
|
3589
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
3590
4138
|
/**
|
|
3591
4139
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
3592
4140
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -3635,6 +4183,10 @@ export declare namespace ModelCopyResponse {
|
|
|
3635
4183
|
* The id of the parent model
|
|
3636
4184
|
*/
|
|
3637
4185
|
parentModelId?: string;
|
|
4186
|
+
/**
|
|
4187
|
+
* Aggregated performance stats
|
|
4188
|
+
*/
|
|
4189
|
+
performanceStats?: Model.PerformanceStats;
|
|
3638
4190
|
/**
|
|
3639
4191
|
* Fine-tune the model's inferences with prompt embedding
|
|
3640
4192
|
*/
|
|
@@ -3694,53 +4246,28 @@ export declare namespace ModelCopyResponse {
|
|
|
3694
4246
|
/**
|
|
3695
4247
|
* The model ID of the class (example: "stable-diffusion-v1-5")
|
|
3696
4248
|
*/
|
|
3697
|
-
modelId: string;
|
|
3698
|
-
/**
|
|
3699
|
-
* The class name (example: "Character Design")
|
|
3700
|
-
*/
|
|
3701
|
-
name: string;
|
|
3702
|
-
/**
|
|
3703
|
-
* The class prompt (example: "a character design")
|
|
3704
|
-
*/
|
|
3705
|
-
prompt: string;
|
|
3706
|
-
/**
|
|
3707
|
-
* The class slug (example: "art-style-character-design")
|
|
3708
|
-
*/
|
|
3709
|
-
slug: string;
|
|
3710
|
-
/**
|
|
3711
|
-
* The class status (only published classes are listed, but unpublished classes can
|
|
3712
|
-
* still appear in existing models)
|
|
3713
|
-
*/
|
|
3714
|
-
status: 'published' | 'unpublished';
|
|
3715
|
-
/**
|
|
3716
|
-
* Some example images URLs to showcase the class
|
|
3717
|
-
*/
|
|
3718
|
-
thumbnails: Array<string>;
|
|
3719
|
-
}
|
|
3720
|
-
/**
|
|
3721
|
-
* Compliance and regulatory metadata for the model
|
|
3722
|
-
*/
|
|
3723
|
-
interface ComplianceMetadata {
|
|
4249
|
+
modelId: string;
|
|
3724
4250
|
/**
|
|
3725
|
-
*
|
|
4251
|
+
* The class name (example: "Character Design")
|
|
3726
4252
|
*/
|
|
3727
|
-
|
|
4253
|
+
name: string;
|
|
3728
4254
|
/**
|
|
3729
|
-
*
|
|
4255
|
+
* The class prompt (example: "a character design")
|
|
3730
4256
|
*/
|
|
3731
|
-
|
|
4257
|
+
prompt: string;
|
|
3732
4258
|
/**
|
|
3733
|
-
* The
|
|
4259
|
+
* The class slug (example: "art-style-character-design")
|
|
3734
4260
|
*/
|
|
3735
|
-
|
|
4261
|
+
slug: string;
|
|
3736
4262
|
/**
|
|
3737
|
-
* The
|
|
4263
|
+
* The class status (only published classes are listed, but unpublished classes can
|
|
4264
|
+
* still appear in existing models)
|
|
3738
4265
|
*/
|
|
3739
|
-
|
|
4266
|
+
status: 'published' | 'unpublished';
|
|
3740
4267
|
/**
|
|
3741
|
-
*
|
|
4268
|
+
* Some example images URLs to showcase the class
|
|
3742
4269
|
*/
|
|
3743
|
-
|
|
4270
|
+
thumbnails: Array<string>;
|
|
3744
4271
|
}
|
|
3745
4272
|
interface Concept {
|
|
3746
4273
|
/**
|
|
@@ -3815,6 +4342,10 @@ export declare namespace ModelCopyResponse {
|
|
|
3815
4342
|
* Whether this input affects the model's cost calculation
|
|
3816
4343
|
*/
|
|
3817
4344
|
costImpact?: boolean;
|
|
4345
|
+
/**
|
|
4346
|
+
* The default value for the input
|
|
4347
|
+
*/
|
|
4348
|
+
default?: unknown;
|
|
3818
4349
|
/**
|
|
3819
4350
|
* Help text displayed in the UI to provide additional information about the input
|
|
3820
4351
|
*/
|
|
@@ -3833,10 +4364,14 @@ export declare namespace ModelCopyResponse {
|
|
|
3833
4364
|
* the same as the current object. This is only available for type inputs_array
|
|
3834
4365
|
* inputs.
|
|
3835
4366
|
*/
|
|
3836
|
-
inputs?: Array<
|
|
4367
|
+
inputs?: Array<{
|
|
4368
|
+
[key: string]: unknown;
|
|
4369
|
+
}>;
|
|
3837
4370
|
/**
|
|
3838
4371
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
3839
|
-
* \`file_array\` input types.
|
|
4372
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
4373
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
4374
|
+
* data:kind, prefix
|
|
3840
4375
|
*/
|
|
3841
4376
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3842
4377
|
/**
|
|
@@ -3857,6 +4392,12 @@ export declare namespace ModelCopyResponse {
|
|
|
3857
4392
|
* \`string_array\`.
|
|
3858
4393
|
*/
|
|
3859
4394
|
maxLength?: number;
|
|
4395
|
+
/**
|
|
4396
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
4397
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
4398
|
+
* creation time.
|
|
4399
|
+
*/
|
|
4400
|
+
maxSize?: number;
|
|
3860
4401
|
/**
|
|
3861
4402
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
3862
4403
|
*/
|
|
@@ -3870,7 +4411,7 @@ export declare namespace ModelCopyResponse {
|
|
|
3870
4411
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
3871
4412
|
* available for \`model_array\` input type.
|
|
3872
4413
|
*/
|
|
3873
|
-
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'>;
|
|
4414
|
+
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'>;
|
|
3874
4415
|
/**
|
|
3875
4416
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
3876
4417
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -3955,6 +4496,12 @@ export declare namespace ModelCopyResponse {
|
|
|
3955
4496
|
* The parameters of the model
|
|
3956
4497
|
*/
|
|
3957
4498
|
interface Parameters {
|
|
4499
|
+
/**
|
|
4500
|
+
* Age group of the voice (for professional cloning)
|
|
4501
|
+
*
|
|
4502
|
+
* Only available for ElevenLabs voice training
|
|
4503
|
+
*/
|
|
4504
|
+
age?: string;
|
|
3958
4505
|
/**
|
|
3959
4506
|
* The batch size Less steps, and will increase the learning rate
|
|
3960
4507
|
*
|
|
@@ -3967,6 +4514,13 @@ export declare namespace ModelCopyResponse {
|
|
|
3967
4514
|
* Only available for SD15 training
|
|
3968
4515
|
*/
|
|
3969
4516
|
classPrompt?: string;
|
|
4517
|
+
/**
|
|
4518
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
4519
|
+
* requires captcha)
|
|
4520
|
+
*
|
|
4521
|
+
* Only available for ElevenLabs voice training
|
|
4522
|
+
*/
|
|
4523
|
+
cloneType?: string;
|
|
3970
4524
|
/**
|
|
3971
4525
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
3972
4526
|
* (example: "a daiton dog")
|
|
@@ -3978,6 +4532,18 @@ export declare namespace ModelCopyResponse {
|
|
|
3978
4532
|
* - For Flux: ""
|
|
3979
4533
|
*/
|
|
3980
4534
|
conceptPrompt?: string;
|
|
4535
|
+
/**
|
|
4536
|
+
* Gender of the voice (for professional cloning)
|
|
4537
|
+
*
|
|
4538
|
+
* Only available for ElevenLabs voice training
|
|
4539
|
+
*/
|
|
4540
|
+
gender?: string;
|
|
4541
|
+
/**
|
|
4542
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
4543
|
+
*
|
|
4544
|
+
* Only available for ElevenLabs voice training
|
|
4545
|
+
*/
|
|
4546
|
+
language?: string;
|
|
3981
4547
|
/**
|
|
3982
4548
|
* Initial learning rate (after the potential warmup period)
|
|
3983
4549
|
*
|
|
@@ -4092,14 +4658,25 @@ export declare namespace ModelCopyResponse {
|
|
|
4092
4658
|
/**
|
|
4093
4659
|
* The dimension of the LoRA update matrices
|
|
4094
4660
|
*
|
|
4095
|
-
* Only available for SDXL
|
|
4661
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
4096
4662
|
*
|
|
4097
4663
|
* Default value varies depending on the model type:
|
|
4098
4664
|
*
|
|
4099
|
-
* - For SDXL: 64
|
|
4665
|
+
* - For SDXL (deprecated): 64
|
|
4100
4666
|
* - For Flux: 16
|
|
4667
|
+
* - For Musubi: 64
|
|
4668
|
+
*
|
|
4669
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
4670
|
+
* 128])
|
|
4101
4671
|
*/
|
|
4102
4672
|
rank?: number;
|
|
4673
|
+
/**
|
|
4674
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
4675
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
4676
|
+
*
|
|
4677
|
+
* Only available for ElevenLabs voice training
|
|
4678
|
+
*/
|
|
4679
|
+
removeBackgroundNoise?: boolean;
|
|
4103
4680
|
/**
|
|
4104
4681
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
4105
4682
|
*/
|
|
@@ -4146,11 +4723,124 @@ export declare namespace ModelCopyResponse {
|
|
|
4146
4723
|
* Only available for SD15 and SDXL LoRA training
|
|
4147
4724
|
*/
|
|
4148
4725
|
validationPrompt?: string;
|
|
4726
|
+
/**
|
|
4727
|
+
* Description of the voice characteristics
|
|
4728
|
+
*
|
|
4729
|
+
* Only available for ElevenLabs voice training
|
|
4730
|
+
*/
|
|
4731
|
+
voiceDescription?: string;
|
|
4149
4732
|
/**
|
|
4150
4733
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
4151
4734
|
*/
|
|
4152
4735
|
wandbKey?: string;
|
|
4153
4736
|
}
|
|
4737
|
+
/**
|
|
4738
|
+
* Aggregated performance stats
|
|
4739
|
+
*/
|
|
4740
|
+
interface PerformanceStats {
|
|
4741
|
+
/**
|
|
4742
|
+
* Performance metrics per variant
|
|
4743
|
+
*/
|
|
4744
|
+
variants: Array<PerformanceStats.Variant>;
|
|
4745
|
+
/**
|
|
4746
|
+
* Default variant key for quick model comparison
|
|
4747
|
+
*/
|
|
4748
|
+
default?: string;
|
|
4749
|
+
}
|
|
4750
|
+
namespace PerformanceStats {
|
|
4751
|
+
/**
|
|
4752
|
+
* Performance stats for a model variant
|
|
4753
|
+
*/
|
|
4754
|
+
interface Variant {
|
|
4755
|
+
/**
|
|
4756
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
4757
|
+
*/
|
|
4758
|
+
capability: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* When these stats were last computed (ISO date)
|
|
4761
|
+
*/
|
|
4762
|
+
computedAt: string;
|
|
4763
|
+
/**
|
|
4764
|
+
* Maximum cost per output asset (CU)
|
|
4765
|
+
*/
|
|
4766
|
+
costPerAssetMaxCU: number;
|
|
4767
|
+
/**
|
|
4768
|
+
* Minimum cost per output asset (CU)
|
|
4769
|
+
*/
|
|
4770
|
+
costPerAssetMinCU: number;
|
|
4771
|
+
/**
|
|
4772
|
+
* Median cost per output asset (CU)
|
|
4773
|
+
*/
|
|
4774
|
+
costPerAssetP50CU: number;
|
|
4775
|
+
/**
|
|
4776
|
+
* Inference latency P50 per output asset (seconds)
|
|
4777
|
+
*/
|
|
4778
|
+
inferenceLatencyP50Sec: number;
|
|
4779
|
+
/**
|
|
4780
|
+
* Inference latency P75 per output asset (seconds)
|
|
4781
|
+
*/
|
|
4782
|
+
inferenceLatencyP75Sec: number;
|
|
4783
|
+
/**
|
|
4784
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
4785
|
+
*/
|
|
4786
|
+
totalLatencyP50Sec: number;
|
|
4787
|
+
/**
|
|
4788
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
4789
|
+
*/
|
|
4790
|
+
totalLatencyP75Sec: number;
|
|
4791
|
+
/**
|
|
4792
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
4793
|
+
*/
|
|
4794
|
+
variantKey: string;
|
|
4795
|
+
/**
|
|
4796
|
+
* External quality score from arena.ai leaderboard
|
|
4797
|
+
*/
|
|
4798
|
+
arenaScore?: Variant.ArenaScore;
|
|
4799
|
+
/**
|
|
4800
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
4801
|
+
*/
|
|
4802
|
+
resolution?: string;
|
|
4803
|
+
}
|
|
4804
|
+
namespace Variant {
|
|
4805
|
+
/**
|
|
4806
|
+
* External quality score from arena.ai leaderboard
|
|
4807
|
+
*/
|
|
4808
|
+
interface ArenaScore {
|
|
4809
|
+
/**
|
|
4810
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
4811
|
+
*/
|
|
4812
|
+
arenaCategory: string;
|
|
4813
|
+
/**
|
|
4814
|
+
* Model name on arena.ai
|
|
4815
|
+
*/
|
|
4816
|
+
arenaModelName: string;
|
|
4817
|
+
/**
|
|
4818
|
+
* When this score was last fetched (ISO date)
|
|
4819
|
+
*/
|
|
4820
|
+
fetchedAt: string;
|
|
4821
|
+
/**
|
|
4822
|
+
* Rank in the arena category
|
|
4823
|
+
*/
|
|
4824
|
+
rank: number;
|
|
4825
|
+
/**
|
|
4826
|
+
* ELO rating
|
|
4827
|
+
*/
|
|
4828
|
+
rating: number;
|
|
4829
|
+
/**
|
|
4830
|
+
* ELO rating confidence interval lower bound
|
|
4831
|
+
*/
|
|
4832
|
+
ratingLower: number;
|
|
4833
|
+
/**
|
|
4834
|
+
* ELO rating confidence interval upper bound
|
|
4835
|
+
*/
|
|
4836
|
+
ratingUpper: number;
|
|
4837
|
+
/**
|
|
4838
|
+
* Number of human votes
|
|
4839
|
+
*/
|
|
4840
|
+
votes: number;
|
|
4841
|
+
}
|
|
4842
|
+
}
|
|
4843
|
+
}
|
|
4154
4844
|
/**
|
|
4155
4845
|
* A thumbnail for your model
|
|
4156
4846
|
*/
|
|
@@ -4213,7 +4903,7 @@ export declare namespace ModelCopyResponse {
|
|
|
4213
4903
|
/**
|
|
4214
4904
|
* The stage of the request
|
|
4215
4905
|
*/
|
|
4216
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
4906
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
4217
4907
|
/**
|
|
4218
4908
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
4219
4909
|
*/
|
|
@@ -4393,12 +5083,12 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4393
5083
|
/**
|
|
4394
5084
|
* The model type (example: "flux.1-lora")
|
|
4395
5085
|
*/
|
|
4396
|
-
type: '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';
|
|
5086
|
+
type: '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';
|
|
4397
5087
|
/**
|
|
4398
5088
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
4399
5089
|
* 75: Team plan 100: Enterprise plan
|
|
4400
5090
|
*/
|
|
4401
|
-
accessRestrictions?:
|
|
5091
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
4402
5092
|
/**
|
|
4403
5093
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
4404
5094
|
*/
|
|
@@ -4407,7 +5097,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4407
5097
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
4408
5098
|
* "txt2img_ip_adapter", ...])
|
|
4409
5099
|
*/
|
|
4410
|
-
capabilities?: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
5100
|
+
capabilities?: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
4411
5101
|
/**
|
|
4412
5102
|
* The class of the model
|
|
4413
5103
|
*/
|
|
@@ -4416,10 +5106,6 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4416
5106
|
* A list of CollectionId this model belongs to
|
|
4417
5107
|
*/
|
|
4418
5108
|
collectionIds?: Array<string>;
|
|
4419
|
-
/**
|
|
4420
|
-
* Compliance and regulatory metadata for the model
|
|
4421
|
-
*/
|
|
4422
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
4423
5109
|
/**
|
|
4424
5110
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
4425
5111
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -4481,6 +5167,10 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4481
5167
|
* The id of the parent model
|
|
4482
5168
|
*/
|
|
4483
5169
|
parentModelId?: string;
|
|
5170
|
+
/**
|
|
5171
|
+
* Aggregated performance stats
|
|
5172
|
+
*/
|
|
5173
|
+
performanceStats?: Model.PerformanceStats;
|
|
4484
5174
|
/**
|
|
4485
5175
|
* Fine-tune the model's inferences with prompt embedding
|
|
4486
5176
|
*/
|
|
@@ -4584,31 +5274,6 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4584
5274
|
*/
|
|
4585
5275
|
thumbnails: Array<string>;
|
|
4586
5276
|
}
|
|
4587
|
-
/**
|
|
4588
|
-
* Compliance and regulatory metadata for the model
|
|
4589
|
-
*/
|
|
4590
|
-
interface ComplianceMetadata {
|
|
4591
|
-
/**
|
|
4592
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
4593
|
-
*/
|
|
4594
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
4595
|
-
/**
|
|
4596
|
-
* URL to license terms
|
|
4597
|
-
*/
|
|
4598
|
-
licenseTerms?: string;
|
|
4599
|
-
/**
|
|
4600
|
-
* The maintainer of the model
|
|
4601
|
-
*/
|
|
4602
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
4603
|
-
/**
|
|
4604
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
4605
|
-
*/
|
|
4606
|
-
modelProvider?: string;
|
|
4607
|
-
/**
|
|
4608
|
-
* The sub-processor used for the model
|
|
4609
|
-
*/
|
|
4610
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
4611
|
-
}
|
|
4612
5277
|
interface Concept {
|
|
4613
5278
|
/**
|
|
4614
5279
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -4682,6 +5347,10 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4682
5347
|
* Whether this input affects the model's cost calculation
|
|
4683
5348
|
*/
|
|
4684
5349
|
costImpact?: boolean;
|
|
5350
|
+
/**
|
|
5351
|
+
* The default value for the input
|
|
5352
|
+
*/
|
|
5353
|
+
default?: unknown;
|
|
4685
5354
|
/**
|
|
4686
5355
|
* Help text displayed in the UI to provide additional information about the input
|
|
4687
5356
|
*/
|
|
@@ -4700,10 +5369,14 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4700
5369
|
* the same as the current object. This is only available for type inputs_array
|
|
4701
5370
|
* inputs.
|
|
4702
5371
|
*/
|
|
4703
|
-
inputs?: Array<
|
|
5372
|
+
inputs?: Array<{
|
|
5373
|
+
[key: string]: unknown;
|
|
5374
|
+
}>;
|
|
4704
5375
|
/**
|
|
4705
5376
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
4706
|
-
* \`file_array\` input types.
|
|
5377
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
5378
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
5379
|
+
* data:kind, prefix
|
|
4707
5380
|
*/
|
|
4708
5381
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
4709
5382
|
/**
|
|
@@ -4724,6 +5397,12 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4724
5397
|
* \`string_array\`.
|
|
4725
5398
|
*/
|
|
4726
5399
|
maxLength?: number;
|
|
5400
|
+
/**
|
|
5401
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
5402
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
5403
|
+
* creation time.
|
|
5404
|
+
*/
|
|
5405
|
+
maxSize?: number;
|
|
4727
5406
|
/**
|
|
4728
5407
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
4729
5408
|
*/
|
|
@@ -4737,7 +5416,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4737
5416
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
4738
5417
|
* available for \`model_array\` input type.
|
|
4739
5418
|
*/
|
|
4740
|
-
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'>;
|
|
5419
|
+
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'>;
|
|
4741
5420
|
/**
|
|
4742
5421
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
4743
5422
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -4822,6 +5501,12 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4822
5501
|
* The parameters of the model
|
|
4823
5502
|
*/
|
|
4824
5503
|
interface Parameters {
|
|
5504
|
+
/**
|
|
5505
|
+
* Age group of the voice (for professional cloning)
|
|
5506
|
+
*
|
|
5507
|
+
* Only available for ElevenLabs voice training
|
|
5508
|
+
*/
|
|
5509
|
+
age?: string;
|
|
4825
5510
|
/**
|
|
4826
5511
|
* The batch size Less steps, and will increase the learning rate
|
|
4827
5512
|
*
|
|
@@ -4834,6 +5519,13 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4834
5519
|
* Only available for SD15 training
|
|
4835
5520
|
*/
|
|
4836
5521
|
classPrompt?: string;
|
|
5522
|
+
/**
|
|
5523
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
5524
|
+
* requires captcha)
|
|
5525
|
+
*
|
|
5526
|
+
* Only available for ElevenLabs voice training
|
|
5527
|
+
*/
|
|
5528
|
+
cloneType?: string;
|
|
4837
5529
|
/**
|
|
4838
5530
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
4839
5531
|
* (example: "a daiton dog")
|
|
@@ -4845,6 +5537,18 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4845
5537
|
* - For Flux: ""
|
|
4846
5538
|
*/
|
|
4847
5539
|
conceptPrompt?: string;
|
|
5540
|
+
/**
|
|
5541
|
+
* Gender of the voice (for professional cloning)
|
|
5542
|
+
*
|
|
5543
|
+
* Only available for ElevenLabs voice training
|
|
5544
|
+
*/
|
|
5545
|
+
gender?: string;
|
|
5546
|
+
/**
|
|
5547
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
5548
|
+
*
|
|
5549
|
+
* Only available for ElevenLabs voice training
|
|
5550
|
+
*/
|
|
5551
|
+
language?: string;
|
|
4848
5552
|
/**
|
|
4849
5553
|
* Initial learning rate (after the potential warmup period)
|
|
4850
5554
|
*
|
|
@@ -4959,14 +5663,25 @@ export declare namespace ModelGetBulkResponse {
|
|
|
4959
5663
|
/**
|
|
4960
5664
|
* The dimension of the LoRA update matrices
|
|
4961
5665
|
*
|
|
4962
|
-
* Only available for SDXL
|
|
5666
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
4963
5667
|
*
|
|
4964
5668
|
* Default value varies depending on the model type:
|
|
4965
5669
|
*
|
|
4966
|
-
* - For SDXL: 64
|
|
5670
|
+
* - For SDXL (deprecated): 64
|
|
4967
5671
|
* - For Flux: 16
|
|
5672
|
+
* - For Musubi: 64
|
|
5673
|
+
*
|
|
5674
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
5675
|
+
* 128])
|
|
4968
5676
|
*/
|
|
4969
5677
|
rank?: number;
|
|
5678
|
+
/**
|
|
5679
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
5680
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
5681
|
+
*
|
|
5682
|
+
* Only available for ElevenLabs voice training
|
|
5683
|
+
*/
|
|
5684
|
+
removeBackgroundNoise?: boolean;
|
|
4970
5685
|
/**
|
|
4971
5686
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
4972
5687
|
*/
|
|
@@ -5013,11 +5728,124 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5013
5728
|
* Only available for SD15 and SDXL LoRA training
|
|
5014
5729
|
*/
|
|
5015
5730
|
validationPrompt?: string;
|
|
5731
|
+
/**
|
|
5732
|
+
* Description of the voice characteristics
|
|
5733
|
+
*
|
|
5734
|
+
* Only available for ElevenLabs voice training
|
|
5735
|
+
*/
|
|
5736
|
+
voiceDescription?: string;
|
|
5016
5737
|
/**
|
|
5017
5738
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
5018
5739
|
*/
|
|
5019
5740
|
wandbKey?: string;
|
|
5020
5741
|
}
|
|
5742
|
+
/**
|
|
5743
|
+
* Aggregated performance stats
|
|
5744
|
+
*/
|
|
5745
|
+
interface PerformanceStats {
|
|
5746
|
+
/**
|
|
5747
|
+
* Performance metrics per variant
|
|
5748
|
+
*/
|
|
5749
|
+
variants: Array<PerformanceStats.Variant>;
|
|
5750
|
+
/**
|
|
5751
|
+
* Default variant key for quick model comparison
|
|
5752
|
+
*/
|
|
5753
|
+
default?: string;
|
|
5754
|
+
}
|
|
5755
|
+
namespace PerformanceStats {
|
|
5756
|
+
/**
|
|
5757
|
+
* Performance stats for a model variant
|
|
5758
|
+
*/
|
|
5759
|
+
interface Variant {
|
|
5760
|
+
/**
|
|
5761
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
5762
|
+
*/
|
|
5763
|
+
capability: string;
|
|
5764
|
+
/**
|
|
5765
|
+
* When these stats were last computed (ISO date)
|
|
5766
|
+
*/
|
|
5767
|
+
computedAt: string;
|
|
5768
|
+
/**
|
|
5769
|
+
* Maximum cost per output asset (CU)
|
|
5770
|
+
*/
|
|
5771
|
+
costPerAssetMaxCU: number;
|
|
5772
|
+
/**
|
|
5773
|
+
* Minimum cost per output asset (CU)
|
|
5774
|
+
*/
|
|
5775
|
+
costPerAssetMinCU: number;
|
|
5776
|
+
/**
|
|
5777
|
+
* Median cost per output asset (CU)
|
|
5778
|
+
*/
|
|
5779
|
+
costPerAssetP50CU: number;
|
|
5780
|
+
/**
|
|
5781
|
+
* Inference latency P50 per output asset (seconds)
|
|
5782
|
+
*/
|
|
5783
|
+
inferenceLatencyP50Sec: number;
|
|
5784
|
+
/**
|
|
5785
|
+
* Inference latency P75 per output asset (seconds)
|
|
5786
|
+
*/
|
|
5787
|
+
inferenceLatencyP75Sec: number;
|
|
5788
|
+
/**
|
|
5789
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
5790
|
+
*/
|
|
5791
|
+
totalLatencyP50Sec: number;
|
|
5792
|
+
/**
|
|
5793
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
5794
|
+
*/
|
|
5795
|
+
totalLatencyP75Sec: number;
|
|
5796
|
+
/**
|
|
5797
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
5798
|
+
*/
|
|
5799
|
+
variantKey: string;
|
|
5800
|
+
/**
|
|
5801
|
+
* External quality score from arena.ai leaderboard
|
|
5802
|
+
*/
|
|
5803
|
+
arenaScore?: Variant.ArenaScore;
|
|
5804
|
+
/**
|
|
5805
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
5806
|
+
*/
|
|
5807
|
+
resolution?: string;
|
|
5808
|
+
}
|
|
5809
|
+
namespace Variant {
|
|
5810
|
+
/**
|
|
5811
|
+
* External quality score from arena.ai leaderboard
|
|
5812
|
+
*/
|
|
5813
|
+
interface ArenaScore {
|
|
5814
|
+
/**
|
|
5815
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
5816
|
+
*/
|
|
5817
|
+
arenaCategory: string;
|
|
5818
|
+
/**
|
|
5819
|
+
* Model name on arena.ai
|
|
5820
|
+
*/
|
|
5821
|
+
arenaModelName: string;
|
|
5822
|
+
/**
|
|
5823
|
+
* When this score was last fetched (ISO date)
|
|
5824
|
+
*/
|
|
5825
|
+
fetchedAt: string;
|
|
5826
|
+
/**
|
|
5827
|
+
* Rank in the arena category
|
|
5828
|
+
*/
|
|
5829
|
+
rank: number;
|
|
5830
|
+
/**
|
|
5831
|
+
* ELO rating
|
|
5832
|
+
*/
|
|
5833
|
+
rating: number;
|
|
5834
|
+
/**
|
|
5835
|
+
* ELO rating confidence interval lower bound
|
|
5836
|
+
*/
|
|
5837
|
+
ratingLower: number;
|
|
5838
|
+
/**
|
|
5839
|
+
* ELO rating confidence interval upper bound
|
|
5840
|
+
*/
|
|
5841
|
+
ratingUpper: number;
|
|
5842
|
+
/**
|
|
5843
|
+
* Number of human votes
|
|
5844
|
+
*/
|
|
5845
|
+
votes: number;
|
|
5846
|
+
}
|
|
5847
|
+
}
|
|
5848
|
+
}
|
|
5021
5849
|
/**
|
|
5022
5850
|
* A thumbnail for your model
|
|
5023
5851
|
*/
|
|
@@ -5080,7 +5908,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5080
5908
|
/**
|
|
5081
5909
|
* The stage of the request
|
|
5082
5910
|
*/
|
|
5083
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
5911
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
5084
5912
|
/**
|
|
5085
5913
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
5086
5914
|
*/
|
|
@@ -5250,7 +6078,7 @@ export declare namespace ModelTransferResponse {
|
|
|
5250
6078
|
* List of model capabilities (example: ["txt2img", "img2img",
|
|
5251
6079
|
* "txt2img_ip_adapter", ...])
|
|
5252
6080
|
*/
|
|
5253
|
-
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video2img' | 'video2video'>;
|
|
6081
|
+
capabilities: Array<'3d23d' | 'audio2audio' | 'controlnet' | 'controlnet_img2img' | 'controlnet_inpaint' | 'controlnet_inpaint_ip_adapter' | 'controlnet_ip_adapter' | 'controlnet_reference' | 'controlnet_texture' | 'img23d' | 'img2img' | 'img2img_ip_adapter' | 'img2img_texture' | 'img2txt' | 'img2video' | 'inpaint' | 'inpaint_ip_adapter' | 'outpaint' | 'reference' | 'reference_texture' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2img_ip_adapter' | 'txt2img_texture' | 'txt2txt' | 'txt2video' | 'video23d' | 'video2img' | 'video2video'>;
|
|
5254
6082
|
/**
|
|
5255
6083
|
* A list of CollectionId this model belongs to
|
|
5256
6084
|
*/
|
|
@@ -5291,7 +6119,7 @@ export declare namespace ModelTransferResponse {
|
|
|
5291
6119
|
/**
|
|
5292
6120
|
* The model type (example: "flux.1-lora")
|
|
5293
6121
|
*/
|
|
5294
|
-
type: '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';
|
|
6122
|
+
type: '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';
|
|
5295
6123
|
/**
|
|
5296
6124
|
* The model last update date as an ISO string (example:
|
|
5297
6125
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -5301,7 +6129,7 @@ export declare namespace ModelTransferResponse {
|
|
|
5301
6129
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
5302
6130
|
* 75: Team plan 100: Enterprise plan
|
|
5303
6131
|
*/
|
|
5304
|
-
accessRestrictions?:
|
|
6132
|
+
accessRestrictions?: 0 | 100 | 25 | 50 | 75;
|
|
5305
6133
|
/**
|
|
5306
6134
|
* The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
|
|
5307
6135
|
*/
|
|
@@ -5310,10 +6138,6 @@ export declare namespace ModelTransferResponse {
|
|
|
5310
6138
|
* The class of the model
|
|
5311
6139
|
*/
|
|
5312
6140
|
class?: Model.Class;
|
|
5313
|
-
/**
|
|
5314
|
-
* Compliance and regulatory metadata for the model
|
|
5315
|
-
*/
|
|
5316
|
-
complianceMetadata?: Model.ComplianceMetadata;
|
|
5317
6141
|
/**
|
|
5318
6142
|
* List of base model IDs compliant with the model (example: ["flux.1-dev",
|
|
5319
6143
|
* "flux.1-schnell"]) This attribute is mainly used for Flux LoRA models
|
|
@@ -5362,6 +6186,10 @@ export declare namespace ModelTransferResponse {
|
|
|
5362
6186
|
* The id of the parent model
|
|
5363
6187
|
*/
|
|
5364
6188
|
parentModelId?: string;
|
|
6189
|
+
/**
|
|
6190
|
+
* Aggregated performance stats
|
|
6191
|
+
*/
|
|
6192
|
+
performanceStats?: Model.PerformanceStats;
|
|
5365
6193
|
/**
|
|
5366
6194
|
* Fine-tune the model's inferences with prompt embedding
|
|
5367
6195
|
*/
|
|
@@ -5444,31 +6272,6 @@ export declare namespace ModelTransferResponse {
|
|
|
5444
6272
|
*/
|
|
5445
6273
|
thumbnails: Array<string>;
|
|
5446
6274
|
}
|
|
5447
|
-
/**
|
|
5448
|
-
* Compliance and regulatory metadata for the model
|
|
5449
|
-
*/
|
|
5450
|
-
interface ComplianceMetadata {
|
|
5451
|
-
/**
|
|
5452
|
-
* Data processing comment (e.g., zeroRetention, temporaryRetention, etc.)
|
|
5453
|
-
*/
|
|
5454
|
-
dataProcessingComment?: 'researchOnly' | 'serviceImprovement' | 'temporaryRetention' | 'zeroRetention';
|
|
5455
|
-
/**
|
|
5456
|
-
* URL to license terms
|
|
5457
|
-
*/
|
|
5458
|
-
licenseTerms?: string;
|
|
5459
|
-
/**
|
|
5460
|
-
* The maintainer of the model
|
|
5461
|
-
*/
|
|
5462
|
-
maintainer?: 'Fal' | 'Provider' | 'Replicate' | 'Scenario';
|
|
5463
|
-
/**
|
|
5464
|
-
* The provider of the model (examples: 'Google', 'AWS', 'BFL', 'Meshy', etc.)
|
|
5465
|
-
*/
|
|
5466
|
-
modelProvider?: string;
|
|
5467
|
-
/**
|
|
5468
|
-
* The sub-processor used for the model
|
|
5469
|
-
*/
|
|
5470
|
-
subProcessor?: 'AWS' | 'Fal' | 'Modal' | 'Provider' | 'Replicate';
|
|
5471
|
-
}
|
|
5472
6275
|
interface Concept {
|
|
5473
6276
|
/**
|
|
5474
6277
|
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
@@ -5542,6 +6345,10 @@ export declare namespace ModelTransferResponse {
|
|
|
5542
6345
|
* Whether this input affects the model's cost calculation
|
|
5543
6346
|
*/
|
|
5544
6347
|
costImpact?: boolean;
|
|
6348
|
+
/**
|
|
6349
|
+
* The default value for the input
|
|
6350
|
+
*/
|
|
6351
|
+
default?: unknown;
|
|
5545
6352
|
/**
|
|
5546
6353
|
* Help text displayed in the UI to provide additional information about the input
|
|
5547
6354
|
*/
|
|
@@ -5560,10 +6367,14 @@ export declare namespace ModelTransferResponse {
|
|
|
5560
6367
|
* the same as the current object. This is only available for type inputs_array
|
|
5561
6368
|
* inputs.
|
|
5562
6369
|
*/
|
|
5563
|
-
inputs?: Array<
|
|
6370
|
+
inputs?: Array<{
|
|
6371
|
+
[key: string]: unknown;
|
|
6372
|
+
}>;
|
|
5564
6373
|
/**
|
|
5565
6374
|
* The asset kind of the input. Only taken into account for \`file\` and
|
|
5566
|
-
* \`file_array\` input types.
|
|
6375
|
+
* \`file_array\` input types. If model provides multiple kinds, the input will be
|
|
6376
|
+
* not able to create the asset on the flight on API side with dataurl without
|
|
6377
|
+
* data:kind, prefix
|
|
5567
6378
|
*/
|
|
5568
6379
|
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
5569
6380
|
/**
|
|
@@ -5584,6 +6395,12 @@ export declare namespace ModelTransferResponse {
|
|
|
5584
6395
|
* \`string_array\`.
|
|
5585
6396
|
*/
|
|
5586
6397
|
maxLength?: number;
|
|
6398
|
+
/**
|
|
6399
|
+
* The maximum allowed file size in bytes. Only applies to \`file\` and
|
|
6400
|
+
* \`file_array\` input types. Validated against \`asset.properties.size\` at job
|
|
6401
|
+
* creation time.
|
|
6402
|
+
*/
|
|
6403
|
+
maxSize?: number;
|
|
5587
6404
|
/**
|
|
5588
6405
|
* The minimum allowed value. Only available for \`number\` and array input types.
|
|
5589
6406
|
*/
|
|
@@ -5597,7 +6414,7 @@ export declare namespace ModelTransferResponse {
|
|
|
5597
6414
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
5598
6415
|
* available for \`model_array\` input type.
|
|
5599
6416
|
*/
|
|
5600
|
-
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'>;
|
|
6417
|
+
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'>;
|
|
5601
6418
|
/**
|
|
5602
6419
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
5603
6420
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -5682,6 +6499,12 @@ export declare namespace ModelTransferResponse {
|
|
|
5682
6499
|
* The parameters of the model
|
|
5683
6500
|
*/
|
|
5684
6501
|
interface Parameters {
|
|
6502
|
+
/**
|
|
6503
|
+
* Age group of the voice (for professional cloning)
|
|
6504
|
+
*
|
|
6505
|
+
* Only available for ElevenLabs voice training
|
|
6506
|
+
*/
|
|
6507
|
+
age?: string;
|
|
5685
6508
|
/**
|
|
5686
6509
|
* The batch size Less steps, and will increase the learning rate
|
|
5687
6510
|
*
|
|
@@ -5694,6 +6517,13 @@ export declare namespace ModelTransferResponse {
|
|
|
5694
6517
|
* Only available for SD15 training
|
|
5695
6518
|
*/
|
|
5696
6519
|
classPrompt?: string;
|
|
6520
|
+
/**
|
|
6521
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
6522
|
+
* requires captcha)
|
|
6523
|
+
*
|
|
6524
|
+
* Only available for ElevenLabs voice training
|
|
6525
|
+
*/
|
|
6526
|
+
cloneType?: string;
|
|
5697
6527
|
/**
|
|
5698
6528
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
5699
6529
|
* (example: "a daiton dog")
|
|
@@ -5705,6 +6535,18 @@ export declare namespace ModelTransferResponse {
|
|
|
5705
6535
|
* - For Flux: ""
|
|
5706
6536
|
*/
|
|
5707
6537
|
conceptPrompt?: string;
|
|
6538
|
+
/**
|
|
6539
|
+
* Gender of the voice (for professional cloning)
|
|
6540
|
+
*
|
|
6541
|
+
* Only available for ElevenLabs voice training
|
|
6542
|
+
*/
|
|
6543
|
+
gender?: string;
|
|
6544
|
+
/**
|
|
6545
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
6546
|
+
*
|
|
6547
|
+
* Only available for ElevenLabs voice training
|
|
6548
|
+
*/
|
|
6549
|
+
language?: string;
|
|
5708
6550
|
/**
|
|
5709
6551
|
* Initial learning rate (after the potential warmup period)
|
|
5710
6552
|
*
|
|
@@ -5819,14 +6661,25 @@ export declare namespace ModelTransferResponse {
|
|
|
5819
6661
|
/**
|
|
5820
6662
|
* The dimension of the LoRA update matrices
|
|
5821
6663
|
*
|
|
5822
|
-
* Only available for SDXL
|
|
6664
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
5823
6665
|
*
|
|
5824
6666
|
* Default value varies depending on the model type:
|
|
5825
6667
|
*
|
|
5826
|
-
* - For SDXL: 64
|
|
6668
|
+
* - For SDXL (deprecated): 64
|
|
5827
6669
|
* - For Flux: 16
|
|
6670
|
+
* - For Musubi: 64
|
|
6671
|
+
*
|
|
6672
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
6673
|
+
* 128])
|
|
5828
6674
|
*/
|
|
5829
6675
|
rank?: number;
|
|
6676
|
+
/**
|
|
6677
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
6678
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
6679
|
+
*
|
|
6680
|
+
* Only available for ElevenLabs voice training
|
|
6681
|
+
*/
|
|
6682
|
+
removeBackgroundNoise?: boolean;
|
|
5830
6683
|
/**
|
|
5831
6684
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
5832
6685
|
*/
|
|
@@ -5873,11 +6726,124 @@ export declare namespace ModelTransferResponse {
|
|
|
5873
6726
|
* Only available for SD15 and SDXL LoRA training
|
|
5874
6727
|
*/
|
|
5875
6728
|
validationPrompt?: string;
|
|
6729
|
+
/**
|
|
6730
|
+
* Description of the voice characteristics
|
|
6731
|
+
*
|
|
6732
|
+
* Only available for ElevenLabs voice training
|
|
6733
|
+
*/
|
|
6734
|
+
voiceDescription?: string;
|
|
5876
6735
|
/**
|
|
5877
6736
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
5878
6737
|
*/
|
|
5879
6738
|
wandbKey?: string;
|
|
5880
6739
|
}
|
|
6740
|
+
/**
|
|
6741
|
+
* Aggregated performance stats
|
|
6742
|
+
*/
|
|
6743
|
+
interface PerformanceStats {
|
|
6744
|
+
/**
|
|
6745
|
+
* Performance metrics per variant
|
|
6746
|
+
*/
|
|
6747
|
+
variants: Array<PerformanceStats.Variant>;
|
|
6748
|
+
/**
|
|
6749
|
+
* Default variant key for quick model comparison
|
|
6750
|
+
*/
|
|
6751
|
+
default?: string;
|
|
6752
|
+
}
|
|
6753
|
+
namespace PerformanceStats {
|
|
6754
|
+
/**
|
|
6755
|
+
* Performance stats for a model variant
|
|
6756
|
+
*/
|
|
6757
|
+
interface Variant {
|
|
6758
|
+
/**
|
|
6759
|
+
* The generation capability (example: "txt2img", "img2video", "txt2audio")
|
|
6760
|
+
*/
|
|
6761
|
+
capability: string;
|
|
6762
|
+
/**
|
|
6763
|
+
* When these stats were last computed (ISO date)
|
|
6764
|
+
*/
|
|
6765
|
+
computedAt: string;
|
|
6766
|
+
/**
|
|
6767
|
+
* Maximum cost per output asset (CU)
|
|
6768
|
+
*/
|
|
6769
|
+
costPerAssetMaxCU: number;
|
|
6770
|
+
/**
|
|
6771
|
+
* Minimum cost per output asset (CU)
|
|
6772
|
+
*/
|
|
6773
|
+
costPerAssetMinCU: number;
|
|
6774
|
+
/**
|
|
6775
|
+
* Median cost per output asset (CU)
|
|
6776
|
+
*/
|
|
6777
|
+
costPerAssetP50CU: number;
|
|
6778
|
+
/**
|
|
6779
|
+
* Inference latency P50 per output asset (seconds)
|
|
6780
|
+
*/
|
|
6781
|
+
inferenceLatencyP50Sec: number;
|
|
6782
|
+
/**
|
|
6783
|
+
* Inference latency P75 per output asset (seconds)
|
|
6784
|
+
*/
|
|
6785
|
+
inferenceLatencyP75Sec: number;
|
|
6786
|
+
/**
|
|
6787
|
+
* Total latency P50 per output asset, including queue time (seconds)
|
|
6788
|
+
*/
|
|
6789
|
+
totalLatencyP50Sec: number;
|
|
6790
|
+
/**
|
|
6791
|
+
* Total latency P75 per output asset, including queue time (seconds)
|
|
6792
|
+
*/
|
|
6793
|
+
totalLatencyP75Sec: number;
|
|
6794
|
+
/**
|
|
6795
|
+
* Unique variant identifier (example: "txt2img:1K", "img2video:2K", "txt2audio")
|
|
6796
|
+
*/
|
|
6797
|
+
variantKey: string;
|
|
6798
|
+
/**
|
|
6799
|
+
* External quality score from arena.ai leaderboard
|
|
6800
|
+
*/
|
|
6801
|
+
arenaScore?: Variant.ArenaScore;
|
|
6802
|
+
/**
|
|
6803
|
+
* The resolution bucket (example: "0.5K", "1K", "2K", "4K")
|
|
6804
|
+
*/
|
|
6805
|
+
resolution?: string;
|
|
6806
|
+
}
|
|
6807
|
+
namespace Variant {
|
|
6808
|
+
/**
|
|
6809
|
+
* External quality score from arena.ai leaderboard
|
|
6810
|
+
*/
|
|
6811
|
+
interface ArenaScore {
|
|
6812
|
+
/**
|
|
6813
|
+
* Arena category (example: "text_to_image", "image_to_video")
|
|
6814
|
+
*/
|
|
6815
|
+
arenaCategory: string;
|
|
6816
|
+
/**
|
|
6817
|
+
* Model name on arena.ai
|
|
6818
|
+
*/
|
|
6819
|
+
arenaModelName: string;
|
|
6820
|
+
/**
|
|
6821
|
+
* When this score was last fetched (ISO date)
|
|
6822
|
+
*/
|
|
6823
|
+
fetchedAt: string;
|
|
6824
|
+
/**
|
|
6825
|
+
* Rank in the arena category
|
|
6826
|
+
*/
|
|
6827
|
+
rank: number;
|
|
6828
|
+
/**
|
|
6829
|
+
* ELO rating
|
|
6830
|
+
*/
|
|
6831
|
+
rating: number;
|
|
6832
|
+
/**
|
|
6833
|
+
* ELO rating confidence interval lower bound
|
|
6834
|
+
*/
|
|
6835
|
+
ratingLower: number;
|
|
6836
|
+
/**
|
|
6837
|
+
* ELO rating confidence interval upper bound
|
|
6838
|
+
*/
|
|
6839
|
+
ratingUpper: number;
|
|
6840
|
+
/**
|
|
6841
|
+
* Number of human votes
|
|
6842
|
+
*/
|
|
6843
|
+
votes: number;
|
|
6844
|
+
}
|
|
6845
|
+
}
|
|
6846
|
+
}
|
|
5881
6847
|
/**
|
|
5882
6848
|
* A thumbnail for your model
|
|
5883
6849
|
*/
|
|
@@ -5940,7 +6906,7 @@ export declare namespace ModelTransferResponse {
|
|
|
5940
6906
|
/**
|
|
5941
6907
|
* The stage of the request
|
|
5942
6908
|
*/
|
|
5943
|
-
stage: 'pending' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
6909
|
+
stage: 'pending' | 'pending-captcha' | 'queued-for-train' | 'running-train' | 'starting-train';
|
|
5944
6910
|
/**
|
|
5945
6911
|
* Timestamp in milliseconds of the last time the training progress was updated
|
|
5946
6912
|
*/
|
|
@@ -6111,7 +7077,7 @@ export interface ModelCreateParams {
|
|
|
6111
7077
|
/**
|
|
6112
7078
|
* Query param: If set to true, returns the original asset without transformation
|
|
6113
7079
|
*/
|
|
6114
|
-
originalAssets?:
|
|
7080
|
+
originalAssets?: boolean;
|
|
6115
7081
|
/**
|
|
6116
7082
|
* Body param: The ID of the base model to use as a starting point for the training
|
|
6117
7083
|
* (example: "flux.1-dev")
|
|
@@ -6156,7 +7122,7 @@ export interface ModelCreateParams {
|
|
|
6156
7122
|
*
|
|
6157
7123
|
* The type can only be changed if the model has the "new" status.
|
|
6158
7124
|
*/
|
|
6159
|
-
type?: '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';
|
|
7125
|
+
type?: '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';
|
|
6160
7126
|
}
|
|
6161
7127
|
export declare namespace ModelCreateParams {
|
|
6162
7128
|
interface Concept {
|
|
@@ -6180,13 +7146,13 @@ export interface ModelRetrieveParams {
|
|
|
6180
7146
|
/**
|
|
6181
7147
|
* If set to true, returns the original asset without transformation
|
|
6182
7148
|
*/
|
|
6183
|
-
originalAssets?:
|
|
7149
|
+
originalAssets?: boolean;
|
|
6184
7150
|
}
|
|
6185
7151
|
export interface ModelUpdateParams {
|
|
6186
7152
|
/**
|
|
6187
7153
|
* Query param: If set to true, returns the original asset without transformation
|
|
6188
7154
|
*/
|
|
6189
|
-
originalAssets?:
|
|
7155
|
+
originalAssets?: boolean;
|
|
6190
7156
|
/**
|
|
6191
7157
|
* Body param: The slug of the class you want to use (ex:
|
|
6192
7158
|
* "characters-npcs-mobs-characters"). Set to null to unset the class
|
|
@@ -6248,7 +7214,7 @@ export interface ModelUpdateParams {
|
|
|
6248
7214
|
*
|
|
6249
7215
|
* The type can only be changed if the model has the "new" status.
|
|
6250
7216
|
*/
|
|
6251
|
-
type?: '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';
|
|
7217
|
+
type?: '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';
|
|
6252
7218
|
}
|
|
6253
7219
|
export declare namespace ModelUpdateParams {
|
|
6254
7220
|
interface Concept {
|
|
@@ -6271,6 +7237,12 @@ export declare namespace ModelUpdateParams {
|
|
|
6271
7237
|
* The parameters to use for the model's training
|
|
6272
7238
|
*/
|
|
6273
7239
|
interface Parameters {
|
|
7240
|
+
/**
|
|
7241
|
+
* Age group of the voice (for professional cloning)
|
|
7242
|
+
*
|
|
7243
|
+
* Only available for ElevenLabs voice training
|
|
7244
|
+
*/
|
|
7245
|
+
age?: string;
|
|
6274
7246
|
/**
|
|
6275
7247
|
* The batch size Less steps, and will increase the learning rate
|
|
6276
7248
|
*
|
|
@@ -6283,6 +7255,13 @@ export declare namespace ModelUpdateParams {
|
|
|
6283
7255
|
* Only available for SD15 training
|
|
6284
7256
|
*/
|
|
6285
7257
|
classPrompt?: string;
|
|
7258
|
+
/**
|
|
7259
|
+
* Type of voice cloning: "instant" (fast) or "professional" (higher quality,
|
|
7260
|
+
* requires captcha)
|
|
7261
|
+
*
|
|
7262
|
+
* Only available for ElevenLabs voice training
|
|
7263
|
+
*/
|
|
7264
|
+
cloneType?: string;
|
|
6286
7265
|
/**
|
|
6287
7266
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
6288
7267
|
* (example: "a daiton dog")
|
|
@@ -6294,6 +7273,18 @@ export declare namespace ModelUpdateParams {
|
|
|
6294
7273
|
* - For Flux: ""
|
|
6295
7274
|
*/
|
|
6296
7275
|
conceptPrompt?: string;
|
|
7276
|
+
/**
|
|
7277
|
+
* Gender of the voice (for professional cloning)
|
|
7278
|
+
*
|
|
7279
|
+
* Only available for ElevenLabs voice training
|
|
7280
|
+
*/
|
|
7281
|
+
gender?: string;
|
|
7282
|
+
/**
|
|
7283
|
+
* Language of the audio samples (ISO 639-1 code)
|
|
7284
|
+
*
|
|
7285
|
+
* Only available for ElevenLabs voice training
|
|
7286
|
+
*/
|
|
7287
|
+
language?: string;
|
|
6297
7288
|
/**
|
|
6298
7289
|
* Initial learning rate (after the potential warmup period)
|
|
6299
7290
|
*
|
|
@@ -6408,14 +7399,25 @@ export declare namespace ModelUpdateParams {
|
|
|
6408
7399
|
/**
|
|
6409
7400
|
* The dimension of the LoRA update matrices
|
|
6410
7401
|
*
|
|
6411
|
-
* Only available for SDXL
|
|
7402
|
+
* Only available for SDXL (deprecated), Flux LoRA and Musubi training
|
|
6412
7403
|
*
|
|
6413
7404
|
* Default value varies depending on the model type:
|
|
6414
7405
|
*
|
|
6415
|
-
* - For SDXL: 64
|
|
7406
|
+
* - For SDXL (deprecated): 64
|
|
6416
7407
|
* - For Flux: 16
|
|
7408
|
+
* - For Musubi: 64
|
|
7409
|
+
*
|
|
7410
|
+
* Each trainer enforces its own tighter limit (Flux LoRA: [2; 64], Musubi: [2;
|
|
7411
|
+
* 128])
|
|
6417
7412
|
*/
|
|
6418
7413
|
rank?: number;
|
|
7414
|
+
/**
|
|
7415
|
+
* Whether to remove background noise from audio samples before cloning. When
|
|
7416
|
+
* enabled, each sample must be at least 5 seconds long.
|
|
7417
|
+
*
|
|
7418
|
+
* Only available for ElevenLabs voice training
|
|
7419
|
+
*/
|
|
7420
|
+
removeBackgroundNoise?: boolean;
|
|
6419
7421
|
/**
|
|
6420
7422
|
* The prompts to use for each epoch Only available for Flux LoRA training
|
|
6421
7423
|
*/
|
|
@@ -6462,6 +7464,12 @@ export declare namespace ModelUpdateParams {
|
|
|
6462
7464
|
* Only available for SD15 and SDXL LoRA training
|
|
6463
7465
|
*/
|
|
6464
7466
|
validationPrompt?: string;
|
|
7467
|
+
/**
|
|
7468
|
+
* Description of the voice characteristics
|
|
7469
|
+
*
|
|
7470
|
+
* Only available for ElevenLabs voice training
|
|
7471
|
+
*/
|
|
7472
|
+
voiceDescription?: string;
|
|
6465
7473
|
/**
|
|
6466
7474
|
* The Weights And Bias key to use for logging. The maximum length is 40 characters
|
|
6467
7475
|
*/
|
|
@@ -6470,10 +7478,10 @@ export declare namespace ModelUpdateParams {
|
|
|
6470
7478
|
}
|
|
6471
7479
|
export interface ModelListParams {
|
|
6472
7480
|
/**
|
|
6473
|
-
* If set to true, returns the list of models blacklisted
|
|
6474
|
-
* available for team admins)
|
|
7481
|
+
* If set to true, returns the full list of models (including blacklisted models)
|
|
7482
|
+
* (only available for team admins)
|
|
6475
7483
|
*/
|
|
6476
|
-
blacklisted?:
|
|
7484
|
+
blacklisted?: boolean;
|
|
6477
7485
|
/**
|
|
6478
7486
|
* When provided, only the models in the Collection will be returned. Only
|
|
6479
7487
|
* available when privacy=private/unlisted (note: this is different from
|
|
@@ -6499,16 +7507,16 @@ export interface ModelListParams {
|
|
|
6499
7507
|
/**
|
|
6500
7508
|
* If set to true, returns the list of models currently loaded on GPU
|
|
6501
7509
|
*/
|
|
6502
|
-
loadedOnly?:
|
|
7510
|
+
loadedOnly?: boolean;
|
|
6503
7511
|
/**
|
|
6504
7512
|
* If set to true, returns the original asset without transformation
|
|
6505
7513
|
*/
|
|
6506
|
-
originalAssets?:
|
|
7514
|
+
originalAssets?: boolean;
|
|
6507
7515
|
/**
|
|
6508
7516
|
* The number of items to return in the response. The default value is 100, maximum
|
|
6509
7517
|
* value is 500, minimum value is 1
|
|
6510
7518
|
*/
|
|
6511
|
-
pageSize?:
|
|
7519
|
+
pageSize?: number;
|
|
6512
7520
|
/**
|
|
6513
7521
|
* A token you received in a previous request to query the next page of items
|
|
6514
7522
|
*/
|
|
@@ -6517,25 +7525,25 @@ export interface ModelListParams {
|
|
|
6517
7525
|
* The privacy of the models to return. The default value is `private`, possible
|
|
6518
7526
|
* values are `private` and `public`
|
|
6519
7527
|
*/
|
|
6520
|
-
privacy?:
|
|
7528
|
+
privacy?: 'private' | 'public';
|
|
6521
7529
|
/**
|
|
6522
7530
|
* Sort results by createdAt, updatedAt, or score. When privacy=public, defaults to
|
|
6523
7531
|
* score if not specified. When privacy=private/unlisted, supports createdAt and
|
|
6524
7532
|
* score (default: createdAt). When sortBy=score for privacy=private/unlisted, both
|
|
6525
7533
|
* privacy and status query parameters are required.
|
|
6526
7534
|
*/
|
|
6527
|
-
sortBy?:
|
|
7535
|
+
sortBy?: 'createdAt' | 'updatedAt' | 'score';
|
|
6528
7536
|
/**
|
|
6529
7537
|
* Sort results in ascending (asc) or descending (desc) order. Only used when
|
|
6530
7538
|
* sortBy is specified. Available for both privacy=public and
|
|
6531
7539
|
* privacy=private/unlisted. For public models, this parameter is ignored when
|
|
6532
7540
|
* sortBy is not specified or set to score.
|
|
6533
7541
|
*/
|
|
6534
|
-
sortDirection?:
|
|
7542
|
+
sortDirection?: 'asc' | 'desc';
|
|
6535
7543
|
/**
|
|
6536
7544
|
* The status of the models to return. Only available when privacy=private/unlisted
|
|
6537
7545
|
*/
|
|
6538
|
-
status?:
|
|
7546
|
+
status?: 'new' | 'training' | 'trained' | 'failed' | 'deleted';
|
|
6539
7547
|
/**
|
|
6540
7548
|
* List of tags, comma separated. Only available when privacy=public
|
|
6541
7549
|
*/
|
|
@@ -6545,15 +7553,29 @@ export interface ModelListParams {
|
|
|
6545
7553
|
* sd-1_5, sd-1_5-lora, sd-1_5-composition, sd-xl, sd-xl-lora, sd-xl-composition,
|
|
6546
7554
|
* flux.1, flux.1-lora, flux.1-kontext-dev, flux.1-krea-dev, flux.1-kontext-lora,
|
|
6547
7555
|
* flux.1-krea-lora, flux.1-composition, flux.1-pro, flux1.1-pro,
|
|
6548
|
-
* flux.1.1-pro-ultra,
|
|
7556
|
+
* flux.1.1-pro-ultra, flux.2-dev-lora, flux.2-dev-edit-lora, flux.2-klein-4b-lora,
|
|
7557
|
+
* flux.2-klein-9b-lora, flux.2-klein-base-4b-lora, flux.2-klein-base-9b-lora,
|
|
7558
|
+
* flux.2-klein-4b-edit-lora, flux.2-klein-9b-edit-lora,
|
|
7559
|
+
* flux.2-klein-base-4b-edit-lora, flux.2-klein-base-9b-edit-lora, gpt-image-1,
|
|
7560
|
+
* qwen-image-lora, qwen-image-2512-lora, qwen-image-edit-lora,
|
|
7561
|
+
* qwen-image-edit-2509-lora, qwen-image-edit-2511-lora, zimage-lora,
|
|
7562
|
+
* zimage-turbo-lora, zimage-de-turbo-lora, custom, elevenlabs-voice. Only
|
|
7563
|
+
* available when privacy=public
|
|
6549
7564
|
*/
|
|
6550
|
-
type?:
|
|
7565
|
+
type?: 'sd-1_5' | 'sd-1_5-lora' | 'sd-1_5-composition' | 'sd-xl' | 'sd-xl-lora' | 'sd-xl-composition' | 'flux.1' | 'flux.1-lora' | 'flux.1-kontext-dev' | 'flux.1-krea-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-lora' | 'flux.1-composition' | 'flux.1-pro' | 'flux1.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-lora' | 'flux.2-dev-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-9b-edit-lora' | 'gpt-image-1' | 'qwen-image-lora' | 'qwen-image-2512-lora' | 'qwen-image-edit-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'zimage-lora' | 'zimage-turbo-lora' | 'zimage-de-turbo-lora' | 'custom' | 'elevenlabs-voice';
|
|
6551
7566
|
/**
|
|
6552
7567
|
* List of types, comma separated. Can be any of the following values: sd-1_5,
|
|
6553
7568
|
* sd-1_5-lora, sd-1_5-composition, sd-xl, sd-xl-lora, sd-xl-composition, flux.1,
|
|
6554
7569
|
* flux.1-lora, flux.1-kontext-dev, flux.1-krea-dev, flux.1-kontext-lora,
|
|
6555
7570
|
* flux.1-krea-lora, flux.1-composition, flux.1-pro, flux1.1-pro,
|
|
6556
|
-
* flux.1.1-pro-ultra,
|
|
7571
|
+
* flux.1.1-pro-ultra, flux.2-dev-lora, flux.2-dev-edit-lora, flux.2-klein-4b-lora,
|
|
7572
|
+
* flux.2-klein-9b-lora, flux.2-klein-base-4b-lora, flux.2-klein-base-9b-lora,
|
|
7573
|
+
* flux.2-klein-4b-edit-lora, flux.2-klein-9b-edit-lora,
|
|
7574
|
+
* flux.2-klein-base-4b-edit-lora, flux.2-klein-base-9b-edit-lora, gpt-image-1,
|
|
7575
|
+
* qwen-image-lora, qwen-image-2512-lora, qwen-image-edit-lora,
|
|
7576
|
+
* qwen-image-edit-2509-lora, qwen-image-edit-2511-lora, zimage-lora,
|
|
7577
|
+
* zimage-turbo-lora, zimage-de-turbo-lora, custom, elevenlabs-voice. Only
|
|
7578
|
+
* available when privacy=public
|
|
6557
7579
|
*/
|
|
6558
7580
|
types?: string;
|
|
6559
7581
|
/**
|
|
@@ -6573,7 +7595,7 @@ export interface ModelCopyParams {
|
|
|
6573
7595
|
/**
|
|
6574
7596
|
* Query param: If set to true, returns the original asset without transformation
|
|
6575
7597
|
*/
|
|
6576
|
-
originalAssets?:
|
|
7598
|
+
originalAssets?: boolean;
|
|
6577
7599
|
/**
|
|
6578
7600
|
* Body param: If set to true, the training data will be copied
|
|
6579
7601
|
*/
|
|
@@ -6587,7 +7609,7 @@ export interface ModelDeleteImagesParams {
|
|
|
6587
7609
|
/**
|
|
6588
7610
|
* The asset ids of the images to delete
|
|
6589
7611
|
*/
|
|
6590
|
-
ids: string
|
|
7612
|
+
ids: Array<string>;
|
|
6591
7613
|
}
|
|
6592
7614
|
export interface ModelDownloadParams {
|
|
6593
7615
|
/**
|
|
@@ -6601,7 +7623,7 @@ export interface ModelGetBulkParams {
|
|
|
6601
7623
|
/**
|
|
6602
7624
|
* Query param: If set to true, returns the original asset without transformation
|
|
6603
7625
|
*/
|
|
6604
|
-
originalAssets?:
|
|
7626
|
+
originalAssets?: boolean;
|
|
6605
7627
|
/**
|
|
6606
7628
|
* Body param: If true will return all training images; otherwise returns only the
|
|
6607
7629
|
* first 3 training images.
|