StabilityAI class

The main class for interacting with the Stability AI API

To use this class, you need to have an API key. You can provide the API key as an argument to the constructor or set it as an environment variable STABILITY_API_KEY. You can also provide the API key as an argument when running the script using --stability-api-key.

This class provides access to the following modules:

  • UserModule: For user related operations
  • EngineModule : For listing and getting information about engines
  • SDXLWithMaskModule : For using the Stable Diffusion XL model with stable-diffusion-xl-1024-v1-0 model
  • SDXLModule : For using the Stable Diffusion XL model with stable-diffusion-v1-6 model
  • D3DModule : For using the Diffusion 3D model
  • ImageToVideoModule : For converting images to videos
  • StableImageModule : For image related operations like editing, generating, upscaling, etc.

This package prepared by using the documentation

Constructors

StabilityAI.new({String? apiKey, String? stabilityClientId, String? stabilityClientUserId})
Create a new StabilityAI instance.

Properties

d3d → D3DModule
The D3DModule for using the Diffusion 3D model
no setter
engines → EngineModule
The EngineModule for listing and getting information about engines
no setter
hashCode → int
The hash code for this object.
no setterinherited
image → StableImageModule
The StableImageModule for image related operations like editing, generating, upscaling, etc.
no setter
imageToVideo → ImageToVideoModule
The ImageToVideoModule for converting images to videos
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sdBeta → SDXLModule
The SDXLModule for using the Stable Diffusion XL model
no setter
sdxlV1 → SDXLWithMaskModule
The SDXLWithMaskModule for using the Stable Diffusion XL model with stable-diffusion-xl-1024-v1-0 model
no setter
sdxlV16 → SDXLModule
The SDXLModule for using the Stable Diffusion XL with stable-diffusion-xl-1024-v1-0 model
no setter
user → UserModule
The UserModule for user related operations
no setter

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited