client_base

Classes

OWUIClientBase

OWUIClientBase(
    api_url: str = "http://127.0.0.1:8080/api",
    api_key: str | None = None,
)

Base class for the OWUIClient, provides the built-in and internal functionality.

Subclassed by:

Code Reference client Classes OpenWebUI

Used by:

Code Reference
- client_base Classes ResourceBase
- routers

Source code in src/owui_client/client_base.py

def __init__(
    self, api_url: str = "http://127.0.0.1:8080/api", api_key: str | None = None
):

    self.api_url = api_url
    """The full URL to the Open WebUI API, including the port if it is not 80/443, e.g. http://127.0.0.1:8080/api for local."""

    self.api_key: str | None = api_key
    """The API key to send with requests (if any)."""

    self.__client: AsyncClient | None = None

Attributes

api_url

api_url = api_url

The full URL to the Open WebUI API, including the port if it is not 80/443, e.g. http://127.0.0.1:8080/api for local.

api_key

api_key: str | None = api_key

The API key to send with requests (if any).

ResourceBase

ResourceBase(client: OWUIClientBase)

Base class for all resource clients (Auths, Chats, etc).

Subclassed by:

Code Reference routers

Source code in src/owui_client/client_base.py

def __init__(self, client: OWUIClientBase):
    self._client = client