Skip to main content

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 -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"
}'

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

ParameterTypeDescription
namestring

Profile name or identifier.

Required: true

formatstring

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

Required: true

descriptionstringSmall 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 -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"
}
}'

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 -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%"
}
}'

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#

ParameterTypeDescription
profile_idstringGumlet video profile id.
curl -L -X GET 'https://api.gumlet.com/v1/video/profiles/5feaf9a22e3cb37e8417174e' \
-H 'Authorization: Bearer <YOUR API KEY>'

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

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

Page size for the paginated list.

Default: 10

curl -L -X GET 'https://api.gumlet.com/v1/video/profiles' \
-H 'Authorization: Bearer <YOUR API KEY>'

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#

ParameterTypeDescription
profile_idstringprofile id for the previously created profile.
curl -L -X DELETE 'https://api.gumlet.com/v1/video/profiles/5feaf9a22e3cb37e8417174e' \
-H 'Authorization: Bearer <YOUR API KEY>'