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

    Interface GenerateObjectCompositeRequestV3

    interface GenerateObjectCompositeRequestV3 {
        contentClass?: FireflyApiClient.ContentClassV3;
        image: InputImageV3;
        mask?: BaseInputMaskV3;
        numVariations?: number;
        placement?: Placement;
        prompt: string;
        seeds?: number[];
        size?: Size;
        style?: StylesV3;
    }
    Index

    Properties

    contentClass? image mask? numVariations? placement? prompt seeds? size? style?

    Properties

    contentClass?: FireflyApiClient.ContentClassV3
    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?: BaseInputMaskV3

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

    numVariations?: number

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

    placement?: Placement

    The position of the source image after Firefly adjusts 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

    A text prompt up to 1024 characters. The longer the prompt the better Firefly performs. 1 1024

    seeds?: number[]

    Array of seed image IDs. These reference images help ensure consistent image generation across multiple API calls.

    If specified along with numVariations, the number of seeds must equal numVariations. 1 4

    size?: Size

    The desired width and height for the final 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
    .

    style?: StylesV3

    Settings

    Member Visibility

    On This Page

    Properties