venice_client 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -0
  3. data/.openapi-generator/FILES +18 -147
  4. data/Gemfile.lock +94 -0
  5. data/README.md +10 -11
  6. data/docs/APIKeysApi.md +70 -0
  7. data/docs/AssistantMessage.md +1 -1
  8. data/docs/BillingUsageResponse.md +2 -0
  9. data/docs/CharactersApi.md +70 -0
  10. data/docs/ChatCompletionRequestVeniceParameters.md +7 -5
  11. data/docs/CreateChatCompletion200ResponseVeniceParameters.md +2 -0
  12. data/docs/DetailedError.md +20 -0
  13. data/docs/EditImageRequest.md +1 -1
  14. data/docs/EditImageRequestImage.md +15 -0
  15. data/docs/GenerateImageRequest.md +3 -1
  16. data/docs/GetApiKeyById200Response.md +18 -0
  17. data/docs/GetApiKeyById200ResponseData.md +34 -0
  18. data/docs/GetApiKeyRateLimits200Response.md +2 -0
  19. data/docs/GetBillingUsage200Response.md +2 -0
  20. data/docs/GetCharacterBySlug200Response.md +20 -0
  21. data/docs/ImageApi.md +1 -1
  22. data/docs/ListCharacters200ResponseDataInner.md +5 -1
  23. data/docs/PreviewApi.md +70 -0
  24. data/docs/StandardError.md +18 -0
  25. data/docs/ToolCallFunction.md +3 -1
  26. data/lib/venice_client/api/api_keys_api.rb +64 -1
  27. data/lib/venice_client/api/audio_api.rb +1 -1
  28. data/lib/venice_client/api/billing_api.rb +1 -1
  29. data/lib/venice_client/api/characters_api.rb +64 -1
  30. data/lib/venice_client/api/chat_api.rb +1 -1
  31. data/lib/venice_client/api/embeddings_api.rb +1 -1
  32. data/lib/venice_client/api/image_api.rb +1 -1
  33. data/lib/venice_client/api/models_api.rb +1 -1
  34. data/lib/venice_client/api/preview_api.rb +64 -1
  35. data/lib/venice_client/api/speech_api.rb +1 -1
  36. data/lib/venice_client/api_client.rb +1 -1
  37. data/lib/venice_client/api_error.rb +1 -1
  38. data/lib/venice_client/configuration.rb +1 -1
  39. data/lib/venice_client/models/assistant_message.rb +3 -4
  40. data/lib/venice_client/models/assistant_message_content.rb +1 -1
  41. data/lib/venice_client/models/audio_model_pricing.rb +1 -1
  42. data/lib/venice_client/models/audio_model_pricing_input.rb +1 -1
  43. data/lib/venice_client/models/billing_usage_request.rb +1 -1
  44. data/lib/venice_client/models/billing_usage_response.rb +12 -2
  45. data/lib/venice_client/models/chat_completion_request.rb +1 -1
  46. data/lib/venice_client/models/chat_completion_request_messages_inner.rb +1 -1
  47. data/lib/venice_client/models/chat_completion_request_response_format.rb +1 -1
  48. data/lib/venice_client/models/chat_completion_request_stop.rb +1 -1
  49. data/lib/venice_client/models/chat_completion_request_stream_options.rb +1 -1
  50. data/lib/venice_client/models/chat_completion_request_tool_choice.rb +1 -1
  51. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +1 -1
  52. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +1 -1
  53. data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +34 -21
  54. data/lib/venice_client/models/create_api_key200_response.rb +1 -1
  55. data/lib/venice_client/models/create_api_key200_response_data.rb +1 -1
  56. data/lib/venice_client/models/create_api_key_request.rb +2 -2
  57. data/lib/venice_client/models/create_api_key_request_expires_at.rb +1 -1
  58. data/lib/venice_client/models/create_chat_completion200_response.rb +1 -1
  59. data/lib/venice_client/models/create_chat_completion200_response_choices_inner.rb +1 -1
  60. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs.rb +1 -1
  61. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb +1 -1
  62. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +1 -1
  63. data/lib/venice_client/models/create_chat_completion200_response_usage.rb +1 -1
  64. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb +29 -2
  65. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb +1 -1
  66. data/lib/venice_client/models/create_embedding200_response.rb +1 -1
  67. data/lib/venice_client/models/create_embedding200_response_data_inner.rb +1 -1
  68. data/lib/venice_client/models/create_embedding200_response_usage.rb +1 -1
  69. data/lib/venice_client/models/create_embedding_request_schema.rb +1 -1
  70. data/lib/venice_client/models/create_embedding_request_schema_input.rb +1 -1
  71. data/lib/venice_client/models/create_embedding_request_schema_model.rb +1 -1
  72. data/lib/venice_client/models/create_speech_request_schema.rb +1 -1
  73. data/lib/venice_client/models/delete_api_key200_response.rb +1 -1
  74. data/lib/venice_client/models/detailed_error.rb +248 -0
  75. data/lib/venice_client/models/edit_image_request.rb +2 -2
  76. data/lib/venice_client/models/edit_image_request_image.rb +104 -0
  77. data/lib/venice_client/models/generate_image200_response.rb +1 -1
  78. data/lib/venice_client/models/generate_image200_response_timing.rb +1 -1
  79. data/lib/venice_client/models/generate_image_request.rb +41 -3
  80. data/lib/venice_client/models/get_api_key_by_id200_response.rb +237 -0
  81. data/lib/venice_client/models/get_api_key_by_id200_response_data.rb +401 -0
  82. data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +1 -1
  83. data/lib/venice_client/models/get_api_key_generate_web3_key200_response_data.rb +1 -1
  84. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response.rb +1 -1
  85. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response_data_inner.rb +1 -1
  86. data/lib/venice_client/models/get_api_key_rate_limits200_response.rb +12 -2
  87. data/lib/venice_client/models/get_api_key_rate_limits200_response_data.rb +1 -1
  88. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_api_tier.rb +1 -1
  89. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_balances.rb +1 -1
  90. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner.rb +1 -1
  91. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb +1 -1
  92. data/lib/venice_client/models/get_api_keys200_response.rb +1 -1
  93. data/lib/venice_client/models/get_api_keys200_response_data_inner.rb +1 -1
  94. data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +1 -1
  95. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage.rb +1 -1
  96. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +1 -1
  97. data/lib/venice_client/models/get_billing_usage200_response.rb +12 -2
  98. data/lib/venice_client/models/get_billing_usage200_response_data_inner.rb +1 -1
  99. data/lib/venice_client/models/get_billing_usage200_response_data_inner_inference_details.rb +1 -1
  100. data/lib/venice_client/models/get_billing_usage200_response_pagination.rb +1 -1
  101. data/lib/venice_client/models/get_character_by_slug200_response.rb +287 -0
  102. data/lib/venice_client/models/image_model_constraints.rb +1 -1
  103. data/lib/venice_client/models/image_model_constraints_steps.rb +1 -1
  104. data/lib/venice_client/models/image_model_pricing.rb +1 -1
  105. data/lib/venice_client/models/image_model_pricing_generation.rb +1 -1
  106. data/lib/venice_client/models/image_model_pricing_upscale.rb +1 -1
  107. data/lib/venice_client/models/image_model_pricing_upscale2x.rb +1 -1
  108. data/lib/venice_client/models/image_model_pricing_upscale4x.rb +1 -1
  109. data/lib/venice_client/models/image_styles_get200_response.rb +1 -1
  110. data/lib/venice_client/models/image_url.rb +1 -1
  111. data/lib/venice_client/models/image_url_object.rb +1 -1
  112. data/lib/venice_client/models/json_object.rb +1 -1
  113. data/lib/venice_client/models/json_schema.rb +1 -1
  114. data/lib/venice_client/models/list_characters200_response.rb +1 -1
  115. data/lib/venice_client/models/list_characters200_response_data_inner.rb +45 -5
  116. data/lib/venice_client/models/list_characters200_response_data_inner_stats.rb +1 -1
  117. data/lib/venice_client/models/list_model_compatibility_mapping200_response.rb +1 -1
  118. data/lib/venice_client/models/list_model_traits200_response.rb +1 -1
  119. data/lib/venice_client/models/list_models200_response.rb +1 -1
  120. data/lib/venice_client/models/list_models200_response_type.rb +1 -1
  121. data/lib/venice_client/models/list_models_type_parameter.rb +1 -1
  122. data/lib/venice_client/models/llm_model_pricing.rb +1 -1
  123. data/lib/venice_client/models/llm_model_pricing_input.rb +1 -1
  124. data/lib/venice_client/models/llm_model_pricing_output.rb +1 -1
  125. data/lib/venice_client/models/model_response.rb +1 -1
  126. data/lib/venice_client/models/model_response_model_spec.rb +1 -1
  127. data/lib/venice_client/models/model_response_model_spec_capabilities.rb +3 -3
  128. data/lib/venice_client/models/model_response_model_spec_constraints.rb +1 -1
  129. data/lib/venice_client/models/model_response_model_spec_pricing.rb +1 -1
  130. data/lib/venice_client/models/objects_inner.rb +1 -1
  131. data/lib/venice_client/models/post_api_key_generate_web3_key_request.rb +1 -1
  132. data/lib/venice_client/models/simple_generate_image200_response.rb +1 -1
  133. data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +1 -1
  134. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +1 -1
  135. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of1.rb +1 -1
  136. data/lib/venice_client/models/simple_generate_image_request.rb +1 -1
  137. data/lib/venice_client/models/standard_error.rb +238 -0
  138. data/lib/venice_client/models/system_message.rb +1 -1
  139. data/lib/venice_client/models/system_message_content.rb +1 -1
  140. data/lib/venice_client/models/text.rb +1 -1
  141. data/lib/venice_client/models/text_model_constraints.rb +1 -1
  142. data/lib/venice_client/models/text_model_constraints_temperature.rb +1 -1
  143. data/lib/venice_client/models/text_model_constraints_top_p.rb +1 -1
  144. data/lib/venice_client/models/tool_call.rb +1 -1
  145. data/lib/venice_client/models/tool_call_function.rb +17 -5
  146. data/lib/venice_client/models/tool_message.rb +2 -1
  147. data/lib/venice_client/models/upscale_image_request.rb +1 -1
  148. data/lib/venice_client/models/upscale_image_request_enhance.rb +1 -1
  149. data/lib/venice_client/models/user_message.rb +1 -1
  150. data/lib/venice_client/models/user_message_content.rb +1 -1
  151. data/lib/venice_client/version.rb +2 -2
  152. data/lib/venice_client.rb +7 -11
  153. data/package-lock.json +2159 -0
  154. data/package.json +5 -0
  155. data/spec/models/detailed_error_spec.rb +42 -0
  156. data/spec/models/edit_image_request_image_spec.rb +21 -0
  157. data/spec/models/get_api_key_by_id200_response_data_spec.rb +88 -0
  158. data/spec/models/get_api_key_by_id200_response_spec.rb +36 -0
  159. data/spec/models/get_character_by_slug200_response_spec.rb +46 -0
  160. data/spec/models/standard_error_spec.rb +36 -0
  161. data/spec/spec_helper.rb +1 -1
  162. data/swagger.yaml +513 -714
  163. metadata +28 -1
@@ -4,12 +4,13 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **character_slug** | **String** | The character slug of a public Venice character. | [optional] |
7
+ | **character_slug** | **String** | The character slug of a public Venice character. Discoverable as the \"Public ID\" on the published character page. | [optional] |
8
8
  | **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] |
9
9
  | **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] |
10
10
  | **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'] |
11
11
  | **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] |
12
12
  | **include_search_results_in_stream** | **Boolean** | Experimental feature - When set to true, the LLM will include search results in the stream as the first emitted chunk. Defaults to false. | [optional][default to false] |
13
+ | **return_search_results_as_documents** | **Boolean** | When set, search results are also surfaced in an OpenAI-compatible tool call named \"venice_web_search_documents\" to ease LangChain consumption. | [optional] |
13
14
  | **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] |
14
15
 
15
16
  ## Example
@@ -18,12 +19,13 @@
18
19
  require 'venice_client'
19
20
 
20
21
  instance = VeniceClient::ChatCompletionRequestVeniceParameters.new(
21
- character_slug: venice,
22
+ character_slug: null,
22
23
  strip_thinking_response: false,
23
24
  disable_thinking: false,
24
- enable_web_search: auto,
25
- enable_web_citations: true,
26
- include_search_results_in_stream: true,
25
+ enable_web_search: false,
26
+ enable_web_citations: null,
27
+ include_search_results_in_stream: null,
28
+ return_search_results_as_documents: null,
27
29
  include_venice_system_prompt: null
28
30
  )
29
31
  ```
@@ -8,6 +8,7 @@
8
8
  | **enable_web_citations** | **Boolean** | Did the request enable web citations? | |
9
9
  | **include_venice_system_prompt** | **Boolean** | Did the request include the Venice system prompt? | |
10
10
  | **include_search_results_in_stream** | **Boolean** | Did the request include search results in the stream? | |
11
+ | **return_search_results_as_documents** | **Boolean** | Did the request also return search results as a tool-call documents block? | |
11
12
  | **character_slug** | **String** | The character slug of a public Venice character. | [optional] |
12
13
  | **strip_thinking_response** | **Boolean** | Did the request strip thinking response? | |
13
14
  | **disable_thinking** | **Boolean** | Did the request disable thinking? | |
@@ -23,6 +24,7 @@ instance = VeniceClient::CreateChatCompletion200ResponseVeniceParameters.new(
23
24
  enable_web_citations: true,
24
25
  include_venice_system_prompt: true,
25
26
  include_search_results_in_stream: false,
27
+ return_search_results_as_documents: true,
26
28
  character_slug: venice,
27
29
  strip_thinking_response: true,
28
30
  disable_thinking: true,
@@ -0,0 +1,20 @@
1
+ # VeniceClient::DetailedError
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **details** | **Object** | Details about the incorrect input | [optional] |
8
+ | **error** | **String** | A description of the error | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'venice_client'
14
+
15
+ instance = VeniceClient::DetailedError.new(
16
+ details: {"_errors":[],"field":{"_errors":["Field is required"]}},
17
+ error: null
18
+ )
19
+ ```
20
+
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **prompt** | **String** | The text directions to edit or modify the image. Does best with short but descriptive prompts. IE: \"Change the color of\", \"remove the object\", \"change the sky to a sunrise\", etc. | |
8
- | **image** | **String** | | |
8
+ | **image** | [**EditImageRequestImage**](EditImageRequestImage.md) | | |
9
9
 
10
10
  ## Example
11
11
 
@@ -0,0 +1,15 @@
1
+ # VeniceClient::EditImageRequestImage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'venice_client'
12
+
13
+ instance = VeniceClient::EditImageRequestImage.new()
14
+ ```
15
+
@@ -15,9 +15,10 @@
15
15
  | **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] |
16
16
  | **prompt** | **String** | The description for the image. Character limit is model specific and is listed in the promptCharacterLimit setting in the model list endpoint. | |
17
17
  | **return_binary** | **Boolean** | Whether to return binary image data instead of base64. | [optional][default to false] |
18
+ | **variants** | **Integer** | Number of images to generate (1–4). Only supported when return_binary is false. | [optional] |
18
19
  | **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] |
19
20
  | **seed** | **Integer** | Random seed for generation. If not provided, a random seed will be used. | [optional][default to 0] |
20
- | **steps** | **Integer** | Number of inference steps. The following models have reduced max steps from the global max: venice-sd35: 30 max steps, hidream: 50 max steps, fluently-xl: 50 max steps, flux-dev: 30 max steps, flux-dev-uncensored-11: 30 max steps, flux-dev-uncensored: 30 max steps, lustify-sdxl: 50 max steps, pony-realism: 50 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] |
21
+ | **steps** | **Integer** | Number of inference steps. The following models have reduced max steps from the global max: venice-sd35: 30 max steps, hidream: 50 max steps, flux.1-krea: 30 max steps, flux-dev: 30 max steps, flux-dev-uncensored: 30 max steps, lustify-sdxl: 50 max steps, lustify-v7: 25 max steps, pony-realism: 50 max steps, qwen-image: 8 max steps, stable-diffusion-3.5: 30 max steps, wai-Illustrious: 30 max steps. These constraints are exposed in the model list endpoint for each model. | [optional][default to 20] |
21
22
  | **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] |
22
23
  | **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] |
23
24
 
@@ -38,6 +39,7 @@ instance = VeniceClient::GenerateImageRequest.new(
38
39
  negative_prompt: Clouds, Rain, Snow,
39
40
  prompt: A beautiful sunset over a mountain range,
40
41
  return_binary: false,
42
+ variants: 3,
41
43
  safe_mode: false,
42
44
  seed: 123456789,
43
45
  steps: 20,
@@ -0,0 +1,18 @@
1
+ # VeniceClient::GetApiKeyById200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**GetApiKeyById200ResponseData**](GetApiKeyById200ResponseData.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'venice_client'
13
+
14
+ instance = VeniceClient::GetApiKeyById200Response.new(
15
+ data: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,34 @@
1
+ # VeniceClient::GetApiKeyById200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **api_key_type** | **String** | API Key type | |
8
+ | **consumption_limits** | [**GetApiKeys200ResponseDataInnerConsumptionLimits**](GetApiKeys200ResponseDataInnerConsumptionLimits.md) | | |
9
+ | **created_at** | **String** | API Key creation date | |
10
+ | **description** | **String** | API Key description | [optional] |
11
+ | **expires_at** | **String** | API Key expiration date | |
12
+ | **id** | **String** | API Key ID | |
13
+ | **last6_chars** | **String** | Last 6 characters of the API Key | |
14
+ | **last_used_at** | **String** | API Key last used date | |
15
+ | **usage** | [**GetApiKeys200ResponseDataInnerUsage**](GetApiKeys200ResponseDataInnerUsage.md) | | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'venice_client'
21
+
22
+ instance = VeniceClient::GetApiKeyById200ResponseData.new(
23
+ api_key_type: ADMIN,
24
+ consumption_limits: null,
25
+ created_at: 2023-10-01T12:00:00Z,
26
+ description: Example API Key,
27
+ expires_at: 2023-10-01T12:00:00Z,
28
+ id: e28e82dc-9df2-4b47-b726-d0a222ef2ab5,
29
+ last6_chars: 2V2jNW,
30
+ last_used_at: 2023-10-01T12:00:00Z,
31
+ usage: null
32
+ )
33
+ ```
34
+
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **warning_message** | **String** | A warning message to disambiguate staked DIEM balance from legacy DIEM (formerly VCU) balance | [optional] |
7
8
  | **data** | [**GetApiKeyRateLimits200ResponseData**](GetApiKeyRateLimits200ResponseData.md) | | |
8
9
 
9
10
  ## Example
@@ -12,6 +13,7 @@
12
13
  require 'venice_client'
13
14
 
14
15
  instance = VeniceClient::GetApiKeyRateLimits200Response.new(
16
+ warning_message: null,
15
17
  data: null
16
18
  )
17
19
  ```
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **warning_message** | **String** | A warning message to disambiguate DIEM usage from legacy DIEM (formerly VCU) usage | [optional] |
7
8
  | **data** | [**Array<GetBillingUsage200ResponseDataInner>**](GetBillingUsage200ResponseDataInner.md) | | |
8
9
  | **pagination** | [**GetBillingUsage200ResponsePagination**](GetBillingUsage200ResponsePagination.md) | | |
9
10
 
@@ -13,6 +14,7 @@
13
14
  require 'venice_client'
14
15
 
15
16
  instance = VeniceClient::GetBillingUsage200Response.new(
17
+ warning_message: null,
16
18
  data: null,
17
19
  pagination: null
18
20
  )
@@ -0,0 +1,20 @@
1
+ # VeniceClient::GetCharacterBySlug200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**ListCharacters200ResponseDataInner**](ListCharacters200ResponseDataInner.md) | | |
8
+ | **object** | **String** | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'venice_client'
14
+
15
+ instance = VeniceClient::GetCharacterBySlug200Response.new(
16
+ data: null,
17
+ object: null
18
+ )
19
+ ```
20
+
data/docs/ImageApi.md CHANGED
@@ -32,7 +32,7 @@ end
32
32
 
33
33
  api_instance = VeniceClient::ImageApi.new
34
34
  opts = {
35
- edit_image_request: VeniceClient::EditImageRequest.new({prompt: 'Change the color of the sky to a sunrise', image: 'image_example'}) # EditImageRequest |
35
+ edit_image_request: VeniceClient::EditImageRequest.new({prompt: 'Change the color of the sky to a sunrise', image: VeniceClient::EditImageRequestImage.new}) # EditImageRequest |
36
36
  }
37
37
 
38
38
  begin
@@ -9,11 +9,13 @@
9
9
  | **description** | **String** | Description of the character | |
10
10
  | **name** | **String** | Name of the character | |
11
11
  | **share_url** | **String** | Share URL of the character | |
12
+ | **photo_url** | **String** | URL of the character photo | |
12
13
  | **slug** | **String** | Slug of the character to be used in the completions API | |
13
14
  | **stats** | [**ListCharacters200ResponseDataInnerStats**](ListCharacters200ResponseDataInnerStats.md) | | |
14
15
  | **tags** | **Array<String>** | Tags associated with the character | |
15
16
  | **updated_at** | **String** | Date when the character was last updated | |
16
17
  | **web_enabled** | **Boolean** | Whether the character is enabled for web use | |
18
+ | **model_id** | **String** | API model ID for the character | |
17
19
 
18
20
  ## Example
19
21
 
@@ -26,11 +28,13 @@ instance = VeniceClient::ListCharacters200ResponseDataInner.new(
26
28
  description: Alan Watts (6 January 1915 – 16 November 1973) was a British and American writer, speaker, and self-styled "philosophical entertainer", known for interpreting and popularizing Buddhist, Taoist, and Hindu philosophy for a Western audience.,
27
29
  name: Alan Watts,
28
30
  share_url: https://venice.ai/c/alan-watts,
31
+ photo_url: https://outerface.venice.ai/api/characters/2f460055-7595-4640-9cb6-c442c4c869b0/photo,
29
32
  slug: alan-watts,
30
33
  stats: null,
31
34
  tags: ["AlanWatts","Philosophy","Buddhism","Taoist","Hindu"],
32
35
  updated_at: 2025-02-09T03:23:53.708Z,
33
- web_enabled: true
36
+ web_enabled: true,
37
+ model_id: venice-uncensored
34
38
  )
35
39
  ```
36
40
 
data/docs/PreviewApi.md CHANGED
@@ -4,9 +4,79 @@ All URIs are relative to *https://api.venice.ai/api/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**get_character_by_slug**](PreviewApi.md#get_character_by_slug) | **GET** /characters/{slug} | /api/v1/characters/{slug} |
7
8
  | [**list_characters**](PreviewApi.md#list_characters) | **GET** /characters | /api/v1/characters |
8
9
 
9
10
 
11
+ ## get_character_by_slug
12
+
13
+ > <GetCharacterBySlug200Response> get_character_by_slug(slug)
14
+
15
+ /api/v1/characters/{slug}
16
+
17
+ This is a preview API and may change. Returns a single character by its slug.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'venice_client'
24
+ # setup authorization
25
+ VeniceClient.configure do |config|
26
+ # Configure Bearer authorization (JWT): BearerAuth
27
+ config.access_token = 'YOUR_BEARER_TOKEN'
28
+ end
29
+
30
+ api_instance = VeniceClient::PreviewApi.new
31
+ slug = 'alan-watts' # String | The slug of the character to retrieve
32
+
33
+ begin
34
+ # /api/v1/characters/{slug}
35
+ result = api_instance.get_character_by_slug(slug)
36
+ p result
37
+ rescue VeniceClient::ApiError => e
38
+ puts "Error when calling PreviewApi->get_character_by_slug: #{e}"
39
+ end
40
+ ```
41
+
42
+ #### Using the get_character_by_slug_with_http_info variant
43
+
44
+ This returns an Array which contains the response data, status code and headers.
45
+
46
+ > <Array(<GetCharacterBySlug200Response>, Integer, Hash)> get_character_by_slug_with_http_info(slug)
47
+
48
+ ```ruby
49
+ begin
50
+ # /api/v1/characters/{slug}
51
+ data, status_code, headers = api_instance.get_character_by_slug_with_http_info(slug)
52
+ p status_code # => 2xx
53
+ p headers # => { ... }
54
+ p data # => <GetCharacterBySlug200Response>
55
+ rescue VeniceClient::ApiError => e
56
+ puts "Error when calling PreviewApi->get_character_by_slug_with_http_info: #{e}"
57
+ end
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+ | Name | Type | Description | Notes |
63
+ | ---- | ---- | ----------- | ----- |
64
+ | **slug** | **String** | The slug of the character to retrieve | |
65
+
66
+ ### Return type
67
+
68
+ [**GetCharacterBySlug200Response**](GetCharacterBySlug200Response.md)
69
+
70
+ ### Authorization
71
+
72
+ [BearerAuth](../README.md#BearerAuth)
73
+
74
+ ### HTTP request headers
75
+
76
+ - **Content-Type**: Not defined
77
+ - **Accept**: application/json
78
+
79
+
10
80
  ## list_characters
11
81
 
12
82
  > <ListCharacters200Response> list_characters
@@ -0,0 +1,18 @@
1
+ # VeniceClient::StandardError
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | **String** | A description of the error | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'venice_client'
13
+
14
+ instance = VeniceClient::StandardError.new(
15
+ error: null
16
+ )
17
+ ```
18
+
@@ -7,6 +7,7 @@
7
7
  | **description** | **String** | | [optional] |
8
8
  | **name** | **String** | | |
9
9
  | **parameters** | **Hash&lt;String, Object&gt;** | | [optional] |
10
+ | **strict** | **Boolean** | If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. | [optional][default to false] |
10
11
 
11
12
  ## Example
12
13
 
@@ -16,7 +17,8 @@ require 'venice_client'
16
17
  instance = VeniceClient::ToolCallFunction.new(
17
18
  description: null,
18
19
  name: null,
19
- parameters: null
20
+ parameters: null,
21
+ strict: false
20
22
  )
21
23
  ```
22
24
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -143,6 +143,69 @@ module VeniceClient
143
143
  return data, status_code, headers
144
144
  end
145
145
 
146
+ # Get API key details by ID
147
+ # Return details about a specific API key, including rate limits and balance data.
148
+ # @param id [String] The ID of the API key to retrieve
149
+ # @param [Hash] opts the optional parameters
150
+ # @return [GetApiKeyById200Response]
151
+ def get_api_key_by_id(id, opts = {})
152
+ data, _status_code, _headers = get_api_key_by_id_with_http_info(id, opts)
153
+ data
154
+ end
155
+
156
+ # Get API key details by ID
157
+ # Return details about a specific API key, including rate limits and balance data.
158
+ # @param id [String] The ID of the API key to retrieve
159
+ # @param [Hash] opts the optional parameters
160
+ # @return [Array<(GetApiKeyById200Response, Integer, Hash)>] GetApiKeyById200Response data, response status code and response headers
161
+ def get_api_key_by_id_with_http_info(id, opts = {})
162
+ if @api_client.config.debugging
163
+ @api_client.config.logger.debug 'Calling API: APIKeysApi.get_api_key_by_id ...'
164
+ end
165
+ # verify the required parameter 'id' is set
166
+ if @api_client.config.client_side_validation && id.nil?
167
+ fail ArgumentError, "Missing the required parameter 'id' when calling APIKeysApi.get_api_key_by_id"
168
+ end
169
+ # resource path
170
+ local_var_path = '/api_keys/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
171
+
172
+ # query parameters
173
+ query_params = opts[:query_params] || {}
174
+
175
+ # header parameters
176
+ header_params = opts[:header_params] || {}
177
+ # HTTP header 'Accept' (if needed)
178
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
179
+
180
+ # form parameters
181
+ form_params = opts[:form_params] || {}
182
+
183
+ # http body (model)
184
+ post_body = opts[:debug_body]
185
+
186
+ # return_type
187
+ return_type = opts[:debug_return_type] || 'GetApiKeyById200Response'
188
+
189
+ # auth_names
190
+ auth_names = opts[:debug_auth_names] || ['BearerAuth']
191
+
192
+ new_options = opts.merge(
193
+ :operation => :"APIKeysApi.get_api_key_by_id",
194
+ :header_params => header_params,
195
+ :query_params => query_params,
196
+ :form_params => form_params,
197
+ :body => post_body,
198
+ :auth_names => auth_names,
199
+ :return_type => return_type
200
+ )
201
+
202
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
203
+ if @api_client.config.debugging
204
+ @api_client.config.logger.debug "API called: APIKeysApi#get_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
205
+ end
206
+ return data, status_code, headers
207
+ end
208
+
146
209
  # /api/v1/api_keys/generate_web3_key
147
210
  # Returns the token required to generate an API key via a wallet.
148
211
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -19,6 +19,69 @@ module VeniceClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # /api/v1/characters/{slug}
23
+ # This is a preview API and may change. Returns a single character by its slug.
24
+ # @param slug [String] The slug of the character to retrieve
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [GetCharacterBySlug200Response]
27
+ def get_character_by_slug(slug, opts = {})
28
+ data, _status_code, _headers = get_character_by_slug_with_http_info(slug, opts)
29
+ data
30
+ end
31
+
32
+ # /api/v1/characters/{slug}
33
+ # This is a preview API and may change. Returns a single character by its slug.
34
+ # @param slug [String] The slug of the character to retrieve
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(GetCharacterBySlug200Response, Integer, Hash)>] GetCharacterBySlug200Response data, response status code and response headers
37
+ def get_character_by_slug_with_http_info(slug, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: CharactersApi.get_character_by_slug ...'
40
+ end
41
+ # verify the required parameter 'slug' is set
42
+ if @api_client.config.client_side_validation && slug.nil?
43
+ fail ArgumentError, "Missing the required parameter 'slug' when calling CharactersApi.get_character_by_slug"
44
+ end
45
+ # resource path
46
+ local_var_path = '/characters/{slug}'.sub('{' + 'slug' + '}', CGI.escape(slug.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'GetCharacterBySlug200Response'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['BearerAuth']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"CharactersApi.get_character_by_slug",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: CharactersApi#get_character_by_slug\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
22
85
  # /api/v1/characters
23
86
  # This is a preview API and may change. Returns a list of characters supported in the API.
24
87
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0