Skip to content

groups

Classes

GroupsClient 

GroupsClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Groups endpoints.

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

Functions

get_groups 
get_groups(
    share: Optional[bool] = None,
) -> list[GroupResponse]

Get all groups.

Retrieves a list of all groups available to the user. Admin users can see all groups. Regular users only see groups they are members of.

Parameters:

Name Type Description Default
share Optional[bool]

Filter by share status. If True, returns only shared groups. If False, returns only non-shared groups. If None, returns all groups (subject to user role).

 None

Returns:

Type Description
list[GroupResponse]

List of groups.
Source code in src/owui_client/routers/groups.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
async def get_groups(self, share: Optional[bool] = None) -> list[GroupResponse]:
    """
    Get all groups.

    Retrieves a list of all groups available to the user.
    Admin users can see all groups. Regular users only see groups they are members of.

    Args:
        share: Filter by share status.
               If True, returns only shared groups.
               If False, returns only non-shared groups.
               If None, returns all groups (subject to user role).

    Returns:
        List of groups.
    """
    params = {}
    if share is not None:
        params["share"] = share

    return await self._request(
        "GET",
        "/v1/groups/",
        model=GroupResponse,
        params=params,
    )
create_new_group 
create_new_group(
    form_data: GroupForm,
) -> Optional[GroupResponse]

Create a new group.

Creates a new user group with the provided details. Requires admin privileges.

Parameters:

Name Type Description Default
form_data GroupForm

The group creation information including name, description, and permissions.

 required

Returns:

Type Description
Optional[GroupResponse]

The created group if successful, None otherwise.
Source code in src/owui_client/routers/groups.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
async def create_new_group(self, form_data: GroupForm) -> Optional[GroupResponse]:
    """
    Create a new group.

    Creates a new user group with the provided details.
    Requires admin privileges.

    Args:
        form_data: The group creation information including name, description, and permissions.

    Returns:
        The created group if successful, None otherwise.
    """
    return await self._request(
        "POST",
        "/v1/groups/create",
        model=GroupResponse,
        json=form_data.model_dump(),
    )
get_group_by_id 
get_group_by_id(id: str) -> Optional[GroupResponse]

Get group by ID.

Retrieves details of a specific group by its ID. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required

Returns:

Type Description
Optional[GroupResponse]

The group details if found, None otherwise.
Source code in src/owui_client/routers/groups.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
async def get_group_by_id(self, id: str) -> Optional[GroupResponse]:
    """
    Get group by ID.

    Retrieves details of a specific group by its ID.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.

    Returns:
        The group details if found, None otherwise.
    """
    return await self._request(
        "GET",
        f"/v1/groups/id/{id}",
        model=GroupResponse,
    )
export_group_by_id 
export_group_by_id(
    id: str,
) -> Optional[GroupExportResponse]

Export group by ID (includes user IDs).

Retrieves group details along with the list of member user IDs. Useful for backing up or migrating group data. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required

Returns:

Type Description
Optional[GroupExportResponse]

The exported group details including member user IDs if found, None otherwise.
Source code in src/owui_client/routers/groups.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
async def export_group_by_id(self, id: str) -> Optional[GroupExportResponse]:
    """
    Export group by ID (includes user IDs).

    Retrieves group details along with the list of member user IDs.
    Useful for backing up or migrating group data.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.

    Returns:
        The exported group details including member user IDs if found, None otherwise.
    """
    return await self._request(
        "GET",
        f"/v1/groups/id/{id}/export",
        model=GroupExportResponse,
    )
get_users_in_group 
get_users_in_group(id: str) -> list[UserInfoResponse]

Get users in a group.

Retrieves the list of users who are members of the specified group. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required

Returns:

Type Description
list[UserInfoResponse]

List of user information for members of the group.
Source code in src/owui_client/routers/groups.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
async def get_users_in_group(self, id: str) -> list[UserInfoResponse]:
    """
    Get users in a group.

    Retrieves the list of users who are members of the specified group.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.

    Returns:
        List of user information for members of the group.
    """
    return await self._request(
        "POST",
        f"/v1/groups/id/{id}/users",
        model=UserInfoResponse,
    )
update_group_by_id 
update_group_by_id(
    id: str, form_data: GroupUpdateForm
) -> Optional[GroupResponse]

Update group by ID.

Updates the details of an existing group. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required
form_data GroupUpdateForm

The updated group information.

 required

Returns:

Type Description
Optional[GroupResponse]

The updated group details if successful, None otherwise.
Source code in src/owui_client/routers/groups.py 
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
async def update_group_by_id(
    self, id: str, form_data: GroupUpdateForm
) -> Optional[GroupResponse]:
    """
    Update group by ID.

    Updates the details of an existing group.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.
        form_data: The updated group information.

    Returns:
        The updated group details if successful, None otherwise.
    """
    return await self._request(
        "POST",
        f"/v1/groups/id/{id}/update",
        model=GroupResponse,
        json=form_data.model_dump(),
    )
add_user_to_group 
add_user_to_group(
    id: str, form_data: UserIdsForm
) -> Optional[GroupResponse]

Add users to group.

Adds one or more users to the specified group. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required
form_data UserIdsForm

Form containing the list of user IDs to add.

 required

Returns:

Type Description
Optional[GroupResponse]

The updated group details if successful, None otherwise.
Source code in src/owui_client/routers/groups.py 
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
async def add_user_to_group(
    self, id: str, form_data: UserIdsForm
) -> Optional[GroupResponse]:
    """
    Add users to group.

    Adds one or more users to the specified group.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.
        form_data: Form containing the list of user IDs to add.

    Returns:
        The updated group details if successful, None otherwise.
    """
    return await self._request(
        "POST",
        f"/v1/groups/id/{id}/users/add",
        model=GroupResponse,
        json=form_data.model_dump(),
    )
remove_users_from_group 
remove_users_from_group(
    id: str, form_data: UserIdsForm
) -> Optional[GroupResponse]

Remove users from group.

Removes one or more users from the specified group. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required
form_data UserIdsForm

Form containing the list of user IDs to remove.

 required

Returns:

Type Description
Optional[GroupResponse]

The updated group details if successful, None otherwise.
Source code in src/owui_client/routers/groups.py 
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
async def remove_users_from_group(
    self, id: str, form_data: UserIdsForm
) -> Optional[GroupResponse]:
    """
    Remove users from group.

    Removes one or more users from the specified group.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.
        form_data: Form containing the list of user IDs to remove.

    Returns:
        The updated group details if successful, None otherwise.
    """
    return await self._request(
        "POST",
        f"/v1/groups/id/{id}/users/remove",
        model=GroupResponse,
        json=form_data.model_dump(),
    )
delete_group_by_id 
delete_group_by_id(id: str) -> bool

Delete group by ID.

Permanently deletes the specified group. Requires admin privileges.

Parameters:

Name Type Description Default
id str

The unique identifier of the group.

 required

Returns:

Type Description
bool

True if the group was successfully deleted, False otherwise.
Source code in src/owui_client/routers/groups.py 
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
async def delete_group_by_id(self, id: str) -> bool:
    """
    Delete group by ID.

    Permanently deletes the specified group.
    Requires admin privileges.

    Args:
        id: The unique identifier of the group.

    Returns:
        True if the group was successfully deleted, False otherwise.
    """
    return await self._request(
        "DELETE",
        f"/v1/groups/id/{id}/delete",
        model=bool,
    )