openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
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

# \VideosApi

All URIs are relative to *https://api.openai.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_video**](VideosApi.md#create_video) | **POST** /videos | Create a new video generation job from a prompt and optional reference assets.
[**create_video_character**](VideosApi.md#create_video_character) | **POST** /videos/characters | Create a character from an uploaded video.
[**create_video_edit**](VideosApi.md#create_video_edit) | **POST** /videos/edits | Create a new video generation job by editing a source video or existing generated video.
[**create_video_extend**](VideosApi.md#create_video_extend) | **POST** /videos/extensions | Create an extension of a completed video.
[**create_video_remix**](VideosApi.md#create_video_remix) | **POST** /videos/{video_id}/remix | Create a remix of a completed video using a refreshed prompt.
[**delete_video**](VideosApi.md#delete_video) | **DELETE** /videos/{video_id} | Permanently delete a completed or failed video and its stored assets.
[**get_video**](VideosApi.md#get_video) | **GET** /videos/{video_id} | Fetch the latest metadata for a generated video.
[**get_video_character**](VideosApi.md#get_video_character) | **GET** /videos/characters/{character_id} | Fetch a character.
[**list_videos**](VideosApi.md#list_videos) | **GET** /videos | List recently generated videos for the current project.
[**retrieve_video_content**](VideosApi.md#retrieve_video_content) | **GET** /videos/{video_id}/content | Download the generated video bytes or a derived preview asset.  Streams the rendered video content for the specified video job.



## create_video

> models::VideoResource create_video(prompt, model, input_reference, seconds, size)
Create a new video generation job from a prompt and optional reference assets.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**prompt** | **String** | Text prompt that describes the video to generate. | [required] |
**model** | Option<[**models::VideoModel**](VideoModel.md)> |  |  |
**input_reference** | Option<[**models::CreateVideoMultipartBodyInputReference**](CreateVideoMultipartBody_input_reference.md)> |  |  |
**seconds** | Option<[**models::VideoSeconds**](VideoSeconds.md)> |  |  |
**size** | Option<[**models::VideoSize**](VideoSize.md)> |  |  |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data, 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)


## create_video_character

> models::VideoCharacterResource create_video_character(video, name)
Create a character from an uploaded video.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video** | **std::path::PathBuf** | Video file used to create a character. | [required] |
**name** | **String** | Display name for this API character. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data
- **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)


## create_video_edit

> models::VideoResource create_video_edit(video, prompt)
Create a new video generation job by editing a source video or existing generated video.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video** | [**models::CreateVideoEditMultipartBodyVideo**](CreateVideoEditMultipartBody_video.md) |  | [required] |
**prompt** | **String** | Text prompt that describes how to edit the source video. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data, 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)


## create_video_extend

> models::VideoResource create_video_extend(video, prompt, seconds)
Create an extension of a completed video.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video** | [**models::CreateVideoExtendMultipartBodyVideo**](CreateVideoExtendMultipartBody_video.md) |  | [required] |
**prompt** | **String** | Updated text prompt that directs the extension generation. | [required] |
**seconds** | [**models::VideoSeconds**](VideoSeconds.md) |  | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data, 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)


## create_video_remix

> models::VideoResource create_video_remix(video_id, prompt)
Create a remix of a completed video using a refreshed prompt.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video_id** | **String** | The identifier of the completed video to remix. | [required] |
**prompt** | **String** | Updated text prompt that directs the remix generation. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: multipart/form-data, 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)


## delete_video

> models::DeletedVideoResource delete_video(video_id)
Permanently delete a completed or failed video and its stored assets.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video_id** | **String** | The identifier of the video to delete. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

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

> models::VideoResource get_video(video_id)
Fetch the latest metadata for a generated video.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video_id** | **String** | The identifier of the video to retrieve. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

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

> models::VideoCharacterResource get_video_character(character_id)
Fetch a character.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**character_id** | **String** | The identifier of the character to retrieve. | [required] |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

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

> models::VideoListResource list_videos(limit, order, after)
List recently generated videos for the current project.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**i32**> | Number of items to retrieve |  |
**order** | Option<[**OrderEnum**](.md)> | Sort order of results by timestamp. Use `asc` for ascending order or `desc` for descending order. |  |
**after** | Option<**String**> | Identifier for the last item from the previous pagination request |  |

### Return type

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

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

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


## retrieve_video_content

> std::path::PathBuf retrieve_video_content(video_id, variant)
Download the generated video bytes or a derived preview asset.  Streams the rendered video content for the specified video job.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**video_id** | **String** | The identifier of the video whose media to download. | [required] |
**variant** | Option<[**VideoContentVariant**](.md)> | Which downloadable asset to return. Defaults to the MP4 video. |  |

### Return type

[**std::path::PathBuf**](std::path::PathBuf.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: video/mp4, image/webp, 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)