OCT-103 Gumlet outreach
POST/video/profiles/{profile_id}

Update a video profile

Updates an existing video profile with the settings you provide. Send only the settings you want to change; the profile's other settings remain unchanged.

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

1 parameter · 22 body fields
profile_idstringrequired

The ID of the video profile to update.

Optional video profile settings to update. The schema marks profile_id as required, but does not define it as a body property.

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.

formatstringoptional

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

Allowed:ABRMP4Default:ABR
generate_chaptersbooleanoptional

Whether Gumlet should generate chapters.

generate_descriptionbooleanoptional

Whether Gumlet should generate descriptions.

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). You can remove this object if you don't 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

namestringoptional

Profile name or identifier.

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

profile_idstringrequired

Profile id of the profile which needs to be deleted.

resolutionstringoptional

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.

text_overlayobjectoptional

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

transcribebooleanoptional

To generate the subtitles in the native audio.

Default:false
trimobjectoptional

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

vcarray<string>optional

Video Codecs

Default:["libx264"]
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 updated profile, including its ID, name, creation and update timestamps, and transformation settings.
created_atintegeroptional
Default:0
namestringoptional
profile_idstringoptional
transformationsobjectoptional
updated_atintegeroptional
Default:0
400Returned when the request is invalid.

One documented failure

  • parameter_missing

    One or more required values are missing.

errorobjectrequired
401Returned when the request has a missing or invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
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
404Returned when the profile is not found.

One documented failure

  • profile_not_found

    Could not find any video profile with specified profile_id.

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 is returned for a bad request. A 401 is returned when the request has a missing or invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions. A 404 is returned when the profile is not found. A 500 is returned for an internal server error. The request body schema marks profile_id as required, although it does not define that property. The profile_id path parameter must identify the profile to update.