@scenario-labs/sdk 2.4.0 → 2.5.0

package/src/resources/assets/assets.ts

@@ -245,6 +245,7 @@ export namespace AssetRetrieveResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -434,6 +435,7 @@ export namespace AssetRetrieveResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -778,12 +780,6 @@ export namespace AssetRetrieveResponse {
         | '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';
@@ -1120,6 +1116,18 @@ export namespace AssetRetrieveResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -1240,6 +1248,28 @@ export namespace AssetRetrieveResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -1392,6 +1422,7 @@ export namespace AssetUpdateResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -1581,6 +1612,7 @@ export namespace AssetUpdateResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -1925,12 +1957,6 @@ export namespace AssetUpdateResponse {
         | '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';
@@ -2267,6 +2293,18 @@ export namespace AssetUpdateResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -2387,6 +2425,28 @@ export namespace AssetUpdateResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -2534,6 +2594,7 @@ export interface AssetListResponse {
     | 'image-prompt-editing'
     | 'img23d'
     | 'img2img'
+    | 'img2splat'
     | 'img2txt'
     | 'img2video'
     | 'inference-control-net'
@@ -2723,6 +2784,7 @@ export namespace AssetListResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-controlnet'
@@ -3067,12 +3129,6 @@ export namespace AssetListResponse {
       | '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';
@@ -3409,6 +3465,18 @@ export namespace AssetListResponse {
      */
     boneCount?: number;
 
+    /**
+     * Recommended preview camera mode emitted by the generator (gsplat route); passed
+     * through to mesh-rendering verbatim.
+     */
+    cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+    /**
+     * Recommended preview camera path emitted by the generator (gsplat route); passed
+     * through to mesh-rendering verbatim.
+     */
+    cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
     /**
      * Number of channels of the audio
      */
@@ -3529,6 +3597,28 @@ export namespace AssetListResponse {
   }
 
   export namespace Properties {
+    /**
+     * One explicit camera keyframe for the splat route. Several are interpolated over
+     * the requested frames into an orbit/fly-through; a single keyframe renders a
+     * static view. Overrides {@link SplatCameraMode} when provided.
+     */
+    export interface CameraTrajectory {
+      /**
+       * Camera eye position in the splat's world frame.
+       */
+      position: Array<unknown>;
+
+      /**
+       * Look-at point in the splat's world frame.
+       */
+      target: Array<unknown>;
+
+      /**
+       * Vertical field of view in degrees (defaults to 50 in the renderer).
+       */
+      fov?: number;
+    }
+
     /**
      * Transcription of the audio
      */
@@ -3682,6 +3772,7 @@ export namespace AssetDuplicateResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -3871,6 +3962,7 @@ export namespace AssetDuplicateResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -4215,12 +4307,6 @@ export namespace AssetDuplicateResponse {
         | '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';
@@ -4557,6 +4643,18 @@ export namespace AssetDuplicateResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -4677,6 +4775,28 @@ export namespace AssetDuplicateResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -4829,6 +4949,7 @@ export namespace AssetGetBulkResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -5018,6 +5139,7 @@ export namespace AssetGetBulkResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -5362,12 +5484,6 @@ export namespace AssetGetBulkResponse {
         | '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';
@@ -5704,6 +5820,18 @@ export namespace AssetGetBulkResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -5824,6 +5952,28 @@ export namespace AssetGetBulkResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -5991,6 +6141,7 @@ export namespace AssetLockResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -6180,6 +6331,7 @@ export namespace AssetLockResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -6524,12 +6676,6 @@ export namespace AssetLockResponse {
         | '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';
@@ -6866,6 +7012,18 @@ export namespace AssetLockResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -6986,6 +7144,28 @@ export namespace AssetLockResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -7138,6 +7318,7 @@ export namespace AssetUnlockResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -7327,6 +7508,7 @@ export namespace AssetUnlockResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -7671,12 +7853,6 @@ export namespace AssetUnlockResponse {
         | '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';
@@ -8013,6 +8189,18 @@ export namespace AssetUnlockResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -8133,6 +8321,28 @@ export namespace AssetUnlockResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -8299,6 +8509,7 @@ export namespace AssetUploadResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -8488,6 +8699,7 @@ export namespace AssetUploadResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -8832,12 +9044,6 @@ export namespace AssetUploadResponse {
         | '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';
@@ -9174,6 +9380,18 @@ export namespace AssetUploadResponse {
        */
       boneCount?: number;
 
+      /**
+       * Recommended preview camera mode emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraMode?: 'aerial' | 'interior' | 'turntable';
+
+      /**
+       * Recommended preview camera path emitted by the generator (gsplat route); passed
+       * through to mesh-rendering verbatim.
+       */
+      cameraTrajectory?: Array<Properties.CameraTrajectory>;
+
       /**
        * Number of channels of the audio
        */
@@ -9294,6 +9512,28 @@ export namespace AssetUploadResponse {
     }
 
     export namespace Properties {
+      /**
+       * One explicit camera keyframe for the splat route. Several are interpolated over
+       * the requested frames into an orbit/fly-through; a single keyframe renders a
+       * static view. Overrides {@link SplatCameraMode} when provided.
+       */
+      export interface CameraTrajectory {
+        /**
+         * Camera eye position in the splat's world frame.
+         */
+        position: Array<unknown>;
+
+        /**
+         * Look-at point in the splat's world frame.
+         */
+        target: Array<unknown>;
+
+        /**
+         * Vertical field of view in degrees (defaults to 50 in the renderer).
+         */
+        fov?: number;
+      }
+
       /**
        * Transcription of the audio
        */
@@ -9393,6 +9633,7 @@ export namespace AssetUploadResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -9800,12 +10041,6 @@ export namespace AssetUploadResponse {
             | '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'
@@ -10033,12 +10268,6 @@ export namespace AssetUploadResponse {
               | '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'
@@ -10304,6 +10533,13 @@ export namespace AssetUploadResponse {
       cuCost: number;
 
       cuDiscount: number;
+
+      /**
+       * When true, the credits charged for this job are not automatically refunded if
+       * the generation fails, because the model used does not support refund-on-failure.
+       * Absent or false means a failed generation is refunded as usual.
+       */
+      disableRefund?: boolean;
     }
   }
 }
@@ -10450,7 +10686,7 @@ export interface AssetListParams extends AssetsCursorParams {
    * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
    * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
    * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
-   * txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl,
+   * txt23d, video23d, 3d23d, img2splat, 3d23d-texture, 3d-texture, 3d-texture-mtl,
    * 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
    * img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
    * video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
@@ -10510,6 +10746,7 @@ export interface AssetListParams extends AssetsCursorParams {
     | 'txt23d'
     | 'video23d'
     | '3d23d'
+    | 'img2splat'
     | '3d23d-texture'
     | '3d-texture'
     | '3d-texture-mtl'
@@ -10554,7 +10791,7 @@ export interface AssetListParams extends AssetsCursorParams {
    * skybox-base-360, skybox-hdri, skybox-3d, restyle, reframe, generative-fill,
    * texture, texture-height, texture-normal, texture-smoothness, texture-metallic,
    * texture-edge, texture-ao, texture-albedo, image-prompt-editing, unknown, img23d,
-   * txt23d, video23d, 3d23d, 3d23d-texture, 3d-texture, 3d-texture-mtl,
+   * txt23d, video23d, 3d23d, img2splat, 3d23d-texture, 3d-texture, 3d-texture-mtl,
    * 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
    * img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
    * video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
@@ -10613,6 +10850,7 @@ export interface AssetListParams extends AssetsCursorParams {
     | 'txt23d'
     | 'video23d'
     | '3d23d'
+    | 'img2splat'
     | '3d23d-texture'
     | '3d-texture'
     | '3d-texture-mtl'