Class OpenAIImageProvider

constructor

• new OpenAIImageProvider(): OpenAIImageProvider

• Returns OpenAIImageProvider

initialize

• initialize(config): Promise<void>

• Parameters

  • config: Record<string, unknown>

  Returns Promise<void>

generateImage

• generateImage(request): Promise<ImageGenerationResult>

• Parameters

  • request: ImageGenerationRequest

  Returns Promise<ImageGenerationResult>

editImage

• editImage(request): Promise<ImageGenerationResult>

• 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

variateImage

• variateImage(request): Promise<ImageGenerationResult>

• 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

listAvailableModels

• listAvailableModels(): Promise<ImageModelInfo[]>

• Returns Promise<ImageModelInfo[]>

Readonly providerId

isInitialized

Optional defaultModelId