`generateImage()`

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 { generateImage } from 'ai';

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

console.log(images);

Import

import { generateImage } from "ai"

API Signature

Parameters

model:

ImageModelV3

prompt:

string | GenerateImagePrompt

object

images:

Array<DataContent>

text:

string

mask:

DataContent

n?:

number

size?:

string

aspectRatio?:

string

seed?:

number

providerOptions?:

ProviderOptions

maxImagesPerCall?:

number

maxRetries?:

number

abortSignal?:

AbortSignal

headers?:

Record<string, string>

Returns

image:

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mediaType:

string

images:

Array<GeneratedFile>

GeneratedFile

base64:

string

uint8Array:

Uint8Array

mediaType:

string

warnings:

Warning[]

usage:

ImageModelUsage

imagesGenerated:

number

providerMetadata?:

ImageModelProviderMetadata

responses:

Array<ImageModelResponseMetadata>

ImageModelResponseMetadata

timestamp:

Date

modelId:

string

headers?:

Record<string, string>