Guides

Process

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

KeyDescription
smart_imagingUsed 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

Special video processing keys

KeyDescription
clip_previewGenerate a preview clip of the video using user's settings profile
storyboardGenerate a set of storyboard images for the video using user's video settings profile. STORYBOARD addon must be enabled for this.

Note:

  1. That unknown keys and keys that do not apply to the file type will be ignored.
  2. 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

KeyValueDescription
statusstringStatus of the process. Can be QUEUED or ERROR
messagestringMessage describing the status
job_idintegerJob ID of the process. Can be used to query the status of job using Job Status API
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!