venice_client

VeniceClient - the Ruby gem for the Venice.ai API

The Venice.ai API.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 20250918.173746
Package version: 1.0.0
Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build venice_client.gemspec

Then either install the gem locally:

gem install ./venice_client-1.0.0.gem

(for development, run gem install --dev ./venice_client-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'venice_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'venice_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'venice_client'

# Setup authorization
VeniceClient.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = VeniceClient::APIKeysApi.new
opts = {
  create_api_key_request: VeniceClient::CreateApiKeyRequest.new({api_key_type: 'INFERENCE', description: 'Example API Key'}) # CreateApiKeyRequest | 
}

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

Documentation for API Endpoints

All URIs are relative to https://api.venice.ai/api/v1

Class	Method	HTTP request	Description
VeniceClient::APIKeysApi	create_api_key	POST /api_keys	/api/v1/api_keys
VeniceClient::APIKeysApi	delete_api_key	DELETE /api_keys	/api/v1/api_keys
VeniceClient::APIKeysApi	get_api_key_by_id	GET /api_keys/id	Get API key details by ID
VeniceClient::APIKeysApi	get_api_key_generate_web3_key	GET /api_keys/generate_web3_key	/api/v1/api_keys/generate_web3_key
VeniceClient::APIKeysApi	get_api_key_rate_limit_logs	GET /api_keys/rate_limits/log	/api/v1/api_keys/rate_limits/log
VeniceClient::APIKeysApi	get_api_key_rate_limits	GET /api_keys/rate_limits	/api/v1/api_keys/rate_limits
VeniceClient::APIKeysApi	get_api_keys	GET /api_keys	/api/v1/api_keys
VeniceClient::APIKeysApi	post_api_key_generate_web3_key	POST /api_keys/generate_web3_key	/api/v1/api_keys/generate_web3_key
VeniceClient::AudioApi	create_speech	POST /audio/speech	/api/v1/audio/speech
VeniceClient::BillingApi	get_billing_usage	GET /billing/usage	/api/v1/billing/usage
VeniceClient::CharactersApi	get_character_by_slug	GET /characters/slug	/api/v1/characters/slug
VeniceClient::CharactersApi	list_characters	GET /characters	/api/v1/characters
VeniceClient::ChatApi	create_chat_completion	POST /chat/completions	/api/v1/chat/completions
VeniceClient::EmbeddingsApi	create_embedding	POST /embeddings	/api/v1/embeddings
VeniceClient::ImageApi	edit_image	POST /image/edit	/api/v1/image/edit
VeniceClient::ImageApi	generate_image	POST /image/generate	/api/v1/image/generate
VeniceClient::ImageApi	image_styles_get	GET /image/styles	/api/v1/image/styles
VeniceClient::ImageApi	simple_generate_image	POST /images/generations	/api/v1/image/generations
VeniceClient::ImageApi	upscale_image	POST /image/upscale	/api/v1/image/upscale
VeniceClient::ModelsApi	list_model_compatibility_mapping	GET /models/compatibility_mapping	/api/v1/models/compatibility_mapping
VeniceClient::ModelsApi	list_model_traits	GET /models/traits	/api/v1/models/traits
VeniceClient::ModelsApi	list_models	GET /models	/api/v1/models
VeniceClient::PreviewApi	get_character_by_slug	GET /characters/slug	/api/v1/characters/slug
VeniceClient::PreviewApi	list_characters	GET /characters	/api/v1/characters
VeniceClient::SpeechApi	create_speech	POST /audio/speech	/api/v1/audio/speech