changedInput schema / $defs / Destinations / anyOf
Previous value: -[
- {
- "$ref": "#/$defs/ShotstackDestination"
- },
- {
- "$ref": "#/$defs/MuxDestination"
- },
- {
- "$ref": "#/$defs/S3Destination"
- },
- {
- "$ref": "#/$defs/GoogleCloudStorageDestination"
- },
- {
- "$ref": "#/$defs/GoogleDriveDestination"
- },
- {
- "$ref": "#/$defs/VimeoDestination"
- },
- {
- "deprecated": true,
- "description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
- "properties": {
- "options": {
- "deprecated": true,
- "description": "Additional TikTok configuration options.",
- "properties": {
- "disableComment": {
- "default": false,
- "description": "Disable comments on this video.",
- "type": "boolean"
- },
- "disableDuet": {
- "default": false,
- "description": "Disable the Duet feature for this video.",
- "type": "boolean"
- },
- "disableStitch": {
- "default": false,
- "description": "Disable the Stitch feature for this video.",
- "type": "boolean"
- },
- "privacyLevel": {
- "default": "private",
- "description": "The privacy level for the video. Options are: <ul>\n <li>`public` - video is visible to everyone</li>\n <li>`friends` - video is visible to friends only</li>\n <li>`private` - video is only visible to you</li>\n</ul>",
- "enum": [
- "public",
- "friends",
- "private"
- ],
- "type": "string"
- },
- "title": {
- "description": "A title for the video that will be displayed on TikTok.",
- "maxLength": 150,
- "type": "string"
- }
- },
- "type": "object"
- },
- "provider": {
- "default": "tiktok",
- "description": "The destination to send video to - set to `tiktok` for TikTok.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- },
- {
- "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
- "properties": {
- "options": {
- "description": "Additional Akamai NetStorage configuration options.",
- "properties": {
- "cpCode": {
- "description": "The Content Provider code (CP code) for the NetStorage upload directory.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": [
- "string",
- "null"
- ]
- },
- "host": {
- "description": "The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.",
- "type": "string"
- },
- "path": {
- "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "host",
- "cpCode"
- ]
- },
- "provider": {
- "default": "akamai-netstorage",
- "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- },
- {
- "description": "Send videos and assets to [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/). Send files to any container with a custom prefix and filename. Azure credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/azure-blob-storage), not in the request.",
- "properties": {
- "options": {
- "description": "Additional Azure Blob Storage configuration options.",
- "properties": {
- "accountName": {
- "description": "The Azure Storage account name.",
- "type": "string"
- },
- "container": {
- "description": "The Blob container name. The container must exist in the Azure Storage account before files can be sent.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": [
- "string",
- "null"
- ]
- },
- "prefix": {
- "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "accountName",
- "container"
- ]
- },
- "provider": {
- "default": "azure-blob-storage",
- "description": "The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- }
-]New value: +[
+ {
+ "$ref": "#/$defs/ShotstackDestination"
+ },
+ {
+ "$ref": "#/$defs/MuxDestination"
+ },
+ {
+ "$ref": "#/$defs/S3Destination"
+ },
+ {
+ "$ref": "#/$defs/GoogleCloudStorageDestination"
+ },
+ {
+ "$ref": "#/$defs/GoogleDriveDestination"
+ },
+ {
+ "$ref": "#/$defs/VimeoDestination"
+ },
+ {
+ "deprecated": true,
+ "description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
+ "properties": {
+ "options": {
+ "deprecated": true,
+ "description": "Additional TikTok configuration options.",
+ "properties": {
+ "disableComment": {
+ "default": false,
+ "description": "Disable comments on this video.",
+ "type": "boolean"
+ },
+ "disableDuet": {
+ "default": false,
+ "description": "Disable the Duet feature for this video.",
+ "type": "boolean"
+ },
+ "disableStitch": {
+ "default": false,
+ "description": "Disable the Stitch feature for this video.",
+ "type": "boolean"
+ },
+ "privacyLevel": {
+ "default": "private",
+ "description": "The privacy level for the video. Options are: <ul>\n <li>`public` - video is visible to everyone</li>\n <li>`friends` - video is visible to friends only</li>\n <li>`private` - video is only visible to you</li>\n</ul>",
+ "enum": [
+ "public",
+ "friends",
+ "private"
+ ],
+ "type": "string"
+ },
+ "title": {
+ "description": "A title for the video that will be displayed on TikTok.",
+ "maxLength": 150,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "provider": {
+ "default": "tiktok",
+ "description": "The destination to send video to - set to `tiktok` for TikTok.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "provider"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
+ "properties": {
+ "options": {
+ "description": "Additional Akamai NetStorage configuration options.",
+ "properties": {
+ "cpCode": {
+ "description": "The Content Provider code (CP code) for the NetStorage upload directory.",
+ "type": "string"
+ },
+ "filename": {
+ "$ref": "#/$defs/filename"
+ },
+ "host": {
+ "description": "The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.",
+ "type": "string"
+ },
+ "path": {
+ "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "host",
+ "cpCode"
+ ]
+ },
+ "provider": {
+ "default": "akamai-netstorage",
+ "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "provider"
+ ],
+ "type": "object"
+ },
+ {
+ "description": "Send videos and assets to [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/). Send files to any container with a custom prefix and filename. Azure credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/azure-blob-storage), not in the request.",
+ "properties": {
+ "options": {
+ "description": "Additional Azure Blob Storage configuration options.",
+ "properties": {
+ "accountName": {
+ "description": "The Azure Storage account name.",
+ "type": "string"
+ },
+ "container": {
+ "description": "The Blob container name. The container must exist in the Azure Storage account before files can be sent.",
+ "type": "string"
+ },
+ "filename": {
+ "$ref": "#/$defs/filename"
+ },
+ "prefix": {
+ "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "accountName",
+ "container"
+ ]
+ },
+ "provider": {
+ "default": "azure-blob-storage",
+ "description": "The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "provider"
+ ],
+ "type": "object"
+ }
+]
addedInput schema / $defs / GoogleCloudStorageDestinationOptions / properties / filename / $ref
Added value: +"#/$defs/filename_2"
removedInput schema / $defs / GoogleCloudStorageDestinationOptions / properties / filename / description
Removed value: -"Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
removedInput schema / $defs / GoogleCloudStorageDestinationOptions / properties / filename / type
Removed value: -"string"
addedInput schema / $defs / GoogleDriveDestinationOptions / properties / filename / $ref
Added value: +"#/$defs/filename_2"
removedInput schema / $defs / GoogleDriveDestinationOptions / properties / filename / description
Removed value: -"Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
removedInput schema / $defs / GoogleDriveDestinationOptions / properties / filename / type
Removed value: -"string"
addedInput schema / $defs / S3DestinationOptions / properties / filename / $ref
Added value: +"#/$defs/filename_2"
removedInput schema / $defs / S3DestinationOptions / properties / filename / description
Removed value: -"Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images."
removedInput schema / $defs / S3DestinationOptions / properties / filename / type
Removed value: -"string"
addedInput schema / $defs / filename
Added value: +{
+ "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedInput schema / $defs / filename_2
Added value: +{
+ "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
+ "type": "string"
+}
changedInput schema / properties / confirm / description
Previous value: -"Must be true for this exact requested render, generation, mutation, upload URL or deletion."New value: +"Set true only when the user asked for exactly this action."
addedInput schema / properties / payload / $defs / AudioEnhancement / $ref
Added value: +"#/$defs/AudioEnhancement"
removedInput schema / properties / payload / $defs / AudioEnhancement / description
Removed value: -"An audio enhancement that can be applied to the audio content of a rendition.\nThe following providers are available: <ul>\n <li><a href=\"#tocs_dolbyenhancement\">DolbyEnhancement</a></li>\n</ul>"
removedInput schema / properties / payload / $defs / AudioEnhancement / oneOf
Removed value: -[
- {
- "$ref": "#/$defs/DolbyEnhancement"
- }
-]
removedInput schema / properties / payload / $defs / AudioEnhancement / type
Removed value: -"object"
removedInput schema / properties / payload / $defs / AudioEnhancement / unevaluatedProperties
Removed value: -false
addedInput schema / properties / payload / $defs / Destinations / $ref
Added value: +"#/$defs/Destinations"
removedInput schema / properties / payload / $defs / Destinations / additionalProperties
Removed value: -false
removedInput schema / properties / payload / $defs / Destinations / anyOf
Removed value: -[
- {
- "$ref": "#/$defs/ShotstackDestination"
- },
- {
- "$ref": "#/$defs/MuxDestination"
- },
- {
- "$ref": "#/$defs/S3Destination"
- },
- {
- "$ref": "#/$defs/GoogleCloudStorageDestination"
- },
- {
- "$ref": "#/$defs/GoogleDriveDestination"
- },
- {
- "$ref": "#/$defs/VimeoDestination"
- },
- {
- "deprecated": true,
- "description": "**Notice: The TikTok destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to TikTok. TikTok credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/tiktok), not in the request.",
- "properties": {
- "options": {
- "deprecated": true,
- "description": "Additional TikTok configuration options.",
- "properties": {
- "disableComment": {
- "default": false,
- "description": "Disable comments on this video.",
- "type": "boolean"
- },
- "disableDuet": {
- "default": false,
- "description": "Disable the Duet feature for this video.",
- "type": "boolean"
- },
- "disableStitch": {
- "default": false,
- "description": "Disable the Stitch feature for this video.",
- "type": "boolean"
- },
- "privacyLevel": {
- "default": "private",
- "description": "The privacy level for the video. Options are: <ul>\n <li>`public` - video is visible to everyone</li>\n <li>`friends` - video is visible to friends only</li>\n <li>`private` - video is only visible to you</li>\n</ul>",
- "enum": [
- "public",
- "friends",
- "private"
- ],
- "type": "string"
- },
- "title": {
- "description": "A title for the video that will be displayed on TikTok.",
- "maxLength": 150,
- "type": "string"
- }
- },
- "type": "object"
- },
- "provider": {
- "default": "tiktok",
- "description": "The destination to send video to - set to `tiktok` for TikTok.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- },
- {
- "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
- "properties": {
- "options": {
- "description": "Additional Akamai NetStorage configuration options.",
- "properties": {
- "cpCode": {
- "description": "The Content Provider code (CP code) for the NetStorage upload directory.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": [
- "string",
- "null"
- ]
- },
- "host": {
- "description": "The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.",
- "type": "string"
- },
- "path": {
- "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "host",
- "cpCode"
- ]
- },
- "provider": {
- "default": "akamai-netstorage",
- "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- },
- {
- "description": "Send videos and assets to [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/). Send files to any container with a custom prefix and filename. Azure credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/azure-blob-storage), not in the request.",
- "properties": {
- "options": {
- "description": "Additional Azure Blob Storage configuration options.",
- "properties": {
- "accountName": {
- "description": "The Azure Storage account name.",
- "type": "string"
- },
- "container": {
- "description": "The Blob container name. The container must exist in the Azure Storage account before files can be sent.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": [
- "string",
- "null"
- ]
- },
- "prefix": {
- "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "required": [
- "accountName",
- "container"
- ]
- },
- "provider": {
- "default": "azure-blob-storage",
- "description": "The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.",
- "type": "string"
- }
- },
- "required": [
- "provider"
- ],
- "type": "object"
- }
-]
removedInput schema / properties / payload / $defs / Destinations / description
Removed value: -"A destination is a location where assets can be sent to for serving or hosting. Videos, images and audio files that are rendered by the [Edit API](#shotstack-edit) and [source](#tocs_source) and [rendition](#tocs_rendition) files generated by the [Ingest API](#shotstack-ingest) can be sent to destinations. You can also fetch a file from any public URL and [transfer](#transfer-asset) it to a destination. A file can be sent to one or more destinations including 3rd party destinations.\n\nBy default all ingested and generated assets are automatically sent to the [Shotstack hosting destination](https://shotstack.io/docs/guide/serving-assets/hosting/). You can [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from by setting the Shotstack destination **exclude** property to **true**."
removedInput schema / properties / payload / $defs / Destinations / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / DolbyEnhancement / $ref
Added value: +"#/$defs/DolbyEnhancement"
removedInput schema / properties / payload / $defs / DolbyEnhancement / description
Removed value: -"Dolby.io audio enhancement provider. Credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/dolby), not in the request."
removedInput schema / properties / payload / $defs / DolbyEnhancement / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/DolbyEnhancementOptions",
- "description": "Additional Dolby configuration and features."
- },
- "provider": {
- "default": "dolby",
- "description": "The enhancement provider to use - set to `dolby` for Dolby.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / DolbyEnhancement / required
Removed value: -[
- "provider",
- "options"
-]
removedInput schema / properties / payload / $defs / DolbyEnhancement / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / DolbyEnhancementOptions / $ref
Added value: +"#/$defs/DolbyEnhancementOptions"
removedInput schema / properties / payload / $defs / DolbyEnhancementOptions / description
Removed value: -"Options for the Dolby.io audio enhancement provider."
removedInput schema / properties / payload / $defs / DolbyEnhancementOptions / properties
Removed value: -{
- "preset": {
- "description": "The preset to use for the audio enhancement. The following presets are available: <ul>\n <li>`conference` - Conference</li>\n <li>`interview` - Interview</li>\n <li>`lecture` - Lecture</li>\n <li>`meeting` - Meeting</li>\n <li>`mobile_phone` - Mobile Phone</li>\n <li>`music` - Music</li>\n <li>`podcast` - Podcast</li>\n <li>`studio` - Studio</li>\n <li>`voice_over` - Voice Over</li>\n</ul>",
- "enum": [
- "conference",
- "interview",
- "lecture",
- "meeting",
- "mobile_phone",
- "music",
- "podcast",
- "studio",
- "voice_over"
- ],
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / DolbyEnhancementOptions / required
Removed value: -[
- "preset"
-]
addedInput schema / properties / payload / $defs / Enhancements / $ref
Added value: +"#/$defs/Enhancements"
removedInput schema / properties / payload / $defs / Enhancements / description
Removed value: -"Enhancements that can be applied to a rendition. Currently only supports the Dolby audio enhancement."
removedInput schema / properties / payload / $defs / Enhancements / properties
Removed value: -{
- "audio": {
- "$ref": "#/$defs/AudioEnhancement",
- "description": "An audio enhancement that can be applied to the audio content of the rendition."
- }
-}
removedInput schema / properties / payload / $defs / Enhancements / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / GoogleCloudStorageDestination / $ref
Added value: +"#/$defs/GoogleCloudStorageDestination"
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestination / description
Removed value: -"Send videos and assets to a [Google Cloud Storage](https://cloud.google.com/storage) bucket. Send files with your own prefix and filename. Google Cloud credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/google-cloud-storage), not in the request."
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestination / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/GoogleCloudStorageDestinationOptions",
- "description": "Additional Google Cloud Storage configuration options."
- },
- "provider": {
- "default": "google-cloud-storage",
- "description": "The destination to send assets to - set to `google-cloud-storage` for Google Cloud Storage.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / GoogleCloudStorageDestinationOptions / $ref
Added value: +"#/$defs/GoogleCloudStorageDestinationOptions"
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestinationOptions / description
Removed value: -"Pass additional options to control how files are stored in Google Cloud Storage."
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestinationOptions / properties
Removed value: -{
- "bucket": {
- "description": "The bucket name to send files to. The bucket must exist in the Google Cloud Storage account before files can be sent.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": "string"
- },
- "prefix": {
- "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / GoogleCloudStorageDestinationOptions / required
Removed value: -[
- "bucket"
-]
addedInput schema / properties / payload / $defs / GoogleDriveDestination / $ref
Added value: +"#/$defs/GoogleDriveDestination"
removedInput schema / properties / payload / $defs / GoogleDriveDestination / description
Removed value: -"Send rendered videos and assets to the [Google Drive](https://shotstack.io/docs/guide/serving-assets/destinations/google-drive/) cloud storage service. Google Drive uses OAuth and you must authenticate and link your Google account via [dashboard](https://dashboard.shotstack.io/integrations/google-drive), not in the request."
removedInput schema / properties / payload / $defs / GoogleDriveDestination / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/GoogleDriveDestinationOptions",
- "description": "Additional Google Drive configuration and features. If omitted, files are saved to the root of My Drive using the default Shotstack filename."
- },
- "provider": {
- "default": "google-drive",
- "description": "The destination to send assets to - set to `google-drive` for Google Drive.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / GoogleDriveDestination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / GoogleDriveDestination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / GoogleDriveDestinationOptions / $ref
Added value: +"#/$defs/GoogleDriveDestinationOptions"
removedInput schema / properties / payload / $defs / GoogleDriveDestinationOptions / description
Removed value: -"Pass the folder ID and options to configure how assets are stored in Google Drive."
removedInput schema / properties / payload / $defs / GoogleDriveDestinationOptions / properties
Removed value: -{
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": "string"
- },
- "folderId": {
- "description": "The Google Drive folder ID where the asset will be stored. If omitted, the asset is saved to the root of My Drive. The folder ID can be retrieved from the URL when logged in to Google Drive, e.g. <a href=\"#\">https://drive.google.com/drive/u/0/folders/1r-eTY6OLO8tzQRKwMyq-fIrQ_7AJEI6A</a>.",
- "type": "string"
- }
-}
addedInput schema / properties / payload / $defs / MuxDestination / $ref
Added value: +"#/$defs/MuxDestination"
removedInput schema / properties / payload / $defs / MuxDestination / deprecated
Removed value: -true
removedInput schema / properties / payload / $defs / MuxDestination / description
Removed value: -"**Notice: The Mux destination is deprecated.** It continues to work, with no behaviour change for existing integrations.\nSend videos to the [Mux](https://www.mux.com/docs) video hosting and streaming service. Mux credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/mux), not in the request."
removedInput schema / properties / payload / $defs / MuxDestination / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/MuxDestinationOptions",
- "description": "Additional Mux configuration and features."
- },
- "provider": {
- "default": "mux",
- "description": "The destination to send video to - set to `mux` for Mux.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / MuxDestination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / MuxDestination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / MuxDestinationOptions / $ref
Added value: +"#/$defs/MuxDestinationOptions"
removedInput schema / properties / payload / $defs / MuxDestinationOptions / deprecated
Removed value: -true
removedInput schema / properties / payload / $defs / MuxDestinationOptions / description
Removed value: -"**Notice: MuxDestinationOptions, like the Mux destination, is deprecated.** It continues to work, with no behaviour change for existing integrations.\nPass additional options to control how Mux processes video. Currently supports playback_policy and passthrough options."
removedInput schema / properties / payload / $defs / MuxDestinationOptions / properties
Removed value: -{
- "passthrough": {
- "description": "Sets the Mux `passthrough` option. Max 255 characters.",
- "maxLength": 255,
- "type": "string"
- },
- "playbackPolicy": {
- "description": "Sets the Mux `playback_policy` option. Value is an array of strings - use `public`, `signed`, or both.",
- "items": {
- "enum": [
- "public",
- "signed"
- ],
- "type": "string"
- },
- "type": "array"
- }
-}
addedInput schema / properties / payload / $defs / Outputs / $ref
Added value: +"#/$defs/Outputs"
removedInput schema / properties / payload / $defs / Outputs / description
Removed value: -"The output renditions and transformations that should be generated from the source file."
removedInput schema / properties / payload / $defs / Outputs / properties
Removed value: -{
- "renditions": {
- "description": "The output renditions and transformations that should be generated from the source file.",
- "items": {
- "$ref": "#/$defs/Rendition"
- },
- "type": "array"
- },
- "transcription": {
- "$ref": "#/$defs/Transcription",
- "description": "The transcription settings for the output file."
- }
-}
removedInput schema / properties / payload / $defs / Outputs / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / Rendition / $ref
Added value: +"#/$defs/Rendition"
removedInput schema / properties / payload / $defs / Rendition / description
Removed value: -"A rendition is a new output file that is generated from the source. The rendition can be encoded to a different format and have transformations applied to it such as resizing, cropping, etc..."
removedInput schema / properties / payload / $defs / Rendition / properties
Removed value: -{
- "enhance": {
- "$ref": "#/$defs/Enhancements",
- "description": "Apply media processing enhancements to the rendition using a third party provider. Currently only Dolby.io audio enhancement is available.",
- "type": "object"
- },
- "filename": {
- "description": "A custom name for the generated rendition file. The file extension will be automatically added based on the format of the rendition. If no filename is provided, the rendition ID will be used.",
- "type": "string"
- },
- "fit": {
- "description": "Set how the rendition should be scaled and cropped when using a size with an aspect ratio that is different from the source. Fit applies to both videos and images. <ul>\n <li>`crop` <b>(default)</b> - scale the rendition to fill the output area while maintaining the aspect ratio. The rendition will be cropped if it exceeds the bounds of the output.</li>\n <li>`cover` - stretch the rendition to fill the output without maintaining the aspect ratio.</li>\n <li>`contain` - fit the entire rendition within the output while maintaining the original aspect ratio.</li>\n</ul>",
- "enum": [
- "cover",
- "contain",
- "crop"
- ],
- "type": "string"
- },
- "fixOffset": {
- "description": "Attempt to fix audio and video sync issues. This can occur when recording devices, such as smartphones and\n web cams use compression techniques like [Variable Frame Rate](https://en.wikipedia.org/wiki/Variable_frame_rate)\n (VFR) which can cause audio and video to go out of sync. This option will attempt to fix the sync issues.",
- "type": "boolean"
- },
- "fixRotation": {
- "description": "Automatically reset the rotation of the video based on the orientation metadata in the video file. This is useful for videos recorded on smartphones that have orientation metadata that may not work correctly with certain video editing software, including the Shotstack Edit API.",
- "type": "boolean"
- },
- "format": {
- "description": "The output format to encode the file to. You can only encode a file to the same type, i.e. a video to a video or an image to an image. You can't encode a video as an image. The following formats are available: <ul>\n <li>`mp4` - mp4 video file (video only)</li>\n <li>`webm` - webm video file (video only)</li>\n <li>`mov` - mov video file (video only)</li>\n <li>`avi` - avi video file (video only)</li>\n <li>`mkv` - mkv video file (video only)</li>\n <li>`ogv` - ogv video file (video only)</li>\n <li>`wmv` - wmv video file (video only)</li>\n <li>`avif` - avif video file (video only)</li>\n <li>`gif` - animated gif file (video only)</li>\n <li>`jpg` - jpg image file (image only)</li>\n <li>`png` - png image file (image only)</li>\n <li>`webp` - webp image file (image only)</li>\n <li>`tif` - tif image file (image only)</li>\n <li>`mp3` - mp3 audio file (audio only)</li>\n <li>`wav` - wav audio file (audio only)</li>\n</ul>",
- "enum": [
- "mp4",
- "webm",
- "mov",
- "avi",
- "mkv",
- "ogv",
- "wmv",
- "avif",
- "gif",
- "mp3",
- "wav",
- "jpg",
- "png",
- "webp",
- "tif"
- ],
- "type": "string"
- },
- "fps": {
- "description": "Change the frame rate of a video asset. <ul>\n <li>`12` - 12fps</li>\n <li>`15` - 15fps</li>\n <li>`24` - 24fps</li>\n <li>`23.976` - 23.976fps</li>\n <li>`25` (default) - 25fps</li>\n <li>`29.97` - 29.97fps</li>\n <li>`30` - 30fps</li>\n <li>`48` - 48fps</li>\n <li>`50` - 50fps</li>\n <li>`59.94` - 59.94fps</li>\n <li>`60` - 60fps</li>\n</ul>",
- "enum": [
- 12,
- 15,
- 23.976,
- 24,
- 25,
- 29.97,
- 30,
- 48,
- 50,
- 59.94,
- 60
- ],
- "type": "number"
- },
- "keyframeInterval": {
- "description": "The keyframe interval is useful to optimize playback, seeking and smoother scrubbing in browsers. The value sets the number of frames between a keyframe. The lower the number, the larger the file. Try a value between 10 and 25 for smooth scrubbing.",
- "maximum": 300,
- "minimum": 1,
- "type": "integer"
- },
- "quality": {
- "description": "Adjust the visual quality of the video or image. The higher the value, the sharper the image quality but the larger file size and slower the encoding process. When specifying quality, the goal is to balance file size vs visual quality.\nQuality is a value between 1 and 100 where 1 is fully compressed with low image quality and 100 is close to lossless with high image quality and large file size. Sane values are between 50 and 75. Omitting the quality parameter will result in an asset optimised for encoding speed, file size and visual quality.",
- "maximum": 100,
- "minimum": 1,
- "type": "integer"
- },
- "resolution": {
- "description": "The preset output resolution of the video or image. This is a convenience property that sets the width and height based on industry standard resolutions. The following resolutions are available: <ul>\n <li>`preview` - 512px x 288px</li>\n <li>`mobile` - 640px x 360px</li>\n <li>`sd` - 1024px x 576px</li>\n <li>`hd` - 1280px x 720px</li>\n <li>`fhd` - 1920px x 1080px</li>\n</ul>",
- "enum": [
- "preview",
- "mobile",
- "sd",
- "hd",
- "fhd"
- ]
- },
- "size": {
- "$ref": "#/$defs/Size"
- },
- "speed": {
- "$ref": "#/$defs/Speed"
- }
-}
removedInput schema / properties / payload / $defs / Rendition / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / S3Destination / $ref
Added value: +"#/$defs/S3Destination"
removedInput schema / properties / payload / $defs / S3Destination / description
Removed value: -"Send videos and assets to an [Amazon S3](https://shotstack.io/docs/guide/serving-assets/destinations/s3/) bucket. Send files to any region with your own prefix and filename. AWS credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/s3), not in the request."
removedInput schema / properties / payload / $defs / S3Destination / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/S3DestinationOptions",
- "description": "Additional S3 configuration options."
- },
- "provider": {
- "default": "s3",
- "description": "The destination to send assets to - set to `s3` for S3.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / S3Destination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / S3Destination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / S3DestinationOptions / $ref
Added value: +"#/$defs/S3DestinationOptions"
removedInput schema / properties / payload / $defs / S3DestinationOptions / description
Removed value: -"Pass additional options to control how files are stored in S3."
removedInput schema / properties / payload / $defs / S3DestinationOptions / properties
Removed value: -{
- "acl": {
- "description": "Sets the S3 Access Control List (acl) permissions. Default is `private`. Must use a valid S3 [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl).",
- "type": "string"
- },
- "bucket": {
- "description": "The bucket name to send files to. The bucket must exist in the AWS account before files can be sent.",
- "type": "string"
- },
- "filename": {
- "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
- "type": "string"
- },
- "prefix": {
- "description": "A prefix for the file being sent. This is typically a folder name, i.e. `videos` or `customerId/videos`.",
- "type": "string"
- },
- "region": {
- "description": "Choose the region to send the file to. Must be a valid [AWS region](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) string like `us-east-1` or `ap-southeast-2`.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / S3DestinationOptions / required
Removed value: -[
- "region",
- "bucket"
-]
addedInput schema / properties / payload / $defs / ShotstackDestination / $ref
Added value: +"#/$defs/ShotstackDestination"
removedInput schema / properties / payload / $defs / ShotstackDestination / description
Removed value: -"Send videos and assets to the [Shotstack hosting and CDN](https://shotstack.io/docs/guide/serving-assets/destinations/shotstack/) service. This destination is enabled by default."
removedInput schema / properties / payload / $defs / ShotstackDestination / properties
Removed value: -{
- "exclude": {
- "description": "Set to `true` to [opt-out](https://shotstack.io/docs/guide/serving-assets/self-host/) from the Shotstack hosting and CDN service. All files must be downloaded within 24 hours of rendering.",
- "type": "boolean"
- },
- "provider": {
- "default": "shotstack",
- "description": "The destination to send assets to - set to `shotstack` for Shotstack hosting and CDN.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / ShotstackDestination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / ShotstackDestination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / Size / $ref
Added value: +"#/$defs/Size"
removedInput schema / properties / payload / $defs / Size / additionalProperties
Removed value: -false
removedInput schema / properties / payload / $defs / Size / description
Removed value: -"Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications."
removedInput schema / properties / payload / $defs / Size / properties
Removed value: -{
- "height": {
- "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.",
- "maximum": 4096,
- "minimum": 1,
- "type": "integer"
- },
- "width": {
- "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.",
- "maximum": 4096,
- "minimum": 1,
- "type": "integer"
- }
-}
removedInput schema / properties / payload / $defs / Size / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / Speed / $ref
Added value: +"#/$defs/Speed"
removedInput schema / properties / payload / $defs / Speed / description
Removed value: -"Set the playback speed of a video or audio file. Allows you to preserve the pitch of the audio so that it is sped up without sounding too high pitched or too low."
removedInput schema / properties / payload / $defs / Speed / properties
Removed value: -{
- "preservePitch": {
- "description": "Set whether to adjust the audio pitch or not. Set to false to make the audio sound higher or lower pitched. By default the pitch is preserved.",
- "type": "boolean"
- },
- "speed": {
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Set values less than 1 to slow down the playback speed, i.e. set speed to 0.5 to play back at half speed. Set values greater than 1 to speed up the playback speed, i.e. set speed to 2 to play back at double speed.",
- "format": "float",
- "maximum": 10,
- "minimum": 0,
- "type": "number"
- }
-}
removedInput schema / properties / payload / $defs / Speed / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / Transcription / $ref
Added value: +"#/$defs/Transcription"
removedInput schema / properties / payload / $defs / Transcription / description
Removed value: -"Generate a transcription of the audio in the video. The transcription can be output as a file in SRT or VTT format."
removedInput schema / properties / payload / $defs / Transcription / properties
Removed value: -{
- "format": {
- "description": "The output format of the transcription file. The following formats are available: <ul>\n <li>`srt` - SRT captions format</li>\n <li>`vtt` - VTT captions format</li>\n</ul>",
- "enum": [
- "srt",
- "vtt"
- ],
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / Transcription / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / VimeoDestination / $ref
Added value: +"#/$defs/VimeoDestination"
removedInput schema / properties / payload / $defs / VimeoDestination / description
Removed value: -"Send videos to [Vimeo](https://shotstack.io/docs/guide/serving-assets/destinations/vimeo/) video hosting and streaming service. Vimeo credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/vimeo), not in the request."
removedInput schema / properties / payload / $defs / VimeoDestination / properties
Removed value: -{
- "options": {
- "$ref": "#/$defs/VimeoDestinationOptions",
- "description": "Additional Vimeo configuration and features."
- },
- "provider": {
- "default": "vimeo",
- "description": "The destination to send video to - set to `vimeo` for Vimeo.",
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / VimeoDestination / required
Removed value: -[
- "provider"
-]
removedInput schema / properties / payload / $defs / VimeoDestination / type
Removed value: -"object"
addedInput schema / properties / payload / $defs / VimeoDestinationOptions / $ref
Added value: +"#/$defs/VimeoDestinationOptions"
removedInput schema / properties / payload / $defs / VimeoDestinationOptions / description
Removed value: -"Pass additional options to control how Vimeo publishes video, including name, description and privacy settings."
removedInput schema / properties / payload / $defs / VimeoDestinationOptions / properties
Removed value: -{
- "description": {
- "description": "A description of the video that will be displayed on the Vimeo website.",
- "type": "string"
- },
- "folderUri": {
- "description": "The Vimeo folder URI to upload the video to. The folder must already exist in your Vimeo account.",
- "type": "string"
- },
- "name": {
- "description": "A name or title for the video that will be displayed on the Vimeo website.",
- "type": "string"
- },
- "privacy": {
- "$ref": "#/$defs/VimeoDestinationPrivacyOptions",
- "description": "Options to control the visibility of videos and privacy features."
- }
-}
addedInput schema / properties / payload / $defs / VimeoDestinationPrivacyOptions / $ref
Added value: +"#/$defs/VimeoDestinationPrivacyOptions"
removedInput schema / properties / payload / $defs / VimeoDestinationPrivacyOptions / description
Removed value: -"Options to control the visibility of videos and privacy features."
removedInput schema / properties / payload / $defs / VimeoDestinationPrivacyOptions / properties
Removed value: -{
- "add": {
- "description": "Set whether other users can add the video to their collections.",
- "type": "boolean"
- },
- "comments": {
- "description": "Set who can comment on the video. Available options are: <ul>\n <li>`anybody` - Anyone can comment on the video.</li>\n <li>`nobody` - Only the video owner can comment on the video.</li>\n <li>`contacts` - Only contacts can comment on the video.</li>\n</ul>",
- "enum": [
- "anybody",
- "nobody",
- "contacts"
- ],
- "type": "string"
- },
- "download": {
- "description": "Set whether the video can be downloaded.",
- "type": "boolean"
- },
- "embed": {
- "description": "Set who can embed the video. Available options are: <ul>\n <li>`public` - Anyone can embed the video.</li>\n <li>`private` - Only the video owner can embed the video.</li>\n <li>`whitelist` - Only whitelisted domains can embed the video.</li>\n</ul>",
- "enum": [
- "public",
- "private",
- "whitelist"
- ],
- "type": "string"
- },
- "view": {
- "description": "Set who can view the videos. Available options are: <ul>\n <li>`anybody` - Anyone can view the video.</li>\n <li>`nobody` - Only the video owner can view the video.</li>\n <li>`contacts` - Only contacts can view the video.</li>\n <li>`password` - A password is required to view the video.</li>\n <li>`unlisted` - The video is not listed on Vimeo.</li>\n</ul>",
- "enum": [
- "anybody",
- "nobody",
- "contacts",
- "password",
- "unlisted"
- ],
- "type": "string"
- }
-}
removedInput schema / properties / payload / $defs / VimeoDestinationPrivacyOptions / type
Removed value: -"object"