ai/docs/07-reference/01-ai-sdk-core/61-wrap-image-model.mdx

AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript

---
title: wrapImageModel
description: Function for wrapping an image model with middleware (API Reference)
---

# `wrapImageModel()`

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

```ts
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: 'ImageModelV3',
      description: 'The original ImageModelV3 instance to be wrapped.',
    },
    {
      name: 'middleware',
      type: 'ImageModelV3Middleware | ImageModelV3Middleware[]',
      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 `ImageModelV3` instance with middleware applied.