venice_client 1.0.20 → 1.0.22
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.
- checksums.yaml +4 -4
- data/README.md +15 -1
- data/docs/AudioModelPricingInput.md +0 -2
- data/docs/CacheControl.md +20 -0
- data/docs/ChatApi.md +1 -1
- data/docs/ChatCompletionRequest.md +7 -1
- data/docs/ChatCompletionRequestReasoning.md +18 -0
- data/docs/ChatCompletionRequestVeniceParameters.md +3 -1
- data/docs/CompleteVideo200Response.md +18 -0
- data/docs/CompleteVideoRequest.md +20 -0
- data/docs/CreateChatCompletion200Response.md +1 -1
- data/docs/CreateChatCompletion200ResponseVeniceParameters.md +2 -0
- data/docs/GenerateImageRequest.md +9 -3
- data/docs/GetApiKeyRateLimitLogs200ResponseDataInner.md +1 -1
- data/docs/GetApiKeyRateLimits200Response.md +0 -2
- data/docs/GetApiKeyRateLimits200ResponseDataBalances.md +0 -2
- data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInner.md +1 -1
- data/docs/ImageApi.md +1 -1
- data/docs/ImageModelPricingGeneration.md +0 -2
- data/docs/ImageModelPricingUpscale2x.md +0 -2
- data/docs/ImageModelPricingUpscale4x.md +0 -2
- data/docs/ImageUrl.md +2 -0
- data/docs/LLMModelPricingInput.md +0 -2
- data/docs/LLMModelPricingOutput.md +0 -2
- data/docs/ModelResponseModelSpec.md +2 -0
- data/docs/ModelResponseModelSpecConstraints.md +13 -1
- data/docs/ModelsApi.md +2 -2
- data/docs/QueueVideo200Response.md +20 -0
- data/docs/QueueVideoRequest.md +32 -0
- data/docs/QuoteVideo200Response.md +18 -0
- data/docs/RetrieveVideo200Response.md +22 -0
- data/docs/RetrieveVideoRequest.md +22 -0
- data/docs/SimpleGenerateImageRequest.md +1 -1
- data/docs/Text.md +2 -0
- data/docs/VideoApi.md +295 -0
- data/docs/VideoModelConstraints.md +28 -0
- data/lib/venice_client/api/api_keys_api.rb +1 -1
- data/lib/venice_client/api/audio_api.rb +1 -1
- data/lib/venice_client/api/billing_api.rb +1 -1
- data/lib/venice_client/api/characters_api.rb +1 -1
- data/lib/venice_client/api/chat_api.rb +1 -1
- data/lib/venice_client/api/embeddings_api.rb +1 -1
- data/lib/venice_client/api/image_api.rb +1 -1
- data/lib/venice_client/api/models_api.rb +3 -3
- data/lib/venice_client/api/preview_api.rb +1 -1
- data/lib/venice_client/api/speech_api.rb +1 -1
- data/lib/venice_client/api/video_api.rb +278 -0
- data/lib/venice_client/api_client.rb +1 -1
- data/lib/venice_client/api_error.rb +1 -1
- data/lib/venice_client/configuration.rb +1 -1
- data/lib/venice_client/models/assistant_message.rb +8 -8
- data/lib/venice_client/models/assistant_message_content.rb +1 -1
- data/lib/venice_client/models/audio_model_pricing.rb +1 -1
- data/lib/venice_client/models/audio_model_pricing_input.rb +2 -29
- data/lib/venice_client/models/billing_usage_request.rb +1 -1
- data/lib/venice_client/models/billing_usage_response.rb +1 -1
- data/lib/venice_client/models/cache_control.rb +273 -0
- data/lib/venice_client/models/chat_completion_request.rb +65 -2
- data/lib/venice_client/models/chat_completion_request_messages_inner.rb +2 -2
- data/lib/venice_client/models/chat_completion_request_reasoning.rb +256 -0
- data/lib/venice_client/models/chat_completion_request_response_format.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_stop.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_stream_options.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +1 -1
- data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +15 -3
- data/lib/venice_client/models/complete_video200_response.rb +238 -0
- data/lib/venice_client/models/complete_video_request.rb +265 -0
- data/lib/venice_client/models/create_api_key200_response.rb +1 -1
- data/lib/venice_client/models/create_api_key200_response_data.rb +1 -1
- data/lib/venice_client/models/create_api_key_request.rb +1 -1
- data/lib/venice_client/models/create_api_key_request_expires_at.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response.rb +11 -19
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner.rb +9 -9
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +2 -2
- data/lib/venice_client/models/create_chat_completion200_response_usage.rb +1 -1
- data/lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb +29 -2
- data/lib/venice_client/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/create_embedding200_response_usage.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema_input.rb +1 -1
- data/lib/venice_client/models/create_embedding_request_schema_model.rb +1 -1
- data/lib/venice_client/models/create_speech_request_schema.rb +1 -1
- data/lib/venice_client/models/delete_api_key200_response.rb +1 -1
- data/lib/venice_client/models/detailed_error.rb +1 -1
- data/lib/venice_client/models/edit_image_request.rb +1 -1
- data/lib/venice_client/models/edit_image_request_image.rb +1 -1
- data/lib/venice_client/models/generate_image200_response.rb +1 -1
- data/lib/venice_client/models/generate_image200_response_timing.rb +1 -1
- data/lib/venice_client/models/generate_image_request.rb +44 -42
- data/lib/venice_client/models/get_api_key_by_id200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_by_id200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_generate_web3_key200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limit_logs200_response.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limit_logs200_response_data_inner.rb +2 -2
- data/lib/venice_client/models/get_api_key_rate_limits200_response.rb +2 -12
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_api_tier.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_balances.rb +2 -12
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner.rb +1 -1
- data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_usage.rb +1 -1
- data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_data_inner_inference_details.rb +1 -1
- data/lib/venice_client/models/get_billing_usage200_response_pagination.rb +1 -1
- data/lib/venice_client/models/get_character_by_slug200_response.rb +1 -1
- data/lib/venice_client/models/image_model_constraints.rb +1 -1
- data/lib/venice_client/models/image_model_constraints_steps.rb +1 -1
- data/lib/venice_client/models/image_model_pricing.rb +1 -1
- data/lib/venice_client/models/image_model_pricing_generation.rb +2 -29
- data/lib/venice_client/models/image_model_pricing_upscale.rb +1 -1
- data/lib/venice_client/models/image_model_pricing_upscale2x.rb +2 -29
- data/lib/venice_client/models/image_model_pricing_upscale4x.rb +2 -29
- data/lib/venice_client/models/image_styles_get200_response.rb +1 -1
- data/lib/venice_client/models/image_url.rb +12 -3
- data/lib/venice_client/models/image_url_object.rb +1 -1
- data/lib/venice_client/models/json_object.rb +1 -1
- data/lib/venice_client/models/json_schema.rb +1 -1
- data/lib/venice_client/models/list_characters200_response.rb +1 -1
- data/lib/venice_client/models/list_characters200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/list_characters200_response_data_inner_stats.rb +1 -1
- data/lib/venice_client/models/list_model_compatibility_mapping200_response.rb +1 -1
- data/lib/venice_client/models/list_model_traits200_response.rb +1 -1
- data/lib/venice_client/models/list_models200_response.rb +1 -1
- data/lib/venice_client/models/list_models200_response_type.rb +1 -1
- data/lib/venice_client/models/list_models_type_parameter.rb +1 -1
- data/lib/venice_client/models/llm_model_pricing.rb +1 -1
- data/lib/venice_client/models/llm_model_pricing_input.rb +2 -29
- data/lib/venice_client/models/llm_model_pricing_output.rb +2 -29
- data/lib/venice_client/models/model_response.rb +3 -3
- data/lib/venice_client/models/model_response_model_spec.rb +46 -2
- data/lib/venice_client/models/model_response_model_spec_capabilities.rb +3 -3
- data/lib/venice_client/models/model_response_model_spec_constraints.rb +3 -2
- data/lib/venice_client/models/model_response_model_spec_pricing.rb +1 -1
- data/lib/venice_client/models/objects_inner.rb +1 -1
- data/lib/venice_client/models/post_api_key_generate_web3_key_request.rb +1 -1
- data/lib/venice_client/models/queue_video200_response.rb +265 -0
- data/lib/venice_client/models/queue_video_request.rb +438 -0
- data/lib/venice_client/models/quote_video200_response.rb +237 -0
- data/lib/venice_client/models/retrieve_video200_response.rb +316 -0
- data/lib/venice_client/models/retrieve_video_request.rb +277 -0
- data/lib/venice_client/models/simple_generate_image200_response.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +1 -1
- data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of1.rb +1 -1
- data/lib/venice_client/models/simple_generate_image_request.rb +1 -1
- data/lib/venice_client/models/standard_error.rb +1 -1
- data/lib/venice_client/models/system_message.rb +8 -8
- data/lib/venice_client/models/system_message_content.rb +1 -1
- data/lib/venice_client/models/text.rb +12 -3
- data/lib/venice_client/models/text_model_constraints.rb +1 -1
- data/lib/venice_client/models/text_model_constraints_temperature.rb +1 -1
- data/lib/venice_client/models/text_model_constraints_top_p.rb +1 -1
- data/lib/venice_client/models/tool_call.rb +1 -1
- data/lib/venice_client/models/tool_call_function.rb +1 -1
- data/lib/venice_client/models/tool_message.rb +8 -8
- data/lib/venice_client/models/upscale_image_request.rb +1 -1
- data/lib/venice_client/models/upscale_image_request_enhance.rb +1 -1
- data/lib/venice_client/models/user_message.rb +8 -8
- data/lib/venice_client/models/user_message_content.rb +1 -1
- data/lib/venice_client/models/video_model_constraints.rb +404 -0
- data/lib/venice_client/version.rb +2 -2
- data/lib/venice_client.rb +12 -1
- data/spec/api/video_api_spec.rb +83 -0
- data/spec/models/cache_control_spec.rb +46 -0
- data/spec/models/chat_completion_request_reasoning_spec.rb +40 -0
- data/spec/models/complete_video200_response_spec.rb +36 -0
- data/spec/models/complete_video_request_spec.rb +42 -0
- data/spec/models/queue_video200_response_spec.rb +42 -0
- data/spec/models/queue_video_request_spec.rb +86 -0
- data/spec/models/quote_video200_response_spec.rb +36 -0
- data/spec/models/retrieve_video200_response_spec.rb +52 -0
- data/spec/models/retrieve_video_request_spec.rb +48 -0
- data/spec/models/video_model_constraints_spec.rb +70 -0
- data/spec/spec_helper.rb +1 -1
- data/swagger.yaml +587 -76
- data/update.sh +1 -0
- data/venice_client.gemspec +1 -1
- metadata +46 -2
data/swagger.yaml
CHANGED
|
@@ -5,7 +5,7 @@ info:
|
|
|
5
5
|
description: The Venice.ai API.
|
|
6
6
|
termsOfService: https://venice.ai/legal/tos
|
|
7
7
|
title: Venice.ai API
|
|
8
|
-
version: "
|
|
8
|
+
version: "20251209.153516"
|
|
9
9
|
openapi: 3.0.0
|
|
10
10
|
security:
|
|
11
11
|
- BearerAuth: []
|
|
@@ -19,6 +19,8 @@ tags:
|
|
|
19
19
|
name: Models
|
|
20
20
|
- description: Generate and manipulate images using AI models.
|
|
21
21
|
name: Image
|
|
22
|
+
- description: Generate videos using AI models.
|
|
23
|
+
name: Video
|
|
22
24
|
- description: List and retrieve character information for use in completions.
|
|
23
25
|
name: Characters
|
|
24
26
|
components:
|
|
@@ -106,6 +108,26 @@ components:
|
|
|
106
108
|
oneOf:
|
|
107
109
|
- type: object
|
|
108
110
|
properties:
|
|
111
|
+
cache_control:
|
|
112
|
+
type: object
|
|
113
|
+
properties:
|
|
114
|
+
ttl:
|
|
115
|
+
type: string
|
|
116
|
+
description: Optional TTL for extended cache duration. Beta feature requiring
|
|
117
|
+
special header.
|
|
118
|
+
example: 1h
|
|
119
|
+
type:
|
|
120
|
+
type: string
|
|
121
|
+
enum:
|
|
122
|
+
- ephemeral
|
|
123
|
+
description: The type of cache control. Currently only "ephemeral" is supported.
|
|
124
|
+
example: ephemeral
|
|
125
|
+
required:
|
|
126
|
+
- type
|
|
127
|
+
description: Optional cache control for prompt caching on supported providers.
|
|
128
|
+
example:
|
|
129
|
+
type: ephemeral
|
|
130
|
+
title: Cache Control
|
|
109
131
|
text:
|
|
110
132
|
type: string
|
|
111
133
|
minLength: 1
|
|
@@ -122,13 +144,34 @@ components:
|
|
|
122
144
|
- text
|
|
123
145
|
- type
|
|
124
146
|
additionalProperties: false
|
|
125
|
-
description: Text message type.
|
|
147
|
+
description: Text message type. Supports optional cache_control for prompt
|
|
148
|
+
caching on supported providers.
|
|
126
149
|
example:
|
|
127
150
|
text: Why is the sky blue?
|
|
128
151
|
type: text
|
|
129
152
|
title: text
|
|
130
153
|
- type: object
|
|
131
154
|
properties:
|
|
155
|
+
cache_control:
|
|
156
|
+
type: object
|
|
157
|
+
properties:
|
|
158
|
+
ttl:
|
|
159
|
+
type: string
|
|
160
|
+
description: Optional TTL for extended cache duration. Beta feature requiring
|
|
161
|
+
special header.
|
|
162
|
+
example: 1h
|
|
163
|
+
type:
|
|
164
|
+
type: string
|
|
165
|
+
enum:
|
|
166
|
+
- ephemeral
|
|
167
|
+
description: The type of cache control. Currently only "ephemeral" is supported.
|
|
168
|
+
example: ephemeral
|
|
169
|
+
required:
|
|
170
|
+
- type
|
|
171
|
+
description: Optional cache control for prompt caching on supported providers.
|
|
172
|
+
example:
|
|
173
|
+
type: ephemeral
|
|
174
|
+
title: Cache Control
|
|
132
175
|
image_url:
|
|
133
176
|
type: object
|
|
134
177
|
properties:
|
|
@@ -151,7 +194,8 @@ components:
|
|
|
151
194
|
- image_url
|
|
152
195
|
- type
|
|
153
196
|
additionalProperties: false
|
|
154
|
-
description:
|
|
197
|
+
description: Image URL message type. Supports optional cache_control for prompt
|
|
198
|
+
caching on supported providers.
|
|
155
199
|
title: image_url
|
|
156
200
|
title: Objects
|
|
157
201
|
role:
|
|
@@ -174,6 +218,26 @@ components:
|
|
|
174
218
|
items:
|
|
175
219
|
type: object
|
|
176
220
|
properties:
|
|
221
|
+
cache_control:
|
|
222
|
+
type: object
|
|
223
|
+
properties:
|
|
224
|
+
ttl:
|
|
225
|
+
type: string
|
|
226
|
+
description: Optional TTL for extended cache duration. Beta feature requiring
|
|
227
|
+
special header.
|
|
228
|
+
example: 1h
|
|
229
|
+
type:
|
|
230
|
+
type: string
|
|
231
|
+
enum:
|
|
232
|
+
- ephemeral
|
|
233
|
+
description: The type of cache control. Currently only "ephemeral" is supported.
|
|
234
|
+
example: ephemeral
|
|
235
|
+
required:
|
|
236
|
+
- type
|
|
237
|
+
description: Optional cache control for prompt caching on supported providers.
|
|
238
|
+
example:
|
|
239
|
+
type: ephemeral
|
|
240
|
+
title: Cache Control
|
|
177
241
|
text:
|
|
178
242
|
type: string
|
|
179
243
|
minLength: 1
|
|
@@ -190,7 +254,8 @@ components:
|
|
|
190
254
|
- text
|
|
191
255
|
- type
|
|
192
256
|
additionalProperties: false
|
|
193
|
-
description: Text message type.
|
|
257
|
+
description: Text message type. Supports optional cache_control for prompt
|
|
258
|
+
caching on supported providers.
|
|
194
259
|
example:
|
|
195
260
|
text: Why is the sky blue?
|
|
196
261
|
type: text
|
|
@@ -255,6 +320,26 @@ components:
|
|
|
255
320
|
items:
|
|
256
321
|
type: object
|
|
257
322
|
properties:
|
|
323
|
+
cache_control:
|
|
324
|
+
type: object
|
|
325
|
+
properties:
|
|
326
|
+
ttl:
|
|
327
|
+
type: string
|
|
328
|
+
description: Optional TTL for extended cache duration. Beta feature requiring
|
|
329
|
+
special header.
|
|
330
|
+
example: 1h
|
|
331
|
+
type:
|
|
332
|
+
type: string
|
|
333
|
+
enum:
|
|
334
|
+
- ephemeral
|
|
335
|
+
description: The type of cache control. Currently only "ephemeral" is supported.
|
|
336
|
+
example: ephemeral
|
|
337
|
+
required:
|
|
338
|
+
- type
|
|
339
|
+
description: Optional cache control for prompt caching on supported providers.
|
|
340
|
+
example:
|
|
341
|
+
type: ephemeral
|
|
342
|
+
title: Cache Control
|
|
258
343
|
text:
|
|
259
344
|
type: string
|
|
260
345
|
minLength: 1
|
|
@@ -271,7 +356,8 @@ components:
|
|
|
271
356
|
- text
|
|
272
357
|
- type
|
|
273
358
|
additionalProperties: false
|
|
274
|
-
description: Text message type.
|
|
359
|
+
description: Text message type. Supports optional cache_control for prompt
|
|
360
|
+
caching on supported providers.
|
|
275
361
|
example:
|
|
276
362
|
text: Why is the sky blue?
|
|
277
363
|
type: text
|
|
@@ -317,7 +403,7 @@ components:
|
|
|
317
403
|
of models available to you. You can use feature suffixes to enable
|
|
318
404
|
features from the venice_parameters object. Please see "Model
|
|
319
405
|
Feature Suffix" documentation for more details.
|
|
320
|
-
example:
|
|
406
|
+
example: zai-org-glm-4.6
|
|
321
407
|
n:
|
|
322
408
|
type: integer
|
|
323
409
|
default: 1
|
|
@@ -333,12 +419,41 @@ components:
|
|
|
333
419
|
description: Number between -2.0 and 2.0. Positive values penalize new tokens
|
|
334
420
|
based on whether they appear in the text so far, increasing the
|
|
335
421
|
model's likelihood to talk about new topics.
|
|
422
|
+
prompt_cache_key:
|
|
423
|
+
type: string
|
|
424
|
+
description: When supplied, this field may be used to optimize conversation
|
|
425
|
+
routing to improve cache performance and thus reduce latency.
|
|
426
|
+
example: random-string
|
|
336
427
|
repetition_penalty:
|
|
337
428
|
type: number
|
|
338
429
|
minimum: 0
|
|
339
430
|
description: The parameter for repetition penalty. 1.0 means no penalty. Values
|
|
340
431
|
> 1.0 discourage repetition.
|
|
341
432
|
example: 1.2
|
|
433
|
+
reasoning:
|
|
434
|
+
type: object
|
|
435
|
+
properties:
|
|
436
|
+
effort:
|
|
437
|
+
type: string
|
|
438
|
+
enum:
|
|
439
|
+
- low
|
|
440
|
+
- medium
|
|
441
|
+
- high
|
|
442
|
+
description: Controls the reasoning effort level for supported models. Higher
|
|
443
|
+
effort means more thorough reasoning but increased token usage.
|
|
444
|
+
Defaults to the model configuration if not specified.
|
|
445
|
+
example: medium
|
|
446
|
+
description: Configuration for reasoning behavior on supported models.
|
|
447
|
+
reasoning_effort:
|
|
448
|
+
type: string
|
|
449
|
+
enum:
|
|
450
|
+
- low
|
|
451
|
+
- medium
|
|
452
|
+
- high
|
|
453
|
+
description: OpenAI-compatible parameter to control reasoning effort level for
|
|
454
|
+
supported models. Takes precedence over reasoning.effort if both are
|
|
455
|
+
provided.
|
|
456
|
+
example: medium
|
|
342
457
|
seed:
|
|
343
458
|
type: integer
|
|
344
459
|
minimum: 0
|
|
@@ -441,11 +556,18 @@ components:
|
|
|
441
556
|
first chunk of a streaming result, or in the non streaming
|
|
442
557
|
response.
|
|
443
558
|
example: off
|
|
559
|
+
enable_web_scraping:
|
|
560
|
+
type: boolean
|
|
561
|
+
default: false
|
|
562
|
+
description: Enable Venice web scraping of URLs in the latest user message using
|
|
563
|
+
Firecrawl. Off by default.
|
|
564
|
+
example: false
|
|
444
565
|
enable_web_citations:
|
|
445
566
|
type: boolean
|
|
446
567
|
default: false
|
|
447
568
|
description: When web search is enabled, this will request that the LLM cite its
|
|
448
|
-
sources using a
|
|
569
|
+
sources using a ^index^ or ^i,j^ superscript format (e.g., ^1^).
|
|
570
|
+
Defaults to false.
|
|
449
571
|
include_search_results_in_stream:
|
|
450
572
|
type: boolean
|
|
451
573
|
default: false
|
|
@@ -632,10 +754,10 @@ components:
|
|
|
632
754
|
model:
|
|
633
755
|
type: string
|
|
634
756
|
description: The model to use for image generation.
|
|
635
|
-
example:
|
|
757
|
+
example: z-image-turbo
|
|
636
758
|
negative_prompt:
|
|
637
759
|
type: string
|
|
638
|
-
maxLength:
|
|
760
|
+
maxLength: 7500
|
|
639
761
|
description: A description of what should not be in the image. Character limit
|
|
640
762
|
is model specific and is listed in the promptCharacterLimit
|
|
641
763
|
constraint in the model list endpoint.
|
|
@@ -643,7 +765,7 @@ components:
|
|
|
643
765
|
prompt:
|
|
644
766
|
type: string
|
|
645
767
|
minLength: 1
|
|
646
|
-
maxLength:
|
|
768
|
+
maxLength: 7500
|
|
647
769
|
description: The description for the image. Character limit is model specific
|
|
648
770
|
and is listed in the promptCharacterLimit setting in the model list
|
|
649
771
|
endpoint.
|
|
@@ -676,25 +798,33 @@ components:
|
|
|
676
798
|
example: 123456789
|
|
677
799
|
steps:
|
|
678
800
|
type: integer
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
description: "Number of inference steps. The following models have reduced max
|
|
684
|
-
steps from the global max: venice-sd35: 30 max steps, hidream: 50
|
|
685
|
-
max steps, flux.1-krea: 30 max steps, flux-dev: 30 max steps,
|
|
686
|
-
flux-dev-uncensored: 30 max steps, lustify-sdxl: 50 max steps,
|
|
687
|
-
lustify-v7: 25 max steps, pony-realism: 50 max steps, qwen-image: 8
|
|
688
|
-
max steps, stable-diffusion-3.5: 30 max steps, wai-Illustrious: 30
|
|
689
|
-
max steps. These constraints are exposed in the model list endpoint
|
|
690
|
-
for each model."
|
|
691
|
-
example: 20
|
|
801
|
+
default: 0
|
|
802
|
+
description: Number of inference steps. This model does not support steps - this
|
|
803
|
+
field is ignored.
|
|
804
|
+
example: 0
|
|
692
805
|
style_preset:
|
|
693
806
|
type: string
|
|
694
807
|
description: An image style to apply to the image. Visit
|
|
695
808
|
https://docs.venice.ai/api-reference/endpoint/image/styles for more
|
|
696
809
|
details.
|
|
697
810
|
example: 3D Model
|
|
811
|
+
aspect_ratio:
|
|
812
|
+
type: string
|
|
813
|
+
description: 'Aspect ratio (utilized by certain image models including Nano
|
|
814
|
+
Banana). Examples: "1:1", "16:9".'
|
|
815
|
+
example: 1:1
|
|
816
|
+
resolution:
|
|
817
|
+
type: string
|
|
818
|
+
description: 'Resolution (utilized by certain image models including Nano
|
|
819
|
+
Banana). Examples: "1024x1024", "512x512".'
|
|
820
|
+
example: 1024x1024
|
|
821
|
+
enable_web_search:
|
|
822
|
+
type: boolean
|
|
823
|
+
description: Enable web search for the image generation task. This will allow
|
|
824
|
+
the model to use the latest information from the web to generate the
|
|
825
|
+
image. Only supported by certain models. If web search is used,
|
|
826
|
+
additional credits are getting charged.
|
|
827
|
+
example: false
|
|
698
828
|
width:
|
|
699
829
|
type: integer
|
|
700
830
|
minimum: 0
|
|
@@ -729,7 +859,7 @@ components:
|
|
|
729
859
|
description: The model to use for image generation. Defaults to Venice's default
|
|
730
860
|
image model. If a non-existent model is specified (ie an OpenAI
|
|
731
861
|
model name), it will default to Venice's default image model.
|
|
732
|
-
example:
|
|
862
|
+
example: z-image-turbo
|
|
733
863
|
moderation:
|
|
734
864
|
type: string
|
|
735
865
|
nullable: true
|
|
@@ -1135,6 +1265,99 @@ components:
|
|
|
1135
1265
|
speed: 1
|
|
1136
1266
|
streaming: false
|
|
1137
1267
|
voice: af_sky
|
|
1268
|
+
QueueVideoRequest:
|
|
1269
|
+
type: object
|
|
1270
|
+
properties:
|
|
1271
|
+
model:
|
|
1272
|
+
type: string
|
|
1273
|
+
description: The model to use for image generation.
|
|
1274
|
+
example: wan-2.5-preview-image-to-video
|
|
1275
|
+
prompt:
|
|
1276
|
+
type: string
|
|
1277
|
+
minLength: 1
|
|
1278
|
+
maxLength: 2500
|
|
1279
|
+
description: The prompt to use for video generation. The maximum length is 2500
|
|
1280
|
+
characters.
|
|
1281
|
+
example: Commerce being conducted in the city of Venice, Italy.
|
|
1282
|
+
negative_prompt:
|
|
1283
|
+
type: string
|
|
1284
|
+
maxLength: 2500
|
|
1285
|
+
default: low resolution, error, worst quality, low quality, defects
|
|
1286
|
+
description: The negative prompt to use for video generation. The maximum length
|
|
1287
|
+
is 2500 characters.
|
|
1288
|
+
example: low resolution, error, worst quality, low quality, defects
|
|
1289
|
+
duration:
|
|
1290
|
+
type: string
|
|
1291
|
+
enum:
|
|
1292
|
+
- 5s
|
|
1293
|
+
- 10s
|
|
1294
|
+
description: The duration of the video to generate.
|
|
1295
|
+
example: 5s
|
|
1296
|
+
aspect_ratio:
|
|
1297
|
+
description: The aspect ratio of the video to generate.
|
|
1298
|
+
example: 16:9
|
|
1299
|
+
resolution:
|
|
1300
|
+
type: string
|
|
1301
|
+
enum:
|
|
1302
|
+
- 1080p
|
|
1303
|
+
- 720p
|
|
1304
|
+
- 480p
|
|
1305
|
+
default: 720p
|
|
1306
|
+
description: The resolution of the video to generate.
|
|
1307
|
+
example: 720p
|
|
1308
|
+
audio:
|
|
1309
|
+
description: For models which support audio generation and configuration,
|
|
1310
|
+
indicates if audio should be generated. Defaults to true.
|
|
1311
|
+
example: true
|
|
1312
|
+
image_url:
|
|
1313
|
+
type: string
|
|
1314
|
+
description: For image to video models, the reference image to use for video
|
|
1315
|
+
generation. Must be either a URL (starting with "http://" or
|
|
1316
|
+
"https://") or a data URL (starting with "data:").
|
|
1317
|
+
example: data:image/png;base64,iVBORw0K...
|
|
1318
|
+
required:
|
|
1319
|
+
- model
|
|
1320
|
+
- prompt
|
|
1321
|
+
- duration
|
|
1322
|
+
- image_url
|
|
1323
|
+
additionalProperties: false
|
|
1324
|
+
CompleteVideoRequest:
|
|
1325
|
+
type: object
|
|
1326
|
+
properties:
|
|
1327
|
+
model:
|
|
1328
|
+
type: string
|
|
1329
|
+
description: The ID of the model used for video generation.
|
|
1330
|
+
example: video-model-123
|
|
1331
|
+
queue_id:
|
|
1332
|
+
type: string
|
|
1333
|
+
description: The ID of the video generation request.
|
|
1334
|
+
example: 123e4567-e89b-12d3-a456-426614174000
|
|
1335
|
+
required:
|
|
1336
|
+
- model
|
|
1337
|
+
- queue_id
|
|
1338
|
+
additionalProperties: false
|
|
1339
|
+
RetrieveVideoRequest:
|
|
1340
|
+
type: object
|
|
1341
|
+
properties:
|
|
1342
|
+
model:
|
|
1343
|
+
type: string
|
|
1344
|
+
description: The ID of the model used for video generation.
|
|
1345
|
+
example: video-model-123
|
|
1346
|
+
queue_id:
|
|
1347
|
+
type: string
|
|
1348
|
+
description: The ID of the video generation request.
|
|
1349
|
+
example: 123e4567-e89b-12d3-a456-426614174000
|
|
1350
|
+
delete_media_on_completion:
|
|
1351
|
+
type: boolean
|
|
1352
|
+
default: false
|
|
1353
|
+
description: If true, the video media will be deleted from storage after the
|
|
1354
|
+
request is completed. If false, you can use the complete endpoint to
|
|
1355
|
+
remove the media once you have successfully downloaded the video.
|
|
1356
|
+
example: false
|
|
1357
|
+
required:
|
|
1358
|
+
- model
|
|
1359
|
+
- queue_id
|
|
1360
|
+
additionalProperties: false
|
|
1138
1361
|
BillingUsageRequest:
|
|
1139
1362
|
type: object
|
|
1140
1363
|
properties:
|
|
@@ -1326,6 +1549,15 @@ components:
|
|
|
1326
1549
|
type: boolean
|
|
1327
1550
|
description: Is this model in beta?
|
|
1328
1551
|
example: false
|
|
1552
|
+
privacy:
|
|
1553
|
+
type: string
|
|
1554
|
+
enum:
|
|
1555
|
+
- private
|
|
1556
|
+
- anonymized
|
|
1557
|
+
description: The privacy mode of the model. Private models have zero data
|
|
1558
|
+
retention. Anonymized models Venice can not guarantee privacy
|
|
1559
|
+
on, but requests are not affiliated with a user
|
|
1560
|
+
example: private
|
|
1329
1561
|
capabilities:
|
|
1330
1562
|
type: object
|
|
1331
1563
|
properties:
|
|
@@ -1336,9 +1568,12 @@ components:
|
|
|
1336
1568
|
quantization:
|
|
1337
1569
|
type: string
|
|
1338
1570
|
enum:
|
|
1571
|
+
- fp4
|
|
1339
1572
|
- fp8
|
|
1340
1573
|
- fp16
|
|
1341
1574
|
- bf16
|
|
1575
|
+
- int8
|
|
1576
|
+
- int4
|
|
1342
1577
|
- not-available
|
|
1343
1578
|
description: The quantization type of the running model.
|
|
1344
1579
|
example: fp8
|
|
@@ -1436,6 +1671,64 @@ components:
|
|
|
1436
1671
|
- top_p
|
|
1437
1672
|
description: Constraints that apply to text models.
|
|
1438
1673
|
title: Text Model Constraints
|
|
1674
|
+
- type: object
|
|
1675
|
+
properties:
|
|
1676
|
+
aspect_ratios:
|
|
1677
|
+
type: array
|
|
1678
|
+
items:
|
|
1679
|
+
type: string
|
|
1680
|
+
description: The aspect ratios supported by the model. Empty array means the
|
|
1681
|
+
model does not support a defined aspect ratio.
|
|
1682
|
+
example:
|
|
1683
|
+
- 16:9
|
|
1684
|
+
- 9:16
|
|
1685
|
+
resolutions:
|
|
1686
|
+
type: array
|
|
1687
|
+
items:
|
|
1688
|
+
type: string
|
|
1689
|
+
description: The resolutions supported by the model. Empty array means the model
|
|
1690
|
+
does not support a defined resolution.
|
|
1691
|
+
example:
|
|
1692
|
+
- 1080p
|
|
1693
|
+
- 720p
|
|
1694
|
+
- 480p
|
|
1695
|
+
durations:
|
|
1696
|
+
type: array
|
|
1697
|
+
items:
|
|
1698
|
+
type: string
|
|
1699
|
+
description: The durations supported by the model. Empty array means the model
|
|
1700
|
+
does not support a defined duration.
|
|
1701
|
+
example:
|
|
1702
|
+
- 5s
|
|
1703
|
+
- 10s
|
|
1704
|
+
- 15s
|
|
1705
|
+
- 20s
|
|
1706
|
+
- 30s
|
|
1707
|
+
model_type:
|
|
1708
|
+
type: string
|
|
1709
|
+
enum:
|
|
1710
|
+
- image-to-video
|
|
1711
|
+
- text-to-video
|
|
1712
|
+
- video
|
|
1713
|
+
description: The type of video model.
|
|
1714
|
+
example: image-to-video
|
|
1715
|
+
audio:
|
|
1716
|
+
type: boolean
|
|
1717
|
+
description: Does the model support audio generation?
|
|
1718
|
+
example: true
|
|
1719
|
+
audio_configurable:
|
|
1720
|
+
type: boolean
|
|
1721
|
+
description: Can audio be enabled or disabled for the video generation?
|
|
1722
|
+
example: true
|
|
1723
|
+
required:
|
|
1724
|
+
- aspect_ratios
|
|
1725
|
+
- resolutions
|
|
1726
|
+
- durations
|
|
1727
|
+
- model_type
|
|
1728
|
+
- audio
|
|
1729
|
+
- audio_configurable
|
|
1730
|
+
description: Constraints that apply to video models.
|
|
1731
|
+
title: Video Model Constraints
|
|
1439
1732
|
description: Constraints that apply to this model.
|
|
1440
1733
|
name:
|
|
1441
1734
|
type: string
|
|
@@ -1461,18 +1754,12 @@ components:
|
|
|
1461
1754
|
type: number
|
|
1462
1755
|
description: USD cost per million input tokens
|
|
1463
1756
|
example: 0.7
|
|
1464
|
-
vcu:
|
|
1465
|
-
type: number
|
|
1466
|
-
description: VCU cost per million input tokens (deprecated - use Diem instead)
|
|
1467
|
-
deprecated: true
|
|
1468
|
-
example: 7
|
|
1469
1757
|
diem:
|
|
1470
1758
|
type: number
|
|
1471
1759
|
description: Diem cost per million input tokens
|
|
1472
1760
|
example: 7
|
|
1473
1761
|
required:
|
|
1474
1762
|
- usd
|
|
1475
|
-
- vcu
|
|
1476
1763
|
- diem
|
|
1477
1764
|
output:
|
|
1478
1765
|
type: object
|
|
@@ -1481,18 +1768,12 @@ components:
|
|
|
1481
1768
|
type: number
|
|
1482
1769
|
description: USD cost per million output tokens
|
|
1483
1770
|
example: 2.8
|
|
1484
|
-
vcu:
|
|
1485
|
-
type: number
|
|
1486
|
-
description: VCU cost per million output tokens (deprecated - use Diem instead)
|
|
1487
|
-
deprecated: true
|
|
1488
|
-
example: 28
|
|
1489
1771
|
diem:
|
|
1490
1772
|
type: number
|
|
1491
1773
|
description: Diem cost per million output tokens
|
|
1492
1774
|
example: 28
|
|
1493
1775
|
required:
|
|
1494
1776
|
- usd
|
|
1495
|
-
- vcu
|
|
1496
1777
|
- diem
|
|
1497
1778
|
required:
|
|
1498
1779
|
- input
|
|
@@ -1508,18 +1789,12 @@ components:
|
|
|
1508
1789
|
type: number
|
|
1509
1790
|
description: USD cost per image generation
|
|
1510
1791
|
example: 0.01
|
|
1511
|
-
vcu:
|
|
1512
|
-
type: number
|
|
1513
|
-
description: VCU cost per image generation (deprecated - use Diem instead)
|
|
1514
|
-
deprecated: true
|
|
1515
|
-
example: 0.1
|
|
1516
1792
|
diem:
|
|
1517
1793
|
type: number
|
|
1518
1794
|
description: Diem cost per image generation
|
|
1519
1795
|
example: 0.1
|
|
1520
1796
|
required:
|
|
1521
1797
|
- usd
|
|
1522
|
-
- vcu
|
|
1523
1798
|
- diem
|
|
1524
1799
|
upscale:
|
|
1525
1800
|
type: object
|
|
@@ -1531,18 +1806,12 @@ components:
|
|
|
1531
1806
|
type: number
|
|
1532
1807
|
description: USD cost for 2x upscale
|
|
1533
1808
|
example: 0.02
|
|
1534
|
-
vcu:
|
|
1535
|
-
type: number
|
|
1536
|
-
description: VCU cost for 2x upscale (deprecated - use Diem instead)
|
|
1537
|
-
deprecated: true
|
|
1538
|
-
example: 0.2
|
|
1539
1809
|
diem:
|
|
1540
1810
|
type: number
|
|
1541
1811
|
description: Diem cost for 2x upscale
|
|
1542
1812
|
example: 0.2
|
|
1543
1813
|
required:
|
|
1544
1814
|
- usd
|
|
1545
|
-
- vcu
|
|
1546
1815
|
- diem
|
|
1547
1816
|
4x:
|
|
1548
1817
|
type: object
|
|
@@ -1551,18 +1820,12 @@ components:
|
|
|
1551
1820
|
type: number
|
|
1552
1821
|
description: USD cost for 4x upscale
|
|
1553
1822
|
example: 0.08
|
|
1554
|
-
vcu:
|
|
1555
|
-
type: number
|
|
1556
|
-
description: VCU cost for 4x upscale (deprecated - use Diem instead)
|
|
1557
|
-
deprecated: true
|
|
1558
|
-
example: 0.8
|
|
1559
1823
|
diem:
|
|
1560
1824
|
type: number
|
|
1561
1825
|
description: Diem cost for 4x upscale
|
|
1562
1826
|
example: 0.8
|
|
1563
1827
|
required:
|
|
1564
1828
|
- usd
|
|
1565
|
-
- vcu
|
|
1566
1829
|
- diem
|
|
1567
1830
|
required:
|
|
1568
1831
|
- 2x
|
|
@@ -1581,19 +1844,12 @@ components:
|
|
|
1581
1844
|
type: number
|
|
1582
1845
|
description: USD cost per million input characters
|
|
1583
1846
|
example: 3.5
|
|
1584
|
-
vcu:
|
|
1585
|
-
type: number
|
|
1586
|
-
description: VCU cost per million input characters (deprecated - use Diem
|
|
1587
|
-
instead)
|
|
1588
|
-
deprecated: true
|
|
1589
|
-
example: 35
|
|
1590
1847
|
diem:
|
|
1591
1848
|
type: number
|
|
1592
1849
|
description: Diem cost per million input characters
|
|
1593
1850
|
example: 35
|
|
1594
1851
|
required:
|
|
1595
1852
|
- usd
|
|
1596
|
-
- vcu
|
|
1597
1853
|
- diem
|
|
1598
1854
|
required:
|
|
1599
1855
|
- input
|
|
@@ -1636,12 +1892,14 @@ components:
|
|
|
1636
1892
|
type:
|
|
1637
1893
|
type: string
|
|
1638
1894
|
enum:
|
|
1895
|
+
- asr
|
|
1639
1896
|
- embedding
|
|
1640
1897
|
- image
|
|
1641
1898
|
- text
|
|
1642
1899
|
- tts
|
|
1643
1900
|
- upscale
|
|
1644
1901
|
- inpaint
|
|
1902
|
+
- video
|
|
1645
1903
|
description: Model type
|
|
1646
1904
|
example: text
|
|
1647
1905
|
required:
|
|
@@ -1676,11 +1934,9 @@ components:
|
|
|
1676
1934
|
pricing:
|
|
1677
1935
|
input:
|
|
1678
1936
|
usd: 0.15
|
|
1679
|
-
vcu: 1.5
|
|
1680
1937
|
diem: 0.15
|
|
1681
1938
|
output:
|
|
1682
1939
|
usd: 0.6
|
|
1683
|
-
vcu: 6
|
|
1684
1940
|
diem: 0.6
|
|
1685
1941
|
traits:
|
|
1686
1942
|
- fastest
|
|
@@ -1814,6 +2070,26 @@ paths:
|
|
|
1814
2070
|
items:
|
|
1815
2071
|
type: object
|
|
1816
2072
|
properties:
|
|
2073
|
+
cache_control:
|
|
2074
|
+
type: object
|
|
2075
|
+
properties:
|
|
2076
|
+
ttl:
|
|
2077
|
+
type: string
|
|
2078
|
+
description: Optional TTL for extended cache duration. Beta feature requiring
|
|
2079
|
+
special header.
|
|
2080
|
+
example: 1h
|
|
2081
|
+
type:
|
|
2082
|
+
type: string
|
|
2083
|
+
enum:
|
|
2084
|
+
- ephemeral
|
|
2085
|
+
description: The type of cache control. Currently only "ephemeral" is supported.
|
|
2086
|
+
example: ephemeral
|
|
2087
|
+
required:
|
|
2088
|
+
- type
|
|
2089
|
+
description: Optional cache control for prompt caching on supported providers.
|
|
2090
|
+
example:
|
|
2091
|
+
type: ephemeral
|
|
2092
|
+
title: Cache Control
|
|
1817
2093
|
text:
|
|
1818
2094
|
type: string
|
|
1819
2095
|
minLength: 1
|
|
@@ -1830,7 +2106,8 @@ paths:
|
|
|
1830
2106
|
- text
|
|
1831
2107
|
- type
|
|
1832
2108
|
additionalProperties: false
|
|
1833
|
-
description: Text message type.
|
|
2109
|
+
description: Text message type. Supports optional cache_control for prompt
|
|
2110
|
+
caching on supported providers.
|
|
1834
2111
|
example:
|
|
1835
2112
|
text: Why is the sky blue?
|
|
1836
2113
|
type: text
|
|
@@ -1935,7 +2212,7 @@ paths:
|
|
|
1935
2212
|
model:
|
|
1936
2213
|
type: string
|
|
1937
2214
|
description: The model id used for the request.
|
|
1938
|
-
example:
|
|
2215
|
+
example: zai-org-glm-4.6
|
|
1939
2216
|
object:
|
|
1940
2217
|
type: string
|
|
1941
2218
|
enum:
|
|
@@ -1992,6 +2269,10 @@ paths:
|
|
|
1992
2269
|
type: boolean
|
|
1993
2270
|
description: Did the request enable web citations?
|
|
1994
2271
|
example: true
|
|
2272
|
+
enable_web_scraping:
|
|
2273
|
+
type: boolean
|
|
2274
|
+
description: Did the request enable web scraping of URLs via Firecrawl?
|
|
2275
|
+
example: false
|
|
1995
2276
|
include_venice_system_prompt:
|
|
1996
2277
|
type: boolean
|
|
1997
2278
|
description: Did the request include the Venice system prompt?
|
|
@@ -2098,6 +2379,7 @@ paths:
|
|
|
2098
2379
|
required:
|
|
2099
2380
|
- enable_web_search
|
|
2100
2381
|
- enable_web_citations
|
|
2382
|
+
- enable_web_scraping
|
|
2101
2383
|
- include_venice_system_prompt
|
|
2102
2384
|
- include_search_results_in_stream
|
|
2103
2385
|
- return_search_results_as_documents
|
|
@@ -2151,6 +2433,7 @@ paths:
|
|
|
2151
2433
|
return_search_results_as_documents: false
|
|
2152
2434
|
web_search_citations: []
|
|
2153
2435
|
enable_web_search: auto
|
|
2436
|
+
enable_web_scraping: false
|
|
2154
2437
|
enable_web_citations: true
|
|
2155
2438
|
strip_thinking_response: true
|
|
2156
2439
|
disable_thinking: true
|
|
@@ -2700,12 +2983,14 @@ paths:
|
|
|
2700
2983
|
anyOf:
|
|
2701
2984
|
- type: string
|
|
2702
2985
|
enum:
|
|
2986
|
+
- asr
|
|
2703
2987
|
- embedding
|
|
2704
2988
|
- image
|
|
2705
2989
|
- text
|
|
2706
2990
|
- tts
|
|
2707
2991
|
- upscale
|
|
2708
2992
|
- inpaint
|
|
2993
|
+
- video
|
|
2709
2994
|
- type: string
|
|
2710
2995
|
enum:
|
|
2711
2996
|
- all
|
|
@@ -2736,12 +3021,14 @@ paths:
|
|
|
2736
3021
|
anyOf:
|
|
2737
3022
|
- type: string
|
|
2738
3023
|
enum:
|
|
3024
|
+
- asr
|
|
2739
3025
|
- embedding
|
|
2740
3026
|
- image
|
|
2741
3027
|
- text
|
|
2742
3028
|
- tts
|
|
2743
3029
|
- upscale
|
|
2744
3030
|
- inpaint
|
|
3031
|
+
- video
|
|
2745
3032
|
- type: string
|
|
2746
3033
|
enum:
|
|
2747
3034
|
- all
|
|
@@ -2772,12 +3059,14 @@ paths:
|
|
|
2772
3059
|
- schema:
|
|
2773
3060
|
type: string
|
|
2774
3061
|
enum:
|
|
3062
|
+
- asr
|
|
2775
3063
|
- embedding
|
|
2776
3064
|
- image
|
|
2777
3065
|
- text
|
|
2778
3066
|
- tts
|
|
2779
3067
|
- upscale
|
|
2780
3068
|
- inpaint
|
|
3069
|
+
- video
|
|
2781
3070
|
default: text
|
|
2782
3071
|
description: Filter models by type.
|
|
2783
3072
|
example: text
|
|
@@ -2802,12 +3091,14 @@ paths:
|
|
|
2802
3091
|
anyOf:
|
|
2803
3092
|
- type: string
|
|
2804
3093
|
enum:
|
|
3094
|
+
- asr
|
|
2805
3095
|
- embedding
|
|
2806
3096
|
- image
|
|
2807
3097
|
- text
|
|
2808
3098
|
- tts
|
|
2809
3099
|
- upscale
|
|
2810
3100
|
- inpaint
|
|
3101
|
+
- video
|
|
2811
3102
|
- type: string
|
|
2812
3103
|
enum:
|
|
2813
3104
|
- all
|
|
@@ -2844,12 +3135,14 @@ paths:
|
|
|
2844
3135
|
- schema:
|
|
2845
3136
|
type: string
|
|
2846
3137
|
enum:
|
|
3138
|
+
- asr
|
|
2847
3139
|
- embedding
|
|
2848
3140
|
- image
|
|
2849
3141
|
- text
|
|
2850
3142
|
- tts
|
|
2851
3143
|
- upscale
|
|
2852
3144
|
- inpaint
|
|
3145
|
+
- video
|
|
2853
3146
|
default: text
|
|
2854
3147
|
description: Filter models by type.
|
|
2855
3148
|
example: text
|
|
@@ -2874,12 +3167,14 @@ paths:
|
|
|
2874
3167
|
anyOf:
|
|
2875
3168
|
- type: string
|
|
2876
3169
|
enum:
|
|
3170
|
+
- asr
|
|
2877
3171
|
- embedding
|
|
2878
3172
|
- image
|
|
2879
3173
|
- text
|
|
2880
3174
|
- tts
|
|
2881
3175
|
- upscale
|
|
2882
3176
|
- inpaint
|
|
3177
|
+
- video
|
|
2883
3178
|
- type: string
|
|
2884
3179
|
enum:
|
|
2885
3180
|
- all
|
|
@@ -3470,10 +3765,6 @@ paths:
|
|
|
3470
3765
|
schema:
|
|
3471
3766
|
type: object
|
|
3472
3767
|
properties:
|
|
3473
|
-
warningMessage:
|
|
3474
|
-
type: string
|
|
3475
|
-
description: A warning message to disambiguate staked DIEM balance from legacy
|
|
3476
|
-
DIEM (formerly VCU) balance
|
|
3477
3768
|
data:
|
|
3478
3769
|
type: object
|
|
3479
3770
|
properties:
|
|
@@ -3502,11 +3793,6 @@ paths:
|
|
|
3502
3793
|
type: number
|
|
3503
3794
|
description: The USD balance of the key.
|
|
3504
3795
|
example: 50.23
|
|
3505
|
-
VCU:
|
|
3506
|
-
type: number
|
|
3507
|
-
description: The VCU balance of the key. VCU is being deprecated in favor of
|
|
3508
|
-
Diem.
|
|
3509
|
-
example: 100.023
|
|
3510
3796
|
DIEM:
|
|
3511
3797
|
type: number
|
|
3512
3798
|
description: The Diem balance of the key.
|
|
@@ -3529,7 +3815,7 @@ paths:
|
|
|
3529
3815
|
apiModelId:
|
|
3530
3816
|
type: string
|
|
3531
3817
|
description: The ID of the API model.
|
|
3532
|
-
example:
|
|
3818
|
+
example: zai-org-glm-4.6
|
|
3533
3819
|
rateLimits:
|
|
3534
3820
|
type: array
|
|
3535
3821
|
items:
|
|
@@ -3596,7 +3882,7 @@ paths:
|
|
|
3596
3882
|
description: The ID of the API key that exceeded the limit.
|
|
3597
3883
|
modelId:
|
|
3598
3884
|
type: string
|
|
3599
|
-
default:
|
|
3885
|
+
default: zai-org-glm-4.6
|
|
3600
3886
|
description: The ID of the model that was used when the rate limit was exceeded.
|
|
3601
3887
|
rateLimitTier:
|
|
3602
3888
|
type: string
|
|
@@ -4337,6 +4623,231 @@ paths:
|
|
|
4337
4623
|
application/json:
|
|
4338
4624
|
schema:
|
|
4339
4625
|
$ref: "#/components/schemas/StandardError"
|
|
4626
|
+
/video/complete:
|
|
4627
|
+
post:
|
|
4628
|
+
description: Delete a video generation request from storage after it has been
|
|
4629
|
+
successfully downloaded. Videos can be automatically deleted after
|
|
4630
|
+
retrieval by setting the `delete_media_on_completion` flag to true when
|
|
4631
|
+
calling the retrieve API.
|
|
4632
|
+
operationId: completeVideo
|
|
4633
|
+
summary: /api/v1/video/complete
|
|
4634
|
+
tags:
|
|
4635
|
+
- Video
|
|
4636
|
+
requestBody:
|
|
4637
|
+
content:
|
|
4638
|
+
application/json:
|
|
4639
|
+
schema:
|
|
4640
|
+
$ref: "#/components/schemas/CompleteVideoRequest"
|
|
4641
|
+
responses:
|
|
4642
|
+
"200":
|
|
4643
|
+
description: Video generation request completed successfully
|
|
4644
|
+
content:
|
|
4645
|
+
application/json:
|
|
4646
|
+
schema:
|
|
4647
|
+
type: object
|
|
4648
|
+
properties:
|
|
4649
|
+
success:
|
|
4650
|
+
type: boolean
|
|
4651
|
+
description: Indicates whether the video cleanup was successful.
|
|
4652
|
+
example: true
|
|
4653
|
+
required:
|
|
4654
|
+
- success
|
|
4655
|
+
"400":
|
|
4656
|
+
description: Invalid request parameters
|
|
4657
|
+
content:
|
|
4658
|
+
application/json:
|
|
4659
|
+
schema:
|
|
4660
|
+
$ref: "#/components/schemas/DetailedError"
|
|
4661
|
+
"401":
|
|
4662
|
+
description: Authentication failed
|
|
4663
|
+
content:
|
|
4664
|
+
application/json:
|
|
4665
|
+
schema:
|
|
4666
|
+
$ref: "#/components/schemas/StandardError"
|
|
4667
|
+
"500":
|
|
4668
|
+
description: Inference processing failed
|
|
4669
|
+
content:
|
|
4670
|
+
application/json:
|
|
4671
|
+
schema:
|
|
4672
|
+
$ref: "#/components/schemas/StandardError"
|
|
4673
|
+
/video/queue:
|
|
4674
|
+
post:
|
|
4675
|
+
description: Queue a new video generation request.
|
|
4676
|
+
operationId: queueVideo
|
|
4677
|
+
summary: /api/v1/video/queue
|
|
4678
|
+
tags:
|
|
4679
|
+
- Video
|
|
4680
|
+
requestBody:
|
|
4681
|
+
content:
|
|
4682
|
+
application/json:
|
|
4683
|
+
schema:
|
|
4684
|
+
$ref: "#/components/schemas/QueueVideoRequest"
|
|
4685
|
+
responses:
|
|
4686
|
+
"200":
|
|
4687
|
+
description: Video generation request queued successfully
|
|
4688
|
+
content:
|
|
4689
|
+
application/json:
|
|
4690
|
+
schema:
|
|
4691
|
+
type: object
|
|
4692
|
+
properties:
|
|
4693
|
+
model:
|
|
4694
|
+
type: string
|
|
4695
|
+
description: The ID of the model used for video generation.
|
|
4696
|
+
example: video-model-123
|
|
4697
|
+
queue_id:
|
|
4698
|
+
type: string
|
|
4699
|
+
description: The ID of the video generation request.
|
|
4700
|
+
example: 123e4567-e89b-12d3-a456-426614174000
|
|
4701
|
+
required:
|
|
4702
|
+
- model
|
|
4703
|
+
- queue_id
|
|
4704
|
+
additionalProperties: false
|
|
4705
|
+
"400":
|
|
4706
|
+
description: Invalid request parameters
|
|
4707
|
+
content:
|
|
4708
|
+
application/json:
|
|
4709
|
+
schema:
|
|
4710
|
+
$ref: "#/components/schemas/DetailedError"
|
|
4711
|
+
"401":
|
|
4712
|
+
description: Authentication failed
|
|
4713
|
+
content:
|
|
4714
|
+
application/json:
|
|
4715
|
+
schema:
|
|
4716
|
+
$ref: "#/components/schemas/StandardError"
|
|
4717
|
+
"402":
|
|
4718
|
+
description: Insufficient USD or Diem balance to complete request
|
|
4719
|
+
content:
|
|
4720
|
+
application/json:
|
|
4721
|
+
schema:
|
|
4722
|
+
$ref: "#/components/schemas/StandardError"
|
|
4723
|
+
"413":
|
|
4724
|
+
description: The request payload is too large. Please reduce the size of your
|
|
4725
|
+
request.
|
|
4726
|
+
content:
|
|
4727
|
+
application/json:
|
|
4728
|
+
schema:
|
|
4729
|
+
$ref: "#/components/schemas/StandardError"
|
|
4730
|
+
"422":
|
|
4731
|
+
description: Your prompt violates the content policy of Venice.ai or the model
|
|
4732
|
+
provider
|
|
4733
|
+
content:
|
|
4734
|
+
application/json:
|
|
4735
|
+
schema:
|
|
4736
|
+
$ref: "#/components/schemas/StandardError"
|
|
4737
|
+
"500":
|
|
4738
|
+
description: Inference processing failed
|
|
4739
|
+
content:
|
|
4740
|
+
application/json:
|
|
4741
|
+
schema:
|
|
4742
|
+
$ref: "#/components/schemas/StandardError"
|
|
4743
|
+
/video/quote:
|
|
4744
|
+
post:
|
|
4745
|
+
description: Quote a video generation request. Utilizes the same parameters as
|
|
4746
|
+
the queue API and will return the price in USD for the request.
|
|
4747
|
+
operationId: quoteVideo
|
|
4748
|
+
summary: /api/v1/video/quote
|
|
4749
|
+
tags:
|
|
4750
|
+
- Video
|
|
4751
|
+
requestBody:
|
|
4752
|
+
content:
|
|
4753
|
+
application/json:
|
|
4754
|
+
schema:
|
|
4755
|
+
$ref: "#/components/schemas/QueueVideoRequest"
|
|
4756
|
+
responses:
|
|
4757
|
+
"200":
|
|
4758
|
+
description: Video generation price quote
|
|
4759
|
+
content:
|
|
4760
|
+
application/json:
|
|
4761
|
+
schema:
|
|
4762
|
+
type: object
|
|
4763
|
+
properties:
|
|
4764
|
+
quote:
|
|
4765
|
+
type: number
|
|
4766
|
+
required:
|
|
4767
|
+
- quote
|
|
4768
|
+
"400":
|
|
4769
|
+
description: Invalid request parameters
|
|
4770
|
+
content:
|
|
4771
|
+
application/json:
|
|
4772
|
+
schema:
|
|
4773
|
+
$ref: "#/components/schemas/DetailedError"
|
|
4774
|
+
/video/retrieve:
|
|
4775
|
+
post:
|
|
4776
|
+
description: Retrieve a video generation result. Returns the video file if
|
|
4777
|
+
completed, or a status if the request is still processing.
|
|
4778
|
+
operationId: retrieveVideo
|
|
4779
|
+
summary: /api/v1/video/retrieve
|
|
4780
|
+
tags:
|
|
4781
|
+
- Video
|
|
4782
|
+
requestBody:
|
|
4783
|
+
content:
|
|
4784
|
+
application/json:
|
|
4785
|
+
schema:
|
|
4786
|
+
$ref: "#/components/schemas/RetrieveVideoRequest"
|
|
4787
|
+
responses:
|
|
4788
|
+
"200":
|
|
4789
|
+
description: Video file if completed, or processing status if still in progress
|
|
4790
|
+
content:
|
|
4791
|
+
application/json:
|
|
4792
|
+
schema:
|
|
4793
|
+
type: object
|
|
4794
|
+
properties:
|
|
4795
|
+
status:
|
|
4796
|
+
type: string
|
|
4797
|
+
enum:
|
|
4798
|
+
- PROCESSING
|
|
4799
|
+
description: The status of the video generation request.
|
|
4800
|
+
example: PROCESSING
|
|
4801
|
+
average_execution_time:
|
|
4802
|
+
type: number
|
|
4803
|
+
description: The average execution time of the video generation request in
|
|
4804
|
+
milliseconds.
|
|
4805
|
+
example: 145000
|
|
4806
|
+
execution_duration:
|
|
4807
|
+
type: number
|
|
4808
|
+
description: The current duration of the video generation request in
|
|
4809
|
+
milliseconds.
|
|
4810
|
+
example: 53200
|
|
4811
|
+
required:
|
|
4812
|
+
- status
|
|
4813
|
+
- average_execution_time
|
|
4814
|
+
- execution_duration
|
|
4815
|
+
video/mp4:
|
|
4816
|
+
schema:
|
|
4817
|
+
format: binary
|
|
4818
|
+
type: string
|
|
4819
|
+
"400":
|
|
4820
|
+
description: Invalid request parameters
|
|
4821
|
+
content:
|
|
4822
|
+
application/json:
|
|
4823
|
+
schema:
|
|
4824
|
+
$ref: "#/components/schemas/DetailedError"
|
|
4825
|
+
"401":
|
|
4826
|
+
description: Authentication failed
|
|
4827
|
+
content:
|
|
4828
|
+
application/json:
|
|
4829
|
+
schema:
|
|
4830
|
+
$ref: "#/components/schemas/StandardError"
|
|
4831
|
+
"404":
|
|
4832
|
+
description: Media could not be found. Request may may be invalid, expired, or
|
|
4833
|
+
deleted.
|
|
4834
|
+
content:
|
|
4835
|
+
application/json:
|
|
4836
|
+
schema:
|
|
4837
|
+
$ref: "#/components/schemas/StandardError"
|
|
4838
|
+
"422":
|
|
4839
|
+
description: Your prompt violates the content policy of Venice.ai or the model
|
|
4840
|
+
provider
|
|
4841
|
+
content:
|
|
4842
|
+
application/json:
|
|
4843
|
+
schema:
|
|
4844
|
+
$ref: "#/components/schemas/StandardError"
|
|
4845
|
+
"500":
|
|
4846
|
+
description: Inference processing failed
|
|
4847
|
+
content:
|
|
4848
|
+
application/json:
|
|
4849
|
+
schema:
|
|
4850
|
+
$ref: "#/components/schemas/StandardError"
|
|
4340
4851
|
/billing/usage:
|
|
4341
4852
|
get:
|
|
4342
4853
|
description: "Get paginated billing usage data for the authenticated user. NOTE:
|