venice_client 1.0.0

data/docs/BillingUsageResponseInferenceDetails.md

@@ -0,0 +1,10 @@
+# VeniceClient::BillingUsageResponseInferenceDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**completion_tokens** | [**BigDecimal**](BigDecimal.md) | Number of tokens used in the completion. Only present for LLM usage. | 
+**inference_execution_time** | [**BigDecimal**](BigDecimal.md) | Time taken for inference execution in milliseconds | 
+**prompt_tokens** | [**BigDecimal**](BigDecimal.md) | Number of tokens requested in the prompt. Only present for LLM usage. | 
+**request_id** | **String** | Unique identifier for the inference request | 
+

data/docs/BillingUsageResponsePagination.md

@@ -0,0 +1,10 @@
+# VeniceClient::BillingUsageResponsePagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | [**BigDecimal**](BigDecimal.md) |  | 
+**page** | [**BigDecimal**](BigDecimal.md) |  | 
+**total** | [**BigDecimal**](BigDecimal.md) |  | 
+**total_pages** | [**BigDecimal**](BigDecimal.md) |  | 
+

data/docs/CharactersApi.md

@@ -0,0 +1,52 @@
+# VeniceClient::CharactersApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_characters**](CharactersApi.md#list_characters) | **GET** /characters | /api/v1/characters
+
+# **list_characters**
+> InlineResponse20013 list_characters
+
+/api/v1/characters
+
+This is a preview API and may change. Returns a list of characters supported in the API.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::CharactersApi.new
+
+begin
+  #/api/v1/characters
+  result = api_instance.list_characters
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling CharactersApi->list_characters: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse20013**](InlineResponse20013.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ChatApi.md

@@ -0,0 +1,60 @@
+# VeniceClient::ChatApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_chat_completion**](ChatApi.md#create_chat_completion) | **POST** /chat/completions | /api/v1/chat/completions
+
+# **create_chat_completion**
+> InlineResponse200 create_chat_completion(opts)
+
+/api/v1/chat/completions
+
+Run text inference based on the supplied parameters.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ChatApi.new
+opts = { 
+  body: VeniceClient::ChatCompletionRequest.new # ChatCompletionRequest | 
+  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br). Only applied when stream is false.
+}
+
+begin
+  #/api/v1/chat/completions
+  result = api_instance.create_chat_completion(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ChatApi->create_chat_completion: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ChatCompletionRequest**](ChatCompletionRequest.md)|  | [optional] 
+ **accept_encoding** | **String**| Supported compression encodings (gzip, br). Only applied when stream is false. | [optional] 
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/ChatCompletionRequest.md

@@ -0,0 +1,32 @@
+# VeniceClient::ChatCompletionRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**frequency_penalty** | [**BigDecimal**](BigDecimal.md) | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | [optional] [default to 0]
+**logprobs** | **BOOLEAN** | Whether to include log probabilities in the response. This is not supported by all models. | [optional] 
+**max_completion_tokens** | **Integer** | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. | [optional] 
+**max_temp** | [**BigDecimal**](BigDecimal.md) | Maximum temperature value for dynamic temperature scaling. | [optional] 
+**max_tokens** | **Integer** | The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. This value is now deprecated in favor of max_completion_tokens. | [optional] 
+**messages** | [**Array<AnyOfChatCompletionRequestMessagesItems>**](.md) | A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text and images. For compatibility purposes, the schema supports submitting multiple image_url messages, however, only the last image_url message will be passed to and processed by the model. | 
+**min_p** | [**BigDecimal**](BigDecimal.md) | Sets a minimum probability threshold for token selection. Tokens with probabilities below this value are filtered out. | [optional] 
+**min_temp** | [**BigDecimal**](BigDecimal.md) | Minimum temperature value for dynamic temperature scaling. | [optional] 
+**model** | **String** | The ID of the model you wish to prompt. May also be a model trait, or a compatibility mapping. See the models endpoint for a list of models available to you.  You can use feature suffixes to enable features from the venice_parameters object. Please see \"Model Feature Suffix\" documentation for more details. | 
+**n** | **Integer** | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. | [optional] [default to 1]
+**presence_penalty** | [**BigDecimal**](BigDecimal.md) | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. | [optional] [default to 0]
+**repetition_penalty** | [**BigDecimal**](BigDecimal.md) | The parameter for repetition penalty. 1.0 means no penalty. Values > 1.0 discourage repetition. | [optional] 
+**seed** | **Integer** | The random seed used to generate the response. This is useful for reproducibility. | [optional] 
+**stop** | [**AnyOfChatCompletionRequestStop**](AnyOfChatCompletionRequestStop.md) | Up to 4 sequences where the API will stop generating further tokens. Defaults to null. | [optional] 
+**stop_token_ids** | [**Array<BigDecimal>**](BigDecimal.md) | Array of token IDs where the API will stop generating further tokens. | [optional] 
+**stream** | **BOOLEAN** | Whether to stream back partial progress. Defaults to false. | [optional] 
+**stream_options** | [**ChatCompletionRequestStreamOptions**](ChatCompletionRequestStreamOptions.md) |  | [optional] 
+**temperature** | [**BigDecimal**](BigDecimal.md) | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. | [optional] [default to 0.3]
+**top_k** | **Integer** | The number of highest probability vocabulary tokens to keep for top-k-filtering. | [optional] 
+**top_p** | [**BigDecimal**](BigDecimal.md) | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. | [optional] [default to 1]
+**user** | **String** | This field is discarded on the request but is supported in the Venice API for compatibility with OpenAPI clients. | [optional] 
+**venice_parameters** | [**ChatCompletionRequestVeniceParameters**](ChatCompletionRequestVeniceParameters.md) |  | [optional] 
+**parallel_tool_calls** | **BOOLEAN** | Whether to enable parallel function calling during tool use. | [optional] [default to true]
+**response_format** | [**OneOfChatCompletionRequestResponseFormat**](OneOfChatCompletionRequestResponseFormat.md) | Format in which the response should be returned. | [optional] 
+**tool_choice** | [**AnyOfChatCompletionRequestToolChoice**](AnyOfChatCompletionRequestToolChoice.md) |  | [optional] 
+**tools** | [**Array<ToolCall>**](ToolCall.md) | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | [optional] 
+

data/docs/ChatCompletionRequestFunction.md

@@ -0,0 +1,9 @@
+# VeniceClient::ChatCompletionRequestFunction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** |  | [optional] 
+**name** | **String** |  | 
+**parameters** | [**Hash<String, null>**](.md) |  | [optional] 
+

data/docs/ChatCompletionRequestStreamOptions.md

@@ -0,0 +1,7 @@
+# VeniceClient::ChatCompletionRequestStreamOptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**include_usage** | **BOOLEAN** | Whether to include usage information in the stream. | [optional] 
+

data/docs/ChatCompletionRequestVeniceParameters.md

@@ -0,0 +1,12 @@
+# VeniceClient::ChatCompletionRequestVeniceParameters
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**character_slug** | **String** | The character slug of a public Venice character. | [optional] 
+**strip_thinking_response** | **BOOLEAN** | Strip <think></think> blocks from the response. Applicable only to reasoning / thinking models. Also available to use as a model feature suffix. Defaults to false. | [optional] [default to false]
+**disable_thinking** | **BOOLEAN** | On supported reasoning models, will disable thinking and strip the <think></think> blocks from the response. Defaults to false. | [optional] [default to false]
+**enable_web_search** | **String** | Enable web search for this request. Defaults to off. On will force web search on the request. Auto will enable it based on the model's discretion. Citations will be returned either in the first chunk of a streaming result, or in the non streaming response. | [optional] [default to 'false']
+**enable_web_citations** | **BOOLEAN** | When web search is enabled, this will request that the LLM cite its sources using a [REF]0[/REF] format. Defaults to false. | [optional] [default to false]
+**include_venice_system_prompt** | **BOOLEAN** | Whether to include the Venice supplied system prompts along side specified system prompts. Defaults to true. | [optional] [default to true]
+

data/docs/CreateEmbeddingRequestSchema.md

@@ -0,0 +1,11 @@
+# VeniceClient::CreateEmbeddingRequestSchema
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dimensions** | **Integer** | The number of dimensions the resulting output embeddings should have. | [optional] 
+**encoding_format** | **String** | The format to return the embeddings in. Can be either `float` or `base64`. | [optional] [default to 'float']
+**input** | [**AnyOfCreateEmbeddingRequestSchemaInput**](AnyOfCreateEmbeddingRequestSchemaInput.md) | Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens), cannot be an empty string, and any array must be 2048 dimensions or less. | 
+**model** | [**AnyOfCreateEmbeddingRequestSchemaModel**](AnyOfCreateEmbeddingRequestSchemaModel.md) | ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them. | 
+**user** | **String** | This is an unused parameter and is discarded by Venice. It is supported solely for API compatibility with OpenAI. | [optional] 
+

data/docs/CreateSpeechRequestSchema.md

@@ -0,0 +1,12 @@
+# VeniceClient::CreateSpeechRequestSchema
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input** | **String** | The text to generate audio for. The maximum length is 4096 characters. | 
+**model** | **String** | The model ID of a Venice TTS model. | [optional] [default to 'tts-kokoro']
+**response_format** | **String** | The format to audio in. | [optional] [default to 'mp3']
+**speed** | [**BigDecimal**](BigDecimal.md) | The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default. | [optional] [default to 1]
+**streaming** | **BOOLEAN** | Should the content stream back sentence by sentence or be processed and returned as a complete audio file. | [optional] [default to false]
+**voice** | **String** | The voice to use when generating the audio. | [optional] [default to 'af_sky']
+

data/docs/EmbeddingsApi.md

@@ -0,0 +1,60 @@
+# VeniceClient::EmbeddingsApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_embedding**](EmbeddingsApi.md#create_embedding) | **POST** /embeddings | /api/v1/embeddings
+
+# **create_embedding**
+> InlineResponse20014 create_embedding(body, opts)
+
+/api/v1/embeddings
+
+Create embeddings for the supplied input. This is a beta model accessible to Venice beta testers.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::EmbeddingsApi.new
+body = VeniceClient::CreateEmbeddingRequestSchema.new # CreateEmbeddingRequestSchema | 
+opts = { 
+  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br)
+}
+
+begin
+  #/api/v1/embeddings
+  result = api_instance.create_embedding(body, opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling EmbeddingsApi->create_embedding: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateEmbeddingRequestSchema**](CreateEmbeddingRequestSchema.md)|  | 
+ **accept_encoding** | **String**| Supported compression encodings (gzip, br) | [optional] 
+
+### Return type
+
+[**InlineResponse20014**](InlineResponse20014.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GenerateImageRequest.md

@@ -0,0 +1,22 @@
+# VeniceClient::GenerateImageRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cfg_scale** | [**BigDecimal**](BigDecimal.md) | CFG scale parameter. Higher values lead to more adherence to the prompt. | [optional] 
+**embed_exif_metadata** | **BOOLEAN** | Embed prompt generation information into the image's EXIF metadata. | [optional] [default to false]
+**format** | **String** | The image format to return. WebP are smaller and optimized for web use. PNG are higher quality but larger in file size.  | [optional] [default to 'webp']
+**height** | **Integer** | Height of the generated image. Each model has a specific height and width divisor listed in the widthHeightDivisor constraint in the model list endpoint. | [optional] [default to 1024]
+**hide_watermark** | **BOOLEAN** | Whether to hide the Venice watermark. Venice may ignore this parameter for certain generated content. | [optional] [default to false]
+**inpaint** | [****](.md) | This feature is deprecated and was disabled on May 19th, 2025. A revised in-painting API will be launched in the near future. | [optional] 
+**lora_strength** | **Integer** | Lora strength for the model. Only applies if the model uses additional Loras. | [optional] 
+**model** | **String** | The model to use for image generation. | 
+**negative_prompt** | **String** | A description of what should not be in the image. Character limit is model specific and is listed in the promptCharacterLimit constraint in the model list endpoint. | [optional] 
+**prompt** | **String** | The description for the image. Character limit is model specific and is listed in the promptCharacterLimit setting in the model list endpoint. | 
+**return_binary** | **BOOLEAN** | Whether to return binary image data instead of base64. | [optional] [default to false]
+**safe_mode** | **BOOLEAN** | Whether to use safe mode. If enabled, this will blur images that are classified as having adult content. | [optional] [default to true]
+**seed** | **Integer** | Random seed for generation. If not provided, a random seed will be used. | [optional] [default to 0]
+**steps** | **Integer** | Number of inference steps. The following models have reduced max steps from the global max: venice-sd35: 30 max steps, flux-dev: 30 max steps, flux-dev-uncensored: 30 max steps, stable-diffusion-3.5: 30 max steps. These constraints are exposed in the model list endpoint for each model. | [optional] [default to 20]
+**style_preset** | **String** | An image style to apply to the image. Visit https://docs.venice.ai/api-reference/endpoint/image/styles for more details. | [optional] 
+**width** | **Integer** | Width of the generated image. Each model has a specific height and width divisor listed in the widthHeightDivisor constraint in the model list endpoint. | [optional] [default to 1024]
+

data/docs/ImageApi.md

@@ -0,0 +1,270 @@
+# VeniceClient::ImageApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**generate_image**](ImageApi.md#generate_image) | **POST** /image/generate | /api/v1/image/generate
+[**image_styles_get**](ImageApi.md#image_styles_get) | **GET** /image/styles | /api/v1/image/styles
+[**simple_generate_image**](ImageApi.md#simple_generate_image) | **POST** /images/generations | /api/v1/image/generations
+[**upscale_image**](ImageApi.md#upscale_image) | **POST** /image/upscale | /api/v1/image/upscale
+[**upscale_image**](ImageApi.md#upscale_image) | **POST** /image/upscale | /api/v1/image/upscale
+
+# **generate_image**
+> InlineResponse2001 generate_image(opts)
+
+/api/v1/image/generate
+
+Generate an image based on input parameters
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ImageApi.new
+opts = { 
+  body: VeniceClient::GenerateImageRequest.new # GenerateImageRequest | 
+  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br). Only applied when return_binary is false.
+}
+
+begin
+  #/api/v1/image/generate
+  result = api_instance.generate_image(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ImageApi->generate_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GenerateImageRequest**](GenerateImageRequest.md)|  | [optional] 
+ **accept_encoding** | **String**| Supported compression encodings (gzip, br). Only applied when return_binary is false. | [optional] 
+
+### Return type
+
+[**InlineResponse2001**](InlineResponse2001.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json, image/jpeg, image/png, image/webp
+
+
+
+# **image_styles_get**
+> InlineResponse2003 image_styles_get
+
+/api/v1/image/styles
+
+List available image styles that can be used with the generate API.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ImageApi.new
+
+begin
+  #/api/v1/image/styles
+  result = api_instance.image_styles_get
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ImageApi->image_styles_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse2003**](InlineResponse2003.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **simple_generate_image**
+> InlineResponse2002 simple_generate_image(opts)
+
+/api/v1/image/generations
+
+Generate an image based on input parameters using an OpenAI compatible endpoint. This endpoint does not support the full feature set of the Venice Image Generation endpoint, but is compatible with the existing OpenAI endpoint.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ImageApi.new
+opts = { 
+  body: VeniceClient::SimpleGenerateImageRequest.new # SimpleGenerateImageRequest | 
+  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br).
+}
+
+begin
+  #/api/v1/image/generations
+  result = api_instance.simple_generate_image(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ImageApi->simple_generate_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SimpleGenerateImageRequest**](SimpleGenerateImageRequest.md)|  | [optional] 
+ **accept_encoding** | **String**| Supported compression encodings (gzip, br). | [optional] 
+
+### Return type
+
+[**InlineResponse2002**](InlineResponse2002.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **upscale_image**
+> String upscale_image(opts)
+
+/api/v1/image/upscale
+
+Upscale or enhance an image based on the supplied parameters. Using a scale of 1 with enhance enabled will only run the enhancer. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ImageApi.new
+opts = { 
+  body: VeniceClient::UpscaleImageRequest.new # UpscaleImageRequest | 
+}
+
+begin
+  #/api/v1/image/upscale
+  result = api_instance.upscale_image(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ImageApi->upscale_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpscaleImageRequest**](UpscaleImageRequest.md)|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: image/png, application/json
+
+
+
+# **upscale_image**
+> String upscale_image(opts)
+
+/api/v1/image/upscale
+
+Upscale or enhance an image based on the supplied parameters. Using a scale of 1 with enhance enabled will only run the enhancer. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::ImageApi.new
+opts = { 
+  enhance: VeniceClient::null.new #  | 
+  enhance_creativity: VeniceClient::BigDecimal.new # BigDecimal | 
+  enhance_prompt: 'enhance_prompt_example' # String | 
+  image: VeniceClient::null.new #  | 
+  replication: VeniceClient::BigDecimal.new # BigDecimal | 
+  scale: VeniceClient::BigDecimal.new # BigDecimal | 
+}
+
+begin
+  #/api/v1/image/upscale
+  result = api_instance.upscale_image(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling ImageApi->upscale_image: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **enhance** | [****](.md)|  | [optional] 
+ **enhance_creativity** | **BigDecimal**|  | [optional] 
+ **enhance_prompt** | **String**|  | [optional] 
+ **image** | [****](.md)|  | [optional] 
+ **replication** | **BigDecimal**|  | [optional] 
+ **scale** | **BigDecimal**|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json, multipart/form-data
+ - **Accept**: image/png, application/json
+
+
+

data/docs/InlineResponse200.md

@@ -0,0 +1,14 @@
+# VeniceClient::InlineResponse200
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**choices** | [**Array<InlineResponse200Choices>**](InlineResponse200Choices.md) | A list of chat completion choices. Can be more than one if n is greater than 1. | 
+**created** | **Integer** | The time at which the request was created. | 
+**id** | **String** | The ID of the request. | 
+**model** | **String** | The model id used for the request. | 
+**object** | **String** | The type of the object returned. | 
+**prompt_logprobs** | [**AnyOfinlineResponse200PromptLogprobs**](AnyOfinlineResponse200PromptLogprobs.md) | Log probability information for the prompt. | [optional] 
+**usage** | [**InlineResponse200Usage**](InlineResponse200Usage.md) |  | 
+**venice_parameters** | [**InlineResponse200VeniceParameters**](InlineResponse200VeniceParameters.md) |  | [optional] 
+

data/docs/InlineResponse2001.md

@@ -0,0 +1,10 @@
+# VeniceClient::InlineResponse2001
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the request. | 
+**images** | **Array<String>** | Base64 encoded image data. | 
+**request** | [****](.md) | The original request data sent to the API. | [optional] 
+**timing** | [**InlineResponse2001Timing**](InlineResponse2001Timing.md) |  | 
+

data/docs/InlineResponse20010.md

@@ -0,0 +1,7 @@
+# VeniceClient::InlineResponse20010
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**InlineResponse20010Data**](InlineResponse20010Data.md) |  | 
+

data/docs/InlineResponse20010Data.md

@@ -0,0 +1,12 @@
+# VeniceClient::InlineResponse20010Data
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_permitted** | **BOOLEAN** | Does the API key have access to consume the inference APIs? | 
+**api_tier** | [**InlineResponse20010DataApiTier**](InlineResponse20010DataApiTier.md) |  | 
+**balances** | [**InlineResponse20010DataBalances**](InlineResponse20010DataBalances.md) |  | 
+**key_expiration** | **String** | The timestamp the API key expires. If null, the key never expires. | 
+**next_epoch_begins** | **String** | The timestamp when the next epoch begins. This is relevant for rate limits that reset at the start of each epoch. | 
+**rate_limits** | [**Array<InlineResponse20010DataRateLimits1>**](InlineResponse20010DataRateLimits1.md) |  | 
+

data/docs/InlineResponse20010DataApiTier.md

@@ -0,0 +1,8 @@
+# VeniceClient::InlineResponse20010DataApiTier
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The ID of the API tier. | 
+**is_charged** | **BOOLEAN** | Is the API key pay per use (in VCU or USD). | 
+

data/docs/InlineResponse20010DataBalances.md

@@ -0,0 +1,8 @@
+# VeniceClient::InlineResponse20010DataBalances
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usd** | [**BigDecimal**](BigDecimal.md) | The USD balance of the key. | [optional] 
+**vcu** | [**BigDecimal**](BigDecimal.md) | The VCU balance of the key. | [optional] 
+

data/docs/InlineResponse20010DataRateLimits.md

@@ -0,0 +1,8 @@
+# VeniceClient::InlineResponse20010DataRateLimits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**BigDecimal**](BigDecimal.md) | The rate limit for the API model. | 
+**type** | **String** | The time period for the rate limit. Can be Requests Per Minute (RPM), Requests Per Day (RPD), or Tokens Per Minute (TPM). | 
+