Interface ImageStyleTransferRequest

Provider-level request for a style transfer: the source image restyled after the style reference, both sent to the provider.

Passed to IImageProvider.transferStyle by the high-level transferStyle helper.

interface ImageStyleTransferRequest {
    modelId: string;
    image: Buffer<ArrayBufferLike>;
    styleImage: Buffer<ArrayBufferLike>;
    prompt: string;
    strength?: number;
    negativePrompt?: string;
    size?: string;
    seed?: number;
    providerOptions?: Record<string, unknown> | ImageProviderOptionBag;
}

Properties

modelId image styleImage prompt strength? negativePrompt? size? seed? providerOptions?

Properties

modelId

modelId: string

Model identifier. An empty string asks for the provider's own default for style transfer.

image

image: Buffer<ArrayBufferLike>

The image to restyle: its subject and composition are kept.

styleImage

styleImage: Buffer<ArrayBufferLike>

The image whose style is applied.

prompt

prompt: string

Text guiding the result.

Optional strength

strength?: number

How much of the reference's style to apply, from 0 to 1.

Optional negativePrompt

negativePrompt?: string

Content to avoid, where the provider takes it.

Optional size

size?: string

Output dimensions (e.g. "1024x1024"), where the provider takes them.

Optional seed

seed?: number

Seed for reproducible output, where the provider takes one.

Optional providerOptions

providerOptions?: Record<string, unknown> | ImageProviderOptionBag

Arbitrary provider-specific options.

Settings

Member Visibility

Theme

On This Page

modelIdimagestyleImagepromptstrengthnegativePromptsizeseedproviderOptions