adobe-firefly-sdk
    Preparing search index...

    Type Alias FillImageRequestV3

    Fill images payload

    type FillImageRequestV3 = {
        image: InputImageV3;
        mask: InputMaskV3;
        negativePrompt?: string;
        numVariations?: number;
        prompt?: string;
        promptBiasingLocaleCode?: string;
        seeds?: number[];
        size?: Size;
    }
    Index

    Properties

    image mask negativePrompt? numVariations? prompt? promptBiasingLocaleCode? seeds? size?

    Properties

    image: InputImageV3

    The image to expand. Use a URL or an uploadID as the source for the image. Firefly only allows these listed domains for input URLs in the request:

    • amazonaws.com
    • windows.net
    • dropboxusercontent.com
    • storage.googleapis.com
    .

    mask: InputMaskV3

    Required. Selected areas of a background image that Firefly uses to fill the source image.

    negativePrompt?: string

    Avoid prompt

    An optional text prompt up to 1024 characters. Avoid these characteristics in the generated image. Not supported for Firefly Custom Models on Image Model 3 or Firefly Custom Models on Image Model 4.

    numVariations?: number

    The number of variations

    Generate this number of variations. numVariations defaults to the number of seed images, or to 1 if you do not specify seeds.

    prompt?: string

    The prompt

    An optional text prompt up to 1024 characters. The longer the prompt the better Firefly performs.

    promptBiasingLocaleCode?: string

    The locale used to generate an image

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

    seeds?: number[]

    The seed of each variation

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

    size?: Size

    The size

    The desired width and height for the final expanded image in pixels. The supported sizes for the output images 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
    • (7:4) - width 1344px, height 768px
    • (9:7) - width 1152px, height 896px
    • (7:9) - width 896px, height 1152px
    .

    Settings

    Member Visibility

    On This Page

    Properties