venice_client 1.0.0

data/docs/APIKeysApi.md

@@ -0,0 +1,334 @@
+# VeniceClient::APIKeysApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_api_key**](APIKeysApi.md#create_api_key) | **POST** /api_keys | /api/v1/api_keys
+[**delete_api_key**](APIKeysApi.md#delete_api_key) | **DELETE** /api_keys | /api/v1/api_keys
+[**get_api_key_generate_web3_key**](APIKeysApi.md#get_api_key_generate_web3_key) | **GET** /api_keys/generate_web3_key | /api/v1/api_keys/generate_web3_key
+[**get_api_key_rate_limit_logs**](APIKeysApi.md#get_api_key_rate_limit_logs) | **GET** /api_keys/rate_limits/log | /api/v1/api_keys/rate_limits/log
+[**get_api_key_rate_limits**](APIKeysApi.md#get_api_key_rate_limits) | **GET** /api_keys/rate_limits | /api/v1/api_keys/rate_limits
+[**get_api_keys**](APIKeysApi.md#get_api_keys) | **GET** /api_keys | /api/v1/api_keys
+[**post_api_key_generate_web3_key**](APIKeysApi.md#post_api_key_generate_web3_key) | **POST** /api_keys/generate_web3_key | /api/v1/api_keys/generate_web3_key
+
+# **create_api_key**
+> InlineResponse2008 create_api_key(opts)
+
+/api/v1/api_keys
+
+Create a new API key.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::APIKeysApi.new
+opts = { 
+  body: VeniceClient::ApiKeysBody.new # ApiKeysBody | 
+}
+
+begin
+  #/api/v1/api_keys
+  result = api_instance.create_api_key(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->create_api_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ApiKeysBody**](ApiKeysBody.md)|  | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_api_key**
+> InlineResponse2009 delete_api_key(opts)
+
+/api/v1/api_keys
+
+Delete an API key.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::APIKeysApi.new
+opts = { 
+  id: 'id_example' # String | The ID of the API key to delete
+}
+
+begin
+  #/api/v1/api_keys
+  result = api_instance.delete_api_key(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->delete_api_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| The ID of the API key to delete | [optional] 
+
+### Return type
+
+[**InlineResponse2009**](InlineResponse2009.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_api_key_generate_web3_key**
+> InlineResponse20012 get_api_key_generate_web3_key
+
+/api/v1/api_keys/generate_web3_key
+
+Returns the token required to generate an API key via a wallet.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+
+api_instance = VeniceClient::APIKeysApi.new
+
+begin
+  #/api/v1/api_keys/generate_web3_key
+  result = api_instance.get_api_key_generate_web3_key
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->get_api_key_generate_web3_key: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse20012**](InlineResponse20012.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_api_key_rate_limit_logs**
+> InlineResponse20011 get_api_key_rate_limit_logs
+
+/api/v1/api_keys/rate_limits/log
+
+Returns the last 50 rate limits that the account exceeded.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::APIKeysApi.new
+
+begin
+  #/api/v1/api_keys/rate_limits/log
+  result = api_instance.get_api_key_rate_limit_logs
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->get_api_key_rate_limit_logs: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse20011**](InlineResponse20011.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_api_key_rate_limits**
+> InlineResponse20010 get_api_key_rate_limits
+
+/api/v1/api_keys/rate_limits
+
+Return details about user balances and rate limits.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::APIKeysApi.new
+
+begin
+  #/api/v1/api_keys/rate_limits
+  result = api_instance.get_api_key_rate_limits
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->get_api_key_rate_limits: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse20010**](InlineResponse20010.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_api_keys**
+> InlineResponse2007 get_api_keys
+
+/api/v1/api_keys
+
+Return a list of API keys.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::APIKeysApi.new
+
+begin
+  #/api/v1/api_keys
+  result = api_instance.get_api_keys
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->get_api_keys: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse2007**](InlineResponse2007.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_api_key_generate_web3_key**
+> InlineResponse2008 post_api_key_generate_web3_key(opts)
+
+/api/v1/api_keys/generate_web3_key
+
+Authenticates a wallet holding sVVV and creates an API key.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+
+api_instance = VeniceClient::APIKeysApi.new
+opts = { 
+  body: VeniceClient::ApiKeysGenerateWeb3KeyBody.new # ApiKeysGenerateWeb3KeyBody | 
+}
+
+begin
+  #/api/v1/api_keys/generate_web3_key
+  result = api_instance.post_api_key_generate_web3_key(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling APIKeysApi->post_api_key_generate_web3_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ApiKeysGenerateWeb3KeyBody**](ApiKeysGenerateWeb3KeyBody.md)|  | [optional] 
+
+### Return type
+
+[**InlineResponse2008**](InlineResponse2008.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AnyOfChatCompletionRequestMessagesItems.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfChatCompletionRequestMessagesItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfChatCompletionRequestStop.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfChatCompletionRequestStop
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfChatCompletionRequestToolChoice.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfChatCompletionRequestToolChoice
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfCreateEmbeddingRequestSchemaInput.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfCreateEmbeddingRequestSchemaInput
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfCreateEmbeddingRequestSchemaModel.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfCreateEmbeddingRequestSchemaModel
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfModelResponseModelSpecConstraints.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfModelResponseModelSpecConstraints
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfModelResponseModelSpecPricing.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfModelResponseModelSpecPricing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfUpscaleImageRequestEnhance.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfUpscaleImageRequestEnhance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfUpscaleImageRequestImage.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfUpscaleImageRequestImage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfapiKeysBodyExpiresAt.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfapiKeysBodyExpiresAt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfapiKeysConsumptionLimitUsd.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfapiKeysConsumptionLimitUsd
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfapiKeysConsumptionLimitVcu.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfapiKeysConsumptionLimitVcu
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfapiKeysGenerateWeb3KeyBodyExpiresAt.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfapiKeysGenerateWeb3KeyBodyExpiresAt
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse2002DataItems.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse2002DataItems
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse2004Type.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse2004Type
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse2005Type.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse2005Type
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse2006Type.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse2006Type
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse200ChoicesMessage.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse200ChoicesMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/AnyOfinlineResponse200PromptLogprobs.md

@@ -0,0 +1,6 @@
+# VeniceClient::AnyOfinlineResponse200PromptLogprobs
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/ApiKeysBody.md

@@ -0,0 +1,10 @@
+# VeniceClient::ApiKeysBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key_type** | **String** | The API Key type. Admin keys have full access to the API while inference keys are only able to call inference endpoints. | 
+**consumption_limit** | [**ApiKeysConsumptionLimit**](ApiKeysConsumptionLimit.md) |  | [optional] 
+**description** | **String** | The API Key description | 
+**expires_at** | [**AnyOfapiKeysBodyExpiresAt**](AnyOfapiKeysBodyExpiresAt.md) | The API Key expiration date. If not provided, the key will not expire. | [optional] 
+

data/docs/ApiKeysConsumptionLimit.md

@@ -0,0 +1,8 @@
+# VeniceClient::ApiKeysConsumptionLimit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**usd** | [**AnyOfapiKeysConsumptionLimitUsd**](AnyOfapiKeysConsumptionLimitUsd.md) | USD limit | 
+**vcu** | [**AnyOfapiKeysConsumptionLimitVcu**](AnyOfapiKeysConsumptionLimitVcu.md) | VCU limit | 
+

data/docs/ApiKeysGenerateWeb3KeyBody.md

@@ -0,0 +1,13 @@
+# VeniceClient::ApiKeysGenerateWeb3KeyBody
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**api_key_type** | **String** | The API Key type. Admin keys have full access to the API while inference keys are only able to call inference endpoints. | 
+**consumption_limit** | [**ApiKeysConsumptionLimit**](ApiKeysConsumptionLimit.md) |  | [optional] 
+**description** | **String** | The API Key description | [optional] [default to 'Web3 API Key']
+**expires_at** | [**AnyOfapiKeysGenerateWeb3KeyBodyExpiresAt**](AnyOfapiKeysGenerateWeb3KeyBodyExpiresAt.md) | The API Key expiration date. If not provided, the key will not expire. | [optional] 
+**address** | **String** | The wallet's address | 
+**signature** | **String** | The token, signed with the wallet's private key | 
+**token** | **String** | The token obtained from https://api.venice.ai/api/v1/api_keys/generate_web3_key | 
+

data/docs/AudioApi.md

@@ -0,0 +1,58 @@
+# VeniceClient::AudioApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_speech**](AudioApi.md#create_speech) | **POST** /audio/speech | /api/v1/audio/speech
+
+# **create_speech**
+> String create_speech(opts)
+
+/api/v1/audio/speech
+
+Converts text to speech using various voice models and formats.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::AudioApi.new
+opts = { 
+  body: VeniceClient::CreateSpeechRequestSchema.new # CreateSpeechRequestSchema | 
+}
+
+begin
+  #/api/v1/audio/speech
+  result = api_instance.create_speech(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling AudioApi->create_speech: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateSpeechRequestSchema**](CreateSpeechRequestSchema.md)|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: audio/aac, audio/flac, audio/mpeg, audio/opus, audio/pcm, audio/wav, application/json
+
+
+

data/docs/BillingApi.md

@@ -0,0 +1,70 @@
+# VeniceClient::BillingApi
+
+All URIs are relative to *https://api.venice.ai/api/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_billing_usage**](BillingApi.md#get_billing_usage) | **GET** /billing/usage | /api/v1/billing/usage
+
+# **get_billing_usage**
+> InlineResponse20015 get_billing_usage(opts)
+
+/api/v1/billing/usage
+
+Get paginated billing usage data for the authenticated user. NOTE: This is a beta endpoint and may be subject to change.
+
+### Example
+```ruby
+# load the gem
+require 'venice_client'
+# setup authorization
+VeniceClient.configure do |config|
+end
+
+api_instance = VeniceClient::BillingApi.new
+opts = { 
+  accept: 'accept_example', # String | Accept header to specify the response format
+  currency: 'currency_example', # String | 
+  end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | 
+  limit: 200, # Integer | 
+  page: 1, # Integer | 
+  sort_order: 'desc', # String | 
+  start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | 
+}
+
+begin
+  #/api/v1/billing/usage
+  result = api_instance.get_billing_usage(opts)
+  p result
+rescue VeniceClient::ApiError => e
+  puts "Exception when calling BillingApi->get_billing_usage: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accept** | **String**| Accept header to specify the response format | [optional] 
+ **currency** | **String**|  | [optional] 
+ **end_date** | **DateTime**|  | [optional] 
+ **limit** | **Integer**|  | [optional] [default to 200]
+ **page** | **Integer**|  | [optional] [default to 1]
+ **sort_order** | **String**|  | [optional] [default to desc]
+ **start_date** | **DateTime**|  | [optional] 
+
+### Return type
+
+[**InlineResponse20015**](InlineResponse20015.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+

data/docs/BillingUsageRequest.md

@@ -0,0 +1,12 @@
+# VeniceClient::BillingUsageRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** | Filter by currency | [optional] 
+**end_date** | **DateTime** | End date for filtering records (ISO 8601) | [optional] 
+**limit** | **Integer** | Number of items per page | [optional] [default to 200]
+**page** | **Integer** | Page number for pagination | [optional] [default to 1]
+**sort_order** | **String** | Sort order for createdAt field | [optional] [default to 'desc']
+**start_date** | **DateTime** | Start date for filtering records (ISO 8601) | [optional] 
+

data/docs/BillingUsageResponse.md

@@ -0,0 +1,8 @@
+# VeniceClient::BillingUsageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<BillingUsageResponseData>**](BillingUsageResponseData.md) |  | 
+**pagination** | [**BillingUsageResponsePagination**](BillingUsageResponsePagination.md) |  | 
+

data/docs/BillingUsageResponseData.md

@@ -0,0 +1,14 @@
+# VeniceClient::BillingUsageResponseData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | [**BigDecimal**](BigDecimal.md) | The total amount charged for the billing usage entry | 
+**currency** | **String** | The currency charged for the billing usage entry | 
+**inference_details** | [**BillingUsageResponseInferenceDetails**](BillingUsageResponseInferenceDetails.md) |  | 
+**notes** | **String** | Notes about the billing usage entry | 
+**price_per_unit_usd** | [**BigDecimal**](BigDecimal.md) | The price per unit in USD | 
+**sku** | **String** | The product associated with the billing usage entry | 
+**timestamp** | **String** | The timestamp the billing usage entry was created | 
+**units** | [**BigDecimal**](BigDecimal.md) | The number of units consumed | 
+