Change Log

June 14, 2018

New Events for the Workspace Events API

'RenameAsset' and 'RenameFolder' events added to the List Workspace Events resource.

Get Folder Metadata

We now return custom folder metadata in the following resources:

May 23, 2018

New Bulk Change Metadata for Folders API

Users can now set user metadata to folders with a single operation using the Change Folders' Metadata resource.

New Sort Option for Search

Users can now sort search results by file name using the Search Workspace Contents resource.

New Events for the Workspace Events API

'CopyAsset' and 'AssetArchiveStatusChange' events added to the List Workspace Events resource.

April 16, 2018

New File Request property

Users can now specify if a File Request should require the contributor to provide an email when using the Create File Request API.

February 9, 2018

New Archive Folder API

Users can now archive the contents of a folder by using the Archive Folder API.

January 5, 2018

New MediaBox Notifications

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.

December 8, 2017

New General Media Services API

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.

November 17, 2017

New Create File Request API

Users can now create File Requests through our APIs using the Create File Request resource.

New properties in Create MediaBox API

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.

July 31, 2017

New Bulk Create Assets API

Users can now create multiple assets with a single operation using the Create Multiple Assets resource.

PDF Proxies Now Created for Documents

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:

June 13, 2017

Aspera Push Transfer Now Supports SSH Key Authentication

You can now provide an SSH private key using the sshPrivateKey property when initiating an Aspera push transfer.

May 10, 2017

New Folder property

You can see information about a folder's parent folder using the new ParentFolder property. This new property is available in the following resources:

April 19, 2017

HLS Playlist

A link to the HLS Playlist is now included in:

March 21, 2017

New Bulk Archive and Restore Operations

You can now perform bulk operations for asset archive, cancel archive and restore.

February 23, 2017

New Feature: Playback Streams API Captions

Links to individual caption files are now included in the Create Playback Streams API.

February 16, 2017

New Feature: Playback Streams API

Custom playback streams can now be created using the Create Playback Streams API.

January 26, 2017

Aspera push transfer for asset elements, proxies, and thumbnails

The Aspera push transfer resource can now send asset elements, proxies, and thumbnails to external Aspera nodes.

November 29, 2016

New Feature: Custom expiration for element download URL

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.

November 10, 2016

Update ingest configuration for an asset's audio mappings

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.

Deprecated HTTP fallback for Aspera transfers

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.

November 1, 2016

Introducing custom ingest configurations

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.

October 19, 2016

New supported event types for Webhooks

You can now create and update webhooks to get notified about 'AssetArchiveStatusChange' and 'AssetRestoreStatusChange' events.

October 12, 2016

Aspera download for thumbnails and elements

Thumbnails and elements are now available for download when using the Aspera download resource.

Aspera Bulk Upload for existing assets

The Aspera Bulk Upload endpoint now supports existing assets when generating the Aspera upload configuration information.

September 28, 2016

User Metadata endpoints

You can now add, update or delete user metadata items of an asset.

Get media service jobs by id

You can now get details about one or more media service jobs using the Get Job Details and the Get Multiple Jobs' Details resources.

September 16, 2016

Media service jobs now support thumbnails and audio proxies

You can now request the creation of thumbnails and audio proxies using the Jobs resource.

Job Progress

You can now retrieve job progress percentage for some job types. See Get Asset Jobs for more details.

September 7, 2016

Custom profiles for proxy and caption jobs

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.

August 10, 2016

Move Folders

You can now move folders into a new target folder using the Move Folders resource.

New event type filter in List Workspace Events

You can now use the event type filter 'MoveFolder' when Listing Workspace Events to get information on folders that have been moved.

August 5, 2016

Aspera Push Transfer

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.

Premium proxies on request

You can now request premium proxies to be generated using the Jobs resource. The specs of these proxies are detailed in the Previews section.

July 26, 2016

Asset Ingest jobs are now reported by the Get Jobs API

You can now get the details of the jobs created during the asset ingest process using the Get Jobs resource.

New supported event types for Webhooks

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.

New Workspace property

A new createdBy JSON object has been added to List Workspaces for User and Get Workspace Details.

July 12, 2016

New feature: Create media service jobs for existing assets

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.

June 21, 2016

HTTP download for asset thumbnails

You can now download asset thumbnails using the HTTP Download resource.

June 10, 2016

New supported event types for Webhooks

You can now create and update webhooks to get notified about 'TrashAsset' and 'DeleteAsset' events.

HTTP download for asset proxies

You can now download asset proxies using the HTTP Download resource.

June 3, 2016

New feature: Search assets and folders

You can now search for assets and folders using the Search Workspace Contents endpoint.

New Sort Options

You can now sort by 'size' and 'createdBy' in the following endpoints. Note: 'size' only sorts by asset size and not folder size.

May 11, 2016

New Workspace property

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.

New option for creating MediaBoxes

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.

New Asset property

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:

April 26, 2016

Additional waveform specs available

The sampleMethod, maxAmplitude, and samplesPerSecond fields are now available in the waveform fields when getting asset details.

April 13, 2016

New feature: Webhooks

You can now create and manage Webhooks, allowing your applications to receive event notifications via callback URLs.

Filmstrips and waveforms available

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.

New Technical Metadata field

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).

March 3, 2016

Technical metadata file now available

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.

New Upload Transfer Type value

We've added a new uploadTransferType value called WorkspaceSend. This value indicates an asset was sent from one workspace to another workspace.

New event type filter in List Workspace Events

You can now detect when an asset was moved to a different folder by using the event type filter 'MoveAsset' when Listing Workspace Events.

New field added

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.

December 16, 2015

New Feature: Move Assets

You can now move assets into a different folder using the Move Multiple Assets resource.

New Feature: Upload Cover Elements

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.

New feature: Create delegate token to authorize Cover Element Upload

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.

December 2, 2015

New feature: Audio mapping customizations for video assets

You can now specify custom audio mappings between the source file and its proxies when creating a new video asset through the following resources:

November 17, 2015

Improvement: Added new event type filter in List Workspace Events

You can now retrieve a list of assets that have finished processing using the event type filter 'AssetProcessingFinished' when Listing Workspace Events

November 6, 2015

New Feature: Technical metadata

You can now obtain the technical metadata of an asset in the following resources:

October 15, 2015

New Feature: Custom expirations for thumbnail, proxy, and HLS playlist urls

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.

Update: New properties for Workspace

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.

October 2, 2015

New Feature: Copy Multiple Assets

We've added the ability to copy assets into specific workspaces with the new Copy Multiple Assets endpoint.

September 2, 2015

Improvement: Set MediaBox expiration using exact date and time

You can now set a MediaBox to expire by providing an exact datetime value in the

August 25, 2015

Improvement: List Content Limit Increases and Select Fields to Return

You can now return up to 100 results and select which fields are returned (for performance improvements) in the following resources:

August 13, 2015

Improvement: Updates to List Workspaces for User

The following updates were made to the List Workspaces For User resource:

August 4, 2015

New Feature: Get Folder Details

We've added the ability to retrieve folder information with the new Get Folder Details endpoint.

New Feature: Get Multiple Assets' Details

We've added the ability to retrieve asset details for multiple assets in a single operation with the new Get Multiple Assets' Details endpoint.

July 30, 2015

New Feature: Bulk Aspera download

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.

July 6, 2015

New Feature: Bulk trash, untrash, and delete for folders and assets

You can now use the following endpoints for bulk operations:

Update: New properties for Asset and Folder

We added six new properties to assets, List Workspace Contents, List Trash Bin Contents, and List Folder Contents.

Update: New properties for Workspace

We added two new properties to Get Workspace Details and List Workspaces for User:

May 14, 2015

Update: Asset Runtime

The following endpoints now return the asset runtime, if available:

Update: Ability to set Asset's Description

Now it is possible to set the asset description when creating or updating an asset.

Update: New properties for Workspace

We added a new property to Get Workspace Details and List Workspaces for User:

April 29, 2015

Update: New properties for Workspace

We added two new properties to Get Workspace Details and List Workspaces for User:

April 16, 2015

New Feature: Aspera Bulk Upload

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.

April 3, 2015

New Feature: Create MediaBoxes

You can now create MediaBoxes using Ci API. This is a step toward full API support for MediaBoxes.

Breaking change: Removed Aspera download configuration properties

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.

February 24, 2015

Update: Upload status endpoint

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.

Update: Asset Description

The following endpoints now return the asset description, if available:

February 11, 2015

Update: Uploads no longer accepted at https://api.cimediacloud.com

HTTP singlepart and multipart uploads are now only accepted at https://io.cimediacloud.com.

January 12, 2015

Update: New supported Event types

Workspace Events now supports the 'CreateAsset' and 'DeleteAsset' event types, in addition to 'UploadAsset' and 'TrashAsset'.

January 5, 2015

New Feature: Asset Elements

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.

December 12, 2014

New Feature: Workspace Events

We've added a new resource, Workspace Events, that allows clients to retrieve events (like asset uploads) that occurred in a given workspace.

November 26, 2014

Update: New thumbnail and proxy attributes

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.

Update: Updated thumbnail types

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.

November 13, 2014

Update: Medium resolution thumbnails generated on image uploads

Medium resolution thumbnails are now generated for uploaded images.

Update: Proxy and Thumbnail details added

The asset object now includes the following fields on proxies: size, width, height, audioBitRate, videoBitRate. Thumbnails now include size.

Update: "Standard" video proxy is deprecated

The standard-video proxy has been deprecated. It will continue to be available on older assets, but will not be created on new uploads.

October 29, 2014

Update: Upload up to 5 terabytes with Multipart Upload

Multipart Upload now supports uploads of up to 5 terabytes.

September 18, 2014

New Feature: Adaptive Streaming for Videos

We've added the property hlsPlaylistUrl to the asset object to enable adaptive streams for your assets.

September 4, 2014

New Feature: Refresh Tokens

Refresh token functionality is now supported to allow clients to get new access tokens without providing Ci user credentials.

Update: Asset Object Contains Additional Information

We've added the following properties to the asset object: folder.id, trashedOn, trashedBy.id, trashedBy.name, trashedBy.email, acquisitionSource.name.

August 21, 2014

New Feature: Rename Assets and Folders

Users can now update asset and folder names with the Update an Asset and Update a Folder resources.

July 29, 2014

Update: Added upload transfer type to assets

The following resources will now return a new uploadTransferType property, that indicates how the asset was uploaded.

Update: Added proxy and thumbnail sets to assets

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.

June 16, 2014

New Feature: Purge Trash

We added a new resource, Purge Trash, that allows clients to purge all trashed assets and folders for a given workspace.

Update: Added created by information to assets and folders

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.

Bug fix: Asset download

Asset must be uploaded before download information is returned.

May 20, 2014

New Feature: Get Workspace Details

We added a new resource, Get Workspace Details, that allows clients to get the information of a given workspace.

New Feature: List Workspace Contents

We added a new resource, List Workspace Contents, that allows clients to get all assets and all folders of a given workspace.

New Feature: List Trash Bin Contents

We added a new resource, List Trash Bin Contents, that allows clients to list the trashed assets and folders of a given workspace.

New Feature: Sorting support in List Workspaces for User

List Workspaces for User now supports the ability to sort results by workspace name, network name, last activity date or creation date.

New Feature: Sorting support in List Folder Contents

List Folder Contents now supports the ability to sort results by item name, type, status or creation date.

New Feature: Create, Trash, Untrash and Delete Folders

We've expanded folder support with the ability to create, trash, untrash and delete folders.

Breaking Change: renamed properties in List Workspaces for User

The planName, storageAllotted and storagedUsed properties are now included inside the plan and storage properties. The type property was renamed to class.

April 29, 2014

Breaking Change: renamed property in List Folder Contents

The contents property was renamed to items, to improve consistency with other resource representations.

Breaking Change: New Subdomain Name for singlepart and multipart HTTP uploads

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.

New Feature: List Workspaces for User

We added a new resource, List Workspaces for User, that allows clients to get the workspaces owned by the calling user.

New Feature: Cancel Archive

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.

March 31, 2014

List the Contents of a Folder

We added a new resource, List Folder Contents, that allows clients to get the assets and child folders of a given folder.

Aspera Proxy Downloads

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 Updated if Aspera Transfer Fails

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.

March 19, 2014

Added Error Codes

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.

Workspaces and Folders

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.

Breaking Change for Singlepart HTTP 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' }"