@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.
Files changed (91) hide show
  1. package/CHANGELOG.md +28 -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 +3 -0
  7. package/lib/workflow_converter.d.mts.map +1 -1
  8. package/lib/workflow_converter.d.ts +3 -0
  9. package/lib/workflow_converter.d.ts.map +1 -1
  10. package/lib/workflow_converter.js +62 -34
  11. package/lib/workflow_converter.js.map +1 -1
  12. package/lib/workflow_converter.mjs +62 -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 +157 -51
  22. package/resources/generate.d.mts.map +1 -1
  23. package/resources/generate.d.ts +157 -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 +91 -35
  75. package/src/resources/assets/assets.ts +300 -62
  76. package/src/resources/generate.ts +157 -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
@@ -93,6 +93,7 @@ export namespace JobRetrieveResponse {
93
93
  | 'skybox-base-360'
94
94
  | 'skybox-hdri'
95
95
  | 'skybox-upscale-360'
96
+ | 'splat'
96
97
  | 'texture'
97
98
  | 'translate'
98
99
  | 'upload'
@@ -500,12 +501,6 @@ export namespace JobRetrieveResponse {
500
501
  | 'qwen-image-edit-2511-lora'
501
502
  | 'qwen-image-edit-lora'
502
503
  | 'qwen-image-lora'
503
- | 'sd-1_5'
504
- | 'sd-1_5-composition'
505
- | 'sd-1_5-lora'
506
- | 'sd-xl'
507
- | 'sd-xl-composition'
508
- | 'sd-xl-lora'
509
504
  | 'zimage-de-turbo-lora'
510
505
  | 'zimage-lora'
511
506
  | 'zimage-turbo-lora'
@@ -733,12 +728,6 @@ export namespace JobRetrieveResponse {
733
728
  | 'qwen-image-edit-2511-lora'
734
729
  | 'qwen-image-edit-lora'
735
730
  | 'qwen-image-lora'
736
- | 'sd-1_5'
737
- | 'sd-1_5-composition'
738
- | 'sd-1_5-lora'
739
- | 'sd-xl'
740
- | 'sd-xl-composition'
741
- | 'sd-xl-lora'
742
731
  | 'zimage-de-turbo-lora'
743
732
  | 'zimage-lora'
744
733
  | 'zimage-turbo-lora'
@@ -1004,6 +993,13 @@ export namespace JobRetrieveResponse {
1004
993
  cuCost: number;
1005
994
 
1006
995
  cuDiscount: number;
996
+
997
+ /**
998
+ * When true, the credits charged for this job are not automatically refunded if
999
+ * the generation fails, because the model used does not support refund-on-failure.
1000
+ * Absent or false means a failed generation is refunded as usual.
1001
+ */
1002
+ disableRefund?: boolean;
1007
1003
  }
1008
1004
  }
1009
1005
  }
@@ -1054,6 +1050,7 @@ export interface JobListResponse {
1054
1050
  | 'skybox-base-360'
1055
1051
  | 'skybox-hdri'
1056
1052
  | 'skybox-upscale-360'
1053
+ | 'splat'
1057
1054
  | 'texture'
1058
1055
  | 'translate'
1059
1056
  | 'upload'
@@ -1461,12 +1458,6 @@ export namespace JobListResponse {
1461
1458
  | 'qwen-image-edit-2511-lora'
1462
1459
  | 'qwen-image-edit-lora'
1463
1460
  | 'qwen-image-lora'
1464
- | 'sd-1_5'
1465
- | 'sd-1_5-composition'
1466
- | 'sd-1_5-lora'
1467
- | 'sd-xl'
1468
- | 'sd-xl-composition'
1469
- | 'sd-xl-lora'
1470
1461
  | 'zimage-de-turbo-lora'
1471
1462
  | 'zimage-lora'
1472
1463
  | 'zimage-turbo-lora'
@@ -1694,12 +1685,6 @@ export namespace JobListResponse {
1694
1685
  | 'qwen-image-edit-2511-lora'
1695
1686
  | 'qwen-image-edit-lora'
1696
1687
  | 'qwen-image-lora'
1697
- | 'sd-1_5'
1698
- | 'sd-1_5-composition'
1699
- | 'sd-1_5-lora'
1700
- | 'sd-xl'
1701
- | 'sd-xl-composition'
1702
- | 'sd-xl-lora'
1703
1688
  | 'zimage-de-turbo-lora'
1704
1689
  | 'zimage-lora'
1705
1690
  | 'zimage-turbo-lora'
@@ -1965,6 +1950,13 @@ export namespace JobListResponse {
1965
1950
  cuCost: number;
1966
1951
 
1967
1952
  cuDiscount: number;
1953
+
1954
+ /**
1955
+ * When true, the credits charged for this job are not automatically refunded if
1956
+ * the generation fails, because the model used does not support refund-on-failure.
1957
+ * Absent or false means a failed generation is refunded as usual.
1958
+ */
1959
+ disableRefund?: boolean;
1968
1960
  }
1969
1961
  }
1970
1962
 
@@ -2019,6 +2011,7 @@ export namespace JobTriggerActionResponse {
2019
2011
  | 'skybox-base-360'
2020
2012
  | 'skybox-hdri'
2021
2013
  | 'skybox-upscale-360'
2014
+ | 'splat'
2022
2015
  | 'texture'
2023
2016
  | 'translate'
2024
2017
  | 'upload'
@@ -2426,12 +2419,6 @@ export namespace JobTriggerActionResponse {
2426
2419
  | 'qwen-image-edit-2511-lora'
2427
2420
  | 'qwen-image-edit-lora'
2428
2421
  | 'qwen-image-lora'
2429
- | 'sd-1_5'
2430
- | 'sd-1_5-composition'
2431
- | 'sd-1_5-lora'
2432
- | 'sd-xl'
2433
- | 'sd-xl-composition'
2434
- | 'sd-xl-lora'
2435
2422
  | 'zimage-de-turbo-lora'
2436
2423
  | 'zimage-lora'
2437
2424
  | 'zimage-turbo-lora'
@@ -2659,12 +2646,6 @@ export namespace JobTriggerActionResponse {
2659
2646
  | 'qwen-image-edit-2511-lora'
2660
2647
  | 'qwen-image-edit-lora'
2661
2648
  | 'qwen-image-lora'
2662
- | 'sd-1_5'
2663
- | 'sd-1_5-composition'
2664
- | 'sd-1_5-lora'
2665
- | 'sd-xl'
2666
- | 'sd-xl-composition'
2667
- | 'sd-xl-lora'
2668
2649
  | 'zimage-de-turbo-lora'
2669
2650
  | 'zimage-lora'
2670
2651
  | 'zimage-turbo-lora'
@@ -2930,6 +2911,13 @@ export namespace JobTriggerActionResponse {
2930
2911
  cuCost: number;
2931
2912
 
2932
2913
  cuDiscount: number;
2914
+
2915
+ /**
2916
+ * When true, the credits charged for this job are not automatically refunded if
2917
+ * the generation fails, because the model used does not support refund-on-failure.
2918
+ * Absent or false means a failed generation is refunded as usual.
2919
+ */
2920
+ disableRefund?: boolean;
2933
2921
  }
2934
2922
  }
2935
2923
  }
@@ -3002,6 +2990,7 @@ export interface JobListParams extends JobsCursorParams {
3002
2990
  | 'openai-image-generation'
3003
2991
  | 'upload'
3004
2992
  | 'custom'
2993
+ | 'splat'
3005
2994
  | 'mesh-preview-rendering'
3006
2995
  | 'workflow';
3007
2996
 
@@ -3013,7 +3002,7 @@ export interface JobListParams extends JobsCursorParams {
3013
3002
  * image-prompt-editing, caption, generate-prompt, describe-style, translate,
3014
3003
  * detection, restyle, repaint, reframe, segment, skybox-base-360,
3015
3004
  * skybox-upscale-360, skybox-hdri, skybox-3d, texture, upscale, upscale-skybox,
3016
- * upscale-texture, flux, openai-image-generation, upload, custom,
3005
+ * upscale-texture, flux, openai-image-generation, upload, custom, splat,
3017
3006
  * mesh-preview-rendering, workflow. Optional.
3018
3007
  */
3019
3008
  types?: Array<
@@ -3050,6 +3039,7 @@ export interface JobListParams extends JobsCursorParams {
3050
3039
  | 'openai-image-generation'
3051
3040
  | 'upload'
3052
3041
  | 'custom'
3042
+ | 'splat'
3053
3043
  | 'mesh-preview-rendering'
3054
3044
  | 'workflow'
3055
3045
  >;
@@ -119,6 +119,7 @@ export namespace DescriptionRetrieveResponse {
119
119
  | 'image-prompt-editing'
120
120
  | 'img23d'
121
121
  | 'img2img'
122
+ | 'img2splat'
122
123
  | 'img2txt'
123
124
  | 'img2video'
124
125
  | 'inference-control-net'
@@ -230,6 +231,18 @@ export namespace DescriptionRetrieveResponse {
230
231
  */
231
232
  boneCount?: number;
232
233
 
234
+ /**
235
+ * Recommended preview camera mode emitted by the generator (gsplat route); passed
236
+ * through to mesh-rendering verbatim.
237
+ */
238
+ cameraMode?: 'aerial' | 'interior' | 'turntable';
239
+
240
+ /**
241
+ * Recommended preview camera path emitted by the generator (gsplat route); passed
242
+ * through to mesh-rendering verbatim.
243
+ */
244
+ cameraTrajectory?: Array<Properties.CameraTrajectory>;
245
+
233
246
  /**
234
247
  * Number of channels of the audio
235
248
  */
@@ -350,6 +363,28 @@ export namespace DescriptionRetrieveResponse {
350
363
  }
351
364
 
352
365
  export namespace Properties {
366
+ /**
367
+ * One explicit camera keyframe for the splat route. Several are interpolated over
368
+ * the requested frames into an orbit/fly-through; a single keyframe renders a
369
+ * static view. Overrides {@link SplatCameraMode} when provided.
370
+ */
371
+ export interface CameraTrajectory {
372
+ /**
373
+ * Camera eye position in the splat's world frame.
374
+ */
375
+ position: Array<unknown>;
376
+
377
+ /**
378
+ * Look-at point in the splat's world frame.
379
+ */
380
+ target: Array<unknown>;
381
+
382
+ /**
383
+ * Vertical field of view in degrees (defaults to 50 in the renderer).
384
+ */
385
+ fov?: number;
386
+ }
387
+
353
388
  /**
354
389
  * Transcription of the audio
355
390
  */
@@ -424,12 +459,6 @@ export namespace DescriptionRetrieveResponse {
424
459
  | 'qwen-image-edit-2511-lora'
425
460
  | 'qwen-image-edit-lora'
426
461
  | 'qwen-image-lora'
427
- | 'sd-1_5'
428
- | 'sd-1_5-composition'
429
- | 'sd-1_5-lora'
430
- | 'sd-xl'
431
- | 'sd-xl-composition'
432
- | 'sd-xl-lora'
433
462
  | 'zimage-de-turbo-lora'
434
463
  | 'zimage-lora'
435
464
  | 'zimage-turbo-lora';
@@ -543,6 +572,7 @@ export namespace DescriptionUpdateResponse {
543
572
  | 'image-prompt-editing'
544
573
  | 'img23d'
545
574
  | 'img2img'
575
+ | 'img2splat'
546
576
  | 'img2txt'
547
577
  | 'img2video'
548
578
  | 'inference-control-net'
@@ -654,6 +684,18 @@ export namespace DescriptionUpdateResponse {
654
684
  */
655
685
  boneCount?: number;
656
686
 
687
+ /**
688
+ * Recommended preview camera mode emitted by the generator (gsplat route); passed
689
+ * through to mesh-rendering verbatim.
690
+ */
691
+ cameraMode?: 'aerial' | 'interior' | 'turntable';
692
+
693
+ /**
694
+ * Recommended preview camera path emitted by the generator (gsplat route); passed
695
+ * through to mesh-rendering verbatim.
696
+ */
697
+ cameraTrajectory?: Array<Properties.CameraTrajectory>;
698
+
657
699
  /**
658
700
  * Number of channels of the audio
659
701
  */
@@ -774,6 +816,28 @@ export namespace DescriptionUpdateResponse {
774
816
  }
775
817
 
776
818
  export namespace Properties {
819
+ /**
820
+ * One explicit camera keyframe for the splat route. Several are interpolated over
821
+ * the requested frames into an orbit/fly-through; a single keyframe renders a
822
+ * static view. Overrides {@link SplatCameraMode} when provided.
823
+ */
824
+ export interface CameraTrajectory {
825
+ /**
826
+ * Camera eye position in the splat's world frame.
827
+ */
828
+ position: Array<unknown>;
829
+
830
+ /**
831
+ * Look-at point in the splat's world frame.
832
+ */
833
+ target: Array<unknown>;
834
+
835
+ /**
836
+ * Vertical field of view in degrees (defaults to 50 in the renderer).
837
+ */
838
+ fov?: number;
839
+ }
840
+
777
841
  /**
778
842
  * Transcription of the audio
779
843
  */
@@ -848,12 +912,6 @@ export namespace DescriptionUpdateResponse {
848
912
  | 'qwen-image-edit-2511-lora'
849
913
  | 'qwen-image-edit-lora'
850
914
  | 'qwen-image-lora'
851
- | 'sd-1_5'
852
- | 'sd-1_5-composition'
853
- | 'sd-1_5-lora'
854
- | 'sd-xl'
855
- | 'sd-xl-composition'
856
- | 'sd-xl-lora'
857
915
  | 'zimage-de-turbo-lora'
858
916
  | 'zimage-lora'
859
917
  | 'zimage-turbo-lora';
@@ -163,6 +163,7 @@ export namespace ExampleUpdateResponse {
163
163
  | 'image-prompt-editing'
164
164
  | 'img23d'
165
165
  | 'img2img'
166
+ | 'img2splat'
166
167
  | 'img2txt'
167
168
  | 'img2video'
168
169
  | 'inference-control-net'
@@ -352,6 +353,7 @@ export namespace ExampleUpdateResponse {
352
353
  | 'image-prompt-editing'
353
354
  | 'img23d'
354
355
  | 'img2img'
356
+ | 'img2splat'
355
357
  | 'img2txt'
356
358
  | 'img2video'
357
359
  | 'inference-controlnet'
@@ -696,12 +698,6 @@ export namespace ExampleUpdateResponse {
696
698
  | 'qwen-image-edit-2511-lora'
697
699
  | 'qwen-image-edit-lora'
698
700
  | 'qwen-image-lora'
699
- | 'sd-1_5'
700
- | 'sd-1_5-composition'
701
- | 'sd-1_5-lora'
702
- | 'sd-xl'
703
- | 'sd-xl-composition'
704
- | 'sd-xl-lora'
705
701
  | 'zimage-de-turbo-lora'
706
702
  | 'zimage-lora'
707
703
  | 'zimage-turbo-lora';
@@ -1038,6 +1034,18 @@ export namespace ExampleUpdateResponse {
1038
1034
  */
1039
1035
  boneCount?: number;
1040
1036
 
1037
+ /**
1038
+ * Recommended preview camera mode emitted by the generator (gsplat route); passed
1039
+ * through to mesh-rendering verbatim.
1040
+ */
1041
+ cameraMode?: 'aerial' | 'interior' | 'turntable';
1042
+
1043
+ /**
1044
+ * Recommended preview camera path emitted by the generator (gsplat route); passed
1045
+ * through to mesh-rendering verbatim.
1046
+ */
1047
+ cameraTrajectory?: Array<Properties.CameraTrajectory>;
1048
+
1041
1049
  /**
1042
1050
  * Number of channels of the audio
1043
1051
  */
@@ -1158,6 +1166,28 @@ export namespace ExampleUpdateResponse {
1158
1166
  }
1159
1167
 
1160
1168
  export namespace Properties {
1169
+ /**
1170
+ * One explicit camera keyframe for the splat route. Several are interpolated over
1171
+ * the requested frames into an orbit/fly-through; a single keyframe renders a
1172
+ * static view. Overrides {@link SplatCameraMode} when provided.
1173
+ */
1174
+ export interface CameraTrajectory {
1175
+ /**
1176
+ * Camera eye position in the splat's world frame.
1177
+ */
1178
+ position: Array<unknown>;
1179
+
1180
+ /**
1181
+ * Look-at point in the splat's world frame.
1182
+ */
1183
+ target: Array<unknown>;
1184
+
1185
+ /**
1186
+ * Vertical field of view in degrees (defaults to 50 in the renderer).
1187
+ */
1188
+ fov?: number;
1189
+ }
1190
+
1161
1191
  /**
1162
1192
  * Transcription of the audio
1163
1193
  */
@@ -1226,10 +1256,8 @@ export namespace ExampleUpdateResponse {
1226
1256
  *
1227
1257
  * Selecting the right type will condition the expected parameters.
1228
1258
  *
1229
- * Note: if model.type is `sd-xl*` or `sd-1_5*`, when using the `"inpaint"`
1230
- * inference type, Scenario determines the best available `baseModel` for a given
1231
- * `modelId`: one of `["stable-diffusion-inpainting",
1232
- * "stable-diffusion-xl-1.0-inpainting-0.1"] will be used.
1259
+ * Note: for inpainting with models that support multiple base models, Scenario
1260
+ * determines the best available `baseModel` for a given `modelId`.
1233
1261
  */
1234
1262
  type:
1235
1263
  | 'controlnet'
@@ -1339,17 +1367,13 @@ export namespace ExampleUpdateResponse {
1339
1367
  *
1340
1368
  * - For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
1341
1369
  * - For Flux pro models, the default is 3 and allowed values are within [2, 5]
1342
- * - For SDXL models, the default is 6 and allowed values are within [0, 20]
1343
- * - For SD1.5 models, the default is 7.5 and allowed values are within [0, 20]
1344
1370
  */
1345
1371
  guidance?: number;
1346
1372
 
1347
1373
  /**
1348
1374
  * The height of the generated images, must be a 8 multiple (within [64, 2048],
1349
- * default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the
1350
- * height must be within [512, 2048] If model.type is `sd-1_5`, the height must be
1351
- * within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the
1352
- * aspectRatio parameter instead
1375
+ * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
1376
+ * parameter instead
1353
1377
  */
1354
1378
  height?: number;
1355
1379
 
@@ -1424,18 +1448,6 @@ export namespace ExampleUpdateResponse {
1424
1448
  * The modality associated with the control image used for the generation: it can
1425
1449
  * either be an object with a combination of maximum
1426
1450
  *
1427
- * For models of SD1.5 family:
1428
- *
1429
- * - up to 3 modalities from `canny`, `pose`, `depth`, `lines`, `seg`, `scribble`,
1430
- * `lineart`, `normal-map`, `illusion`
1431
- * - or one of the following presets: `character`, `landscape`, `city`, `interior`.
1432
- *
1433
- * For models of the SDXL family:
1434
- *
1435
- * - up to 3 modalities from `canny`, `pose`, `depth`, `seg`, `illusion`,
1436
- * `scribble`
1437
- * - or one of the following presets: `character`, `landscape`.
1438
- *
1439
1451
  * For models of the FLUX schnell or dev families:
1440
1452
  *
1441
1453
  * - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`,
@@ -1545,10 +1557,8 @@ export namespace ExampleUpdateResponse {
1545
1557
 
1546
1558
  /**
1547
1559
  * The width of the generated images, must be a 8 multiple (within [64, 2048],
1548
- * default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the
1549
- * width must be within [512, 2048] If model.type is `sd-1_5`, the width must be
1550
- * within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the
1551
- * aspectRatio parameter instead
1560
+ * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
1561
+ * parameter instead
1552
1562
  */
1553
1563
  width?: number;
1554
1564
  }
@@ -1623,6 +1633,7 @@ export namespace ExampleUpdateResponse {
1623
1633
  | 'skybox-base-360'
1624
1634
  | 'skybox-hdri'
1625
1635
  | 'skybox-upscale-360'
1636
+ | 'splat'
1626
1637
  | 'texture'
1627
1638
  | 'translate'
1628
1639
  | 'upload'
@@ -2030,12 +2041,6 @@ export namespace ExampleUpdateResponse {
2030
2041
  | 'qwen-image-edit-2511-lora'
2031
2042
  | 'qwen-image-edit-lora'
2032
2043
  | 'qwen-image-lora'
2033
- | 'sd-1_5'
2034
- | 'sd-1_5-composition'
2035
- | 'sd-1_5-lora'
2036
- | 'sd-xl'
2037
- | 'sd-xl-composition'
2038
- | 'sd-xl-lora'
2039
2044
  | 'zimage-de-turbo-lora'
2040
2045
  | 'zimage-lora'
2041
2046
  | 'zimage-turbo-lora'
@@ -2263,12 +2268,6 @@ export namespace ExampleUpdateResponse {
2263
2268
  | 'qwen-image-edit-2511-lora'
2264
2269
  | 'qwen-image-edit-lora'
2265
2270
  | 'qwen-image-lora'
2266
- | 'sd-1_5'
2267
- | 'sd-1_5-composition'
2268
- | 'sd-1_5-lora'
2269
- | 'sd-xl'
2270
- | 'sd-xl-composition'
2271
- | 'sd-xl-lora'
2272
2271
  | 'zimage-de-turbo-lora'
2273
2272
  | 'zimage-lora'
2274
2273
  | 'zimage-turbo-lora'
@@ -2534,6 +2533,13 @@ export namespace ExampleUpdateResponse {
2534
2533
  cuCost: number;
2535
2534
 
2536
2535
  cuDiscount: number;
2536
+
2537
+ /**
2538
+ * When true, the credits charged for this job are not automatically refunded if
2539
+ * the generation fails, because the model used does not support refund-on-failure.
2540
+ * Absent or false means a failed generation is refunded as usual.
2541
+ */
2542
+ disableRefund?: boolean;
2537
2543
  }
2538
2544
  }
2539
2545
  }
@@ -2668,6 +2674,7 @@ export namespace ExampleListResponse {
2668
2674
  | 'image-prompt-editing'
2669
2675
  | 'img23d'
2670
2676
  | 'img2img'
2677
+ | 'img2splat'
2671
2678
  | 'img2txt'
2672
2679
  | 'img2video'
2673
2680
  | 'inference-control-net'
@@ -2857,6 +2864,7 @@ export namespace ExampleListResponse {
2857
2864
  | 'image-prompt-editing'
2858
2865
  | 'img23d'
2859
2866
  | 'img2img'
2867
+ | 'img2splat'
2860
2868
  | 'img2txt'
2861
2869
  | 'img2video'
2862
2870
  | 'inference-controlnet'
@@ -3201,12 +3209,6 @@ export namespace ExampleListResponse {
3201
3209
  | 'qwen-image-edit-2511-lora'
3202
3210
  | 'qwen-image-edit-lora'
3203
3211
  | 'qwen-image-lora'
3204
- | 'sd-1_5'
3205
- | 'sd-1_5-composition'
3206
- | 'sd-1_5-lora'
3207
- | 'sd-xl'
3208
- | 'sd-xl-composition'
3209
- | 'sd-xl-lora'
3210
3212
  | 'zimage-de-turbo-lora'
3211
3213
  | 'zimage-lora'
3212
3214
  | 'zimage-turbo-lora';
@@ -3543,6 +3545,18 @@ export namespace ExampleListResponse {
3543
3545
  */
3544
3546
  boneCount?: number;
3545
3547
 
3548
+ /**
3549
+ * Recommended preview camera mode emitted by the generator (gsplat route); passed
3550
+ * through to mesh-rendering verbatim.
3551
+ */
3552
+ cameraMode?: 'aerial' | 'interior' | 'turntable';
3553
+
3554
+ /**
3555
+ * Recommended preview camera path emitted by the generator (gsplat route); passed
3556
+ * through to mesh-rendering verbatim.
3557
+ */
3558
+ cameraTrajectory?: Array<Properties.CameraTrajectory>;
3559
+
3546
3560
  /**
3547
3561
  * Number of channels of the audio
3548
3562
  */
@@ -3663,6 +3677,28 @@ export namespace ExampleListResponse {
3663
3677
  }
3664
3678
 
3665
3679
  export namespace Properties {
3680
+ /**
3681
+ * One explicit camera keyframe for the splat route. Several are interpolated over
3682
+ * the requested frames into an orbit/fly-through; a single keyframe renders a
3683
+ * static view. Overrides {@link SplatCameraMode} when provided.
3684
+ */
3685
+ export interface CameraTrajectory {
3686
+ /**
3687
+ * Camera eye position in the splat's world frame.
3688
+ */
3689
+ position: Array<unknown>;
3690
+
3691
+ /**
3692
+ * Look-at point in the splat's world frame.
3693
+ */
3694
+ target: Array<unknown>;
3695
+
3696
+ /**
3697
+ * Vertical field of view in degrees (defaults to 50 in the renderer).
3698
+ */
3699
+ fov?: number;
3700
+ }
3701
+
3666
3702
  /**
3667
3703
  * Transcription of the audio
3668
3704
  */
@@ -3731,10 +3767,8 @@ export namespace ExampleListResponse {
3731
3767
  *
3732
3768
  * Selecting the right type will condition the expected parameters.
3733
3769
  *
3734
- * Note: if model.type is `sd-xl*` or `sd-1_5*`, when using the `"inpaint"`
3735
- * inference type, Scenario determines the best available `baseModel` for a given
3736
- * `modelId`: one of `["stable-diffusion-inpainting",
3737
- * "stable-diffusion-xl-1.0-inpainting-0.1"] will be used.
3770
+ * Note: for inpainting with models that support multiple base models, Scenario
3771
+ * determines the best available `baseModel` for a given `modelId`.
3738
3772
  */
3739
3773
  type:
3740
3774
  | 'controlnet'
@@ -3844,17 +3878,13 @@ export namespace ExampleListResponse {
3844
3878
  *
3845
3879
  * - For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
3846
3880
  * - For Flux pro models, the default is 3 and allowed values are within [2, 5]
3847
- * - For SDXL models, the default is 6 and allowed values are within [0, 20]
3848
- * - For SD1.5 models, the default is 7.5 and allowed values are within [0, 20]
3849
3881
  */
3850
3882
  guidance?: number;
3851
3883
 
3852
3884
  /**
3853
3885
  * The height of the generated images, must be a 8 multiple (within [64, 2048],
3854
- * default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the
3855
- * height must be within [512, 2048] If model.type is `sd-1_5`, the height must be
3856
- * within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the
3857
- * aspectRatio parameter instead
3886
+ * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
3887
+ * parameter instead
3858
3888
  */
3859
3889
  height?: number;
3860
3890
 
@@ -3929,18 +3959,6 @@ export namespace ExampleListResponse {
3929
3959
  * The modality associated with the control image used for the generation: it can
3930
3960
  * either be an object with a combination of maximum
3931
3961
  *
3932
- * For models of SD1.5 family:
3933
- *
3934
- * - up to 3 modalities from `canny`, `pose`, `depth`, `lines`, `seg`, `scribble`,
3935
- * `lineart`, `normal-map`, `illusion`
3936
- * - or one of the following presets: `character`, `landscape`, `city`, `interior`.
3937
- *
3938
- * For models of the SDXL family:
3939
- *
3940
- * - up to 3 modalities from `canny`, `pose`, `depth`, `seg`, `illusion`,
3941
- * `scribble`
3942
- * - or one of the following presets: `character`, `landscape`.
3943
- *
3944
3962
  * For models of the FLUX schnell or dev families:
3945
3963
  *
3946
3964
  * - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`,
@@ -4050,10 +4068,8 @@ export namespace ExampleListResponse {
4050
4068
 
4051
4069
  /**
4052
4070
  * The width of the generated images, must be a 8 multiple (within [64, 2048],
4053
- * default: 512) If model.type is `sd-xl`, `sd-xl-lora`, `sd-xl-composition` the
4054
- * width must be within [512, 2048] If model.type is `sd-1_5`, the width must be
4055
- * within [64, 1024] If model.type is `flux.1.1-pro-ultra`, you can use the
4056
- * aspectRatio parameter instead
4071
+ * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
4072
+ * parameter instead
4057
4073
  */
4058
4074
  width?: number;
4059
4075
  }
@@ -4128,6 +4144,7 @@ export namespace ExampleListResponse {
4128
4144
  | 'skybox-base-360'
4129
4145
  | 'skybox-hdri'
4130
4146
  | 'skybox-upscale-360'
4147
+ | 'splat'
4131
4148
  | 'texture'
4132
4149
  | 'translate'
4133
4150
  | 'upload'
@@ -4535,12 +4552,6 @@ export namespace ExampleListResponse {
4535
4552
  | 'qwen-image-edit-2511-lora'
4536
4553
  | 'qwen-image-edit-lora'
4537
4554
  | 'qwen-image-lora'
4538
- | 'sd-1_5'
4539
- | 'sd-1_5-composition'
4540
- | 'sd-1_5-lora'
4541
- | 'sd-xl'
4542
- | 'sd-xl-composition'
4543
- | 'sd-xl-lora'
4544
4555
  | 'zimage-de-turbo-lora'
4545
4556
  | 'zimage-lora'
4546
4557
  | 'zimage-turbo-lora'
@@ -4768,12 +4779,6 @@ export namespace ExampleListResponse {
4768
4779
  | 'qwen-image-edit-2511-lora'
4769
4780
  | 'qwen-image-edit-lora'
4770
4781
  | 'qwen-image-lora'
4771
- | 'sd-1_5'
4772
- | 'sd-1_5-composition'
4773
- | 'sd-1_5-lora'
4774
- | 'sd-xl'
4775
- | 'sd-xl-composition'
4776
- | 'sd-xl-lora'
4777
4782
  | 'zimage-de-turbo-lora'
4778
4783
  | 'zimage-lora'
4779
4784
  | 'zimage-turbo-lora'
@@ -5039,6 +5044,13 @@ export namespace ExampleListResponse {
5039
5044
  cuCost: number;
5040
5045
 
5041
5046
  cuDiscount: number;
5047
+
5048
+ /**
5049
+ * When true, the credits charged for this job are not automatically refunded if
5050
+ * the generation fails, because the model used does not support refund-on-failure.
5051
+ * Absent or false means a failed generation is refunded as usual.
5052
+ */
5053
+ disableRefund?: boolean;
5042
5054
  }
5043
5055
  }
5044
5056
  }