venice_client 1.0.20 → 1.0.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -1
  3. data/docs/AudioModelPricingInput.md +0 -2
  4. data/docs/CacheControl.md +20 -0
  5. data/docs/ChatApi.md +1 -1
  6. data/docs/ChatCompletionRequest.md +7 -1
  7. data/docs/ChatCompletionRequestReasoning.md +18 -0
  8. data/docs/ChatCompletionRequestVeniceParameters.md +3 -1
  9. data/docs/CompleteVideo200Response.md +18 -0
  10. data/docs/CompleteVideoRequest.md +20 -0
  11. data/docs/CreateChatCompletion200Response.md +1 -1
  12. data/docs/CreateChatCompletion200ResponseVeniceParameters.md +2 -0
  13. data/docs/GenerateImageRequest.md +9 -3
  14. data/docs/GetApiKeyRateLimitLogs200ResponseDataInner.md +1 -1
  15. data/docs/GetApiKeyRateLimits200Response.md +0 -2
  16. data/docs/GetApiKeyRateLimits200ResponseDataBalances.md +0 -2
  17. data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInner.md +1 -1
  18. data/docs/ImageApi.md +1 -1
  19. data/docs/ImageModelPricingGeneration.md +0 -2
  20. data/docs/ImageModelPricingUpscale2x.md +0 -2
  21. data/docs/ImageModelPricingUpscale4x.md +0 -2
  22. data/docs/ImageUrl.md +2 -0
  23. data/docs/LLMModelPricingInput.md +0 -2
  24. data/docs/LLMModelPricingOutput.md +0 -2
  25. data/docs/ModelResponseModelSpec.md +2 -0
  26. data/docs/ModelResponseModelSpecConstraints.md +13 -1
  27. data/docs/ModelsApi.md +2 -2
  28. data/docs/QueueVideo200Response.md +20 -0
  29. data/docs/QueueVideoRequest.md +32 -0
  30. data/docs/QuoteVideo200Response.md +18 -0
  31. data/docs/RetrieveVideo200Response.md +22 -0
  32. data/docs/RetrieveVideoRequest.md +22 -0
  33. data/docs/SimpleGenerateImageRequest.md +1 -1
  34. data/docs/Text.md +2 -0
  35. data/docs/VideoApi.md +295 -0
  36. data/docs/VideoModelConstraints.md +28 -0
  37. data/lib/venice_client/api/api_keys_api.rb +1 -1
  38. data/lib/venice_client/api/audio_api.rb +1 -1
  39. data/lib/venice_client/api/billing_api.rb +1 -1
  40. data/lib/venice_client/api/characters_api.rb +1 -1
  41. data/lib/venice_client/api/chat_api.rb +1 -1
  42. data/lib/venice_client/api/embeddings_api.rb +1 -1
  43. data/lib/venice_client/api/image_api.rb +1 -1
  44. data/lib/venice_client/api/models_api.rb +3 -3
  45. data/lib/venice_client/api/preview_api.rb +1 -1
  46. data/lib/venice_client/api/speech_api.rb +1 -1
  47. data/lib/venice_client/api/video_api.rb +278 -0
  48. data/lib/venice_client/api_client.rb +1 -1
  49. data/lib/venice_client/api_error.rb +1 -1
  50. data/lib/venice_client/configuration.rb +1 -1
  51. data/lib/venice_client/models/assistant_message.rb +8 -8
  52. data/lib/venice_client/models/assistant_message_content.rb +1 -1
  53. data/lib/venice_client/models/audio_model_pricing.rb +1 -1
  54. data/lib/venice_client/models/audio_model_pricing_input.rb +2 -29
  55. data/lib/venice_client/models/billing_usage_request.rb +1 -1
  56. data/lib/venice_client/models/billing_usage_response.rb +1 -1
  57. data/lib/venice_client/models/cache_control.rb +273 -0
  58. data/lib/venice_client/models/chat_completion_request.rb +65 -2
  59. data/lib/venice_client/models/chat_completion_request_messages_inner.rb +2 -2
  60. data/lib/venice_client/models/chat_completion_request_reasoning.rb +256 -0
  61. data/lib/venice_client/models/chat_completion_request_response_format.rb +1 -1
  62. data/lib/venice_client/models/chat_completion_request_stop.rb +1 -1
  63. data/lib/venice_client/models/chat_completion_request_stream_options.rb +1 -1
  64. data/lib/venice_client/models/chat_completion_request_tool_choice.rb +1 -1
  65. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +1 -1
  66. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +1 -1
  67. data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +15 -3
  68. data/lib/venice_client/models/complete_video200_response.rb +238 -0
  69. data/lib/venice_client/models/complete_video_request.rb +265 -0
  70. data/lib/venice_client/models/create_api_key200_response.rb +1 -1
  71. data/lib/venice_client/models/create_api_key200_response_data.rb +1 -1
  72. data/lib/venice_client/models/create_api_key_request.rb +1 -1
  73. data/lib/venice_client/models/create_api_key_request_expires_at.rb +1 -1
  74. data/lib/venice_client/models/create_chat_completion200_response.rb +11 -19
  75. data/lib/venice_client/models/create_chat_completion200_response_choices_inner.rb +7 -7
  76. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs.rb +1 -1
  77. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb +1 -1
  78. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +2 -2
  79. data/lib/venice_client/models/create_chat_completion200_response_usage.rb +1 -1
  80. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb +29 -2
  81. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb +1 -1
  82. data/lib/venice_client/models/create_embedding200_response.rb +1 -1
  83. data/lib/venice_client/models/create_embedding200_response_data_inner.rb +1 -1
  84. data/lib/venice_client/models/create_embedding200_response_usage.rb +1 -1
  85. data/lib/venice_client/models/create_embedding_request_schema.rb +1 -1
  86. data/lib/venice_client/models/create_embedding_request_schema_input.rb +1 -1
  87. data/lib/venice_client/models/create_embedding_request_schema_model.rb +1 -1
  88. data/lib/venice_client/models/create_speech_request_schema.rb +1 -1
  89. data/lib/venice_client/models/delete_api_key200_response.rb +1 -1
  90. data/lib/venice_client/models/detailed_error.rb +1 -1
  91. data/lib/venice_client/models/edit_image_request.rb +1 -1
  92. data/lib/venice_client/models/edit_image_request_image.rb +1 -1
  93. data/lib/venice_client/models/generate_image200_response.rb +1 -1
  94. data/lib/venice_client/models/generate_image200_response_timing.rb +1 -1
  95. data/lib/venice_client/models/generate_image_request.rb +44 -42
  96. data/lib/venice_client/models/get_api_key_by_id200_response.rb +1 -1
  97. data/lib/venice_client/models/get_api_key_by_id200_response_data.rb +1 -1
  98. data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +1 -1
  99. data/lib/venice_client/models/get_api_key_generate_web3_key200_response_data.rb +1 -1
  100. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response.rb +1 -1
  101. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response_data_inner.rb +2 -2
  102. data/lib/venice_client/models/get_api_key_rate_limits200_response.rb +2 -12
  103. data/lib/venice_client/models/get_api_key_rate_limits200_response_data.rb +1 -1
  104. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_api_tier.rb +1 -1
  105. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_balances.rb +2 -12
  106. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner.rb +1 -1
  107. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb +1 -1
  108. data/lib/venice_client/models/get_api_keys200_response.rb +1 -1
  109. data/lib/venice_client/models/get_api_keys200_response_data_inner.rb +1 -1
  110. data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +1 -1
  111. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage.rb +1 -1
  112. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +1 -1
  113. data/lib/venice_client/models/get_billing_usage200_response.rb +1 -1
  114. data/lib/venice_client/models/get_billing_usage200_response_data_inner.rb +1 -1
  115. data/lib/venice_client/models/get_billing_usage200_response_data_inner_inference_details.rb +1 -1
  116. data/lib/venice_client/models/get_billing_usage200_response_pagination.rb +1 -1
  117. data/lib/venice_client/models/get_character_by_slug200_response.rb +1 -1
  118. data/lib/venice_client/models/image_model_constraints.rb +1 -1
  119. data/lib/venice_client/models/image_model_constraints_steps.rb +1 -1
  120. data/lib/venice_client/models/image_model_pricing.rb +1 -1
  121. data/lib/venice_client/models/image_model_pricing_generation.rb +2 -29
  122. data/lib/venice_client/models/image_model_pricing_upscale.rb +1 -1
  123. data/lib/venice_client/models/image_model_pricing_upscale2x.rb +2 -29
  124. data/lib/venice_client/models/image_model_pricing_upscale4x.rb +2 -29
  125. data/lib/venice_client/models/image_styles_get200_response.rb +1 -1
  126. data/lib/venice_client/models/image_url.rb +12 -3
  127. data/lib/venice_client/models/image_url_object.rb +1 -1
  128. data/lib/venice_client/models/json_object.rb +1 -1
  129. data/lib/venice_client/models/json_schema.rb +1 -1
  130. data/lib/venice_client/models/list_characters200_response.rb +1 -1
  131. data/lib/venice_client/models/list_characters200_response_data_inner.rb +1 -1
  132. data/lib/venice_client/models/list_characters200_response_data_inner_stats.rb +1 -1
  133. data/lib/venice_client/models/list_model_compatibility_mapping200_response.rb +1 -1
  134. data/lib/venice_client/models/list_model_traits200_response.rb +1 -1
  135. data/lib/venice_client/models/list_models200_response.rb +1 -1
  136. data/lib/venice_client/models/list_models200_response_type.rb +1 -1
  137. data/lib/venice_client/models/list_models_type_parameter.rb +1 -1
  138. data/lib/venice_client/models/llm_model_pricing.rb +1 -1
  139. data/lib/venice_client/models/llm_model_pricing_input.rb +2 -29
  140. data/lib/venice_client/models/llm_model_pricing_output.rb +2 -29
  141. data/lib/venice_client/models/model_response.rb +3 -3
  142. data/lib/venice_client/models/model_response_model_spec.rb +46 -2
  143. data/lib/venice_client/models/model_response_model_spec_capabilities.rb +3 -3
  144. data/lib/venice_client/models/model_response_model_spec_constraints.rb +3 -2
  145. data/lib/venice_client/models/model_response_model_spec_pricing.rb +1 -1
  146. data/lib/venice_client/models/objects_inner.rb +1 -1
  147. data/lib/venice_client/models/post_api_key_generate_web3_key_request.rb +1 -1
  148. data/lib/venice_client/models/queue_video200_response.rb +265 -0
  149. data/lib/venice_client/models/queue_video_request.rb +438 -0
  150. data/lib/venice_client/models/quote_video200_response.rb +237 -0
  151. data/lib/venice_client/models/retrieve_video200_response.rb +316 -0
  152. data/lib/venice_client/models/retrieve_video_request.rb +277 -0
  153. data/lib/venice_client/models/simple_generate_image200_response.rb +1 -1
  154. data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +1 -1
  155. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +1 -1
  156. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of1.rb +1 -1
  157. data/lib/venice_client/models/simple_generate_image_request.rb +1 -1
  158. data/lib/venice_client/models/standard_error.rb +1 -1
  159. data/lib/venice_client/models/system_message.rb +8 -8
  160. data/lib/venice_client/models/system_message_content.rb +1 -1
  161. data/lib/venice_client/models/text.rb +12 -3
  162. data/lib/venice_client/models/text_model_constraints.rb +1 -1
  163. data/lib/venice_client/models/text_model_constraints_temperature.rb +1 -1
  164. data/lib/venice_client/models/text_model_constraints_top_p.rb +1 -1
  165. data/lib/venice_client/models/tool_call.rb +1 -1
  166. data/lib/venice_client/models/tool_call_function.rb +1 -1
  167. data/lib/venice_client/models/tool_message.rb +8 -8
  168. data/lib/venice_client/models/upscale_image_request.rb +1 -1
  169. data/lib/venice_client/models/upscale_image_request_enhance.rb +1 -1
  170. data/lib/venice_client/models/user_message.rb +8 -8
  171. data/lib/venice_client/models/user_message_content.rb +1 -1
  172. data/lib/venice_client/models/video_model_constraints.rb +404 -0
  173. data/lib/venice_client/version.rb +2 -2
  174. data/lib/venice_client.rb +12 -1
  175. data/spec/api/video_api_spec.rb +83 -0
  176. data/spec/models/cache_control_spec.rb +46 -0
  177. data/spec/models/chat_completion_request_reasoning_spec.rb +40 -0
  178. data/spec/models/complete_video200_response_spec.rb +36 -0
  179. data/spec/models/complete_video_request_spec.rb +42 -0
  180. data/spec/models/queue_video200_response_spec.rb +42 -0
  181. data/spec/models/queue_video_request_spec.rb +86 -0
  182. data/spec/models/quote_video200_response_spec.rb +36 -0
  183. data/spec/models/retrieve_video200_response_spec.rb +52 -0
  184. data/spec/models/retrieve_video_request_spec.rb +48 -0
  185. data/spec/models/video_model_constraints_spec.rb +70 -0
  186. data/spec/spec_helper.rb +1 -1
  187. data/swagger.yaml +587 -76
  188. data/venice_client.gemspec +1 -1
  189. metadata +46 -2
@@ -24,7 +24,7 @@ require 'venice_client'
24
24
 
25
25
  instance = VeniceClient::SimpleGenerateImageRequest.new(
26
26
  background: auto,
27
- model: hidream,
27
+ model: z-image-turbo,
28
28
  moderation: auto,
29
29
  n: 1,
30
30
  output_compression: null,
data/docs/Text.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **cache_control** | [**CacheControl**](CacheControl.md) | | [optional] |
7
8
  | **text** | **String** | The prompt text of the message. Must be at-least one character in length | |
8
9
  | **type** | **String** | | |
9
10
 
@@ -13,6 +14,7 @@
13
14
  require 'venice_client'
14
15
 
15
16
  instance = VeniceClient::Text.new(
17
+ cache_control: null,
16
18
  text: Why is the sky blue?,
17
19
  type: null
18
20
  )
data/docs/VideoApi.md ADDED
@@ -0,0 +1,295 @@
1
+ # VeniceClient::VideoApi
2
+
3
+ All URIs are relative to *https://api.venice.ai/api/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**complete_video**](VideoApi.md#complete_video) | **POST** /video/complete | /api/v1/video/complete |
8
+ | [**queue_video**](VideoApi.md#queue_video) | **POST** /video/queue | /api/v1/video/queue |
9
+ | [**quote_video**](VideoApi.md#quote_video) | **POST** /video/quote | /api/v1/video/quote |
10
+ | [**retrieve_video**](VideoApi.md#retrieve_video) | **POST** /video/retrieve | /api/v1/video/retrieve |
11
+
12
+
13
+ ## complete_video
14
+
15
+ > <CompleteVideo200Response> complete_video(opts)
16
+
17
+ /api/v1/video/complete
18
+
19
+ Delete a video generation request from storage after it has been successfully downloaded. Videos can be automatically deleted after retrieval by setting the `delete_media_on_completion` flag to true when calling the retrieve API.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'venice_client'
26
+ # setup authorization
27
+ VeniceClient.configure do |config|
28
+ # Configure Bearer authorization (JWT): BearerAuth
29
+ config.access_token = 'YOUR_BEARER_TOKEN'
30
+ end
31
+
32
+ api_instance = VeniceClient::VideoApi.new
33
+ opts = {
34
+ complete_video_request: VeniceClient::CompleteVideoRequest.new({model: 'video-model-123', queue_id: '123e4567-e89b-12d3-a456-426614174000'}) # CompleteVideoRequest |
35
+ }
36
+
37
+ begin
38
+ # /api/v1/video/complete
39
+ result = api_instance.complete_video(opts)
40
+ p result
41
+ rescue VeniceClient::ApiError => e
42
+ puts "Error when calling VideoApi->complete_video: #{e}"
43
+ end
44
+ ```
45
+
46
+ #### Using the complete_video_with_http_info variant
47
+
48
+ This returns an Array which contains the response data, status code and headers.
49
+
50
+ > <Array(<CompleteVideo200Response>, Integer, Hash)> complete_video_with_http_info(opts)
51
+
52
+ ```ruby
53
+ begin
54
+ # /api/v1/video/complete
55
+ data, status_code, headers = api_instance.complete_video_with_http_info(opts)
56
+ p status_code # => 2xx
57
+ p headers # => { ... }
58
+ p data # => <CompleteVideo200Response>
59
+ rescue VeniceClient::ApiError => e
60
+ puts "Error when calling VideoApi->complete_video_with_http_info: #{e}"
61
+ end
62
+ ```
63
+
64
+ ### Parameters
65
+
66
+ | Name | Type | Description | Notes |
67
+ | ---- | ---- | ----------- | ----- |
68
+ | **complete_video_request** | [**CompleteVideoRequest**](CompleteVideoRequest.md) | | [optional] |
69
+
70
+ ### Return type
71
+
72
+ [**CompleteVideo200Response**](CompleteVideo200Response.md)
73
+
74
+ ### Authorization
75
+
76
+ [BearerAuth](../README.md#BearerAuth)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: application/json
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## queue_video
85
+
86
+ > <QueueVideo200Response> queue_video(opts)
87
+
88
+ /api/v1/video/queue
89
+
90
+ Queue a new video generation request.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'venice_client'
97
+ # setup authorization
98
+ VeniceClient.configure do |config|
99
+ # Configure Bearer authorization (JWT): BearerAuth
100
+ config.access_token = 'YOUR_BEARER_TOKEN'
101
+ end
102
+
103
+ api_instance = VeniceClient::VideoApi.new
104
+ opts = {
105
+ queue_video_request: VeniceClient::QueueVideoRequest.new({model: 'wan-2.5-preview-image-to-video', prompt: 'Commerce being conducted in the city of Venice, Italy.', duration: '5s', image_url: 'data:image/png;base64,iVBORw0K...'}) # QueueVideoRequest |
106
+ }
107
+
108
+ begin
109
+ # /api/v1/video/queue
110
+ result = api_instance.queue_video(opts)
111
+ p result
112
+ rescue VeniceClient::ApiError => e
113
+ puts "Error when calling VideoApi->queue_video: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the queue_video_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(<QueueVideo200Response>, Integer, Hash)> queue_video_with_http_info(opts)
122
+
123
+ ```ruby
124
+ begin
125
+ # /api/v1/video/queue
126
+ data, status_code, headers = api_instance.queue_video_with_http_info(opts)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => <QueueVideo200Response>
130
+ rescue VeniceClient::ApiError => e
131
+ puts "Error when calling VideoApi->queue_video_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **queue_video_request** | [**QueueVideoRequest**](QueueVideoRequest.md) | | [optional] |
140
+
141
+ ### Return type
142
+
143
+ [**QueueVideo200Response**](QueueVideo200Response.md)
144
+
145
+ ### Authorization
146
+
147
+ [BearerAuth](../README.md#BearerAuth)
148
+
149
+ ### HTTP request headers
150
+
151
+ - **Content-Type**: application/json
152
+ - **Accept**: application/json
153
+
154
+
155
+ ## quote_video
156
+
157
+ > <QuoteVideo200Response> quote_video(opts)
158
+
159
+ /api/v1/video/quote
160
+
161
+ Quote a video generation request. Utilizes the same parameters as the queue API and will return the price in USD for the request.
162
+
163
+ ### Examples
164
+
165
+ ```ruby
166
+ require 'time'
167
+ require 'venice_client'
168
+ # setup authorization
169
+ VeniceClient.configure do |config|
170
+ # Configure Bearer authorization (JWT): BearerAuth
171
+ config.access_token = 'YOUR_BEARER_TOKEN'
172
+ end
173
+
174
+ api_instance = VeniceClient::VideoApi.new
175
+ opts = {
176
+ queue_video_request: VeniceClient::QueueVideoRequest.new({model: 'wan-2.5-preview-image-to-video', prompt: 'Commerce being conducted in the city of Venice, Italy.', duration: '5s', image_url: 'data:image/png;base64,iVBORw0K...'}) # QueueVideoRequest |
177
+ }
178
+
179
+ begin
180
+ # /api/v1/video/quote
181
+ result = api_instance.quote_video(opts)
182
+ p result
183
+ rescue VeniceClient::ApiError => e
184
+ puts "Error when calling VideoApi->quote_video: #{e}"
185
+ end
186
+ ```
187
+
188
+ #### Using the quote_video_with_http_info variant
189
+
190
+ This returns an Array which contains the response data, status code and headers.
191
+
192
+ > <Array(<QuoteVideo200Response>, Integer, Hash)> quote_video_with_http_info(opts)
193
+
194
+ ```ruby
195
+ begin
196
+ # /api/v1/video/quote
197
+ data, status_code, headers = api_instance.quote_video_with_http_info(opts)
198
+ p status_code # => 2xx
199
+ p headers # => { ... }
200
+ p data # => <QuoteVideo200Response>
201
+ rescue VeniceClient::ApiError => e
202
+ puts "Error when calling VideoApi->quote_video_with_http_info: #{e}"
203
+ end
204
+ ```
205
+
206
+ ### Parameters
207
+
208
+ | Name | Type | Description | Notes |
209
+ | ---- | ---- | ----------- | ----- |
210
+ | **queue_video_request** | [**QueueVideoRequest**](QueueVideoRequest.md) | | [optional] |
211
+
212
+ ### Return type
213
+
214
+ [**QuoteVideo200Response**](QuoteVideo200Response.md)
215
+
216
+ ### Authorization
217
+
218
+ [BearerAuth](../README.md#BearerAuth)
219
+
220
+ ### HTTP request headers
221
+
222
+ - **Content-Type**: application/json
223
+ - **Accept**: application/json
224
+
225
+
226
+ ## retrieve_video
227
+
228
+ > <RetrieveVideo200Response> retrieve_video(opts)
229
+
230
+ /api/v1/video/retrieve
231
+
232
+ Retrieve a video generation result. Returns the video file if completed, or a status if the request is still processing.
233
+
234
+ ### Examples
235
+
236
+ ```ruby
237
+ require 'time'
238
+ require 'venice_client'
239
+ # setup authorization
240
+ VeniceClient.configure do |config|
241
+ # Configure Bearer authorization (JWT): BearerAuth
242
+ config.access_token = 'YOUR_BEARER_TOKEN'
243
+ end
244
+
245
+ api_instance = VeniceClient::VideoApi.new
246
+ opts = {
247
+ retrieve_video_request: VeniceClient::RetrieveVideoRequest.new({model: 'video-model-123', queue_id: '123e4567-e89b-12d3-a456-426614174000'}) # RetrieveVideoRequest |
248
+ }
249
+
250
+ begin
251
+ # /api/v1/video/retrieve
252
+ result = api_instance.retrieve_video(opts)
253
+ p result
254
+ rescue VeniceClient::ApiError => e
255
+ puts "Error when calling VideoApi->retrieve_video: #{e}"
256
+ end
257
+ ```
258
+
259
+ #### Using the retrieve_video_with_http_info variant
260
+
261
+ This returns an Array which contains the response data, status code and headers.
262
+
263
+ > <Array(<RetrieveVideo200Response>, Integer, Hash)> retrieve_video_with_http_info(opts)
264
+
265
+ ```ruby
266
+ begin
267
+ # /api/v1/video/retrieve
268
+ data, status_code, headers = api_instance.retrieve_video_with_http_info(opts)
269
+ p status_code # => 2xx
270
+ p headers # => { ... }
271
+ p data # => <RetrieveVideo200Response>
272
+ rescue VeniceClient::ApiError => e
273
+ puts "Error when calling VideoApi->retrieve_video_with_http_info: #{e}"
274
+ end
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ | Name | Type | Description | Notes |
280
+ | ---- | ---- | ----------- | ----- |
281
+ | **retrieve_video_request** | [**RetrieveVideoRequest**](RetrieveVideoRequest.md) | | [optional] |
282
+
283
+ ### Return type
284
+
285
+ [**RetrieveVideo200Response**](RetrieveVideo200Response.md)
286
+
287
+ ### Authorization
288
+
289
+ [BearerAuth](../README.md#BearerAuth)
290
+
291
+ ### HTTP request headers
292
+
293
+ - **Content-Type**: application/json
294
+ - **Accept**: application/json, video/mp4
295
+
@@ -0,0 +1,28 @@
1
+ # VeniceClient::VideoModelConstraints
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **aspect_ratios** | **Array&lt;String&gt;** | The aspect ratios supported by the model. Empty array means the model does not support a defined aspect ratio. | |
8
+ | **resolutions** | **Array&lt;String&gt;** | The resolutions supported by the model. Empty array means the model does not support a defined resolution. | |
9
+ | **durations** | **Array&lt;String&gt;** | The durations supported by the model. Empty array means the model does not support a defined duration. | |
10
+ | **model_type** | **String** | The type of video model. | |
11
+ | **audio** | **Boolean** | Does the model support audio generation? | |
12
+ | **audio_configurable** | **Boolean** | Can audio be enabled or disabled for the video generation? | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'venice_client'
18
+
19
+ instance = VeniceClient::VideoModelConstraints.new(
20
+ aspect_ratios: [969,556],
21
+ resolutions: [&quot;1080p&quot;,&quot;720p&quot;,&quot;480p&quot;],
22
+ durations: [&quot;5s&quot;,&quot;10s&quot;,&quot;15s&quot;,&quot;20s&quot;,&quot;30s&quot;],
23
+ model_type: image-to-video,
24
+ audio: true,
25
+ audio_configurable: true
26
+ )
27
+ ```
28
+
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -38,7 +38,7 @@ module VeniceClient
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: ModelsApi.list_model_compatibility_mapping ...'
40
40
  end
41
- allowable_values = ["embedding", "image", "text", "tts", "upscale", "inpaint"]
41
+ allowable_values = ["asr", "embedding", "image", "text", "tts", "upscale", "inpaint", "video"]
42
42
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
43
43
  fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
44
44
  end
@@ -102,7 +102,7 @@ module VeniceClient
102
102
  if @api_client.config.debugging
103
103
  @api_client.config.logger.debug 'Calling API: ModelsApi.list_model_traits ...'
104
104
  end
105
- allowable_values = ["embedding", "image", "text", "tts", "upscale", "inpaint"]
105
+ allowable_values = ["asr", "embedding", "image", "text", "tts", "upscale", "inpaint", "video"]
106
106
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
107
107
  fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
108
108
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250918.173746
6
+ The version of the OpenAPI document: 20251209.153516
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0