Video Profile

Complete API reference for video 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.

cURL
response
cURL
curl -L -X POST 'https://api.gumlet.com/v1/video/assets' \
-H 'Authorization: Bearer <YOUR API KEY>' \
-H 'Content-Type: application/json' \
-d '{
"input":"https://gumlet.sgp1.digitaloceanspaces.com/video/sample_2.mp4",
"source_id": "5f462c1561cf8a766464ffc4",
"profile_id": "5feaf9a22e3cb37e8417174e"
}'
response
{
"asset_id": "5fec393f2e3cb35e34172cbf",
"progress": 0,
"created_at": 1609316671913,
"status": "queued",
"input": {
"transformations": {
"resolution": [],
"thumbnail": [
"auto"
],
"format": "hls",
"video_codec": "libx264",
"audio_codec": "aac",
"text_overlay": {
"text": "Gumlet",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "10%",
"horizontal_margin": "10%",
"font_color": "black",
"font": "sans",
"font_size": 45,
"box": true,
"box_color": "white",
"box_border": 10
},
"thumbnail_format": "png",
"mp4_access": false,
"image_overlay": {
"url": "https://assets.gumlet.io/assets/logo.svg?format=png",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "5%",
"horizontal_margin": "5%",
"width": "10%",
"height": "10%"
}
},
"profile_id": "5feaf9a22e3cb37e8417174e",
"source_url": "https://gumlet.sgp1.digitaloceanspaces.com/video/sample_2.mp4"
},
"output": {
"status_url": "https://api.gumlet.com/video/v1/status/5fec393f2e3cb35e34172cbf",
"playback_url": "https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fec393f2e3cb35e34172cbf/1.m3u8",
"thumbnail_url": [
"https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fec393f2e3cb35e34172cbf/thumbnail-1-0.png"
]
}
}

POST Create Profile

https://api.gumlet.com/v1/video/profiles

A video profile refers to a set of video asset parameter which can be stored and later used to create a video asset.

Body Parameters

Parameter

Type

Description

name

string

Profile name or identifier.

Required: true

format

string

Transcode and deliver the asset in the requested format. The options can be one of mp4, HLS, MPEG-DASH, mkv, and webm.

Required: true

description

string

Small text describing the profile.

Video Profile supports all video asset create request body parameters except input and source_id(which are individual to an asset).

cURL
response
cURL
curl -L -X POST 'https://api.gumlet.com/v1/video/profiles' \
-H 'Authorization: Bearer <YOUR API KEY>' \
-H 'Content-Type: application/json' \
-d '{
"name": "Gumlet Video Profile-1"
"format": "hls",
"text_overlay": {
"text": "Gumlet",
"horizontal_margin": "10%",
"vertical_margin": "10%",
"vertical_align": "top",
"horizontal_align": "left",
"color": "black",
"font_size": "45",
"box": true,
"box_color": "white",
"box_border": "10"
}
}'
response
{
"profile_id": "5feaf9a22e3cb37e8417174e",
"name": "Gumlet Video Profile-1"
"transformations": {
"format": "hls",
"video_codec": "libx264",
"audio_codec": "aac",
"text_overlay": {
"text": "Gumlet",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "10%",
"horizontal_margin": "10%",
"font_color": "black",
"font": "sans",
"font_size": 45,
"box": true,
"box_color": "white",
"box_border": 10
},
"thumbnail": [
"auto"
],
"thumbnail_format": "png",
"mp4_access": false
},
"created_at": 1609234850093
}

POST Update Profile

https://api.gumlet.com/v1/video/profiles/:profile_id

Update an existing profile. Settings provided in body parameters will only be updated in the existing profile. profile_id is the required parameter for updating a video profile.

cURL
response
cURL
curl -L -X POST 'https://api.gumlet.com/v1/video/profiles/5feaf9a22e3cb37e8417174e' \
-H 'Authorization: Bearer <YOUR API KEY>' \
-H 'Content-Type: application/json' \
-d '{
"image_overlay": {
"url": "https://assets.gumlet.io/assets/logo.svg?format=png",
"height": "10%",
"width": "10%",
"horizontal_align": "left",
"horizontal_margin": "5%",
"vertical_align": "top",
"vertical_margin": "5%"
}
}'
response
{
"profile_id": "5feaf9a22e3cb37e8417174e",
"transformations": {
"resolution": [],
"thumbnail": [
"auto"
],
"format": "hls",
"video_codec": "libx264",
"audio_codec": "aac",
"text_overlay": {
"text": "Gumlet",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "10%",
"horizontal_margin": "10%",
"font_color": "black",
"font": "sans",
"font_size": 45,
"box": true,
"box_color": "white",
"box_border": 10
},
"thumbnail_format": "png",
"mp4_access": false,
"image_overlay": {
"url": "https://assets.gumlet.io/assets/logo.svg?format=png",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "5%",
"horizontal_margin": "5%",
"width": "10%",
"height": "10%"
}
},
"created_at": 1609234850093,
"updated_at": 1609235119156
}

GET Profile Status

https://api.gumlet.com/v1/video/profiles/:profile_id

This endpoint retrieves the details of a video profile that has previously been created. Given the unique profile_id, Gumlet will return the corresponding profile status.

Path Parameters

Parameter

Type

Description

profile_id

string

Gumlet video profile id.

cURL
response
cURL
curl -L -X GET 'https://api.gumlet.com/v1/video/profiles/5feaf9a22e3cb37e8417174e' \
-H 'Authorization: Bearer <YOUR API KEY>'
response
{
"profile_id": "5feaf9a22e3cb37e8417174e",
"transformations": {
"resolution": [],
"thumbnail": [
"auto"
],
"format": "hls",
"video_codec": "libx264",
"audio_codec": "aac",
"text_overlay": {
"text": "Gumlet",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "10%",
"horizontal_margin": "10%",
"font_color": "black",
"font": "sans",
"font_size": 45,
"box": true,
"box_color": "white",
"box_border": 10
},
"thumbnail_format": "png",
"mp4_access": false,
"image_overlay": {
"url": "https://assets.gumlet.io/assets/logo.svg?format=png",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "5%",
"horizontal_margin": "5%",
"width": "10%",
"height": "10%"
}
},
"created_at": 1609234850093,
"updated_at": 1609235119156
}

GET List Profiles

https://api.gumlet.com/v1/video/profiles

This endpoint retrieves the details of all profiles that have previously been created.

Query Parameters

Parameter

Type

Description

offset

integer

Offset value for a paginated list of profiles. Can be zero for the first time andcurrent_offsetvalue received from the last request afterward.

size

integer

Page size for the paginated list.

Default: 10

cURL
response
cURL
curl -L -X GET 'https://api.gumlet.com/v1/video/profiles' \
-H 'Authorization: Bearer <YOUR API KEY>'
response
{
"all_profiles": [
{
"profile_id": "5feaf9a22e3cb37e8417174e",
"transformations": {
"resolution": [],
"thumbnail": [
"auto"
],
"format": "hls",
"video_codec": "libx264",
"audio_codec": "aac",
"text_overlay": {
"text": "Gumlet",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "10%",
"horizontal_margin": "10%",
"font_color": "black",
"font": "sans",
"font_size": 45,
"box": true,
"box_color": "white",
"box_border": 10
},
"thumbnail_format": "png",
"mp4_access": false,
"image_overlay": {
"url": "https://assets.gumlet.io/assets/logo.svg?format=png",
"vertical_align": "top",
"horizontal_align": "left",
"vertical_margin": "5%",
"horizontal_margin": "5%",
"width": "10%",
"height": "10%"
}
},
"created_at": 1609234850093,
"updated_at": 1609235119156
}
],
"total_profile_count": 1,
"current_offset": 1
}

DELETE Delete Profile

https://api.gumlet.com/v1/video/profiles/:profile_id

This endpoint removes a profile given its unique profile id. The profile will be removed but assets created using the profile will remain as it is.

Path Parameters

Parameter

Type

Description

profile_id

string

profile id for the previously created profile.

cURL
response
cURL
curl -L -X DELETE 'https://api.gumlet.com/v1/video/profiles/5feaf9a22e3cb37e8417174e' \
-H 'Authorization: Bearer <YOUR API KEY>'
response
{}