vectorizer_ai

VectorizerAI - the Ruby gem for the Vectorizer.AI API

OpenAPI 3.0 specification for the Vectorizer.AI image vectorization API. Authenticate with HTTP Basic auth, using your API Id as the username and your API Secret as the password.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://vectorizer.ai/support

Installation

Build a gem

To build the Ruby code into a gem:

gem build vectorizer_ai.gemspec

Then either install the gem locally:

gem install ./vectorizer_ai-1.0.0.gem

(for development, run gem install --dev ./vectorizer_ai-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 'vectorizer_ai', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/clv/vectorizer-ai-ruby, then add the following in the Gemfile:

gem 'vectorizer_ai', :git => 'https://github.com/clv/vectorizer-ai-ruby.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 'vectorizer_ai'

# Setup authorization
VectorizerAI.configure do |config|
  # Configure HTTP basic authorization: basicAuth
  config.username = 'YOUR_USERNAME'
  config.password = 'YOUR_PASSWORD'
end

api_instance = VectorizerAI::AccountApi.new

begin
  #Get account status
  result = api_instance.
  p result
rescue VectorizerAI::ApiError => e
  puts "Exception when calling AccountApi->get_account_status: #{e}"
end

Documentation for API Endpoints

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

Class Method HTTP request Description
VectorizerAI::AccountApi get_account_status GET /account Get account status
VectorizerAI::VectorizationApi post_delete POST /delete Delete a retained image
VectorizerAI::VectorizationApi post_download POST /download Download a retained result
VectorizerAI::VectorizationApi post_vectorize POST /vectorize Vectorize an image

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication