Interface: ImageInstance

@providerprotocol/ai

---

@providerprotocol/ai / @providerprotocol/ai / ImageInstance

Interface: ImageInstance<TParams>

Defined in: src/types/image.ts:191

Image instance returned by the image() function.

Example

const dalle = image({ model: openai('dall-e-3') });

// Simple generation
const result = await dalle.generate('A sunset over mountains');

// Streaming (if supported)
if (dalle.capabilities.streaming && dalle.stream) {
  const stream = dalle.stream('A cyberpunk cityscape');
  for await (const event of stream) {
    // Handle preview/complete events
  }
}

Type Parameters

TParams

TParams = unknown

Provider-specific parameter type

Properties

capabilities

readonly capabilities: ImageCapabilities

Defined in: src/types/image.ts:226

Model capabilities

---

model

readonly model: BoundImageModel<TParams>

Defined in: src/types/image.ts:220

The bound image model

---

params

readonly params: TParams | undefined

Defined in: src/types/image.ts:223

Current parameters

Methods

edit()?

optional edit(input): Promise<ImageResult>

Defined in: src/types/image.ts:217

Edit an existing image (if supported). Only available when capabilities.edit is true.

Parameters

input

ImageEditInput

Edit input with image, optional mask, and prompt

Returns

Promise<ImageResult>

Promise resolving to the edited images

---

generate()

generate(input, options?): Promise<ImageResult>

Defined in: src/types/image.ts:199

Generate images from a text prompt.

Parameters

input

ImageInput

The prompt string or object with prompt

options?

ImageGenerateOptions

Optional generation options

Returns

Promise<ImageResult>

Promise resolving to the generated images

---

stream()?

optional stream(input): ImageStreamResult

Defined in: src/types/image.ts:208

Generate with streaming progress (if supported). Only available when capabilities.streaming is true.

Parameters

input

ImageInput

The prompt string or object with prompt

Returns

ImageStreamResult

ImageStreamResult with events and final result