v300 API Documentation
Introduction
Abstract
The uEncode API allows your software to communicate with our encoding platform. With it, you can create new jobs, get lists of running jobs and get details about specific jobs. A single job can produce an unlimited number of outputs from the source video. Each output can be either a video or a frame capture.
Audience
This documentation is primarily for application developers who engineer web-enabled software products. It may also be of interest to those who manage such projects.
Change Log
A list of features added and changes made in this version.
| Description | Breaking* | Notes |
| Changed API URLs. | YES | See release notes. |
| Changed how API requests are authorized. | YES | See release notes. |
| Changed the format of our job creation response. | YES | See Response. |
| Changed the format of our job completion callback. | YES | See Callback. |
| New API call - Get list of active jobs. | No | See List Jobs. |
| New API call - Get details about a job. | No | See Job Details. |
| Added H.264 profile selection. | No | See <profile>. |
| Added quality setting for video. | No | See <quality>. |
| Added quality setting for audio. | No | See <quality>. |
| Added "total N" capture rate. | No | See <rate>. |
| Added WebM output container support. | No | See <video>. |
| Added VP8 video output codec support. | No | See <video>. |
| Added Vorbis audio output codec support. | No | See <audio>. |
| Added video clipping. | No | See <clip>. |
| Added image overlay. | No | See <overlay>. |
| Added meta-data support. | No | See <meta>. |
| * This feature is substantially different from the previous version. If any feature is indicated as breaking, existing systems will need to be changed prior to upgrading to this version. | ||
Release Notes
URLs
This version changes the URL format used for all API requests. The new syntax is not backward-compatible with prior versions. See requests for details.
Old
Previously, you would include the API version as a query-string variable:
New
Now, you include it in the URL. The new URL for the call above would be:
Authorization
This version changes the way that you indicate your API access key when making requests. The new syntax is not backward-compatible with prior versions. See requests for details.
Old
Previously, you would include your API access key inside the body of your request:
New
Now, you include it in the "Authorization" header:
