{"server":{"name":"Gumlet","version":"1.4","transport":"http","url":"https://mcp.gumlet.com/mcp/v1","docs":"https://docs.gumlet.com/reference/mcp"},"capabilities":{"tools":{"insights_chart_data":{"name":"insights_chart_data","description":"This endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.","inputSchema":{"type":"object","properties":{"metrics":{"items":{"type":"string"},"type":"array","description":"Get data for one or more `metrics` in the same request. Please add any of these metrics. `views`, `unique_views`, `impressions`. `completion_percent_by_views`, `playing_time`, `concurrent_users`, `widget_form_submitted`, `cta_clicks`"},"workspace_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet workspace ID available on the Video Workspaces."},"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. \nCurrently, we only support a maximum of *60 days* between `start_at` and `end_at`."},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Build *segments* of users using multiple filters on the data, `value` should be an *exact match*"},"group_by":{"type":"string","enum":["daily","weekly","monthly"],"description":"Data can be grouped by `daily`, `weekly` or `monthly`.","default":"daily"},"chart_dimension":{"properties":{"group_by":{"items":{"properties":{"name":{"type":"string","enum":["custom_video_title","custom_video_id","custom_workspace_id","video_source_url","video_source_format","player_software_version","player_software","meta_page_url","audio_language","subtitle_language","video_width_pixels","video_height_pixels","meta_country","meta_city","meta_device_category","meta_device_manufacturer","meta_browser","meta_browser_version","meta_browser_language","meta_operating_system","meta_operating_system_version","meta_device_name","meta_asn"]}},"type":"object"},"type":"array"}},"type":"object","description":"Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order."}},"required":[]}},"insights_breakdown_data":{"name":"insights_breakdown_data","description":"This endpoint retrieves breakdown data of the given metrics by given breakdown field","inputSchema":{"type":"object","properties":{"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. \nCurrently, we only support a maximum of *60 days* between `start_at` and `end_at`."},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Build *segments* of users using multiple filters on the data, `value` should be an *exact match*"},"breakdowns":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the field to break down the data by."},"metric":{"type":"string","enum":["views","unique_views","impressions","completion_percent_by_views","playing_time","concurrent_users","widget_form_submitted","cta_clicks"],"description":"The metric to retrieve breakdown data for."},"page":{"type":"integer","description":"Page number for paginated results.","default":1},"page_size":{"type":"integer","description":"Number of results per page.","default":100}},"type":"object","required":["name","metric"]},"type":"array","maxItems":3,"minItems":1,"description":"Breakdown fields and metrics to retrieve data for. Supports 1 to 3 breakdowns per request."},"workspace_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet workspace ID available on the Video Workspaces."}},"required":[]}},"insights_aggregated_data":{"name":"insights_aggregated_data","description":"This endpoint retrieves aggregated data of the given metrics.","inputSchema":{"type":"object","properties":{"aggregate":{"items":{"properties":{"metric":{"type":"string","enum":["views","unique_views","completion_percent_by_views","playing_time","concurrent_users","impressions","widget_form_submitted","cta_clicks"],"description":"The metric to be aggregated for this request."},"function":{"type":"string","enum":["sum","average"],"description":"Aggregation function which is to be used."}},"type":"object","required":["metric","function"]},"type":"array","description":"Aggregate multiple metrics at the same time"},"workspace_id":{"type":"string","description":"The unique identifier of the Gumlet workspace ID available on the Video Workspaces."},"timeframe":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","description":"The timeframe to get the data for. Currently we only support maximum difference between `start_at` and `end_at` to be *60 days*"},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_height_pixels","player_width_pixels","player_language_code","meta_page_url","meta_asn","custom_user_id","user_name","user_email","custom_video_id","custom_video_title","video_source_url","video_source_hostname","video_source_format","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Get aggregations for metrics with multiple filters, `value` should be an exact match"}},"required":[]}},"list_sdks":{"name":"list_sdks","description":"List 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.","inputSchema":{"additionalProperties":false,"properties":{},"type":"object"}},"get_sdk":{"name":"get_sdk","description":"Get 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.","inputSchema":{"additionalProperties":false,"properties":{"language":{"type":"string"}},"required":["language"],"type":"object"}},"create_asset":{"name":"create_asset","description":"An asset refers to 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.","inputSchema":{"type":"object","properties":{"input":{"type":"string","description":"URL or web address of a file that Gumlet should download to create a new asset."},"profile_id":{"type":"string","description":"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":{"type":"string","enum":["ABR","MP4"],"description":"Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`."},"tag":{"items":{"type":"string","x-stoplight":{"id":"ukzi2mra8hepj"}},"type":"array","description":"Specify a text string or identifier which can identify an asset or bunch of assets later."},"title":{"type":"string","description":"Specify a text string or identifier which can be used for filtering or searching the asset."},"description":{"type":"string","description":"Attach some textual data with the asset. This field is neither searchable nor filterable."},"metadata":{"properties":{},"additionalProperties":{},"type":"object","description":"Add your metadata you want to associate with this asset.<br/> Example: <br/> <code>  {  \"internal_video_id\" : \"123Abc\"  }  </code>","x-apidog-orders":[]},"width":{"type":"string","description":"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`."},"height":{"type":"string","description":"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`."},"resolution":{"type":"string","description":"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`. Resized rendition will retain the input aspect ratio."},"crop":{"properties":{"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"width":{"type":"string","description":"Width of the cropping area in pixels."},"height":{"type":"string","description":"Height of the cropping area in pixels."}},"type":"object","required":["width","height"],"description":"This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.","x-apidog-orders":["horizontal_margin","vertical_margin","width","height"]},"pad":{"properties":{"top":{"type":"string","description":"Width of padding on the top side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"left":{"type":"string","description":"Width of padding on the left side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"bottom":{"type":"string","description":"Width of padding on the bottom side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"right":{"type":"string","description":"Width of padding on the right side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"color":{"type":"string","description":"Color of padding area. **Default: `black`**"}},"type":"object","description":"This transformation can be used to add padding to the video.","x-apidog-orders":["top","left","bottom","right","color"]},"trim":{"properties":{"start_offset":{"type":"number","format":"float","description":"Start offset in number of seconds or in `HH:MM:SS` format."},"end_offset":{"type":"number","format":"float","description":"End offset in number of seconds or in `HH:MM:SS` format."},"duration":{"type":"number","format":"float","description":"Duration can be used in conjunction with `start_offset` parameter, can be specified in number of seconds."}},"type":"object","required":["start_offset","end_offset"],"description":"Trim transformation can be used to trim videos based on time duration.","x-apidog-orders":["start_offset","end_offset","duration"]},"image_overlay":{"properties":{"url":{"type":"string","description":"This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid."},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**"},"width":{"type":"string","description":"Width of the overlaid image. **Default: `image width`**"},"height":{"type":"string","description":"Height of the overlaid image. **Default: `image height`**"}},"type":"object","required":["url"],"description":"Image overlay can be used to brand a video or add a visual label in the form of an image.","x-apidog-orders":["url","horizontal_margin","vertical_margin","horizontal_align","vertical_align","width","height"]},"text_overlay":{"properties":{"text":{"type":"string","description":"Text to be overlaid on video."},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**"},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by vertical_align) of the overlay area. Values can be an absolute number of pixels relative to the video height. **Default: `0`**"},"color":{"type":"string","description":"Font color for text. **Default: `black`**"},"font":{"type":"string","description":"Font family type for text. **Default: `sans`**"},"font_size":{"type":"string","description":"Font size in pixels. **Default: `16`**"},"opacity":{"type":"string","description":"Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**"},"box":{"type":"boolean","description":"This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**"},"box_color":{"type":"string","description":"Box color can be specified with this parameter. **Default: `white`**"},"box_opacity":{"type":"string","description":"Box opacity can be specified with this parameter. **Default: `100`**"},"box_border":{"type":"string","description":"Padding between the box border and the text can be specified with this parameter in pixels. **Default: `0`**"}},"type":"object","required":["text"],"description":"Text overlay can be used to brand a video or add a label in the form of text.","x-apidog-orders":["text","horizontal_align","vertical_align","horizontal_margin","vertical_margin","color","font","font_size","opacity","box","box_color","box_opacity","box_border"]},"animated_gif":{"properties":{"start_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the animated gif should begin. **Default: `0`**"},"end_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the GIF ends. Defaults to `10` seconds after the start_offset. Maximum duration of GIF is limited to `10` seconds."},"width":{"type":"string","description":"The width in pixels (or in percentage value of asset width) of the animated GIF. Max width is `640px`."},"height":{"type":"string","description":"The height in pixels (or in percentage value of asset height) of the animated GIF. Max height is `640px`."},"fps":{"type":"string","description":"The frame rate of the generated GIF. Defaults to `15` fps. Max `30` fps."}},"type":"object","description":"Create an animated GIF from the video.","x-apidog-orders":["start_offset","end_offset","width","height","fps"]},"additional_tracks":{"items":{"properties":{"url":{"type":"string","description":"URL or web address of a file that Gumlet should download to add a stream."},"type":{"type":"string","description":"Type of additional track. Value can be either audio or subtitle."},"language_code":{"type":"string","description":"The language code value represents BCP 47 specification compliant value. For example, en for English."},"name":{"type":"string","description":"The name of the track containing a human-readable description."}},"type":"object","required":["url","type","language_code"],"x-apidog-orders":["url","type","language_code","name"]},"type":"array","description":"Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track."},"generate_subtitles":{"properties":{"audio_language":{"type":"string","description":"Language code for native language of the audio."},"subtitle_languages":{"type":"string","description":"Comma separated string of language codes for which subtitle needs to be generated. Maximum four language codes are allowed."}},"type":"object","description":"Gumlet allows you to generate subtitles from the audio stream (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes)","x-apidog-orders":["audio_language","subtitle_languages"]},"mp4_access":{"type":"boolean","description":"Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**"},"per_title_encoding":{"type":"boolean","description":"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_input":{"type":"boolean","description":"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_only":{"type":"boolean","description":"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_drm":{"type":"boolean","description":"Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs."},"call_to_actions":{"items":{"properties":{"text":{"type":"string"},"url":{"type":"string"},"start_time":{"type":"integer","format":"int32"},"end_time":{"type":"integer","format":"int32"},"font_color":{"type":"string","description":"hex value of color"},"background_color":{"type":"string","description":"hex code of color"},"position_from_top":{"type":"integer","format":"int32","description":"number of pixels from top"},"position_from_right":{"type":"integer","format":"int32","description":"number of pixels from right"}},"type":"object","x-apidog-orders":["text","url","start_time","end_time","font_color","background_color","position_from_top","position_from_right"]},"type":"array","description":"A CTA is an explicit prompt within the video content encouraging viewers to take a particular action."},"playlist_id":{"type":"string","description":"Add this asset to a playlist."},"folder":{"type":"string","description":"Add this asset to an existing folder by `folder_id`."},"workspace_id":{"type":"string","description":"Gumlet video workspace id."}},"required":[]}},"create_asset_direct_upload":{"name":"create_asset_direct_upload","description":"This endpoint creates a video asset allowing upload of a 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](https://docs.gumlet.com/docs/direct-upload#2-use-the-url-to-upload-a-file).","inputSchema":{"type":"object","properties":{"collection_id":{"type":"string","description":"Gumlet video workspace id."},"profile_id":{"type":"string","description":"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":{"type":"string","enum":["ABR","MP4"],"description":"Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`."},"tag":{"items":{"type":"string","x-stoplight":{"id":"ukzi2mra8hepj"}},"type":"array","description":"Specify a text string or identifier which can identify an asset or bunch of assets later."},"title":{"type":"string","description":"Specify a text string or identifier which can be used for filtering or searching the asset."},"description":{"type":"string","description":"Attach some textual data with the asset. This field is neither searchable nor filterable."},"metadata":{"properties":{},"additionalProperties":{},"type":"object","description":"Add your metadata you want to associate with this asset.<br/> Example: <br/> <code>  {  \"internal_video_id\" : \"123Abc\"  }  </code>"},"width":{"type":"string","description":"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`."},"height":{"type":"string","description":"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`."},"resolution":{"type":"string","description":"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`. Resized rendition will retain the input aspect ratio."},"crop":{"properties":{"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"width":{"type":"string","description":"Width of the cropping area in pixels."},"height":{"type":"string","description":"Height of the cropping area in pixels."}},"type":"object","required":["width","height"],"description":"This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video."},"pad":{"properties":{"top":{"type":"string","description":"Width of padding on the top side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"left":{"type":"string","description":"Width of padding on the left side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"bottom":{"type":"string","description":"Width of padding on the bottom side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"right":{"type":"string","description":"Width of padding on the right side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"color":{"type":"string","description":"Color of padding area. **Default: `black`**"}},"type":"object","description":"This transformation can be used to add padding to the video."},"trim":{"properties":{"start_offset":{"type":"number","format":"float","description":"Start offset in number of seconds or in `HH:MM:SS` format."},"end_offset":{"type":"number","format":"float","description":"End offset in number of seconds or in `HH:MM:SS` format."},"duration":{"type":"number","format":"float","description":"Duration can be used in conjunction with `start_offset` parameter, can be specified in number of seconds."}},"type":"object","required":["start_offset","end_offset"],"description":"Trim transformation can be used to trim videos based on time duration."},"image_overlay":{"properties":{"url":{"type":"string","description":"This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid."},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**"},"width":{"type":"string","description":"Width of the overlaid image. **Default: `image width`**"},"height":{"type":"string","description":"Height of the overlaid image. **Default: `image height`**"}},"type":"object","required":["url"],"description":"Image overlay can be used to brand a video or add a visual label in the form of an image."},"text_overlay":{"properties":{"text":{"type":"string","description":"Text to be overlaid on video."},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**"},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by vertical_align) of the overlay area. Values can be an absolute number of pixels relative to the video height. **Default: `0`**"},"color":{"type":"string","description":"Font color for text. **Default: `black`**"},"font":{"type":"string","description":"Font family type for text. **Default: `sans`**"},"font_size":{"type":"string","description":"Font size in pixels. **Default: `16`**"},"opacity":{"type":"string","description":"Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**"},"box":{"type":"boolean","description":"This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**"},"box_color":{"type":"string","description":"Box color can be specified with this parameter. **Default: `white`**"},"box_opacity":{"type":"string","description":"Box opacity can be specified with this parameter. **Default: `100`**"},"box_border":{"type":"string","description":"Padding between the box border and the text can be specified with this parameter in pixels. **Default: `0`**"}},"type":"object","required":["text"],"description":"Text overlay can be used to brand a video or add a label in the form of text."},"animated_gif":{"properties":{"start_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the animated gif should begin. **Default: `0`**"},"end_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the GIF ends. Defaults to `10` seconds after the start_offset. Maximum duration of GIF is limited to `10` seconds."},"width":{"type":"string","description":"The width in pixels (or in percentage value of asset width) of the animated GIF. Max width is `640px`."},"height":{"type":"string","description":"The height in pixels (or in percentage value of asset height) of the animated GIF. Max height is `640px`."},"fps":{"type":"string","description":"The frame rate of the generated GIF. Defaults to `15` fps. Max `30` fps."}},"type":"object","description":"Create an animated GIF from the video."},"additional_tracks":{"items":{"properties":{"url":{"type":"string","description":"URL or web address of a file that Gumlet should download to add a stream."},"type":{"type":"string","description":"Type of additional track. Value can be either audio or subtitle."},"language_code":{"type":"string","description":"The language code value represents BCP 47 specification compliant value. For example, en for English."},"name":{"type":"string","description":"The name of the track containing a human-readable description."}},"type":"object","required":["url","type","language_code"]},"type":"array","description":"Add additional Audio / Subtitle tracks to Gumlet for transcoding and delivery along with video asset track."},"generate_subtitles":{"properties":{"audio_language":{"type":"string","description":"Language code for native language of the audio."},"subtitle_languages":{"type":"string","description":"Comma separated string of language codes for which subtitle needs to be generated. Maximum four language codes are allowed."}},"type":"object","description":"Gumlet allows you to generate subtitles from the audio stream (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes)"},"mp4_access":{"type":"boolean","description":"Creates `MP4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**"},"per_title_encoding":{"type":"boolean","description":"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_input":{"type":"boolean","description":"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_only":{"type":"boolean","description":"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_drm":{"type":"boolean","description":"Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs."},"call_to_actions":{"items":{"properties":{"text":{"type":"string"},"url":{"type":"string"},"start_time":{"type":"integer","format":"int32"},"end_time":{"type":"integer","format":"int32"},"font_color":{"type":"string","description":"hex value of color"},"background_color":{"type":"string","description":"hex code of color"},"position_from_top":{"type":"integer","format":"int32","description":"number of pixels from top"},"position_from_right":{"type":"integer","format":"int32","description":"number of pixels from right"}},"type":"object"},"type":"array","description":"A CTA is an explicit prompt within the video content encouraging viewers to take a particular action."},"playlist_id":{"type":"string","description":"Add this asset to a playlist."},"folder":{"type":"string","description":"Add this asset to an existing folder by `folder_id`."}},"required":[]}},"get_asset_details":{"name":"get_asset_details","description":"This endpoint retrieves the details of an asset that has previously been created.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"An asset id for the previously created asset."}},"required":["asset_id"]}},"delete_asset":{"name":"delete_asset","description":"This endpoint removes an asset given its unique asset id. The asset will be removed from storage as well, associated URLs will be inaccessible.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Asset id of the video asset which needs to be deleted."}},"required":["asset_id"]}},"update_asset":{"name":"update_asset","description":"This endpoint allows users to update video asset that has previously been created.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Asset Id"},"title":{"type":"string","description":"Specify a text string or identifier which can be used for filtering or searching the asset."},"description":{"type":"string","description":"Attach some textual data with the asset. This field is neither searchable nor filterable."},"tag":{"type":"string","description":"Specify a text string or identifier which can identify an asset or bunch of assets later. You can pass multiple comma-separated values."},"call_to_actions":{"items":{"properties":{"text":{"type":"string"},"url":{"type":"string"},"start_time":{"type":"integer","format":"int32"},"end_time":{"type":"integer","format":"int32"},"font_color":{"type":"string","description":"hex value of color"},"background_color":{"type":"string","description":"hex code of color"},"position_from_top":{"type":"integer","format":"int32","description":"number of pixels from top"},"position_from_right":{"type":"string","description":"number of pixels from right"}},"type":"object","x-apidog-orders":["text","url","start_time","end_time","font_color","background_color","position_from_top","position_from_right"]},"type":"array","description":"A CTA is an explicit prompt within the video content encouraging viewers to take a particular action."},"metadata":{"type":"string","format":"json","description":"Set of key-value pairs that you can attach to this Asset. This can be useful for storing additional information.<br/> Example: <br/> <code>  {  \"internal_video_id\" : \"123Abc\"  }  </code>"},"remove_subtitles":{"items":{"type":"string"},"type":"array","description":"Comma separated string of language codes."},"input":{"type":"string","description":"For replacing videos, pass this along with `asset_id`\n\n`{workspace_id}/{asset_id}/origin-{asset_id}`"},"reprocess":{"type":"boolean","description":"To reprocess same video, pass this as true."}},"required":[]}},"thumbnail_select":{"name":"thumbnail_select","description":"Select frame from video to use as thumbnail.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Asset id of the video asset which needs to be deleted."},"frame_at_second":{"type":"number","description":"Actual time in second at which thumbnail extraction needs to be done. It can be a fraction of a second as well"}},"required":["asset_id"]}},"thumbnail_upload":{"name":"thumbnail_upload","description":"Use 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.\n\nHere is the sample curl request.\n\n```bash\ncurl --location --request PUT '<upload_url>' \\\n--data '<YOUR_FILE_PATH>'\n```","inputSchema":{"type":"object","properties":{"asset_ID":{"type":"string","description":"An asset id for the previously created asset."}},"required":["asset_ID"]}},"upload_subtitles":{"name":"upload_subtitles","description":"Upload `.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.","inputSchema":{"type":"object","properties":{"asset_ID":{"type":"string","description":"An asset id for the previously created asset."},"language_codes":{"items":{"type":"string"},"type":"array","description":"List of language codes to upload subtitle file (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes)"}},"required":["asset_ID"]}},"complete_subtitle_upload":{"name":"complete_subtitle_upload","description":"This 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. \nOnce that is done, calling this initiates the process to actually add the subtitle to the video.","inputSchema":{"type":"object","properties":{"asset_ID":{"type":"string","description":"An asset id for the previously created asset."},"upload_responses":{"items":{"properties":{"language_code":{"type":"string","description":"Language code for uploaded .srt or .vtt file."},"uploaded":{"type":"boolean","description":"Status of language uploaded .srt or .vtt file. (If status code was 200, You can mark true else false)"}},"type":"object","x-apidog-orders":["language_code","uploaded"]},"type":"array","description":"Array of objects of uploaded languages"}},"required":["asset_ID"]}},"asset_audio_upload":{"name":"asset_audio_upload","description":"Add any audio file to the video asset. \nThe 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.","inputSchema":{"type":"object","properties":{"asset_ID":{"type":"string","description":"An asset id for the previously created asset."},"language_codes":{"items":{"type":"string"},"type":"array","description":"List of language codes to upload audio file (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes)"}},"required":["asset_ID"]}},"complete_audio_upload":{"name":"complete_audio_upload","description":"This 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. \nOnce that is done, calling this initiates the process to actually add the subtitle to the video.","inputSchema":{"type":"object","properties":{"asset_ID":{"type":"string","description":"An asset id for the previously created asset."},"upload_responses":{"items":{"properties":{"language_code":{"type":"string","description":"Language code for uploaded audio file."},"uploaded":{"type":"boolean","description":"Status of language uploaded audio file. (If status code was 200, You can mark true else false)"}},"type":"object"},"type":"array"}},"required":["asset_ID"]}},"create_update_chapter":{"name":"create_update_chapter","description":"This endpoint will create/update video asset chapters.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Gumlet asset ID"},"chapters":{"items":{"properties":{"label":{"type":"string","description":"Label for the chapter"},"startTime":{"type":"integer","format":"int32","description":"Start time of chapter in seconds. 0 means chapter is put as the video starts."}},"type":"object","required":["label","startTime"],"x-apidog-orders":["label","startTime"]},"type":"array","description":"List of chapters"}},"required":["asset_id"]}},"retrieve_analytics":{"name":"retrieve_analytics","description":"This endpoint gives usage analytics data of your videos. Ex - top assets, bandwidth consumption","inputSchema":{"type":"object","properties":{"metrics":{"items":{"type":"string","enum":["bandwidth_consumption","asset_duration","storage_unit","top_assets","drm_requests","ai_credit_usage","errored_videos"],"x-apidog-enum":[{"value":"bandwidth_consumption","name":"","description":""},{"value":"asset_duration","name":"","description":""},{"value":"storage_unit","name":"","description":""},{"value":"top_assets","name":"","description":""},{"value":"drm_requests","name":"","description":""},{"value":"ai_credit_usage","name":"","description":""},{"value":"errored_videos","name":"","description":""}]},"type":"array","description":"Define the metric you need the data for. Currently we only support `bandwidth_consumption`, `asset_duration`, `storage_unit`, `top_assets`, `bandwidth_consumption_by_collection`, `errored_videos` and `widget_data`"},"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"The starting date to consider"},"end_at":{"type":"string","format":"date","description":"The ending date to consider"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. Currently we only support a maximum of 60 days between `start_at` and `end_at`.","x-apidog-orders":["start_at","end_at"]},"filters":{"properties":{"collection_id":{"type":"string","description":"The ID of the `workspace` you want to filter the data for."},"source_id":{"type":"string","description":"The ID of the `workspace` you want to filter the data for. Deprecated."}},"type":"object","x-apidog-orders":["collection_id","source_id"]},"top_assets_count":{"type":"string","description":"Count of video assets that should be returned. Max assets count is 1000 per page.","default":"5"},"top_assets_page":{"type":"string","description":"top_assets metric may get paginated response. Iterate this parameter to get more data.","default":"0"},"group_by":{"type":"string","enum":["hourly","daily","monthly"],"description":"Group by hourly, daily or monthly. If you don't specify anything it's `hourly` by default.","default":"hourly","x-apidog-enum":[{"value":"hourly","name":"","description":""},{"value":"daily","name":"","description":""},{"value":"monthly","name":"","description":""}]}},"required":[]}},"top_assets":{"name":"top_assets","description":"This endpoint lists top streamed assets in a video collection","inputSchema":{"type":"object","properties":{"start_at":{"type":"string","examples":["2026-06-21"],"description":"Date string in \"yyyy-mm-dd\" format"},"end_at":{"type":"string","examples":["2026-06-30"],"description":"Date string in \"yyyy-mm-dd\" format"},"collection_id":{"type":"string","description":"Gumlet workspace ID"},"page":{"type":"string","default":"1","description":"Page number of the response."},"page_size":{"type":"string","default":"1000","description":"Assets to list per page."}},"required":["start_at","end_at"]}},"retrieve_part_url":{"name":"retrieve_part_url","description":"Use this endpoint to retrieve a pre-signed upload URL for the given part number.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"An asset id of the created asset for which you are uploading parts"},"part_number":{"type":"string","description":"Part number of multiple parts of the original video which you you are uploading"}},"required":["asset_id","part_number"]}},"complete_multipart_upload":{"name":"complete_multipart_upload","description":"Once you upload all parts to S3 bucket via pre-signed URL, use this endpoint to complete the multipart upload.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"An asset id for which you are uploading original video via multipart"},"parts":{"items":{"properties":{"PartNumber":{"type":"integer","format":"int32","description":"Part number"},"ETag":{"type":"string","description":"ETag received while uploading the part using PUT"}},"type":"object","x-apidog-orders":["PartNumber","ETag"]},"type":"array","description":"List of object containing part number with ETag received as a response header while uploading each part"}},"required":["asset_id"]}},"list_profiles":{"name":"list_profiles","description":"This endpoint retrieves the details of all profiles that have previously been created.","inputSchema":{"type":"object","properties":{"offset":{"type":"integer","format":"int32","description":"Offset value for a paginated list of profiles. Can be zero for the first time and `current_offset` value received from the last request afterwards."},"size":{"type":"integer","format":"int32","description":"Page size for the paginated list. **Default: `10`**"}},"required":[]}},"create_profile":{"name":"create_profile","description":"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.","inputSchema":{"type":"object","properties":{"name":{"type":"string","description":"Profile name or identifier.","default":"Gumlet-Profile-1"},"format":{"type":"string","enum":["ABR","MP4"],"description":"Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`.","default":"ABR"},"width":{"type":"string","description":"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. Only applicable when specified `format` is `MP4`."},"height":{"type":"string","description":"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. Only applicable when specified `format` is `MP4`."},"resolution":{"type":"string","description":"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 `. Resized rendition will retain the input aspect ratio."},"crop":{"properties":{"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"width":{"type":"string","description":"Width of the cropping area in pixels."},"height":{"type":"string","description":"Height of the cropping area in pixels."}},"type":"object","required":["width","height"],"description":"This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video."},"pad":{"properties":{"top":{"type":"string","description":"Width of padding on the top side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"left":{"type":"string","description":"Width of padding on the left side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"bottom":{"type":"string","description":"Width of padding on the bottom side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"right":{"type":"string","description":"Width of padding on the right side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"color":{"type":"string","description":"Color of padding area. **Default: `black`**"}},"type":"object","description":"This transformation can be used to add padding to the video."},"trim":{"properties":{"start_offset":{"type":"number","format":"float","description":"Start offset in number of seconds or in `HH:MM:SS` format."},"end_offset":{"type":"number","format":"float","description":"End offset in number of seconds or in `HH:MM:SS` format."},"duration":{"type":"number","format":"float","description":"Duration can be used in conjunction with `start_offset` parameter, can be specified in number of seconds."}},"type":"object","required":["start_offset","end_offset"],"description":"Trim transformation can be used to trim videos based on time duration."},"image_overlay":{"properties":{"url":{"type":"string","description":"This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid."},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**"},"width":{"type":"string","description":"Width of the overlaid image. **Default: `image width`**"},"height":{"type":"string","description":"Height of the overlaid image. **Default: `image height`**"}},"type":"object","required":["url"],"description":"Image overlay can be used to brand a video or add a visual label in the form of an image."},"text_overlay":{"properties":{"text":{"type":"string","description":"Text to be overlaid on video."},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**"},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by vertical_align) of the overlay area. Values can be an absolute number of pixels relative to the video height. **Default: `0`**"},"color":{"type":"string","description":"Font color for text. **Default: `black`**"},"font":{"type":"string","description":"Font family type for text. **Default: `sans`**"},"font_size":{"type":"string","description":"Font size in pixels. **Default: `16`**"},"opacity":{"type":"string","description":"Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**"},"box":{"type":"boolean","description":"This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**"},"box_color":{"type":"string","description":"Box color can be specified with this parameter. **Default: `white`**"},"box_opacity":{"type":"string","description":"Box opacity can be specified with this parameter. **Default: `100`**"},"box_border":{"type":"string","description":"Padding between the box border and the text can be specified with this parameter in pixels. **Default: `0`**"}},"type":"object","required":["text"],"description":"Text overlay can be used to brand a video or add a label in the form of text."},"animated_gif":{"properties":{"start_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the animated gif should begin. **Default: `0`**"},"end_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the GIF ends. Defaults to `10` seconds after the start_offset. Maximum duration of GIF is limited to `10` seconds."},"width":{"type":"string","description":"The width in pixels (or in percentage value of asset width) of the animated GIF. Max width is `640px`."},"height":{"type":"string","description":"The height in pixels (or in percentage value of asset height) of the animated GIF. Max height is `640px`."},"fps":{"type":"string","description":"The frame rate of the generated GIF. Defaults to `15` fps. Max `30` fps."}},"type":"object","description":"Create an animated GIF from a video."},"generate_subtitles":{"properties":{"transcribe":{"type":"boolean","description":"This will generate the subtitles in the native audio.","default":true},"subtitle_languages":{"type":"string","description":"Array of string of language codes for which subtitle needs to be generated. Maximum four language codes are allowed."}},"type":"object","description":"Gumlet allows you to generate subtitles from the audio stream (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes). Remove this object if you do not want to generate AI subtitles."},"mp4_access":{"type":"boolean","description":"Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**"},"per_title_encoding":{"type":"boolean","description":"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_input":{"type":"boolean","description":"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_only":{"type":"boolean","description":"This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,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_drm":{"type":"boolean","description":"Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs."}},"required":[]}},"get_profile":{"name":"get_profile","description":"This endpoint retrieves the details of a video profile that has previously been created.","inputSchema":{"type":"object","properties":{"profile_id":{"type":"string","description":"Profile id of the profile which needs to be retrieved."}},"required":["profile_id"]}},"update_profile":{"name":"update_profile","description":"Update an existing profile. Settings provided in body parameters will only be updated in the existing profile.","inputSchema":{"type":"object","properties":{"profile_id__path":{"type":"string","description":"Profile id of the profile which need to be updated. (Path parameter)"},"profile_id":{"type":"string","description":"Profile id of the profile which needs to be deleted."},"name":{"type":"string","description":"Profile name or identifier."},"format":{"type":"string","enum":["ABR","MP4"],"description":"Transcode and deliver the asset in the requested format. The options can be one of `ABR` (HLS + DASH) and `MP4`.","default":"ABR"},"width":{"type":"string","description":"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. Only applicable when specified `format` is `MP4`."},"height":{"type":"string","description":"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. Only applicable when specified `format` is `MP4`."},"resolution":{"type":"string","description":"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. Only applicable when specified `format` is `MP4`."},"crop":{"properties":{"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the upper-left corner of the cropping area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"width":{"type":"string","description":"Width of the cropping area in pixels."},"height":{"type":"string","description":"Height of the cropping area in pixels."}},"type":"object","required":["width","height"],"description":"This transformation can be used to crop the video by defining a rectangular area within the dimensions of the output video.","x-apidog-orders":["horizontal_margin","vertical_margin","width","height"]},"pad":{"properties":{"top":{"type":"string","description":"Width of padding on the top side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"left":{"type":"string","description":"Width of padding on the left side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"bottom":{"type":"string","description":"Width of padding on the bottom side. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `%5`**"},"right":{"type":"string","description":"Width of padding on the right side. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"color":{"type":"string","description":"Color of padding area. **Default: `black`**"}},"type":"object","description":"This transformation can be used to add padding to the video.","x-apidog-orders":["top","left","bottom","right","color"]},"trim":{"properties":{"start_offset":{"type":"number","format":"float","description":"Start offset in number of seconds or in `HH:MM:SS` format."},"end_offset":{"type":"number","format":"float","description":"End offset in number of seconds or in `HH:MM:SS` format."},"duration":{"type":"number","format":"float","description":"Duration can be used in conjunction with `start_offset` parameter, can be specified in number of seconds."}},"type":"object","required":["start_offset","end_offset"],"description":"Trim transformation can be used to trim videos based on time duration.","x-apidog-orders":["start_offset","end_offset","duration"]},"image_overlay":{"properties":{"url":{"type":"string","description":"This is the required parameter for image overlay; it can be a URL to an image that needs to be overlaid."},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by `vertical_align`) of the overlay area. Values can be an absolute number of pixels or a percentage value relative to the video height. **Default: `0`**"},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid image and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid image and can be either `top` or `bottom`. **Default: `bottom`**"},"width":{"type":"string","description":"Width of the overlaid image. **Default: `image width`**"},"height":{"type":"string","description":"Height of the overlaid image. **Default: `image height`**"}},"type":"object","required":["url"],"description":"Image overlay can be used to brand a video or add a visual label in the form of an image.","x-apidog-orders":["url","horizontal_margin","vertical_margin","horizontal_align","vertical_align","width","height"]},"text_overlay":{"properties":{"text":{"type":"string","description":"Text to be overlaid on video."},"horizontal_align":{"type":"string","description":"This parameter specifies the horizontal alignment of the overlaid text and can be either `left` or `right`. **Default: `right`**"},"vertical_align":{"type":"string","description":"This parameter specifies the vertical alignment of the overlaid text and can be either `top` or `bottom`. **Default: `bottom`**"},"horizontal_margin":{"type":"string","description":"This parameter defines the horizontal coordinate value of the corner (determined by `horizontal_align`) of the overlay area. Values can be an absolute number of pixels relative to the video width. **Default: `0`**"},"vertical_margin":{"type":"string","description":"This parameter defines the vertical coordinate value of the corner (determined by vertical_align) of the overlay area. Values can be an absolute number of pixels relative to the video height. **Default: `0`**"},"color":{"type":"string","description":"Font color for text. **Default: `black`**"},"font":{"type":"string","description":"Font family type for text. **Default: `sans`**"},"font_size":{"type":"string","description":"Font size in pixels. **Default: `16`**"},"opacity":{"type":"string","description":"Overlay text opacity can be specified with opacity parameter where value can be between `0` and `100` where `0` is considered completely transparent and `100` is considered completely opaque. **Default: `100`**"},"box":{"type":"boolean","description":"This parameter allows drawing a rectangular box over the overlaid text. **Default: `false`**"},"box_color":{"type":"string","description":"Box color can be specified with this parameter. **Default: `white`**"},"box_opacity":{"type":"string","description":"Box opacity can be specified with this parameter. **Default: `100`**"},"box_border":{"type":"string","description":"Padding between the box border and the text can be specified with this parameter in pixels. **Default: `0`**"}},"type":"object","required":["text"],"description":"Text overlay can be used to brand a video or add a label in the form of text.","x-apidog-orders":["text","horizontal_align","vertical_align","horizontal_margin","vertical_margin","color","font","font_size","opacity","box","box_color","box_opacity","box_border"]},"animated_gif":{"properties":{"start_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the animated gif should begin. **Default: `0`**"},"end_offset":{"type":"string","description":"The time (in seconds or `HH:MM:SS` format) of the video timeline where the GIF ends. Defaults to `10` seconds after the start_offset. Maximum duration of GIF is limited to `10` seconds."},"width":{"type":"string","description":"The width in pixels (or in percentage value of asset width) of the animated GIF. Max width is `640px`."},"height":{"type":"string","description":"The height in pixels (or in percentage value of asset height) of the animated GIF. Max height is `640px`."},"fps":{"type":"string","description":"The frame rate of the generated GIF. Defaults to `15` fps. Max `30` fps."}},"type":"object","description":"Create an animated GIF from a video.","x-apidog-orders":["start_offset","end_offset","width","height","fps"]},"generate_subtitles":{"properties":{"subtitle_languages":{"items":{"type":"string"},"type":"array","description":"Array of string of language codes for which subtitle needs to be generated. Maximum four language codes are allowed."},"transcribe":{"type":"boolean","description":"This is by default true to generate the subtitles in the native audio.","default":true}},"type":"object","description":"Gumlet allows you to generate subtitles from the audio stream (use <a href='https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes'> ISO 639-1 </a> Language Codes). You can remove this object if you don't want to generate AI subtitles.","x-apidog-orders":["subtitle_languages","transcribe"]},"mp4_access":{"type":"boolean","description":"Creates `mp4` version for download purpose in case of `MPEG-DASH` or `HLS` delivery format. **Default: `false`**"},"per_title_encoding":{"type":"boolean","description":"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_input":{"type":"boolean","description":"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_only":{"type":"boolean","description":"This flag allows Gumlet to transcode and deliver audio-only in the specified format. In this case,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_drm":{"type":"boolean","description":"Enable DRM encryption for transcoded videos. Gumlet supports Widevine and FairPlay DRMs."},"vc":{"items":{"type":"string","enum":["libx264","libsvtav1"]},"type":"array","description":"Video Codecs","default":["libx264"]},"generate_chapters":{"type":"boolean","description":"Whether Gumlet should generate chapters."},"generate_description":{"type":"boolean","description":"Whether Gumlet should generate descriptions."}},"required":["profile_id__path"]}},"delete_profile":{"name":"delete_profile","description":"This 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.","inputSchema":{"type":"object","properties":{"profile_id":{"type":"string","description":"Profile id of the profile which needs to be deleted."}},"required":["profile_id"]}},"get_all_playlists":{"name":"get_all_playlists","description":"Get all playlists for given workspace","inputSchema":{"type":"object","properties":{"collection_id":{"type":"string","description":"Workspace ID"}},"required":[]}},"create_playlist":{"name":"create_playlist","description":"Create new playlist inside video wprkspace","inputSchema":{"type":"object","properties":{"collection_id":{"type":"string","description":"Workspace ID in which the playlist should be created"},"title":{"type":"string","description":"Playlist title"},"description":{"type":"string","description":"Playlist description"}},"required":[]}},"add_asset_playlist":{"name":"add_asset_playlist","description":"This operation adds a single asset or a list of assets to a playlist.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"Playlist ID in which the asset needs to be added."},"asset_list":{"items":{"properties":{"asset_id":{"type":"string","description":"Asset ID"},"position":{"type":"integer","format":"int32","description":"Optional, if not provided asset will added at the back/last of playlist"}},"type":"object","x-apidog-orders":["asset_id","position"]},"type":"array"}},"required":["playlist_id"]}},"remove_asset_playlist":{"name":"remove_asset_playlist","description":"Removed an asset or list of assets from a given playlist.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"Playlist ID that is to be deleted."},"delete_list":{"items":{"type":"string"},"type":"array","description":"Array of video asset ids to delete"}},"required":["playlist_id"]}},"update_playlist":{"name":"update_playlist","description":"This endpoint allows you to update playlist name, channel visibility, or playlist order on a channel page.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"ID for the playlist to update."},"title":{"type":"string","description":"Playlist title"},"description":{"type":"string","description":"Playlist description"},"position":{"type":"integer","format":"int32","description":"Playlists have order in which they will be shown on the channel page."},"player_config":{"properties":{"preload":{"type":"boolean"},"autoplay":{"type":"boolean"},"disable_seek":{"type":"boolean"},"disable_player_controls":{"type":"boolean"},"powered_by_gumlet_overlay":{"type":"boolean"},"allow_drm_protected_videos":{"type":"boolean"},"loop":{"type":"boolean"},"player_color":{"type":"string"},"include_seo":{"type":"boolean"},"subtitle_enabled":{"type":"boolean"},"pixel_tags":{"properties":{},"type":"object","x-apidog-orders":[]},"logo_width":{"type":"integer","format":"int32"},"logo_height":{"type":"integer","format":"int32"},"dynamic_watermark":{"type":"boolean"},"watermark_font_size":{"type":"integer","format":"int32"},"watermark_font_color":{"type":"string"},"watermark_bg_color":{"type":"string"},"watermark_interval":{"type":"integer","format":"int32"}},"type":"object","description":"Configure player settings for this playlist, it overrides the setting set on collection.","x-apidog-orders":["preload","autoplay","disable_seek","disable_player_controls","powered_by_gumlet_overlay","allow_drm_protected_videos","loop","player_color","include_seo","subtitle_enabled","pixel_tags","logo_width","logo_height","dynamic_watermark","watermark_font_size","watermark_font_color","watermark_bg_color","watermark_interval"]},"channel_visibility":{"type":"boolean","description":"If true then playlist will be visible on channel page.","default":false}},"required":["playlist_id"]}},"delete_playlist":{"name":"delete_playlist","description":"Deletes a playlist by plalist ID.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"Playlist ID that is to be deleted."}},"required":["playlist_id"]}},"get_playlist_assets":{"name":"get_playlist_assets","description":"Get a list of all assets inside playlist. You can choose in which order are assets returned.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"ID of playlist in which you need to list assets."},"sort_by":{"type":"string","description":"Optional, if sort_by is set to asset_title it will sorted by title name. Otherwise order in which user added the assets in playlist."},"sort_order":{"type":"integer","format":"int32","default":1,"description":"-1 or 1"},"page_number":{"type":"integer","format":"int32","default":1,"description":"Optional. Minimum: 1"},"page_size":{"type":"string","default":"10","description":"Optional. Minimum: 10"}},"required":["playlist_id"]}},"reorder_asset_playlist":{"name":"reorder_asset_playlist","description":"Reorder videos inside a playlist either by moving a single asset to a position or by sorting the playlist by title or created date.","inputSchema":{"type":"object","properties":{"playlist_id":{"type":"string","description":"Playlist id."},"body":{"anyOf":[{"properties":{"asset_id":{"type":"string","description":"Asset id to move."},"page_number":{"type":"integer","minimum":1.0,"description":"Current playlist page number."},"page_size":{"type":"integer","maximum":200.0,"minimum":1.0,"description":"Playlist page size used by the caller."},"asset_position":{"type":"integer","minimum":0.0,"description":"Zero-based position inside the provided page."}},"type":"object","required":["asset_id","page_number","page_size","asset_position"]},{"properties":{"sort_by":{"type":"string","enum":["title","created_at"]},"sort_order":{"type":"string","enum":["asc","desc"]}},"type":"object","required":["sort_by","sort_order"]}]}},"required":["playlist_id"]}},"list_webhooks":{"name":"list_webhooks","description":"List all webhooks.","inputSchema":{"type":"object","properties":{},"required":[]}},"create_webhook":{"name":"create_webhook","description":"Creates a new webhook listener.","inputSchema":{"type":"object","properties":{"url":{"type":"string","description":"URL from the application you want to send data to."},"secret_token":{"type":"string","description":"Authentication token to ensure legitimacy of Gumlet Webhook request on your application."},"triggers":{"items":{"type":"string"},"type":"array","description":"Triggers for the invocation of webhookos, supported option is `status`."},"sources":{"items":{"type":"string"},"type":"array","description":"List of video collection identifiers for which webhooks are needed to be invoked."}},"required":[]}},"update_webhook":{"name":"update_webhook","description":"Update a webhook listener.","inputSchema":{"type":"object","properties":{"webhook_id":{"type":"string","description":"Unique identifier for the Gumlet Webhook which needs to be updated."},"url":{"type":"string","description":"URL from the application you want to send data to."},"secret_token":{"type":"string","description":"Authentication token to ensure legitimacy of Gumlet Webhook request on your application."},"triggers":{"type":"string","description":"Triggers for the invocation of webhookos, supported option is `status`."},"sources":{"type":"string","description":"List of video collection identifiers for which webhooks are needed to be invoked."}},"required":["webhook_id"]}},"delete_webhook":{"name":"delete_webhook","description":"Delete webhook listener endpoint.","inputSchema":{"type":"object","properties":{"webhook_id":{"type":"string","description":"Unique identifier for the Gumlet Webhook which needs to be deleted."}},"required":["webhook_id"]}},"list_sources":{"name":"list_sources","description":"This endpoint list image sources which are assigned to the user or token.","inputSchema":{"type":"object","properties":{"offset":{"type":"integer","default":0,"description":"Skip number of items. Helpful for pagination."},"size":{"type":"integer","default":20,"description":"Results per page."}},"required":[]}},"create_image_source":{"name":"create_image_source","description":"This endpoint allows users to create image source.","inputSchema":{"type":"object","properties":{"namespace":{"type":"string","description":"unique subdomain associated with the image source"},"type":{"type":"string","enum":["proxy","webfolder","aws","gcs","dostorage","wasabi","cloudinary","azure","linode","backblaze","cloudflare","zoom"]},"aws":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"},"endpoint":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is aws."},"proxy":{"properties":{"whitelisted_domains":{"type":"string"}},"type":"object","required":["whitelisted_domains"],"description":"This is a required field if source type is proxy."},"gcs":{"properties":{"bucket_name":{"type":"string"},"service_account_key":{"type":"string"}},"type":"object","required":["bucket_name","service_account_key"],"description":"This is a required field if source type is gcs."},"dostorage":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is dostorage."},"wasabi":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is wasabi."},"cloudinary":{"properties":{"host_name":{"type":"string"},"cloud_name":{"type":"string"}},"type":"object","required":["host_name","cloud_name"],"description":"This is a required field if source type is cloudinary."},"azure":{"properties":{"azure_account_name":{"type":"string"},"azure_container_name":{"type":"string"},"azure_shared_token":{"type":"string"},"azure_path":{"type":"string"}},"type":"object","required":["azure_account_name","azure_container_name","azure_shared_token","azure_path"],"description":"This is a required field if source type is azure."},"linode":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is linode."},"backblaze":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string","description":"bucket_region or endpoint"},"endpoint":{"type":"string","description":"bucket_region or endpoint"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","secret"],"description":"This is a required field if source type is backblaze."},"cloudflare":{"properties":{"bucket_name":{"type":"string"},"access_key":{"type":"string"},"account_id":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","account_id","secret"],"description":"This is a required field if source type is cloudflare."},"webfolder":{"properties":{"base_url":{"type":"string","x-stoplight":{"id":"8nxga6djly0mz"}}},"type":"object","x-stoplight":{"id":"kt4iq0r4ofkar"}}},"required":[]}},"get_image_sources_source_id":{"name":"get_image_sources_source_id","description":"Get all details about image source.","inputSchema":{"type":"object","properties":{"image_source_id":{"type":"string","description":"Image source id. You can get it on Gumlet dashboard or using list sources API endpoint."}},"required":["image_source_id"]}},"update_image_source":{"name":"update_image_source","description":"This endpoint allows users to update image source that has previously been created.","inputSchema":{"type":"object","properties":{"image_source_id":{"type":"string","description":"image source id which you want to update"},"type":{"type":"string","enum":["proxy","direct-upload","webfolder","aws","gcs","dostorage","wasabi","cloudinary","azure","linode","backblaze","cloudflare"]},"webfolder":{"properties":{"base_url":{"type":"string"}},"type":"object","description":"This is a required field if source type is webfolder.","x-apidog-orders":["base_url"]},"aws":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"},"endpoint":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is aws.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path","endpoint"]},"proxy":{"properties":{"whitelisted_domains":{"type":"string"}},"type":"object","required":["whitelisted_domains"],"description":"This is a required field if source type is proxy.","x-apidog-orders":["whitelisted_domains"]},"gcs":{"properties":{"bucket_name":{"type":"string"},"service_account_key":{"type":"string"}},"type":"object","required":["bucket_name","service_account_key"],"description":"This is a required field if source type is gcs.","x-apidog-orders":["bucket_name","service_account_key"]},"dostorage":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is dostorage.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"wasabi":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is wasabi.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"linode":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is linode.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret"]},"backblaze":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string","description":"bucket_region or endpoint"},"endpoint":{"type":"string","description":"bucket_region or endpoint"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","secret"],"description":"This is a required field if source type is backblaze.","x-apidog-orders":["bucket_name","bucket_region","endpoint","access_key","secret","base_path"]},"cloudflare":{"properties":{"bucket_name":{"type":"string"},"access_key":{"type":"string"},"account_id":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","account_id","secret"],"description":"This is a required field if source type is cloudflare.","x-apidog-orders":["bucket_name","access_key","account_id","secret","base_path"]},"cloudinary":{"properties":{"host_name":{"type":"string"},"cloud_name":{"type":"string"}},"type":"object","required":["host_name","cloud_name"],"description":"This is a required field if source type is cloudinary.","x-apidog-orders":["host_name","cloud_name"]},"azure":{"properties":{"azure_account_name":{"type":"string"},"azure_container_name":{"type":"string"},"azure_shared_token":{"type":"string"},"azure_path":{"type":"string"}},"type":"object","required":["azure_account_name","azure_container_name","azure_shared_token","azure_path"],"description":"This is a required field if source type is azure.","x-apidog-orders":["azure_account_name","azure_container_name","azure_shared_token","azure_path"]},"default_params":{"properties":{},"type":"object","x-stoplight":{"id":"uevurxwukxwph"},"x-apidog-orders":[]},"error_image":{"type":"string","description":"URL for error image to display when we get broken image from your origin.","x-stoplight":{"id":"vsfn5j2zepna2"}},"request_headers":{"items":{"properties":{},"type":"object","x-stoplight":{"id":"b4zme1scx0vau"},"x-apidog-orders":[]},"type":"array","x-stoplight":{"id":"jfv8jngxfn44y"}},"response_headers":{"items":{"properties":{},"type":"object","x-stoplight":{"id":"h991rmiuuck50"},"x-apidog-orders":[]},"type":"array","x-stoplight":{"id":"3c37705m1vqtv"}},"temp_cname":{"items":{"type":"string","x-stoplight":{"id":"uiq0l25kmsvrr"}},"type":"array","x-stoplight":{"id":"nycpttbt3ubkv"}},"browser_cache_time":{"type":"integer","format":"int32","description":"Browser cache time in seconds. For example setting this to 3600 caches the image in browser for 3600 seconds (1 hour)","x-stoplight":{"id":"xfsu66pc7m5ok"}},"cdn_cache_time":{"type":"integer","format":"int32","description":"CDN cache time in seconds.","x-stoplight":{"id":"9g2k0iyj9vq86"}},"is_active":{"type":"boolean","description":"Enable / disable source.","x-stoplight":{"id":"l0wilhnm9rcwn"}},"cname":{"items":{"type":"string"},"type":"array","description":"List of verified CNAMEs"},"fallback_origins":{"items":{"properties":{"conditions":{"items":{"type":"string"},"type":"array"},"name":{"type":"string","description":"Name of fallback"},"type":{"type":"string","enum":["dostorage","aws","wasabi","hetzner","backblaze","webfolder","gcs","azure","cloudflare","imgix","cloudinary","proxy","wordpress","linode"],"description":"Type of fallback origin","x-apidog-enum":[{"value":"proxy","name":"","description":""}]},"replace_operation":{"properties":{"from":{"type":"string"},"to":{"type":"string"}},"type":"object","x-apidog-orders":["from","to"]},"webfolder":{"properties":{"base_url":{"type":"string"}},"type":"object","description":"This is a required field if source type is webfolder.","x-apidog-orders":["base_url"]},"aws":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"},"endpoint":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is aws.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path","endpoint"]},"proxy":{"properties":{"whitelisted_domains":{"type":"string"}},"type":"object","required":["whitelisted_domains"],"description":"This is a required field if source type is proxy.","x-apidog-orders":["whitelisted_domains"]},"gcs":{"properties":{"bucket_name":{"type":"string"},"service_account_key":{"type":"string"}},"type":"object","required":["bucket_name","service_account_key"],"description":"This is a required field if source type is gcs.","x-apidog-orders":["bucket_name","service_account_key"]},"dostorage":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is dostorage.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"wasabi":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is wasabi.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"linode":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if source type is linode.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret"]},"backblaze":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string","description":"bucket_region or endpoint"},"endpoint":{"type":"string","description":"bucket_region or endpoint"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","secret"],"description":"This is a required field if source type is backblaze.","x-apidog-orders":["bucket_name","bucket_region","endpoint","access_key","secret","base_path"]},"cloudflare":{"properties":{"bucket_name":{"type":"string"},"access_key":{"type":"string"},"account_id":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","account_id","secret"],"description":"This is a required field if source type is cloudflare.","x-apidog-orders":["bucket_name","access_key","account_id","secret","base_path"]},"cloudinary":{"properties":{"host_name":{"type":"string"},"cloud_name":{"type":"string"}},"type":"object","required":["host_name","cloud_name"],"description":"This is a required field if source type is cloudinary.","x-apidog-orders":["host_name","cloud_name"]},"azure":{"properties":{"azure_account_name":{"type":"string"},"azure_container_name":{"type":"string"},"azure_shared_token":{"type":"string"},"azure_path":{"type":"string"}},"type":"object","required":["azure_account_name","azure_container_name","azure_shared_token","azure_path"],"description":"This is a required field if source type is azure.","x-apidog-orders":["azure_account_name","azure_container_name","azure_shared_token","azure_path"]}},"type":"object","required":["conditions","name","type","replace_operation"],"x-apidog-orders":["conditions","name","replace_operation","type","webfolder","aws","proxy","gcs","dostorage","wasabi","linode","backblaze","cloudflare","cloudinary","azure"]},"type":"array","description":"List of fallback origins"}},"required":["image_source_id"]}},"delete_source":{"name":"delete_source","description":"This endpoint removes a image source. All image delivery using this subdomain will be stopped.","inputSchema":{"type":"object","properties":{"image_source_id":{"type":"string","description":"Image source ID to delete. You can get this on Gumlet dashboard or in list source API."}},"required":["image_source_id"]}},"purge_image_cache":{"name":"purge_image_cache","description":"You can purge cache for any image by using our cache purge API.","inputSchema":{"type":"object","properties":{"subdomain":{"type":"string","description":"Subdomain is same subdomain you created while creating source. If you serve image from example.gumlet.com, please enter only 'example' for this parameter."},"paths":{"items":{"type":"string"},"type":"array","description":"An array of path of images to purge. It should be provided without any query parameters."}},"required":["subdomain"]}},"retrieve_image_analytics":{"name":"retrieve_image_analytics","description":"This endpoint helps you get image analytics data like bandwidth consumption, request count, CDN hit ratio, etc.","inputSchema":{"type":"object","properties":{"metrics":{"items":{"type":"string","enum":["bandwidth_consumption","requests_count","transformations_count","bandwidth_savings","origin_hit_rate","avg_transformation_response_time","status_4xx","status_5xx","cdn_hit_rate","content_type","status_2xx","avg_response_time","top_assets","bandwidth_consumption_by_source","ai_credit_usage"],"x-apidog-enum":[{"value":"bandwidth_consumption","name":"","description":""},{"value":"requests_count","name":"","description":""},{"value":"transformations_count","name":"","description":""},{"value":"bandwidth_savings","name":"","description":""},{"value":"origin_hit_rate","name":"","description":""},{"value":"avg_transformation_response_time","name":"","description":""},{"value":"status_4xx","name":"","description":""},{"value":"status_5xx","name":"","description":""},{"value":"cdn_hit_rate","name":"","description":""},{"value":"content_type","name":"","description":""},{"value":"status_2xx","name":"","description":""},{"value":"avg_response_time","name":"","description":""},{"value":"top_assets","name":"","description":""},{"value":"bandwidth_consumption_by_source","name":"","description":""},{"value":"ai_credit_usage","name":"","description":""}]},"type":"array","description":"Define the metric you need the data for. Currently we support `bandwidth_consumption`, `requests_count`, `status_4xx`, `status_5xx`, and `avg_response_time`."},"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"The starting date to consider"},"end_at":{"type":"string","format":"date","description":"The ending date to consider"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. Currently we only support a maximum of 30 days between `start_at` and `end_at`.","x-apidog-orders":["start_at","end_at"]},"group_by":{"type":"string","enum":["daily","weekly","monthly","hourly"],"default":"daily","x-apidog-enum":[{"value":"daily","name":"","description":""},{"value":"weekly","name":"","description":""},{"value":"monthly","name":"","description":""},{"value":"hourly","name":"","description":""}]},"filters":{"properties":{"source_id":{"type":"string","description":"Source ID"}},"type":"object","x-apidog-orders":["source_id"]}},"required":[]}},"create_live_asset":{"name":"create_live_asset","description":"A live asset refers to 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.","inputSchema":{"type":"object","properties":{"live_source_id":{"type":"string","description":"Gumlet live video source/collection id."},"resolution":{"type":"string","description":"Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: `240p`, `360p`, `480p`, `540p`, `720p`, and `1080p`. Resized rendition will retain the input aspect ratio."},"title":{"type":"string","description":"Your live stream asset title"},"mp4_access":{"type":"boolean","description":"Creates <code>MP4</code> version for download purpose."},"orientation":{"type":"string","enum":["landscape","potrait"]},"start_at":{"type":"string","format":"date-time"}},"required":[]}},"create_live_asset_copy":{"name":"create_live_asset_copy","description":"A live asset refers to media content/video that is live-streamed through Gumlet. This endpoint allows users to update a live streaming asset.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"Gumlet live video asset id."},"title":{"type":"string","description":"Your live stream asset title"},"start_at":{"type":"string","format":"date-time","description":""}},"required":[]}},"get_live_asset_status":{"name":"get_live_asset_status","description":"This endpoint retrieves the details of a live video asset that has previously been created.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"A live asset id for the previously created asset."}},"required":["live_asset_id"]}},"delete_live_asset":{"name":"delete_live_asset","description":"This 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.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"Live asset id of the live asset which needs to be deleted."}},"required":["live_asset_id"]}},"complete_live_stream":{"name":"complete_live_stream","description":"This 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.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"Live asset id of the live stream which needs to be completed."}},"required":["live_asset_id"]}},"filter_live_assets":{"name":"filter_live_assets","description":"This endpoint lists live assets on the basis of `status` for the given `live_source_id`.","inputSchema":{"type":"object","properties":{"live_source_id":{"type":"string","description":"Gumlet live source/collection id."},"status":{"type":"string","description":"To filter live 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 `created`, `active`, `complete`, `disconnected`, `errored`, and `deleted`."},"offset":{"type":"integer","format":"int32","description":"Offset value for a paginated list of assets."},"size":{"type":"integer","format":"int32","description":"Page size for the paginated list."}},"required":["live_source_id"]}},"recover":{"name":"recover","description":"Recovers a deleted asset from the recycle bin.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Gumlet Video Asset Id which needs to be recovered."}},"required":[]}},"start_live":{"name":"start_live","description":"Start a live stream.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"List asset id for which the stream needs to start."}},"required":["live_asset_id"]}},"thumbnail_upload_live":{"name":"thumbnail_upload_live","description":"Generate presigned upload URLs for live stream thumbnails. Supported thumbnail states are `preparing`, `disconnected`, and `end`.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"Gumlet live video asset id."},"statuses":{"description":"Thumbnail states to upload. You can send an array or a comma-separated string.","anyOf":[{"items":{"type":"string","enum":["preparing","disconnected","end"]},"type":"array"},{"type":"string","example":"preparing,disconnected"}]}},"required":[]}},"list_workspaces":{"name":"list_workspaces","description":"This endpoint list video workspace which are assigned to the user or token.","inputSchema":{"type":"object","properties":{"offset":{"type":"string","default":"0","description":"Number of workspaces to skip. For example if you need to list 11 to 20th workspaces, pass offset as 10 and size as 10."},"size":{"type":"string","default":"10","description":"Number of workspace to return in single response."}},"required":[]}},"create_workspace":{"name":"create_workspace","description":"Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.","inputSchema":{"type":"object","properties":{"name":{"type":"string","description":"Specify a text string or identifier for the workspace."},"type":{"type":"string","enum":["proxy","direct-upload","webfolder","aws","gcs","dostorage","wasabi","cloudinary","azure","linode","backblaze","cloudflare","zoom"],"description":"Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases.","default":"direct-upload"},"default_profile_id":{"type":"string","description":"Gumlet provides the functionality of creating multiple video assets using the same set of parameters."},"insight_property_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard."},"video_protection":{"properties":{"signed_url":{"type":"boolean","default":false},"signed_url_secret":{"type":"string"},"blacklisted_countries":{"items":{"type":"string"},"type":"array","description":"Example: [\"IN\",\"USA\"]"},"whitelisted_referrers":{"type":"string"}},"type":"object","description":"Gumlet provides multiple options for securing your video playback."},"aws":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"},"endpoint":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is aws."},"proxy":{"properties":{"whitelisted_domains":{"type":"string"}},"type":"object","required":["whitelisted_domains"],"description":"This is a required field if workspace type is proxy."},"gcs":{"properties":{"bucket_name":{"type":"string"},"service_account_key":{"type":"string"}},"type":"object","required":["bucket_name","service_account_key"],"description":"This is a required field if workspace type is gcs."},"dostorage":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is dostorage."},"wasabi":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is wasabi."},"cloudinary":{"properties":{"host_name":{"type":"string"},"cloud_name":{"type":"string"}},"type":"object","required":["host_name","cloud_name"],"description":"This is a required field if workspace type is cloudinary."},"azure":{"properties":{"azure_account_name":{"type":"string"},"azure_container_name":{"type":"string"},"azure_shared_token":{"type":"string"},"azure_path":{"type":"string"}},"type":"object","required":["azure_account_name","azure_container_name","azure_shared_token","azure_path"],"description":"This is a required field if workspace type is azure."},"linode":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is linode."},"backblaze":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string","description":"bucket_region or endpoint"},"endpoint":{"type":"string","description":"bucket_region or endpoint"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","secret"],"description":"This is a required field if workspace type is backblaze."},"cloudflare":{"properties":{"bucket_name":{"type":"string"},"access_key":{"type":"string"},"account_id":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","account_id","secret"],"description":"This is a required field if workspace type is cloudflare."},"zoom":{"properties":{"secret":{"type":"string"}},"type":"object","required":["secret"],"description":"This is a required field if workspace type is zoom."}},"required":[]}},"get_workspace":{"name":"get_workspace","description":"This endpoint get all the data of video workspace that has previously been created.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."}},"required":["workspace_id"]}},"update_workspace":{"name":"update_workspace","description":"This endpoint allows users to update video workspace that has previously been created.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."},"name":{"type":"string","description":"video workspace name"},"default_profile_id":{"type":"string","description":"Gumlet provides the functionality of creating multiple video assets using the same set of parameters."},"temp_cname":{"items":{"type":"string"},"type":"array","description":"cname for channel"},"insight_property_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet Insight Property available on the dashboard."},"player_config":{"properties":{"preload":{"type":"boolean"},"autoplay":{"type":"boolean"},"disable_seek":{"type":"boolean"},"disable_player_controls":{"type":"boolean"},"powered_by_gumlet_overlay":{"type":"boolean"},"allow_drm_protected_videos":{"type":"boolean"},"loop":{"type":"boolean"},"player_color":{"type":"string"},"include_seo":{"type":"boolean"},"subtitle_enabled":{"type":"boolean"},"pixel_tags":{"properties":{},"type":"object","x-apidog-orders":[]},"logo_width":{"type":"integer","format":"int32"},"logo_height":{"type":"integer","format":"int32"},"dynamic_watermark":{"type":"boolean"},"watermark_font_size":{"type":"integer","format":"int32"},"watermark_font_color":{"type":"string"},"watermark_bg_color":{"type":"string"},"watermark_interval":{"type":"integer","format":"int32"},"cast":{"type":"boolean"},"show_video_title":{"type":"boolean"}},"type":"object","description":"Configure player settings for this playlist, it overrides the setting set on workspace.","x-apidog-orders":["preload","autoplay","disable_seek","disable_player_controls","powered_by_gumlet_overlay","allow_drm_protected_videos","loop","player_color","include_seo","subtitle_enabled","pixel_tags","logo_width","logo_height","dynamic_watermark","watermark_font_size","watermark_font_color","watermark_bg_color","watermark_interval","cast","show_video_title"]},"video_protection":{"properties":{"signed_url":{"type":"boolean","default":false},"signed_url_secret":{"type":"string"},"blacklisted_countries":{"items":{"type":"string"},"type":"array","description":"Example: [\"IN\",\"USA\"]"},"whitelisted_referrers":{"items":{"type":"string"},"type":"array"}},"type":"object","description":"Gumlet provides multiple options for securing your video playback.","x-apidog-orders":["signed_url","signed_url_secret","blacklisted_countries","whitelisted_referrers"]},"channel_settings":{"properties":{"active":{"type":"boolean","default":false},"description":{"type":"string"},"title":{"type":"string"},"privacy_type":{"type":"string","enum":["\"public\"","\"private\"","\"password-protected\""]},"featured_video":{"type":"string","description":"Video asset id, the asset should be in the same workspace as channel"},"password":{"type":"string","description":"under channel_settings privacy_type must be \"password-protected\". Password length should be greater than 5 and lesser than 100 characters."}},"type":"object","description":"Configurations to set various channel settings.","x-apidog-orders":["active","description","title","privacy_type","featured_video","password"]},"type":{"type":"string","enum":["proxy","direct-upload","webfolder","aws","gcs","dostorage","wasabi","cloudinary","azure","linode","backblaze","cloudflare","zoom"],"description":"Video workspaces are top-level entities in Gumlet. You can use them to organize videos for different teams/departments or use cases."},"webfolder":{"properties":{"base_url":{"type":"string"}},"type":"object","description":"This is a required field if workspace type is webfolder.","x-apidog-orders":["base_url"]},"aws":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"},"endpoint":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is aws.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path","endpoint"]},"proxy":{"properties":{"whitelisted_domains":{"type":"string"}},"type":"object","required":["whitelisted_domains"],"description":"This is a required field if workspace type is proxy.","x-apidog-orders":["whitelisted_domains"]},"gcs":{"properties":{"bucket_name":{"type":"string"},"service_account_key":{"type":"string"}},"type":"object","required":["bucket_name","service_account_key"],"description":"This is a required field if workspace type is gcs.","x-apidog-orders":["bucket_name","service_account_key"]},"dostorage":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is dostorage.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"wasabi":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is wasabi.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret","base_path"]},"linode":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string"},"access_key":{"type":"string"},"secret":{"type":"string"}},"type":"object","required":["bucket_name","bucket_region","access_key","secret"],"description":"This is a required field if workspace type is linode.","x-apidog-orders":["bucket_name","bucket_region","access_key","secret"]},"backblaze":{"properties":{"bucket_name":{"type":"string"},"bucket_region":{"type":"string","description":"bucket_region or endpoint"},"endpoint":{"type":"string","description":"bucket_region or endpoint"},"access_key":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","secret"],"description":"This is a required field if workspace type is backblaze.","x-apidog-orders":["bucket_name","bucket_region","endpoint","access_key","secret","base_path"]},"cloudflare":{"properties":{"bucket_name":{"type":"string"},"access_key":{"type":"string"},"account_id":{"type":"string"},"secret":{"type":"string"},"base_path":{"type":"string"}},"type":"object","required":["bucket_name","access_key","account_id","secret"],"description":"This is a required field if workspace type is cloudflare.","x-apidog-orders":["bucket_name","access_key","account_id","secret","base_path"]},"cloudinary":{"properties":{"host_name":{"type":"string"},"cloud_name":{"type":"string"}},"type":"object","required":["host_name","cloud_name"],"description":"This is a required field if workspace type is cloudinary.","x-apidog-orders":["host_name","cloud_name"]},"azure":{"properties":{"azure_account_name":{"type":"string"},"azure_container_name":{"type":"string"},"azure_shared_token":{"type":"string"},"azure_path":{"type":"string"}},"type":"object","required":["azure_account_name","azure_container_name","azure_shared_token","azure_path"],"description":"This is a required field if workspace type is azure.","x-apidog-orders":["azure_account_name","azure_container_name","azure_shared_token","azure_path"]},"zoom":{"properties":{"secret":{"type":"string"}},"type":"object","required":["secret"],"description":"This is a required field if workspace type is zoom.","x-apidog-orders":["secret"]}},"required":["workspace_id"]}},"delete_workspace":{"name":"delete_workspace","description":"This 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.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."}},"required":["workspace_id"]}},"list_folders":{"name":"list_folders","description":"List folders for a video workspace. Use `parent_id` to list only folders inside a specific parent folder.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"parent_id":{"type":"string","description":"Parent folder id. Send `null` to list root folders."}},"required":["workspace_id"]}},"create_folder":{"name":"create_folder","description":"Create a folder inside a video workspace. Optionally provide `parent_id` to create a nested folder.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"name":{"type":"string","description":"Folder name."},"parent_id":{"type":["string","null"],"description":"Parent folder id. Send `null` or omit it to create a root-level folder."}},"required":["workspace_id"]}},"get_folder":{"name":"get_folder","description":"Get a single folder by id.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"folder_id":{"type":"string","description":"Folder id."}},"required":["workspace_id","folder_id"]}},"update_folder":{"name":"update_folder","description":"Rename a folder, move it to another parent folder, or move assets into the folder by sending `asset_ids`.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"folder_id":{"type":"string","description":"Folder id."},"name":{"type":"string","description":"New folder name."},"parent_id":{"type":["string","null"],"description":"New parent folder id. Send `null` to move the folder to the root level."},"asset_ids":{"items":{"type":"string"},"type":"array","description":"Asset ids to move into this folder."}},"required":["workspace_id","folder_id"]}},"delete_folder":{"name":"delete_folder","description":"Delete a folder. Descendant folders and assets inside them are deleted by the backend workflow.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"folder_id":{"type":"string","description":"Folder id."}},"required":["workspace_id","folder_id"]}},"remove_assets_folder":{"name":"remove_assets_folder","description":"Remove one or more assets from their current folder assignment inside the workspace.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"asset_ids":{"items":{"type":"string"},"type":"array"}},"required":["workspace_id"]}},"list_assets":{"name":"list_assets","description":"List 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.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Video workspace id."},"type":{"type":"string","enum":["folders","videos","all"],"default":"all","description":"Return `folders`, `videos`, or `all`. Default is `all`."},"parent_id":{"type":"string","description":"Parent folder id. Send `null` to browse the root level."},"title":{"type":"string","description":"Search folders or assets by title or description."},"status":{"type":"string","description":"Comma-separated asset status values."},"tag":{"type":"string","description":"Comma-separated asset tags."},"playlist_id":{"type":"string","description":"Filter assets to a playlist."},"start_date":{"type":"string","description":"Asset created_at lower bound."},"end_date":{"type":"string","description":"Asset created_at upper bound."},"min_duration":{"type":"number","description":"Minimum asset duration in seconds."},"max_duration":{"type":"number","description":"Maximum asset duration in seconds."},"sortBy":{"type":"string","enum":["title","duration","uploaded_at","created_at"],"description":"Sort assets by a supported field."},"orderBy":{"type":"string","enum":["asc","desc"],"description":"Asset sort order."},"searchIndex":{"type":"string","enum":["search_index_for_asset_list","cms-search","cms-search-v2"],"description":"Search index used for asset title search."},"offset":{"type":"integer","default":0,"description":"Offset for paginated results."},"size":{"type":"integer","maximum":100.0,"default":20,"description":"Page size. Maximum 100."},"signed_token":{"type":"string","enum":["true","false"],"default":"false","x-apidog-enum":[{"value":"true","name":"","description":""},{"value":"false","name":"","description":""}],"description":"Whether URLs should be pre-signed in the API response. Possible values: `true` and `false`. Default is `false`."}},"required":["workspace_id"]}},"invite_channel_viewers":{"name":"invite_channel_viewers","description":"Invite one or more viewers to a members-only channel.","inputSchema":{"type":"object","properties":{"video_workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."},"users":{"items":{"properties":{"email":{"type":"string","format":"email","description":"Viewer email address."},"name":{"type":"string","maxLength":100,"minLength":1,"description":"Viewer display name."}},"type":"object","required":["email","name"]},"type":"array","maxItems":200,"minItems":1,"description":"List of viewers to invite. A maximum of 200 viewers can be invited in one request."}},"required":["video_workspace_id","users"]}},"remove_channel_viewers":{"name":"remove_channel_viewers","description":"Remove one or more viewers from a channel by email address.","inputSchema":{"type":"object","properties":{"video_workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."},"emails":{"items":{"type":"string","format":"email"},"type":"array","maxItems":200,"description":"Email addresses of viewers to remove. A maximum of 200 viewers can be removed in one request."}},"required":["video_workspace_id","emails"]}},"invite_channel_viewers_csv":{"name":"invite_channel_viewers_csv","description":"Invite viewers to a channel by uploading a CSV file.","inputSchema":{"type":"object","properties":{"video_workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."},"viewers_csv":{"type":"string","format":"binary","description":"CSV file containing viewer rows. Required columns: email, name. Maximum 500 viewers."}},"required":["video_workspace_id","viewers_csv"]}},"asset_status_history":{"name":"asset_status_history","description":"This endpoint retrieves the history of a live video asset that has previously been created.","inputSchema":{"type":"object","properties":{"live_asset_id":{"type":"string","description":"A live asset id for the previously created asset."}},"required":["live_asset_id"]}},"analytics_chart_data":{"name":"analytics_chart_data","description":"This endpoint retrieves viewer analytics data. This endpoint is use for deep insights on the analytics data.","inputSchema":{"type":"object","properties":{"metrics":{"items":{"type":"string"},"type":"array","description":"Get data for one or more `metrics` in the same request. Please add any of these metrics. `views`, `unique_views`, `impressions`. `completion_percent_by_views`, `playing_time`, `concurrent_users`, `widget_form_submitted`, `cta_clicks`"},"workspace_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet workspace ID available on the Video Workspaces."},"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. \nCurrently, we only support a maximum of *60 days* between `start_at` and `end_at`."},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Build *segments* of users using multiple filters on the data, `value` should be an *exact match*"},"group_by":{"type":"string","enum":["daily","weekly","monthly"],"description":"Data can be grouped by `daily`, `weekly` or `monthly`.","default":"daily"},"chart_dimension":{"properties":{"group_by":{"items":{"properties":{"name":{"type":"string","enum":["custom_video_title","custom_video_id","custom_workspace_id","video_source_url","video_source_format","player_software_version","player_software","meta_page_url","audio_language","subtitle_language","video_width_pixels","video_height_pixels","meta_country","meta_city","meta_device_category","meta_device_manufacturer","meta_browser","meta_browser_version","meta_browser_language","meta_operating_system","meta_operating_system_version","meta_device_name","meta_asn"]}},"type":"object"},"type":"array"}},"type":"object","description":"Group metrics by the selected dimension. You can select up to 3 dimensions for nested category results; results follow the selection order."}},"required":[]}},"analytics_breakdown_data":{"name":"analytics_breakdown_data","description":"This endpoint retrieves breakdown data of the given metrics by given breakdown field","inputSchema":{"type":"object","properties":{"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","required":["start_at","end_at"],"description":"The timeframe to get the data for. \nCurrently, we only support a maximum of *60 days* between `start_at` and `end_at`."},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Build *segments* of users using multiple filters on the data, `value` should be an *exact match*"},"breakdowns":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_language_code","player_name","meta_page_url","meta_asn","custom_user_id","custom_user_email","custom_video_id","custom_video_title","video_source_url","custom_video_variant_name","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the field to break down the data by."},"metric":{"type":"string","enum":["views","unique_views","impressions","completion_percent_by_views","playing_time","concurrent_users","widget_form_submitted","cta_clicks"],"description":"The metric to retrieve breakdown data for."},"page":{"type":"integer","description":"Page number for paginated results.","default":1},"page_size":{"type":"integer","description":"Number of results per page.","default":100}},"type":"object","required":["name","metric"]},"type":"array","maxItems":3,"minItems":1,"description":"Breakdown fields and metrics to retrieve data for. Supports 1 to 3 breakdowns per request."},"workspace_id":{"type":"string","description":"The five to ten character unique identifier of the Gumlet workspace ID available on the Video Workspaces."}},"required":[]}},"analytics_aggregated_data":{"name":"analytics_aggregated_data","description":"This endpoint retrieves aggregated data of the given metrics.","inputSchema":{"type":"object","properties":{"aggregate":{"items":{"properties":{"metric":{"type":"string","enum":["views","unique_views","completion_percent_by_views","playing_time","concurrent_users","impressions","widget_form_submitted","cta_clicks"],"description":"The metric to be aggregated for this request."},"function":{"type":"string","enum":["sum","average"],"description":"Aggregation function which is to be used."}},"type":"object","required":["metric","function"]},"type":"array","description":"Aggregate multiple metrics at the same time"},"workspace_id":{"type":"string","description":"The unique identifier of the Gumlet workspace ID available on the Video Workspaces."},"timeframe":{"properties":{"start_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"},"end_at":{"type":"string","format":"date","description":"Use <b>yyyy-MM-dd</b> format"}},"type":"object","description":"The timeframe to get the data for. Currently we only support maximum difference between `start_at` and `end_at` to be *60 days*"},"filters":{"items":{"properties":{"name":{"type":"string","enum":["meta_browser","meta_operating_system","meta_operating_system_version","meta_device_category","meta_device_manufacturer","meta_device_name","meta_device_display_width","meta_device_display_height","meta_country","meta_city","meta_region","player_software","player_software_version","player_height_pixels","player_width_pixels","player_language_code","meta_page_url","meta_asn","custom_user_id","user_name","user_email","custom_video_id","custom_video_title","video_source_url","video_source_hostname","video_source_format","custom_video_language","custom_video_variant","custom_data_1","custom_data_2","custom_data_3","custom_data_4","custom_data_5"],"description":"Name of the breakdown to filter data on."},"value":{"type":"string","description":"Value to be matched for the given filter name. Currently we support exact matches."},"operator":{"type":"string","enum":["equals","does not equal","contains","does not contain","is set","is not set"],"description":"Operator to be used while filtering the data","default":"equals"}},"type":"object","required":["name","value"]},"type":"array","description":"Get aggregations for metrics with multiple filters, `value` should be an exact match"}},"required":[]}},"image_purge":{"name":"image_purge","description":"You can purge the cache for any image path by using this cache purge API.","inputSchema":{"type":"object","properties":{"source_id":{"type":"string","description":"Image Source ID"},"paths":{"items":{"type":"string"},"type":"array","description":"An array of path of images to purge. It should be provided without any query parameters."}},"required":["source_id"]}},"fetch_org":{"name":"fetch_org","description":"You can get organization data using this API.","inputSchema":{"type":"object","properties":{},"required":[]}},"fetch_user":{"name":"fetch_user","description":"This endpoint gives information about the user account.","inputSchema":{"type":"object","properties":{},"required":[]}},"fetch_audit_logs":{"name":"fetch_audit_logs","description":"Get audit logs for the user activity in your organisation. Please note that this endpoint can only be accessed by `owner` and `admin` role users.","inputSchema":{"type":"object","properties":{"date_range":{"properties":{"start_at":{"type":"string","description":"Starting date for audit logs. It's a string in YYYY-MM-DD format."},"end_at":{"type":"string","description":"Ending date for audit logs. It's a string in YYYY-MM-DD format."}},"type":"object","required":["start_at","end_at"],"x-apidog-orders":["start_at","end_at"]},"page_number":{"type":"integer","multipleOf":1.0,"minimum":1.0,"description":"Page number of results.","default":1},"page_size":{"type":"integer","maximum":500.0,"minimum":10.0,"default":100},"user_email":{"items":{"type":"string","format":"email"},"type":"array","description":"Array of user emails to filter the activity logs."},"activity_type":{"items":{"type":"string","enum":["workspace_created","video_uploaded","video_details_updated","video_deleted","thumbnail_updated","subtitles_updated","audio_updated","processing_settings_updated","player_settings_updated","workspace_updated","team_member_invited","team_member_removed","import_started","playlist_created","playlist_updated","playlist_asset_changed","security_settings_updated","channel_updated","video_alert_changed","video_report_changed","live_stream_created","live_stream_started","live_stream_thumbnail_updated","live_stream_completed","live_stream_collection_created","live_stream_collection_updated","live_stream_deleted","image_source_created","image_source_updated","image_report_changed","image_alert_changed","user_profile_updated","api_key_changed","webhook_created","webhook_updated","webhook_deleted","drm_credentials_changed","plan_changed","billing_details_updated","playlist_deleted","payment_method_added","billing_alert_changed"],"x-apidog-enum":[{"value":"workspace_created","name":"","description":""},{"value":"video_uploaded","name":"","description":""}]},"type":"array","description":"Array of activity types to filter the audit logs"}},"required":[]}},"list_recycle_bin":{"name":"list_recycle_bin","description":"List all assets in a recycle bin for a given workspace. The deleted assets are available for 30 days. After that, assets are permanently deleted.","inputSchema":{"type":"object","properties":{"offset":{"type":"integer","minimum":0.0,"description":"Number of items to skip from start of page response."},"size":{"type":"integer","minimum":10.0,"default":20,"description":"Number of items to return for a single page."},"workspace_id":{"type":"string","description":"ID of workspace for which you want to list the recycle bin items."}},"required":["workspace_id"]}},"assets_delete_many":{"name":"assets_delete_many","description":"Delete multiple VOD assets at once.","inputSchema":{"type":"object","properties":{"asset_list":{"items":{"type":"string"},"type":"array","description":"LIst of asset ids to delete"},"source_id":{"type":"string","description":"Workspace ID from which assets needs to be deleted."}},"required":[]}},"assets_tag_many":{"name":"assets_tag_many","description":"Add / remove tags from multiple assets at once.","inputSchema":{"type":"object","properties":{"asset_list":{"items":{"type":"string"},"type":"array","description":"List of asset ids to update the tags for."},"source_id":{"type":"string","description":"Workspace ID in which the videos needs the operation"},"add_tags":{"items":{"type":"string"},"type":"array","description":"List of tags to add to given assets."},"remove_tags":{"items":{"type":"string"},"type":"array","description":"List of tags to remove from given assets. Pass empty array if nothing is to be removed."}},"required":[]}},"asset_analytics":{"name":"asset_analytics","description":"Get video analytics for a single asset.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"Gumlet asset ID"},"group_by":{"type":"string","enum":["daily","monthly","weekly"],"description":"Group the data by this period.","x-apidog-enum":[{"value":"daily","name":"","description":""},{"value":"monthly","name":"","description":""},{"value":"weekly","name":"","description":""}]},"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"ISO 8601 start timestamp"},"end_at":{"type":"string","format":"date","description":"ISO 8601 end timestamp"}},"type":"object","required":["start_at","end_at"],"x-apidog-orders":["start_at","end_at"]},"metrics":{"items":{"type":"string","enum":["impressions","views","playing_time","top_countries","top_pages","top_cities","top_device_types","top_browsers","heatmap","widget_data"],"x-apidog-enum":[{"value":"impressions","name":"","description":""},{"value":"views","name":"","description":""},{"value":"playing_time","name":"","description":""},{"value":"top_countries","name":"","description":""},{"value":"top_pages","name":"","description":""},{"value":"top_cities","name":"","description":""},{"value":"top_device_types","name":"","description":""},{"value":"top_browsers","name":"","description":""},{"value":"heatmap","name":"","description":""},{"value":"widget_data","name":"","description":""}]},"type":"array","description":"List of metrics to return in response."},"page_number":{"type":"integer","description":"Page number to fetch. Starting at 1"},"page_size":{"type":"integer","description":"Number of items to return per page"}},"required":["asset_id"]}},"list_channel_subscribers":{"name":"list_channel_subscribers","description":"List all channel subscribers.","inputSchema":{"type":"object","properties":{"workspace_id":{"type":"string","description":"Gumlet workspace ID. You can get it on Gumlet dashboard or retrieve it using list workspace API."},"page_number":{"type":"integer","multipleOf":1.0,"minimum":1.0,"default":1,"description":"Page number to retrieve. Starts at 1."},"page_size":{"type":"integer","multipleOf":1.0,"minimum":1.0,"default":10,"description":"Number of items to return per page"}},"required":["workspace_id"]}},"webhook_history":{"name":"webhook_history","description":"Get logs history for a given webhook.","inputSchema":{"type":"object","properties":{"webhook_id":{"type":"string","description":"Webhook ID. You can get it using list webhook endpoint."}},"required":["webhook_id"]}},"list_invoices":{"name":"list_invoices","description":"Liost all invoices that are generated so far.","inputSchema":{"type":"object","properties":{},"required":[]}},"fetch_billing_details":{"name":"fetch_billing_details","description":"Get billing details for this organization.","inputSchema":{"type":"object","properties":{},"required":[]}},"update_billing_details":{"name":"update_billing_details","description":"Update billing details","inputSchema":{"type":"object","properties":{"address_line":{"type":"string","description":"Address line 1"},"city":{"type":"string","description":"Name of the city"},"company_name":{"type":"string","description":"Company name"},"country_code":{"type":"string","description":"ISO country code"},"gst_number":{"type":"string","description":"GST / VAT details of the company"},"postal":{"type":"string","description":"Postal code of the company"},"state_code":{"type":"string","description":"ISO code of the state / region"}},"required":[]}},"fetch_upcoming_invoice":{"name":"fetch_upcoming_invoice","description":"Get details about upcoming invoice.","inputSchema":{"type":"object","properties":{},"required":[]}},"list_live_workspaces":{"name":"list_live_workspaces","description":"List all live stream workspaces.","inputSchema":{"type":"object","properties":{},"required":[]}},"live_workspace_create":{"name":"live_workspace_create","description":"Create live stream workspace.","inputSchema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name"}},"required":[]}},"live_workspace_update":{"name":"live_workspace_update","description":"Update live stream workspace.","inputSchema":{"type":"object","properties":{"live_workspace_id":{"type":"string","description":"Live stream workspace ID."},"name":{"type":"string","description":"Live stream collection name"},"video_source_id":{"type":"string","description":"Video on demand workspace ID"}},"required":["live_workspace_id"]}},"live_workspace_delete":{"name":"live_workspace_delete","description":"Delete the live stream workspace.","inputSchema":{"type":"object","properties":{"live_workspace_id":{"type":"string","description":"Live stream workspace ID."}},"required":["live_workspace_id"]}},"live_usage_analytics":{"name":"live_usage_analytics","description":"Get usage analytics for your live streams.","inputSchema":{"type":"object","properties":{"date_range":{"properties":{"start_at":{"type":"string","format":"date","description":"Start date in ISO 8601 date format (YYYY-MM-DD)"},"end_at":{"type":"string","format":"date","description":"End date in ISO 8601 date format (YYYY-MM-DD)"}},"type":"object","required":["start_at","end_at"],"x-apidog-orders":["start_at","end_at"]},"group_by":{"type":"string","enum":["daily","weekly","monthly"],"description":"Group the data either weekly, daily or monthly","x-apidog-enum":[{"value":"daily","name":"","description":""},{"value":"weekly","name":"","description":""},{"value":"monthly","name":"","description":""}]},"metrics":{"items":{"type":"string","enum":["bandwidth_consumption","asset_duration","storage_unit"],"x-apidog-enum":[{"value":"bandwidth_consumption","name":"","description":""},{"value":"asset_duration","name":"","description":""},{"value":"storage_unit","name":"","description":""}]},"type":"array","description":"List of metrics required in response"}},"required":[]}},"global_search":{"name":"global_search","description":"Search all video assets / playlists / folders etc across workspaces.","inputSchema":{"type":"object","properties":{"search_query":{"type":"string","description":"Search query term"},"collection_id":{"type":"string","description":"Workspace ID if you want to limit search to a specific workspace"},"size":{"type":"integer","default":20,"description":"Number of results to return"},"assets_offset":{"type":"integer","default":0,"description":"Offset for assets"},"folders_offset":{"type":"integer","default":0,"description":"Offset for folders"},"playlists_offset":{"type":"integer","default":0,"description":"Offset for playlists"},"channels_offset":{"type":"integer","default":0,"description":"Offset for channels"}},"required":["search_query"]}},"multipart_upload_abort":{"name":"multipart_upload_abort","description":"This call aborts multi-part upload and deletes the already uploaded parts from the storage.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"An asset id for the asset."},"body":{"properties":{},"type":"object"}},"required":["asset_id"]}},"multipart_upload_list":{"name":"multipart_upload_list","description":"Lists all parts uploaded so far.","inputSchema":{"type":"object","properties":{"asset_id":{"type":"string","description":"An asset id for the asset."},"body":{"properties":{},"type":"object"}},"required":["asset_id"]}}},"resources":[{"name":"python_sdk","uri":"gumlet://sdk/python","description":"Official Gumlet Python SDK on PyPI: pip install gumlet"},{"name":"nodejs_sdk","uri":"gumlet://sdk/nodejs","description":"Official Gumlet Node.js SDK on npm: npm install @gumlet/nodejs-sdk"}],"prompts":[]}}