functions

Classes

FunctionsClient

FunctionsClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Functions endpoints.

Used by:

• Code Reference client Classes OpenWebUI Attributes functions

Source code in src/owui_client/client_base.py

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

Functions

get_functions

get_functions() -> list[FunctionResponse]

Get all functions.

Returns:

Type	Description
list[FunctionResponse]	list[FunctionResponse]: A list of all functions.

Source code in src/owui_client/routers/functions.py

async def get_functions(self) -> list[FunctionResponse]:
    """
    Get all functions.

    Returns:
        list[FunctionResponse]: A list of all functions.
    """
    return await self._request(
        "GET",
        "/v1/functions/",
        model=list[FunctionResponse],
    )

get_function_list

get_function_list() -> list[FunctionUserResponse]

Get list of functions with user info.

Returns:

Type	Description
list[FunctionUserResponse]	list[FunctionUserResponse]: A list of functions including user details.

Source code in src/owui_client/routers/functions.py

async def get_function_list(self) -> list[FunctionUserResponse]:
    """
    Get list of functions with user info.

    Returns:
        list[FunctionUserResponse]: A list of functions including user details.
    """
    return await self._request(
        "GET",
        "/v1/functions/list",
        model=list[FunctionUserResponse],
    )

export_functions

export_functions(
    include_valves: bool = False,
) -> list[Union[FunctionModel, FunctionWithValvesModel]]

Export functions.

Parameters:

Name	Type	Description	Default
include_valves	bool	Whether to include valve configurations in the export.	False

Returns:

Type	Description
list[Union[FunctionModel, FunctionWithValvesModel]]	list[Union[FunctionModel, FunctionWithValvesModel]]: A list of functions, optionally including valves.

Source code in src/owui_client/routers/functions.py

async def export_functions(
    self, include_valves: bool = False
) -> list[Union[FunctionModel, FunctionWithValvesModel]]:
    """
    Export functions.

    Args:
        include_valves: Whether to include valve configurations in the export.

    Returns:
        list[Union[`FunctionModel`, `FunctionWithValvesModel`]]: A list of functions, optionally including valves.
    """
    return await self._request(
        "GET",
        "/v1/functions/export",
        params={"include_valves": include_valves},
        model=list[Union[FunctionModel, FunctionWithValvesModel]],
    )

load_function_from_url

load_function_from_url(url: str) -> Optional[dict]

Load a function from a URL.

Parameters:

Name	Type	Description	Default
url	str	The URL to load the function from.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: A dictionary containing the function name and content if successful.

Source code in src/owui_client/routers/functions.py

async def load_function_from_url(self, url: str) -> Optional[dict]:
    """
    Load a function from a URL.

    Args:
        url: The URL to load the function from.

    Returns:
        Optional[dict]: A dictionary containing the function name and content if successful.
    """
    return await self._request(
        "POST",
        "/v1/functions/load/url",
        json={"url": url},
        model=Optional[dict],
    )

sync_functions

sync_functions(
    functions: list[FunctionWithValvesModel],
) -> list[FunctionWithValvesModel]

Sync functions.

Parameters:

Name	Type	Description	Default
functions	list[FunctionWithValvesModel]	A list of functions to sync.	required

Returns:

Type	Description
list[FunctionWithValvesModel]	list[FunctionWithValvesModel]: The list of synced functions.

Source code in src/owui_client/routers/functions.py

async def sync_functions(
    self, functions: list[FunctionWithValvesModel]
) -> list[FunctionWithValvesModel]:
    """
    Sync functions.

    Args:
        functions: A list of functions to sync.

    Returns:
        list[FunctionWithValvesModel]: The list of synced functions.
    """
    form = SyncFunctionsForm(functions=functions)
    return await self._request(
        "POST",
        "/v1/functions/sync",
        json=form.model_dump(),
        model=list[FunctionWithValvesModel],
    )

create_function

create_function(
    form_data: FunctionForm,
) -> Optional[FunctionResponse]

Create a new function.

Parameters:

Name	Type	Description	Default
form_data	FunctionForm	The function data to create.	required

Returns:

Type	Description
Optional[FunctionResponse]	Optional[FunctionResponse]: The created function details.

Source code in src/owui_client/routers/functions.py

async def create_function(
    self, form_data: FunctionForm
) -> Optional[FunctionResponse]:
    """
    Create a new function.

    Args:
        form_data: The function data to create.

    Returns:
        Optional[FunctionResponse]: The created function details.
    """
    return await self._request(
        "POST",
        "/v1/functions/create",
        json=form_data.model_dump(),
        model=Optional[FunctionResponse],
    )

get_function_by_id

get_function_by_id(id: str) -> Optional[FunctionModel]

Get a function by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[FunctionModel]	Optional[FunctionModel]: The function details if found.

Source code in src/owui_client/routers/functions.py

async def get_function_by_id(self, id: str) -> Optional[FunctionModel]:
    """
    Get a function by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[FunctionModel]: The function details if found.
    """
    return await self._request(
        "GET",
        f"/v1/functions/id/{id}",
        model=Optional[FunctionModel],
    )

toggle_function_by_id

toggle_function_by_id(id: str) -> Optional[FunctionModel]

Toggle a function's active state by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[FunctionModel]	Optional[FunctionModel]: The updated function details.

Source code in src/owui_client/routers/functions.py

async def toggle_function_by_id(self, id: str) -> Optional[FunctionModel]:
    """
    Toggle a function's active state by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[FunctionModel]: The updated function details.
    """
    return await self._request(
        "POST",
        f"/v1/functions/id/{id}/toggle",
        model=Optional[FunctionModel],
    )

toggle_global_by_id

toggle_global_by_id(id: str) -> Optional[FunctionModel]

Toggle a function's global state by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[FunctionModel]	Optional[FunctionModel]: The updated function details.

Source code in src/owui_client/routers/functions.py

async def toggle_global_by_id(self, id: str) -> Optional[FunctionModel]:
    """
    Toggle a function's global state by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[FunctionModel]: The updated function details.
    """
    return await self._request(
        "POST",
        f"/v1/functions/id/{id}/toggle/global",
        model=Optional[FunctionModel],
    )

update_function_by_id

update_function_by_id(
    id: str, form_data: FunctionForm
) -> Optional[FunctionModel]

Update a function by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function to update.	required
form_data	FunctionForm	The updated function data.	required

Returns:

Type	Description
Optional[FunctionModel]	Optional[FunctionModel]: The updated function details.

Source code in src/owui_client/routers/functions.py

async def update_function_by_id(
    self, id: str, form_data: FunctionForm
) -> Optional[FunctionModel]:
    """
    Update a function by ID.

    Args:
        id: The ID of the function to update.
        form_data: The updated function data.

    Returns:
        Optional[FunctionModel]: The updated function details.
    """
    return await self._request(
        "POST",
        f"/v1/functions/id/{id}/update",
        json=form_data.model_dump(),
        model=Optional[FunctionModel],
    )

delete_function_by_id

delete_function_by_id(id: str) -> bool

Delete a function by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function to delete.	required

Returns:

Name	Type	Description
bool	bool	True if the function was deleted successfully.

Source code in src/owui_client/routers/functions.py

async def delete_function_by_id(self, id: str) -> bool:
    """
    Delete a function by ID.

    Args:
        id: The ID of the function to delete.

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

get_function_valves_by_id

get_function_valves_by_id(id: str) -> Optional[dict]

Get function valves by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The function valves configuration.

Source code in src/owui_client/routers/functions.py

async def get_function_valves_by_id(self, id: str) -> Optional[dict]:
    """
    Get function valves by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[dict]: The function valves configuration.
    """
    return await self._request(
        "GET",
        f"/v1/functions/id/{id}/valves",
        model=Optional[dict],
    )

get_function_valves_spec_by_id

get_function_valves_spec_by_id(id: str) -> Optional[dict]

Get function valves specification by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The function valves specification (schema).

Source code in src/owui_client/routers/functions.py

async def get_function_valves_spec_by_id(self, id: str) -> Optional[dict]:
    """
    Get function valves specification by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[dict]: The function valves specification (schema).
    """
    return await self._request(
        "GET",
        f"/v1/functions/id/{id}/valves/spec",
        model=Optional[dict],
    )

update_function_valves_by_id

update_function_valves_by_id(
    id: str, valves: dict
) -> Optional[dict]

Update function valves by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required
valves	dict	The new valves configuration.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The updated valves configuration.

Source code in src/owui_client/routers/functions.py

async def update_function_valves_by_id(
    self, id: str, valves: dict
) -> Optional[dict]:
    """
    Update function valves by ID.

    Args:
        id: The ID of the function.
        valves: The new valves configuration.

    Returns:
        Optional[dict]: The updated valves configuration.
    """
    return await self._request(
        "POST",
        f"/v1/functions/id/{id}/valves/update",
        json=valves,
        model=Optional[dict],
    )

get_function_user_valves_by_id

get_function_user_valves_by_id(id: str) -> Optional[dict]

Get function user valves by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The function user valves configuration.

Source code in src/owui_client/routers/functions.py

async def get_function_user_valves_by_id(self, id: str) -> Optional[dict]:
    """
    Get function user valves by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[dict]: The function user valves configuration.
    """
    return await self._request(
        "GET",
        f"/v1/functions/id/{id}/valves/user",
        model=Optional[dict],
    )

get_function_user_valves_spec_by_id

get_function_user_valves_spec_by_id(
    id: str,
) -> Optional[dict]

Get function user valves specification by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The function user valves specification (schema).

Source code in src/owui_client/routers/functions.py

async def get_function_user_valves_spec_by_id(self, id: str) -> Optional[dict]:
    """
    Get function user valves specification by ID.

    Args:
        id: The ID of the function.

    Returns:
        Optional[dict]: The function user valves specification (schema).
    """
    return await self._request(
        "GET",
        f"/v1/functions/id/{id}/valves/user/spec",
        model=Optional[dict],
    )

update_function_user_valves_by_id

update_function_user_valves_by_id(
    id: str, valves: dict
) -> Optional[dict]

Update function user valves by ID.

Parameters:

Name	Type	Description	Default
id	str	The ID of the function.	required
valves	dict	The new user valves configuration.	required

Returns:

Type	Description
Optional[dict]	Optional[dict]: The updated user valves configuration.

Source code in src/owui_client/routers/functions.py

async def update_function_user_valves_by_id(
    self, id: str, valves: dict
) -> Optional[dict]:
    """
    Update function user valves by ID.

    Args:
        id: The ID of the function.
        valves: The new user valves configuration.

    Returns:
        Optional[dict]: The updated user valves configuration.
    """
    return await self._request(
        "POST",
        f"/v1/functions/id/{id}/valves/user/update",
        json=valves,
        model=Optional[dict],
    )