Interface: ImageEditRequest

Defined in: packages/agentos/src/core/images/IImageProvider.ts:151

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/core/images/IImageProvider.ts:155

Source image as a raw Buffer.

---

mask?

optional mask: Buffer

Defined in: packages/agentos/src/core/images/IImageProvider.ts:159

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

---

mode?

optional mode: ImageEditMode

Defined in: packages/agentos/src/core/images/IImageProvider.ts:161

Editing mode. Defaults to 'img2img'.

---

modelId

modelId: string

Defined in: packages/agentos/src/core/images/IImageProvider.ts:153

Model identifier to use for the edit.

---

n?

optional n: number

Defined in: packages/agentos/src/core/images/IImageProvider.ts:174

Number of output images.

---

negativePrompt?

optional negativePrompt: string

Defined in: packages/agentos/src/core/images/IImageProvider.ts:168

Negative prompt describing content to avoid.

---

prompt

prompt: string

Defined in: packages/agentos/src/core/images/IImageProvider.ts:157

Text prompt describing the desired changes.

---

providerOptions?

optional providerOptions: Record<string, unknown> | ImageProviderOptionBag

Defined in: packages/agentos/src/core/images/IImageProvider.ts:176

Arbitrary provider-specific options.

---

seed?

optional seed: number

Defined in: packages/agentos/src/core/images/IImageProvider.ts:172

Seed for reproducible output.

---

size?

optional size: string

Defined in: packages/agentos/src/core/images/IImageProvider.ts:170

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

---

strength?

optional strength: number

Defined in: packages/agentos/src/core/images/IImageProvider.ts:166

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