Skip to content

automations

Classes

AutomationsClient 

AutomationsClient(client: OWUIClientBase)

Bases: ResourceBase

Client for the Automations endpoints.

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

Functions

get_automation_items 
get_automation_items(
    query: Optional[str] = None,
    status: Optional[str] = None,
    page: Optional[int] = 1,
) -> AutomationListResponse

Get a paginated, searchable list of automations.

Returns automations owned by the authenticated user. Each item includes the latest run record. Supports filtering by name/prompt text and active/paused status.

Parameters:

Name Type Description Default
query Optional[str]

Optional search string to filter by name or prompt content.

 None
status Optional[str]

Optional status filter: 'active' or 'paused'.

 None
page Optional[int]

Page number (1-indexed). Defaults to 1.

 1

Returns:

Type Description
AutomationListResponse

AutomationListResponse: Paginated automations with run history.
Source code in src/owui_client/routers/automations.py 
17
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
44
45
46
47
48
49
50
async def get_automation_items(
    self,
    query: Optional[str] = None,
    status: Optional[str] = None,
    page: Optional[int] = 1,
) -> AutomationListResponse:
    """Get a paginated, searchable list of automations.

    Returns automations owned by the authenticated user. Each item includes
    the latest run record. Supports filtering by name/prompt text and
    active/paused status.

    Args:
        query: Optional search string to filter by name or prompt content.
        status: Optional status filter: 'active' or 'paused'.
        page: Page number (1-indexed). Defaults to 1.

    Returns:
        `AutomationListResponse`: Paginated automations with run history.
    """
    params = {}
    if query is not None:
        params["query"] = query
    if status is not None:
        params["status"] = status
    if page is not None:
        params["page"] = page

    return await self._request(
        "GET",
        "/v1/automations/list",
        params=params,
        model=AutomationListResponse,
    )
create_new_automation 
create_new_automation(
    form_data: AutomationForm,
) -> Optional[AutomationResponse]

Create a new automation.

Validates the RRULE schedule and enforces user automation limits. The automation is scheduled for its next run immediately upon creation.

Parameters:

Name Type Description Default
form_data AutomationForm

The automation definition including name, data (prompt, model_id, rrule), optional meta, and is_active flag.

 required

Returns:

Type Description
Optional[AutomationResponse]

Optional[AutomationResponse]: The created automation with enriched run data.
Source code in src/owui_client/routers/automations.py 
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
async def create_new_automation(
    self, form_data: AutomationForm
) -> Optional[AutomationResponse]:
    """Create a new automation.

    Validates the RRULE schedule and enforces user automation limits.
    The automation is scheduled for its next run immediately upon creation.

    Args:
        form_data: The automation definition including name, data (prompt,
            model_id, rrule), optional meta, and is_active flag.

    Returns:
        Optional[AutomationResponse]: The created automation with enriched run data.
    """
    return await self._request(
        "POST",
        "/v1/automations/create",
        json=form_data.model_dump(mode="json", exclude_none=True),
        model=Optional[AutomationResponse],
    )
get_automation_by_id 
get_automation_by_id(
    id: str,
) -> Optional[AutomationResponse]

Get a single automation by ID with enriched run data.

Returns the automation details including the latest run record and computed next run timestamps.

Parameters:

Name Type Description Default
id str

The automation ID.

 required

Returns:

Type Description
Optional[AutomationResponse]

Optional[AutomationResponse]: The automation with run history.
Source code in src/owui_client/routers/automations.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
async def get_automation_by_id(self, id: str) -> Optional[AutomationResponse]:
    """Get a single automation by ID with enriched run data.

    Returns the automation details including the latest run record and
    computed next run timestamps.

    Args:
        id: The automation ID.

    Returns:
        Optional[AutomationResponse]: The automation with run history.
    """
    return await self._request(
        "GET",
        f"/v1/automations/{id}",
        model=Optional[AutomationResponse],
    )
update_automation_by_id 
update_automation_by_id(
    id: str, form_data: AutomationForm
) -> Optional[AutomationResponse]

Update an automation by ID.

Re-validates the RRULE and re-enforces rate limits. The schedule is recalculated based on the new RRULE.

Parameters:

Name Type Description Default
id str

The automation ID.

 required
form_data AutomationForm

The updated automation definition.

 required

Returns:

Type Description
Optional[AutomationResponse]

Optional[AutomationResponse]: The updated automation with enriched run data.
Source code in src/owui_client/routers/automations.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
async def update_automation_by_id(
    self, id: str, form_data: AutomationForm
) -> Optional[AutomationResponse]:
    """Update an automation by ID.

    Re-validates the RRULE and re-enforces rate limits. The schedule is
    recalculated based on the new RRULE.

    Args:
        id: The automation ID.
        form_data: The updated automation definition.

    Returns:
        Optional[AutomationResponse]: The updated automation with enriched run data.
    """
    return await self._request(
        "POST",
        f"/v1/automations/{id}/update",
        json=form_data.model_dump(mode="json", exclude_none=True),
        model=Optional[AutomationResponse],
    )
toggle_automation_by_id 
toggle_automation_by_id(
    id: str,
) -> Optional[AutomationResponse]

Toggle an automation's active state.

Flips the is_active flag. Paused automations are excluded from scheduling. When reactivated, the next run is recalculated from the RRULE.

Parameters:

Name Type Description Default
id str

The automation ID.

 required

Returns:

Type Description
Optional[AutomationResponse]

Optional[AutomationResponse]: The toggled automation with enriched run data.
Source code in src/owui_client/routers/automations.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
async def toggle_automation_by_id(
    self, id: str
) -> Optional[AutomationResponse]:
    """Toggle an automation's active state.

    Flips the `is_active` flag. Paused automations are excluded from
    scheduling. When reactivated, the next run is recalculated from the
    RRULE.

    Args:
        id: The automation ID.

    Returns:
        Optional[AutomationResponse]: The toggled automation with enriched run data.
    """
    return await self._request(
        "POST",
        f"/v1/automations/{id}/toggle",
        model=Optional[AutomationResponse],
    )
run_automation_by_id 
run_automation_by_id(
    id: str,
) -> Optional[AutomationResponse]

Trigger an immediate execution of an automation.

The automation runs asynchronously in the background. This endpoint returns the current automation state immediately, not the run result.

Parameters:

Name Type Description Default
id str

The automation ID.

 required

Returns:

Type Description
Optional[AutomationResponse]

Optional[AutomationResponse]: The automation state at trigger time.
Source code in src/owui_client/routers/automations.py 
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
async def run_automation_by_id(
    self, id: str
) -> Optional[AutomationResponse]:
    """Trigger an immediate execution of an automation.

    The automation runs asynchronously in the background. This endpoint
    returns the current automation state immediately, not the run result.

    Args:
        id: The automation ID.

    Returns:
        Optional[AutomationResponse]: The automation state at trigger time.
    """
    return await self._request(
        "POST",
        f"/v1/automations/{id}/run",
        model=Optional[AutomationResponse],
    )
delete_automation_by_id 
delete_automation_by_id(id: str) -> bool

Delete an automation and all its run history by ID.

Permanently removes the automation and all associated run records.

Parameters:

Name Type Description Default
id str

The automation ID.

 required

Returns:

Name Type Description
bool bool

True if deletion succeeded.
Source code in src/owui_client/routers/automations.py 
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
async def delete_automation_by_id(self, id: str) -> bool:
    """Delete an automation and all its run history by ID.

    Permanently removes the automation and all associated run records.

    Args:
        id: The automation ID.

    Returns:
        bool: True if deletion succeeded.
    """
    return await self._request(
        "DELETE",
        f"/v1/automations/{id}/delete",
        model=bool,
    )
get_automation_runs 
get_automation_runs(
    id: str, skip: int = 0, limit: int = 50
) -> List[AutomationRunModel]

Get run history for an automation.

Returns execution records ordered by creation time descending (most recent first).

Parameters:

Name Type Description Default
id str

The automation ID.

 required
skip int

Number of records to skip. Defaults to 0.

 0
limit int

Maximum number of records to return. Defaults to 50.

 50

Returns:

Type Description
List[AutomationRunModel]

List[AutomationRunModel]: List of run records.
Source code in src/owui_client/routers/automations.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
async def get_automation_runs(
    self,
    id: str,
    skip: int = 0,
    limit: int = 50,
) -> List[AutomationRunModel]:
    """Get run history for an automation.

    Returns execution records ordered by creation time descending (most
    recent first).

    Args:
        id: The automation ID.
        skip: Number of records to skip. Defaults to 0.
        limit: Maximum number of records to return. Defaults to 50.

    Returns:
        List[AutomationRunModel]: List of run records.
    """
    return await self._request(
        "GET",
        f"/v1/automations/{id}/runs",
        params={"skip": skip, "limit": limit},
        model=List[AutomationRunModel],
    )