Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zencoder Jobs API

Operations for managing Zencoder encoding jobs.

Zencoder Jobs API is one of 5 APIs that Zencoder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 6 operations across 5 paths, and defines 21 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://app.zencoder.com/api/v2.

6 operations 5 paths 21 schemas 3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://app.zencoder.com/api/v2
Resource Areas
1

Paths & Operations 6

Across 5 paths, the API surfaces 6 operations — 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Jobs 6

Operations for managing Zencoder encoding jobs.

POST
/jobs
Create an Encoding Job
createJob 2 params body → 200403422500
GET
/jobs
List jobs
getJobs 4 params → 200403422500
GET
/jobs/{job_id}
Get Job Details
getJob 5 params → 200403422500
PUT
/jobs/{job_id}/resubmit
Resubmit a Job
resubmitJob 5 params → 204409500
GET
/jobs/{job_id}/progress
Get Job Progress
getJobProgress 5 params → 200500
PUT
/jobs/{job_id}/cancel
Cancel a Job
cancelJob 3 params → 204409500

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are Output (128 properties), OutputMediaFile (28 properties), InputMediaFile (25 properties), DynamicProfileOptions (21 properties). Each schema is shown below with its type and property counts.

JobResponseFields
object
Hash of Zencoder job properties
8 properties 1 required
Stream
object
Playlist stream info
6 properties
Skip
object
An object containing conditions for skipping the output Note: Due to the nature of video metadata and inconsistencies between video types some source files may…
10 properties
DRM
object
Hash of DRM options
10 properties
Schema
object
2 properties
Notification
object
3 properties
OutputMediaFile
object
Object containing properties for an output media file.
28 properties
CreateJobFields
object
Hash of Zencoder job properties
16 properties 1 required
InputMediaFile
object
Object containing properties for the input media file.
25 properties
Thumbnail
object
Hash of thumbnail properties
3 properties
CreateJobResponse
object
Success response for job creation
2 properties
Watermark
object
Hash of watermark properties
7 properties
GetProgressResponse
object
4 properties
DynamicProfileOptions
object
'hash of options for CAE (Context Aware Encoding) jobs. With CAE the number of outputs and parameters of such outputs may change dynamically for each input fil…
21 properties
MasterDisplay
object
Hash of HDR10 output settings
5 properties
OutputProgressResponse
object
Progress in the processing of a job input file
5 properties
InputProgressResponse
object
Progress in the processing of a job input file
5 properties
Output
object
128 properties
CuePoint
object
Zencoder supports adding event and navigation cue points to VP6 Flash Video (FLV) files. Cue points are embedded in the FLV stream and FLV metadata packet when…
4 properties
AlternateAudio
object
Provides a set of alternate audio streams for HLS playlists. Requires maxhlsprotocolversion to be 4 or greater. This option will insert EXT-X-MEDIA tags into t…
ListJobsResponse
array
Success response for list jobs request

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zencoder-jobs-api-openapi.yml Raw ↑

Other APIs Zencoder publishes across the network.

Zencoder Accounts API
Zencoder Inputs API
Zencoder Outputs API
Zencoder Reports API