@scenario-labs/sdk 3.2.0 → 3.3.0

package/src/resources/models/presets.ts

@@ -0,0 +1,1335 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+import { omitUndefined } from '../../internal/utils/values';
+
+export class Presets extends APIResource {
+  /**
+   * Create a new preset for the given `modelId`
+   */
+  create(
+    modelID: string,
+    params: PresetCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<PresetCreateResponse> {
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.post(path`/models/${modelID}/presets`, {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Modify the given `presetId`
+   */
+  update(
+    presetID: string,
+    params: PresetUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<PresetUpdateResponse> {
+    const { modelId, originalAssets, projectId, ...body } = params;
+    return this._client.put(path`/models/${modelId}/presets/${presetID}`, {
+      body,
+      ...options,
+      query: { originalAssets, projectId, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * List all presets for the given `modelId`
+   */
+  list(
+    modelID: string,
+    query: PresetListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PresetListResponse> {
+    return this._client.get(path`/models/${modelID}/presets`, {
+      ...options,
+      query: { ...query, ...omitUndefined(options?.query) },
+    });
+  }
+
+  /**
+   * Delete a preset for the given `modelId`
+   */
+  delete(presetID: string, params: PresetDeleteParams, options?: RequestOptions): APIPromise<unknown> {
+    const { modelId, projectId } = params;
+    return this._client.delete(path`/models/${modelId}/presets/${presetID}`, {
+      ...options,
+      query: { projectId, ...omitUndefined(options?.query) },
+    });
+  }
+}
+
+export interface PresetCreateResponse {
+  preset: PresetCreateResponse.Preset;
+}
+
+export namespace PresetCreateResponse {
+  export interface Preset {
+    /**
+     * The preset ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The author user ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    authorId: string;
+
+    /**
+     * The preset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * Whether the preset is the default preset of the model (example: true)
+     */
+    isDefault: boolean;
+
+    /**
+     * The model ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    modelId: string;
+
+    /**
+     * The owner ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    ownerId: string;
+
+    /**
+     * The inference parameters
+     */
+    parameters: Preset.Parameters;
+
+    /**
+     * The preset last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+  }
+
+  export namespace Preset {
+    /**
+     * The inference parameters
+     */
+    export interface Parameters {
+      /**
+       * Full text prompt including the model placeholder. (example: "an illustration of
+       * phoenix in a fantasy world, flying over a mountain, 8k, bokeh effect")
+       */
+      prompt: string;
+
+      /**
+       * The type of inference to use. Example: txt2img, img2img, etc.
+       *
+       * Selecting the right type will condition the expected parameters.
+       *
+       * Note: for inpainting with models that support multiple base models, Scenario
+       * determines the best available `baseModel` for a given `modelId`.
+       */
+      type:
+        | 'controlnet'
+        | 'controlnet_img2img'
+        | 'controlnet_inpaint'
+        | 'controlnet_inpaint_ip_adapter'
+        | 'controlnet_ip_adapter'
+        | 'controlnet_reference'
+        | 'controlnet_texture'
+        | 'img2img'
+        | 'img2img_ip_adapter'
+        | 'img2img_texture'
+        | 'inpaint'
+        | 'inpaint_ip_adapter'
+        | 'outpaint'
+        | 'reference'
+        | 'reference_texture'
+        | 'txt2img'
+        | 'txt2img_ip_adapter'
+        | 'txt2img_texture';
+
+      /**
+       * The aspect ratio of the generated images. Only used for the model
+       * flux.1.1-pro-ultra. The aspect ratio is a string formatted as "width:height"
+       * (example: "16:9").
+       */
+      aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '9:21';
+
+      /**
+       * The base model to use for the inference. Only Flux LoRA models can use this
+       * parameter. Allowed values are available in the model's attribute:
+       * `compliantModelIds`
+       */
+      baseModelId?: string;
+
+      concepts?: Array<Parameters.Concept>;
+
+      /**
+       * Specifies how long the ControlNet guidance should be applied during the
+       * inference process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance is active. For example:
+       *
+       * - 1.0: ControlNet guidance is applied during all inference steps
+       * - 0.5: ControlNet guidance is only applied during the first half of inference
+       *   steps
+       *
+       * Default values:
+       *
+       * - 0.5 for Canny modality
+       * - 0.6 for all other modalities
+       */
+      controlEnd?: number;
+
+      /**
+       * Signed URL to display the controlnet input image
+       */
+      controlImage?: string;
+
+      /**
+       * Asset id of the controlnet input image
+       */
+      controlImageId?: string;
+
+      /**
+       * Specifies the starting point of the ControlNet guidance during the inference
+       * process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance starts. For example:
+       *
+       * - 0.0: ControlNet guidance starts at the beginning of the inference steps
+       * - 0.5: ControlNet guidance starts at the middle of the inference steps
+       */
+      controlStart?: number;
+
+      /**
+       * If set to true, the entire input image will likely change during inpainting.
+       * This results in faster inferences, but the output image will be harder to
+       * integrate if the input is just a small part of a larger image.
+       */
+      disableMerging?: boolean;
+
+      /**
+       * If false, the process uses the given image to detect the modality. If true
+       * (default), the process will not try to detect the modality of the given image.
+       *
+       * For example: with `pose` modality and `false` value, the process will detect the
+       * pose of people in the given image with `depth` modality and `false` value, the
+       * process will detect the depth of the given image with `scribble` modality and
+       * `true`value, the process will use the given image as a scribble
+       *
+       * ⚠️ For models of the FLUX schnell or dev families, this parameter is ignored.
+       * The modality detection is always disabled. ⚠️
+       */
+      disableModalityDetection?: boolean;
+
+      /**
+       * Controls how closely the generated image follows the prompt. Higher values
+       * result in stronger adherence to the prompt. Default and allowed values depend on
+       * the model type:
+       *
+       * - For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
+       * - For Flux pro models, the default is 3 and allowed values are within [2, 5]
+       */
+      guidance?: number;
+
+      /**
+       * The height of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      height?: number;
+
+      /**
+       * If set, generated assets will be hidden and not returned in the list of images
+       * of the inference or when listing assets (default: false)
+       */
+      hideResults?: boolean;
+
+      /**
+       * Signed URL to display the input image
+       */
+      image?: string;
+
+      /**
+       * Asset id of the input image
+       */
+      imageId?: string;
+
+      /**
+       * Enable or disable the intermediate images generation (default: false)
+       */
+      intermediateImages?: boolean;
+
+      /**
+       * Signed URL to display the IpAdapter image
+       */
+      ipAdapterImage?: string;
+
+      /**
+       * Asset id of the input IpAdapter image
+       */
+      ipAdapterImageId?: string;
+
+      /**
+       * Asset id of the input IpAdapter images
+       */
+      ipAdapterImageIds?: Array<string>;
+
+      /**
+       * Signed URL to display the IpAdapter images
+       */
+      ipAdapterImages?: Array<string>;
+
+      /**
+       * IpAdapter scale factor (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScale?: number;
+
+      /**
+       * IpAdapter scale factors (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScales?: Array<number>;
+
+      /**
+       * The type of IP Adapter model to use. Must be one of [`style`, `character`],
+       * default to `style``
+       */
+      ipAdapterType?: 'character' | 'style';
+
+      /**
+       * Signed URL to display the mask image
+       */
+      mask?: string;
+
+      /**
+       * Asset id of the mask image
+       */
+      maskId?: string;
+
+      /**
+       * The modality associated with the control image used for the generation: it can
+       * either be an object with a combination of maximum
+       *
+       * For models of the FLUX schnell or dev families:
+       *
+       * - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`,
+       *   `low-quality`
+       *
+       * Optionally, you can associate a value to these modalities or presets. The value
+       * must be within `]0.0, 1.0]`.
+       *
+       * Examples:
+       *
+       * - `canny`
+       * - `depth:0.5,pose:1.0`
+       * - `canny:0.5,depth:0.5,lines:0.3`
+       * - `landscape`
+       * - `character:0.5`
+       * - `illusion:1`
+       *
+       * Note: if you use a value that is not supported by the model family, this will
+       * result in an error.
+       */
+      modality?: string;
+
+      /**
+       * The epoch of the model to use for the inference. Only available for Flux Lora
+       * Trained models.
+       */
+      modelEpoch?: string;
+
+      /**
+       * The prompt not to guide the image generation, ignored when guidance < 1
+       * (example: "((ugly face))") For Flux based model (not Fast-Flux): requires
+       * negativePromptStrength > 0 and active only for inference types txt2img / img2img
+       * / controlnet.
+       */
+      negativePrompt?: string;
+
+      /**
+       * Only applicable for flux-dev based models for `txt2img`, `img2img`, and
+       * `controlnet` inference types.
+       *
+       * Controls the influence of the negative prompt. Default 0 means the negative
+       * prompt has no effect. Higher values increase negative prompt influence. Must
+       * be > 0 if negativePrompt is provided.
+       */
+      negativePromptStrength?: number;
+
+      /**
+       * The number of denoising steps for each image generation (within [1, 150],
+       * default: 30)
+       */
+      numInferenceSteps?: number;
+
+      /**
+       * The number of images to generate (within [1, 128], default: 4)
+       */
+      numSamples?: number;
+
+      /**
+       * Whether to use reference adain Only for "reference" inference type
+       */
+      referenceAdain?: boolean;
+
+      /**
+       * Whether to use reference query for self attention's context Only for "reference"
+       * inference type
+       */
+      referenceAttn?: boolean;
+
+      /**
+       * The scheduler to use to override the default configured for the model. See
+       * detailed documentation for more details.
+       */
+      scheduler?:
+        | 'DDIMScheduler'
+        | 'DDPMScheduler'
+        | 'DEISMultistepScheduler'
+        | 'DPMSolverMultistepScheduler'
+        | 'DPMSolverSinglestepScheduler'
+        | 'EulerAncestralDiscreteScheduler'
+        | 'EulerDiscreteScheduler'
+        | 'HeunDiscreteScheduler'
+        | 'KDPM2AncestralDiscreteScheduler'
+        | 'KDPM2DiscreteScheduler'
+        | 'LCMScheduler'
+        | 'LMSDiscreteScheduler'
+        | 'PNDMScheduler'
+        | 'TCDScheduler'
+        | 'UniPCMultistepScheduler';
+
+      /**
+       * Used to reproduce previous results. Default: randomly generated number.
+       */
+      seed?: string;
+
+      /**
+       * Controls the noise intensity introduced to the input image, where a value of 1.0
+       * completely erases the original image's details. Available for img2img and
+       * inpainting. (within [0.01, 1.0], default: 0.75)
+       */
+      strength?: number;
+
+      /**
+       * If style_fidelity=1.0, control more important, else if style_fidelity=0.0,
+       * prompt more important, else balanced Only for "reference" inference type
+       */
+      styleFidelity?: number;
+
+      /**
+       * The width of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      width?: number;
+    }
+
+    export namespace Parameters {
+      export interface Concept {
+        /**
+         * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+         */
+        modelId: string;
+
+        /**
+         * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
+         * is between 0 and 2.
+         */
+        scale: number;
+
+        /**
+         * The epoch of the model (example: "000001") Only available for Flux Lora Trained
+         * models
+         */
+        modelEpoch?: string;
+      }
+    }
+  }
+}
+
+export interface PresetUpdateResponse {
+  preset: PresetUpdateResponse.Preset;
+}
+
+export namespace PresetUpdateResponse {
+  export interface Preset {
+    /**
+     * The preset ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The author user ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    authorId: string;
+
+    /**
+     * The preset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * Whether the preset is the default preset of the model (example: true)
+     */
+    isDefault: boolean;
+
+    /**
+     * The model ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    modelId: string;
+
+    /**
+     * The owner ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    ownerId: string;
+
+    /**
+     * The inference parameters
+     */
+    parameters: Preset.Parameters;
+
+    /**
+     * The preset last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+  }
+
+  export namespace Preset {
+    /**
+     * The inference parameters
+     */
+    export interface Parameters {
+      /**
+       * Full text prompt including the model placeholder. (example: "an illustration of
+       * phoenix in a fantasy world, flying over a mountain, 8k, bokeh effect")
+       */
+      prompt: string;
+
+      /**
+       * The type of inference to use. Example: txt2img, img2img, etc.
+       *
+       * Selecting the right type will condition the expected parameters.
+       *
+       * Note: for inpainting with models that support multiple base models, Scenario
+       * determines the best available `baseModel` for a given `modelId`.
+       */
+      type:
+        | 'controlnet'
+        | 'controlnet_img2img'
+        | 'controlnet_inpaint'
+        | 'controlnet_inpaint_ip_adapter'
+        | 'controlnet_ip_adapter'
+        | 'controlnet_reference'
+        | 'controlnet_texture'
+        | 'img2img'
+        | 'img2img_ip_adapter'
+        | 'img2img_texture'
+        | 'inpaint'
+        | 'inpaint_ip_adapter'
+        | 'outpaint'
+        | 'reference'
+        | 'reference_texture'
+        | 'txt2img'
+        | 'txt2img_ip_adapter'
+        | 'txt2img_texture';
+
+      /**
+       * The aspect ratio of the generated images. Only used for the model
+       * flux.1.1-pro-ultra. The aspect ratio is a string formatted as "width:height"
+       * (example: "16:9").
+       */
+      aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '9:21';
+
+      /**
+       * The base model to use for the inference. Only Flux LoRA models can use this
+       * parameter. Allowed values are available in the model's attribute:
+       * `compliantModelIds`
+       */
+      baseModelId?: string;
+
+      concepts?: Array<Parameters.Concept>;
+
+      /**
+       * Specifies how long the ControlNet guidance should be applied during the
+       * inference process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance is active. For example:
+       *
+       * - 1.0: ControlNet guidance is applied during all inference steps
+       * - 0.5: ControlNet guidance is only applied during the first half of inference
+       *   steps
+       *
+       * Default values:
+       *
+       * - 0.5 for Canny modality
+       * - 0.6 for all other modalities
+       */
+      controlEnd?: number;
+
+      /**
+       * Signed URL to display the controlnet input image
+       */
+      controlImage?: string;
+
+      /**
+       * Asset id of the controlnet input image
+       */
+      controlImageId?: string;
+
+      /**
+       * Specifies the starting point of the ControlNet guidance during the inference
+       * process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance starts. For example:
+       *
+       * - 0.0: ControlNet guidance starts at the beginning of the inference steps
+       * - 0.5: ControlNet guidance starts at the middle of the inference steps
+       */
+      controlStart?: number;
+
+      /**
+       * If set to true, the entire input image will likely change during inpainting.
+       * This results in faster inferences, but the output image will be harder to
+       * integrate if the input is just a small part of a larger image.
+       */
+      disableMerging?: boolean;
+
+      /**
+       * If false, the process uses the given image to detect the modality. If true
+       * (default), the process will not try to detect the modality of the given image.
+       *
+       * For example: with `pose` modality and `false` value, the process will detect the
+       * pose of people in the given image with `depth` modality and `false` value, the
+       * process will detect the depth of the given image with `scribble` modality and
+       * `true`value, the process will use the given image as a scribble
+       *
+       * ⚠️ For models of the FLUX schnell or dev families, this parameter is ignored.
+       * The modality detection is always disabled. ⚠️
+       */
+      disableModalityDetection?: boolean;
+
+      /**
+       * Controls how closely the generated image follows the prompt. Higher values
+       * result in stronger adherence to the prompt. Default and allowed values depend on
+       * the model type:
+       *
+       * - For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
+       * - For Flux pro models, the default is 3 and allowed values are within [2, 5]
+       */
+      guidance?: number;
+
+      /**
+       * The height of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      height?: number;
+
+      /**
+       * If set, generated assets will be hidden and not returned in the list of images
+       * of the inference or when listing assets (default: false)
+       */
+      hideResults?: boolean;
+
+      /**
+       * Signed URL to display the input image
+       */
+      image?: string;
+
+      /**
+       * Asset id of the input image
+       */
+      imageId?: string;
+
+      /**
+       * Enable or disable the intermediate images generation (default: false)
+       */
+      intermediateImages?: boolean;
+
+      /**
+       * Signed URL to display the IpAdapter image
+       */
+      ipAdapterImage?: string;
+
+      /**
+       * Asset id of the input IpAdapter image
+       */
+      ipAdapterImageId?: string;
+
+      /**
+       * Asset id of the input IpAdapter images
+       */
+      ipAdapterImageIds?: Array<string>;
+
+      /**
+       * Signed URL to display the IpAdapter images
+       */
+      ipAdapterImages?: Array<string>;
+
+      /**
+       * IpAdapter scale factor (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScale?: number;
+
+      /**
+       * IpAdapter scale factors (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScales?: Array<number>;
+
+      /**
+       * The type of IP Adapter model to use. Must be one of [`style`, `character`],
+       * default to `style``
+       */
+      ipAdapterType?: 'character' | 'style';
+
+      /**
+       * Signed URL to display the mask image
+       */
+      mask?: string;
+
+      /**
+       * Asset id of the mask image
+       */
+      maskId?: string;
+
+      /**
+       * The modality associated with the control image used for the generation: it can
+       * either be an object with a combination of maximum
+       *
+       * For models of the FLUX schnell or dev families:
+       *
+       * - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`,
+       *   `low-quality`
+       *
+       * Optionally, you can associate a value to these modalities or presets. The value
+       * must be within `]0.0, 1.0]`.
+       *
+       * Examples:
+       *
+       * - `canny`
+       * - `depth:0.5,pose:1.0`
+       * - `canny:0.5,depth:0.5,lines:0.3`
+       * - `landscape`
+       * - `character:0.5`
+       * - `illusion:1`
+       *
+       * Note: if you use a value that is not supported by the model family, this will
+       * result in an error.
+       */
+      modality?: string;
+
+      /**
+       * The epoch of the model to use for the inference. Only available for Flux Lora
+       * Trained models.
+       */
+      modelEpoch?: string;
+
+      /**
+       * The prompt not to guide the image generation, ignored when guidance < 1
+       * (example: "((ugly face))") For Flux based model (not Fast-Flux): requires
+       * negativePromptStrength > 0 and active only for inference types txt2img / img2img
+       * / controlnet.
+       */
+      negativePrompt?: string;
+
+      /**
+       * Only applicable for flux-dev based models for `txt2img`, `img2img`, and
+       * `controlnet` inference types.
+       *
+       * Controls the influence of the negative prompt. Default 0 means the negative
+       * prompt has no effect. Higher values increase negative prompt influence. Must
+       * be > 0 if negativePrompt is provided.
+       */
+      negativePromptStrength?: number;
+
+      /**
+       * The number of denoising steps for each image generation (within [1, 150],
+       * default: 30)
+       */
+      numInferenceSteps?: number;
+
+      /**
+       * The number of images to generate (within [1, 128], default: 4)
+       */
+      numSamples?: number;
+
+      /**
+       * Whether to use reference adain Only for "reference" inference type
+       */
+      referenceAdain?: boolean;
+
+      /**
+       * Whether to use reference query for self attention's context Only for "reference"
+       * inference type
+       */
+      referenceAttn?: boolean;
+
+      /**
+       * The scheduler to use to override the default configured for the model. See
+       * detailed documentation for more details.
+       */
+      scheduler?:
+        | 'DDIMScheduler'
+        | 'DDPMScheduler'
+        | 'DEISMultistepScheduler'
+        | 'DPMSolverMultistepScheduler'
+        | 'DPMSolverSinglestepScheduler'
+        | 'EulerAncestralDiscreteScheduler'
+        | 'EulerDiscreteScheduler'
+        | 'HeunDiscreteScheduler'
+        | 'KDPM2AncestralDiscreteScheduler'
+        | 'KDPM2DiscreteScheduler'
+        | 'LCMScheduler'
+        | 'LMSDiscreteScheduler'
+        | 'PNDMScheduler'
+        | 'TCDScheduler'
+        | 'UniPCMultistepScheduler';
+
+      /**
+       * Used to reproduce previous results. Default: randomly generated number.
+       */
+      seed?: string;
+
+      /**
+       * Controls the noise intensity introduced to the input image, where a value of 1.0
+       * completely erases the original image's details. Available for img2img and
+       * inpainting. (within [0.01, 1.0], default: 0.75)
+       */
+      strength?: number;
+
+      /**
+       * If style_fidelity=1.0, control more important, else if style_fidelity=0.0,
+       * prompt more important, else balanced Only for "reference" inference type
+       */
+      styleFidelity?: number;
+
+      /**
+       * The width of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      width?: number;
+    }
+
+    export namespace Parameters {
+      export interface Concept {
+        /**
+         * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+         */
+        modelId: string;
+
+        /**
+         * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
+         * is between 0 and 2.
+         */
+        scale: number;
+
+        /**
+         * The epoch of the model (example: "000001") Only available for Flux Lora Trained
+         * models
+         */
+        modelEpoch?: string;
+      }
+    }
+  }
+}
+
+export interface PresetListResponse {
+  presets: Array<PresetListResponse.Preset>;
+}
+
+export namespace PresetListResponse {
+  export interface Preset {
+    /**
+     * The preset ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    id: string;
+
+    /**
+     * The author user ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    authorId: string;
+
+    /**
+     * The preset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * Whether the preset is the default preset of the model (example: true)
+     */
+    isDefault: boolean;
+
+    /**
+     * The model ID (example: "eyVcnFJcR92BxBkz7N6g5w")
+     */
+    modelId: string;
+
+    /**
+     * The owner ID (example: "VFhihHKMRZyDDnZAJwLb2Q")
+     */
+    ownerId: string;
+
+    /**
+     * The inference parameters
+     */
+    parameters: Preset.Parameters;
+
+    /**
+     * The preset last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+  }
+
+  export namespace Preset {
+    /**
+     * The inference parameters
+     */
+    export interface Parameters {
+      /**
+       * Full text prompt including the model placeholder. (example: "an illustration of
+       * phoenix in a fantasy world, flying over a mountain, 8k, bokeh effect")
+       */
+      prompt: string;
+
+      /**
+       * The type of inference to use. Example: txt2img, img2img, etc.
+       *
+       * Selecting the right type will condition the expected parameters.
+       *
+       * Note: for inpainting with models that support multiple base models, Scenario
+       * determines the best available `baseModel` for a given `modelId`.
+       */
+      type:
+        | 'controlnet'
+        | 'controlnet_img2img'
+        | 'controlnet_inpaint'
+        | 'controlnet_inpaint_ip_adapter'
+        | 'controlnet_ip_adapter'
+        | 'controlnet_reference'
+        | 'controlnet_texture'
+        | 'img2img'
+        | 'img2img_ip_adapter'
+        | 'img2img_texture'
+        | 'inpaint'
+        | 'inpaint_ip_adapter'
+        | 'outpaint'
+        | 'reference'
+        | 'reference_texture'
+        | 'txt2img'
+        | 'txt2img_ip_adapter'
+        | 'txt2img_texture';
+
+      /**
+       * The aspect ratio of the generated images. Only used for the model
+       * flux.1.1-pro-ultra. The aspect ratio is a string formatted as "width:height"
+       * (example: "16:9").
+       */
+      aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '3:4' | '4:3' | '4:5' | '5:4' | '9:16' | '9:21';
+
+      /**
+       * The base model to use for the inference. Only Flux LoRA models can use this
+       * parameter. Allowed values are available in the model's attribute:
+       * `compliantModelIds`
+       */
+      baseModelId?: string;
+
+      concepts?: Array<Parameters.Concept>;
+
+      /**
+       * Specifies how long the ControlNet guidance should be applied during the
+       * inference process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance is active. For example:
+       *
+       * - 1.0: ControlNet guidance is applied during all inference steps
+       * - 0.5: ControlNet guidance is only applied during the first half of inference
+       *   steps
+       *
+       * Default values:
+       *
+       * - 0.5 for Canny modality
+       * - 0.6 for all other modalities
+       */
+      controlEnd?: number;
+
+      /**
+       * Signed URL to display the controlnet input image
+       */
+      controlImage?: string;
+
+      /**
+       * Asset id of the controlnet input image
+       */
+      controlImageId?: string;
+
+      /**
+       * Specifies the starting point of the ControlNet guidance during the inference
+       * process.
+       *
+       * Only available for Flux.1-dev based models.
+       *
+       * The value represents the percentage of total inference steps where the
+       * ControlNet guidance starts. For example:
+       *
+       * - 0.0: ControlNet guidance starts at the beginning of the inference steps
+       * - 0.5: ControlNet guidance starts at the middle of the inference steps
+       */
+      controlStart?: number;
+
+      /**
+       * If set to true, the entire input image will likely change during inpainting.
+       * This results in faster inferences, but the output image will be harder to
+       * integrate if the input is just a small part of a larger image.
+       */
+      disableMerging?: boolean;
+
+      /**
+       * If false, the process uses the given image to detect the modality. If true
+       * (default), the process will not try to detect the modality of the given image.
+       *
+       * For example: with `pose` modality and `false` value, the process will detect the
+       * pose of people in the given image with `depth` modality and `false` value, the
+       * process will detect the depth of the given image with `scribble` modality and
+       * `true`value, the process will use the given image as a scribble
+       *
+       * ⚠️ For models of the FLUX schnell or dev families, this parameter is ignored.
+       * The modality detection is always disabled. ⚠️
+       */
+      disableModalityDetection?: boolean;
+
+      /**
+       * Controls how closely the generated image follows the prompt. Higher values
+       * result in stronger adherence to the prompt. Default and allowed values depend on
+       * the model type:
+       *
+       * - For Flux dev models, the default is 3.5 and allowed values are within [0, 10]
+       * - For Flux pro models, the default is 3 and allowed values are within [2, 5]
+       */
+      guidance?: number;
+
+      /**
+       * The height of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      height?: number;
+
+      /**
+       * If set, generated assets will be hidden and not returned in the list of images
+       * of the inference or when listing assets (default: false)
+       */
+      hideResults?: boolean;
+
+      /**
+       * Signed URL to display the input image
+       */
+      image?: string;
+
+      /**
+       * Asset id of the input image
+       */
+      imageId?: string;
+
+      /**
+       * Enable or disable the intermediate images generation (default: false)
+       */
+      intermediateImages?: boolean;
+
+      /**
+       * Signed URL to display the IpAdapter image
+       */
+      ipAdapterImage?: string;
+
+      /**
+       * Asset id of the input IpAdapter image
+       */
+      ipAdapterImageId?: string;
+
+      /**
+       * Asset id of the input IpAdapter images
+       */
+      ipAdapterImageIds?: Array<string>;
+
+      /**
+       * Signed URL to display the IpAdapter images
+       */
+      ipAdapterImages?: Array<string>;
+
+      /**
+       * IpAdapter scale factor (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScale?: number;
+
+      /**
+       * IpAdapter scale factors (within [0.0, 1.0], default: 0.9).
+       */
+      ipAdapterScales?: Array<number>;
+
+      /**
+       * The type of IP Adapter model to use. Must be one of [`style`, `character`],
+       * default to `style``
+       */
+      ipAdapterType?: 'character' | 'style';
+
+      /**
+       * Signed URL to display the mask image
+       */
+      mask?: string;
+
+      /**
+       * Asset id of the mask image
+       */
+      maskId?: string;
+
+      /**
+       * The modality associated with the control image used for the generation: it can
+       * either be an object with a combination of maximum
+       *
+       * For models of the FLUX schnell or dev families:
+       *
+       * - one modality from: `canny`, `tile`, `depth`, `blur`, `pose`, `gray`,
+       *   `low-quality`
+       *
+       * Optionally, you can associate a value to these modalities or presets. The value
+       * must be within `]0.0, 1.0]`.
+       *
+       * Examples:
+       *
+       * - `canny`
+       * - `depth:0.5,pose:1.0`
+       * - `canny:0.5,depth:0.5,lines:0.3`
+       * - `landscape`
+       * - `character:0.5`
+       * - `illusion:1`
+       *
+       * Note: if you use a value that is not supported by the model family, this will
+       * result in an error.
+       */
+      modality?: string;
+
+      /**
+       * The epoch of the model to use for the inference. Only available for Flux Lora
+       * Trained models.
+       */
+      modelEpoch?: string;
+
+      /**
+       * The prompt not to guide the image generation, ignored when guidance < 1
+       * (example: "((ugly face))") For Flux based model (not Fast-Flux): requires
+       * negativePromptStrength > 0 and active only for inference types txt2img / img2img
+       * / controlnet.
+       */
+      negativePrompt?: string;
+
+      /**
+       * Only applicable for flux-dev based models for `txt2img`, `img2img`, and
+       * `controlnet` inference types.
+       *
+       * Controls the influence of the negative prompt. Default 0 means the negative
+       * prompt has no effect. Higher values increase negative prompt influence. Must
+       * be > 0 if negativePrompt is provided.
+       */
+      negativePromptStrength?: number;
+
+      /**
+       * The number of denoising steps for each image generation (within [1, 150],
+       * default: 30)
+       */
+      numInferenceSteps?: number;
+
+      /**
+       * The number of images to generate (within [1, 128], default: 4)
+       */
+      numSamples?: number;
+
+      /**
+       * Whether to use reference adain Only for "reference" inference type
+       */
+      referenceAdain?: boolean;
+
+      /**
+       * Whether to use reference query for self attention's context Only for "reference"
+       * inference type
+       */
+      referenceAttn?: boolean;
+
+      /**
+       * The scheduler to use to override the default configured for the model. See
+       * detailed documentation for more details.
+       */
+      scheduler?:
+        | 'DDIMScheduler'
+        | 'DDPMScheduler'
+        | 'DEISMultistepScheduler'
+        | 'DPMSolverMultistepScheduler'
+        | 'DPMSolverSinglestepScheduler'
+        | 'EulerAncestralDiscreteScheduler'
+        | 'EulerDiscreteScheduler'
+        | 'HeunDiscreteScheduler'
+        | 'KDPM2AncestralDiscreteScheduler'
+        | 'KDPM2DiscreteScheduler'
+        | 'LCMScheduler'
+        | 'LMSDiscreteScheduler'
+        | 'PNDMScheduler'
+        | 'TCDScheduler'
+        | 'UniPCMultistepScheduler';
+
+      /**
+       * Used to reproduce previous results. Default: randomly generated number.
+       */
+      seed?: string;
+
+      /**
+       * Controls the noise intensity introduced to the input image, where a value of 1.0
+       * completely erases the original image's details. Available for img2img and
+       * inpainting. (within [0.01, 1.0], default: 0.75)
+       */
+      strength?: number;
+
+      /**
+       * If style_fidelity=1.0, control more important, else if style_fidelity=0.0,
+       * prompt more important, else balanced Only for "reference" inference type
+       */
+      styleFidelity?: number;
+
+      /**
+       * The width of the generated images, must be a 8 multiple (within [64, 2048],
+       * default: 512) If model.type is `flux.1.1-pro-ultra`, you can use the aspectRatio
+       * parameter instead
+       */
+      width?: number;
+    }
+
+    export namespace Parameters {
+      export interface Concept {
+        /**
+         * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+         */
+        modelId: string;
+
+        /**
+         * The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
+         * is between 0 and 2.
+         */
+        scale: number;
+
+        /**
+         * The epoch of the model (example: "000001") Only available for Flux Lora Trained
+         * models
+         */
+        modelEpoch?: string;
+      }
+    }
+  }
+}
+
+export type PresetDeleteResponse = unknown;
+
+export interface PresetCreateParams {
+  /**
+   * Body param: The inference ID used to generate new images
+   */
+  inferenceId: string;
+
+  /**
+   * Query param: If set to true, returns the original asset without transformation
+   */
+  originalAssets?: boolean;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: Whether this preset should be the default preset for the model
+   */
+  isDefault?: boolean;
+}
+
+export interface PresetUpdateParams {
+  /**
+   * Path param: The preset's `modelId`
+   */
+  modelId: string;
+
+  /**
+   * Body param: Whether this preset should be the default preset for the model
+   */
+  isDefault: boolean;
+
+  /**
+   * Query param: If set to true, returns the original asset without transformation
+   */
+  originalAssets?: boolean;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export interface PresetListParams {
+  /**
+   * If set to true, returns the original asset without transformation
+   */
+  originalAssets?: boolean;
+
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export interface PresetDeleteParams {
+  /**
+   * Path param: The preset's `modelId` to delete
+   */
+  modelId: string;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+}
+
+export declare namespace Presets {
+  export {
+    type PresetCreateResponse as PresetCreateResponse,
+    type PresetUpdateResponse as PresetUpdateResponse,
+    type PresetListResponse as PresetListResponse,
+    type PresetDeleteResponse as PresetDeleteResponse,
+    type PresetCreateParams as PresetCreateParams,
+    type PresetUpdateParams as PresetUpdateParams,
+    type PresetListParams as PresetListParams,
+    type PresetDeleteParams as PresetDeleteParams,
+  };
+}