Skip to content

images

Client for the Images endpoints.

Classes

ImagesClient 

ImagesClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Images endpoints.

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

Functions

get_config 
get_config() -> ImagesConfig

Get the images configuration.

Returns:

Type Description
ImagesConfig

ImagesConfig: The current images configuration.
Source code in src/owui_client/routers/images.py 
19
20
21
22
23
24
25
26
27
28
29
30
async def get_config(self) -> ImagesConfig:
    """
    Get the images configuration.

    Returns:
        `ImagesConfig`: The current images configuration.
    """
    return await self._request(
        "GET",
        "/v1/images/config",
        model=ImagesConfig,
    )
update_config 
update_config(config: ImagesConfig) -> ImagesConfig

Update the images configuration.

Parameters:

Name Type Description Default
config ImagesConfig

The new configuration.

 required

Returns:

Type Description
ImagesConfig

ImagesConfig: The updated configuration.
Source code in src/owui_client/routers/images.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
async def update_config(self, config: ImagesConfig) -> ImagesConfig:
    """
    Update the images configuration.

    Args:
        config: The new configuration.

    Returns:
        `ImagesConfig`: The updated configuration.
    """
    return await self._request(
        "POST",
        "/v1/images/config/update",
        model=ImagesConfig,
        json=config.model_dump(),
    )
verify_url 
verify_url() -> bool

Verify the image generation URL (for Automatic1111 or ComfyUI).

Returns:

Name Type Description
bool bool

True if the URL is valid.
Source code in src/owui_client/routers/images.py 
49
50
51
52
53
54
55
56
57
58
59
60
async def verify_url(self) -> bool:
    """
    Verify the image generation URL (for Automatic1111 or ComfyUI).

    Returns:
        bool: True if the URL is valid.
    """
    return await self._request(
        "GET",
        "/v1/images/config/url/verify",
        model=bool,
    )
get_models 
get_models() -> List[Dict[str, str]]

Get the list of available image models.

Returns:

Type Description
List[Dict[str, str]]

List[Dict[str, str]]: List of models (dictionaries with 'id' and 'name').
Source code in src/owui_client/routers/images.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
async def get_models(self) -> List[Dict[str, str]]:
    """
    Get the list of available image models.

    Returns:
        List[Dict[str, str]]: List of models (dictionaries with 'id' and 'name').
    """
    # The backend returns a list of dicts, but not a specific Pydantic model for the list items in the response type signature
    # We can use dict as the model, and _request will handle the list
    return await self._request(
        "GET",
        "/v1/images/models",
        model=dict,
    )
generate_image 
generate_image(
    form_data: CreateImageForm,
) -> List[Dict[str, str]]

Generate images based on the provided parameters.

Parameters:

Name Type Description Default
form_data CreateImageForm

The image generation parameters.

 required

Returns:

Type Description
List[Dict[str, str]]

List[Dict[str, str]]: List of generated images (dictionaries with 'url').
Source code in src/owui_client/routers/images.py 
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
async def generate_image(self, form_data: CreateImageForm) -> List[Dict[str, str]]:
    """
    Generate images based on the provided parameters.

    Args:
        form_data: The image generation parameters.

    Returns:
        List[Dict[str, str]]: List of generated images (dictionaries with 'url').
    """
    return await self._request(
        "POST",
        "/v1/images/generations",
        model=dict,
        json=form_data.model_dump(),
    )
edit_image 
edit_image(
    form_data: EditImageForm,
) -> List[Dict[str, str]]

Edit an image based on the provided parameters.

Parameters:

Name Type Description Default
form_data EditImageForm

The image edit parameters.

 required

Returns:

Type Description
List[Dict[str, str]]

List[Dict[str, str]]: List of edited images (dictionaries with 'url').
Source code in src/owui_client/routers/images.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
async def edit_image(self, form_data: EditImageForm) -> List[Dict[str, str]]:
    """
    Edit an image based on the provided parameters.

    Args:
        form_data: The image edit parameters.

    Returns:
        List[Dict[str, str]]: List of edited images (dictionaries with 'url').
    """
    return await self._request(
        "POST",
        "/v1/images/edit",
        model=dict,
        json=form_data.model_dump(),
    )