@scenario-labs/sdk 2.4.0 → 2.5.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 +28 -0
- package/client.d.mts +1 -1
- package/client.d.mts.map +1 -1
- package/client.d.ts +1 -1
- package/client.d.ts.map +1 -1
- package/lib/workflow_converter.d.mts +3 -0
- package/lib/workflow_converter.d.mts.map +1 -1
- package/lib/workflow_converter.d.ts +3 -0
- package/lib/workflow_converter.d.ts.map +1 -1
- package/lib/workflow_converter.js +62 -34
- package/lib/workflow_converter.js.map +1 -1
- package/lib/workflow_converter.mjs +62 -34
- package/lib/workflow_converter.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/assets/assets.d.mts +269 -31
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +269 -31
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/generate.d.mts +157 -51
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +157 -51
- package/resources/generate.d.ts.map +1 -1
- package/resources/generate.js +1 -5
- package/resources/generate.js.map +1 -1
- package/resources/generate.mjs +1 -5
- package/resources/generate.mjs.map +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/jobs.d.mts +30 -12
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +30 -12
- package/resources/jobs.d.ts.map +1 -1
- package/resources/models/description.d.mts +62 -4
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +62 -4
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +94 -64
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +94 -64
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/models.d.mts +239 -295
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +239 -295
- 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 +92 -110
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +92 -110
- package/resources/models/train.d.ts.map +1 -1
- package/resources/search.d.mts +2 -2
- package/resources/search.d.ts +2 -2
- package/resources/uploads.d.mts +2 -3
- package/resources/uploads.d.mts.map +1 -1
- package/resources/uploads.d.ts +2 -3
- package/resources/uploads.d.ts.map +1 -1
- package/resources/usages.d.mts +44 -15
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +44 -15
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +63 -45
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +63 -45
- package/resources/workflows.d.ts.map +1 -1
- package/resources/workflows.js +4 -4
- package/resources/workflows.js.map +1 -1
- package/resources/workflows.mjs +4 -4
- package/resources/workflows.mjs.map +1 -1
- package/src/client.ts +1 -1
- package/src/lib/workflow_converter.ts +91 -35
- package/src/resources/assets/assets.ts +300 -62
- package/src/resources/generate.ts +157 -129
- package/src/resources/index.ts +1 -1
- package/src/resources/jobs.ts +27 -37
- package/src/resources/models/description.ts +70 -12
- package/src/resources/models/examples.ts +100 -88
- package/src/resources/models/models.ts +228 -385
- package/src/resources/models/train.ts +89 -139
- package/src/resources/search.ts +2 -2
- package/src/resources/uploads.ts +2 -3
- package/src/resources/usages.ts +47 -20
- package/src/resources/workflows.ts +48 -157
- 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
|
@@ -121,7 +121,7 @@ export declare namespace ModelCreateResponse {
|
|
|
121
121
|
/**
|
|
122
122
|
* The model type (example: "flux.1-lora")
|
|
123
123
|
*/
|
|
124
|
-
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' | '
|
|
124
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
125
125
|
/**
|
|
126
126
|
* The model last update date as an ISO string (example:
|
|
127
127
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -149,6 +149,12 @@ export declare namespace ModelCreateResponse {
|
|
|
149
149
|
* The concepts is required for the type model: composition
|
|
150
150
|
*/
|
|
151
151
|
concepts?: Array<Model.Concept>;
|
|
152
|
+
/**
|
|
153
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
154
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
155
|
+
* refunded as usual.
|
|
156
|
+
*/
|
|
157
|
+
disableRefund?: boolean;
|
|
152
158
|
/**
|
|
153
159
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
154
160
|
* uses the final model epoch (latest)
|
|
@@ -249,7 +255,7 @@ export declare namespace ModelCreateResponse {
|
|
|
249
255
|
*/
|
|
250
256
|
conceptPrompt: string;
|
|
251
257
|
/**
|
|
252
|
-
* The model ID of the class
|
|
258
|
+
* The model ID of the class. Only available for legacy models.
|
|
253
259
|
*/
|
|
254
260
|
modelId: string;
|
|
255
261
|
/**
|
|
@@ -422,7 +428,7 @@ export declare namespace ModelCreateResponse {
|
|
|
422
428
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
423
429
|
* available for \`model_array\` input type.
|
|
424
430
|
*/
|
|
425
|
-
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' | '
|
|
431
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
426
432
|
/**
|
|
427
433
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
428
434
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -522,7 +528,7 @@ export declare namespace ModelCreateResponse {
|
|
|
522
528
|
/**
|
|
523
529
|
* The prompt to specify images in the same class as provided instance images
|
|
524
530
|
*
|
|
525
|
-
*
|
|
531
|
+
* Deprecated legacy training parameter.
|
|
526
532
|
*/
|
|
527
533
|
classPrompt?: string;
|
|
528
534
|
/**
|
|
@@ -536,11 +542,8 @@ export declare namespace ModelCreateResponse {
|
|
|
536
542
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
537
543
|
* (example: "a daiton dog")
|
|
538
544
|
*
|
|
539
|
-
* Default value varies depending on the model type
|
|
540
|
-
*
|
|
541
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
542
|
-
* - For SDXL: "daiton"
|
|
543
|
-
* - For Flux: ""
|
|
545
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
546
|
+
* an empty string.
|
|
544
547
|
*/
|
|
545
548
|
conceptPrompt?: string;
|
|
546
549
|
/**
|
|
@@ -558,47 +561,39 @@ export declare namespace ModelCreateResponse {
|
|
|
558
561
|
/**
|
|
559
562
|
* Initial learning rate (after the potential warmup period)
|
|
560
563
|
*
|
|
561
|
-
* Default value varies depending on the model type
|
|
562
|
-
*
|
|
563
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
564
|
-
* - For Flux: 0.0001
|
|
564
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
565
|
+
* 0.0001.
|
|
565
566
|
*/
|
|
566
567
|
learningRate?: number;
|
|
567
568
|
/**
|
|
568
569
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
569
570
|
*
|
|
570
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
571
|
-
*
|
|
571
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
572
|
+
* 0.000001]
|
|
572
573
|
*/
|
|
573
574
|
learningRateTextEncoder?: number;
|
|
574
575
|
/**
|
|
575
576
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
576
577
|
*
|
|
577
|
-
*
|
|
578
|
+
* Deprecated legacy training parameter.
|
|
578
579
|
*/
|
|
579
580
|
learningRateUnet?: number;
|
|
580
581
|
/**
|
|
581
582
|
* The scheduler type to use (default: "constant")
|
|
582
583
|
*
|
|
583
|
-
*
|
|
584
|
+
* Deprecated legacy training parameter.
|
|
584
585
|
*/
|
|
585
586
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
586
587
|
/**
|
|
587
588
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
588
589
|
* model type)
|
|
589
590
|
*
|
|
590
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
591
|
-
* instead
|
|
592
|
-
*
|
|
593
591
|
* Default value varies depending on the model type:
|
|
594
592
|
*
|
|
595
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
596
|
-
* - For SDXL: number of training images \* 175
|
|
597
593
|
* - For Flux: number of training images \* 100
|
|
598
594
|
*
|
|
599
595
|
* Maximum value varies depending on the model type:
|
|
600
596
|
*
|
|
601
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
602
597
|
* - For Flux: [0, 10000]
|
|
603
598
|
*/
|
|
604
599
|
maxTrainSteps?: number;
|
|
@@ -617,13 +612,13 @@ export declare namespace ModelCreateResponse {
|
|
|
617
612
|
/**
|
|
618
613
|
* The number of training steps for the text encoder
|
|
619
614
|
*
|
|
620
|
-
*
|
|
615
|
+
* Deprecated legacy training parameter.
|
|
621
616
|
*/
|
|
622
617
|
numTextTrainSteps?: number;
|
|
623
618
|
/**
|
|
624
619
|
* The number of training steps for the UNet
|
|
625
620
|
*
|
|
626
|
-
*
|
|
621
|
+
* Deprecated legacy training parameter.
|
|
627
622
|
*/
|
|
628
623
|
numUNetTrainSteps?: number;
|
|
629
624
|
/**
|
|
@@ -644,36 +639,35 @@ export declare namespace ModelCreateResponse {
|
|
|
644
639
|
/**
|
|
645
640
|
* The weight of prior preservation loss
|
|
646
641
|
*
|
|
647
|
-
*
|
|
642
|
+
* Deprecated legacy training parameter.
|
|
648
643
|
*/
|
|
649
644
|
priorLossWeight?: number;
|
|
650
645
|
/**
|
|
651
646
|
* Whether to random crop or center crop images before resizing to the working
|
|
652
647
|
* resolution
|
|
653
648
|
*
|
|
654
|
-
*
|
|
649
|
+
* Deprecated legacy training parameter.
|
|
655
650
|
*/
|
|
656
651
|
randomCrop?: boolean;
|
|
657
652
|
/**
|
|
658
653
|
* Ratio of random crops
|
|
659
654
|
*
|
|
660
|
-
*
|
|
655
|
+
* Deprecated legacy training parameter.
|
|
661
656
|
*/
|
|
662
657
|
randomCropRatio?: number;
|
|
663
658
|
/**
|
|
664
659
|
* Scale of random crops
|
|
665
660
|
*
|
|
666
|
-
*
|
|
661
|
+
* Deprecated legacy training parameter.
|
|
667
662
|
*/
|
|
668
663
|
randomCropScale?: number;
|
|
669
664
|
/**
|
|
670
665
|
* The dimension of the LoRA update matrices
|
|
671
666
|
*
|
|
672
|
-
* Only available for
|
|
667
|
+
* Only available for Flux LoRA and Musubi training
|
|
673
668
|
*
|
|
674
669
|
* Default value varies depending on the model type:
|
|
675
670
|
*
|
|
676
|
-
* - For SDXL (deprecated): 64
|
|
677
671
|
* - For Flux: 16
|
|
678
672
|
* - For Musubi: 64
|
|
679
673
|
*
|
|
@@ -702,13 +696,13 @@ export declare namespace ModelCreateResponse {
|
|
|
702
696
|
*
|
|
703
697
|
* Note: Legacy parameter, will be ignored
|
|
704
698
|
*
|
|
705
|
-
*
|
|
699
|
+
* Deprecated legacy training parameter.
|
|
706
700
|
*/
|
|
707
701
|
scaleLr?: boolean;
|
|
708
702
|
/**
|
|
709
703
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
710
704
|
*
|
|
711
|
-
*
|
|
705
|
+
* Deprecated legacy training parameter.
|
|
712
706
|
*/
|
|
713
707
|
seed?: number;
|
|
714
708
|
/**
|
|
@@ -719,19 +713,19 @@ export declare namespace ModelCreateResponse {
|
|
|
719
713
|
*
|
|
720
714
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
721
715
|
*
|
|
722
|
-
*
|
|
716
|
+
* Deprecated legacy training parameter.
|
|
723
717
|
*/
|
|
724
718
|
textEncoderTrainingRatio?: number;
|
|
725
719
|
/**
|
|
726
720
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
727
721
|
*
|
|
728
|
-
*
|
|
722
|
+
* Deprecated legacy training parameter.
|
|
729
723
|
*/
|
|
730
724
|
validationFrequency?: number;
|
|
731
725
|
/**
|
|
732
726
|
* Validation prompt
|
|
733
727
|
*
|
|
734
|
-
*
|
|
728
|
+
* Deprecated legacy training parameter.
|
|
735
729
|
*/
|
|
736
730
|
validationPrompt?: string;
|
|
737
731
|
/**
|
|
@@ -1142,7 +1136,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1142
1136
|
/**
|
|
1143
1137
|
* The model type (example: "flux.1-lora")
|
|
1144
1138
|
*/
|
|
1145
|
-
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' | '
|
|
1139
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
1146
1140
|
/**
|
|
1147
1141
|
* The model last update date as an ISO string (example:
|
|
1148
1142
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -1170,6 +1164,12 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1170
1164
|
* The concepts is required for the type model: composition
|
|
1171
1165
|
*/
|
|
1172
1166
|
concepts?: Array<Model.Concept>;
|
|
1167
|
+
/**
|
|
1168
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
1169
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
1170
|
+
* refunded as usual.
|
|
1171
|
+
*/
|
|
1172
|
+
disableRefund?: boolean;
|
|
1173
1173
|
/**
|
|
1174
1174
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
1175
1175
|
* uses the final model epoch (latest)
|
|
@@ -1270,7 +1270,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1270
1270
|
*/
|
|
1271
1271
|
conceptPrompt: string;
|
|
1272
1272
|
/**
|
|
1273
|
-
* The model ID of the class
|
|
1273
|
+
* The model ID of the class. Only available for legacy models.
|
|
1274
1274
|
*/
|
|
1275
1275
|
modelId: string;
|
|
1276
1276
|
/**
|
|
@@ -1443,7 +1443,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1443
1443
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
1444
1444
|
* available for \`model_array\` input type.
|
|
1445
1445
|
*/
|
|
1446
|
-
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' | '
|
|
1446
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
1447
1447
|
/**
|
|
1448
1448
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
1449
1449
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -1543,7 +1543,7 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1543
1543
|
/**
|
|
1544
1544
|
* The prompt to specify images in the same class as provided instance images
|
|
1545
1545
|
*
|
|
1546
|
-
*
|
|
1546
|
+
* Deprecated legacy training parameter.
|
|
1547
1547
|
*/
|
|
1548
1548
|
classPrompt?: string;
|
|
1549
1549
|
/**
|
|
@@ -1557,11 +1557,8 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1557
1557
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
1558
1558
|
* (example: "a daiton dog")
|
|
1559
1559
|
*
|
|
1560
|
-
* Default value varies depending on the model type
|
|
1561
|
-
*
|
|
1562
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
1563
|
-
* - For SDXL: "daiton"
|
|
1564
|
-
* - For Flux: ""
|
|
1560
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
1561
|
+
* an empty string.
|
|
1565
1562
|
*/
|
|
1566
1563
|
conceptPrompt?: string;
|
|
1567
1564
|
/**
|
|
@@ -1579,47 +1576,39 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1579
1576
|
/**
|
|
1580
1577
|
* Initial learning rate (after the potential warmup period)
|
|
1581
1578
|
*
|
|
1582
|
-
* Default value varies depending on the model type
|
|
1583
|
-
*
|
|
1584
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
1585
|
-
* - For Flux: 0.0001
|
|
1579
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
1580
|
+
* 0.0001.
|
|
1586
1581
|
*/
|
|
1587
1582
|
learningRate?: number;
|
|
1588
1583
|
/**
|
|
1589
1584
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
1590
1585
|
*
|
|
1591
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
1592
|
-
*
|
|
1586
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
1587
|
+
* 0.000001]
|
|
1593
1588
|
*/
|
|
1594
1589
|
learningRateTextEncoder?: number;
|
|
1595
1590
|
/**
|
|
1596
1591
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
1597
1592
|
*
|
|
1598
|
-
*
|
|
1593
|
+
* Deprecated legacy training parameter.
|
|
1599
1594
|
*/
|
|
1600
1595
|
learningRateUnet?: number;
|
|
1601
1596
|
/**
|
|
1602
1597
|
* The scheduler type to use (default: "constant")
|
|
1603
1598
|
*
|
|
1604
|
-
*
|
|
1599
|
+
* Deprecated legacy training parameter.
|
|
1605
1600
|
*/
|
|
1606
1601
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
1607
1602
|
/**
|
|
1608
1603
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
1609
1604
|
* model type)
|
|
1610
1605
|
*
|
|
1611
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
1612
|
-
* instead
|
|
1613
|
-
*
|
|
1614
1606
|
* Default value varies depending on the model type:
|
|
1615
1607
|
*
|
|
1616
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
1617
|
-
* - For SDXL: number of training images \* 175
|
|
1618
1608
|
* - For Flux: number of training images \* 100
|
|
1619
1609
|
*
|
|
1620
1610
|
* Maximum value varies depending on the model type:
|
|
1621
1611
|
*
|
|
1622
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
1623
1612
|
* - For Flux: [0, 10000]
|
|
1624
1613
|
*/
|
|
1625
1614
|
maxTrainSteps?: number;
|
|
@@ -1638,13 +1627,13 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1638
1627
|
/**
|
|
1639
1628
|
* The number of training steps for the text encoder
|
|
1640
1629
|
*
|
|
1641
|
-
*
|
|
1630
|
+
* Deprecated legacy training parameter.
|
|
1642
1631
|
*/
|
|
1643
1632
|
numTextTrainSteps?: number;
|
|
1644
1633
|
/**
|
|
1645
1634
|
* The number of training steps for the UNet
|
|
1646
1635
|
*
|
|
1647
|
-
*
|
|
1636
|
+
* Deprecated legacy training parameter.
|
|
1648
1637
|
*/
|
|
1649
1638
|
numUNetTrainSteps?: number;
|
|
1650
1639
|
/**
|
|
@@ -1665,36 +1654,35 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1665
1654
|
/**
|
|
1666
1655
|
* The weight of prior preservation loss
|
|
1667
1656
|
*
|
|
1668
|
-
*
|
|
1657
|
+
* Deprecated legacy training parameter.
|
|
1669
1658
|
*/
|
|
1670
1659
|
priorLossWeight?: number;
|
|
1671
1660
|
/**
|
|
1672
1661
|
* Whether to random crop or center crop images before resizing to the working
|
|
1673
1662
|
* resolution
|
|
1674
1663
|
*
|
|
1675
|
-
*
|
|
1664
|
+
* Deprecated legacy training parameter.
|
|
1676
1665
|
*/
|
|
1677
1666
|
randomCrop?: boolean;
|
|
1678
1667
|
/**
|
|
1679
1668
|
* Ratio of random crops
|
|
1680
1669
|
*
|
|
1681
|
-
*
|
|
1670
|
+
* Deprecated legacy training parameter.
|
|
1682
1671
|
*/
|
|
1683
1672
|
randomCropRatio?: number;
|
|
1684
1673
|
/**
|
|
1685
1674
|
* Scale of random crops
|
|
1686
1675
|
*
|
|
1687
|
-
*
|
|
1676
|
+
* Deprecated legacy training parameter.
|
|
1688
1677
|
*/
|
|
1689
1678
|
randomCropScale?: number;
|
|
1690
1679
|
/**
|
|
1691
1680
|
* The dimension of the LoRA update matrices
|
|
1692
1681
|
*
|
|
1693
|
-
* Only available for
|
|
1682
|
+
* Only available for Flux LoRA and Musubi training
|
|
1694
1683
|
*
|
|
1695
1684
|
* Default value varies depending on the model type:
|
|
1696
1685
|
*
|
|
1697
|
-
* - For SDXL (deprecated): 64
|
|
1698
1686
|
* - For Flux: 16
|
|
1699
1687
|
* - For Musubi: 64
|
|
1700
1688
|
*
|
|
@@ -1723,13 +1711,13 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1723
1711
|
*
|
|
1724
1712
|
* Note: Legacy parameter, will be ignored
|
|
1725
1713
|
*
|
|
1726
|
-
*
|
|
1714
|
+
* Deprecated legacy training parameter.
|
|
1727
1715
|
*/
|
|
1728
1716
|
scaleLr?: boolean;
|
|
1729
1717
|
/**
|
|
1730
1718
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
1731
1719
|
*
|
|
1732
|
-
*
|
|
1720
|
+
* Deprecated legacy training parameter.
|
|
1733
1721
|
*/
|
|
1734
1722
|
seed?: number;
|
|
1735
1723
|
/**
|
|
@@ -1740,19 +1728,19 @@ export declare namespace ModelRetrieveResponse {
|
|
|
1740
1728
|
*
|
|
1741
1729
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
1742
1730
|
*
|
|
1743
|
-
*
|
|
1731
|
+
* Deprecated legacy training parameter.
|
|
1744
1732
|
*/
|
|
1745
1733
|
textEncoderTrainingRatio?: number;
|
|
1746
1734
|
/**
|
|
1747
1735
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
1748
1736
|
*
|
|
1749
|
-
*
|
|
1737
|
+
* Deprecated legacy training parameter.
|
|
1750
1738
|
*/
|
|
1751
1739
|
validationFrequency?: number;
|
|
1752
1740
|
/**
|
|
1753
1741
|
* Validation prompt
|
|
1754
1742
|
*
|
|
1755
|
-
*
|
|
1743
|
+
* Deprecated legacy training parameter.
|
|
1756
1744
|
*/
|
|
1757
1745
|
validationPrompt?: string;
|
|
1758
1746
|
/**
|
|
@@ -2163,7 +2151,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2163
2151
|
/**
|
|
2164
2152
|
* The model type (example: "flux.1-lora")
|
|
2165
2153
|
*/
|
|
2166
|
-
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' | '
|
|
2154
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
2167
2155
|
/**
|
|
2168
2156
|
* The model last update date as an ISO string (example:
|
|
2169
2157
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -2191,6 +2179,12 @@ export declare namespace ModelUpdateResponse {
|
|
|
2191
2179
|
* The concepts is required for the type model: composition
|
|
2192
2180
|
*/
|
|
2193
2181
|
concepts?: Array<Model.Concept>;
|
|
2182
|
+
/**
|
|
2183
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
2184
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
2185
|
+
* refunded as usual.
|
|
2186
|
+
*/
|
|
2187
|
+
disableRefund?: boolean;
|
|
2194
2188
|
/**
|
|
2195
2189
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
2196
2190
|
* uses the final model epoch (latest)
|
|
@@ -2291,7 +2285,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2291
2285
|
*/
|
|
2292
2286
|
conceptPrompt: string;
|
|
2293
2287
|
/**
|
|
2294
|
-
* The model ID of the class
|
|
2288
|
+
* The model ID of the class. Only available for legacy models.
|
|
2295
2289
|
*/
|
|
2296
2290
|
modelId: string;
|
|
2297
2291
|
/**
|
|
@@ -2464,7 +2458,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2464
2458
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
2465
2459
|
* available for \`model_array\` input type.
|
|
2466
2460
|
*/
|
|
2467
|
-
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' | '
|
|
2461
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
2468
2462
|
/**
|
|
2469
2463
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
2470
2464
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -2564,7 +2558,7 @@ export declare namespace ModelUpdateResponse {
|
|
|
2564
2558
|
/**
|
|
2565
2559
|
* The prompt to specify images in the same class as provided instance images
|
|
2566
2560
|
*
|
|
2567
|
-
*
|
|
2561
|
+
* Deprecated legacy training parameter.
|
|
2568
2562
|
*/
|
|
2569
2563
|
classPrompt?: string;
|
|
2570
2564
|
/**
|
|
@@ -2578,11 +2572,8 @@ export declare namespace ModelUpdateResponse {
|
|
|
2578
2572
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
2579
2573
|
* (example: "a daiton dog")
|
|
2580
2574
|
*
|
|
2581
|
-
* Default value varies depending on the model type
|
|
2582
|
-
*
|
|
2583
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
2584
|
-
* - For SDXL: "daiton"
|
|
2585
|
-
* - For Flux: ""
|
|
2575
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
2576
|
+
* an empty string.
|
|
2586
2577
|
*/
|
|
2587
2578
|
conceptPrompt?: string;
|
|
2588
2579
|
/**
|
|
@@ -2600,47 +2591,39 @@ export declare namespace ModelUpdateResponse {
|
|
|
2600
2591
|
/**
|
|
2601
2592
|
* Initial learning rate (after the potential warmup period)
|
|
2602
2593
|
*
|
|
2603
|
-
* Default value varies depending on the model type
|
|
2604
|
-
*
|
|
2605
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
2606
|
-
* - For Flux: 0.0001
|
|
2594
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
2595
|
+
* 0.0001.
|
|
2607
2596
|
*/
|
|
2608
2597
|
learningRate?: number;
|
|
2609
2598
|
/**
|
|
2610
2599
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
2611
2600
|
*
|
|
2612
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
2613
|
-
*
|
|
2601
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
2602
|
+
* 0.000001]
|
|
2614
2603
|
*/
|
|
2615
2604
|
learningRateTextEncoder?: number;
|
|
2616
2605
|
/**
|
|
2617
2606
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
2618
2607
|
*
|
|
2619
|
-
*
|
|
2608
|
+
* Deprecated legacy training parameter.
|
|
2620
2609
|
*/
|
|
2621
2610
|
learningRateUnet?: number;
|
|
2622
2611
|
/**
|
|
2623
2612
|
* The scheduler type to use (default: "constant")
|
|
2624
2613
|
*
|
|
2625
|
-
*
|
|
2614
|
+
* Deprecated legacy training parameter.
|
|
2626
2615
|
*/
|
|
2627
2616
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
2628
2617
|
/**
|
|
2629
2618
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
2630
2619
|
* model type)
|
|
2631
2620
|
*
|
|
2632
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
2633
|
-
* instead
|
|
2634
|
-
*
|
|
2635
2621
|
* Default value varies depending on the model type:
|
|
2636
2622
|
*
|
|
2637
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
2638
|
-
* - For SDXL: number of training images \* 175
|
|
2639
2623
|
* - For Flux: number of training images \* 100
|
|
2640
2624
|
*
|
|
2641
2625
|
* Maximum value varies depending on the model type:
|
|
2642
2626
|
*
|
|
2643
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
2644
2627
|
* - For Flux: [0, 10000]
|
|
2645
2628
|
*/
|
|
2646
2629
|
maxTrainSteps?: number;
|
|
@@ -2659,13 +2642,13 @@ export declare namespace ModelUpdateResponse {
|
|
|
2659
2642
|
/**
|
|
2660
2643
|
* The number of training steps for the text encoder
|
|
2661
2644
|
*
|
|
2662
|
-
*
|
|
2645
|
+
* Deprecated legacy training parameter.
|
|
2663
2646
|
*/
|
|
2664
2647
|
numTextTrainSteps?: number;
|
|
2665
2648
|
/**
|
|
2666
2649
|
* The number of training steps for the UNet
|
|
2667
2650
|
*
|
|
2668
|
-
*
|
|
2651
|
+
* Deprecated legacy training parameter.
|
|
2669
2652
|
*/
|
|
2670
2653
|
numUNetTrainSteps?: number;
|
|
2671
2654
|
/**
|
|
@@ -2686,36 +2669,35 @@ export declare namespace ModelUpdateResponse {
|
|
|
2686
2669
|
/**
|
|
2687
2670
|
* The weight of prior preservation loss
|
|
2688
2671
|
*
|
|
2689
|
-
*
|
|
2672
|
+
* Deprecated legacy training parameter.
|
|
2690
2673
|
*/
|
|
2691
2674
|
priorLossWeight?: number;
|
|
2692
2675
|
/**
|
|
2693
2676
|
* Whether to random crop or center crop images before resizing to the working
|
|
2694
2677
|
* resolution
|
|
2695
2678
|
*
|
|
2696
|
-
*
|
|
2679
|
+
* Deprecated legacy training parameter.
|
|
2697
2680
|
*/
|
|
2698
2681
|
randomCrop?: boolean;
|
|
2699
2682
|
/**
|
|
2700
2683
|
* Ratio of random crops
|
|
2701
2684
|
*
|
|
2702
|
-
*
|
|
2685
|
+
* Deprecated legacy training parameter.
|
|
2703
2686
|
*/
|
|
2704
2687
|
randomCropRatio?: number;
|
|
2705
2688
|
/**
|
|
2706
2689
|
* Scale of random crops
|
|
2707
2690
|
*
|
|
2708
|
-
*
|
|
2691
|
+
* Deprecated legacy training parameter.
|
|
2709
2692
|
*/
|
|
2710
2693
|
randomCropScale?: number;
|
|
2711
2694
|
/**
|
|
2712
2695
|
* The dimension of the LoRA update matrices
|
|
2713
2696
|
*
|
|
2714
|
-
* Only available for
|
|
2697
|
+
* Only available for Flux LoRA and Musubi training
|
|
2715
2698
|
*
|
|
2716
2699
|
* Default value varies depending on the model type:
|
|
2717
2700
|
*
|
|
2718
|
-
* - For SDXL (deprecated): 64
|
|
2719
2701
|
* - For Flux: 16
|
|
2720
2702
|
* - For Musubi: 64
|
|
2721
2703
|
*
|
|
@@ -2744,13 +2726,13 @@ export declare namespace ModelUpdateResponse {
|
|
|
2744
2726
|
*
|
|
2745
2727
|
* Note: Legacy parameter, will be ignored
|
|
2746
2728
|
*
|
|
2747
|
-
*
|
|
2729
|
+
* Deprecated legacy training parameter.
|
|
2748
2730
|
*/
|
|
2749
2731
|
scaleLr?: boolean;
|
|
2750
2732
|
/**
|
|
2751
2733
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
2752
2734
|
*
|
|
2753
|
-
*
|
|
2735
|
+
* Deprecated legacy training parameter.
|
|
2754
2736
|
*/
|
|
2755
2737
|
seed?: number;
|
|
2756
2738
|
/**
|
|
@@ -2761,19 +2743,19 @@ export declare namespace ModelUpdateResponse {
|
|
|
2761
2743
|
*
|
|
2762
2744
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
2763
2745
|
*
|
|
2764
|
-
*
|
|
2746
|
+
* Deprecated legacy training parameter.
|
|
2765
2747
|
*/
|
|
2766
2748
|
textEncoderTrainingRatio?: number;
|
|
2767
2749
|
/**
|
|
2768
2750
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
2769
2751
|
*
|
|
2770
|
-
*
|
|
2752
|
+
* Deprecated legacy training parameter.
|
|
2771
2753
|
*/
|
|
2772
2754
|
validationFrequency?: number;
|
|
2773
2755
|
/**
|
|
2774
2756
|
* Validation prompt
|
|
2775
2757
|
*
|
|
2776
|
-
*
|
|
2758
|
+
* Deprecated legacy training parameter.
|
|
2777
2759
|
*/
|
|
2778
2760
|
validationPrompt?: string;
|
|
2779
2761
|
/**
|
|
@@ -3180,7 +3162,7 @@ export interface ModelListResponse {
|
|
|
3180
3162
|
/**
|
|
3181
3163
|
* The model type (example: "flux.1-lora")
|
|
3182
3164
|
*/
|
|
3183
|
-
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' | '
|
|
3165
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
3184
3166
|
/**
|
|
3185
3167
|
* The model last update date as an ISO string (example:
|
|
3186
3168
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -3208,6 +3190,12 @@ export interface ModelListResponse {
|
|
|
3208
3190
|
* The concepts is required for the type model: composition
|
|
3209
3191
|
*/
|
|
3210
3192
|
concepts?: Array<ModelListResponse.Concept>;
|
|
3193
|
+
/**
|
|
3194
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
3195
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
3196
|
+
* refunded as usual.
|
|
3197
|
+
*/
|
|
3198
|
+
disableRefund?: boolean;
|
|
3211
3199
|
/**
|
|
3212
3200
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
3213
3201
|
* uses the final model epoch (latest)
|
|
@@ -3308,7 +3296,7 @@ export declare namespace ModelListResponse {
|
|
|
3308
3296
|
*/
|
|
3309
3297
|
conceptPrompt: string;
|
|
3310
3298
|
/**
|
|
3311
|
-
* The model ID of the class
|
|
3299
|
+
* The model ID of the class. Only available for legacy models.
|
|
3312
3300
|
*/
|
|
3313
3301
|
modelId: string;
|
|
3314
3302
|
/**
|
|
@@ -3481,7 +3469,7 @@ export declare namespace ModelListResponse {
|
|
|
3481
3469
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
3482
3470
|
* available for \`model_array\` input type.
|
|
3483
3471
|
*/
|
|
3484
|
-
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' | '
|
|
3472
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
3485
3473
|
/**
|
|
3486
3474
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
3487
3475
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -3581,7 +3569,7 @@ export declare namespace ModelListResponse {
|
|
|
3581
3569
|
/**
|
|
3582
3570
|
* The prompt to specify images in the same class as provided instance images
|
|
3583
3571
|
*
|
|
3584
|
-
*
|
|
3572
|
+
* Deprecated legacy training parameter.
|
|
3585
3573
|
*/
|
|
3586
3574
|
classPrompt?: string;
|
|
3587
3575
|
/**
|
|
@@ -3595,11 +3583,8 @@ export declare namespace ModelListResponse {
|
|
|
3595
3583
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
3596
3584
|
* (example: "a daiton dog")
|
|
3597
3585
|
*
|
|
3598
|
-
* Default value varies depending on the model type
|
|
3599
|
-
*
|
|
3600
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
3601
|
-
* - For SDXL: "daiton"
|
|
3602
|
-
* - For Flux: ""
|
|
3586
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
3587
|
+
* an empty string.
|
|
3603
3588
|
*/
|
|
3604
3589
|
conceptPrompt?: string;
|
|
3605
3590
|
/**
|
|
@@ -3617,47 +3602,39 @@ export declare namespace ModelListResponse {
|
|
|
3617
3602
|
/**
|
|
3618
3603
|
* Initial learning rate (after the potential warmup period)
|
|
3619
3604
|
*
|
|
3620
|
-
* Default value varies depending on the model type
|
|
3621
|
-
*
|
|
3622
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
3623
|
-
* - For Flux: 0.0001
|
|
3605
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
3606
|
+
* 0.0001.
|
|
3624
3607
|
*/
|
|
3625
3608
|
learningRate?: number;
|
|
3626
3609
|
/**
|
|
3627
3610
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
3628
3611
|
*
|
|
3629
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
3630
|
-
*
|
|
3612
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
3613
|
+
* 0.000001]
|
|
3631
3614
|
*/
|
|
3632
3615
|
learningRateTextEncoder?: number;
|
|
3633
3616
|
/**
|
|
3634
3617
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
3635
3618
|
*
|
|
3636
|
-
*
|
|
3619
|
+
* Deprecated legacy training parameter.
|
|
3637
3620
|
*/
|
|
3638
3621
|
learningRateUnet?: number;
|
|
3639
3622
|
/**
|
|
3640
3623
|
* The scheduler type to use (default: "constant")
|
|
3641
3624
|
*
|
|
3642
|
-
*
|
|
3625
|
+
* Deprecated legacy training parameter.
|
|
3643
3626
|
*/
|
|
3644
3627
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
3645
3628
|
/**
|
|
3646
3629
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
3647
3630
|
* model type)
|
|
3648
3631
|
*
|
|
3649
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
3650
|
-
* instead
|
|
3651
|
-
*
|
|
3652
3632
|
* Default value varies depending on the model type:
|
|
3653
3633
|
*
|
|
3654
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
3655
|
-
* - For SDXL: number of training images \* 175
|
|
3656
3634
|
* - For Flux: number of training images \* 100
|
|
3657
3635
|
*
|
|
3658
3636
|
* Maximum value varies depending on the model type:
|
|
3659
3637
|
*
|
|
3660
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
3661
3638
|
* - For Flux: [0, 10000]
|
|
3662
3639
|
*/
|
|
3663
3640
|
maxTrainSteps?: number;
|
|
@@ -3676,13 +3653,13 @@ export declare namespace ModelListResponse {
|
|
|
3676
3653
|
/**
|
|
3677
3654
|
* The number of training steps for the text encoder
|
|
3678
3655
|
*
|
|
3679
|
-
*
|
|
3656
|
+
* Deprecated legacy training parameter.
|
|
3680
3657
|
*/
|
|
3681
3658
|
numTextTrainSteps?: number;
|
|
3682
3659
|
/**
|
|
3683
3660
|
* The number of training steps for the UNet
|
|
3684
3661
|
*
|
|
3685
|
-
*
|
|
3662
|
+
* Deprecated legacy training parameter.
|
|
3686
3663
|
*/
|
|
3687
3664
|
numUNetTrainSteps?: number;
|
|
3688
3665
|
/**
|
|
@@ -3703,36 +3680,35 @@ export declare namespace ModelListResponse {
|
|
|
3703
3680
|
/**
|
|
3704
3681
|
* The weight of prior preservation loss
|
|
3705
3682
|
*
|
|
3706
|
-
*
|
|
3683
|
+
* Deprecated legacy training parameter.
|
|
3707
3684
|
*/
|
|
3708
3685
|
priorLossWeight?: number;
|
|
3709
3686
|
/**
|
|
3710
3687
|
* Whether to random crop or center crop images before resizing to the working
|
|
3711
3688
|
* resolution
|
|
3712
3689
|
*
|
|
3713
|
-
*
|
|
3690
|
+
* Deprecated legacy training parameter.
|
|
3714
3691
|
*/
|
|
3715
3692
|
randomCrop?: boolean;
|
|
3716
3693
|
/**
|
|
3717
3694
|
* Ratio of random crops
|
|
3718
3695
|
*
|
|
3719
|
-
*
|
|
3696
|
+
* Deprecated legacy training parameter.
|
|
3720
3697
|
*/
|
|
3721
3698
|
randomCropRatio?: number;
|
|
3722
3699
|
/**
|
|
3723
3700
|
* Scale of random crops
|
|
3724
3701
|
*
|
|
3725
|
-
*
|
|
3702
|
+
* Deprecated legacy training parameter.
|
|
3726
3703
|
*/
|
|
3727
3704
|
randomCropScale?: number;
|
|
3728
3705
|
/**
|
|
3729
3706
|
* The dimension of the LoRA update matrices
|
|
3730
3707
|
*
|
|
3731
|
-
* Only available for
|
|
3708
|
+
* Only available for Flux LoRA and Musubi training
|
|
3732
3709
|
*
|
|
3733
3710
|
* Default value varies depending on the model type:
|
|
3734
3711
|
*
|
|
3735
|
-
* - For SDXL (deprecated): 64
|
|
3736
3712
|
* - For Flux: 16
|
|
3737
3713
|
* - For Musubi: 64
|
|
3738
3714
|
*
|
|
@@ -3761,13 +3737,13 @@ export declare namespace ModelListResponse {
|
|
|
3761
3737
|
*
|
|
3762
3738
|
* Note: Legacy parameter, will be ignored
|
|
3763
3739
|
*
|
|
3764
|
-
*
|
|
3740
|
+
* Deprecated legacy training parameter.
|
|
3765
3741
|
*/
|
|
3766
3742
|
scaleLr?: boolean;
|
|
3767
3743
|
/**
|
|
3768
3744
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
3769
3745
|
*
|
|
3770
|
-
*
|
|
3746
|
+
* Deprecated legacy training parameter.
|
|
3771
3747
|
*/
|
|
3772
3748
|
seed?: number;
|
|
3773
3749
|
/**
|
|
@@ -3778,19 +3754,19 @@ export declare namespace ModelListResponse {
|
|
|
3778
3754
|
*
|
|
3779
3755
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
3780
3756
|
*
|
|
3781
|
-
*
|
|
3757
|
+
* Deprecated legacy training parameter.
|
|
3782
3758
|
*/
|
|
3783
3759
|
textEncoderTrainingRatio?: number;
|
|
3784
3760
|
/**
|
|
3785
3761
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
3786
3762
|
*
|
|
3787
|
-
*
|
|
3763
|
+
* Deprecated legacy training parameter.
|
|
3788
3764
|
*/
|
|
3789
3765
|
validationFrequency?: number;
|
|
3790
3766
|
/**
|
|
3791
3767
|
* Validation prompt
|
|
3792
3768
|
*
|
|
3793
|
-
*
|
|
3769
|
+
* Deprecated legacy training parameter.
|
|
3794
3770
|
*/
|
|
3795
3771
|
validationPrompt?: string;
|
|
3796
3772
|
/**
|
|
@@ -4201,7 +4177,7 @@ export declare namespace ModelCopyResponse {
|
|
|
4201
4177
|
/**
|
|
4202
4178
|
* The model type (example: "flux.1-lora")
|
|
4203
4179
|
*/
|
|
4204
|
-
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' | '
|
|
4180
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
4205
4181
|
/**
|
|
4206
4182
|
* The model last update date as an ISO string (example:
|
|
4207
4183
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -4229,6 +4205,12 @@ export declare namespace ModelCopyResponse {
|
|
|
4229
4205
|
* The concepts is required for the type model: composition
|
|
4230
4206
|
*/
|
|
4231
4207
|
concepts?: Array<Model.Concept>;
|
|
4208
|
+
/**
|
|
4209
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
4210
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
4211
|
+
* refunded as usual.
|
|
4212
|
+
*/
|
|
4213
|
+
disableRefund?: boolean;
|
|
4232
4214
|
/**
|
|
4233
4215
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
4234
4216
|
* uses the final model epoch (latest)
|
|
@@ -4329,7 +4311,7 @@ export declare namespace ModelCopyResponse {
|
|
|
4329
4311
|
*/
|
|
4330
4312
|
conceptPrompt: string;
|
|
4331
4313
|
/**
|
|
4332
|
-
* The model ID of the class
|
|
4314
|
+
* The model ID of the class. Only available for legacy models.
|
|
4333
4315
|
*/
|
|
4334
4316
|
modelId: string;
|
|
4335
4317
|
/**
|
|
@@ -4502,7 +4484,7 @@ export declare namespace ModelCopyResponse {
|
|
|
4502
4484
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
4503
4485
|
* available for \`model_array\` input type.
|
|
4504
4486
|
*/
|
|
4505
|
-
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' | '
|
|
4487
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
4506
4488
|
/**
|
|
4507
4489
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
4508
4490
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -4602,7 +4584,7 @@ export declare namespace ModelCopyResponse {
|
|
|
4602
4584
|
/**
|
|
4603
4585
|
* The prompt to specify images in the same class as provided instance images
|
|
4604
4586
|
*
|
|
4605
|
-
*
|
|
4587
|
+
* Deprecated legacy training parameter.
|
|
4606
4588
|
*/
|
|
4607
4589
|
classPrompt?: string;
|
|
4608
4590
|
/**
|
|
@@ -4616,11 +4598,8 @@ export declare namespace ModelCopyResponse {
|
|
|
4616
4598
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
4617
4599
|
* (example: "a daiton dog")
|
|
4618
4600
|
*
|
|
4619
|
-
* Default value varies depending on the model type
|
|
4620
|
-
*
|
|
4621
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
4622
|
-
* - For SDXL: "daiton"
|
|
4623
|
-
* - For Flux: ""
|
|
4601
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
4602
|
+
* an empty string.
|
|
4624
4603
|
*/
|
|
4625
4604
|
conceptPrompt?: string;
|
|
4626
4605
|
/**
|
|
@@ -4638,47 +4617,39 @@ export declare namespace ModelCopyResponse {
|
|
|
4638
4617
|
/**
|
|
4639
4618
|
* Initial learning rate (after the potential warmup period)
|
|
4640
4619
|
*
|
|
4641
|
-
* Default value varies depending on the model type
|
|
4642
|
-
*
|
|
4643
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
4644
|
-
* - For Flux: 0.0001
|
|
4620
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
4621
|
+
* 0.0001.
|
|
4645
4622
|
*/
|
|
4646
4623
|
learningRate?: number;
|
|
4647
4624
|
/**
|
|
4648
4625
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
4649
4626
|
*
|
|
4650
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
4651
|
-
*
|
|
4627
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
4628
|
+
* 0.000001]
|
|
4652
4629
|
*/
|
|
4653
4630
|
learningRateTextEncoder?: number;
|
|
4654
4631
|
/**
|
|
4655
4632
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
4656
4633
|
*
|
|
4657
|
-
*
|
|
4634
|
+
* Deprecated legacy training parameter.
|
|
4658
4635
|
*/
|
|
4659
4636
|
learningRateUnet?: number;
|
|
4660
4637
|
/**
|
|
4661
4638
|
* The scheduler type to use (default: "constant")
|
|
4662
4639
|
*
|
|
4663
|
-
*
|
|
4640
|
+
* Deprecated legacy training parameter.
|
|
4664
4641
|
*/
|
|
4665
4642
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
4666
4643
|
/**
|
|
4667
4644
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
4668
4645
|
* model type)
|
|
4669
4646
|
*
|
|
4670
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
4671
|
-
* instead
|
|
4672
|
-
*
|
|
4673
4647
|
* Default value varies depending on the model type:
|
|
4674
4648
|
*
|
|
4675
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
4676
|
-
* - For SDXL: number of training images \* 175
|
|
4677
4649
|
* - For Flux: number of training images \* 100
|
|
4678
4650
|
*
|
|
4679
4651
|
* Maximum value varies depending on the model type:
|
|
4680
4652
|
*
|
|
4681
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
4682
4653
|
* - For Flux: [0, 10000]
|
|
4683
4654
|
*/
|
|
4684
4655
|
maxTrainSteps?: number;
|
|
@@ -4697,13 +4668,13 @@ export declare namespace ModelCopyResponse {
|
|
|
4697
4668
|
/**
|
|
4698
4669
|
* The number of training steps for the text encoder
|
|
4699
4670
|
*
|
|
4700
|
-
*
|
|
4671
|
+
* Deprecated legacy training parameter.
|
|
4701
4672
|
*/
|
|
4702
4673
|
numTextTrainSteps?: number;
|
|
4703
4674
|
/**
|
|
4704
4675
|
* The number of training steps for the UNet
|
|
4705
4676
|
*
|
|
4706
|
-
*
|
|
4677
|
+
* Deprecated legacy training parameter.
|
|
4707
4678
|
*/
|
|
4708
4679
|
numUNetTrainSteps?: number;
|
|
4709
4680
|
/**
|
|
@@ -4724,36 +4695,35 @@ export declare namespace ModelCopyResponse {
|
|
|
4724
4695
|
/**
|
|
4725
4696
|
* The weight of prior preservation loss
|
|
4726
4697
|
*
|
|
4727
|
-
*
|
|
4698
|
+
* Deprecated legacy training parameter.
|
|
4728
4699
|
*/
|
|
4729
4700
|
priorLossWeight?: number;
|
|
4730
4701
|
/**
|
|
4731
4702
|
* Whether to random crop or center crop images before resizing to the working
|
|
4732
4703
|
* resolution
|
|
4733
4704
|
*
|
|
4734
|
-
*
|
|
4705
|
+
* Deprecated legacy training parameter.
|
|
4735
4706
|
*/
|
|
4736
4707
|
randomCrop?: boolean;
|
|
4737
4708
|
/**
|
|
4738
4709
|
* Ratio of random crops
|
|
4739
4710
|
*
|
|
4740
|
-
*
|
|
4711
|
+
* Deprecated legacy training parameter.
|
|
4741
4712
|
*/
|
|
4742
4713
|
randomCropRatio?: number;
|
|
4743
4714
|
/**
|
|
4744
4715
|
* Scale of random crops
|
|
4745
4716
|
*
|
|
4746
|
-
*
|
|
4717
|
+
* Deprecated legacy training parameter.
|
|
4747
4718
|
*/
|
|
4748
4719
|
randomCropScale?: number;
|
|
4749
4720
|
/**
|
|
4750
4721
|
* The dimension of the LoRA update matrices
|
|
4751
4722
|
*
|
|
4752
|
-
* Only available for
|
|
4723
|
+
* Only available for Flux LoRA and Musubi training
|
|
4753
4724
|
*
|
|
4754
4725
|
* Default value varies depending on the model type:
|
|
4755
4726
|
*
|
|
4756
|
-
* - For SDXL (deprecated): 64
|
|
4757
4727
|
* - For Flux: 16
|
|
4758
4728
|
* - For Musubi: 64
|
|
4759
4729
|
*
|
|
@@ -4782,13 +4752,13 @@ export declare namespace ModelCopyResponse {
|
|
|
4782
4752
|
*
|
|
4783
4753
|
* Note: Legacy parameter, will be ignored
|
|
4784
4754
|
*
|
|
4785
|
-
*
|
|
4755
|
+
* Deprecated legacy training parameter.
|
|
4786
4756
|
*/
|
|
4787
4757
|
scaleLr?: boolean;
|
|
4788
4758
|
/**
|
|
4789
4759
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
4790
4760
|
*
|
|
4791
|
-
*
|
|
4761
|
+
* Deprecated legacy training parameter.
|
|
4792
4762
|
*/
|
|
4793
4763
|
seed?: number;
|
|
4794
4764
|
/**
|
|
@@ -4799,19 +4769,19 @@ export declare namespace ModelCopyResponse {
|
|
|
4799
4769
|
*
|
|
4800
4770
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
4801
4771
|
*
|
|
4802
|
-
*
|
|
4772
|
+
* Deprecated legacy training parameter.
|
|
4803
4773
|
*/
|
|
4804
4774
|
textEncoderTrainingRatio?: number;
|
|
4805
4775
|
/**
|
|
4806
4776
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
4807
4777
|
*
|
|
4808
|
-
*
|
|
4778
|
+
* Deprecated legacy training parameter.
|
|
4809
4779
|
*/
|
|
4810
4780
|
validationFrequency?: number;
|
|
4811
4781
|
/**
|
|
4812
4782
|
* Validation prompt
|
|
4813
4783
|
*
|
|
4814
|
-
*
|
|
4784
|
+
* Deprecated legacy training parameter.
|
|
4815
4785
|
*/
|
|
4816
4786
|
validationPrompt?: string;
|
|
4817
4787
|
/**
|
|
@@ -5191,7 +5161,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5191
5161
|
/**
|
|
5192
5162
|
* The model type (example: "flux.1-lora")
|
|
5193
5163
|
*/
|
|
5194
|
-
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' | '
|
|
5164
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
5195
5165
|
/**
|
|
5196
5166
|
* The access restrictions of the model 0: Free plan 25: Creator plan 50: Pro plan
|
|
5197
5167
|
* 75: Team plan 100: Enterprise plan
|
|
@@ -5232,6 +5202,12 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5232
5202
|
* /generate/custom/{modelId} endpoint
|
|
5233
5203
|
*/
|
|
5234
5204
|
custom?: boolean;
|
|
5205
|
+
/**
|
|
5206
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
5207
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
5208
|
+
* refunded as usual.
|
|
5209
|
+
*/
|
|
5210
|
+
disableRefund?: boolean;
|
|
5235
5211
|
/**
|
|
5236
5212
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
5237
5213
|
* uses the final model epoch (latest)
|
|
@@ -5357,7 +5333,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5357
5333
|
*/
|
|
5358
5334
|
conceptPrompt: string;
|
|
5359
5335
|
/**
|
|
5360
|
-
* The model ID of the class
|
|
5336
|
+
* The model ID of the class. Only available for legacy models.
|
|
5361
5337
|
*/
|
|
5362
5338
|
modelId: string;
|
|
5363
5339
|
/**
|
|
@@ -5530,7 +5506,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5530
5506
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
5531
5507
|
* available for \`model_array\` input type.
|
|
5532
5508
|
*/
|
|
5533
|
-
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' | '
|
|
5509
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
5534
5510
|
/**
|
|
5535
5511
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
5536
5512
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -5630,7 +5606,7 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5630
5606
|
/**
|
|
5631
5607
|
* The prompt to specify images in the same class as provided instance images
|
|
5632
5608
|
*
|
|
5633
|
-
*
|
|
5609
|
+
* Deprecated legacy training parameter.
|
|
5634
5610
|
*/
|
|
5635
5611
|
classPrompt?: string;
|
|
5636
5612
|
/**
|
|
@@ -5644,11 +5620,8 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5644
5620
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
5645
5621
|
* (example: "a daiton dog")
|
|
5646
5622
|
*
|
|
5647
|
-
* Default value varies depending on the model type
|
|
5648
|
-
*
|
|
5649
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
5650
|
-
* - For SDXL: "daiton"
|
|
5651
|
-
* - For Flux: ""
|
|
5623
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
5624
|
+
* an empty string.
|
|
5652
5625
|
*/
|
|
5653
5626
|
conceptPrompt?: string;
|
|
5654
5627
|
/**
|
|
@@ -5666,47 +5639,39 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5666
5639
|
/**
|
|
5667
5640
|
* Initial learning rate (after the potential warmup period)
|
|
5668
5641
|
*
|
|
5669
|
-
* Default value varies depending on the model type
|
|
5670
|
-
*
|
|
5671
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
5672
|
-
* - For Flux: 0.0001
|
|
5642
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
5643
|
+
* 0.0001.
|
|
5673
5644
|
*/
|
|
5674
5645
|
learningRate?: number;
|
|
5675
5646
|
/**
|
|
5676
5647
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
5677
5648
|
*
|
|
5678
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
5679
|
-
*
|
|
5649
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
5650
|
+
* 0.000001]
|
|
5680
5651
|
*/
|
|
5681
5652
|
learningRateTextEncoder?: number;
|
|
5682
5653
|
/**
|
|
5683
5654
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
5684
5655
|
*
|
|
5685
|
-
*
|
|
5656
|
+
* Deprecated legacy training parameter.
|
|
5686
5657
|
*/
|
|
5687
5658
|
learningRateUnet?: number;
|
|
5688
5659
|
/**
|
|
5689
5660
|
* The scheduler type to use (default: "constant")
|
|
5690
5661
|
*
|
|
5691
|
-
*
|
|
5662
|
+
* Deprecated legacy training parameter.
|
|
5692
5663
|
*/
|
|
5693
5664
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
5694
5665
|
/**
|
|
5695
5666
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
5696
5667
|
* model type)
|
|
5697
5668
|
*
|
|
5698
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
5699
|
-
* instead
|
|
5700
|
-
*
|
|
5701
5669
|
* Default value varies depending on the model type:
|
|
5702
5670
|
*
|
|
5703
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
5704
|
-
* - For SDXL: number of training images \* 175
|
|
5705
5671
|
* - For Flux: number of training images \* 100
|
|
5706
5672
|
*
|
|
5707
5673
|
* Maximum value varies depending on the model type:
|
|
5708
5674
|
*
|
|
5709
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
5710
5675
|
* - For Flux: [0, 10000]
|
|
5711
5676
|
*/
|
|
5712
5677
|
maxTrainSteps?: number;
|
|
@@ -5725,13 +5690,13 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5725
5690
|
/**
|
|
5726
5691
|
* The number of training steps for the text encoder
|
|
5727
5692
|
*
|
|
5728
|
-
*
|
|
5693
|
+
* Deprecated legacy training parameter.
|
|
5729
5694
|
*/
|
|
5730
5695
|
numTextTrainSteps?: number;
|
|
5731
5696
|
/**
|
|
5732
5697
|
* The number of training steps for the UNet
|
|
5733
5698
|
*
|
|
5734
|
-
*
|
|
5699
|
+
* Deprecated legacy training parameter.
|
|
5735
5700
|
*/
|
|
5736
5701
|
numUNetTrainSteps?: number;
|
|
5737
5702
|
/**
|
|
@@ -5752,36 +5717,35 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5752
5717
|
/**
|
|
5753
5718
|
* The weight of prior preservation loss
|
|
5754
5719
|
*
|
|
5755
|
-
*
|
|
5720
|
+
* Deprecated legacy training parameter.
|
|
5756
5721
|
*/
|
|
5757
5722
|
priorLossWeight?: number;
|
|
5758
5723
|
/**
|
|
5759
5724
|
* Whether to random crop or center crop images before resizing to the working
|
|
5760
5725
|
* resolution
|
|
5761
5726
|
*
|
|
5762
|
-
*
|
|
5727
|
+
* Deprecated legacy training parameter.
|
|
5763
5728
|
*/
|
|
5764
5729
|
randomCrop?: boolean;
|
|
5765
5730
|
/**
|
|
5766
5731
|
* Ratio of random crops
|
|
5767
5732
|
*
|
|
5768
|
-
*
|
|
5733
|
+
* Deprecated legacy training parameter.
|
|
5769
5734
|
*/
|
|
5770
5735
|
randomCropRatio?: number;
|
|
5771
5736
|
/**
|
|
5772
5737
|
* Scale of random crops
|
|
5773
5738
|
*
|
|
5774
|
-
*
|
|
5739
|
+
* Deprecated legacy training parameter.
|
|
5775
5740
|
*/
|
|
5776
5741
|
randomCropScale?: number;
|
|
5777
5742
|
/**
|
|
5778
5743
|
* The dimension of the LoRA update matrices
|
|
5779
5744
|
*
|
|
5780
|
-
* Only available for
|
|
5745
|
+
* Only available for Flux LoRA and Musubi training
|
|
5781
5746
|
*
|
|
5782
5747
|
* Default value varies depending on the model type:
|
|
5783
5748
|
*
|
|
5784
|
-
* - For SDXL (deprecated): 64
|
|
5785
5749
|
* - For Flux: 16
|
|
5786
5750
|
* - For Musubi: 64
|
|
5787
5751
|
*
|
|
@@ -5810,13 +5774,13 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5810
5774
|
*
|
|
5811
5775
|
* Note: Legacy parameter, will be ignored
|
|
5812
5776
|
*
|
|
5813
|
-
*
|
|
5777
|
+
* Deprecated legacy training parameter.
|
|
5814
5778
|
*/
|
|
5815
5779
|
scaleLr?: boolean;
|
|
5816
5780
|
/**
|
|
5817
5781
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
5818
5782
|
*
|
|
5819
|
-
*
|
|
5783
|
+
* Deprecated legacy training parameter.
|
|
5820
5784
|
*/
|
|
5821
5785
|
seed?: number;
|
|
5822
5786
|
/**
|
|
@@ -5827,19 +5791,19 @@ export declare namespace ModelGetBulkResponse {
|
|
|
5827
5791
|
*
|
|
5828
5792
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
5829
5793
|
*
|
|
5830
|
-
*
|
|
5794
|
+
* Deprecated legacy training parameter.
|
|
5831
5795
|
*/
|
|
5832
5796
|
textEncoderTrainingRatio?: number;
|
|
5833
5797
|
/**
|
|
5834
5798
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
5835
5799
|
*
|
|
5836
|
-
*
|
|
5800
|
+
* Deprecated legacy training parameter.
|
|
5837
5801
|
*/
|
|
5838
5802
|
validationFrequency?: number;
|
|
5839
5803
|
/**
|
|
5840
5804
|
* Validation prompt
|
|
5841
5805
|
*
|
|
5842
|
-
*
|
|
5806
|
+
* Deprecated legacy training parameter.
|
|
5843
5807
|
*/
|
|
5844
5808
|
validationPrompt?: string;
|
|
5845
5809
|
/**
|
|
@@ -6250,7 +6214,7 @@ export declare namespace ModelTransferResponse {
|
|
|
6250
6214
|
/**
|
|
6251
6215
|
* The model type (example: "flux.1-lora")
|
|
6252
6216
|
*/
|
|
6253
|
-
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' | '
|
|
6217
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
6254
6218
|
/**
|
|
6255
6219
|
* The model last update date as an ISO string (example:
|
|
6256
6220
|
* "2023-02-03T11:19:41.579Z")
|
|
@@ -6278,6 +6242,12 @@ export declare namespace ModelTransferResponse {
|
|
|
6278
6242
|
* The concepts is required for the type model: composition
|
|
6279
6243
|
*/
|
|
6280
6244
|
concepts?: Array<Model.Concept>;
|
|
6245
|
+
/**
|
|
6246
|
+
* When true, credits spent on a generation with this model are not automatically
|
|
6247
|
+
* refunded if the generation fails. Absent or false means failed generations are
|
|
6248
|
+
* refunded as usual.
|
|
6249
|
+
*/
|
|
6250
|
+
disableRefund?: boolean;
|
|
6281
6251
|
/**
|
|
6282
6252
|
* The epoch of the model. Only available for Flux Lora Trained models. If not set,
|
|
6283
6253
|
* uses the final model epoch (latest)
|
|
@@ -6378,7 +6348,7 @@ export declare namespace ModelTransferResponse {
|
|
|
6378
6348
|
*/
|
|
6379
6349
|
conceptPrompt: string;
|
|
6380
6350
|
/**
|
|
6381
|
-
* The model ID of the class
|
|
6351
|
+
* The model ID of the class. Only available for legacy models.
|
|
6382
6352
|
*/
|
|
6383
6353
|
modelId: string;
|
|
6384
6354
|
/**
|
|
@@ -6551,7 +6521,7 @@ export declare namespace ModelTransferResponse {
|
|
|
6551
6521
|
* The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
|
|
6552
6522
|
* available for \`model_array\` input type.
|
|
6553
6523
|
*/
|
|
6554
|
-
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' | '
|
|
6524
|
+
modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
|
|
6555
6525
|
/**
|
|
6556
6526
|
* Whether this input represents a parent asset to assign to the produced assets.
|
|
6557
6527
|
* Only available for \`file\` and \`file_array\` input types.
|
|
@@ -6651,7 +6621,7 @@ export declare namespace ModelTransferResponse {
|
|
|
6651
6621
|
/**
|
|
6652
6622
|
* The prompt to specify images in the same class as provided instance images
|
|
6653
6623
|
*
|
|
6654
|
-
*
|
|
6624
|
+
* Deprecated legacy training parameter.
|
|
6655
6625
|
*/
|
|
6656
6626
|
classPrompt?: string;
|
|
6657
6627
|
/**
|
|
@@ -6665,11 +6635,8 @@ export declare namespace ModelTransferResponse {
|
|
|
6665
6635
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
6666
6636
|
* (example: "a daiton dog")
|
|
6667
6637
|
*
|
|
6668
|
-
* Default value varies depending on the model type
|
|
6669
|
-
*
|
|
6670
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
6671
|
-
* - For SDXL: "daiton"
|
|
6672
|
-
* - For Flux: ""
|
|
6638
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
6639
|
+
* an empty string.
|
|
6673
6640
|
*/
|
|
6674
6641
|
conceptPrompt?: string;
|
|
6675
6642
|
/**
|
|
@@ -6687,47 +6654,39 @@ export declare namespace ModelTransferResponse {
|
|
|
6687
6654
|
/**
|
|
6688
6655
|
* Initial learning rate (after the potential warmup period)
|
|
6689
6656
|
*
|
|
6690
|
-
* Default value varies depending on the model type
|
|
6691
|
-
*
|
|
6692
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
6693
|
-
* - For Flux: 0.0001
|
|
6657
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
6658
|
+
* 0.0001.
|
|
6694
6659
|
*/
|
|
6695
6660
|
learningRate?: number;
|
|
6696
6661
|
/**
|
|
6697
6662
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
6698
6663
|
*
|
|
6699
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
6700
|
-
*
|
|
6664
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
6665
|
+
* 0.000001]
|
|
6701
6666
|
*/
|
|
6702
6667
|
learningRateTextEncoder?: number;
|
|
6703
6668
|
/**
|
|
6704
6669
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
6705
6670
|
*
|
|
6706
|
-
*
|
|
6671
|
+
* Deprecated legacy training parameter.
|
|
6707
6672
|
*/
|
|
6708
6673
|
learningRateUnet?: number;
|
|
6709
6674
|
/**
|
|
6710
6675
|
* The scheduler type to use (default: "constant")
|
|
6711
6676
|
*
|
|
6712
|
-
*
|
|
6677
|
+
* Deprecated legacy training parameter.
|
|
6713
6678
|
*/
|
|
6714
6679
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
6715
6680
|
/**
|
|
6716
6681
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
6717
6682
|
* model type)
|
|
6718
6683
|
*
|
|
6719
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
6720
|
-
* instead
|
|
6721
|
-
*
|
|
6722
6684
|
* Default value varies depending on the model type:
|
|
6723
6685
|
*
|
|
6724
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
6725
|
-
* - For SDXL: number of training images \* 175
|
|
6726
6686
|
* - For Flux: number of training images \* 100
|
|
6727
6687
|
*
|
|
6728
6688
|
* Maximum value varies depending on the model type:
|
|
6729
6689
|
*
|
|
6730
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
6731
6690
|
* - For Flux: [0, 10000]
|
|
6732
6691
|
*/
|
|
6733
6692
|
maxTrainSteps?: number;
|
|
@@ -6746,13 +6705,13 @@ export declare namespace ModelTransferResponse {
|
|
|
6746
6705
|
/**
|
|
6747
6706
|
* The number of training steps for the text encoder
|
|
6748
6707
|
*
|
|
6749
|
-
*
|
|
6708
|
+
* Deprecated legacy training parameter.
|
|
6750
6709
|
*/
|
|
6751
6710
|
numTextTrainSteps?: number;
|
|
6752
6711
|
/**
|
|
6753
6712
|
* The number of training steps for the UNet
|
|
6754
6713
|
*
|
|
6755
|
-
*
|
|
6714
|
+
* Deprecated legacy training parameter.
|
|
6756
6715
|
*/
|
|
6757
6716
|
numUNetTrainSteps?: number;
|
|
6758
6717
|
/**
|
|
@@ -6773,36 +6732,35 @@ export declare namespace ModelTransferResponse {
|
|
|
6773
6732
|
/**
|
|
6774
6733
|
* The weight of prior preservation loss
|
|
6775
6734
|
*
|
|
6776
|
-
*
|
|
6735
|
+
* Deprecated legacy training parameter.
|
|
6777
6736
|
*/
|
|
6778
6737
|
priorLossWeight?: number;
|
|
6779
6738
|
/**
|
|
6780
6739
|
* Whether to random crop or center crop images before resizing to the working
|
|
6781
6740
|
* resolution
|
|
6782
6741
|
*
|
|
6783
|
-
*
|
|
6742
|
+
* Deprecated legacy training parameter.
|
|
6784
6743
|
*/
|
|
6785
6744
|
randomCrop?: boolean;
|
|
6786
6745
|
/**
|
|
6787
6746
|
* Ratio of random crops
|
|
6788
6747
|
*
|
|
6789
|
-
*
|
|
6748
|
+
* Deprecated legacy training parameter.
|
|
6790
6749
|
*/
|
|
6791
6750
|
randomCropRatio?: number;
|
|
6792
6751
|
/**
|
|
6793
6752
|
* Scale of random crops
|
|
6794
6753
|
*
|
|
6795
|
-
*
|
|
6754
|
+
* Deprecated legacy training parameter.
|
|
6796
6755
|
*/
|
|
6797
6756
|
randomCropScale?: number;
|
|
6798
6757
|
/**
|
|
6799
6758
|
* The dimension of the LoRA update matrices
|
|
6800
6759
|
*
|
|
6801
|
-
* Only available for
|
|
6760
|
+
* Only available for Flux LoRA and Musubi training
|
|
6802
6761
|
*
|
|
6803
6762
|
* Default value varies depending on the model type:
|
|
6804
6763
|
*
|
|
6805
|
-
* - For SDXL (deprecated): 64
|
|
6806
6764
|
* - For Flux: 16
|
|
6807
6765
|
* - For Musubi: 64
|
|
6808
6766
|
*
|
|
@@ -6831,13 +6789,13 @@ export declare namespace ModelTransferResponse {
|
|
|
6831
6789
|
*
|
|
6832
6790
|
* Note: Legacy parameter, will be ignored
|
|
6833
6791
|
*
|
|
6834
|
-
*
|
|
6792
|
+
* Deprecated legacy training parameter.
|
|
6835
6793
|
*/
|
|
6836
6794
|
scaleLr?: boolean;
|
|
6837
6795
|
/**
|
|
6838
6796
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
6839
6797
|
*
|
|
6840
|
-
*
|
|
6798
|
+
* Deprecated legacy training parameter.
|
|
6841
6799
|
*/
|
|
6842
6800
|
seed?: number;
|
|
6843
6801
|
/**
|
|
@@ -6848,19 +6806,19 @@ export declare namespace ModelTransferResponse {
|
|
|
6848
6806
|
*
|
|
6849
6807
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
6850
6808
|
*
|
|
6851
|
-
*
|
|
6809
|
+
* Deprecated legacy training parameter.
|
|
6852
6810
|
*/
|
|
6853
6811
|
textEncoderTrainingRatio?: number;
|
|
6854
6812
|
/**
|
|
6855
6813
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
6856
6814
|
*
|
|
6857
|
-
*
|
|
6815
|
+
* Deprecated legacy training parameter.
|
|
6858
6816
|
*/
|
|
6859
6817
|
validationFrequency?: number;
|
|
6860
6818
|
/**
|
|
6861
6819
|
* Validation prompt
|
|
6862
6820
|
*
|
|
6863
|
-
*
|
|
6821
|
+
* Deprecated legacy training parameter.
|
|
6864
6822
|
*/
|
|
6865
6823
|
validationPrompt?: string;
|
|
6866
6824
|
/**
|
|
@@ -7253,7 +7211,7 @@ export interface ModelCreateParams {
|
|
|
7253
7211
|
* Body param: The concepts is required for composition models. With one or more
|
|
7254
7212
|
* loras
|
|
7255
7213
|
*
|
|
7256
|
-
* Only applicable to Flux based models
|
|
7214
|
+
* Only applicable to Flux based models.
|
|
7257
7215
|
*/
|
|
7258
7216
|
concepts?: Array<ModelCreateParams.Concept>;
|
|
7259
7217
|
/**
|
|
@@ -7276,7 +7234,7 @@ export interface ModelCreateParams {
|
|
|
7276
7234
|
*
|
|
7277
7235
|
* The type can only be changed if the model has the "new" status.
|
|
7278
7236
|
*/
|
|
7279
|
-
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' | '
|
|
7237
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
7280
7238
|
}
|
|
7281
7239
|
export declare namespace ModelCreateParams {
|
|
7282
7240
|
interface Concept {
|
|
@@ -7316,7 +7274,7 @@ export interface ModelUpdateParams {
|
|
|
7316
7274
|
* Body param: The concepts is required for composition models. With one or more
|
|
7317
7275
|
* loras
|
|
7318
7276
|
*
|
|
7319
|
-
* Only applicable to Flux based models
|
|
7277
|
+
* Only applicable to Flux based models.
|
|
7320
7278
|
*/
|
|
7321
7279
|
concepts?: Array<ModelUpdateParams.Concept>;
|
|
7322
7280
|
/**
|
|
@@ -7368,7 +7326,7 @@ export interface ModelUpdateParams {
|
|
|
7368
7326
|
*
|
|
7369
7327
|
* The type can only be changed if the model has the "new" status.
|
|
7370
7328
|
*/
|
|
7371
|
-
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' | '
|
|
7329
|
+
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' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
7372
7330
|
}
|
|
7373
7331
|
export declare namespace ModelUpdateParams {
|
|
7374
7332
|
interface Concept {
|
|
@@ -7406,7 +7364,7 @@ export declare namespace ModelUpdateParams {
|
|
|
7406
7364
|
/**
|
|
7407
7365
|
* The prompt to specify images in the same class as provided instance images
|
|
7408
7366
|
*
|
|
7409
|
-
*
|
|
7367
|
+
* Deprecated legacy training parameter.
|
|
7410
7368
|
*/
|
|
7411
7369
|
classPrompt?: string;
|
|
7412
7370
|
/**
|
|
@@ -7420,11 +7378,8 @@ export declare namespace ModelUpdateParams {
|
|
|
7420
7378
|
* The prompt with identifier specifying the instance (or subject) of the class
|
|
7421
7379
|
* (example: "a daiton dog")
|
|
7422
7380
|
*
|
|
7423
|
-
* Default value varies depending on the model type
|
|
7424
|
-
*
|
|
7425
|
-
* - For SD1.5: "daiton" if no class is associated with the model
|
|
7426
|
-
* - For SDXL: "daiton"
|
|
7427
|
-
* - For Flux: ""
|
|
7381
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
7382
|
+
* an empty string.
|
|
7428
7383
|
*/
|
|
7429
7384
|
conceptPrompt?: string;
|
|
7430
7385
|
/**
|
|
@@ -7442,47 +7397,39 @@ export declare namespace ModelUpdateParams {
|
|
|
7442
7397
|
/**
|
|
7443
7398
|
* Initial learning rate (after the potential warmup period)
|
|
7444
7399
|
*
|
|
7445
|
-
* Default value varies depending on the model type
|
|
7446
|
-
*
|
|
7447
|
-
* - For SD1.5 and SDXL: 0.000005
|
|
7448
|
-
* - For Flux: 0.0001
|
|
7400
|
+
* Default value varies depending on the model type. For Flux LoRA, the default is
|
|
7401
|
+
* 0.0001.
|
|
7449
7402
|
*/
|
|
7450
7403
|
learningRate?: number;
|
|
7451
7404
|
/**
|
|
7452
7405
|
* Initial learning rate (after the potential warmup period) for the text encoder
|
|
7453
7406
|
*
|
|
7454
|
-
* Maximum [Flux LoRA: 0.001] Default [
|
|
7455
|
-
*
|
|
7407
|
+
* Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
|
|
7408
|
+
* 0.000001]
|
|
7456
7409
|
*/
|
|
7457
7410
|
learningRateTextEncoder?: number;
|
|
7458
7411
|
/**
|
|
7459
7412
|
* Initial learning rate (after the potential warmup period) for the UNet
|
|
7460
7413
|
*
|
|
7461
|
-
*
|
|
7414
|
+
* Deprecated legacy training parameter.
|
|
7462
7415
|
*/
|
|
7463
7416
|
learningRateUnet?: number;
|
|
7464
7417
|
/**
|
|
7465
7418
|
* The scheduler type to use (default: "constant")
|
|
7466
7419
|
*
|
|
7467
|
-
*
|
|
7420
|
+
* Deprecated legacy training parameter.
|
|
7468
7421
|
*/
|
|
7469
7422
|
lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
|
|
7470
7423
|
/**
|
|
7471
7424
|
* Maximum number of training steps to execute (default: varies depending on the
|
|
7472
7425
|
* model type)
|
|
7473
7426
|
*
|
|
7474
|
-
* For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
7475
|
-
* instead
|
|
7476
|
-
*
|
|
7477
7427
|
* Default value varies depending on the model type:
|
|
7478
7428
|
*
|
|
7479
|
-
* - For SD1.5: round((number of training images \* 225) / 3)
|
|
7480
|
-
* - For SDXL: number of training images \* 175
|
|
7481
7429
|
* - For Flux: number of training images \* 100
|
|
7482
7430
|
*
|
|
7483
7431
|
* Maximum value varies depending on the model type:
|
|
7484
7432
|
*
|
|
7485
|
-
* - For SD1.5 and SDXL: [0, 40000]
|
|
7486
7433
|
* - For Flux: [0, 10000]
|
|
7487
7434
|
*/
|
|
7488
7435
|
maxTrainSteps?: number;
|
|
@@ -7501,13 +7448,13 @@ export declare namespace ModelUpdateParams {
|
|
|
7501
7448
|
/**
|
|
7502
7449
|
* The number of training steps for the text encoder
|
|
7503
7450
|
*
|
|
7504
|
-
*
|
|
7451
|
+
* Deprecated legacy training parameter.
|
|
7505
7452
|
*/
|
|
7506
7453
|
numTextTrainSteps?: number;
|
|
7507
7454
|
/**
|
|
7508
7455
|
* The number of training steps for the UNet
|
|
7509
7456
|
*
|
|
7510
|
-
*
|
|
7457
|
+
* Deprecated legacy training parameter.
|
|
7511
7458
|
*/
|
|
7512
7459
|
numUNetTrainSteps?: number;
|
|
7513
7460
|
/**
|
|
@@ -7528,36 +7475,35 @@ export declare namespace ModelUpdateParams {
|
|
|
7528
7475
|
/**
|
|
7529
7476
|
* The weight of prior preservation loss
|
|
7530
7477
|
*
|
|
7531
|
-
*
|
|
7478
|
+
* Deprecated legacy training parameter.
|
|
7532
7479
|
*/
|
|
7533
7480
|
priorLossWeight?: number;
|
|
7534
7481
|
/**
|
|
7535
7482
|
* Whether to random crop or center crop images before resizing to the working
|
|
7536
7483
|
* resolution
|
|
7537
7484
|
*
|
|
7538
|
-
*
|
|
7485
|
+
* Deprecated legacy training parameter.
|
|
7539
7486
|
*/
|
|
7540
7487
|
randomCrop?: boolean;
|
|
7541
7488
|
/**
|
|
7542
7489
|
* Ratio of random crops
|
|
7543
7490
|
*
|
|
7544
|
-
*
|
|
7491
|
+
* Deprecated legacy training parameter.
|
|
7545
7492
|
*/
|
|
7546
7493
|
randomCropRatio?: number;
|
|
7547
7494
|
/**
|
|
7548
7495
|
* Scale of random crops
|
|
7549
7496
|
*
|
|
7550
|
-
*
|
|
7497
|
+
* Deprecated legacy training parameter.
|
|
7551
7498
|
*/
|
|
7552
7499
|
randomCropScale?: number;
|
|
7553
7500
|
/**
|
|
7554
7501
|
* The dimension of the LoRA update matrices
|
|
7555
7502
|
*
|
|
7556
|
-
* Only available for
|
|
7503
|
+
* Only available for Flux LoRA and Musubi training
|
|
7557
7504
|
*
|
|
7558
7505
|
* Default value varies depending on the model type:
|
|
7559
7506
|
*
|
|
7560
|
-
* - For SDXL (deprecated): 64
|
|
7561
7507
|
* - For Flux: 16
|
|
7562
7508
|
* - For Musubi: 64
|
|
7563
7509
|
*
|
|
@@ -7586,13 +7532,13 @@ export declare namespace ModelUpdateParams {
|
|
|
7586
7532
|
*
|
|
7587
7533
|
* Note: Legacy parameter, will be ignored
|
|
7588
7534
|
*
|
|
7589
|
-
*
|
|
7535
|
+
* Deprecated legacy training parameter.
|
|
7590
7536
|
*/
|
|
7591
7537
|
scaleLr?: boolean;
|
|
7592
7538
|
/**
|
|
7593
7539
|
* Used to reproduce previous results. Default: randomly generated number.
|
|
7594
7540
|
*
|
|
7595
|
-
*
|
|
7541
|
+
* Deprecated legacy training parameter.
|
|
7596
7542
|
*/
|
|
7597
7543
|
seed?: number;
|
|
7598
7544
|
/**
|
|
@@ -7603,19 +7549,19 @@ export declare namespace ModelUpdateParams {
|
|
|
7603
7549
|
*
|
|
7604
7550
|
* Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
|
|
7605
7551
|
*
|
|
7606
|
-
*
|
|
7552
|
+
* Deprecated legacy training parameter.
|
|
7607
7553
|
*/
|
|
7608
7554
|
textEncoderTrainingRatio?: number;
|
|
7609
7555
|
/**
|
|
7610
7556
|
* Validation frequency. Cannot be greater than maxTrainSteps value
|
|
7611
7557
|
*
|
|
7612
|
-
*
|
|
7558
|
+
* Deprecated legacy training parameter.
|
|
7613
7559
|
*/
|
|
7614
7560
|
validationFrequency?: number;
|
|
7615
7561
|
/**
|
|
7616
7562
|
* Validation prompt
|
|
7617
7563
|
*
|
|
7618
|
-
*
|
|
7564
|
+
* Deprecated legacy training parameter.
|
|
7619
7565
|
*/
|
|
7620
7566
|
validationPrompt?: string;
|
|
7621
7567
|
/**
|
|
@@ -7700,8 +7646,7 @@ export interface ModelListParams extends ModelsCursorParams {
|
|
|
7700
7646
|
tags?: string;
|
|
7701
7647
|
/**
|
|
7702
7648
|
* List all the models of a specific type. The parameter "type" and "types" cannot
|
|
7703
|
-
* be used together. Can be any of the following values:
|
|
7704
|
-
* sd-1_5-composition, sd-xl, sd-xl-lora, sd-xl-composition, flux.1, flux.1-lora,
|
|
7649
|
+
* be used together. Can be any of the following values: flux.1, flux.1-lora,
|
|
7705
7650
|
* flux.1-kontext-dev, flux.1-krea-dev, flux.1-kontext-lora, flux.1-krea-lora,
|
|
7706
7651
|
* flux.1-composition, flux.1-pro, flux1.1-pro, flux.1.1-pro-ultra,
|
|
7707
7652
|
* flux.2-dev-lora, flux.2-dev-edit-lora, flux.2-klein-4b-lora,
|
|
@@ -7713,11 +7658,10 @@ export interface ModelListParams extends ModelsCursorParams {
|
|
|
7713
7658
|
* zimage-turbo-lora, zimage-de-turbo-lora, custom, elevenlabs-voice. Only
|
|
7714
7659
|
* available when privacy=public
|
|
7715
7660
|
*/
|
|
7716
|
-
type?: '
|
|
7661
|
+
type?: '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';
|
|
7717
7662
|
/**
|
|
7718
7663
|
* List of types, comma separated. The parameter "type" and "types" cannot be used
|
|
7719
|
-
* together. Can be any of the following values:
|
|
7720
|
-
* sd-1_5-composition, sd-xl, sd-xl-lora, sd-xl-composition, flux.1, flux.1-lora,
|
|
7664
|
+
* together. Can be any of the following values: flux.1, flux.1-lora,
|
|
7721
7665
|
* flux.1-kontext-dev, flux.1-krea-dev, flux.1-kontext-lora, flux.1-krea-lora,
|
|
7722
7666
|
* flux.1-composition, flux.1-pro, flux1.1-pro, flux.1.1-pro-ultra,
|
|
7723
7667
|
* flux.2-dev-lora, flux.2-dev-edit-lora, flux.2-klein-4b-lora,
|
|
@@ -7729,7 +7673,7 @@ export interface ModelListParams extends ModelsCursorParams {
|
|
|
7729
7673
|
* zimage-turbo-lora, zimage-de-turbo-lora, custom, elevenlabs-voice. Only
|
|
7730
7674
|
* available when privacy=public
|
|
7731
7675
|
*/
|
|
7732
|
-
types?: Array<'
|
|
7676
|
+
types?: Array<'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'>;
|
|
7733
7677
|
/**
|
|
7734
7678
|
* Filter results to only return models updated after the specified ISO string date
|
|
7735
7679
|
* (exclusive). Requires the sortBy parameter to be "updatedAt". Only available
|