Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepart and multipart uploads will be allowed on https://api.cimediacloud.com until 6/1/2014.
We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.
You can now cancel an asset archive operation which will stop the archive process and make the asset's source file available for download immediately. You cannot cancel archive for an asset that is already archived. You must restore the asset in order to download the source file.
We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.
Users can now download proxies using Aspera with our updated Aspera Download endpoint. This new release is an interim, non-breaking version, however, a future version scheduled after 6/1/2014 will introduce breaking changes. In a future version (scheduled after 6/1/2014) the asperaDownloadConfigurations array elements will no longer contain the host, sshPort, targetRate, minRate, and httpFallback properties. Those will only be in the root of the JSON response.
Asset status will now get updated to 'Failed' if the Aspera transfer process fails for an asset. If this happens you can easily generate a new token using the Aspera Upload Only endpoint and try the upload again.
Our 4xx responses now contain error codes in addition to the existing error messages. The error codes are designed to be machine readable codes that applications can use to better understand the context of our 4xx error responses and react appropriately.
We added the ability to declare a specific Workspace and/or folder when creating an asset. Supplying one or both of these will place the asset into the supplied Workspace and/or folder (please note, the folder must be a member of the Workspace if both are supplied). If neither is supplied, the asset will be created in the user's personal Workspace and root folder. The endpoints affected are Create an Asset, Singlepart HTTP Create and Upload, Multipart HTTP Create and Upload, Aspera Create and Upload.
Previously, when creating and uploading an asset using Singlepart HTTP Create and Upload, asset metadata could be declared in the request header. With this release the asset metadata, if supplied, must be declared in the request body. We made this change to enforce consistency across our APIs.
Previous curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Metadata: { 'Resolution' : '1080p', 'Language' : 'English' }" \ -F filename=@Movie.mov Updated curl command
curl -XPOST -i "https://io.cimediacloud.com/upload" \ -H "Authorization: Bearer ACCESS_TOKEN" \ -F filename=@Movie.mov -F metadata="{ 'metadata' : { 'Resolution' : '1080p', 'Language' : 'English' }, 'workspaceId' : 'a585b641a60843498543597d16ba0108', 'folderId' : 'a585b641a60843498543597d16ba0108' }" Using the Open File Request endpoint you can now get the contribution details of a File Request.
Ci users can now create an Element from an existing Asset.
There are two new parameters for Creating a File Request. The first is allowedFileExtensions which can be used to restrict the types of file extensions that can be uploaded. The second is distributionListIds which can be used to quickly add lists of users to be notified about a File Request.
A new Events API is available for retrieving events from multiple Workpaces or Catalogs. Additionally, we've added multiple new event types. NOTE: We deprecated the previous List Workspace Events API. It will remain available but we suggest you upgrade to the new version.
When subscribing to receive webhooks messages you can now include MoveAsset and CopyAsset events.
Using the Get element details endpoint you can now rename elements in the target destination.
Ci users can now create an asset from a URL that points to a source file. This is helpful for customers who need to migrate content into Ci from other cloud based platforms without having to download files and re-upload them into Ci.
Using the HTTP download endpoint you can now rename assets, proxies and thumbnails in the target destination.
When creating a playback stream, you can now specify a name to display for the caption file when the user wants to change languages.
You will now see a 2000px type in the thumbnails array that is twice as large as the large thumbnail currently. This has been added to the following resources:
You can now use the Update Multiple Assets' Metadata and Update Multiple Assets endpoints to set the metadata and description of multiple assets, respectively.
Additional technical metadata fields have been added for assets in the following resources:
When getting an asset's HTTP download link you can now specify custom expiration. This is helpful if you want cache the download link for very long periods of time.
You can now use the Update Workspace API to update Team Workspaces.
Users can now restore the contents of a folder by using the Restore Folder API.
We've added a new resource, Network Events, that allows clients to retrieve events (like Workspaces created and deleted) that occurred in a given Network.
You can now use the Create Workspace API to create Team Workspaces.
We've made public four MediaBox APIs:
When creating a playback stream you can now specify multiple caption sources to support multiple languages.
When creating a MediaBox you can now send folderIds in addition to assetIds so users can view a folder's contents in a MediaBox.
'AssetMetadataChange' and 'FolderMetadataChange' events added to the List Workspace Events resource.
The Aspera push transfer resource can now send folders to external Aspera nodes.
'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.
We now return custom folder metadata in the following resources:
Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.
Users can now sort search results by file name using the Search Workspace Contents resource.
'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.
Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.
Users can now archive the contents of a folder by using the Archive Folder API.
When creating a MediaBox you can now set a flag to notify the calling user when someone edits, closes or re-opens their MediaBox. The new property is called notifyOnChange.
Users can now create transcode jobs using the new General Media Service Jobs API. This new API gives customers the ability create new Assets or Elements by transcoding a source video Asset with optional specifications.
Users can now create File Requests through our APIs using the Create File Request resource.
Users can now specify whether the recipients of a MediaBox should be allowed to download either the asset source, its previews and/or its elements, by using the Create MediaBox resource. Also, the 'allowDownload' field has been deprecated.
Users can now create multiple assets with a single operation using the Create Multiple Assets resource.
We now create PDF proxies and image thumbnails when you ingest doc, docx, ppt, pptx, and txt files. The proxy type for PDF proxies is 'document-pdf' and is available in the following resources:
You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.
You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:
A link to the HLS Playlist is now included in:
You can now perform bulk operations for asset archive, cancel archive and restore.
Links to individual caption files are now included in the Create Playback Streams API.
Custom playback streams can now be created using the Create Playback Streams API.
The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.
When getting element information you can now specify custom expiration for the element download URL. This is helpful if you want cache the download link for very long periods of time.
When updating an asset you can now use the ingestConfiguration property to add or update custom audio mappings. Note: this update will fail if the asset already has one or more proxies created.
Ci API no longer supports HTTP fallback for Aspera transfers. If a true value for httpFallback is specified to an Aspera transfer client it will be ignored.
When creating an asset you can now use the ingestConfiguration property to configure custom ingest settings. This gives greater control over proxy generation and audio mapping customization. Additionally, you can configure your asset to auto-archive immediately after being uploaded.
You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.
Thumbnails and elements are now available for download when using the Aspera download resource.
The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.
You can now add, update or delete user metadata items of an asset.
You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.
You can now request the creation of thumbnails and audio proxies using the Jobs resource.
You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.
You can now request custom profiles that can be used when generating proxies and caption files from the Jobs resource. Custom profiles are a feature of Company Networks. If you want to learn more, please drop a line to Customer Service.
You can now move folders into a new target folder using the Move Folders resource.
You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.
You can now initiate Aspera transfers from Ci to externally hosted Aspera servers using the Create Aspera Push Transfer resource. Additionally, you can get the transfer's status.
You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.
You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.
You can now create and update webhooks to get notified about 'JobStatusChange' events. These events occur when a media service job get processed and it's status is updated.
A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.
You can now request the creation of media service jobs for existing assets using the Jobs resource. Additionally, you can get the details of those jobs using the Get Jobs resource.
You can now download asset thumbnails using the HTTP Download resource.
You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.
You can now download asset proxies using the HTTP Download resource.
You can now search for assets and folders using the Search Workspace Contents endpoint.
You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.
A new isDeleted property has been added to List Workspaces for User and Get Workspace Details so you know if a Workspace is active or deleted.
Note: when listing a user's workspaces you will only get active workspaces, however, when getting a workspace's details you can get information about both active and deleted workspaces.
When creating a MediaBox you can now set a flag to notify the MediaBox owner when someone opens their MediaBox. The new property is called notifyOnOpen.
You can now use the uploadCompleteDate property to give an exact date and time when an asset was uploaded. This new property is available in the following resources:
The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.
You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.
You can now retrieve information about automatically generated filmstrips and waveforms for your assets through the new filmstrips and waveforms fields in the Asset Object.
The derivedTimeCode field is now available in the asset's technical metadata. Derived timecode is a standardized timecode derived by evaluating stream metadata and converting to drop frame format (if using drop frame rate).
You can now retrieve an asset's raw technical metadata file using the technicalMetadata.location field in the Asset Object. Additionally, you can use technicalMetadata.size to get the technical metadata file size.
We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.
You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.
In the following endpoints you can now retrieve acquisitionSource.name to the get the client that uploaded an asset. Note: this already exists in Get Asset Details and Get Multiple Assets' Details.
You can now move assets into a different folder using the Move Multiple Assets resource.
Cover elements are image representations of an asset that appear in the thumbnails array of the Asset Object. With the new Upload Cover Elements resource, you can now replace the default cover element automatically generated by Ci.
You can now create a delegate authentication token that can be used to upload cover elements from Javascript clients. For more details, please review Using a Delegate Token.
You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:
You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events
You can now obtain the technical metadata of an asset in the following resources:
When getting asset information you can now specify custom expirations for asset thumbnail, proxy, and HLS playlist urls. This is helpful if you want cache the thumbnail link for very long periods of time. Additionally, it can be helpful to limit the amount of time a proxy or hls playlist is available for viewing. Both Get Asset Details and Get Multiple Assets' Details have this new functionality.
We've added a runtime.video property to the Get Workspace Details and List Workspaces for User. This will give total video runtime for all assets within a given workspace.
We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.
You can now set a MediaBox to expire by providing an exact datetime value in the
You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:
The following updates were made to the List Workspaces For User resource:
We've added the ability to retrieve folder information with the new Get Folder Details endpoint.
We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.
We've added the ability to download multiple assets in a single Aspera session with the new Aspera Bulk Download endpoint.
For consistency, we added the following array and array properties to the original Aspera Download endpoint. These properties contain redundant values but provide a consistent response format with the new Aspera bulk download.
You can now use the following endpoints for bulk operations:
We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.
We added two new properties to Get Workspace Details and List Workspaces for User:
The following endpoints now return the asset runtime, if available:
Now it is possible to set the asset description when creating or updating an asset.
We added a new property to Get Workspace Details and List Workspaces for User:
We added two new properties to Get Workspace Details and List Workspaces for User:
The new Aspera Bulk Upload endpoint will let you create and upload multiple assets with a single API call and a single Aspera transfer session.
You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.
When getting Aspera Download configuration information the following properties, which have marked as obsolete for some time, are no longer returned within the asperaDownloadConfigurations array items. Please note, these properties are included in the root of the response.
The Upload Status endpoint will now show upload status for assets when upload information is no longer available from Aspera. This upload information is now derived from other data sources.
The following endpoints now return the asset description, if available:
HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.
Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.
Elements are separate files that can be uploaded and associated with your primary Assets. You can read more about them here. You can now upload an element, get an element's details, or list an asset's elements.
We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.
We've added additional thumbnail and proxy attributes to the thumbnail and proxy arrays returned for an asset object. See the Previews section for more information.
We now return a thumbnail type called "small" that will be replacing the "standard" thumbnail type. The dimensions of the thumbnail will remain the same. As of the writing of this log entry both types will be returned when getting asset information. However, we will be removing the "standard" type after 2/1/15.
Medium resolution thumbnails are now generated for uploaded images.
The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.
The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.
Multipart Upload now supports uploads of up to 5 terabytes.
We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.
Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.
We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.
Users can now update asset and folder names with the Update an Asset and Update a Folder resources.
The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.
Get Asset Details now returns the set of all thumbnails and proxies available for the asset. Although the proxyUrl and thumbnailUrl properties are still returned, they are considered obsolete and clients are encouraged to use proxies and thumbnails instead.
We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.
The following resources will now return a new createdBy property that includes user id, name, and email. This property appears in asset and folder detail information.
Asset must be uploaded before download information is returned.
We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.
We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.
We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.
List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.
List Folder Contents now supports the ability to sort results by item name, type, status or creation date.
We've expanded folder support with the ability to create, trash, untrash and delete folders.
The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.
The contents property was renamed to items, to improve consistency with other resource representations.
Singlepart and multipart HTTP uploads now use https://io.cimediacloud.com. This change will allow us to scale our upload infrastructure independently as demand changes over time. Singlepa