@scenario-labs/sdk 3.1.0 → 3.2.0

package/src/resources/models/models.ts

@@ -142,8 +142,12 @@ export class Models extends APIResource {
     params: ModelDownloadParams,
     options?: RequestOptions,
   ): APIPromise<ModelDownloadResponse> {
-    const { projectId, ...body } = params;
-    return this._client.post(path`/models/${modelID}/download`, { query: { projectId }, body, ...options });
+    const { dryRun, projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/download`, {
+      query: { dryRun, projectId },
+      body,
+      ...options,
+    });
   }
 
   /**
@@ -636,7 +640,9 @@ export 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';
 
@@ -664,8 +670,9 @@ export 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;
 
@@ -682,8 +689,9 @@ export 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;
 
@@ -1379,6 +1387,11 @@ export namespace ModelCreateResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -1433,6 +1446,10 @@ export namespace ModelCreateResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -1951,7 +1968,9 @@ export 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';
 
@@ -1979,8 +1998,9 @@ export 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;
 
@@ -1997,8 +2017,9 @@ export 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;
 
@@ -2694,6 +2715,11 @@ export namespace ModelRetrieveResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -2748,6 +2774,10 @@ export namespace ModelRetrieveResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -3266,7 +3296,9 @@ export 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';
 
@@ -3294,8 +3326,9 @@ export 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;
 
@@ -3312,8 +3345,9 @@ export 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;
 
@@ -4009,6 +4043,11 @@ export namespace ModelUpdateResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -4063,6 +4102,10 @@ export namespace ModelUpdateResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -4576,7 +4619,9 @@ export 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';
 
@@ -4604,8 +4649,9 @@ export 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;
 
@@ -4622,8 +4668,9 @@ export 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;
 
@@ -5319,6 +5366,11 @@ export namespace ModelListResponse {
      */
     lorasComponent?: UiConfig.LorasComponent;
 
+    /**
+     * Configuration for the provider outputs exposed by `exposeOutput`
+     */
+    outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
     /**
      * Configuration for the presets
      */
@@ -5373,6 +5425,10 @@ export namespace ModelListResponse {
       modelIdInput?: string;
     }
 
+    export interface OutputProperties {
+      label: string;
+    }
+
     export interface Preset {
       fields: Array<string>;
 
@@ -5892,7 +5948,9 @@ export 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';
 
@@ -5920,8 +5978,9 @@ export 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;
 
@@ -5938,8 +5997,9 @@ export 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;
 
@@ -6635,6 +6695,11 @@ export namespace ModelCopyResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -6689,6 +6754,10 @@ export namespace ModelCopyResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -7216,7 +7285,9 @@ export 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';
 
@@ -7244,8 +7315,9 @@ export 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;
 
@@ -7262,8 +7334,9 @@ export 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;
 
@@ -7959,6 +8032,11 @@ export namespace ModelGetBulkResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -8013,6 +8091,10 @@ export namespace ModelGetBulkResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -8531,7 +8613,9 @@ export 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';
 
@@ -8559,8 +8643,9 @@ export 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;
 
@@ -8577,8 +8662,9 @@ export 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;
 
@@ -9274,6 +9360,11 @@ export namespace ModelTransferResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -9328,6 +9419,10 @@ export namespace ModelTransferResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -10181,6 +10276,12 @@ export interface ModelDeleteImagesParams {
 }
 
 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)