tools

Classes

ToolsClient

ToolsClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Tools endpoints.

Used by:

• Code Reference client Classes OpenWebUI Attributes tools

Source code in src/owui_client/client_base.py

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

Functions

get_tools

get_tools() -> List[ToolUserResponse]

Get all available tools.

This includes local tools and tools from configured servers (OpenAPI, MCP).

Returns:

Type	Description
List[ToolUserResponse]	List[ToolUserResponse]: List of tools with user information.

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

async def get_tools(self) -> List[ToolUserResponse]:
    """
    Get all available tools.

    This includes local tools and tools from configured servers (OpenAPI, MCP).

    Returns:
        List[ToolUserResponse]: List of tools with user information.
    """
    return await self._request(
        "GET",
        "/v1/tools/",
        model=List[ToolUserResponse],
    )

get_tool_list

get_tool_list() -> List[ToolUserResponse]

Get list of tools the user has write access to.

Returns:

Type	Description
List[ToolUserResponse]	List[ToolUserResponse]: List of tools.

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

async def get_tool_list(self) -> List[ToolUserResponse]:
    """
    Get list of tools the user has write access to.

    Returns:
        List[ToolUserResponse]: List of tools.
    """
    return await self._request(
        "GET",
        "/v1/tools/list",
        model=List[ToolUserResponse],
    )

load_tool_from_url

load_tool_from_url(
    form_data: LoadUrlForm,
) -> Optional[Dict[str, Any]]

Load a tool's code and metadata from a URL.

Parameters:

Name	Type	Description	Default
form_data	LoadUrlForm	The URL information.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: A dictionary containing 'name' and 'content' of the tool, or None if failed.

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

async def load_tool_from_url(self, form_data: LoadUrlForm) -> Optional[Dict[str, Any]]:
    """
    Load a tool's code and metadata from a URL.

    Args:
        form_data: The URL information.

    Returns:
        Optional[Dict[str, Any]]: A dictionary containing 'name' and 'content' of the tool, or None if failed.
    """
    return await self._request(
        "POST",
        "/v1/tools/load/url",
        json=form_data.model_dump(mode="json"),
        model=Optional[Dict[str, Any]],
    )

export_tools

export_tools() -> List[ToolModel]

Export all tools the user has read access to.

Returns:

Type	Description
List[ToolModel]	List[ToolModel]: List of tools with full content.

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

async def export_tools(self) -> List[ToolModel]:
    """
    Export all tools the user has read access to.

    Returns:
        List[ToolModel]: List of tools with full content.
    """
    return await self._request(
        "GET",
        "/v1/tools/export",
        model=List[ToolModel],
    )

create_new_tool

create_new_tool(
    form_data: ToolForm,
) -> Optional[ToolResponse]

Create a new tool.

Parameters:

Name	Type	Description	Default
form_data	ToolForm	The tool data, including ID, name, and Python content.	required

Returns:

Type	Description
Optional[ToolResponse]	Optional[ToolResponse]: The created tool metadata.

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

async def create_new_tool(self, form_data: ToolForm) -> Optional[ToolResponse]:
    """
    Create a new tool.

    Args:
        form_data: The tool data, including ID, name, and Python content.

    Returns:
        Optional[ToolResponse]: The created tool metadata.
    """
    return await self._request(
        "POST",
        "/v1/tools/create",
        json=form_data.model_dump(mode="json"),
        model=Optional[ToolResponse],
    )

get_tool_by_id

get_tool_by_id(id: str) -> Optional[ToolModel]

Get a tool by its unique ID.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Type	Description
Optional[ToolModel]	Optional[ToolModel]: The tool details.

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

async def get_tool_by_id(self, id: str) -> Optional[ToolModel]:
    """
    Get a tool by its unique ID.

    Args:
        id: The tool ID.

    Returns:
        Optional[ToolModel]: The tool details.
    """
    return await self._request(
        "GET",
        f"/v1/tools/id/{id}",
        model=Optional[ToolModel],
    )

update_tool_by_id

update_tool_by_id(
    id: str, form_data: ToolForm
) -> Optional[ToolModel]

Update a tool by ID.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required
form_data	ToolForm	The updated tool data.	required

Returns:

Type	Description
Optional[ToolModel]	Optional[ToolModel]: The updated tool details.

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

async def update_tool_by_id(self, id: str, form_data: ToolForm) -> Optional[ToolModel]:
    """
    Update a tool by ID.

    Args:
        id: The tool ID.
        form_data: The updated tool data.

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

delete_tool_by_id

delete_tool_by_id(id: str) -> bool

Delete a tool by ID.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Name	Type	Description
bool	bool	True if successful, False otherwise.

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

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

    Args:
        id: The tool ID.

    Returns:
        bool: True if successful, False otherwise.
    """
    return await self._request(
        "DELETE",
        f"/v1/tools/id/{id}/delete",
        model=bool,
    )

get_tool_valves_by_id

get_tool_valves_by_id(id: str) -> Optional[Dict[str, Any]]

Get the current valve settings for a tool.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The valve settings.

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

async def get_tool_valves_by_id(self, id: str) -> Optional[Dict[str, Any]]:
    """
    Get the current valve settings for a tool.

    Args:
        id: The tool ID.

    Returns:
        Optional[Dict[str, Any]]: The valve settings.
    """
    return await self._request(
        "GET",
        f"/v1/tools/id/{id}/valves",
        model=Optional[Dict[str, Any]],
    )

get_tool_valves_spec_by_id

get_tool_valves_spec_by_id(
    id: str,
) -> Optional[Dict[str, Any]]

Get the specification (schema) for the tool's valves.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The JSON schema for the valves.

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

async def get_tool_valves_spec_by_id(self, id: str) -> Optional[Dict[str, Any]]:
    """
    Get the specification (schema) for the tool's valves.

    Args:
        id: The tool ID.

    Returns:
        Optional[Dict[str, Any]]: The JSON schema for the valves.
    """
    return await self._request(
        "GET",
        f"/v1/tools/id/{id}/valves/spec",
        model=Optional[Dict[str, Any]],
    )

update_tool_valves_by_id

update_tool_valves_by_id(
    id: str, valves: Dict[str, Any]
) -> Optional[Dict[str, Any]]

Update the valve settings for a tool.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required
valves	Dict[str, Any]	The new valve settings.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The updated valve settings.

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

async def update_tool_valves_by_id(self, id: str, valves: Dict[str, Any]) -> Optional[Dict[str, Any]]:
    """
    Update the valve settings for a tool.

    Args:
        id: The tool ID.
        valves: The new valve settings.

    Returns:
        Optional[Dict[str, Any]]: The updated valve settings.
    """
    return await self._request(
        "POST",
        f"/v1/tools/id/{id}/valves/update",
        json=valves,
        model=Optional[Dict[str, Any]],
    )

get_tool_user_valves_by_id

get_tool_user_valves_by_id(
    id: str,
) -> Optional[Dict[str, Any]]

Get user-specific valve settings for a tool.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The user's valve settings.

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

async def get_tool_user_valves_by_id(self, id: str) -> Optional[Dict[str, Any]]:
    """
    Get user-specific valve settings for a tool.

    Args:
        id: The tool ID.

    Returns:
        Optional[Dict[str, Any]]: The user's valve settings.
    """
    return await self._request(
        "GET",
        f"/v1/tools/id/{id}/valves/user",
        model=Optional[Dict[str, Any]],
    )

get_tool_user_valves_spec_by_id

get_tool_user_valves_spec_by_id(
    id: str,
) -> Optional[Dict[str, Any]]

Get the specification (schema) for the tool's user valves.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The JSON schema for the user valves.

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

async def get_tool_user_valves_spec_by_id(self, id: str) -> Optional[Dict[str, Any]]:
    """
    Get the specification (schema) for the tool's user valves.

    Args:
        id: The tool ID.

    Returns:
        Optional[Dict[str, Any]]: The JSON schema for the user valves.
    """
    return await self._request(
        "GET",
        f"/v1/tools/id/{id}/valves/user/spec",
        model=Optional[Dict[str, Any]],
    )

update_tool_user_valves_by_id

update_tool_user_valves_by_id(
    id: str, valves: Dict[str, Any]
) -> Optional[Dict[str, Any]]

Update user-specific valve settings for a tool.

Parameters:

Name	Type	Description	Default
id	str	The tool ID.	required
valves	Dict[str, Any]	The new valve settings.	required

Returns:

Type	Description
Optional[Dict[str, Any]]	Optional[Dict[str, Any]]: The updated valve settings.

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

async def update_tool_user_valves_by_id(self, id: str, valves: Dict[str, Any]) -> Optional[Dict[str, Any]]:
    """
    Update user-specific valve settings for a tool.

    Args:
        id: The tool ID.
        valves: The new valve settings.

    Returns:
        Optional[Dict[str, Any]]: The updated valve settings.
    """
    return await self._request(
        "POST",
        f"/v1/tools/id/{id}/valves/user/update",
        json=valves,
        model=Optional[Dict[str, Any]],
    )