Skip to main content

Interface: ImageEditRequest

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:215

Provider-level request for image editing.

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

Properties​

image​

image: Buffer

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:219

Source image as a raw Buffer.

mask?​

optional mask: Buffer

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:223

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

mode?​

optional mode: ImageEditMode

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:225

Editing mode. Defaults to 'img2img'.

modelId​

modelId: string

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:217

Model identifier to use for the edit.

n?​

optional n: number

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:238

Number of output images.

negativePrompt?​

optional negativePrompt: string

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:232

Negative prompt describing content to avoid.

prompt​

prompt: string

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:221

Text prompt describing the desired changes.

providerOptions?​

optional providerOptions: Record<string, unknown> | ImageProviderOptionBag

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:240

Arbitrary provider-specific options.

seed?​

optional seed: number

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:236

Seed for reproducible output.

size?​

optional size: string

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:234

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

strength?​

optional strength: number

Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:230

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