Skip to content

Repository files navigation

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.2
  • 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.2.gem

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

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 gemrequire'vectorizer_ai'# Setup authorizationVectorizerAI.configuredo |config|
# Configure HTTP basic authorization: basicAuthconfig.username='YOUR_USERNAME'config.password='YOUR_PASSWORD'endapi_instance=VectorizerAI::AccountApi.newbegin#Get account statusresult=api_instance.get_account_statuspresultrescueVectorizerAI::ApiError=>eputs"Exception when calling AccountApi->get_account_status: #{e}"end

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
VectorizerAI::AccountApiget_account_statusGET /accountGet account status
VectorizerAI::VectorizationApipost_deletePOST /deleteDelete a retained image
VectorizerAI::VectorizationApipost_downloadPOST /downloadDownload a retained result
VectorizerAI::VectorizationApipost_vectorizePOST /vectorizeVectorize an image

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

About

Official Ruby SDK for the Vectorizer.AI image vectorization API.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages