Interface IImageProvider

initialize

• initialize(config): Promise<void>

• Parameters

  • config: Record<string, unknown>

  Returns Promise<void>

generateImage

• generateImage(request): Promise<ImageGenerationResult>

• Parameters

  • request: ImageGenerationRequest

  Returns Promise<ImageGenerationResult>

Optional listAvailableModels

• listAvailableModels(): Promise<ImageModelInfo[]>

• Returns Promise<ImageModelInfo[]>

Optional shutdown

• shutdown(): Promise<void>

• Returns Promise<void>

Optional editImage

• editImage(request): Promise<ImageGenerationResult>

• Perform an image-to-image edit, inpainting, or outpainting operation. Providers that do not support editing should leave this undefined.

  Parameters

  • request: ImageEditRequest

  Returns Promise<ImageGenerationResult>

Optional upscaleImage

• upscaleImage(request): Promise<ImageGenerationResult>

• Upscale / super-resolve an image. Providers that do not support upscaling should leave this undefined.

  Parameters

  • request: ImageUpscaleRequest

  Returns Promise<ImageGenerationResult>

Optional variateImage

• variateImage(request): Promise<ImageGenerationResult>

• Generate visual variations of the supplied image. Providers that do not support variations should leave this undefined.

  Parameters

  • request: ImageVariateRequest

  Returns Promise<ImageGenerationResult>

Optional transferStyle

• transferStyle(request): Promise<ImageGenerationResult>

• Restyle image after styleImage, sending the provider both. A provider with no call that takes both images leaves this undefined.

  Parameters

  • request: ImageStyleTransferRequest

  Returns Promise<ImageGenerationResult>

Optional styleTransferModel

• styleTransferModel(modelId): string

• The model a style transfer runs on for modelId (an empty string for the provider's default), decided by an initialised provider from its own configuration, without a request. Throws for a model its style transfer cannot run. A provider whose base URL is not its own may take a model outside its list, by its own rule: OpenAI and Fal any name, Replicate any owner/name (never a pinned version), Stability none, since its endpoint takes no model. A provider defines this exactly when it defines transferStyle.

  Parameters

  • modelId: string

  Returns string

Readonly providerId

Readonly isInitialized

Optional Readonly defaultModelId