Skip to main content

Interface: EditImageOptions

Defined in: packages/agentos/src/api/editImage.ts:47

Options for an editImage call.

Example​

const result = await editImage({
  provider: 'openai',
  image: 'data:image/png;base64,...',
  prompt: 'Add a rainbow in the sky.',
  mode: 'img2img',
  strength: 0.6,
});

Properties​

apiKey?​

optional apiKey: string

Defined in: packages/agentos/src/api/editImage.ts:91

Override the provider API key instead of reading from env vars.

baseUrl?​

optional baseUrl: string

Defined in: packages/agentos/src/api/editImage.ts:93

Override the provider base URL.

image​

image: string | Buffer

Defined in: packages/agentos/src/api/editImage.ts:62

Source image as a base64 data URL, raw base64 string, Buffer, local file path, or HTTP/HTTPS URL.

mask?​

optional mask: string | Buffer

Defined in: packages/agentos/src/api/editImage.ts:69

Optional mask for inpainting. White pixels mark regions to be edited; black pixels mark regions to keep. Accepts the same formats as image.

mode?​

optional mode: ImageEditMode

Defined in: packages/agentos/src/api/editImage.ts:76

Edit mode.

  • 'img2img' (default) — prompt-guided transformation.
  • 'inpaint' — mask-guided regional editing.
  • 'outpaint' — extend image borders.

model?​

optional model: string

Defined in: packages/agentos/src/api/editImage.ts:57

Model in provider:model format (legacy) or plain model name when provider is set.

Example​

`"openai:gpt-image-1"`, `"stability:sd3-medium"`

n?​

optional n: number

Defined in: packages/agentos/src/api/editImage.ts:89

Number of output images.

negativePrompt?​

optional negativePrompt: string

Defined in: packages/agentos/src/api/editImage.ts:83

Negative prompt describing content to avoid.

prompt​

prompt: string

Defined in: packages/agentos/src/api/editImage.ts:64

Text prompt describing the desired changes.

provider?​

optional provider: string

Defined in: packages/agentos/src/api/editImage.ts:52

Provider name (e.g. "openai", "stability", "stable-diffusion-local"). When omitted, auto-detection via env vars is attempted.

providerOptions?​

optional providerOptions: Record<string, unknown> | ImageProviderOptionBag

Defined in: packages/agentos/src/api/editImage.ts:95

Arbitrary provider-specific options.

seed?​

optional seed: number

Defined in: packages/agentos/src/api/editImage.ts:87

Seed for reproducibility (provider-dependent support).

size?​

optional size: string

Defined in: packages/agentos/src/api/editImage.ts:85

Output size (e.g. "1024x1024").

strength?​

optional strength: number

Defined in: packages/agentos/src/api/editImage.ts:81

How much to deviate from the source image. 0 = identical, 1 = completely new. Default 0.75.

usageLedger?​

optional usageLedger: AgentOSUsageLedgerOptions

Defined in: packages/agentos/src/api/editImage.ts:97

Optional usage ledger configuration.