Create a job
Endpoint: POST /v2/jobs
When the job is successfully submitted:
If there is an error with the request:
You can find the list of error codes here.
Getting information about a job
Endpoint: GET /v2/jobs/:jobid
Here are the list of status you can see:
By using if, you can choose if an output needs to be processed or not according to a condition. If the condition returns false, then the output will be skipped.
You won't want to convert a 720p video to 4k output, that would be a waste of time, space and money. So to avoid that, we've created those conditional outputs to help you:
Detecting portrait or landscape videos
Sometimes you want to use different resolution depending on the orientation. Here is an example for both portrait and landscape which takes into account the rotation metadata + source resolution:
Same output format with different settings
There are many reasons why you would want to create multiple outputs with the same format but different settings, like generating regular thumbnails and squared ones with the same resolution, or even creating a trailer by cutting the output.
Here is an example:
Note that if you don't provide a key, it will be generated for you following this rule: format:index.
If enable, the input video is split into small chunks that are transcoded in parallel over multiple servers. The speed is greatly increased, for instance, you can expect x5 speed for 4k outputs.
We advise to use the Ultrafast mode in the following cases:
- If your videos are longer than 10 minutes
- Your job includes 1080p and 4k outputs
- Any HEVC transcoding
Note that ultrasfast only works for videos longer than a minute.
Here are the built-in variables usable in the job request: