OCT-103 Gumlet outreach
POST/video/profiles

Create a video profile

Creates a reusable video profile containing transformation settings for video assets. Supply a name and choose format; add optional settings such as resolution, overlays, cropping, or subtitle generation as needed. Reference the profile when creating videos that should use the same transformation parameters.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

18 body fields

Video profile name and transformation settings. name and format are required.

animated_gifobjectoptional

Create an animated GIF from a video.

audio_onlybooleanoptional

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

cropobjectoptional

This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.

enable_drmbooleanoptional

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

formatstringrequired

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

Allowed:ABRMP4Default:ABR
generate_subtitlesobjectoptional

Gumlet allows you to generate subtitles from the audio stream (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes). Remove this object if you do not want to generate AI subtitles.

heightstringoptional

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.

image_overlayobjectoptional

Image overlay can be used to brand a video or add a visual label in the form of an image.

mp4_accessbooleanoptional

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

namestringrequired

Profile name or identifier.

Default:Gumlet-Profile-1
padobjectoptional

This transformation can be used to add padding to the video.

per_title_encodingbooleanoptional

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_inputbooleanoptional

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

resolutionstringoptional

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. Resized rendition will retain the input aspect ratio.

text_overlayobjectoptional

Text overlay can be used to brand a video or add a label in the form of text.

transcribebooleanoptional

This will generate the subtitles in the native audio.

Default:false
trimobjectoptional

Trim transformation can be used to trim videos based on time duration.

widthstringoptional

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.

6 status codes
200Returns the created profile, including its name, generated profile identifier, creation time, and transformation settings.
created_atintegeroptional
Default:0
namestringoptional
profile_idstringoptional
transformationsobjectoptional
400Returned when the request is invalid.

One documented failure

  • parameter_missing

    video output format (format) and profile name (name) are required to create profile.

errorobjectrequired
401Returned when the request is unauthorized.

One documented failure

  • profile_not_found

    Could not find any video profile with specified profile_id.

errorobjectoptional
403Returned when the account is unpaid or the authenticated user has insufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired
500Returned when an internal server error occurs.

One documented failure

  • internal_server_error

    We have encountered some server error. We have been notified and will fix it soon.

errorobjectrequired

Error handling

A 400 indicates a bad request; a 401 indicates an unauthorized request; a 403 indicates an unpaid account or insufficient role permissions. A 422 indicates request validation failed, and a 500 indicates an internal server error. name and format are required, and format must be ABR or MP4; crop requires width and height, image_overlay requires url, and text_overlay requires text.