Open WebUI Client

https://whogben.github.io/owui_client
Admin
An async Python client library and comprehensive unofficial API documentation for Open WebUI,...
Tokens:199,346
Snippets:2,118
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install the Python Client

Source: https://whogben.github.io/owui_client

Use pip to install the owui-client package.

```bash
pip install owui-client
```

--------------------------------

### GET /v1/pipelines/

Source: https://whogben.github.io/owui_client/reference/routers/pipelines

Retrieves the list of installed pipelines from a pipeline server.

```APIDOC
## GET /v1/pipelines/

### Description
Get the list of installed pipelines from a specific pipeline server.

### Method
GET

### Endpoint
/v1/pipelines/

### Parameters
#### Query Parameters
- **urlIdx** (int) - Optional - The index of the pipeline server to query.

### Response
#### Success Response (200)
- **dict** (dict) - A dictionary containing the list of installed pipelines on that server.
```

--------------------------------

### list()

Source: https://whogben.github.io/owui_client/reference/routers/pipelines

Get the list of configured pipeline servers.

```APIDOC
## GET /v1/pipelines/list

### Description
Get the list of configured pipeline servers. This returns the available OpenAI API base URLs that are configured and capable of hosting pipelines.

### Method
GET

### Endpoint
/v1/pipelines/list

### Response
#### Success Response (200)
- **data** (list) - A list of pipeline server configurations, each containing a URL and an index.
```

--------------------------------

### GET /v1/functions/

Source: https://whogben.github.io/owui_client/reference/routers/functions

Retrieves a list of all available functions.

```APIDOC
## GET /v1/functions/

### Description
Get all functions.

### Method
GET

### Endpoint
/v1/functions/

### Response
#### Success Response (200)
- **list[FunctionResponse]** (array) - A list of all functions.
```

--------------------------------

### Get Admin Configuration

Source: https://whogben.github.io/owui_client/reference/routers/auths

Retrieves global application configuration settings.

```python
async def get_admin_config(self) -> AdminConfig:
    """
    Get the admin configuration.

    Retrieves global configuration settings for the application.

    Returns:
        `AdminConfig`: The admin configuration
    """
    return await self._request(
        "GET",
        "/v1/auths/admin/config",
        model=AdminConfig,
    )
```

--------------------------------

### Get Installed Pipelines

Source: https://whogben.github.io/owui_client/reference/routers/pipelines

Retrieves a list of installed pipelines from a specific server index.

```python
get(url_idx: Optional[int] = None) -> dict
```

```python
async def get(self, url_idx: Optional[int] = None) -> dict:
    """
    Get the list of installed pipelines from a specific pipeline server.

    Args:
        url_idx: The index of the pipeline server to query.

    Returns:
        dict: A dictionary containing the list of installed pipelines on that server.
    """
    params = {}
    if url_idx is not None:
        params["urlIdx"] = url_idx
    return await self._request("GET", "/v1/pipelines/", params=params)
```

--------------------------------

### Initialize Shortcuts

Source: https://whogben.github.io/owui_client/reference/shortcuts

Constructor for the Shortcuts class, requiring an OpenWebUI client instance.

```python
def __init__(self, client: "OpenWebUI"):
    self.client = client
```

--------------------------------

### GET /v1/chats/{id}

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get a chat by ID.

```APIDOC
## GET /v1/chats/{id}

### Description
Get a chat by ID.

### Method
GET

### Endpoint
/v1/chats/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - The chat ID.

### Response
#### Success Response (200)
- **ChatResponse** - The chat object.
```

--------------------------------

### Initialize and Use the Python Client

Source: https://whogben.github.io/owui_client

Connect to an Open WebUI instance and perform basic operations like fetching user info and listing models.

```python
import asyncio
from owui_client import OpenWebUI

async def main():
    # Connect to your Open WebUI instance
    client = OpenWebUI(
        api_url="http://localhost:8080/api", 
        api_key="sk-..."
    )

    # Example: Get current user info
    user = await client.auths.get_session_user()
    print(f"Hello, {user.name}!")

    # Example: List all models
    models = await client.models.get_models()
    for model in models.data:
        print(model.id)

if __name__ == "__main__":
    asyncio.run(main())
```

--------------------------------

### Sync Skill Shortcut

Source: https://whogben.github.io/owui_client/reference/shortcuts

Usage example for syncing a local skill file to Open WebUI.

```python
result = await client.shortcuts.sync_skill("skills/summarizer.md")
print(result.action, result.id)
```

--------------------------------

### GET /v1/chats/all

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all chats for the current user.

```APIDOC
## GET /v1/chats/all

### Description
Get all chats for the current user.

### Method
GET

### Endpoint
/v1/chats/all

### Response
#### Success Response (200)
- **List[ChatResponse]** (array) - List of all chat objects.
```

--------------------------------

### Get Models Configuration

Source: https://whogben.github.io/owui_client/reference/routers/configs

Retrieves the current models configuration settings.

```python
get_models_config() -> ModelsConfigForm
```

```python
async def get_models_config(self) -> ModelsConfigForm:
    """
    Get the current models configuration.

    Returns:
        `ModelsConfigForm` with current settings.
    """
    return await self._request(
        "GET",
        "/v1/configs/models",
        model=ModelsConfigForm,
    )
```

--------------------------------

### GET /v1/retrieval/embedding

Source: https://whogben.github.io/owui_client/reference/routers/retrieval

Get the current embedding configuration.

```APIDOC
## GET /v1/retrieval/embedding

### Description
Get the current embedding configuration.

### Method
GET

### Endpoint
/v1/retrieval/embedding

### Response
#### Success Response (200)
- **response** (Dict) - Dict containing the embedding configuration.
```

--------------------------------

### Initialize Audio Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Audio endpoints.

```python
audio = AudioClient(self)
```

--------------------------------

### User Signup Method

Source: https://whogben.github.io/owui_client/reference/routers/auths

Registers a new user account. The first user created is automatically assigned the 'admin' role.

```python
signup(
    form_data: SignupForm, set_client_api_key: bool = True
) -> SessionUserResponse
```

```python
async def signup(
    self, form_data: SignupForm, set_client_api_key: bool = True
) -> SessionUserResponse:
    """
    Sign up a new user.

    Creates a new user account. If this is the first user, they will be assigned the 'admin' role.
    Subsequent users are assigned the default role (usually 'pending').

    Args:
        form_data: The signup information (name, email, password, etc.)
        set_client_api_key: If True (default), updates the main client's API key upon success

    Returns:
        `SessionUserResponse`: Session information including token and user details
    """
    response = await self._request(
        "POST",
        "/v1/auths/signup",
        model=SessionUserResponse,
        json=form_data.model_dump(exclude_none=True),
    )

    if set_client_api_key and response.token:
        self._client.api_key = response.token

    return response
```

--------------------------------

### GET /v1/chats/all/archived

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all archived chats for the current user.

```APIDOC
## GET /v1/chats/all/archived

### Description
Get all archived chats for the current user.

### Method
GET

### Endpoint
/v1/chats/all/archived

### Response
#### Success Response (200)
- **List[ChatResponse]** (array) - List of archived chat objects.
```

--------------------------------

### GET /v1/configs/models

Source: https://whogben.github.io/owui_client/reference/routers/configs

Retrieve the current models configuration settings.

```APIDOC
## GET /v1/configs/models

### Description
Get the current models configuration.

### Method
GET

### Endpoint
/v1/configs/models

### Response
#### Success Response (200)
- **response** (ModelsConfigForm) - ModelsConfigForm with current settings.
```

--------------------------------

### Initialize OWUIClientBase Instance

Source: https://whogben.github.io/owui_client/reference/client_base

Internal implementation of the OWUIClientBase constructor.

```python
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
```

--------------------------------

### GET /v1/chats/pinned

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all pinned chats for the current user.

```APIDOC
## GET /v1/chats/pinned

### Description
Get all pinned chats for the current user.

### Method
GET

### Endpoint
/v1/chats/pinned

### Response
#### Success Response (200)
- **List[ChatTitleIdResponse]** (array) - List of pinned chats.
```

--------------------------------

### GET /v1/chats/folder/{folder_id}

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all chats in a specific folder.

```APIDOC
## GET /v1/chats/folder/{folder_id}

### Description
Get all chats in a specific folder.

### Method
GET

### Endpoint
/v1/chats/folder/{folder_id}

### Parameters
#### Path Parameters
- **folder_id** (str) - Required - ID of the folder.

### Response
#### Success Response (200)
- **List[ChatResponse]** (array) - List of full chat objects.
```

--------------------------------

### Define a skill file

Source: https://whogben.github.io/owui_client/cli

Create a skill file using YAML frontmatter for the name and description, followed by the skill content.

```yaml
---
name: code-review
description: Step-by-step instructions for code reviews.
---
Review the diff ...
```

--------------------------------

### GET /ollama/config

Source: https://whogben.github.io/owui_client/reference/routers/ollama

Get the current global Ollama configuration.

```APIDOC
## GET /ollama/config

### Description
Get the current global Ollama configuration.

### Method
GET

### Endpoint
/ollama/config

### Response
#### Success Response (200)
- **config** (Dict[str, Any]) - Dict containing ENABLE_OLLAMA_API, OLLAMA_BASE_URLS, OLLAMA_API_CONFIGS.
```

--------------------------------

### Initialize Knowledge Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Knowledge endpoints.

```python
knowledge = KnowledgeClient(self)
```

--------------------------------

### Get Images Configuration

Source: https://whogben.github.io/owui_client/reference/routers/images

Retrieves the current configuration for image generation.

```python
async def get_config(self) -> ImagesConfig:
    """
    Get the images configuration.

    Returns:
        `ImagesConfig`: The current images configuration.
    """
    return await self._request(
        "GET",
        "/v1/images/config",
        model=ImagesConfig,
    )
```

--------------------------------

### GET /v1/auths/admin/config

Source: https://whogben.github.io/owui_client/reference/routers/auths

Retrieves global configuration settings for the application.

```APIDOC
## GET /v1/auths/admin/config

### Description
Get the admin configuration. Retrieves global configuration settings for the application.

### Method
GET

### Endpoint
/v1/auths/admin/config

### Response
#### Success Response (200)
- **AdminConfig** (AdminConfig) - The admin configuration
```

--------------------------------

### Initialize UsersClient

Source: https://whogben.github.io/owui_client/reference/routers/users

Constructor for the UsersClient class, requiring an instance of OWUIClientBase.

```python
UsersClient(client: OWUIClientBase)
```

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

--------------------------------

### GET /v1/retrieval/config

Source: https://whogben.github.io/owui_client/reference/routers/retrieval

Get the current retrieval configuration and status.

```APIDOC
## GET /v1/retrieval/config

### Description
Get the current retrieval configuration and status.

### Method
GET

### Endpoint
/v1/retrieval/config

### Response
#### Success Response (200)
- **response** (Dict) - Dict containing retrieval status and configuration fields.
```

--------------------------------

### GET /v1/notes/{id}

Source: https://whogben.github.io/owui_client/reference/routers/notes

Get a specific note by its ID.

```APIDOC
## GET /v1/notes/{id}

### Description
Get a specific note by its ID.

### Method
GET

### Endpoint
/v1/notes/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - The unique identifier of the note.

### Response
#### Success Response (200)
- **NoteModel** (Optional) - The requested note, or None if not found or not accessible.
```

--------------------------------

### POST /v1/folders/

Source: https://whogben.github.io/owui_client/reference/routers/folders

Creates a new root folder.

```APIDOC
## POST /v1/folders/

### Description
Create a new root folder. To create a nested folder, create a root folder and then move it using the update_folder_parent_id_by_id method.

### Method
POST

### Endpoint
/v1/folders/

### Parameters
#### Request Body
- **form_data** (FolderForm) - Required - The form data for creating the folder.

### Response
#### Success Response (200)
- **FolderModel** - The created folder model.
```

--------------------------------

### GET /v1/chats/all/db

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all chats in the database. This endpoint is restricted to administrators.

```APIDOC
## GET /v1/chats/all/db

### Description
Get all chats in the database (Admin only).

### Method
GET

### Endpoint
/v1/chats/all/db

### Response
#### Success Response (200)
- **List[ChatResponse]** - List of all chat objects for all users.
```

--------------------------------

### OWUIClientBase Constructor

Source: https://whogben.github.io/owui_client/reference/client_base

Initializes the base client with the target API URL and an optional API key for authentication.

```APIDOC
## OWUIClientBase(api_url, api_key)

### Description
Initializes a new instance of the OWUIClientBase class. This class acts as the base for all specific resource clients.

### Parameters
- **api_url** (str) - Optional - The full URL to the Open WebUI API (default: "http://127.0.0.1:8080/api").
- **api_key** (str | None) - Optional - The API key to include in requests for authentication.
```

--------------------------------

### Initialize Images Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Images endpoints.

```python
images = ImagesClient(self)
```

--------------------------------

### GET /v1/prompts/id/{prompt_id}/history

Source: https://whogben.github.io/owui_client/reference/routers/prompts

Get version history for a prompt.

```APIDOC
## GET /v1/prompts/id/{prompt_id}/history

### Description
Get version history for a prompt. Returns paginated history entries ordered by creation time (newest first).

### Method
GET

### Endpoint
/v1/prompts/id/{prompt_id}/history

### Parameters
#### Path Parameters
- **prompt_id** (str) - Required - The unique identifier of the prompt.

#### Query Parameters
- **page** (int) - Optional - Page number (0-indexed, default 0).

### Response
#### Success Response (200)
- **List[PromptHistoryResponse]** (array) - List of history entries with user info.
```

--------------------------------

### GET /v1/files/{id}/process/status

Source: https://whogben.github.io/owui_client/reference/routers/files

Get the processing status of a file.

```APIDOC
## GET /v1/files/{id}/process/status

### Description
Get the processing status of a file.

### Method
GET

### Endpoint
/v1/files/{id}/process/status

### Parameters
#### Path Parameters
- **id** (str) - Required - The UUID of the file.

#### Query Parameters
- **stream** (bool) - Optional - If True, returns an SSE stream (not fully supported). Use False for a one-time status check. Default: False

### Response
#### Success Response (200)
- **dict** (object) - The status object (e.g. {"status": "completed"}).
```

--------------------------------

### Initialize OpenWebUI Client

Source: https://whogben.github.io/owui_client/reference/client

Constructor for the OpenWebUI client, accepting an optional API URL and API key.

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

--------------------------------

### Initialize Shortcuts Helper

Source: https://whogben.github.io/owui_client/reference/client

Initializes the helper for shortcut methods.

```python
shortcuts = Shortcuts(self)
```

--------------------------------

### GET /v1/files/{id}

Source: https://whogben.github.io/owui_client/reference/routers/files

Get detailed information about a specific file.

```APIDOC
## GET /v1/files/{id}

### Description
Get detailed information about a specific file.

### Method
GET

### Endpoint
/v1/files/{id}

### Parameters
#### Path Parameters
- **id** (str) - Required - The UUID of the file.

### Response
#### Success Response (200)
- **FileModel** (object) - The file details if found.
```

--------------------------------

### Initialize Folders Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Folders endpoints.

```python
folders = FoldersClient(self)
```

--------------------------------

### GET /v1/evaluations/feedbacks/list

Source: https://whogben.github.io/owui_client/reference/routers/evaluations

Get a paginated and sorted list of feedbacks (admin only).

```APIDOC
## GET /v1/evaluations/feedbacks/list

### Description
Get a paginated and sorted list of feedbacks (admin only).

### Method
GET

### Endpoint
/v1/evaluations/feedbacks/list

### Parameters
#### Query Parameters
- **order_by** (string) - Optional - The field name to order the results by (e.g., 'created_at').
- **direction** (string) - Optional - The sort direction, either 'asc' (ascending) or 'desc' (descending).
- **page** (integer) - Optional - The page number to retrieve (default is 1).

### Response
#### Success Response (200)
- **FeedbackListResponse** - A response object containing the list of feedbacks and pagination details.
```

--------------------------------

### Initialize Tools Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Tools endpoints.

```python
tools = ToolsClient(self)
```

--------------------------------

### OpenWebUI Class Constructor Implementation

Source: https://whogben.github.io/owui_client/reference/client

Internal initialization of the OpenWebUI client and its associated sub-resource clients.

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

    self.auths = AuthsClient(self)
    """Client for Authentication endpoints."""

    self.users = UsersClient(self)
    """Client for Users endpoints."""

    self.configs = ConfigsClient(self)
    """Client for Configs endpoints."""

    self.notes = NotesClient(self)
    """Client for Notes endpoints."""

    self.groups = GroupsClient(self)
    """Client for Groups endpoints."""

    self.prompts = PromptsClient(self)
    """Client for Prompts endpoints."""

    self.files = FilesClient(self)
    """Client for Files endpoints."""

    self.openai = OpenAIClient(self)
    """Client for OpenAI-compatible endpoints."""

    self.ollama = OllamaClient(self)
    """Client for Ollama endpoints."""

    self.pipelines = PipelinesClient(self)
    """Client for Pipelines endpoints."""

    self.tasks = TasksClient(self)
    """Client for Tasks endpoints."""

    self.images = ImagesClient(self)
    """Client for Images endpoints."""

    self.audio = AudioClient(self)
    """Client for Audio endpoints."""

    self.retrieval = RetrievalClient(self)
    """Client for Retrieval endpoints."""

    self.channels = ChannelsClient(self)
    """Client for Channels endpoints."""

    self.chats = ChatsClient(self)
    """Client for Chats endpoints."""

    self.models = ModelsClient(self)
    """Client for Models endpoints."""

    self.knowledge = KnowledgeClient(self)
    """Client for Knowledge endpoints."""

    self.tools = ToolsClient(self)
    """Client for Tools endpoints."""

    self.skills = SkillsClient(self)
    """Client for Skills endpoints."""

    self.memories = MemoriesClient(self)
    """Client for Memories endpoints."""

    self.analytics = AnalyticsClient(self)
    """Client for Analytics endpoints."""

    self.automations = AutomationsClient(self)
    """Client for Automations endpoints."""

    self.calendar = CalendarClient(self)
    """Client for Calendar endpoints."""

    self.folders = FoldersClient(self)
    """Client for Folders endpoints."""

    self.functions = FunctionsClient(self)
    """Client for Functions endpoints."""

    self.evaluations = EvaluationsClient(self)
    """Client for Evaluations endpoints."""

    self.events = EventsClient(self)
    """Client for Event Webhooks endpoints."""

    self.terminals = TerminalsClient(self)
    """Client for Terminals endpoints."""

    self.utils = UtilsClient(self)
    """Client for Utils endpoints."""

    self.root = RootClient(self)
    """Client for Root endpoints."""

    self.shortcuts = Shortcuts(self)
    """Helper for shortcut methods."""
```

--------------------------------

### GET /v1/chats/archived/count

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get the total count of archived chats for the current user.

```APIDOC
## GET /v1/chats/archived/count

### Description
Get the number of archived chats for the current user.

### Method
GET

### Endpoint
/v1/chats/archived/count

### Response
#### Success Response (200)
- **int** - The count of archived chats.
```

--------------------------------

### GET /v1/prompts/

Source: https://whogben.github.io/owui_client/reference/routers/prompts

Retrieves a list of all prompts that the current user has read access to.

```APIDOC
## GET /v1/prompts/

### Description
Get all prompts the user has read access to.

### Method
GET

### Endpoint
/v1/prompts/

### Response
#### Success Response (200)
- **prompts** (List[PromptModel]) - List of prompts.
```

--------------------------------

### GET /v1/chats/all/tags

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get all tags used by the current user across all chats.

```APIDOC
## GET /v1/chats/all/tags

### Description
Get all tags used by the current user across all chats.

### Method
GET

### Endpoint
/v1/chats/all/tags

### Response
#### Success Response (200)
- **List[TagModel]** (array) - List of tag objects.
```

--------------------------------

### Initialize Root Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Root endpoints.

```python
root = RootClient(self)
```

--------------------------------

### Retrieve Configuration

Source: https://whogben.github.io/owui_client/reference/routers/root

Fetches the application configuration, including status, name, version, and feature flags.

```python
async def get_config(self) -> Dict[str, Any]:
    """
    Get the application configuration.

    Returns:
        A dictionary containing configuration details such as:
        - `status`: Application status.
        - `name`: WebUI name.
        - `version`: Application version.
        - `oauth`: OAuth providers configuration.
        - `features`: Enabled features (auth, signup, etc.).
        - `default_models`: Default models configuration (if authenticated).
    """
    return await self._request("GET", "/config", model=dict)
```

--------------------------------

### GET /v1/chats/folder/{folder_id}/list

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get a paginated list of chats in a folder.

```APIDOC
## GET /v1/chats/folder/{folder_id}/list

### Description
Get a paginated list of chats in a folder.

### Method
GET

### Endpoint
/v1/chats/folder/{folder_id}/list

### Parameters
#### Path Parameters
- **folder_id** (str) - Required - ID of the folder.

#### Query Parameters
- **page** (int) - Optional - Page number for pagination (default: 1).

### Response
#### Success Response (200)
- **List[dict]** (array) - List of dictionaries containing basic chat info (id, title, updated_at).
```

--------------------------------

### GET /v1/prompts/id/{prompt_id}/history/{history_id}

Source: https://whogben.github.io/owui_client/reference/routers/prompts

Get a specific version from history.

```APIDOC
## GET /v1/prompts/id/{prompt_id}/history/{history_id}

### Description
Get a specific version from history.

### Method
GET

### Endpoint
/v1/prompts/id/{prompt_id}/history/{history_id}

### Parameters
#### Path Parameters
- **prompt_id** (str) - Required - The unique identifier of the prompt.
- **history_id** (str) - Required - The unique identifier of the history entry.

### Response
#### Success Response (200)
- **PromptHistoryModel** (object) - The history entry details.
```

--------------------------------

### Initialize OWUIClientBase

Source: https://whogben.github.io/owui_client/reference/client_base

Constructor for the base client class, accepting the API URL and an optional API key.

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

--------------------------------

### POST /v1/knowledge/create

Source: https://whogben.github.io/owui_client/reference/routers/knowledge

Creates a new knowledge base. Requires specific workspace and sharing permissions.

```APIDOC
## POST /v1/knowledge/create

### Description
Create a new knowledge base. Requires `workspace.knowledge` permission. If `access_control` is `None` (public), requires `sharing.public_knowledge` permission. If the user lacks `sharing.public_knowledge` permission, `access_control` will default to private `{}`.

### Method
POST

### Endpoint
/v1/knowledge/create

### Parameters
#### Request Body
- **form_data** (KnowledgeForm) - Required - The data for the new knowledge base.

### Response
#### Success Response (200)
- **KnowledgeResponse** (Optional[KnowledgeResponse]) - The created knowledge base.
```

--------------------------------

### GET /v1/files/{id}/data/content

Source: https://whogben.github.io/owui_client/reference/routers/files

Get the extracted text content of a file.

```APIDOC
## GET /v1/files/{id}/data/content

### Description
Get the extracted text content of a file.

### Method
GET

### Endpoint
/v1/files/{id}/data/content

### Parameters
#### Path Parameters
- **id** (str) - Required - The UUID of the file.

### Response
#### Success Response (200)
- **dict** (object) - Wrapper containing the content, e.g. {"content": "Extracted text..."}.
```

--------------------------------

### GET /v1/evaluations/feedbacks/user

Source: https://whogben.github.io/owui_client/reference/routers/evaluations

Get a paginated list of feedbacks submitted by the current user.

```APIDOC
## GET /v1/evaluations/feedbacks/user

### Description
Get a paginated list of feedbacks submitted by the current user.

### Method
GET

### Endpoint
/v1/evaluations/feedbacks/user

### Response
#### Success Response (200)
- **FeedbackListResponse** - A response containing the user's feedback items and the total count.
```

--------------------------------

### Export System Configuration

Source: https://whogben.github.io/owui_client/reference/routers/configs

Retrieves the full system configuration dictionary via a GET request.

```python
async def export_config(self) -> Dict[str, Any]:
    """
    Export the current system configuration.

    This returns the full configuration dictionary including all settings,
    models, and other system-wide configurations.

    Returns:
        The configuration dictionary.
    """
    return await self._request(
        "GET",
        "/v1/configs/export",
        model=dict,
    )
```

--------------------------------

### Initialize Skills Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Skills endpoints.

```python
skills = SkillsClient(self)
```

--------------------------------

### Example Channel Data

Source: https://whogben.github.io/owui_client/reference/models/channels

Example usage of the 'data' field for channel-specific metadata.

```json
{
    "theme": "dark",
    "notifications": {
        "mentions_only": True,
        "sound_enabled": False
    },
    "integration_config": {
        "webhook_url": "https://example.com/webhook",
        "api_key": "secret_key_123"
    },
    "settings": {
        "auto_archive": True,
        "message_retention_days": 30
    }
}
```

--------------------------------

### Sync skills to Open WebUI

Source: https://whogben.github.io/owui_client/cli

Synchronize local skill files or directories into the Open WebUI workspace.

```bash
owui-client sync-skill  ./skills/code-review/SKILL.md
owui-client sync-skills ./skills
```

--------------------------------

### ChannelMemberModel Data Field Example

Source: https://whogben.github.io/owui_client/reference/models/channels

Example JSON structure for the 'data' field of the ChannelMemberModel.

```json
{
    "preferences": {
        "theme": "dark",
        "notifications": {
            "mentions_only": True,
            "sound_enabled": False
        }
    },
    "integration_config": {
        "webhook_url": "https://example.com/webhook",
        "api_key": "secret_key_123"
    },
    "role_data": {
        "custom_permissions": ["read", "write"],
        "expiration_date": "2025-12-31"
    }
}
```

--------------------------------

### Get Prompt Diff Implementation

Source: https://whogben.github.io/owui_client/reference/routers/prompts

The implementation of the get_prompt_diff method, which performs an asynchronous GET request to the API.

```python
async def get_prompt_diff(
    self, prompt_id: str, from_id: str, to_id: str
) -> PromptDiffResponse:
    """Get diff between two prompt versions.

    Computes a unified diff of the content between two history entries.

    Args:
        prompt_id: The unique identifier of the prompt.
        from_id: ID of the source (from) history entry.
        to_id: ID of the target (to) history entry.

    Returns:
        `PromptDiffResponse`: Diff information between the two versions.
    """
    return await self._request(
        "GET",
        f"/v1/prompts/id/{prompt_id}/history/diff",
        params={"from_id": from_id, "to_id": to_id},
        model=PromptDiffResponse,
    )
```

--------------------------------

### Initialize Utils Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Utils endpoints.

```python
utils = UtilsClient(self)
```

--------------------------------

### Get Audio Configuration

Source: https://whogben.github.io/owui_client/reference/routers/audio

Retrieves the current TTS and STT engine settings.

```python
async def get_config(self) -> dict:
    """
    Get the current audio configuration.

    This includes settings for both Text-to-Speech (TTS) and Speech-to-Text (STT) engines,
    such as API keys, base URLs, models, and voice settings.

    Returns:
        dict: The current configuration, with keys 'tts' and 'stt'.
    """
    return await self._request("GET", "/v1/audio/config")
```

--------------------------------

### GET /v1/tasks/config

Source: https://whogben.github.io/owui_client/reference/routers/tasks

Get the global task configuration, including settings for title generation, tags, and autocomplete.

```APIDOC
## GET /v1/tasks/config

### Description
Get the global task configuration. This includes settings for title generation, tags, autocomplete, etc.

### Method
GET

### Endpoint
/v1/tasks/config

### Response
#### Success Response (200)
- **config** (Dict[str, Any]) - The task configuration dictionary.
```

--------------------------------

### Initialize ResourceBase

Source: https://whogben.github.io/owui_client/reference/client_base

Constructor for the base resource client class, requiring an OWUIClientBase instance.

```python
ResourceBase(client: OWUIClientBase)
```

--------------------------------

### POST /v1/configs/import

Source: https://whogben.github.io/owui_client/reference/routers/configs

Imports a system configuration dictionary to update the current settings.

```APIDOC
## POST /v1/configs/import

### Description
Import a system configuration.

### Method
POST

### Endpoint
/v1/configs/import

### Request Body
- **config** (Dict[str, Any]) - Required - The configuration dictionary to import.

### Response
#### Success Response (200)
- **config** (Dict[str, Any]) - The updated configuration dictionary.
```

--------------------------------

### Meta Field Example

Source: https://whogben.github.io/owui_client/reference/models/channels

An example of the JSON structure that can be stored in the 'meta' field for channel-specific metadata.

```json
{
    "theme": "dark",
    "notifications": {
        "mentions_only": True,
        "sound_enabled": False
    },
    "integration_config": {
        "webhook_url": "https://example.com/webhook",
        "api_key": "secret_key_123"
    },
    "settings": {
        "auto_archive": True,
        "message_retention_days": 30
    }
}

```

--------------------------------

### Initialize Channels Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Channels endpoints.

```python
channels = ChannelsClient(self)
```

--------------------------------

### Calendar Event Start Time

Source: https://whogben.github.io/owui_client/reference/models/calendar

The start time of the event in nanoseconds since epoch.

```python
start_at: int
```

--------------------------------

### Example KnowledgeForm access_control configuration

Source: https://whogben.github.io/owui_client/reference/models/knowledge

Example of custom read and write permissions using group and user IDs.

```json
{
    "read": {
        "group_ids": ["group_id1", "group_id2"],
        "user_ids":  ["user_id1", "user_id2"]
    },
    "write": {
        "group_ids": ["group_id1", "group_id2"],
        "user_ids":  ["user_id1", "user_id2"]
    }
}
```

--------------------------------

### Configure environment variables

Source: https://whogben.github.io/owui_client/cli

Set the server URL and API key via environment variables to define connection defaults.

```bash
export OWUI_SERVER=https://owui.example.com/api
export OWUI_API_KEY=sk-...
```

--------------------------------

### Initialize Tasks Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Tasks endpoints.

```python
tasks = TasksClient(self)
```

--------------------------------

### GET /v1/files/{id}/content/html

Source: https://whogben.github.io/owui_client/reference/routers/files

Get the file content to be served as HTML. Restricted to files owned by an Admin user.

```APIDOC
## GET /v1/files/{id}/content/html

### Description
Get the file content to be served as HTML. Restricted to files owned by an Admin user.

### Method
GET

### Endpoint
/v1/files/{id}/content/html

### Parameters
#### Path Parameters
- **id** (str) - Required - The UUID of the file.

### Response
#### Success Response (200)
- **bytes** (bytes) - The file content.
```

--------------------------------

### Example Access Control JSON

Source: https://whogben.github.io/owui_client/reference/models/channels

An example of how the access control dictionary can be structured to define read and write permissions.

```json
{
    "read": {
        "group_ids": ["group1", "group2"],
        "user_ids": ["user1", "user2"]
    },
    "write": {
        "group_ids": ["admin_group"],
        "user_ids": ["channel_owner"]
    }
}
```

--------------------------------

### Initialize Memories Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Memories endpoints.

```python
memories = MemoriesClient(self)
```

--------------------------------

### Get channel details by ID

Source: https://whogben.github.io/owui_client/reference/routers/channels

Retrieves comprehensive channel information including member lists and permissions using a GET request.

```python
async def get(self, id: str) -> Optional[ChannelFullResponse]:
    """
    Get detailed channel information by ID.

    Args:
        id: The channel ID.

    Returns:
        Optional[ChannelFullResponse]: Detailed channel info including members and user permissions.
    """
    return await self._request(
        "GET",
        f"/v1/channels/{id}",
        model=Optional[ChannelFullResponse],
    )
```

--------------------------------

### OpenWebUI Class Constructor

Source: https://whogben.github.io/owui_client/reference/client

Initializes the main client for the Open WebUI API, allowing configuration of the base API URL and authentication credentials.

```APIDOC
## OpenWebUI(api_url, api_key)

### Description
Initializes the OpenWebUI client instance. This class acts as the central hub for all sub-clients (routers) that provide access to specific API endpoints.

### Parameters
- **api_url** (str) - Optional - The base URL for the Open WebUI API. Defaults to "http://127.0.0.1:8080/api".
- **api_key** (str | None) - Optional - The API key to be used for authentication. Defaults to None.

### Usage Example
```python
from owui_client import OpenWebUI

client = OpenWebUI(api_url="http://your-instance.com/api", api_key="your-secret-key")
# Access sub-clients
client.users.get_users()
```
```

--------------------------------

### Initialize ResourceBase Instance

Source: https://whogben.github.io/owui_client/reference/client_base

Internal implementation of the ResourceBase constructor.

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

--------------------------------

### Access Control Example

Source: https://whogben.github.io/owui_client/reference/models/channels

An example demonstrating the structure for read and write access control configurations within the 'access_control' field.

```json
{
    "read": {
        "group_ids": ["group1", "group2"],
        "user_ids": ["user1", "user2"]
    },
    "write": {
        "group_ids": ["admin_group"],
        "user_ids": ["channel_owner"]
    }
}

```

--------------------------------

### Initialize Functions Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Functions endpoints.

```python
functions = FunctionsClient(self)
```

--------------------------------

### Meta Field Example

Source: https://whogben.github.io/owui_client/reference/models/channels

An example of the 'meta' field, which is an optional dictionary for storing arbitrary key-value pairs for membership-specific metadata. It's a flexible JSON field that can store any valid JSON structure.

```python
meta: Optional[dict] = None
```

```json
{
    "preferences": {
        "theme": "dark",
        "notifications": {
            "mentions_only": True,
            "sound_enabled": False
        }
    },
    "integration_config": {
        "webhook_url": "https://example.com/webhook",
        "api_key": "secret_key_123"
    },
    "role_data": {
        "custom_permissions": ["read", "write"],
        "expiration_date": "2025-12-31"
    },
    "last_activity": {
        "timestamp": 1234567890,
        "action": "sent_message"
    }
}
```

--------------------------------

### GET /v1/tools/

Source: https://whogben.github.io/owui_client/reference/routers/tools

Retrieves a list of all available tools, including local tools and those from configured servers like OpenAPI or MCP.

```APIDOC
## GET /v1/tools/

### Description
Get all available tools. This includes local tools and tools from configured servers (OpenAPI, MCP).

### Method
GET

### Endpoint
/v1/tools/

### Response
#### Success Response (200)
- **List[ToolUserResponse]** - List of tools with user information.
```

--------------------------------

### get_version

Source: https://whogben.github.io/owui_client/reference/routers/ollama

Get the Ollama version.

```APIDOC
## get_version(url_idx: int = None)

### Description
Get the Ollama version.

### Parameters
#### Parameters
- **url_idx** (int) - Optional - Index of the Ollama server to query.

### Returns
- **Dict[str, Any]** - Dict containing version string.
```

--------------------------------

### ModelsClient Initialization

Source: https://whogben.github.io/owui_client/reference/routers/models

Constructor for the ModelsClient class, requiring an OWUIClientBase instance.

```python
ModelsClient(client: OWUIClientBase)
```

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

--------------------------------

### GET /v1/models/export

Source: https://whogben.github.io/owui_client/reference/routers/models

Exports all models.

```APIDOC
## GET /v1/models/export

### Description
Export all models.

### Method
GET

### Endpoint
/v1/models/export

### Response
#### Success Response (200)
- **list[ModelModel]** (array) - List of all models.
```

--------------------------------

### Initialize Automations Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Automations endpoints.

```python
automations = AutomationsClient(self)
```

--------------------------------

### GET /v1/configs/banners

Source: https://whogben.github.io/owui_client/reference/routers/configs

Retrieves the current banners.

```APIDOC
## GET /v1/configs/banners

### Description
Get the current banners.

### Method
GET

### Endpoint
/v1/configs/banners

### Response
#### Success Response (200)
- **response** (List[BannerModel]) - List of BannerModel.
```

--------------------------------

### POST /v1/chats/tags

Source: https://whogben.github.io/owui_client/reference/routers/chats

Get chats filtered by tags.

```APIDOC
## POST /v1/chats/tags

### Description
Get chats filtered by tags.

### Method
POST

### Endpoint
/v1/chats/tags

### Parameters
#### Request Body
- **form_data** (TagFilterForm) - Required - Filter options including the tag name and pagination.

### Response
#### Success Response (200)
- **List[ChatTitleIdResponse]** - List of chats matching the tag.
```

--------------------------------

### Initialize MemoriesClient

Source: https://whogben.github.io/owui_client/reference/routers/memories

Constructor for the MemoriesClient class, requiring an instance of OWUIClientBase.

```python
MemoriesClient(client: OWUIClientBase)
```

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

--------------------------------

### GET /tasks

Source: https://whogben.github.io/owui_client/reference/routers/tasks

Lists all active background tasks.

```APIDOC
## GET /tasks

### Description
List all active background tasks.

### Method
GET

### Endpoint
/tasks

### Response
#### Success Response (200)
- **tasks** (List[str]) - A list of active task IDs.
```

--------------------------------

### Initialize Models Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Models endpoints.

```python
models = ModelsClient(self)
```

--------------------------------

### GET /ollama/

Source: https://whogben.github.io/owui_client/reference/routers/ollama

Check the status of the Ollama service.

```APIDOC
## GET /ollama/

### Description
Check the status of the Ollama service.

### Method
GET

### Endpoint
/ollama/

### Response
#### Success Response (200)
- **status** (Dict[str, bool]) - Dict containing status (e.g. {"status": True})
```

--------------------------------

### Import System Configuration

Source: https://whogben.github.io/owui_client/reference/routers/configs

Imports a configuration dictionary using a POST request with an ImportConfigForm.

```python
async def import_config(self, config: Dict[str, Any]) -> Dict[str, Any]:
    """
    Import a system configuration.

    Args:
        config: The configuration dictionary to import.

    Returns:
        The updated configuration dictionary.
    """
    return await self._request(
        "POST",
        "/v1/configs/import",
        model=dict,
        json=ImportConfigForm(config=config).model_dump(),
    )
```

--------------------------------

### Is Production

Source: https://whogben.github.io/owui_client/reference/models/prompts

Optional boolean indicating if the new version should be set as production.

```python
is_production: Optional[bool] = True
```

--------------------------------

### GET /api/models/base

Source: https://whogben.github.io/owui_client/reference/routers/models

Retrieves a list of all base models.

```APIDOC
## GET /api/models/base

### Description
Get all base models (legacy endpoint).

### Method
GET

### Endpoint
/api/models/base

### Response
#### Success Response (200)
- **list[ModelResponse]** (array) - List of base models.
```

--------------------------------

### POST /v1/notes/create

Source: https://whogben.github.io/owui_client/reference/routers/notes

Create a new note.

```APIDOC
## POST /v1/notes/create

### Description
Create a new note.

### Method
POST

### Endpoint
/v1/notes/create

### Parameters
#### Request Body
- **form_data** (NoteForm) - Required - The data for the new note.

### Response
#### Success Response (200)
- **NoteModel** (Optional) - The created note, or None if creation failed.
```

--------------------------------

### GET /v1/users/user/settings

Source: https://whogben.github.io/owui_client/reference/routers/users

Retrieves the settings for the current session user.

```APIDOC
## GET /v1/users/user/settings

### Description
Get the current session user's settings.

### Method
GET

### Endpoint
/v1/users/user/settings

### Response
#### Success Response (200)
- **UserSettings** (Optional[UserSettings]) - User settings if available.
```

--------------------------------

### GET /v1/users/permissions

Source: https://whogben.github.io/owui_client/reference/routers/users

Retrieves the current user's permissions.

```APIDOC
## GET /v1/users/permissions

### Description
Get the current user's permissions.

### Method
GET

### Endpoint
/v1/users/permissions

### Response
#### Success Response (200)
- **Dict** (Dict) - Dictionary of user permissions (workspace, sharing, chat, features).
```

--------------------------------

### CLI entry point

Source: https://whogben.github.io/owui_client/reference/cli

The main entry point for the console script execution.

```python
main() -> None
```

```python
def main() -> None:
    """Entry point for the console script / ``python -m owui_client.cli``."""
    app()
```

--------------------------------

### GET /v1/chats/search

Source: https://whogben.github.io/owui_client/reference/routers/chats

Searches for chats based on a text query.

```APIDOC
## GET /v1/chats/search

### Description
Search for chats.

### Method
GET

### Endpoint
/v1/chats/search

### Parameters
#### Query Parameters
- **text** (str) - Required - The search query text.
- **page** (int) - Optional - Page number for pagination.

### Response
#### Success Response (200)
- **List[ChatTitleIdResponse]** - List of chats matching the search query.
```

--------------------------------

### Implementation of discover_skill_files

Source: https://whogben.github.io/owui_client/reference/skillfiles

The full implementation of the recursive skill file discovery and validation logic.

```python
def discover_skill_files(dir_path: str | Path) -> list[DiscoveredSkillFile]:
    """Recursively discover and parse every Markdown skill file under a directory.

    Walks `dir_path` at arbitrary depth (skills commonly live in their own
    subdirs), deterministically sorted by path, and parses each ``.md`` file via
    `parse_skill_file`. Files that are not valid skills (no frontmatter,
    unparseable YAML, missing/empty ``name`` or ``description``) are reported
    with a `skip_reason` rather than raising, so one bad file does not abort the
    whole scan.

    After parsing, duplicate normalized ids among the successfully-parsed files
    are detected: any id claimed by more than one file marks ALL of those files
    as skipped (`parsed` set to None) with a reason naming the other files.

    This function is pure and performs no network access.

    Args:
        dir_path: Directory to scan recursively.

    Returns:
        A list of `DiscoveredSkillFile`, sorted by path.

    Raises:
        `InvalidSkillFileError`: If `dir_path` does not exist or is not a
            directory.
    """
    root = Path(dir_path)
    if not root.exists():
        raise InvalidSkillFileError(f"Skill directory {root} does not exist.")
    if not root.is_dir():
        raise InvalidSkillFileError(f"Skill directory {root} is not a directory.")

    discovered: list[DiscoveredSkillFile] = []
    for file_path in sorted(root.rglob("*.md")):
        try:
            parsed = parse_skill_file(file_path)
        except InvalidSkillFileError as e:
            discovered.append(
                DiscoveredSkillFile(path=file_path, parsed=None, skip_reason=str(e))
            )
            continue
        discovered.append(
            DiscoveredSkillFile(path=file_path, parsed=parsed, skip_reason=None)
        )

    # Detect duplicate normalized ids among successfully-parsed files. Any id
    # claimed by more than one file marks ALL of those files as skipped.
    id_to_paths: dict[str, list[Path]] = {}
    for d in discovered:
        if d.parsed is not None:
            id_to_paths.setdefault(d.parsed.id, []).append(d.path)
    duplicate_ids = {id_ for id_, paths in id_to_paths.items() if len(paths) > 1}

    if duplicate_ids:
        resolved: list[DiscoveredSkillFile] = []
        for d in discovered:
            if d.parsed is not None and d.parsed.id in duplicate_ids:
                others = [str(p) for p in id_to_paths[d.parsed.id] if p != d.path]
                reason = (
                    f"duplicate skill name '{d.parsed.name}' (id '{d.parsed.id}') "
                    f"also defined in: {', '.join(others)}"
                )
                resolved.append(
                    DiscoveredSkillFile(path=d.path, parsed=None, skip_reason=reason)
                )
            else:
                resolved.append(d)
        discovered = resolved

    return discovered
```

--------------------------------

### Initialize Retrieval Client

Source: https://whogben.github.io/owui_client/reference/client

Initializes the client for interacting with Retrieval endpoints.

```python
retrieval = RetrievalClient(self)
```

--------------------------------

### GET /v1/models/tags

Source: https://whogben.github.io/owui_client/reference/routers/models

Retrieves all unique tags used in models.

```APIDOC
## GET /v1/models/tags

### Description
Get all unique tags used in models.

### Method
GET

### Endpoint
/v1/models/tags

### Response
#### Success Response (200)
- **list[str]** (array) - List of tag names.
```
Tokens:
Raw