Docs
CodeRabbit
Cloudflare
Railway
Netlify
AG Grid
WorkOS
OpenRouter
Clerk
SerpAPI
Unkey
Sentry
Electric
Prisma
CodeRabbit
Cloudflare
Railway
Netlify
AG Grid
WorkOS
OpenRouter
Clerk
SerpAPI
Unkey
Sentry
Electric
Prisma
Class References
Function References
Interface References
Type Alias References
Variable References

ImageGenerationOptions

Interface: ImageGenerationOptions<TProviderOptions, TSize>

Defined in: packages/ai/src/types.ts:1476

Options for image generation. These are the common options supported across providers.

Type Parameters

TProviderOptions

TProviderOptions extends object = object

TSize

TSize extends string | undefined = string

Properties

logger

ts
logger: InternalLogger;
logger: InternalLogger;

Defined in: packages/ai/src/types.ts:1494

Internal logger threaded from the generateImage() entry point. Adapters must call logger.request() before the SDK call and logger.errors() in catch blocks.


model

ts
model: string;
model: string;

Defined in: packages/ai/src/types.ts:1481

The model to use for image generation


modelOptions?

ts
optional modelOptions: TProviderOptions;
optional modelOptions: TProviderOptions;

Defined in: packages/ai/src/types.ts:1489

Model-specific options for image generation


numberOfImages?

ts
optional numberOfImages: number;
optional numberOfImages: number;

Defined in: packages/ai/src/types.ts:1485

Number of images to generate (default: 1)


prompt

ts
prompt: string;
prompt: string;

Defined in: packages/ai/src/types.ts:1483

Text description of the desired image(s)


size?

ts
optional size: TSize;
optional size: TSize;

Defined in: packages/ai/src/types.ts:1487

Image size in WIDTHxHEIGHT format (e.g., "1024x1024")