Skip to main content

Interface: VariateImageOptions

Defined in: packages/agentos/src/api/variateImage.ts:45

Options for a variateImage call.

Example​

const result = await variateImage({
  provider: 'openai',
  image: fs.readFileSync('hero.png'),
  n: 3,
  variance: 0.4,
});

Properties​

apiKey?​

optional apiKey: string

Defined in: packages/agentos/src/api/variateImage.ts:80

Override the provider API key.

baseUrl?​

optional baseUrl: string

Defined in: packages/agentos/src/api/variateImage.ts:82

Override the provider base URL.

image​

image: string | Buffer

Defined in: packages/agentos/src/api/variateImage.ts:60

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

model?​

optional model: string

Defined in: packages/agentos/src/api/variateImage.ts:55

Model identifier. When omitted, the provider's default variation model is used (e.g. dall-e-2 for OpenAI).

n?​

optional n: number

Defined in: packages/agentos/src/api/variateImage.ts:65

Number of variations to generate.

Default​

1

provider?​

optional provider: string

Defined in: packages/agentos/src/api/variateImage.ts:50

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/variateImage.ts:84

Arbitrary provider-specific options.

size?​

optional size: string

Defined in: packages/agentos/src/api/variateImage.ts:78

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

usageLedger?​

optional usageLedger: AgentOSUsageLedgerOptions

Defined in: packages/agentos/src/api/variateImage.ts:86

Optional usage ledger configuration.

variance?​

optional variance: number

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

How different from the original each variation should be. 0 = nearly identical, 1 = very different.

For providers that support strength/denoising (Stability, A1111), this is mapped to that parameter. OpenAI's variations API does not expose a strength control so this value is advisory only.

Default​

0.5