Class SDWebUIClient

Represents a client for interacting with the AUTOMATIC1111 Stable Diffusion Web UI API. Extends the Https.Client class to provide methods for making HTTP requests.

Remarks

This client automatically sets the base URL and headers for the API requests. It also supports basic authentication using a username and password.

Example

const client = new SDWebUIClient({
  baseUrl: "https://api.example.com",
  username: "user",
  password: "pass"
});

Param: options

Configuration options for the client.

Param: options.baseUrl

The base URL for the API. If not provided, it will be read from the environment variable SD_API_URL.

Param: options.username

The username for basic authentication. If not provided, it will be read from the environment variable SD_API_USERNAME.

Param: options.password

The password for basic authentication. If not provided, it will be read from the environment variable SD_API_PASSWORD.

Hierarchy (View Summary)

Constructors

constructor

Properties

api

Methods

get post

Constructors

constructor

Properties

api

api: SDWebUIApi = ...

Represents the API for interacting with the AUTOMATIC1111 Stable Diffusion Web UI API.

Methods

get

  • get<T>(
        path: string,
        params?: string | Record<string, string> | URLSearchParams,
        opts?: RequestOptions,
    ): Promise<T>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optionalparams: string | Record<string, string> | URLSearchParams
    • Optionalopts: RequestOptions

    Returns Promise<T>

post

  • post<T>(path: string, data?: unknown, opts?: RequestOptions): Promise<T>

  • Type Parameters

    • T

    Parameters

    • path: string
    • Optionaldata: unknown
    • Optionalopts: RequestOptions

    Returns Promise<T>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods