@musallam/firefly-client
    Preparing search index...

    Interface GenerateImagesRequestV3

    interface GenerateImagesRequestV3 {
        contentClass?: FireflyApiClient.ContentClassV3;
        customModelId?: string;
        negativePrompt?: string;
        numVariations?: number;
        prompt: string;
        promptBiasingLocaleCode?: string;
        seeds?: number[];
        size?: Size;
        structure?: StructureReferenceV3;
        style?: StylesV3;
        upsamplerType?: FireflyApiClient.GenerateImagesRequestV3UpsamplerType;
        visualIntensity?: number;
    }
    Index

    Properties

    contentClass? customModelId? negativePrompt? numVariations? prompt promptBiasingLocaleCode? seeds? size? structure? style? upsamplerType? visualIntensity?

    Properties

    contentClass?: FireflyApiClient.ContentClassV3

    Directs the style of a generated image to be photographic or like fine art.

    customModelId?: string

    Include the specific custom model ID when a custom model type is designated in the x-model-version header parameter.

    negativePrompt?: string

    A negative prompt of things Firefly will try to avoid generating in the image. Not supported for Firefly Custom Models on Image Model 3 or Firefly Custom Models on Image Model 4. 1024

    numVariations?: number

    The number of variations to generate. numVariations defaults to the number of seed images, or to 1 if you do not specify seeds. 1 4

    prompt: string

    A text prompt to support the generation of an image. The longer the prompt the better Firefly performs. 1 1024

    promptBiasingLocaleCode?: string

    A hyphen-separated string combining the ISO 639-1 language code and the ISO 3166-1 region (like en-US). When a locale is set, the prompt will be biased to generate more relevant content for that region. If not specified, the locale will be auto-detected based on your profile and the accepted language header.

    seeds?: number[]

    An array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls. For example, use the same seed to generate a similar image in different styles. If specified along with numVariations, the number of seeds provided must equal numVariations. 1 4

    size?: Size

    The desired width and height for the final image, in pixels. Supported sizes for the output images with image3 are:

    • Square (1:1) - width 2048px, height 2048px
    • Square (1:1) - width 1024px, height 1024px
    • Landscape (4:3) - width 2304px, height 1792px
    • Portrait (3:4) - width 1792px, height 2304px
    • Widescreen (16:9) - width 2688px, height 1536px
    • Widescreen (16:9) - width 2688px, height 1512px
    • (7:4) - width 1344px, height 768px
    • (7:4) - width 1344px, height 756px
    • (9:7) - width 1152px, height 896px
    • (7:9) - width 896px, height 1152px
    Supported sizes for the output images with image4 are:
    • (1:1) - width 2048px, height 2048px
    • (4:3) - width 2304px, height 1792px
    • (3:4) - width 1792px, height 2304px
    • (16:9) - width 2688px, height 1536px
    • (9:16) - width 1440px, height 2560px
    .

    structure?: StructureReferenceV3

    An object with the reference image details for structure.

    style?: StylesV3

    An object with the reference image details for style.

    upsamplerType?: FireflyApiClient.GenerateImagesRequestV3UpsamplerType

    Only supported with the model version image4_custom. The default setting upscales generated images to 2k. The low_creativity setting refines the image generation by removing distortions, smoothing textures, and sometimes adding details (like freckles to faces in close-up). This setting is recommended for generating images with human subjects.

    visualIntensity?: number

    Adjust the overall intensity of your photo's characteristics, such as contrast, shadow, and hue. This is not supported with the model version image4_custom. 2 10

    Settings

    Member Visibility

    On This Page

    Properties