v1

latestOpenAPI 3.1.02026-07-24650272.2 KB

API Endpoints

Create Asset

An asset refers to a media content/video that is processed, stored, and delivered through Gumlet. This endpoint creates an asset allowing users to ingest media content into the Gumlet system for processing and delivery.

post/video/assets

Request body

inputstring required

URL or web address of a file that Gumlet should download to create a new asset.

collection_idstring required

Gumlet video workspace id.

profile_idstring

Provide profile_id of the previously created video profile. This parameter will override all the parameters (except input and collection_id) from the video profile.

format'ABR' | 'MP4' required

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

tagstring

Specify a text string or identifier which can identify an asset or bunch of assets later.

titlestring

Specify a text string or identifier which can be used for filtering or searching the asset.

descriptionstring

Attach some textual data with the asset. This field is neither searchable nor filterable.

metadatastring json

Add your metadata you want to associate with this asset.<br/> Example: <br/> <code> { "internal_video_id" : "123Abc" } </code>

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. Applicable only 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. Applicable only 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, 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.

playlist_idstring

Add this asset to a playlist.

folderstring

Add this asset to an existing folder by folder_id.

Response

200

asset_idstring

progressinteger

created_atinteger

updated_atinteger

statusstring

tagstring[]

source_idstring

collection_idstring

playlistsstring[]

Example response

{
  "asset_id": "65b168a6e99b77f116c0e488",
  "created_at": 1706125479006,
  "updated_at": 1706125479006,
  "status": "pre-queued",
  "tag": [
    "ball"
  ],
  "source_id": "646df1c9173a4a2fcac180b4",
  "collection_id": "646df1c9173a4a2fcac180b4",
  "input": {
    "transformations": {
      "format": "hls",
      "resolution": [
        "360p"
      ],
      "audio_codec": [
        "aac"
      ],
      "video_codec": [
        "libx264"
      ],
      "thumbnail": [
        "auto"
      ],
      "thumbnail_format": "png"
    },
    "profile_id": "646df1c9173a4a2fcac180b7",
    "title": "bipbopall",
    "description": "some description",
    "metadata": {
      "headermeta": "metavalue"
    },
    "source_url": "http://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8",
    "call_to_actions": [
      {
        "start_time": 1,
        "end_time": 90,
        "text": "some test",
        "url": "https://some-url.com",
        "position_from_top": 11,
        "position_from_right": 23,
        "border_radius": 11,
        "font_color": "#000001",
        "background_color": "#ffffff",
        "html_target": "_blank"
      }
    ]
  },
  "output": {
    "format": "hls",
    "status_url": "https://api.gumlet.com/v1/video/assets/65b168a6e99b77f116c0e488",
    "playback_url": "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/main.m3u8",
    "thumbnail_url": [
      "https://video.gumlet.io/646df1c9173a4a2fcac180b4/65b168a6e99b77f116c0e488/thumbnail-1-0.png?v=1706125479006"
    ]
  },
  "playlists": [
    "6597acd5ed6f26a9c5ca9633"
  ]
}