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?
optionalapiKey:string
Defined in: packages/agentos/src/api/variateImage.ts:82
Override the provider API key.
baseUrl?
optionalbaseUrl:string
Defined in: packages/agentos/src/api/variateImage.ts:84
Override the provider base URL.
image
image:
string|Buffer
Defined in: packages/agentos/src/api/variateImage.ts:62
Source image as a base64 data URL, raw base64 string, Buffer,
local file path, or HTTP/HTTPS URL.
model?
optionalmodel:string
Defined in: packages/agentos/src/api/variateImage.ts:57
Model identifier. When omitted, the provider's own default for a
variation applies: OpenAI makes one through its edits endpoint with
gpt-image-2.5-sunburst, and a provider without native variations through
its edit default (Replicate stability-ai/sdxl, Stability sd3.5-medium).
n?
optionaln:number
Defined in: packages/agentos/src/api/variateImage.ts:67
Number of variations to generate.
Default
1
provider?
optionalprovider: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?
optionalproviderOptions:Record<string,unknown> |ImageProviderOptionBag
Defined in: packages/agentos/src/api/variateImage.ts:86
Arbitrary provider-specific options.
size?
optionalsize:string
Defined in: packages/agentos/src/api/variateImage.ts:80
Desired output size (e.g. "1024x1024").
usageLedger?
optionalusageLedger:AgentOSUsageLedgerOptions
Defined in: packages/agentos/src/api/variateImage.ts:88
Optional usage ledger configuration.
variance?
optionalvariance:number
Defined in: packages/agentos/src/api/variateImage.ts:78
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