windmill-api 1.812.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

# \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_shared_ai_artifact**](AiApi.md#get_shared_ai_artifact) | **GET** /w/{workspace}/ai/shared_artifacts/get/{id} | get a shared AI session artifact
[**list_ai_usage**](AiApi.md#list_ai_usage) | **GET** /w/{workspace}/ai/usage | list aggregated AI token usage
[**record_ai_usage**](AiApi.md#record_ai_usage) | **POST** /w/{workspace}/ai/usage | record AI token usage for the calling user
[**share_ai_artifact**](AiApi.md#share_ai_artifact) | **POST** /w/{workspace}/ai/shared_artifacts/share | share an AI session artifact with the workspace
[**unshare_ai_artifact**](AiApi.md#unshare_ai_artifact) | **DELETE** /w/{workspace}/ai/shared_artifacts/delete/{id} | stop sharing an AI session artifact



## 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_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)


## 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)


## 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)


## 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)


## 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)