@scenario-labs/sdk 2.1.0 → 2.2.0

package/src/resources/models/models.ts

@@ -184,6 +184,7 @@ export namespace ModelCreateResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -540,7 +541,7 @@ export namespace ModelCreateResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -620,7 +621,7 @@ export namespace ModelCreateResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -1489,6 +1490,7 @@ export namespace ModelRetrieveResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -1845,7 +1847,7 @@ export namespace ModelRetrieveResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -1925,7 +1927,7 @@ export namespace ModelRetrieveResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -2794,6 +2796,7 @@ export namespace ModelUpdateResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -3150,7 +3153,7 @@ export namespace ModelUpdateResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -3230,7 +3233,7 @@ export namespace ModelUpdateResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -4094,6 +4097,7 @@ export interface ModelListResponse {
   capabilities: Array<
     | '3d23d'
     | 'audio2audio'
+    | 'audio2txt'
     | 'audio2video'
     | 'controlnet'
     | 'controlnet_img2img'
@@ -4450,7 +4454,7 @@ export namespace ModelListResponse {
    * Defines the input parameters for a model. Use this to understand the available
    * input parameters for a given `modelId` when calling
    * `POST /generate/custom/{modelId}`. See {@link
-   * https://docs.scenario.com/docs/video-generation} for examples.
+   * https://docs.scenario.com/get-started/generation/video-generation} for examples.
    */
   export interface Input {
     /**
@@ -4530,7 +4534,7 @@ export namespace ModelListResponse {
      * not able to create the asset on the flight on API side with dataurl without
      * data:kind, prefix
      */
-    kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+    kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
     /**
      * The label displayed in the UI for this input
@@ -5400,6 +5404,7 @@ export namespace ModelCopyResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -5756,7 +5761,7 @@ export namespace ModelCopyResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -5836,7 +5841,7 @@ export namespace ModelCopyResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -6772,6 +6777,7 @@ export namespace ModelGetBulkResponse {
     capabilities?: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -7070,7 +7076,7 @@ export namespace ModelGetBulkResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -7150,7 +7156,7 @@ export namespace ModelGetBulkResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -8019,6 +8025,7 @@ export namespace ModelTransferResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -8375,7 +8382,7 @@ export namespace ModelTransferResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -8455,7 +8462,7 @@ export namespace ModelTransferResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input

package/src/resources/models/train.ts

@@ -57,6 +57,7 @@ export namespace TrainActionResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -413,7 +414,7 @@ export namespace TrainActionResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -493,7 +494,7 @@ export namespace TrainActionResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input
@@ -1732,7 +1733,7 @@ export namespace TrainTriggerResponse {
            * not able to create the asset on the flight on API side with dataurl without
            * data:kind, prefix
            */
-          kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+          kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
           /**
            * The label displayed in the UI for this input
@@ -1965,7 +1966,7 @@ export namespace TrainTriggerResponse {
              * not able to create the asset on the flight on API side with dataurl without
              * data:kind, prefix
              */
-            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
             /**
              * The label displayed in the UI for this input
@@ -2334,6 +2335,7 @@ export namespace TrainTriggerResponse {
     capabilities: Array<
       | '3d23d'
       | 'audio2audio'
+      | 'audio2txt'
       | 'audio2video'
       | 'controlnet'
       | 'controlnet_img2img'
@@ -2690,7 +2692,7 @@ export namespace TrainTriggerResponse {
      * Defines the input parameters for a model. Use this to understand the available
      * input parameters for a given `modelId` when calling
      * `POST /generate/custom/{modelId}`. See {@link
-     * https://docs.scenario.com/docs/video-generation} for examples.
+     * https://docs.scenario.com/get-started/generation/video-generation} for examples.
      */
     export interface Input {
       /**
@@ -2770,7 +2772,7 @@ export namespace TrainTriggerResponse {
        * not able to create the asset on the flight on API side with dataurl without
        * data:kind, prefix
        */
-      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * The label displayed in the UI for this input

package/src/resources/search.ts

@@ -116,6 +116,13 @@ export interface SearchAssetSearchResponse {
    */
   url: string;
 
+  /**
+   * Indexed body for text assets (`AssetKind.Text`). The full content lives in S3;
+   * this field carries up to TEXT_INDEX_MAX_BYTES of UTF-8 for BM25 lookup. Always
+   * undefined for non-text assets.
+   */
+  content?: string;
+
   /**
    * Textual description of the asset. Can be either:
    *

package/src/resources/uploads.ts

@@ -50,7 +50,7 @@ export namespace UploadCreateResponse {
     /**
      * The kind of the file once validated (example: "model")
      */
-    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'text' | 'video';
 
     ownerId: string;
 
@@ -130,7 +130,7 @@ export namespace UploadRetrieveResponse {
     /**
      * The kind of the file once validated (example: "model")
      */
-    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'text' | 'video';
 
     ownerId: string;
 
@@ -210,7 +210,7 @@ export namespace UploadTriggerActionResponse {
     /**
      * The kind of the file once validated (example: "model")
      */
-    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'text' | 'video';
 
     ownerId: string;
 
@@ -313,7 +313,7 @@ export interface UploadCreateParams {
    * Required for multipart upload and url. The purpose of the file once validated
    * (example: "model")
    */
-  kind?: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+  kind?: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'text' | 'video';
 
   /**
    * Required for multipart upload. The number of parts the file will be uploaded in

package/src/resources/usages.ts

@@ -223,7 +223,7 @@ export namespace UsageListResponse {
   }
 
   export interface AssetUsage {
-    kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+    kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
     /**
      * The data points
@@ -299,7 +299,7 @@ export namespace UsageListResponse {
       /**
        * The kind of the asset
        */
-      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+      kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
       /**
        * Partial metadata of the asset
@@ -324,6 +324,7 @@ export namespace UsageListResponse {
         | '3d:texture:normal'
         | '3d:texture:roughness'
         | 'audio2audio'
+        | 'audio2txt'
         | 'audio2video'
         | 'background-removal'
         | 'canvas'
@@ -334,6 +335,7 @@ export namespace UsageListResponse {
         | 'image-prompt-editing'
         | 'img23d'
         | 'img2img'
+        | 'img2txt'
         | 'img2video'
         | 'inference-control-net'
         | 'inference-control-net-img'
@@ -373,12 +375,14 @@ export namespace UsageListResponse {
         | 'txt23d'
         | 'txt2audio'
         | 'txt2img'
+        | 'txt2txt'
         | 'txt2video'
         | 'unknown'
         | 'uploaded'
         | 'uploaded-3d'
         | 'uploaded-audio'
         | 'uploaded-avatar'
+        | 'uploaded-text'
         | 'uploaded-video'
         | 'upscale'
         | 'upscale-skybox'
@@ -410,6 +414,7 @@ export namespace UsageListResponse {
           | '3d23d'
           | '3d23d-texture'
           | 'audio2audio'
+          | 'audio2txt'
           | 'audio2video'
           | 'background-removal'
           | 'canvas'
@@ -420,6 +425,7 @@ export namespace UsageListResponse {
           | 'image-prompt-editing'
           | 'img23d'
           | 'img2img'
+          | 'img2txt'
           | 'img2video'
           | 'inference-controlnet'
           | 'inference-controlnet-img2img'
@@ -459,12 +465,14 @@ export namespace UsageListResponse {
           | 'txt23d'
           | 'txt2audio'
           | 'txt2img'
+          | 'txt2txt'
           | 'txt2video'
           | 'unknown'
           | 'uploaded'
           | 'uploaded-3d'
           | 'uploaded-audio'
           | 'uploaded-avatar'
+          | 'uploaded-text'
           | 'uploaded-video'
           | 'upscale'
           | 'upscale-skybox'
@@ -504,6 +512,13 @@ export namespace UsageListResponse {
          */
         channels?: number;
 
+        /**
+         * Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
+         * counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
+         * several).
+         */
+        charCount?: number;
+
         /**
          * Classification of the audio
          */
@@ -549,6 +564,14 @@ export namespace UsageListResponse {
          */
         hasAnimations?: boolean;
 
+        /**
+         * True when `preview` holds the entire content unmodified — consumers can use it
+         * directly without fetching `asset.url`. False or undefined means the content
+         * exceeds the preview budget and consumers must fetch the full body from S3 to
+         * read past the preview.
+         */
+        hasFullPreview?: boolean;
+
         /**
          * Whether the mesh has normal vectors
          */
@@ -571,6 +594,15 @@ export namespace UsageListResponse {
          */
         nbFrames?: number;
 
+        /**
+         * Leading slice of the content used for inline UI display and as a search
+         * shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
+         * code-point boundary so no character is split. Number of characters in the
+         * preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
+         * emoji-heavy text at the default 1 KB budget).
+         */
+        preview?: string;
+
         /**
          * Sample rate of the media in Hz
          */
@@ -587,6 +619,11 @@ export namespace UsageListResponse {
         vertexCount?: number;
 
         width?: number;
+
+        /**
+         * Number of whitespace-separated words in the text
+         */
+        wordCount?: number;
       }
 
       export namespace Properties {
@@ -946,7 +983,7 @@ export namespace UsageListResponse {
              * not able to create the asset on the flight on API side with dataurl without
              * data:kind, prefix
              */
-            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
             /**
              * The label displayed in the UI for this input
@@ -1179,7 +1216,7 @@ export namespace UsageListResponse {
                * not able to create the asset on the flight on API side with dataurl without
                * data:kind, prefix
                */
-              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+              kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
               /**
                * The label displayed in the UI for this input