Skip to main content

Class: StabilityImageProvider

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:120

Implements​

Constructors​

Constructor​

new StabilityImageProvider(): StabilityImageProvider

Returns​

StabilityImageProvider

Properties​

defaultModelId?​

optional defaultModelId: string

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:123

Implementation of​

IImageProvider.defaultModelId

isInitialized​

isInitialized: boolean = false

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:122

Implementation of​

IImageProvider.isInitialized

providerId​

readonly providerId: "stability" = 'stability'

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:121

Implementation of​

IImageProvider.providerId

Methods​

editImage()​

editImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:297

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

Implementation of​

IImageProvider.editImage

generateImage()​

generateImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:151

Parameters​

request​

ImageGenerationRequest

Returns​

Promise<ImageGenerationResult>

Implementation of​

IImageProvider.generateImage

initialize()​

initialize(config): Promise<void>

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:129

Parameters​

config​

Record<string, unknown>

Returns​

Promise<void>

Implementation of​

IImageProvider.initialize

listAvailableModels()​

listAvailableModels(): Promise<ImageModelInfo[]>

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:488

Returns​

Promise<ImageModelInfo[]>

Implementation of​

IImageProvider.listAvailableModels

upscaleImage()​

upscaleImage(request): Promise<ImageGenerationResult>

Defined in: packages/agentos/src/media/images/providers/StabilityImageProvider.ts:387

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

Implementation of​

IImageProvider.upscaleImage