Interface: ImageEditRequest
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:229
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:233
Source image as a raw Buffer.
mask?
optionalmask:Buffer
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:237
Optional mask for inpainting (white = edit region, black = keep).
mode?
optionalmode:ImageEditMode
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:239
Editing mode. Defaults to 'img2img'.
modelId
modelId:
string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:231
Model identifier to use for the edit. An empty string asks for the provider's own default for edits.
n?
optionaln:number
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:252
Number of output images.
negativePrompt?
optionalnegativePrompt:string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:246
Negative prompt describing content to avoid.
prompt
prompt:
string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:235
Text prompt describing the desired changes.
providerOptions?
optionalproviderOptions:Record<string,unknown> |ImageProviderOptionBag
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:254
Arbitrary provider-specific options.
seed?
optionalseed:number
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:250
Seed for reproducible output.
size?
optionalsize:string
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:248
Desired output dimensions (e.g. "1024x1024").
strength?
optionalstrength:number
Defined in: packages/agentos/src/io/media/images/IImageProvider.ts:244
How much the output may deviate from the source.
0 = identical, 1 = completely redrawn. Default 0.75.