wrapImageModel()

The wrapImageModel function provides a way to enhance the behavior of image models by wrapping them with middleware.

import { generateImage, wrapImageModel } from 'ai';
import { openai } from '@ai-sdk/openai';

const model = wrapImageModel({
  model: openai.image('gpt-image-1'),
  middleware: yourImageModelMiddleware,
});

const { image } = await generateImage({
  model,
  prompt: 'Santa Claus driving a Cadillac',
});

Import

<Snippet text={import { wrapImageModel } from "ai"} prompt={false} />

API Signature

Parameters

<PropertiesTable content={[ { name: 'model', type: 'ImageModelV4', description: 'The original ImageModelV4 instance to be wrapped.', }, { name: 'middleware', type: 'ImageModelV4Middleware | ImageModelV4Middleware[]', description: 'The middleware to be applied to the image model. When multiple middlewares are provided, the first middleware will transform the input first, and the last middleware will be wrapped directly around the model.', }, { name: 'modelId', type: 'string', description: "Optional custom model ID to override the original model's ID.", }, { name: 'providerId', type: 'string', description: "Optional custom provider ID to override the original model's provider.", }, ]} />

Returns

A new ImageModelV4 instance with middleware applied.