Skip to content

prompts

Classes

PromptsClient 

PromptsClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Prompts endpoints.

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

Functions

get_prompts 
get_prompts() -> List[PromptModel]

Get all prompts (read access).

Returns:

Type Description
List[PromptModel]

List[PromptModel]: List of prompts.
Source code in src/owui_client/routers/prompts.py 
11
12
13
14
15
16
17
18
19
20
async def get_prompts(self) -> List[PromptModel]:
    """
    Get all prompts (read access).

    Returns:
        List[PromptModel]: List of prompts.
    """
    return await self._request(
        "GET", "/v1/prompts/", model=List[PromptModel]
    )
get_prompt_list 
get_prompt_list() -> List[PromptUserResponse]

Get all prompts with user info (write access).

Returns:

Type Description
List[PromptUserResponse]

List[PromptUserResponse]: List of prompts with user details.
Source code in src/owui_client/routers/prompts.py 
22
23
24
25
26
27
28
29
30
31
async def get_prompt_list(self) -> List[PromptUserResponse]:
    """
    Get all prompts with user info (write access).

    Returns:
        List[PromptUserResponse]: List of prompts with user details.
    """
    return await self._request(
        "GET", "/v1/prompts/list", model=List[PromptUserResponse]
    )
create_new_prompt 
create_new_prompt(
    form_data: PromptForm,
) -> Optional[PromptModel]

Create a new prompt.

Parameters:

Name Type Description Default
form_data PromptForm

The prompt data. The command field must start with a slash (e.g., '/help').

 required

Returns:

Type Description
Optional[PromptModel]

Optional[PromptModel]: The created prompt.
Source code in src/owui_client/routers/prompts.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
async def create_new_prompt(self, form_data: PromptForm) -> Optional[PromptModel]:
    """
    Create a new prompt.

    Args:
        form_data: The prompt data. The `command` field must start with a slash (e.g., '/help').

    Returns:
        Optional[PromptModel]: The created prompt.
    """
    return await self._request(
        "POST",
        "/v1/prompts/create",
        json=form_data.model_dump(),
        model=Optional[PromptModel],
    )
get_prompt_by_command 
get_prompt_by_command(
    command: str,
) -> Optional[PromptModel]

Get a prompt by command.

Parameters:

Name Type Description Default
command str

The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.

 required

Returns:

Type Description
Optional[PromptModel]

Optional[PromptModel]: The prompt details.
Source code in src/owui_client/routers/prompts.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
async def get_prompt_by_command(self, command: str) -> Optional[PromptModel]:
    """
    Get a prompt by command.

    Args:
        command: The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.

    Returns:
        Optional[PromptModel]: The prompt details.
    """
    clean_command = command.lstrip("/")
    return await self._request(
        "GET",
        f"/v1/prompts/command/{clean_command}",
        model=Optional[PromptModel],
    )
update_prompt_by_command 
update_prompt_by_command(
    command: str, form_data: PromptForm
) -> Optional[PromptModel]

Update a prompt by command.

Parameters:

Name Type Description Default
command str

The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.

 required
form_data PromptForm

The updated prompt data.

 required

Returns:

Type Description
Optional[PromptModel]

Optional[PromptModel]: The updated prompt.
Source code in src/owui_client/routers/prompts.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
async def update_prompt_by_command(
    self, command: str, form_data: PromptForm
) -> Optional[PromptModel]:
    """
    Update a prompt by command.

    Args:
        command: The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.
        form_data: The updated prompt data.

    Returns:
        Optional[PromptModel]: The updated prompt.
    """
    clean_command = command.lstrip("/")
    return await self._request(
        "POST",
        f"/v1/prompts/command/{clean_command}/update",
        json=form_data.model_dump(),
        model=Optional[PromptModel],
    )
delete_prompt_by_command 
delete_prompt_by_command(command: str) -> bool

Delete a prompt by command.

Parameters:

Name Type Description Default
command str

The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.

 required

Returns:

Name Type Description
bool bool

True if successful.
Source code in src/owui_client/routers/prompts.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
async def delete_prompt_by_command(self, command: str) -> bool:
    """
    Delete a prompt by command.

    Args:
        command: The command trigger (e.g., 'help' or '/help'). Leading slash is automatically handled.

    Returns:
        bool: True if successful.
    """
    clean_command = command.lstrip("/")
    return await self._request(
        "DELETE",
        f"/v1/prompts/command/{clean_command}/delete",
        model=bool,
    )