Interface ImageEditRequest

Provider-level request for image editing.

Passed to IImageProvider.editImage by the high-level editImage helper after normalising user input.

interface ImageEditRequest {
    modelId: string;
    image: Buffer<ArrayBufferLike>;
    prompt: string;
    mask?: Buffer<ArrayBufferLike>;
    mode?: ImageEditMode;
    strength?: number;
    negativePrompt?: string;
    size?: string;
    seed?: number;
    n?: number;
    providerOptions?: Record<string, unknown> | ImageProviderOptionBag;
}

Properties

modelId image prompt mask? mode? strength? negativePrompt? size? seed? n? providerOptions?

Properties

modelId

modelId: string

Model identifier to use for the edit.

image

image: Buffer<ArrayBufferLike>

Source image as a raw Buffer.

prompt

prompt: string

Text prompt describing the desired changes.

Optional mask

mask?: Buffer<ArrayBufferLike>

Optional mask for inpainting (white = edit region, black = keep).

Optional mode

mode?: ImageEditMode

Editing mode. Defaults to 'img2img'.

Optional strength

strength?: number

How much the output may deviate from the source. 0 = identical, 1 = completely redrawn. Default 0.75.

Optional negativePrompt

negativePrompt?: string

Negative prompt describing content to avoid.

Optional size

size?: string

Desired output dimensions (e.g. "1024x1024").

Optional seed

seed?: number

Seed for reproducible output.

Optional n

n?: number

Number of output images.

Optional providerOptions

providerOptions?: Record<string, unknown> | ImageProviderOptionBag

Arbitrary provider-specific options.

Settings

Member Visibility

Theme

On This Page

modelIdimagepromptmaskmodestrengthnegativePromptsizeseednproviderOptions