Skip to content

folders

Classes

FoldersClient 

FoldersClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Folders endpoints.

Used by:
Source code in src/owui_client/client_base.py 
175
176
def __init__(self, client: OWUIClientBase):
    self._client = client

Functions

get_folders 
get_folders() -> List[FolderNameIdResponse]

Get all folders for the current user.

Returns:

Type Description
List[FolderNameIdResponse]

List[FolderNameIdResponse]: A list of folders with basic information.
Source code in src/owui_client/routers/folders.py 
18
19
20
21
22
23
24
25
26
27
28
29
async def get_folders(self) -> List[FolderNameIdResponse]:
    """
    Get all folders for the current user.

    Returns:
        List[FolderNameIdResponse]: A list of folders with basic information.
    """
    return await self._request(
        "GET",
        "/v1/folders/",
        model=List[FolderNameIdResponse],
    )
create_folder 
create_folder(form_data: FolderForm) -> FolderModel

Create a new root folder.

To create a nested folder, create a root folder and then move it using update_folder_parent_id_by_id.

Parameters:

Name Type Description Default
form_data FolderForm

The form data for creating the folder.

 required

Returns:

Type Description
FolderModel

FolderModel: The created folder model.
Source code in src/owui_client/routers/folders.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
async def create_folder(self, form_data: FolderForm) -> FolderModel:
    """
    Create a new root folder.

    To create a nested folder, create a root folder and then move it using `update_folder_parent_id_by_id`.

    Args:
        form_data: The form data for creating the folder.

    Returns:
        `FolderModel`: The created folder model.
    """
    return await self._request(
        "POST",
        "/v1/folders/",
        json=form_data.model_dump(),
        model=FolderModel,
    )
get_folder_by_id 
get_folder_by_id(id: str) -> Optional[FolderModel]

Get a folder by ID.

Parameters:

Name Type Description Default
id str

The folder ID.

 required

Returns:

Type Description
Optional[FolderModel]

Optional[FolderModel]: The folder model, or None if not found.
Source code in src/owui_client/routers/folders.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
async def get_folder_by_id(self, id: str) -> Optional[FolderModel]:
    """
    Get a folder by ID.

    Args:
        id: The folder ID.

    Returns:
        Optional[FolderModel]: The folder model, or None if not found.
    """
    return await self._request(
        "GET",
        f"/v1/folders/{id}",
        model=Optional[FolderModel],
    )
update_folder_name_by_id 
update_folder_name_by_id(
    id: str, form_data: FolderUpdateForm
) -> FolderModel

Update a folder's details (name, data, meta) by ID.

Parameters:

Name Type Description Default
id str

The folder ID.

 required
form_data FolderUpdateForm

The update form data.

 required

Returns:

Type Description
FolderModel

FolderModel: The updated folder model.
Source code in src/owui_client/routers/folders.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
async def update_folder_name_by_id(
    self, id: str, form_data: FolderUpdateForm
) -> FolderModel:
    """
    Update a folder's details (name, data, meta) by ID.

    Args:
        id: The folder ID.
        form_data: The update form data.

    Returns:
        `FolderModel`: The updated folder model.
    """
    return await self._request(
        "POST",
        f"/v1/folders/{id}/update",
        json=form_data.model_dump(exclude_unset=True),
        model=FolderModel,
    )
update_folder_parent_id_by_id 
update_folder_parent_id_by_id(
    id: str, form_data: FolderParentIdForm
) -> FolderModel

Move a folder to a new parent folder.

Parameters:

Name Type Description Default
id str

The folder ID.

 required
form_data FolderParentIdForm

The parent ID form data.

 required

Returns:

Type Description
FolderModel

FolderModel: The updated folder model with the new parent ID.
Source code in src/owui_client/routers/folders.py 
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
async def update_folder_parent_id_by_id(
    self, id: str, form_data: FolderParentIdForm
) -> FolderModel:
    """
    Move a folder to a new parent folder.

    Args:
        id: The folder ID.
        form_data: The parent ID form data.

    Returns:
        `FolderModel`: The updated folder model with the new parent ID.
    """
    return await self._request(
        "POST",
        f"/v1/folders/{id}/update/parent",
        json=form_data.model_dump(),
        model=FolderModel,
    )
update_folder_is_expanded_by_id 
update_folder_is_expanded_by_id(
    id: str, form_data: FolderIsExpandedForm
) -> FolderModel

Update a folder's expansion status (is_expanded) by ID.

Parameters:

Name Type Description Default
id str

The folder ID.

 required
form_data FolderIsExpandedForm

The is_expanded form data.

 required

Returns:

Type Description
FolderModel

FolderModel: The updated folder model.
Source code in src/owui_client/routers/folders.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
async def update_folder_is_expanded_by_id(
    self, id: str, form_data: FolderIsExpandedForm
) -> FolderModel:
    """
    Update a folder's expansion status (is_expanded) by ID.

    Args:
        id: The folder ID.
        form_data: The is_expanded form data.

    Returns:
        `FolderModel`: The updated folder model.
    """
    return await self._request(
        "POST",
        f"/v1/folders/{id}/update/expanded",
        json=form_data.model_dump(),
        model=FolderModel,
    )
delete_folder_by_id 
delete_folder_by_id(
    id: str, delete_contents: Optional[bool] = True
) -> bool

Delete a folder by ID.

Parameters:

Name Type Description Default
id str

The folder ID.

 required
delete_contents Optional[bool]

Whether to delete the contents of the folder (chats, etc). Defaults to True. If False, contents might be moved or handled differently depending on the backend logic (usually chats are moved to root or detached).

 True

Returns:

Name Type Description
bool bool

True if successful.
Source code in src/owui_client/routers/folders.py 
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
async def delete_folder_by_id(
    self, id: str, delete_contents: Optional[bool] = True
) -> bool:
    """
    Delete a folder by ID.

    Args:
        id: The folder ID.
        delete_contents: Whether to delete the contents of the folder (chats, etc). Defaults to True.
                         If False, contents might be moved or handled differently depending on the backend logic (usually chats are moved to root or detached).

    Returns:
        bool: True if successful.
    """
    params = {"delete_contents": delete_contents}
    return await self._request(
        "DELETE",
        f"/v1/folders/{id}",
        params=params,
        model=bool,
    )