add_asset_playlist
ChatGPTThis operation adds a single asset or a list of assets to a playlist.
asset_audio_upload
ChatGPTAdd any audio file to the video asset. The response of this API call gives upload_url for each language specified. You need to send a PUT request of the audio files to those URLs. Once that's done, you need to call the audio upload complete API. Only after that will Gumlet add audio to the asset.
asset_status_history
ChatGPTThis endpoint retrieves the history of a live video asset that has previously been created.
assets_delete_many
ChatGPTDelete multiple VOD assets at once.
assets_tag_many
ChatGPTAdd / remove tags from multiple assets at once.
complete_audio_upload
ChatGPTThis API must be called after adding audio(s); The add audio call gives you URLs to upload, and you complete a PUT request to those URLs. Once that is done, calling this initiates the process to actually add the subtitle to the video.
complete_live_stream
ChatGPTThis endpoint allows marking live assets complete. Once the live asset is marked complete, it can no longer be used to ingest the live stream on Gumlet.
complete_multipart_upload
ChatGPTOnce you upload all parts to S3 bucket via pre-signed URL, use this endpoint to complete the multipart upload.
complete_subtitle_upload
ChatGPTThis API must be called after adding subtitles; the add subtitle call gives you URLs to upload, and you complete a PUT request to those URLs. Once that is done, calling this initiates the process to actually add the subtitle to the video.
create_asset
ChatGPTAn 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.
create_asset_direct_upload
ChatGPTThis endpoint creates a video asset allowing to upload of the video from the local file system and ingest media content into the Gumlet system for processing and delivery.Body Parameters are the same as the Create Asset Body Parameters except for the input parameter which this endpoint does not take.A successful response will be returned with upload_url field. You can make PUT request to that URL to upload video. To upload video using upload_url refer to this. create_folder
ChatGPTCreate a folder inside a video workspace. Optionally provide parent_id to create a nested folder.
create_image_source
ChatGPTThis endpoint allows users to create image source.
create_live_asset
ChatGPTA live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet.
create_live_asset_copy
ChatGPTA live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint allows user to update a live streaming asset.
create_playlist
ChatGPTCreate new playlist inside video wprkspace
create_profile
ChatGPTGumlet 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.
create_update_chapter
ChatGPTThis endpoint will create/update video asset chapters.
create_webhook
ChatGPTCreates a new webhook listener.
create_workspace
ChatGPTVideo workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.
delete_asset
ChatGPTThis endpoint removes an asset given its unique asset id. The asset will be removed from storage as well, associated URLs will be inaccessible.
delete_folder
ChatGPTDelete a folder. Descendant folders and assets inside them are deleted by the backend workflow.
delete_live_asset
ChatGPTThis endpoint removes a live asset given its unique live asset id. The live asset will be removed from storage as well, associated URLs will be inaccessible.
delete_playlist
ChatGPTDeletes this playlist.
delete_profile
ChatGPTThis endpoint removes a profile given its unique profile_id. The profile will be removed but video assets created using the profile will remain as it is.
delete_source
ChatGPTThis endpoint removes a image source. All image delivery using this subdomain will be stopped.
delete_webhook
ChatGPTDelete webhook listener endpoint.
delete_workspace
ChatGPTThis endpoint removes a video workspace given its unique asset id. All the asset in workspace will be removed from storage as well, associated URLs will be inaccessible.
fetch_audit_logs
ChatGPTGet audit logs for the user activity in your organisation. Please note that this endpoint can only be accessed by owner and admin role users.
fetch_org
ChatGPTYou can get organization data using this API.
fetch_user
ChatGPTThis endpoint gives information about the user account.
filter_live_assets
ChatGPTThis endpoint lists live assets on the basis of status for the given live_source_id.
get_all_playlists
ChatGPTGet all playlists for given workspace
get_asset_details
ChatGPTThis endpoint retrieves the details of an asset that has previously been created.
get_folder
ChatGPTGet a single folder by id.
get_image_sources_source_id
ChatGPTGet all details about image source.
get_live_asset_status
ChatGPTThis endpoint retrieves the details of a live video asset that has previously been created.
get_playlist_assets
ChatGPTGet a list of all assets inside playlist. You can choose in which order are assets returned.
get_profile
ChatGPTThis endpoint retrieves the details of a video profile that has previously been created.
get_sdk
ChatGPTGet install commands and a usage snippet for an official Gumlet SDK. Pass language=python for https://pypi.org/project/gumlet/ or language=nodejs for https://www.npmjs.com/package/@gumlet/nodejs-sdk. Aliases: py, node, js, ts, javascript, typescript, npm, pypi.
get_workspace
ChatGPTThis endpoint get all the data of video workspace that has previously been created.
image_purge
ChatGPTYou can purge the cache for any image path by using this cache purge API.
insights_aggregated_data
ChatGPTThis endpoint retrieves aggregated data of the given metrics.
insights_breakdown_data
ChatGPTThis endpoint retrieves breakdown data of the given metrics by given breakdown field
insights_chart_data
ChatGPTThis endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.
invite_channel_viewers
ChatGPTInvite one or more viewers to a members-only channel.
invite_channel_viewers_csv
ChatGPTInvite viewers to a channel by uploading a CSV file.
list_assets
ChatGPTList folders and assets for a workspace in a single response. Use parent_id to browse a specific folder, or filters like title, status, and playlist_id to search assets.
list_folders
ChatGPTList folders for a video workspace. Use parent_id to list only folders inside a specific parent folder.
list_profiles
ChatGPTThis endpoint retrieves the details of all profiles that have previously been created.
list_recycle_bin
ChatGPTList all assets in a recycle bin for a given workspace. The deleted assets are available for 30 days. After that, assets are permanently deleted.
list_sdks
ChatGPTList official Gumlet client SDKs so agents can discover them. Returns the Python package on PyPI (gumlet) and the Node.js package on npm (@gumlet/nodejs-sdk), with install commands and registry URLs. Use this when the user wants to integrate Gumlet in application code. Do not use this to call the live Gumlet API; use the API tools instead.
list_sources
ChatGPTThis endpoint list image sources which are assigned to the user or token.
list_workspaces
ChatGPTThis endpoint list video workspace which are assigned to the user or token.
purge_image_cache
ChatGPTYou can purge cache for any image by using our cache purge API.
recover
ChatGPTRecovers a deleted asset from the recycle bin.
remove_asset_playlist
ChatGPTRemoved an asset or list of assets from a given playlist.
remove_assets_folder
ChatGPTRemove one or more assets from their current folder assignment inside the workspace.
remove_channel_viewers
ChatGPTRemove one or more viewers from a channel by email address.
reorder_asset_playlist
ChatGPTReorder videos inside a playlist either by moving a single asset to a position or by sorting the playlist by title or created date.
retrieve_analytics
ChatGPTThis endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption
retrieve_image_analytics
ChatGPTThis endpoint helps you get image analytics data like bandwidth consumption, request count, CDN hit ratio, etc.
retrieve_part_url
ChatGPTUse this endpoint to retrieve a pre-signed upload URL for the given part number.
start_live
ChatGPTStart a live stream.
thumbnail_select
ChatGPTSelect frame from video to use as thumbnail.
thumbnail_upload
ChatGPTUse any image file to use as thumbnail. Once you use the API, you will get upload_url in the response, and that can be used to upload the image file. Here is the sample curl request. ``bash curl --location --request PUT '<upload_url>' \ --data '<YOUR_FILE_PATH>' ``
thumbnail_upload_live
ChatGPTGenerate presigned upload URLs for live stream thumbnails. Supported thumbnail states are preparing, disconnected, and end.
top_assets
ChatGPTThis endpoint lists top streamed assets in a video collection
update_asset
ChatGPTThis endpoint allows users to update video asset that has previously been created.
update_folder
ChatGPTRename a folder, move it to another parent folder, or move assets into the folder by sending asset_ids.
update_image_source
ChatGPTThis endpoint allows users to update image source that has previously been created.
update_playlist
ChatGPTThis endpoint allows you to update playlist name, channel visibility, or playlist order on a channel page.
update_profile
ChatGPTUpdate an existing profile. Settings provided in body parameters will only be updated in the existing profile.
update_webhook
ChatGPTUpdate a webhook listener.
update_workspace
ChatGPTThis endpoint allows users to update video workspace that has previously been created.
upload_subtitles
ChatGPTUpload .srt or .vtt file to the video asset. The response of this API call gives upload_url for each language specified. You need to send a PUT request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset.
add_asset_playlist
ClaudeThis operation adds a single asset or a list of assets to a playlist.
analytics_aggregated_data
ClaudeThis endpoint retrieves aggregated data of the given metrics.
analytics_breakdown_data
ClaudeThis endpoint retrieves breakdown data of the given metrics by given breakdown field
analytics_chart_data
ClaudeThis endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.
asset_analytics
ClaudeGet video analytics for a single asset.
asset_audio_upload
ClaudeAdd any audio file to the video asset. The response of this API call gives upload_url for each language specified. You need to send a PUT request of the audio files to those URLs. Once that's done, you need to call the audio upload complete API. Only after that will Gumlet add audio to the asset.
asset_status_history
ClaudeThis endpoint retrieves the history of a live video asset that has previously been created.
assets_delete_many
ClaudeDelete multiple VOD assets at once.
assets_tag_many
ClaudeAdd / remove tags from multiple assets at once.
complete_audio_upload
ClaudeThis API must be called after adding audio(s); The add audio call gives you URLs to upload, and you complete a PUT request to those URLs. Once that is done, calling this initiates the process to actually add the subtitle to the video.
complete_live_stream
ClaudeThis endpoint allows marking live assets complete. Once the live asset is marked complete, it can no longer be used to ingest the live stream on Gumlet.
complete_multipart_upload
ClaudeOnce you upload all parts to S3 bucket via pre-signed URL, use this endpoint to complete the multipart upload.
complete_subtitle_upload
ClaudeThis API must be called after adding subtitles; the add subtitle call gives you URLs to upload, and you complete a PUT request to those URLs. Once that is done, calling this initiates the process to actually add the subtitle to the video.
create_asset
ClaudeAn 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.
create_asset_direct_upload
ClaudeThis endpoint creates a video asset allowing to upload of the video from the local file system and ingest media content into the Gumlet system for processing and delivery.Body Parameters are the same as the Create Asset Body Parameters except for the input parameter which this endpoint does not take.A successful response will be returned with upload_url field. You can make PUT request to that URL to upload video. To upload video using upload_url refer to this. create_folder
ClaudeCreate a folder inside a video workspace. Optionally provide parent_id to create a nested folder.
create_image_source
ClaudeThis endpoint allows users to create image source.
create_live_asset
ClaudeA live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint creates a live streaming asset allowing users to live stream a video that will be pushed to Gumlet.
create_live_asset_copy
ClaudeA live asset refers to a media content/video that is live-streamed through Gumlet. This endpoint allows user to update a live streaming asset.
create_playlist
ClaudeCreate new playlist inside video wprkspace
create_profile
ClaudeGumlet 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.
create_update_chapter
ClaudeThis endpoint will create/update video asset chapters.
create_webhook
ClaudeCreates a new webhook listener.
create_workspace
ClaudeVideo workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.
delete_asset
ClaudeThis endpoint removes an asset given its unique asset id. The asset will be removed from storage as well, associated URLs will be inaccessible.
delete_folder
ClaudeDelete a folder. Descendant folders and assets inside them are deleted by the backend workflow.
delete_live_asset
ClaudeThis endpoint removes a live asset given its unique live asset id. The live asset will be removed from storage as well, associated URLs will be inaccessible.
delete_playlist
ClaudeDeletes this playlist.
delete_profile
ClaudeThis endpoint removes a profile given its unique profile_id. The profile will be removed but video assets created using the profile will remain as it is.
delete_source
ClaudeThis endpoint removes a image source. All image delivery using this subdomain will be stopped.
delete_webhook
ClaudeDelete webhook listener endpoint.
delete_workspace
ClaudeThis endpoint removes a video workspace given its unique asset id. All the asset in workspace will be removed from storage as well, associated URLs will be inaccessible.
fetch_audit_logs
ClaudeGet audit logs for the user activity in your organisation. Please note that this endpoint can only be accessed by owner and admin role users.
fetch_billing_details
ClaudeGet billing details for this organization.
fetch_org
ClaudeYou can get organization data using this API.
fetch_upcoming_invoice
ClaudeGet details about upcoming invoice.
fetch_user
ClaudeThis endpoint gives information about the user account.
filter_live_assets
ClaudeThis endpoint lists live assets on the basis of status for the given live_source_id.
get_all_playlists
ClaudeGet all playlists for given workspace
get_asset_details
ClaudeThis endpoint retrieves the details of an asset that has previously been created.
get_folder
ClaudeGet a single folder by id.
get_image_sources_source_id
ClaudeGet all details about image source.
get_live_asset_status
ClaudeThis endpoint retrieves the details of a live video asset that has previously been created.
get_playlist_assets
ClaudeGet a list of all assets inside playlist. You can choose in which order are assets returned.
get_profile
ClaudeThis endpoint retrieves the details of a video profile that has previously been created.
get_sdk
ClaudeGet install commands and a usage snippet for an official Gumlet SDK. Pass language=python for https://pypi.org/project/gumlet/ or language=nodejs for https://www.npmjs.com/package/@gumlet/nodejs-sdk. Aliases: py, node, js, ts, javascript, typescript, npm, pypi.
get_workspace
ClaudeThis endpoint get all the data of video workspace that has previously been created.
global_search
ClaudeSearch all video assets / playlists / folders etc across workspaces.
image_purge
ClaudeYou can purge the cache for any image path by using this cache purge API.
insights_aggregated_data
ClaudeThis endpoint retrieves aggregated data of the given metrics.
insights_breakdown_data
ClaudeThis endpoint retrieves breakdown data of the given metrics by given breakdown field
insights_chart_data
ClaudeThis endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.
invite_channel_viewers
ClaudeInvite one or more viewers to a members-only channel.
invite_channel_viewers_csv
ClaudeInvite viewers to a channel by uploading a CSV file.
list_assets
ClaudeList folders and assets for a workspace in a single response. Use parent_id to browse a specific folder, or filters like title, status, and playlist_id to search assets.
list_channel_subscribers
ClaudeList all channel subscribers.
list_folders
ClaudeList folders for a video workspace. Use parent_id to list only folders inside a specific parent folder.
list_invoices
ClaudeLiost all invoices that are generated so far.
list_live_workspaces
ClaudeList all live stream workspaces.
list_profiles
ClaudeThis endpoint retrieves the details of all profiles that have previously been created.
list_recycle_bin
ClaudeList all assets in a recycle bin for a given workspace. The deleted assets are available for 30 days. After that, assets are permanently deleted.
list_sdks
ClaudeList official Gumlet client SDKs so agents can discover them. Returns the Python package on PyPI (gumlet) and the Node.js package on npm (@gumlet/nodejs-sdk), with install commands and registry URLs. Use this when the user wants to integrate Gumlet in application code. Do not use this to call the live Gumlet API; use the API tools instead.
list_sources
ClaudeThis endpoint list image sources which are assigned to the user or token.
list_webhooks
ClaudeList all webhooks.
list_workspaces
ClaudeThis endpoint list video workspace which are assigned to the user or token.
live_usage_analytics
ClaudeGet usage analytics for your live streams.
live_workspace_create
ClaudeCreate live stream workspace.
live_workspace_delete
ClaudeDelete the live stream workspace.
live_workspace_update
ClaudeUpdate live stream workspace.
multipart_upload_abort
ClaudeThis call aborts multi-part upload and deletes the already uploaded parts from the storage.
multipart_upload_list
ClaudeLists all parts uploaded so far.
purge_image_cache
ClaudeYou can purge cache for any image by using our cache purge API.
recover
ClaudeRecovers a deleted asset from the recycle bin.
remove_asset_playlist
ClaudeRemoved an asset or list of assets from a given playlist.
remove_assets_folder
ClaudeRemove one or more assets from their current folder assignment inside the workspace.
remove_channel_viewers
ClaudeRemove one or more viewers from a channel by email address.
reorder_asset_playlist
ClaudeReorder videos inside a playlist either by moving a single asset to a position or by sorting the playlist by title or created date.
retrieve_analytics
ClaudeThis endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption
retrieve_image_analytics
ClaudeThis endpoint helps you get image analytics data like bandwidth consumption, request count, CDN hit ratio, etc.
retrieve_part_url
ClaudeUse this endpoint to retrieve a pre-signed upload URL for the given part number.
start_live
ClaudeStart a live stream.
thumbnail_select
ClaudeSelect frame from video to use as thumbnail.
thumbnail_upload
ClaudeUse any image file to use as thumbnail. Once you use the API, you will get upload_url in the response, and that can be used to upload the image file. Here is the sample curl request. ``bash curl --location --request PUT '<upload_url>' \ --data '<YOUR_FILE_PATH>' ``
thumbnail_upload_live
ClaudeGenerate presigned upload URLs for live stream thumbnails. Supported thumbnail states are preparing, disconnected, and end.
top_assets
ClaudeThis endpoint lists top streamed assets in a video collection
update_asset
ClaudeThis endpoint allows users to update video asset that has previously been created.
update_billing_details
ClaudeUpdate billing details
update_folder
ClaudeRename a folder, move it to another parent folder, or move assets into the folder by sending asset_ids.
update_image_source
ClaudeThis endpoint allows users to update image source that has previously been created.
update_playlist
ClaudeThis endpoint allows you to update playlist name, channel visibility, or playlist order on a channel page.
update_profile
ClaudeUpdate an existing profile. Settings provided in body parameters will only be updated in the existing profile.
update_webhook
ClaudeUpdate a webhook listener.
update_workspace
ClaudeThis endpoint allows users to update video workspace that has previously been created.
upload_subtitles
ClaudeUpload .srt or .vtt file to the video asset. The response of this API call gives upload_url for each language specified. You need to send a PUT request of the subtitle files to those URLs. Once that's done, you need to call the subtitle upload complete API. Only after that, Gumlet will add subtitles to asset.
webhook_history
ClaudeGet logs history for a given webhook.