adobe-firefly-sdk
    Preparing search index...

    Type Alias ExpandImageRequestV3

    Images expand payload

    type ExpandImageRequestV3 = {
        image: InputImageV3;
        mask?: InputMaskV3;
        numVariations?: number;
        placement?: Placement;
        prompt?: string;
        seeds?: number[];
        size?: Size;
    }
    Index

    Properties

    image mask? numVariations? placement? prompt? 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

    Mask image which will be used to expand the given image.

    numVariations?: number

    The number of variations to generate

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

    placement?: Placement

    The position of the source image after Firefly resizes it. The value describes the horizontal and vertical placement and dimensions of the image in the output. Note you cannot use placement for source images when you also apply a mask image.

    prompt?: string

    The prompt

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

    seeds?: number[]

    The seed image for 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 maximum size for the output images is 3999px by 3999px.

    Settings

    Member Visibility

    On This Page

    Properties