windmill-api 1.841.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436

# \AiApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_ai_artifact_share_status**](AiApi.md#get_ai_artifact_share_status) | **GET** /w/{workspace}/ai/shared_artifacts/status | get the calling user's share of one of their AI session artifacts
[**get_ai_session_share_status**](AiApi.md#get_ai_session_share_status) | **GET** /w/{workspace}/ai/shared_sessions/status | get the calling user's share of one of their AI sessions
[**get_shared_ai_artifact**](AiApi.md#get_shared_ai_artifact) | **GET** /w/{workspace}/ai/shared_artifacts/get/{id} | get a shared AI session artifact
[**get_shared_ai_session**](AiApi.md#get_shared_ai_session) | **GET** /w/{workspace}/ai_u/shared_sessions/get/{id} | get a shared AI session
[**list_ai_session_backups**](AiApi.md#list_ai_session_backups) | **GET** /w/{workspace}/ai/sessions/list | list the calling user's AI session backups in the workspace object storage
[**list_ai_usage**](AiApi.md#list_ai_usage) | **GET** /w/{workspace}/ai/usage | list aggregated AI token usage
[**pull_ai_session_backups**](AiApi.md#pull_ai_session_backups) | **POST** /w/{workspace}/ai/sessions/pull | fetch whole AI session backups
[**push_ai_session_backups**](AiApi.md#push_ai_session_backups) | **POST** /w/{workspace}/ai/sessions/push | write changed pieces of AI sessions to their backups, and remove deleted ones
[**record_ai_usage**](AiApi.md#record_ai_usage) | **POST** /w/{workspace}/ai/usage | record AI token usage for the calling user
[**set_ai_session_share_public**](AiApi.md#set_ai_session_share_public) | **POST** /w/{workspace}/ai/shared_sessions/set_public/{id} | make a shared AI session public, or reserve it to workspace members
[**share_ai_artifact**](AiApi.md#share_ai_artifact) | **POST** /w/{workspace}/ai/shared_artifacts/share | share an AI session artifact with the workspace
[**share_ai_session**](AiApi.md#share_ai_session) | **POST** /w/{workspace}/ai/shared_sessions/share | share an AI session transcript by link
[**unshare_ai_artifact**](AiApi.md#unshare_ai_artifact) | **DELETE** /w/{workspace}/ai/shared_artifacts/delete/{id} | stop sharing an AI session artifact
[**unshare_ai_session**](AiApi.md#unshare_ai_session) | **DELETE** /w/{workspace}/ai/shared_sessions/delete/{id} | stop sharing an AI session



## get_ai_artifact_share_status

> models::GetAiArtifactShareStatus200Response get_ai_artifact_share_status(workspace, artifact_id)
get the calling user's share of one of their AI session artifacts

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**artifact_id** | **String** |  | [required] |

### Return type

[**models::GetAiArtifactShareStatus200Response**](getAiArtifactShareStatus_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_ai_session_share_status

> models::GetAiSessionShareStatus200Response get_ai_session_share_status(workspace, session_id)
get the calling user's share of one of their AI sessions

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**session_id** | **String** |  | [required] |

### Return type

[**models::GetAiSessionShareStatus200Response**](getAiSessionShareStatus_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_shared_ai_artifact

> models::GetSharedAiArtifact200Response get_shared_ai_artifact(workspace, id)
get a shared AI session artifact

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::GetSharedAiArtifact200Response**](getSharedAiArtifact_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_shared_ai_session

> models::GetSharedAiSession200Response get_shared_ai_session(workspace, id)
get a shared AI session

A public share is served without authentication; any other one only to a member of the workspace. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

[**models::GetSharedAiSession200Response**](getSharedAiSession_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_ai_session_backups

> models::ListAiSessionBackups200Response list_ai_session_backups(workspace)
list the calling user's AI session backups in the workspace object storage

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |

### Return type

[**models::ListAiSessionBackups200Response**](listAiSessionBackups_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_ai_usage

> models::ListAiUsage200Response list_ai_usage(workspace, days, group_by, scope)
list aggregated AI token usage

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**days** | Option<**i32**> |  |  |
**group_by** | Option<**String**> |  |  |
**scope** | Option<**String**> | workspace-wide usage (admin only) or the calling user's own |  |

### Return type

[**models::ListAiUsage200Response**](listAiUsage_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## pull_ai_session_backups

> models::PullAiSessionBackups200Response pull_ai_session_backups(workspace, pull_ai_session_backups_request)
fetch whole AI session backups

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**pull_ai_session_backups_request** | [**PullAiSessionBackupsRequest**](PullAiSessionBackupsRequest.md) |  | [required] |

### Return type

[**models::PullAiSessionBackups200Response**](pullAiSessionBackups_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## push_ai_session_backups

> models::PushAiSessionBackups200Response push_ai_session_backups(workspace, push_ai_session_backups_request)
write changed pieces of AI sessions to their backups, and remove deleted ones

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**push_ai_session_backups_request** | [**PushAiSessionBackupsRequest**](PushAiSessionBackupsRequest.md) |  | [required] |

### Return type

[**models::PushAiSessionBackups200Response**](pushAiSessionBackups_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## record_ai_usage

> record_ai_usage(workspace, record_ai_usage_request)
record AI token usage for the calling user

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**record_ai_usage_request** | [**RecordAiUsageRequest**](RecordAiUsageRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_ai_session_share_public

> models::SharedAiSessionInfo set_ai_session_share_public(workspace, id, set_ai_session_share_public_request)
make a shared AI session public, or reserve it to workspace members

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |
**set_ai_session_share_public_request** | [**SetAiSessionSharePublicRequest**](SetAiSessionSharePublicRequest.md) |  | [required] |

### Return type

[**models::SharedAiSessionInfo**](SharedAiSessionInfo.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## share_ai_artifact

> models::SharedAiArtifactInfo share_ai_artifact(workspace, share_ai_artifact_request)
share an AI session artifact with the workspace

Stores a read-only copy that any member of the workspace can open by id. Sharing the same artifact again updates that copy, keeps its id, and restarts its retention window. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**share_ai_artifact_request** | [**ShareAiArtifactRequest**](ShareAiArtifactRequest.md) |  | [required] |

### Return type

[**models::SharedAiArtifactInfo**](SharedAiArtifactInfo.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## share_ai_session

> models::SharedAiSessionInfo share_ai_session(workspace, share_ai_session_request)
share an AI session transcript by link

Stores a read-only snapshot of the session that members of the workspace can open by id, or anyone with the link once it is public. Sharing the same session again updates that snapshot and keeps its id. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**share_ai_session_request** | [**ShareAiSessionRequest**](ShareAiSessionRequest.md) |  | [required] |

### Return type

[**models::SharedAiSessionInfo**](SharedAiSessionInfo.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unshare_ai_artifact

> String unshare_ai_artifact(workspace, id)
stop sharing an AI session artifact

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unshare_ai_session

> String unshare_ai_session(workspace, id)
stop sharing an AI session

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**id** | **uuid::Uuid** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)