Assets can be processed for image transformations, video transcodes and other custom workflows using /process
API.
The /process
API is useful in the following scenarios:-
- Create static image conversions that are not covered by On-demand Image Conversion
- Re-process a static image conversion to apply a new watermark
- Re-process an image if there are any on-demand image conversion errors
- Generate standard video transcodes that do not exist for a video file
- Re-apply a new watermark to existing video transcodes
Built-in Image processing keys
Key | Description |
---|---|
smart_imaging | Used for on-demand images and image annotation re-processing |
Also, once processing completes, Asset Data JSON will contain process state for smart_imaging
as below:
"addons_info": {
"ON_DEMAND_IMAGE": {
"available": true
}
}
Built-in Video processing keys
- Built-in keys that correspond to video quality and sizes:
360p-video
,480p-video
,720p-video
,1080p-video
,hls-video
- Watermarked transcodes:
360p-wm-video
,480p-wm-video
,720p-wm-video
,1080p-wm-video
For hls-video transcode, the source video must be equal or greater than 360 px in height. If a source video smaller than 360 px in height, please enable
UPSCALE
option in Video Settings forhls-video
to generate HLS transcodes. In general, you do not need a HLS video transcode for a video that is small as there is no bandwidth benefit for small videos.
Special video processing keys
Key | Description |
---|---|
clip_preview | Generate a preview clip of the video using user's settings profile |
storyboard | Generate a set of storyboard images for the video using user's video settings profile. STORYBOARD addon must be enabled for this. |
Note:
- That unknown keys and keys that do not apply to the file type will be ignored.
- This API returns job ID only for videos.
Once a image/video conversion is processed, callbacks are issued to registered webhooks.
HTTP Response
Standard HTTP Status code - 202 or 200
Key | Value | Description |
---|---|---|
status | string | Status of the process. Can be QUEUED or ERROR |
message | string | Message describing the status |
job_id | integer | Job ID of the process. Can be used to query the status of job using Job Status API |