@scenario-labs/sdk 3.1.0 → 3.2.0

package/resources/models/models.d.ts

@@ -382,7 +382,9 @@ export declare namespace ModelCreateResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -405,8 +407,9 @@ export declare namespace ModelCreateResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -420,8 +423,9 @@ export declare namespace ModelCreateResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -983,6 +987,12 @@ export declare namespace ModelCreateResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -1030,6 +1040,9 @@ export declare namespace ModelCreateResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -1397,7 +1410,9 @@ export declare namespace ModelRetrieveResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -1420,8 +1435,9 @@ export declare namespace ModelRetrieveResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -1435,8 +1451,9 @@ export declare namespace ModelRetrieveResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -1998,6 +2015,12 @@ export declare namespace ModelRetrieveResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -2045,6 +2068,9 @@ export declare namespace ModelRetrieveResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -2412,7 +2438,9 @@ export declare namespace ModelUpdateResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -2435,8 +2463,9 @@ export declare namespace ModelUpdateResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -2450,8 +2479,9 @@ export declare namespace ModelUpdateResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -3013,6 +3043,12 @@ export declare namespace ModelUpdateResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -3060,6 +3096,9 @@ export declare namespace ModelUpdateResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -3423,7 +3462,9 @@ export declare namespace ModelListResponse {
          * The asset kind of the input. Only taken into account for \`file\` and
          * \`file_array\` input types. If model provides multiple kinds, the input will be
          * not able to create the asset on the flight on API side with dataurl without
-         * data:kind, prefix
+         * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+         * a model does not declare one, \`image\` is returned, which is the kind used at
+         * generation time.
          */
         kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
         /**
@@ -3446,8 +3487,9 @@ export declare namespace ModelListResponse {
          */
         maxDuration?: number;
         /**
-         * The maximum allowed length for \`string\` inputs. Also applies to each item in
-         * \`string_array\`.
+         * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
          */
         maxLength?: number;
         /**
@@ -3461,8 +3503,9 @@ export declare namespace ModelListResponse {
          */
         min?: number;
         /**
-         * The minimum allowed length for string inputs. Also applies to each item in
-         * \`string_array\`.
+         * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
          */
         minLength?: number;
         /**
@@ -4024,6 +4067,12 @@ export declare namespace ModelListResponse {
          * Configuration for the loras component
          */
         lorasComponent?: UiConfig.LorasComponent;
+        /**
+         * Configuration for the provider outputs exposed by `exposeOutput`
+         */
+        outputProperties?: {
+            [key: string]: UiConfig.OutputProperties;
+        };
         /**
          * Configuration for the presets
          */
@@ -4071,6 +4120,9 @@ export declare namespace ModelListResponse {
              */
             modelIdInput?: string;
         }
+        interface OutputProperties {
+            label: string;
+        }
         interface Preset {
             fields: Array<string>;
             presets: unknown;
@@ -4438,7 +4490,9 @@ export declare namespace ModelCopyResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -4461,8 +4515,9 @@ export declare namespace ModelCopyResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -4476,8 +4531,9 @@ export declare namespace ModelCopyResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -5039,6 +5095,12 @@ export declare namespace ModelCopyResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -5086,6 +5148,9 @@ export declare namespace ModelCopyResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -5460,7 +5525,9 @@ export declare namespace ModelGetBulkResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -5483,8 +5550,9 @@ export declare namespace ModelGetBulkResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -5498,8 +5566,9 @@ export declare namespace ModelGetBulkResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -6061,6 +6130,12 @@ export declare namespace ModelGetBulkResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -6108,6 +6183,9 @@ export declare namespace ModelGetBulkResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -6475,7 +6553,9 @@ export declare namespace ModelTransferResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
             /**
@@ -6498,8 +6578,9 @@ export declare namespace ModelTransferResponse {
              */
             maxDuration?: number;
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
             /**
@@ -6513,8 +6594,9 @@ export declare namespace ModelTransferResponse {
              */
             min?: number;
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
             /**
@@ -7076,6 +7158,12 @@ export declare namespace ModelTransferResponse {
              * Configuration for the loras component
              */
             lorasComponent?: UiConfig.LorasComponent;
+            /**
+             * Configuration for the provider outputs exposed by `exposeOutput`
+             */
+            outputProperties?: {
+                [key: string]: UiConfig.OutputProperties;
+            };
             /**
              * Configuration for the presets
              */
@@ -7123,6 +7211,9 @@ export declare namespace ModelTransferResponse {
                  */
                 modelIdInput?: string;
             }
+            interface OutputProperties {
+                label: string;
+            }
             interface Preset {
                 fields: Array<string>;
                 presets: unknown;
@@ -7745,6 +7836,11 @@ export interface ModelDeleteImagesParams {
     projectId?: string;
 }
 export interface ModelDownloadParams {
+    /**
+     * Query param: Estimate the operation instead of running it: the call returns a
+     * 269 response carrying the creative units cost. `api` estimates at the API tier.
+     */
+    dryRun?: 'true' | 'api';
     /**
      * Query param: The projectId used for ownership resource management. Either to
      * assert ownership or to set the owner of the resource(s)