Currently, these APIs are in private beta, please contact support@gumlet.com for enabling them.
Every request to the API is authenticated via an API Token. Bearer authentication works by providing the API key in the request header. Specifically, the header looks something like this:
'authorization': 'Bearer <YOUR API KEY>'
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.
Parameter | Type | Description |
input |
| URL or web address of a file that Gumlet should download to create a new asset. Required: |
source_id |
| Gumlet video source id. Required: |
| Provide profile_id of the previously created profile. This parameter will override all the parameters (except | |
format |
| Transcode and deliver the asset in the requested format. The options can be one of Required: |
tag |
| Specify a text string or identifier which can identify an asset or bunch of assets later. |
width |
| Resize video with the given width. Can be an absolute value in pixels or a percentage value with the |
height |
| Resize video with the given height. Can be an absolute value in pixels or a percentage value with the |
resolution |
| Required resolutions of the transformed asset in case of Default: all resolutions from |
crop |
| This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video. |
pad |
| This transformation can be used to add padding to the video. |
trim |
| Trim transformation can be used to trim videos based on time duration. |
| Image overlay can be used to brand a video or add a visual label in the form of an image. | |
| Text overlay can be used to brand a video or add a label in the form of text. | |
vc |
| Specify video codec for the asset. The options can be one of Default: |
ac |
| Specify audio codec for the asset. The options can be one of Default: |
thumbnail |
| This parameter can be used to control which frame is captured from the video as the thumbnail. Can be one or more (comma-separated) of the following values: A float representing the time in seconds from the beginning of the video e.g. Default: |
thumbnail_format |
| Specify the thumbnail image format. Supported formats are Default: |
mp4_access |
| Creates Default: |
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_1.mp4","source_id": "5f462c1561cf8a766464ffc4","format": "hls"}'
{"asset_id": "5fce1951df953f1e913f4604","progress": 0,"created_at": 1607342417707,"status": "queued","tag": "","input": {"transformations": {"resolution": [],"thumbnail": ["auto"],"format": "hls","video_codec": "libx264","audio_codec": "aac","thumbnail_format": "png","mp4_access": false},"source_url": "https://gumlet.sgp1.digitaloceanspaces.com/video/sample_1.mp4"},"output": {"status_url": "https://api.gumlet.com/video/v1/status/5fce1951df953f1e913f4604","playback_url": "https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/1.m3u8","thumbnail_url": ["https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/thumbnail-1-0.png"]}}
This endpoint retrieves the details of an asset that has previously been created. Given the unique asset_id
, Gumlet will return the corresponding asset status.
Parameter | Type | Description |
asset_id |
| An asset id for the previously created asset. |
curl -L -X GET 'https://api.gumlet.com/v1/video/assets/5fce1951df953f1e913f4604' \-H 'Authorization: Bearer <YOUR_API_KEY>'
{"asset_id": "5fce1951df953f1e913f4604","progress": 100,"created_at": 1607342417707,"status": "ready","tag": "","input": {"transformations": {"resolution": [],"thumbnail": ["auto"],"format": "hls","video_codec": "libx264","audio_codec": "aac","thumbnail_format": "png","mp4_access": false},"source_url": "https://gumlet.sgp1.digitaloceanspaces.com/video/sample_1.mp4","size": 15240078,"duration": 20.32,"aspect_ratio": "16:9","fps": "30000/1001","width": 1920,"height": 1080},"output": {"status_url": "https://api.gumlet.com/video/v1/status/5fce1951df953f1e913f4604","playback_url": "https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/1.m3u8","thumbnail_url": ["https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/thumbnail-1-0.png"],"storage_bytes": 54149281},"processed_at": 1607342550068}
This endpoint list assets on the basis of status
and tag
for the given source_id
. Gumlet will return all assets under the source_id
if none of them is passed.
Parameter | Type | Description |
source_id |
| Gumlet video source id. |
Parameter | Type | Description |
status |
| To filter assets on the basis of their current status. Can be specified as a single status value string or comma-separated status values. The status value can be one of Default: |
tag |
| Input tag on the basis of which assets need to be filtered. |
offset |
| Offset value for a paginated list of assets. |
size |
| Page size for the paginated list. Default: |
curl -L -X GET 'https://api.gumlet.com/v1/video/assets/list/5f462c1561cf8a766464ffc4?offset=0&size=1&tag=Gumlet' \-H 'authorization: Bearer <YOUR_API_KEY>'
{"all_assets": [{"asset_id": "5fce1951df953f1e913f4604","progress": 100,"created_at": 1607342417707,"status": "ready","tag": "Gumlet","input": {"transformations": {"resolution": [],"thumbnail": ["auto"],"format": "hls","video_codec": "libx264","audio_codec": "aac","thumbnail_format": "png","mp4_access": false},"source_url": "https://gumlet.sgp1.digitaloceanspaces.com/video/sample_1.mp4","size": 15240078,"duration": 20.32,"aspect_ratio": "16:9","fps": "30000/1001","width": 1920,"height": 1080},"output": {"status_url": "https://api.gumlet.com/video/v1/status/5fce1951df953f1e913f4604","playback_url": "https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/1.m3u8","thumbnail_url": ["https://video.gumlet.io/5f462c1561cf8a766464ffc4/5fce1951df953f1e913f4604/thumbnail-1-0.png"],"storage_bytes": 54149281},"processed_at": 1607342550068}],"total_asset_count": 21,"current_offset": 21}
This endpoint removes an asset given its unique asset id. The asset will be removed from storage as well, associated URLs will be inaccessible.
Parameter | Type | Description |
asset_id |
| An asset id for the previously created asset. |
curl -L -X DELETE 'http://api.gumlet.com/v1/video/assets/5f48b955115462793462ab03' \-H 'authorization: Bearer <YOUR_API_KEY>'
{}