@scenario-labs/sdk 2.4.0 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/client.d.mts +1 -1
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +1 -1
  5. package/client.d.ts.map +1 -1
  6. package/lib/workflow_converter.d.mts +4 -0
  7. package/lib/workflow_converter.d.mts.map +1 -1
  8. package/lib/workflow_converter.d.ts +4 -0
  9. package/lib/workflow_converter.d.ts.map +1 -1
  10. package/lib/workflow_converter.js +64 -34
  11. package/lib/workflow_converter.js.map +1 -1
  12. package/lib/workflow_converter.mjs +64 -34
  13. package/lib/workflow_converter.mjs.map +1 -1
  14. package/package.json +1 -1
  15. package/resources/assets/assets.d.mts +269 -31
  16. package/resources/assets/assets.d.mts.map +1 -1
  17. package/resources/assets/assets.d.ts +269 -31
  18. package/resources/assets/assets.d.ts.map +1 -1
  19. package/resources/assets/assets.js.map +1 -1
  20. package/resources/assets/assets.mjs.map +1 -1
  21. package/resources/generate.d.mts +159 -51
  22. package/resources/generate.d.mts.map +1 -1
  23. package/resources/generate.d.ts +159 -51
  24. package/resources/generate.d.ts.map +1 -1
  25. package/resources/generate.js +1 -5
  26. package/resources/generate.js.map +1 -1
  27. package/resources/generate.mjs +1 -5
  28. package/resources/generate.mjs.map +1 -1
  29. package/resources/index.d.mts +1 -1
  30. package/resources/index.d.mts.map +1 -1
  31. package/resources/index.d.ts +1 -1
  32. package/resources/index.d.ts.map +1 -1
  33. package/resources/jobs.d.mts +30 -12
  34. package/resources/jobs.d.mts.map +1 -1
  35. package/resources/jobs.d.ts +30 -12
  36. package/resources/jobs.d.ts.map +1 -1
  37. package/resources/models/description.d.mts +62 -4
  38. package/resources/models/description.d.mts.map +1 -1
  39. package/resources/models/description.d.ts +62 -4
  40. package/resources/models/description.d.ts.map +1 -1
  41. package/resources/models/examples.d.mts +94 -64
  42. package/resources/models/examples.d.mts.map +1 -1
  43. package/resources/models/examples.d.ts +94 -64
  44. package/resources/models/examples.d.ts.map +1 -1
  45. package/resources/models/models.d.mts +239 -295
  46. package/resources/models/models.d.mts.map +1 -1
  47. package/resources/models/models.d.ts +239 -295
  48. package/resources/models/models.d.ts.map +1 -1
  49. package/resources/models/models.js.map +1 -1
  50. package/resources/models/models.mjs.map +1 -1
  51. package/resources/models/train.d.mts +92 -110
  52. package/resources/models/train.d.mts.map +1 -1
  53. package/resources/models/train.d.ts +92 -110
  54. package/resources/models/train.d.ts.map +1 -1
  55. package/resources/search.d.mts +2 -2
  56. package/resources/search.d.ts +2 -2
  57. package/resources/uploads.d.mts +2 -3
  58. package/resources/uploads.d.mts.map +1 -1
  59. package/resources/uploads.d.ts +2 -3
  60. package/resources/uploads.d.ts.map +1 -1
  61. package/resources/usages.d.mts +44 -15
  62. package/resources/usages.d.mts.map +1 -1
  63. package/resources/usages.d.ts +44 -15
  64. package/resources/usages.d.ts.map +1 -1
  65. package/resources/workflows.d.mts +63 -45
  66. package/resources/workflows.d.mts.map +1 -1
  67. package/resources/workflows.d.ts +63 -45
  68. package/resources/workflows.d.ts.map +1 -1
  69. package/resources/workflows.js +4 -4
  70. package/resources/workflows.js.map +1 -1
  71. package/resources/workflows.mjs +4 -4
  72. package/resources/workflows.mjs.map +1 -1
  73. package/src/client.ts +1 -1
  74. package/src/lib/workflow_converter.ts +96 -35
  75. package/src/resources/assets/assets.ts +300 -62
  76. package/src/resources/generate.ts +159 -129
  77. package/src/resources/index.ts +1 -1
  78. package/src/resources/jobs.ts +27 -37
  79. package/src/resources/models/description.ts +70 -12
  80. package/src/resources/models/examples.ts +100 -88
  81. package/src/resources/models/models.ts +228 -385
  82. package/src/resources/models/train.ts +89 -139
  83. package/src/resources/search.ts +2 -2
  84. package/src/resources/uploads.ts +2 -3
  85. package/src/resources/usages.ts +47 -20
  86. package/src/resources/workflows.ts +48 -157
  87. package/src/version.ts +1 -1
  88. package/version.d.mts +1 -1
  89. package/version.d.ts +1 -1
  90. package/version.js +1 -1
  91. package/version.mjs +1 -1
@@ -65,7 +65,7 @@ export declare namespace TrainActionResponse {
65
65
  /**
66
66
  * The model type (example: "flux.1-lora")
67
67
  */
68
- type: 'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
68
+ 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';
69
69
  /**
70
70
  * The model last update date as an ISO string (example:
71
71
  * "2023-02-03T11:19:41.579Z")
@@ -93,6 +93,12 @@ export declare namespace TrainActionResponse {
93
93
  * The concepts is required for the type model: composition
94
94
  */
95
95
  concepts?: Array<Model.Concept>;
96
+ /**
97
+ * When true, credits spent on a generation with this model are not automatically
98
+ * refunded if the generation fails. Absent or false means failed generations are
99
+ * refunded as usual.
100
+ */
101
+ disableRefund?: boolean;
96
102
  /**
97
103
  * The epoch of the model. Only available for Flux Lora Trained models. If not set,
98
104
  * uses the final model epoch (latest)
@@ -193,7 +199,7 @@ export declare namespace TrainActionResponse {
193
199
  */
194
200
  conceptPrompt: string;
195
201
  /**
196
- * The model ID of the class (example: "stable-diffusion-v1-5")
202
+ * The model ID of the class. Only available for legacy models.
197
203
  */
198
204
  modelId: string;
199
205
  /**
@@ -366,7 +372,7 @@ export declare namespace TrainActionResponse {
366
372
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
367
373
  * available for \`model_array\` input type.
368
374
  */
369
- modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
375
+ 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'>;
370
376
  /**
371
377
  * Whether this input represents a parent asset to assign to the produced assets.
372
378
  * Only available for \`file\` and \`file_array\` input types.
@@ -466,7 +472,7 @@ export declare namespace TrainActionResponse {
466
472
  /**
467
473
  * The prompt to specify images in the same class as provided instance images
468
474
  *
469
- * Only available for SD15 training
475
+ * Deprecated legacy training parameter.
470
476
  */
471
477
  classPrompt?: string;
472
478
  /**
@@ -480,11 +486,8 @@ export declare namespace TrainActionResponse {
480
486
  * The prompt with identifier specifying the instance (or subject) of the class
481
487
  * (example: "a daiton dog")
482
488
  *
483
- * Default value varies depending on the model type:
484
- *
485
- * - For SD1.5: "daiton" if no class is associated with the model
486
- * - For SDXL: "daiton"
487
- * - For Flux: ""
489
+ * Default value varies depending on the model type. For Flux LoRA, the default is
490
+ * an empty string.
488
491
  */
489
492
  conceptPrompt?: string;
490
493
  /**
@@ -502,47 +505,39 @@ export declare namespace TrainActionResponse {
502
505
  /**
503
506
  * Initial learning rate (after the potential warmup period)
504
507
  *
505
- * Default value varies depending on the model type:
506
- *
507
- * - For SD1.5 and SDXL: 0.000005
508
- * - For Flux: 0.0001
508
+ * Default value varies depending on the model type. For Flux LoRA, the default is
509
+ * 0.0001.
509
510
  */
510
511
  learningRate?: number;
511
512
  /**
512
513
  * Initial learning rate (after the potential warmup period) for the text encoder
513
514
  *
514
- * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
515
- * [SDXL: 0 | Flux LoRA: 0.000001]
515
+ * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
516
+ * 0.000001]
516
517
  */
517
518
  learningRateTextEncoder?: number;
518
519
  /**
519
520
  * Initial learning rate (after the potential warmup period) for the UNet
520
521
  *
521
- * Only available for SDXL LoRA training
522
+ * Deprecated legacy training parameter.
522
523
  */
523
524
  learningRateUnet?: number;
524
525
  /**
525
526
  * The scheduler type to use (default: "constant")
526
527
  *
527
- * Only available for SD15 and SDXL LoRA training
528
+ * Deprecated legacy training parameter.
528
529
  */
529
530
  lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
530
531
  /**
531
532
  * Maximum number of training steps to execute (default: varies depending on the
532
533
  * model type)
533
534
  *
534
- * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
535
- * instead
536
- *
537
535
  * Default value varies depending on the model type:
538
536
  *
539
- * - For SD1.5: round((number of training images \* 225) / 3)
540
- * - For SDXL: number of training images \* 175
541
537
  * - For Flux: number of training images \* 100
542
538
  *
543
539
  * Maximum value varies depending on the model type:
544
540
  *
545
- * - For SD1.5 and SDXL: [0, 40000]
546
541
  * - For Flux: [0, 10000]
547
542
  */
548
543
  maxTrainSteps?: number;
@@ -561,13 +556,13 @@ export declare namespace TrainActionResponse {
561
556
  /**
562
557
  * The number of training steps for the text encoder
563
558
  *
564
- * Only available for SDXL LoRA training
559
+ * Deprecated legacy training parameter.
565
560
  */
566
561
  numTextTrainSteps?: number;
567
562
  /**
568
563
  * The number of training steps for the UNet
569
564
  *
570
- * Only available for SDXL LoRA training
565
+ * Deprecated legacy training parameter.
571
566
  */
572
567
  numUNetTrainSteps?: number;
573
568
  /**
@@ -588,36 +583,35 @@ export declare namespace TrainActionResponse {
588
583
  /**
589
584
  * The weight of prior preservation loss
590
585
  *
591
- * Only available for SD15 and SDXL LoRA training
586
+ * Deprecated legacy training parameter.
592
587
  */
593
588
  priorLossWeight?: number;
594
589
  /**
595
590
  * Whether to random crop or center crop images before resizing to the working
596
591
  * resolution
597
592
  *
598
- * Only available for SD15 and SDXL LoRA training
593
+ * Deprecated legacy training parameter.
599
594
  */
600
595
  randomCrop?: boolean;
601
596
  /**
602
597
  * Ratio of random crops
603
598
  *
604
- * Only available for SD15 and SDXL LoRA training
599
+ * Deprecated legacy training parameter.
605
600
  */
606
601
  randomCropRatio?: number;
607
602
  /**
608
603
  * Scale of random crops
609
604
  *
610
- * Only available for SD15 and SDXL LoRA training
605
+ * Deprecated legacy training parameter.
611
606
  */
612
607
  randomCropScale?: number;
613
608
  /**
614
609
  * The dimension of the LoRA update matrices
615
610
  *
616
- * Only available for SDXL (deprecated), Flux LoRA and Musubi training
611
+ * Only available for Flux LoRA and Musubi training
617
612
  *
618
613
  * Default value varies depending on the model type:
619
614
  *
620
- * - For SDXL (deprecated): 64
621
615
  * - For Flux: 16
622
616
  * - For Musubi: 64
623
617
  *
@@ -646,13 +640,13 @@ export declare namespace TrainActionResponse {
646
640
  *
647
641
  * Note: Legacy parameter, will be ignored
648
642
  *
649
- * Only available for SD15 and SDXL LoRA training
643
+ * Deprecated legacy training parameter.
650
644
  */
651
645
  scaleLr?: boolean;
652
646
  /**
653
647
  * Used to reproduce previous results. Default: randomly generated number.
654
648
  *
655
- * Only available for SD15 and SDXL LoRA training
649
+ * Deprecated legacy training parameter.
656
650
  */
657
651
  seed?: number;
658
652
  /**
@@ -663,19 +657,19 @@ export declare namespace TrainActionResponse {
663
657
  *
664
658
  * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
665
659
  *
666
- * Only available for SD15 and SDXL LoRA training
660
+ * Deprecated legacy training parameter.
667
661
  */
668
662
  textEncoderTrainingRatio?: number;
669
663
  /**
670
664
  * Validation frequency. Cannot be greater than maxTrainSteps value
671
665
  *
672
- * Only available for SD15 and SDXL LoRA training
666
+ * Deprecated legacy training parameter.
673
667
  */
674
668
  validationFrequency?: number;
675
669
  /**
676
670
  * Validation prompt
677
671
  *
678
- * Only available for SD15 and SDXL LoRA training
672
+ * Deprecated legacy training parameter.
679
673
  */
680
674
  validationPrompt?: string;
681
675
  /**
@@ -1036,11 +1030,11 @@ export interface TrainTriggerResponse {
1036
1030
  job: TrainTriggerResponse.Job;
1037
1031
  model: TrainTriggerResponse.Model;
1038
1032
  /**
1039
- * The Creative Units cost for the request billed
1033
+ * The Compute Units cost for the request billed
1040
1034
  */
1041
1035
  creativeUnitsCost?: number;
1042
1036
  /**
1043
- * The Creative Units discount for the request billed
1037
+ * The Compute Units discount for the request billed
1044
1038
  */
1045
1039
  creativeUnitsDiscount?: number;
1046
1040
  /**
@@ -1061,7 +1055,7 @@ export declare namespace TrainTriggerResponse {
1061
1055
  /**
1062
1056
  * The type of job
1063
1057
  */
1064
- jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'musubi-model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
1058
+ jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'musubi-model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'splat' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
1065
1059
  /**
1066
1060
  * Metadata of the job with some additional information
1067
1061
  */
@@ -1351,7 +1345,7 @@ export declare namespace TrainTriggerResponse {
1351
1345
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
1352
1346
  * available for \`model_array\` input type.
1353
1347
  */
1354
- modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
1348
+ 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'>;
1355
1349
  /**
1356
1350
  * Whether this input represents a parent asset to assign to the produced assets.
1357
1351
  * Only available for \`file\` and \`file_array\` input types.
@@ -1509,7 +1503,7 @@ export declare namespace TrainTriggerResponse {
1509
1503
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
1510
1504
  * available for \`model_array\` input type.
1511
1505
  */
1512
- modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
1506
+ 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'>;
1513
1507
  /**
1514
1508
  * Whether this input represents a parent asset to assign to the produced assets.
1515
1509
  * Only available for \`file\` and \`file_array\` input types.
@@ -1730,6 +1724,12 @@ export declare namespace TrainTriggerResponse {
1730
1724
  interface Billing {
1731
1725
  cuCost: number;
1732
1726
  cuDiscount: number;
1727
+ /**
1728
+ * When true, the credits charged for this job are not automatically refunded if
1729
+ * the generation fails, because the model used does not support refund-on-failure.
1730
+ * Absent or false means a failed generation is refunded as usual.
1731
+ */
1732
+ disableRefund?: boolean;
1733
1733
  }
1734
1734
  }
1735
1735
  interface Model {
@@ -1782,7 +1782,7 @@ export declare namespace TrainTriggerResponse {
1782
1782
  /**
1783
1783
  * The model type (example: "flux.1-lora")
1784
1784
  */
1785
- type: 'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
1785
+ 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';
1786
1786
  /**
1787
1787
  * The model last update date as an ISO string (example:
1788
1788
  * "2023-02-03T11:19:41.579Z")
@@ -1810,6 +1810,12 @@ export declare namespace TrainTriggerResponse {
1810
1810
  * The concepts is required for the type model: composition
1811
1811
  */
1812
1812
  concepts?: Array<Model.Concept>;
1813
+ /**
1814
+ * When true, credits spent on a generation with this model are not automatically
1815
+ * refunded if the generation fails. Absent or false means failed generations are
1816
+ * refunded as usual.
1817
+ */
1818
+ disableRefund?: boolean;
1813
1819
  /**
1814
1820
  * The epoch of the model. Only available for Flux Lora Trained models. If not set,
1815
1821
  * uses the final model epoch (latest)
@@ -1910,7 +1916,7 @@ export declare namespace TrainTriggerResponse {
1910
1916
  */
1911
1917
  conceptPrompt: string;
1912
1918
  /**
1913
- * The model ID of the class (example: "stable-diffusion-v1-5")
1919
+ * The model ID of the class. Only available for legacy models.
1914
1920
  */
1915
1921
  modelId: string;
1916
1922
  /**
@@ -2083,7 +2089,7 @@ export declare namespace TrainTriggerResponse {
2083
2089
  * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
2084
2090
  * available for \`model_array\` input type.
2085
2091
  */
2086
- modelTypes?: Array<'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora'>;
2092
+ 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'>;
2087
2093
  /**
2088
2094
  * Whether this input represents a parent asset to assign to the produced assets.
2089
2095
  * Only available for \`file\` and \`file_array\` input types.
@@ -2183,7 +2189,7 @@ export declare namespace TrainTriggerResponse {
2183
2189
  /**
2184
2190
  * The prompt to specify images in the same class as provided instance images
2185
2191
  *
2186
- * Only available for SD15 training
2192
+ * Deprecated legacy training parameter.
2187
2193
  */
2188
2194
  classPrompt?: string;
2189
2195
  /**
@@ -2197,11 +2203,8 @@ export declare namespace TrainTriggerResponse {
2197
2203
  * The prompt with identifier specifying the instance (or subject) of the class
2198
2204
  * (example: "a daiton dog")
2199
2205
  *
2200
- * Default value varies depending on the model type:
2201
- *
2202
- * - For SD1.5: "daiton" if no class is associated with the model
2203
- * - For SDXL: "daiton"
2204
- * - For Flux: ""
2206
+ * Default value varies depending on the model type. For Flux LoRA, the default is
2207
+ * an empty string.
2205
2208
  */
2206
2209
  conceptPrompt?: string;
2207
2210
  /**
@@ -2219,47 +2222,39 @@ export declare namespace TrainTriggerResponse {
2219
2222
  /**
2220
2223
  * Initial learning rate (after the potential warmup period)
2221
2224
  *
2222
- * Default value varies depending on the model type:
2223
- *
2224
- * - For SD1.5 and SDXL: 0.000005
2225
- * - For Flux: 0.0001
2225
+ * Default value varies depending on the model type. For Flux LoRA, the default is
2226
+ * 0.0001.
2226
2227
  */
2227
2228
  learningRate?: number;
2228
2229
  /**
2229
2230
  * Initial learning rate (after the potential warmup period) for the text encoder
2230
2231
  *
2231
- * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
2232
- * [SDXL: 0 | Flux LoRA: 0.000001]
2232
+ * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
2233
+ * 0.000001]
2233
2234
  */
2234
2235
  learningRateTextEncoder?: number;
2235
2236
  /**
2236
2237
  * Initial learning rate (after the potential warmup period) for the UNet
2237
2238
  *
2238
- * Only available for SDXL LoRA training
2239
+ * Deprecated legacy training parameter.
2239
2240
  */
2240
2241
  learningRateUnet?: number;
2241
2242
  /**
2242
2243
  * The scheduler type to use (default: "constant")
2243
2244
  *
2244
- * Only available for SD15 and SDXL LoRA training
2245
+ * Deprecated legacy training parameter.
2245
2246
  */
2246
2247
  lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
2247
2248
  /**
2248
2249
  * Maximum number of training steps to execute (default: varies depending on the
2249
2250
  * model type)
2250
2251
  *
2251
- * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
2252
- * instead
2253
- *
2254
2252
  * Default value varies depending on the model type:
2255
2253
  *
2256
- * - For SD1.5: round((number of training images \* 225) / 3)
2257
- * - For SDXL: number of training images \* 175
2258
2254
  * - For Flux: number of training images \* 100
2259
2255
  *
2260
2256
  * Maximum value varies depending on the model type:
2261
2257
  *
2262
- * - For SD1.5 and SDXL: [0, 40000]
2263
2258
  * - For Flux: [0, 10000]
2264
2259
  */
2265
2260
  maxTrainSteps?: number;
@@ -2278,13 +2273,13 @@ export declare namespace TrainTriggerResponse {
2278
2273
  /**
2279
2274
  * The number of training steps for the text encoder
2280
2275
  *
2281
- * Only available for SDXL LoRA training
2276
+ * Deprecated legacy training parameter.
2282
2277
  */
2283
2278
  numTextTrainSteps?: number;
2284
2279
  /**
2285
2280
  * The number of training steps for the UNet
2286
2281
  *
2287
- * Only available for SDXL LoRA training
2282
+ * Deprecated legacy training parameter.
2288
2283
  */
2289
2284
  numUNetTrainSteps?: number;
2290
2285
  /**
@@ -2305,36 +2300,35 @@ export declare namespace TrainTriggerResponse {
2305
2300
  /**
2306
2301
  * The weight of prior preservation loss
2307
2302
  *
2308
- * Only available for SD15 and SDXL LoRA training
2303
+ * Deprecated legacy training parameter.
2309
2304
  */
2310
2305
  priorLossWeight?: number;
2311
2306
  /**
2312
2307
  * Whether to random crop or center crop images before resizing to the working
2313
2308
  * resolution
2314
2309
  *
2315
- * Only available for SD15 and SDXL LoRA training
2310
+ * Deprecated legacy training parameter.
2316
2311
  */
2317
2312
  randomCrop?: boolean;
2318
2313
  /**
2319
2314
  * Ratio of random crops
2320
2315
  *
2321
- * Only available for SD15 and SDXL LoRA training
2316
+ * Deprecated legacy training parameter.
2322
2317
  */
2323
2318
  randomCropRatio?: number;
2324
2319
  /**
2325
2320
  * Scale of random crops
2326
2321
  *
2327
- * Only available for SD15 and SDXL LoRA training
2322
+ * Deprecated legacy training parameter.
2328
2323
  */
2329
2324
  randomCropScale?: number;
2330
2325
  /**
2331
2326
  * The dimension of the LoRA update matrices
2332
2327
  *
2333
- * Only available for SDXL (deprecated), Flux LoRA and Musubi training
2328
+ * Only available for Flux LoRA and Musubi training
2334
2329
  *
2335
2330
  * Default value varies depending on the model type:
2336
2331
  *
2337
- * - For SDXL (deprecated): 64
2338
2332
  * - For Flux: 16
2339
2333
  * - For Musubi: 64
2340
2334
  *
@@ -2363,13 +2357,13 @@ export declare namespace TrainTriggerResponse {
2363
2357
  *
2364
2358
  * Note: Legacy parameter, will be ignored
2365
2359
  *
2366
- * Only available for SD15 and SDXL LoRA training
2360
+ * Deprecated legacy training parameter.
2367
2361
  */
2368
2362
  scaleLr?: boolean;
2369
2363
  /**
2370
2364
  * Used to reproduce previous results. Default: randomly generated number.
2371
2365
  *
2372
- * Only available for SD15 and SDXL LoRA training
2366
+ * Deprecated legacy training parameter.
2373
2367
  */
2374
2368
  seed?: number;
2375
2369
  /**
@@ -2380,19 +2374,19 @@ export declare namespace TrainTriggerResponse {
2380
2374
  *
2381
2375
  * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
2382
2376
  *
2383
- * Only available for SD15 and SDXL LoRA training
2377
+ * Deprecated legacy training parameter.
2384
2378
  */
2385
2379
  textEncoderTrainingRatio?: number;
2386
2380
  /**
2387
2381
  * Validation frequency. Cannot be greater than maxTrainSteps value
2388
2382
  *
2389
- * Only available for SD15 and SDXL LoRA training
2383
+ * Deprecated legacy training parameter.
2390
2384
  */
2391
2385
  validationFrequency?: number;
2392
2386
  /**
2393
2387
  * Validation prompt
2394
2388
  *
2395
- * Only available for SD15 and SDXL LoRA training
2389
+ * Deprecated legacy training parameter.
2396
2390
  */
2397
2391
  validationPrompt?: string;
2398
2392
  /**
@@ -2859,7 +2853,7 @@ export declare namespace TrainTriggerParams {
2859
2853
  /**
2860
2854
  * The prompt to specify images in the same class as provided instance images
2861
2855
  *
2862
- * Only available for SD15 training
2856
+ * Deprecated legacy training parameter.
2863
2857
  */
2864
2858
  classPrompt?: string;
2865
2859
  /**
@@ -2873,11 +2867,8 @@ export declare namespace TrainTriggerParams {
2873
2867
  * The prompt with identifier specifying the instance (or subject) of the class
2874
2868
  * (example: "a daiton dog")
2875
2869
  *
2876
- * Default value varies depending on the model type:
2877
- *
2878
- * - For SD1.5: "daiton" if no class is associated with the model
2879
- * - For SDXL: "daiton"
2880
- * - For Flux: ""
2870
+ * Default value varies depending on the model type. For Flux LoRA, the default is
2871
+ * an empty string.
2881
2872
  */
2882
2873
  conceptPrompt?: string;
2883
2874
  /**
@@ -2895,47 +2886,39 @@ export declare namespace TrainTriggerParams {
2895
2886
  /**
2896
2887
  * Initial learning rate (after the potential warmup period)
2897
2888
  *
2898
- * Default value varies depending on the model type:
2899
- *
2900
- * - For SD1.5 and SDXL: 0.000005
2901
- * - For Flux: 0.0001
2889
+ * Default value varies depending on the model type. For Flux LoRA, the default is
2890
+ * 0.0001.
2902
2891
  */
2903
2892
  learningRate?: number;
2904
2893
  /**
2905
2894
  * Initial learning rate (after the potential warmup period) for the text encoder
2906
2895
  *
2907
- * Maximum [Flux LoRA: 0.001] Default [SDXL: 0.00005 | Flux LoRA: 0.00001] Minimum
2908
- * [SDXL: 0 | Flux LoRA: 0.000001]
2896
+ * Maximum [Flux LoRA: 0.001] Default [Flux LoRA: 0.00001] Minimum [Flux LoRA:
2897
+ * 0.000001]
2909
2898
  */
2910
2899
  learningRateTextEncoder?: number;
2911
2900
  /**
2912
2901
  * Initial learning rate (after the potential warmup period) for the UNet
2913
2902
  *
2914
- * Only available for SDXL LoRA training
2903
+ * Deprecated legacy training parameter.
2915
2904
  */
2916
2905
  learningRateUnet?: number;
2917
2906
  /**
2918
2907
  * The scheduler type to use (default: "constant")
2919
2908
  *
2920
- * Only available for SD15 and SDXL LoRA training
2909
+ * Deprecated legacy training parameter.
2921
2910
  */
2922
2911
  lrScheduler?: 'constant' | 'constant-with-warmup' | 'cosine' | 'cosine-with-restarts' | 'linear' | 'polynomial';
2923
2912
  /**
2924
2913
  * Maximum number of training steps to execute (default: varies depending on the
2925
2914
  * model type)
2926
2915
  *
2927
- * For SDXL LoRA training, please use `numTextTrainSteps` and `numUNetTrainSteps`
2928
- * instead
2929
- *
2930
2916
  * Default value varies depending on the model type:
2931
2917
  *
2932
- * - For SD1.5: round((number of training images \* 225) / 3)
2933
- * - For SDXL: number of training images \* 175
2934
2918
  * - For Flux: number of training images \* 100
2935
2919
  *
2936
2920
  * Maximum value varies depending on the model type:
2937
2921
  *
2938
- * - For SD1.5 and SDXL: [0, 40000]
2939
2922
  * - For Flux: [0, 10000]
2940
2923
  */
2941
2924
  maxTrainSteps?: number;
@@ -2954,13 +2937,13 @@ export declare namespace TrainTriggerParams {
2954
2937
  /**
2955
2938
  * The number of training steps for the text encoder
2956
2939
  *
2957
- * Only available for SDXL LoRA training
2940
+ * Deprecated legacy training parameter.
2958
2941
  */
2959
2942
  numTextTrainSteps?: number;
2960
2943
  /**
2961
2944
  * The number of training steps for the UNet
2962
2945
  *
2963
- * Only available for SDXL LoRA training
2946
+ * Deprecated legacy training parameter.
2964
2947
  */
2965
2948
  numUNetTrainSteps?: number;
2966
2949
  /**
@@ -2981,36 +2964,35 @@ export declare namespace TrainTriggerParams {
2981
2964
  /**
2982
2965
  * The weight of prior preservation loss
2983
2966
  *
2984
- * Only available for SD15 and SDXL LoRA training
2967
+ * Deprecated legacy training parameter.
2985
2968
  */
2986
2969
  priorLossWeight?: number;
2987
2970
  /**
2988
2971
  * Whether to random crop or center crop images before resizing to the working
2989
2972
  * resolution
2990
2973
  *
2991
- * Only available for SD15 and SDXL LoRA training
2974
+ * Deprecated legacy training parameter.
2992
2975
  */
2993
2976
  randomCrop?: boolean;
2994
2977
  /**
2995
2978
  * Ratio of random crops
2996
2979
  *
2997
- * Only available for SD15 and SDXL LoRA training
2980
+ * Deprecated legacy training parameter.
2998
2981
  */
2999
2982
  randomCropRatio?: number;
3000
2983
  /**
3001
2984
  * Scale of random crops
3002
2985
  *
3003
- * Only available for SD15 and SDXL LoRA training
2986
+ * Deprecated legacy training parameter.
3004
2987
  */
3005
2988
  randomCropScale?: number;
3006
2989
  /**
3007
2990
  * The dimension of the LoRA update matrices
3008
2991
  *
3009
- * Only available for SDXL (deprecated), Flux LoRA and Musubi training
2992
+ * Only available for Flux LoRA and Musubi training
3010
2993
  *
3011
2994
  * Default value varies depending on the model type:
3012
2995
  *
3013
- * - For SDXL (deprecated): 64
3014
2996
  * - For Flux: 16
3015
2997
  * - For Musubi: 64
3016
2998
  *
@@ -3039,13 +3021,13 @@ export declare namespace TrainTriggerParams {
3039
3021
  *
3040
3022
  * Note: Legacy parameter, will be ignored
3041
3023
  *
3042
- * Only available for SD15 and SDXL LoRA training
3024
+ * Deprecated legacy training parameter.
3043
3025
  */
3044
3026
  scaleLr?: boolean;
3045
3027
  /**
3046
3028
  * Used to reproduce previous results. Default: randomly generated number.
3047
3029
  *
3048
- * Only available for SD15 and SDXL LoRA training
3030
+ * Deprecated legacy training parameter.
3049
3031
  */
3050
3032
  seed?: number;
3051
3033
  /**
@@ -3056,19 +3038,19 @@ export declare namespace TrainTriggerParams {
3056
3038
  *
3057
3039
  * Note: Legacy parameter, please use `numTextTrainSteps` and `numUNetTrainSteps`
3058
3040
  *
3059
- * Only available for SD15 and SDXL LoRA training
3041
+ * Deprecated legacy training parameter.
3060
3042
  */
3061
3043
  textEncoderTrainingRatio?: number;
3062
3044
  /**
3063
3045
  * Validation frequency. Cannot be greater than maxTrainSteps value
3064
3046
  *
3065
- * Only available for SD15 and SDXL LoRA training
3047
+ * Deprecated legacy training parameter.
3066
3048
  */
3067
3049
  validationFrequency?: number;
3068
3050
  /**
3069
3051
  * Validation prompt
3070
3052
  *
3071
- * Only available for SD15 and SDXL LoRA training
3053
+ * Deprecated legacy training parameter.
3072
3054
  */
3073
3055
  validationPrompt?: string;
3074
3056
  /**