Class SDWebUIApi

The SDWebUIApi class provides methods to interact with the AUTOMATIC1111 Stable Diffusion Web UI API. It extends the Shared class and includes various methods to generate images, retrieve information, and manage options and configurations.

Each method corresponds to a specific API endpoint and provides a convenient way to interact with the AUTOMATIC1111 Stable Diffusion Web UI functionalities.

Hierarchy

Shared
- SDWebUIApi

Constructors

constructor

new SDWebUIApi(client: SDWebUIClient): SDWebUIApi
Parameters
- client: SDWebUIClient
Returns SDWebUIApi
Inherited from Shared.constructor
- Defined in src/shared.ts:9

Properties

`Protected`_client

_client: SDWebUIClient

Methods

cmdFlags

cmdFlags(): Promise<CmdFlags>
Get the current command flags.

Reference: get_cmd_flags

Returns Promise<CmdFlags>
Current command flags
- Defined in src/sd/index.ts:205

createEmbedding

createEmbedding(options: Record<string, any>): Promise<{ info: string }>
Create embedding from options.

Reference: create_embedding
Parameters
- options: Record<string, any>
  Options for creating an embedding
Returns Promise<{ info: string }>
- Defined in src/sd/index.ts:340

createHyperNetwork

createHyperNetwork(options: Record<string, any>): Promise<{ info: string }>
Create HyperNetwork from options.

Reference: create_hypernetwork
Parameters
- options: Record<string, any>
  Options for creating a HyperNetwork
Returns Promise<{ info: string }>
Information about the HyperNetwork
- Defined in src/sd/index.ts:350

embeddings

embeddings<T extends string>(): Promise<Embedding<T>[]>
Get all available embeddings.

Reference: get_embeddings
Type Parameters
- T extends string
Returns Promise<Embedding<T>[]>
All available embeddings
- Defined in src/sd/index.ts:304

extensions

extensions(): Promise<Extension[]>
Get all installed extensions.

Reference: get_extensions_list

Returns Promise<Extension[]>
All installed extensions
- Defined in src/sd/index.ts:426

extraBatchImage

extraBatchImage<T extends Omit<ExtraImage, "image">>(
options: PartialExcept<T, "imageList">,
): Promise<Omit<ExtraImageResponse, "image">>
Generate extra images from multiple images.

Reference: extras_batch_images_api
Type Parameters
- T extends Omit<ExtraImage, "image">
Parameters
- options: PartialExcept<T, "imageList">
  Options for generating extra images from multiple images
Returns Promise<Omit<ExtraImageResponse, "image">>
Generated images as base64 strings
- Defined in src/sd/index.ts:92

extraSingleImage

extraSingleImage<T extends Omit<ExtraImage, "imageList">>(
options: PartialExcept<T, "image">,
): Promise<Omit<ExtraImageResponse, "images">>
Generate extra images from a single image.

Reference: extras_single_image_api
Type Parameters
- T extends Omit<ExtraImage, "imageList">
Parameters
- options: PartialExcept<T, "image">
  Options for generating extra images from a single image
Returns Promise<Omit<ExtraImageResponse, "images">>
Generated images as base64 strings
- Defined in src/sd/index.ts:80

faceRestorers

faceRestorers(): Promise<FaceRestorer[]>
Get all available face restorers.

Reference: get_face_restorers

Returns Promise<FaceRestorer[]>
All available face restorers
- Defined in src/sd/index.ts:277

getOptions

getOptions(): Promise<SDOptions>
Alias for options.

Get the current options.

Reference: get_config

Returns Promise<SDOptions>
Current options
- Defined in src/sd/index.ts:182

hyperNetworks

hyperNetworks(): Promise<HyperNetwork[]>
Get all available hyper networks.

Reference: get_hypernetworks

Returns Promise<HyperNetwork[]>
All available hyper networks
- Defined in src/sd/index.ts:268

img2img

img2img<T extends Partial<Img2ImgOptions>>(
options: T & { init_images: string[] },
): Promise<Img2ImgResponse<T>>
Generate images from images.

Reference: img2imgapi
Type Parameters
- T extends Partial<Img2ImgOptions>
Parameters
- options: T & { init_images: string[] }
  Options for generating images from images
  - init_images: string[]
    List of base64 encoded images
Returns Promise<Img2ImgResponse<T>>
Generated images as base64 strings
- Defined in src/sd/index.ts:63

interrogate

interrogate(options: InterrogateOptions): Promise<string>
Interrogating an image.

Reference: interrogateapi
Parameters
- options: InterrogateOptions
  Options for interrogating the current task
Returns Promise<string>
- Defined in src/sd/index.ts:124

interrupt

interrupt(): Promise<string>
Interrupt the current task.

Reference: interruptapi

Returns Promise<string>
Information about the interruption
- Defined in src/sd/index.ts:133

latentUpscaleModes

latentUpscaleModes(): Promise<LatentUpscaleMode[]>
Get all available latent upscale modes.

Reference: get_latent_upscale_modes

Returns Promise<LatentUpscaleMode[]>
All available latent upscale modes
- Defined in src/sd/index.ts:241

memory

memory(): Promise<Memory>
Get the current memory usage.

Reference: get_memory

Returns Promise<Memory>
Current memory usage
- Defined in src/sd/index.ts:381

options

options<T extends Partial<SDOptions> & Record<string, any>>(
options?: T,
): Promise<OptionsResponse<T>>
Get the current options or set the options.

Reference: get_config, set_config
Type Parameters
- T extends Partial<SDOptions> & Record<string, any>
Parameters
- Optionaloptions: T
  Options to set
Returns Promise<OptionsResponse<T>>
Current options
Example
```
const options = await client.api.options();
console.log(options);

const options = await client.api.options({
	"sd_model_checkpoint": "some_checkpoint"
});
console.log(options
```
- Defined in src/sd/index.ts:165

pngInfo

pngInfo<T extends undefined | string>(image?: T): Promise<PngInfoResponse<T>>
Get information about a PNG image.

Reference: pnginfoapi
Type Parameters
- T extends undefined | string
Parameters
- Optionalimage: T
  Base64 encoded PNG image
Returns Promise<PngInfoResponse<T>>
Information about the PNG image
- Defined in src/sd/index.ts:104

progress

progress(): Promise<ProgressResponse>
Get the progress of the current task.

Reference: progressapi

Returns Promise<ProgressResponse>
Progress of the current task
- Defined in src/sd/index.ts:115

promptStyles

promptStyles(): Promise<PromptStyle[]>
Get all available prompt styles.

Reference: get_prompt_styles

Returns Promise<PromptStyle[]>
All available prompt styles
- Defined in src/sd/index.ts:295

realEsrganModels

realEsrganModels(): Promise<RealEsrganModel[]>
Get all available RealESRGAN models.

Reference: get_realesrgan_models

Returns Promise<RealEsrganModel[]>
All available RealESRGAN models
- Defined in src/sd/index.ts:286

refreshCheckpoints

refreshCheckpoints(): Promise<string>
Refresh checkpoints.

Reference: refresh_checkpoints

Returns Promise<string>
Information about the refresh
- Defined in src/sd/index.ts:322

refreshEmbeddings

refreshEmbeddings(): Promise<string>
Refresh embeddings.

Reference: refresh_embeddings

Returns Promise<string>
Information about the refresh
- Defined in src/sd/index.ts:313

refreshVae

refreshVae(): Promise<string>
Refresh VAE.

Reference: refresh_vae

Returns Promise<string>
Information about the refresh
- Defined in src/sd/index.ts:331

reloadCheckPoint

reloadCheckPoint(): Promise<string>
Reload the current checkpoint.

Reference: reloadapi

Returns Promise<string>
Information about the reloading
- Defined in src/sd/index.ts:399

samplers

samplers(): Promise<Sampler[]>
Get all available samplers.

Reference: get_samplers

Returns Promise<Sampler[]>
All available samplers
- Defined in src/sd/index.ts:214

schedulers

schedulers(): Promise<Scheduler[]>
Get all available schedulers.

Reference: get_schedulers

Returns Promise<Scheduler[]>
All available schedulers
- Defined in src/sd/index.ts:223

scriptInfo

scriptInfo(): Promise<ScriptInfo[]>
Get all available script info.

Reference: get_script_info

Returns Promise<ScriptInfo[]>
All available script info
- Defined in src/sd/index.ts:417

scripts

scripts(): Promise<Scripts>
Get all available scripts.

Reference: get_scripts_list

Returns Promise<Scripts>
All available scripts
- Defined in src/sd/index.ts:408

sdModels

sdModels(): Promise<SdModel[]>
Get all available SD models.

Reference: get_sd_models

Returns Promise<SdModel[]>
All available SD models
- Defined in src/sd/index.ts:250

sdVae

sdVae(): Promise<SdVae[]>
Get all available SD VAEs.

Reference: get_sd_vaes

Returns Promise<SdVae[]>
All available SD VAEs
- Defined in src/sd/index.ts:259

setOptions

setOptions<T extends Partial<SDOptions> & Record<string, any>>(
options: T,
): Promise<OptionsResponse<T>>
Alias for options.

Set the current options.

Reference: set_config
Type Parameters
- T extends Partial<SDOptions> & Record<string, any>
Parameters
- options: T
  Options to set
Returns Promise<OptionsResponse<T>>
Current options
- Defined in src/sd/index.ts:194

skip

skip(): Promise<string>
Skip the current task.

Reference: skipapi

Returns Promise<string>
Information about the skipped task
- Defined in src/sd/index.ts:142

trainEmbedding

trainEmbedding(options: Record<string, any>): Promise<{ info: string }>
Train embedding from options.

Reference: train_embedding
Parameters
- options: Record<string, any>
  Options for training an embedding
Returns Promise<{ info: string }>
Information about the training
- Defined in src/sd/index.ts:362

trainHyperNetwork

trainHyperNetwork(options: Record<string, any>): Promise<{ info: string }>
Train HyperNetwork from options.

Reference: train_hypernetwork
Parameters
- options: Record<string, any>
  Options for training a HyperNetwork
Returns Promise<{ info: string }>
Information about the training
- Defined in src/sd/index.ts:372

txt2img

txt2img<T extends Partial<Txt2ImgOptions>>(
options: T,
): Promise<Txt2ImgResponse<T>>
Generate images from text.

Reference: text2imgapi
Type Parameters
- T extends Partial<Txt2ImgOptions>
Parameters
- options: T
  Options for generating images from text
Returns Promise<Txt2ImgResponse<T>>
Generated images as base64 strings
- Defined in src/sd/index.ts:51

unloadCheckPoint

unloadCheckPoint(): Promise<string>
Unload the current checkpoint.

Reference: unloadapi

Returns Promise<string>
Information about the unloading
- Defined in src/sd/index.ts:390

upscalers

upscalers(): Promise<UpScaler[]>
Get all available upscalers.

Reference: get_upscalers

Returns Promise<UpScaler[]>
All available upscalers
- Defined in src/sd/index.ts:232

Class SDWebUIApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SDWebUIApi

Properties

Protected_client

Methods

cmdFlags

Returns Promise<CmdFlags>

createEmbedding

Parameters

Returns Promise<{ info: string }>

createHyperNetwork

Parameters

Returns Promise<{ info: string }>

embeddings

Type Parameters

Returns Promise<Embedding<T>[]>

extensions

Returns Promise<Extension[]>

extraBatchImage

Type Parameters

Parameters

Returns Promise<Omit<ExtraImageResponse, "image">>

extraSingleImage

Type Parameters

Parameters

Returns Promise<Omit<ExtraImageResponse, "images">>

faceRestorers

Returns Promise<FaceRestorer[]>

getOptions

Returns Promise<SDOptions>

hyperNetworks

Returns Promise<HyperNetwork[]>

img2img

Type Parameters

Parameters

init_images: string[]

Returns Promise<Img2ImgResponse<T>>

interrogate

Parameters

Returns Promise<string>

interrupt

Returns Promise<string>

latentUpscaleModes

Returns Promise<LatentUpscaleMode[]>

memory

Returns Promise<Memory>

options

Type Parameters

Parameters

Returns Promise<OptionsResponse<T>>

Example

pngInfo

Type Parameters

Parameters

Returns Promise<PngInfoResponse<T>>

progress

Returns Promise<ProgressResponse>

promptStyles

Returns Promise<PromptStyle[]>

realEsrganModels

Returns Promise<RealEsrganModel[]>

refreshCheckpoints

Returns Promise<string>

refreshEmbeddings

Returns Promise<string>

refreshVae

Returns Promise<string>

reloadCheckPoint

Returns Promise<string>

samplers

Returns Promise<Sampler[]>

schedulers

`Protected`_client