Class: OpenAIImageProvider

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:33

Implements

• IImageProvider

Constructors

Constructor

new OpenAIImageProvider(): OpenAIImageProvider

Returns

OpenAIImageProvider

Properties

defaultModelId?

optional defaultModelId: string

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:36

Implementation of

IImageProvider.defaultModelId

---

isInitialized

isInitialized: boolean = false

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:35

Implementation of

IImageProvider.isInitialized

---

providerId

readonly providerId: "openai" = 'openai'

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:34

Implementation of

IImageProvider.providerId

Methods

editImage()

editImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:165

Edits an image using the OpenAI /v1/images/edits endpoint.

Supports both img2img (prompt-guided transformation) and inpainting (mask-guided regional editing). The endpoint expects multipart form data with the source image and an optional mask.

Parameters

request

ImageEditRequest

Edit request with source image buffer and prompt.

Returns

Promise<ImageGenerationResult>

Generation result containing the edited image(s).

Throws

When the provider is not initialised.

Throws

When the API returns an HTTP error status.

See

https://platform.openai.com/docs/api-reference/images/createEdit

Implementation of

IImageProvider.editImage

---

generateImage()

generateImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:67

Parameters

request

ImageGenerationRequest

Returns

Promise<ImageGenerationResult>

Implementation of

IImageProvider.generateImage

---

initialize()

initialize(config): Promise<void>

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:41

Parameters

config

Record<string, unknown>

Returns

Promise<void>

Implementation of

IImageProvider.initialize

---

listAvailableModels()

listAvailableModels(): Promise<ImageModelInfo[]>

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:300

Returns

Promise<ImageModelInfo[]>

Implementation of

IImageProvider.listAvailableModels

---

variateImage()

variateImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/io/media/images/providers/OpenAIImageProvider.ts:247

Creates visual variations of an image using the OpenAI /v1/images/variations endpoint.

The variance field in the request is not natively supported by OpenAI's variations API (there is no strength parameter), so it is currently ignored. Every call produces images with the model's default level of variation.

Parameters

request

ImageVariateRequest

Variation request with the source image buffer.

Returns

Promise<ImageGenerationResult>

Generation result containing the variation image(s).

Throws

When the provider is not initialised.

Throws

When the API returns an HTTP error status.

See

https://platform.openai.com/docs/api-reference/images/createVariation

Implementation of

IImageProvider.variateImage