`generateImage()`

generateImage is an experimental feature.

Generates images based on a given prompt using an image model.

It is ideal for use cases where you need to generate images programmatically, such as creating visual content or generating images for data augmentation.

import { experimental_generateImage as generateImage } from 'ai';

const { images } = await generateImage({
  model: openai.image('dall-e-3'),
  prompt: 'A futuristic cityscape at sunset',
  n: 3,
  size: '1024x1024',
});

console.log(images);

Import

import { experimental_generateImage as generateImage } from "ai"

API Signature

Parameters

model:

ImageModelV1

prompt:

string

n?:

number

size?:

string

aspectRatio?:

string

seed?:

number

providerOptions?:

Record<string, Record<string, JSONValue>>

maxRetries?:

number

abortSignal?:

AbortSignal

headers?:

Record<string, string>

Returns

image:

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mimeType:

string

images:

Array<GeneratedFile>

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mimeType:

string

warnings:

ImageGenerationWarning[]

responses:

Array<ImageModelResponseMetadata>

ImageModelResponseMetadata

timestamp:

Date

modelId:

string

headers?:

Record<string, string>