Class StabilityImageProvider

constructor

• new StabilityImageProvider(): StabilityImageProvider

• Returns StabilityImageProvider

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 Stability AI image-to-image endpoint.

  Routes to different endpoints depending on the edit mode:

  • 'img2img' (default) — /v2beta/stable-image/generate/sd3 with image and strength.
  • 'inpaint' — same endpoint but additionally includes mask_image.
  • 'outpaint' — currently treated identically to img2img (provider does not expose a dedicated outpainting endpoint in the v2beta surface).

  Parameters

  • request: ImageEditRequest

    Edit request containing the source image, prompt, and optional mask.

  Returns Promise<ImageGenerationResult>

  Generation result with the edited image(s).

  Throws

  When the provider is not initialised.

  Throws

  When the Stability API returns an HTTP error status.

  See

  https://platform.stability.ai/docs/api-reference#tag/Generate/paths/~1v2beta~1stable-image~1generate~1sd3/post

upscaleImage

• upscaleImage(request): Promise<ImageGenerationResult>

• Upscales an image using the Stability AI upscale endpoint.

  Uses /v2beta/stable-image/upscale/conservative which takes an image and a target width to produce a higher-resolution version.

  Parameters

  • request: ImageUpscaleRequest

    Upscale request with the source image and desired dimensions.

  Returns Promise<ImageGenerationResult>

  Generation result with the upscaled image.

  Throws

  When the provider is not initialised.

  Throws

  When the Stability API returns an HTTP error status.

  See

  https://platform.stability.ai/docs/api-reference#tag/Upscale

listAvailableModels

• listAvailableModels(): Promise<ImageModelInfo[]>

• Returns Promise<ImageModelInfo[]>

Readonly providerId

isInitialized

Optional defaultModelId