Release NotesUser InterfaceSystem Status
API Reference

Workflow Overview

API Workflow Overview

API Workflow Overview

The Encoding.com API allows you to automate your high volume workflow by integrating an incredibly fast media processing platform that scales without limits with your, CMS, asset management platform, or application.

Our declarative API is the most mature, well-documented and feature-rich cloud encoding API on the market. Our API Builder will help generate properly formatted job requests, which you can use to build and test your JSON or XML job descriptions before writing a single line of code.

The majority of requests to our API include either the AddMedia or AddMediaBenchmark action request to Encoding.com, which includes:

📘

Encoding.com responds immediately with a media ID so your application can track the progress of the job. If there's an error in the request, the response will include a human-readable description of the cause.

With the fastest SLA-backed queue times in the industry, Encoding.com processes all of your jobs in parallel on dedicated multi core servers. Our platform orchestrator scales and assigns compute in realtime based on your needs. If you send us 1 job with 1 output, it will process just as quickly as if you send us 250 jobs each with 10 outputs.

When processing is complete, we will automatically deliver your output to your specified destination, and send a web, message queue, or email notification to your application. If you need to whitelist an IP for notification requests, they will come from "34.193.0.100/32" and "100.24.75.0/32". See our help article for a complete list of IP ranges if you are interested in allowing firewall access. However, please note the IP addresses within a public cloud environment are subject to change often and without notice.

Our API can be quickly integrated into applications written in any programming language. To accelerate your development, we provide and support code libraries in many popular languages: PHP, Java , CFM, C#. There are also dozens of unofficial code libraries.

📘

Some API features to highlight:

  • For more verbose reporting throughout your pipelines, use the GetStatus or GetStatusExtended action requests. These will deliver individual job progress per media ID throughout all phases of the job. Possible status results are: New, Downloading, Downloaded, Ready to process, Waiting for encoder, Processing, Saving, Finished, Error, Stopped.
  • A few highlights of editing features: watermarks, cropping, thumbnail generation, concatenation, picture in picture, custom text overlay.
  • To utilize conformance checks prior to processing, use GetmediaInfo to validate that a source asset has appropriate frame size, frame rate, colorspace, etc. prior to processing. Then your orchestration system can determine if changes need to take place prior to processing an asset.
  • Complete sub user account system lets you create, and manage sub-users, useful for isolating credentials and getting distinct reports on distinct workflow usage.