@scenario-labs/sdk 2.4.0 → 2.6.0

package/src/resources/generate.ts

@@ -59,13 +59,9 @@ export class Generate extends APIResource {
   }
 
   /**
-   * Generate with any model (Image, Video, Audio, 3d).
+   * Generate with any model (Image, Video, Audio, 3d, Text).
    *
    * You can retrieve the model inputs from the `GET /models/{modelId}` endpoint.
-   *
-   * **Note**: This endpoint is not available yet for SD1.5, SDXL and Flux.1 based
-   * models. For these models, use the `POST /generate/{inferenceType}` endpoint. Ex:
-   * `POST /generate/txt2img`
    */
   runModel(
     modelID: string,
@@ -101,12 +97,12 @@ export interface GenerateCaptionResponse {
   job: GenerateCaptionResponse.Job;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -171,6 +167,7 @@ export namespace GenerateCaptionResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -578,12 +575,6 @@ export namespace GenerateCaptionResponse {
             | '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'
@@ -811,12 +802,6 @@ export namespace GenerateCaptionResponse {
               | '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'
@@ -1082,6 +1067,13 @@ export namespace GenerateCaptionResponse {
       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;
     }
   }
 
@@ -1178,12 +1170,12 @@ export interface GenerateDescribeStyleResponse {
   synthesis: string;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -1240,6 +1232,7 @@ export namespace GenerateDescribeStyleResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -1647,12 +1640,6 @@ export namespace GenerateDescribeStyleResponse {
             | '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'
@@ -1880,12 +1867,6 @@ export namespace GenerateDescribeStyleResponse {
               | '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'
@@ -2151,6 +2132,13 @@ export namespace GenerateDescribeStyleResponse {
       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;
     }
   }
 
@@ -2239,12 +2227,12 @@ export interface GenerateDetectResponse {
   asset?: GenerateDetectResponse.Asset;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -2301,6 +2289,7 @@ export namespace GenerateDetectResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -2708,12 +2697,6 @@ export namespace GenerateDetectResponse {
             | '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'
@@ -2941,12 +2924,6 @@ export namespace GenerateDetectResponse {
               | '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'
@@ -3212,6 +3189,13 @@ export namespace GenerateDetectResponse {
       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;
     }
   }
 
@@ -3308,6 +3292,7 @@ export namespace GenerateDetectResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -3497,6 +3482,7 @@ export namespace GenerateDetectResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -3841,12 +3827,6 @@ export namespace GenerateDetectResponse {
         | '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';
@@ -4183,6 +4163,18 @@ export namespace GenerateDetectResponse {
        */
       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
        */
@@ -4303,6 +4295,28 @@ export namespace GenerateDetectResponse {
     }
 
     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
        */
@@ -4446,12 +4460,12 @@ export interface GenerateEmbedResponse {
   job: GenerateEmbedResponse.Job;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -4508,6 +4522,7 @@ export namespace GenerateEmbedResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -4915,12 +4930,6 @@ export namespace GenerateEmbedResponse {
             | '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'
@@ -5148,12 +5157,6 @@ export namespace GenerateEmbedResponse {
               | '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'
@@ -5419,6 +5422,13 @@ export namespace GenerateEmbedResponse {
       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;
     }
   }
 
@@ -5507,12 +5517,12 @@ export interface GeneratePatchResponse {
   asset?: GeneratePatchResponse.Asset;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -5569,6 +5579,7 @@ export namespace GeneratePatchResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -5976,12 +5987,6 @@ export namespace GeneratePatchResponse {
             | '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'
@@ -6209,12 +6214,6 @@ export namespace GeneratePatchResponse {
               | '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'
@@ -6480,6 +6479,13 @@ export namespace GeneratePatchResponse {
       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;
     }
   }
 
@@ -6576,6 +6582,7 @@ export namespace GeneratePatchResponse {
       | 'image-prompt-editing'
       | 'img23d'
       | 'img2img'
+      | 'img2splat'
       | 'img2txt'
       | 'img2video'
       | 'inference-control-net'
@@ -6765,6 +6772,7 @@ export namespace GeneratePatchResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2splat'
         | 'img2txt'
         | 'img2video'
         | 'inference-controlnet'
@@ -7109,12 +7117,6 @@ export namespace GeneratePatchResponse {
         | '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';
@@ -7451,6 +7453,18 @@ export namespace GeneratePatchResponse {
        */
       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
        */
@@ -7571,6 +7585,28 @@ export namespace GeneratePatchResponse {
     }
 
     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
        */
@@ -7718,12 +7754,12 @@ export interface GeneratePromptResponse {
   calls?: Array<GeneratePromptResponse.Call>;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -7785,6 +7821,7 @@ export namespace GeneratePromptResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -8192,12 +8229,6 @@ export namespace GeneratePromptResponse {
             | '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'
@@ -8425,12 +8456,6 @@ export namespace GeneratePromptResponse {
               | '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'
@@ -8696,6 +8721,13 @@ export namespace GeneratePromptResponse {
       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;
     }
   }
 
@@ -8806,12 +8838,12 @@ export interface GenerateRunModelResponse {
   job: GenerateRunModelResponse.Job;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -8868,6 +8900,7 @@ export namespace GenerateRunModelResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -9275,12 +9308,6 @@ export namespace GenerateRunModelResponse {
             | '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'
@@ -9508,12 +9535,6 @@ export namespace GenerateRunModelResponse {
               | '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'
@@ -9779,6 +9800,13 @@ export namespace GenerateRunModelResponse {
       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;
     }
   }
 
@@ -9875,12 +9903,12 @@ export interface GenerateTranslateResponse {
   translation: string;
 
   /**
-   * The Creative Units cost for the request billed
+   * The Compute Units cost for the request billed
    */
   creativeUnitsCost?: number;
 
   /**
-   * The Creative Units discount for the request billed
+   * The Compute Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
 
@@ -9937,6 +9965,7 @@ export namespace GenerateTranslateResponse {
       | 'skybox-base-360'
       | 'skybox-hdri'
       | 'skybox-upscale-360'
+      | 'splat'
       | 'texture'
       | 'translate'
       | 'upload'
@@ -10344,12 +10373,6 @@ export namespace GenerateTranslateResponse {
             | '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'
@@ -10577,12 +10600,6 @@ export namespace GenerateTranslateResponse {
               | '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'
@@ -10848,6 +10865,13 @@ export namespace GenerateTranslateResponse {
       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;
     }
   }
 
@@ -11321,11 +11345,17 @@ export interface GeneratePromptParams {
    * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
    * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
    *
+   * A referenced asset ID may point to an image or a video. A video is used for
+   * visual conditioning via its first and last frames (a single frame when only one
+   * is available) and stays a single reference.
+   *
    * Notes:
    *
    * - in `contextual` mode, images condition prompt generation by using their actual
    *   descriptions as context
    * - in all other modes, it supersedes the `modelId` parameter when provided.
+   * - `contextual-v2` (and modes aliased to it) accepts up to 15 references; the
+   *   other modes accept up to 5.
    */
   images?: Array<string>;
 

package/src/resources/index.ts

@@ -126,9 +126,9 @@ export {
   type WorkflowCreateParams,
   type WorkflowUpdateParams,
   type WorkflowListParams,
-  type WorkflowApproveUserParams,
   type WorkflowGetTagsParams,
   type WorkflowRunParams,
   type WorkflowUserApprovalParams,
+  type WorkflowApproveUserParams,
   type WorkflowListResponsesWorkflowsCursor,
 } from './workflows';