Introduction

Welcome to Hybrik — Dolby's cloud media processing service. Every element of the Hybrik workflow can be managed through Hybrik's RESTful API. This includes transcoding, quality control, data transfers, etc. Even complex workflows with conditional execution and scripting can be designed and implemented using the Hybrik API. When defining transcodes through the API, users can reference pre-configured presets or explicitly define the complete encode pipeline. The API uses JSON structures for the definition of each element.

All Hybrik API submissions are via the HTTP commands POST, PUT, GET, and DELETE. The API uses HTTP authentication for permitting API access, and a user-specific login call which returns an expiring token. This token needs to be passed into all API calls as part of the header.

A typical API session to submit and track a transcoding job would look like this:

• Step 1 - Authenticate User (returns security token used in following calls)
• Step 2 - Create Job (submits your job in JSON format)
• Step 3 - Get Job Info (tracks status of your job)
• Step 4 - Get Job Result (complete details of your job after completion or failure)

At the bottom of this document are downloadable samples for both JSON jobs as well as JavaScript libraries for easily incorporating the Hybrik API into your projects.

REST Arguments

The Hybrik REST API follows REST conventions regarding the placement of arguments in a query string or in a request body. Some limitations apply however: The maximum number of array elements which can be passed via a query string is 250. If any array in your request is exceeding this length, the argument must be passed in the request body.

Generally, Hybrik will attempt to parse arguments from both locations, to overcome issues with maximum url length etc.