Sign in

v1

latestOpenAPI 3.1.02026-07-24650272.2 KB
API Endpoints

Create Profile

Gumlet provides the functionality of creating multiple video assets using the same set of parameters. A Video profile is a set of parameters that can be referenced/used while creating a video as a single parameter.

post/video/profiles

Request body

namestring required

Profile name or identifier.

format'ABR' | 'MP4' required

Transcode and deliver the asset in the requested format. The options can be one of ABR (HLS + DASH) and MP4.

widthstring

Resize video with the given width. Can be an absolute value in pixels or a percentage value with the % suffix. Specified values greater than the original asset width will be ignored. Only applicable when specified format is MP4.

heightstring

Resize video with the given height. Can be an absolute value in pixels or a percentage value with the % suffix. Specified values greater than the original asset height will be ignored. Only applicable when specified format is MP4.

resolutionstring

Required resolutions of the transformed asset in case of HLS or MPEG-DASH delivery format. Can be a comma separated string out of the following values: 240p, 360p, 480p, 540p, 720p, and 1080p . Re-sized rendition will retain the input aspect ratio.

mp4_accessboolean

Creates mp4 version for download purpose in case of MPEG-DASH or HLS delivery format. Default: false

per_title_encodingboolean

Gumlet analyzes each input video on a wide range of visual aspects. Based on the analysis, it chooses a unique set of transcoding options for processing the video. This ensures that the output video is of optimal size and best quality. Default: true

process_low_resolution_inputboolean

Currently, the minimum supported frame size is 57600 (240x240) pixels for HLS/DASH and 21025 (145x145) pixels for MP4 format. However, enabling this flag will allow Gumlet to simply put your video asset into the specified delivery format without transcoding and optimization. Enabling this flag will cause any kind of specified video transformation to be ignored if you input video asset frame size is lower than the minimum supported frame size for the specified format. Default: false

audio_onlyboolean

This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case, video transformation and thumbnails/animated GIFs would not be created. Default: false

enable_drmboolean

Enable DRM encryption for transcoded videos. Gumlet supports Widevine and Fairplay DRMs.

Response

200

profile_idstring
namestring
created_atinteger

Example response

{
  "profile_id": "61921fb10822a81d955d1730",
  "name": "Gumlet-Profile-1",
  "transformations": {
    "format": "hls",
    "audio_codec": [
      "aac"
    ],
    "video_codec": [
      "libx264"
    ],
    "thumbnail": [
      "auto"
    ],
    "thumbnail_format": "png",
    "per_title_encoding": true
  },
  "created_at": 1636966321742
}