Interface GenerateImageOptions

Options for a generateImage call.

interface GenerateImageOptions {
    provider?: string;
    model?: string;
    prompt: string;
    modalities?: ImageModality[];
    n?: number;
    size?: string;
    aspectRatio?: string;
    quality?: string;
    background?: ImageBackground;
    outputFormat?: ImageOutputFormat;
    outputCompression?: number;
    responseFormat?: ImageResponseFormat;
    apiKey?: string;
    baseUrl?: string;
    userId?: string;
    seed?: number;
    negativePrompt?: string;
    providerOptions?: Record<string, unknown> | ImageProviderOptionBag;
    providerPreferences?: MediaProviderPreference;
    policyTier?: "safe" | "standard" | "mature" | "private-adult";
    usageLedger?: AgentOSUsageLedgerOptions;
}

Properties

provider? model? prompt modalities? n? size? aspectRatio? quality? background? outputFormat? outputCompression? responseFormat? apiKey? baseUrl? userId? seed? negativePrompt? providerOptions? providerPreferences? policyTier? usageLedger?

Properties

Optional provider

provider?: string

Provider name. When supplied without model, the default image model for the provider is resolved automatically from the built-in defaults registry.

Example

`"openai"`, `"stability"`, `"replicate"`

Optional model

model?: string

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

Example

`"openai:dall-e-3"`, `"stability:stable-diffusion-xl-1024-v1-0"`

Either `provider` or `model` (or an API key env var for auto-detection) is required.

prompt

prompt: string

Text description of the desired image.

Optional modalities

modalities?: ImageModality[]

Output modalities requested from the provider (provider-dependent).

Optional n

n?: number

Number of images to generate. Defaults to 1 for most providers.

Optional size

size?: string

Pixel dimensions string, e.g. "1024x1024". Provider-dependent.

Optional aspectRatio

aspectRatio?: string

Aspect ratio string, e.g. "16:9". Used by some providers instead of size.

Optional quality

quality?: string

Quality hint forwarded to the provider (e.g. "hd" for DALL-E 3).

Optional background

background?: ImageBackground

Background style for transparent-capable providers.

Optional outputFormat

outputFormat?: ImageOutputFormat

Desired output file format (e.g. "png", "jpeg", "webp").

Optional outputCompression

outputCompression?: number

Compression level (0–100) for lossy output formats.

Optional responseFormat

responseFormat?: ImageResponseFormat

Whether the provider should return a URL or base64-encoded data.

Optional apiKey

apiKey?: string

Override the provider API key instead of reading from environment variables.

Optional baseUrl

baseUrl?: string

Override the provider base URL.

Optional userId

userId?: string

Optional user identifier forwarded to the provider for moderation tracking.

Optional seed

seed?: number

Random seed for reproducible generation (provider-dependent support).

Optional negativePrompt

negativePrompt?: string

Negative prompt describing content to avoid (provider-dependent support).

Optional providerOptions

providerOptions?: Record<string, unknown> | ImageProviderOptionBag

Arbitrary provider-specific options not covered by the standard fields.

Optional providerPreferences

providerPreferences?: MediaProviderPreference

Provider preferences for reordering or filtering the fallback chain. When supplied, the available image providers are reordered according to preferred and filtered by blocked before building the chain.

Optional policyTier

policyTier?: "safe" | "standard" | "mature" | "private-adult"

Content policy tier. When mature or private-adult, the image provider chain is reordered to prefer uncensored providers (Replicate, Fal) over censored ones (DALL-E, Stability safe mode).

Optional usageLedger

usageLedger?: AgentOSUsageLedgerOptions

Optional durable usage ledger configuration for helper-level accounting.

Settings

Member Visibility

Theme

On This Page

providermodelpromptmodalitiesnsizeaspectRatioqualitybackgroundoutputFormatoutputCompressionresponseFormatapiKeybaseUrluserIdseednegativePromptproviderOptionsproviderPreferencespolicyTierusageLedger