Latest commit 686c8bd Nov 23, 2016 @edjames edjames add vzaar logo (V2)


vzaar API Ruby client

vzaar API client for Ruby developers.

Build Status Code Climate

vzaar is the go to video hosting platform for business. Affordable, customizable and secure. Leverage the power of online video and enable commerce with vzaar. For more details and signup please visit http://vzaar.com


Add this line to your application's Gemfile:

gem 'vzaar'

And then execute:

$ bundle


api = Vzaar::Api.new(application_token: "API token", login: "vzaar login")

If your login and API token are correct, you should be able to fetch your login by calling:



Fetching account's type details:

api.account_type(account_type_id, options)

Fetching user's details:

api.user_details("user login", options)

Getting details from public video:

api.video_details(video_id, options)

Getting details from private video (authentication required):

api.video_details(video_id, authenticated: true)

Fetching videos for a given user:

api.video_list("user login", options)

Fetching videos for authenticated user (authentication required):


Removing video from vzaar: (authentication required)


Updating existing video (authentication required):

api.edit_video(video_id, options)

# Options are: title, description, private and seo_url

Uploading new video to vzaar (authentication required):


# Options are: path, url, title, description, profile, transcoding, replace_id, width and bitrate.
# api.upload_video(path: "./path/to/video.mp4", title: "my video")
# For link upload use `url` param:
# api.upload_video(url: "http://example.com/video.mp4", title: "my video")

Uploading new thumbnail for video (authentication required):

api.upload_thumbnail(video_id, options)
# api.upload_thumbnail(123456, path: "/path/to/image.jpg")

Generating new thumbnail based on given time value (authentication required):

api.generate_thumbnail(video_id, options)

# api.generate_thumbnail(123456, time: 3)

Adding subtitle to the video (authentication required):

api.add_subtitle(video_id, options)

# api.add_subtitle(123456, body: "1\n00:00:17,440 --> 00:01:20,375\n ......", language: "en")

Upload Signature

Getting guid and AWS signature (authentication required):

api.signature(path: '/path/to/file/movie.mp4')

When performing a link upload, specify the url instead of the path:

api.signature(url: 'http://example.com/movie.mp4')

Special characters in filenames

As per the AWS S3 documentation, only a small number of special characters in filenames are supported: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html

The following special characters are supported by the vzaar API:

  • a-z
  • A-Z
  • 0-9
  • Space
  • - (dash)
  • . (dot)
  • ! (exclamation)
  • () (braces)

Previous versions of vzaar gem

This version is not backwards compatible with any of the previous versions of vzaar gem (0.2.x series). 0.2.x series is no longer maintained.


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request


Released under the MIT License.