### HLS Playlist Inclusion Source: https://developers.cimediacloud.com/change-log Includes a link to the HLS Playlist in the response of several endpoints related to listing and searching workspace and folder contents, as well as getting asset details. ```APIDOC APIDOC: Response Fields: hlsPlaylistUrl: string (optional) - URL to the HLS playlist. Available In: List Workspace Contents: GET /workspaces/{workspaceId}/contents Search Workspace Contents: GET /workspaces/search List Trash Bin Contents: GET /trash/contents List Folder Contents: GET /folders/{folderId}/contents Get Multiple Asset Details: POST /assets/details/bulk ``` -------------------------------- ### Folder Metadata APIs Source: https://developers.cimediacloud.com/change-log Resources that return custom folder metadata, including Get Folder Details, List Folder Contents, List Workspace Contents, List Trash Bin Contents, and Search Workspace Contents. ```APIDOC Get Folder Details: GET /folders/{folderId} Description: Returns custom folder metadata. URL: https://developers.cimediacloud.com/#folders-folder-get List Folder Contents: GET /folders/{folderId}/contents Description: Returns custom folder metadata. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#folders-list-folder-contents-get List Workspace Contents: GET /workspaces/{workspaceId}/contents Description: Returns custom folder metadata. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#workspaces-list-workspaces-contents-get List Trash Bin Contents: GET /workspaces/trash/contents Description: Returns custom folder metadata. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#workspaces-list-trash-bin-contents-get Search Workspace Contents: GET /workspaces/search/contents Description: Returns custom folder metadata. URL: https://developers.cimediacloud.com/#workspaces-search-workspace-contents-get ``` -------------------------------- ### Asset Properties Update Source: https://developers.cimediacloud.com/change-log Assets now include an _uploadTransferType_ property indicating the upload method. Additionally, _thumbnails_ and _proxies_ sets are returned in Get Asset Details, with _proxyUrl_ and _thumbnailUrl_ being obsolete. ```APIDOC Get Asset Details: Returns: _uploadTransferType: string (Indicates how the asset was uploaded) thumbnails: array (Set of available thumbnails) proxies: array (Set of available proxies) proxyUrl: string (Obsolete, use proxies instead) thumbnailUrl: string (Obsolete, use thumbnails instead) ``` -------------------------------- ### Get Jobs API for Asset Ingest Source: https://developers.cimediacloud.com/change-log Retrieve details of jobs created during the asset ingest process using the Get Jobs resource. ```APIDOC Get Jobs: GET /asset-media-services/media-service-jobs/for-asset Description: Retrieves details of jobs created during the asset ingest process. Parameters: - assetId (string): The ID of the asset. Returns: - Array of Job objects, each containing job details. ``` -------------------------------- ### Get Media Service Job Details Source: https://developers.cimediacloud.com/change-log Allows retrieving detailed information about one or more media service jobs. Supports fetching details for a single job by ID or multiple jobs via a POST request. ```APIDOC ASSET_MEDIA_SERVICES_GET_JOB_DETAILS_GET: description: Get details for a specific media service job. parameters: path: jobId: The ID of the media service job. responses: '200': description: Job details retrieved successfully. ASSET_MEDIA_SERVICES_GET_MULTIPLE_JOBS_DETAILS_POST: description: Get details for multiple media service jobs. requestBody: required: true content: application/json: schema: type: object properties: jobIds: type: array items: type: string description: A list of media service job IDs. responses: '200': description: Job details retrieved successfully. ``` -------------------------------- ### Aspera Download for Thumbnails and Elements Source: https://developers.cimediacloud.com/change-log Enables downloading thumbnails and elements using the Aspera download resource. This leverages the Aspera protocol for efficient file transfers. ```APIDOC DOWNLOAD_ASPERA_DOWNLOAD_POST: description: Initiate an Aspera download for specified assets or elements. requestBody: required: true content: application/json: schema: type: object properties: assetIds: type: array items: type: string description: IDs of assets for which to download elements. elementIds: type: array items: type: string description: IDs of specific elements to download. responses: '200': description: Aspera download initiated successfully. Returns transfer details. ``` -------------------------------- ### Asset Property: uploadCompleteDate Source: https://developers.cimediacloud.com/change-log Use the 'uploadCompleteDate' property to get the exact date and time an asset was uploaded. ```APIDOC Get Asset Details: GET /assets/{assetId} Properties: - uploadCompleteDate (string): ISO 8601 format date-time of upload completion. Get Multiple Assets' Details: POST /assets/get-multiple-assets-details Request Body: - assetIds (array of string): List of asset IDs. Properties: - uploadCompleteDate (string): ISO 8601 format date-time of upload completion. List Folder Contents: GET /folders/{folderId}/contents Properties: - uploadCompleteDate (string): ISO 8601 format date-time of upload completion. List Workspace Contents: GET /workspaces/{workspaceId}/contents Properties: - uploadCompleteDate (string): ISO 8601 format date-time of upload completion. List Trash Bin Contents: GET /workspaces/list-trash-bin-contents Properties: - uploadCompleteDate (string): ISO 8601 format date-time of upload completion. ``` -------------------------------- ### HTTP Download for Asset Thumbnails and Proxies Source: https://developers.cimediacloud.com/change-log Download asset thumbnails and asset proxies directly using the HTTP Download resource. ```APIDOC HTTP Download Resource: GET /download/http-download Description: Downloads asset thumbnails or proxies. Parameters: - assetId (string): The ID of the asset. - type (string): Specifies 'thumbnail' or 'proxy' to download. ``` -------------------------------- ### Create MediaBoxes Source: https://developers.cimediacloud.com/change-log You can now create MediaBoxes using the Ci API, marking a step towards full API support for this feature. ```APIDOC POST /mediaboxes Description: Creates a new MediaBox. ``` -------------------------------- ### Create Asset with Workspace and Folder Source: https://developers.cimediacloud.com/change-log Allows specifying a Workspace and/or folder when creating an asset. If both are provided, the folder must belong to the specified Workspace. If neither is provided, the asset defaults to the user's personal Workspace and root folder. ```APIDOC APIDOC: /assets/asset: POST Description: Creates a new asset, optionally placing it in a specific workspace and folder. Authentication: Required Request Body: workspaceId: (Optional) The ID of the workspace to place the asset in. folderId: (Optional) The ID of the folder to place the asset in. Must be a member of workspaceId if provided. ... other asset creation parameters Response: 201 Created: Asset created successfully. 400 Bad Request: Invalid workspaceId or folderId. 401 Unauthorized: Authentication failed. ``` ```APIDOC APIDOC: /asset/singlepart-upload/create-asset-and-upload: POST Description: Creates and uploads an asset via singlepart HTTP, allowing workspace and folder specification. Authentication: Required Request Body: workspaceId: (Optional) The ID of the workspace. folderId: (Optional) The ID of the folder. ... other parameters Response: 200 OK: Asset created and uploaded. 400 Bad Request: Invalid parameters. 401 Unauthorized: Authentication failed. ``` ```APIDOC APIDOC: /asset/multipart-upload/create-asset-and-initiate-upload: POST Description: Creates and initiates upload for an asset via multipart HTTP, allowing workspace and folder specification. Authentication: Required Request Body: workspaceId: (Optional) The ID of the workspace. folderId: (Optional) The ID of the folder. ... other parameters Response: 200 OK: Upload initiated. 400 Bad Request: Invalid parameters. 401 Unauthorized: Authentication failed. ``` ```APIDOC APIDOC: /asset/aspera-upload/create-asset-and-get-transfer-specs: POST Description: Creates an asset and gets Aspera transfer specifications, allowing workspace and folder specification. Authentication: Required Request Body: workspaceId: (Optional) The ID of the workspace. folderId: (Optional) The ID of the folder. ... other parameters Response: 200 OK: Transfer specifications retrieved. 400 Bad Request: Invalid parameters. 401 Unauthorized: Authentication failed. ``` -------------------------------- ### Aspera Push Transfer - Elements, Proxies, Thumbnails Source: https://developers.cimediacloud.com/change-log The Aspera push transfer resource now supports sending asset elements, proxies, and thumbnails to external Aspera nodes, expanding its utility for data distribution. ```APIDOC APIDOC: Aspera Push Transfer: POST /aspera/push Description: Transfers asset elements, proxies, and thumbnails to external Aspera nodes. ``` -------------------------------- ### Aspera Download API Source: https://developers.cimediacloud.com/change-log Facilitates downloading asset proxies using the Aspera protocol. This endpoint is part of an interim release and may have breaking changes in future versions. ```APIDOC APIDOC: /download/aspera-download: POST Description: Initiates an Aspera download for asset proxies. Authentication: Required Request Body: assetIds: An array of asset IDs to download. asperaDownloadConfigurations: An array of configurations for Aspera downloads. (Future versions will move host, sshPort, targetRate, minRate, httpFallback to the root JSON response) Response: 200 OK: Aspera transfer initiated successfully. 400 Bad Request: Invalid request parameters. 401 Unauthorized: Authentication failed. ``` -------------------------------- ### Asset Import from URL Source: https://developers.cimediacloud.com/change-log Allows users to create an asset in Ci directly from a URL pointing to a source file. This feature simplifies content migration from other cloud platforms by eliminating the need for local downloads and re-uploads. ```APIDOC POST /assets Description: Creates an asset from a URL. Request Body: source_url: string (URL of the source file) asset_name: string (Optional name for the asset) Response: asset_id: string (ID of the created asset) ``` -------------------------------- ### Aspera Bulk Upload for Existing Assets Source: https://developers.cimediacloud.com/change-log The Aspera Bulk Upload endpoint now supports uploading files for existing assets. It provides configuration information for generating Aspera upload details. ```APIDOC ASSET_ASPERA_UPLOAD_UPLOAD_MULTIPLE_FILES_POST: description: Generate Aspera upload configuration for bulk uploading files to existing assets. requestBody: required: true content: application/json: schema: type: object properties: assetId: type: string description: The ID of the existing asset to upload files to. files: type: array items: type: object properties: fileName: type: string description: The name of the file to upload. fileSize: type: integer description: The size of the file in bytes. responses: '200': description: Aspera upload configuration generated successfully. ``` -------------------------------- ### Create Asset with Custom Ingest Configuration Source: https://developers.cimediacloud.com/change-log Enables the creation of assets with custom ingest settings, including proxy generation and audio mapping customization. Assets can also be configured for immediate auto-archiving. ```APIDOC ASSET_ASSET_POST: description: Create a new asset. requestBody: required: true content: application/json: schema: type: object properties: ingestConfiguration: type: object description: Configuration for ingest settings, including custom audio mappings and auto-archive. properties: audioMappings: type: array items: type: object properties: source: type: string description: The source audio channel or stream. destination: type: string description: The destination audio channel or stream. autoArchive: type: boolean description: If true, the asset will auto-archive immediately after upload. responses: '201': description: Asset created successfully. ``` -------------------------------- ### Webhook Integrations Source: https://developers.cimediacloud.com/change-log Allows subscription to webhook messages, now including MoveAsset and CopyAsset events. ```APIDOC Webhooks - Subscribe to webhook messages. - Now includes MoveAsset and CopyAsset events. - Endpoint: https://developers.cimediacloud.com/#webhooks ``` -------------------------------- ### Delegate Token for Cover Element Upload Source: https://developers.cimediacloud.com/change-log Create a delegate authentication token to authorize cover element uploads from Javascript clients. Refer to 'Using a Delegate Token' for more details. ```APIDOC Using a Delegate Token: Description: Guide for creating and using delegate tokens for secure uploads. ``` -------------------------------- ### PDF Proxies and Thumbnails for Documents Source: https://developers.cimediacloud.com/change-log When documents (doc, docx, ppt, pptx, txt) are ingested, PDF proxies and image thumbnails are automatically generated. These proxies are accessible via various asset and folder listing endpoints. ```APIDOC APIDOC: Proxy Type: document-pdf Available In: Get Asset Details: GET /assets/{assetId} Get Multiple Assets' Details: POST /assets/details/bulk List Folder Contents: GET /folders/{folderId}/contents List Workspace Contents: GET /workspaces/{workspaceId}/contents List Trash Bin Contents: GET /trash/contents Search Workspace Contents: GET /workspaces/search ``` -------------------------------- ### Thumbnail Options Source: https://developers.cimediacloud.com/change-log Adds a `2000px` thumbnail size option, which is twice the size of the current `large` thumbnail. This enhanced resolution is available across various asset and folder listing endpoints. ```APIDOC GET /assets/{asset_id} GET /assets/batch GET /folders/{folder_id}/contents GET /workspaces/{workspace_id}/contents GET /trash/contents GET /workspaces/{workspace_id}/search Response (for relevant endpoints): thumbnails: array of objects object: type: string (e.g., "2000px", "large", "small") url: string (URL of the thumbnail) ``` -------------------------------- ### Request Premium Proxies Source: https://developers.cimediacloud.com/change-log Allows requesting the generation of premium proxies for an asset using the Jobs resource. The specifications for these proxies are detailed in the Previews section. ```APIDOC ASSET_MEDIA_SERVICES_MEDIA_SERVICE_JOBS_FOR_ASSET_POST: description: Create media service jobs for an asset, including premium proxies. parameters: path: assetId: The ID of the asset. requestBody: required: true content: application/json: schema: type: object properties: jobType: type: string enum: [Thumbnail, AudioProxy, PremiumProxy] description: The type of media processing job to create. Use 'PremiumProxy' for premium proxies. responses: '201': description: Media service job created successfully. ``` -------------------------------- ### Workspace Flags Source: https://developers.cimediacloud.com/change-log Introduces flags for workspace configurations, including download enablement and sidecar ingest. ```APIDOC isDownloadEnabled Flag - Allows administrators to enable/disable file download functionality for Workspaces. - Related to: Updating a Workspace (PUT) - Endpoint: https://developers.cimediacloud.com/developers.cimediacloud.com/#workspaces-create-workspace-put isSidecarIngestEnabled Field - Added to workspace models. - When enabled (`true`), indicates sidecar ingest is active for a Workspace. ``` -------------------------------- ### HTTP Download - Rename Assets, Proxies, and Thumbnails Source: https://developers.cimediacloud.com/change-log Enables renaming of assets, proxies, and thumbnails when downloading via the HTTP download endpoint. This provides flexibility in managing file names in the target destination. ```APIDOC GET /download/{asset_id} Parameters: asset_id: string (ID of the asset to download) rename_asset: string (Optional new name for the asset) rename_proxy: string (Optional new name for the proxy) rename_thumbnail: string (Optional new name for the thumbnail) Response: File download stream ``` -------------------------------- ### Playback Streams API - Captions Source: https://developers.cimediacloud.com/change-log The Create Playback Streams API now includes links to individual caption files within the response, allowing for better integration of captioning services. ```APIDOC APIDOC: Create Playback Streams: POST /assets/playback-streams Response Fields: captionLinks: array of strings (optional) - URLs to caption files. ``` -------------------------------- ### Workspace and Folder Management Source: https://developers.cimediacloud.com/change-log New resources and updates for managing workspaces and folders, including purging trash, creating, trashing, untrashing, and deleting folders, and retrieving workspace details. ```APIDOC Purge Trash: POST /workspaces/{workspaceId}/purge-trash Description: Purges all trashed assets and folders for a given workspace. Get Workspace Details: GET /workspaces/{workspaceId} Description: Retrieves information for a given workspace. Create Folder: POST /folders Description: Creates a new folder. Trash Folder: POST /folders/{folderId}/trash Description: Moves a folder to the trash. Untrash Folder: POST /folders/{folderId}/untrash Description: Restores a folder from the trash. Delete Folder: DELETE /folders/{folderId} Description: Permanently deletes a folder. ``` -------------------------------- ### List Operations and Sorting Source: https://developers.cimediacloud.com/change-log Updates to list operations for workspaces and folders, including added properties and sorting capabilities. Also includes a bug fix for asset downloads. ```APIDOC List Workspace Contents: GET /workspaces/{workspaceId}/contents Returns: _uploadTransferType: string (Indicates how the asset was uploaded) createdBy: object (User ID, name, and email of the creator) List Trash Bin Contents: GET /workspaces/{workspaceId}/trash Returns: _uploadTransferType: string (Indicates how the asset was uploaded) createdBy: object (User ID, name, and email of the creator) List Folder Contents: GET /folders/{folderId}/contents Parameters: sort_by: string (Sort results by item name, type, status, or creation date) Returns: createdBy: object (User ID, name, and email of the creator) items: array (Renamed from _contents_) List Workspaces for User: GET /user/workspaces Parameters: sort_by: string (Sort results by workspace name, network name, last activity date, or creation date) Breaking Changes: _planName_ moved to _plan.name_ _storageAllotted_ moved to _storage.allotted_ _storageUsed_ moved to _storage.used_ _type_ renamed to _class_ Asset Download: GET /assets/{assetId}/download Bug Fix: Asset must be uploaded before download information is returned. ``` -------------------------------- ### Create MediaBox API - Download Permissions Source: https://developers.cimediacloud.com/change-log Allows specifying download permissions for MediaBox recipients, replacing the deprecated 'allowDownload' field. This impacts how assets, previews, and elements can be downloaded by recipients. ```APIDOC APIDOC: Create MediaBox: POST /mediaboxes Parameters: allowAssetSourceDownload: boolean (optional) - Whether recipients can download the asset source. allowPreviewDownload: boolean (optional) - Whether recipients can download previews. allowElementDownload: boolean (optional) - Whether recipients can download elements. Deprecated: allowDownload: boolean - Use specific download permission fields instead. ``` -------------------------------- ### Cimediacloud API Documentation Source: https://developers.cimediacloud.com/change-log Documentation for various Cimediacloud API endpoints, including asset management, folder operations, workspace management, and downloads. ```APIDOC Assets - Get Asset Details: Endpoint: GET /assets/{asset_id} Description: Retrieves details for a specific asset, including technical metadata and custom expiration options for thumbnails, proxies, and HLS playlists. Parameters: asset_id (string, required): The ID of the asset. thumbnail_expiration (integer, optional): Custom expiration time for thumbnail URL in seconds. proxy_expiration (integer, optional): Custom expiration time for proxy URL in seconds. hls_playlist_expiration (integer, optional): Custom expiration time for HLS playlist URL in seconds. Returns: Asset details object. Assets - Get Multiple Assets' Details: Endpoint: POST /assets/get-multiple-assets-details Description: Retrieves details for multiple assets, including technical metadata and custom expiration options for thumbnails, proxies, and HLS playlists. Request Body: asset_ids (array of strings, required): Array of asset IDs. thumbnail_expiration (integer, optional): Custom expiration time for thumbnail URL in seconds. proxy_expiration (integer, optional): Custom expiration time for proxy URL in seconds. hls_playlist_expiration (integer, optional): Custom expiration time for HLS playlist URL in seconds. Returns: Object containing details for each requested asset. Folders - List Folder Contents: Endpoint: GET /folders/{folder_id}/contents Description: Lists the contents of a specific folder. Supports limiting results and selecting fields to return. Parameters: folder_id (string, required): The ID of the folder. limit (integer, optional, default: 50, max: 100): Maximum number of results to return. fields (string, optional): Comma-separated list of fields to include in the response. Returns: Object containing folder contents. Workspaces - List Workspace Contents: Endpoint: GET /workspaces/{workspace_id}/contents Description: Lists the contents of a specific workspace. Supports limiting results and selecting fields to return. Parameters: workspace_id (string, required): The ID of the workspace. limit (integer, optional, default: 50, max: 100): Maximum number of results to return. fields (string, optional): Comma-separated list of fields to include in the response. Returns: Object containing workspace contents. Workspaces - List Trash Bin Contents: Endpoint: GET /workspaces/trash/contents Description: Lists the contents of the trash bin. Supports limiting results and selecting fields to return. Parameters: limit (integer, optional, default: 50, max: 100): Maximum number of results to return. fields (string, optional): Comma-separated list of fields to include in the response. Returns: Object containing trash bin contents. Workspaces - Get Workspace Details: Endpoint: GET /workspaces/{workspace_id} Description: Retrieves details for a specific workspace, including runtime video information. Parameters: workspace_id (string, required): The ID of the workspace. Returns: Workspace details object with runtime.video property. Workspaces - List User Workspaces: Endpoint: GET /workspaces/user/{user_id} Description: Lists workspaces for a specific user. Supports limiting fields returned and retrieving up to 500 workspaces. Parameters: user_id (string, required): The ID of the user. limit (integer, optional, default: 50, max: 500): Maximum number of workspaces to return. fields (string, optional): Comma-separated list of fields to include in the response. Returns: Object containing user's workspaces. Assets - Copy Multiple Assets: Endpoint: POST /assets/copy-multiple-assets Description: Copies multiple assets into a specified workspace. Request Body: asset_ids (array of strings, required): Array of asset IDs to copy. destination_workspace_id (string, required): The ID of the workspace to copy assets into. Returns: Status of the copy operation. MediaBox - Set Expiration: Endpoint: PUT /mediaboxes/{mediabox_id}/expiration Description: Sets the expiration for a MediaBox using an exact datetime value. Parameters: mediabox_id (string, required): The ID of the MediaBox. Request Body: expiration_datetime (string, required): The exact datetime value for expiration (ISO 8601 format). Returns: Status of the expiration update. Folders - Get Folder Details: Endpoint: GET /folders/{folder_id} Description: Retrieves information for a specific folder. Parameters: folder_id (string, required): The ID of the folder. Returns: Folder details object. Download - Aspera Bulk Download: Endpoint: POST /download/aspera-bulk-download Description: Initiates a bulk download of multiple assets via Aspera. Request Body: asperaDownloadConfigurations (object, required): paths (array of objects, required): source (string, required): Source path of the asset. destination (string, required): Destination path for the download. Returns: Status of the Aspera bulk download request. Download - Aspera Download: Endpoint: POST /download/aspera-download Description: Initiates a download of a single asset via Aspera. Includes properties for consistency with bulk download. Request Body: asperaDownloadConfigurations (object, required): paths (array of objects, required): source (string, required): Source path of the asset. destination (string, required): Destination path for the download. Returns: Status of the Aspera download request. ``` -------------------------------- ### Aspera Bulk Upload Source: https://developers.cimediacloud.com/change-log A new endpoint facilitates bulk uploading of multiple files using Aspera. This allows for efficient creation and upload of numerous assets in a single API call and Aspera transfer session. ```APIDOC POST /asset-aspera-upload/upload-multiple-files Description: Uploads multiple files via Aspera for bulk asset creation. ``` -------------------------------- ### Workspace Events - New Event Types Source: https://developers.cimediacloud.com/change-log The Workspace Events resource now supports 'CreateAsset' and 'DeleteAsset' event types, in addition to the existing 'UploadAsset' and 'TrashAsset' types. ```APIDOC Workspace Events: POST /workspaces/{workspaceId}/events Supported Event Types: - UploadAsset - TrashAsset - CreateAsset - DeleteAsset ``` -------------------------------- ### Asset and Element Management APIs Source: https://developers.cimediacloud.com/change-log APIs for managing assets and elements, including creating elements from existing assets and renaming elements during download. ```APIDOC POST Create Element from Asset - Creates an Element from an existing Asset. - Endpoint: https://developers.cimediacloud.com#elements-create-element-from-asset-post GET Element Details - Retrieves details of an element. - Allows renaming elements in the target destination during download. - Endpoint: https://developers.cimediacloud.com/#elements-get-element-details-get ``` -------------------------------- ### MediaBox Creation API Source: https://developers.cimediacloud.com/change-log Allows for the creation of MediaBoxes, with the option to include folder IDs to enable users to view folder contents within a MediaBox. Also supports a `notifyOnChange` flag to notify users of changes. ```APIDOC Create MediaBox: POST /mediaboxes Description: Creates a MediaBox. Can include folderIds in addition to assetIds. Supports a `notifyOnChange` property to notify the calling user when someone edits, closes, or re-opens their MediaBox. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#mediaboxes-create-mediabox-post ``` -------------------------------- ### Asset and Playback Stream APIs Source: https://developers.cimediacloud.com/change-log Enables the creation of playback streams with support for multiple caption sources for different languages. ```APIDOC Create Playback Streams: POST /assets/playback-streams Description: Creates a playback stream. Allows specifying multiple caption sources to support multiple languages. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#assets-create-playback-streams-post ``` -------------------------------- ### Webhooks for TrashAsset and DeleteAsset Events Source: https://developers.cimediacloud.com/change-log Create and update webhooks to receive notifications for 'TrashAsset' and 'DeleteAsset' events. ```APIDOC Webhooks: POST /webhooks Description: Creates a new webhook subscription. Request Body: - url (string): The callback URL for notifications. - eventTypes (array of string): List of event types to subscribe to, e.g., ['TrashAsset', 'DeleteAsset']. GET /webhooks Description: Retrieves a list of existing webhook subscriptions. PUT /webhooks/{webhookId} Description: Updates an existing webhook subscription. ``` -------------------------------- ### Video Asset Creation: Audio Mapping Customization Source: https://developers.cimediacloud.com/change-log Specify custom audio mappings between source files and proxies when creating new video assets. This applies to various asset creation and upload resources. ```APIDOC Create an Asset: POST /assets/asset Request Body Parameters: audioMapping: Custom audio mapping configuration Singlepart HTTP Create and Upload for Asset: POST /asset/singlepart-upload/create-asset-and-upload Request Body Parameters: audioMapping: Custom audio mapping configuration Multipart HTTP Create and Upload for Asset: POST /asset/multipart-upload/create-asset-and-initiate-upload Request Body Parameters: audioMapping: Custom audio mapping configuration Aspera Create and Upload for Asset: POST /asset/aspera-upload/create-asset-and-get-transfer-specs Request Body Parameters: audioMapping: Custom audio mapping configuration Aspera Bulk Create and Upload for Assets: POST /asset/aspera-upload/upload-multiple-files Request Body Parameters: audioMapping: Custom audio mapping configuration ``` -------------------------------- ### List Workspaces for User API Source: https://developers.cimediacloud.com/change-log Allows clients to retrieve a list of workspaces owned by the authenticated user. ```APIDOC APIDOC: /workspaces/list-user-workspaces: GET Description: Retrieves a list of workspaces owned by the calling user. Authentication: Required Response: 200 OK: An array of workspace objects. 401 Unauthorized: Authentication failed. 404 Not Found: No workspaces found for the user. ``` -------------------------------- ### Create MediaBox with Notification Option Source: https://developers.cimediacloud.com/change-log Set the 'notifyOnOpen' flag when creating a MediaBox to notify the owner when it's opened. ```APIDOC Create MediaBox: POST /mediaboxes/create-mediabox Description: Creates a new MediaBox. Request Body: - name (string): The name of the MediaBox. - notifyOnOpen (boolean): If true, notifies the owner when the MediaBox is opened. ``` -------------------------------- ### Search Assets and Folders Source: https://developers.cimediacloud.com/change-log Search for assets and folders within workspaces using the Search Workspace Contents endpoint. ```APIDOC Search Workspace Contents: GET /workspaces/search-workspace-contents Description: Searches for assets and folders within a workspace. Parameters: - workspaceId (string): The ID of the workspace to search within. - query (string): The search term for assets and folders. ``` -------------------------------- ### Workspace Details and External Storage Source: https://developers.cimediacloud.com/change-log Endpoints for retrieving workspace details and managing external storage configurations. Supports an `extraFields` query parameter for requesting additional data. ```APIDOC GET Workspace Details - Retrieves details of a specific workspace. - Supports `externalStorage` in `extraFields` query parameter. - Requires `ViewSpaceExternalStorageDetails` permission. - Endpoint: https://developers.cimediacloud.com/#workspaces-get-workspace-details-get List User Workspaces - Lists all workspaces for a user. - Supports `externalStorage` in `extraFields` query parameter. - Requires `ViewSpaceExternalStorageDetails` permission. - Endpoint: https://developers.cimediacloud.com/#workspaces-list-user-workspaces-get SpaceExternalStorageInfo Object - Captures external storage settings for a Workspace. - Returned when `externalStorage` field is requested via `extraFields`. ``` -------------------------------- ### Media Service Jobs for Asset Source: https://developers.cimediacloud.com/change-log Enables requesting the creation of media processing jobs for an asset, including thumbnails and audio proxies. Also allows retrieving the progress of these jobs. ```APIDOC ASSET_MEDIA_SERVICES_MEDIA_SERVICE_JOBS_FOR_ASSET_POST: description: Create media service jobs for an asset. parameters: path: assetId: The ID of the asset. requestBody: required: true content: application/json: schema: type: object properties: jobType: type: string enum: [Thumbnail, AudioProxy, CustomProfile] description: The type of media processing job to create. customProfileId: type: string description: The ID of a custom profile to use for the job (if jobType is CustomProfile). responses: '201': description: Media service job created successfully. ASSET_MEDIA_SERVICES_MEDIA_SERVICE_JOBS_FOR_ASSET_GET: description: Retrieve media service jobs for an asset. parameters: path: assetId: The ID of the asset. responses: '200': description: List of media service jobs for the asset. ``` -------------------------------- ### Create Workspace API Source: https://developers.cimediacloud.com/change-log Allows for the creation of new Team Workspaces. This API is used to provision new collaborative spaces within the Ci platform. ```APIDOC POST /workspaces Request Body: workspace_name: string (Name for the new workspace) description: string (Optional description for the workspace) team_id: string (ID of the team the workspace belongs to) Response: workspace_id: string (ID of the newly created workspace) ``` -------------------------------- ### Create Media Service Jobs for Assets Source: https://developers.cimediacloud.com/change-log Request the creation of media service jobs for existing assets using the Jobs resource. ```APIDOC Jobs Resource: POST /asset-media-services/media-service-jobs/for-asset Description: Creates media service jobs for existing assets. Request Body: - assetId (string): The ID of the asset for which to create jobs. - jobType (string): The type of media service job to create. GET /asset-media-services/media-service-jobs/for-asset Description: Retrieves details of jobs created during the asset ingest process. ``` -------------------------------- ### Update Multiple Assets Metadata and Description Source: https://developers.cimediacloud.com/change-log Provides endpoints to update the metadata and description for multiple assets simultaneously. This streamlines bulk content management operations. ```APIDOC POST /assets/batch/metadata Description: Updates metadata for multiple assets. Request Body: asset_ids: array of strings (IDs of assets to update) metadata: object (Key-value pairs for metadata) POST /assets/batch Description: Updates descriptions for multiple assets. Request Body: asset_ids: array of strings (IDs of assets to update) description: string (New description for the assets) Response: update_status: object (Indicates success or failure of the update) ``` -------------------------------- ### Webhooks for Event Notifications Source: https://developers.cimediacloud.com/change-log Create and manage Webhooks to receive event notifications via callback URLs. ```APIDOC Webhooks: POST /webhooks Description: Creates a new webhook subscription. Request Body: - url (string): The callback URL for notifications. - eventTypes (array of string): List of event types to subscribe to. GET /webhooks Description: Retrieves a list of existing webhook subscriptions. PUT /webhooks/{webhookId} Description: Updates an existing webhook subscription. DELETE /webhooks/{webhookId} Description: Deletes a webhook subscription. ``` -------------------------------- ### Workspace Entitlements Update Source: https://developers.cimediacloud.com/change-log A new property indicating whether 'Apera' is enabled for a workspace has been added. This is available in workspace details and user workspace listings. ```APIDOC Property added to Workspace: - entitlements.isAperaEnabled Endpoints affected: - GET /workspaces/get-workspace-details - GET /workspaces/list-user-workspaces ``` -------------------------------- ### Bulk Create Assets API Source: https://developers.cimediacloud.com/change-log Enables the creation of multiple assets in a single API call, improving efficiency for batch operations. This is a significant enhancement for managing large numbers of assets. ```APIDOC APIDOC: Create Multiple Assets: POST /assets/bulk Description: Creates multiple assets with a single request. Request Body: Array of asset creation objects. ``` -------------------------------- ### Aspera Push Transfer - SSH Key Authentication Source: https://developers.cimediacloud.com/change-log Supports SSH key-based authentication for Aspera push transfers, enhancing security. The 'sshPrivateKey' property should be used to provide the private key. ```APIDOC APIDOC: Aspera Push Transfer: POST /aspera/push Parameters: sshPrivateKey: string (required) - The SSH private key for authentication. ``` -------------------------------- ### Bulk Operations for Folders and Assets Source: https://developers.cimediacloud.com/change-log Perform bulk trash, untrash, and delete operations on folders and assets using dedicated API endpoints. These endpoints allow for efficient management of multiple items simultaneously. ```APIDOC POST /folders/trash-multiple-folders Description: Trashes multiple folders. POST /folders/untrash-multiple-folders Description: Untrashes multiple folders. POST /folders/delete-multiple-folders Description: Deletes multiple folders. POST /assets/trash-multiple-assets Description: Trashes multiple assets. POST /assets/untrash-multiple-assets Description: Untrashes multiple assets. POST /assets/delete-multiple-assets Description: Deletes multiple assets. ``` -------------------------------- ### New Sort Options: size and createdBy Source: https://developers.cimediacloud.com/change-log Sort endpoints by 'size' (asset size only) and 'createdBy' properties. ```APIDOC List Folder Contents: GET /folders/{folderId}/contents Parameters: - sortBy (string): 'size' or 'createdBy'. - sortOrder (string): 'asc' or 'desc'. List Workspace Contents: GET /workspaces/{workspaceId}/contents Parameters: - sortBy (string): 'size' or 'createdBy'. - sortOrder (string): 'asc' or 'desc'. List Trash Bin Contents: GET /workspaces/list-trash-bin-contents Parameters: - sortBy (string): 'size' or 'createdBy'. - sortOrder (string): 'asc' or 'desc'. ``` -------------------------------- ### MediaLog APIs Source: https://developers.cimediacloud.com/change-log Provides endpoints for enriching videos with time-based metadata using MediaLogs. ```APIDOC MediaLog Endpoints - Enriches videos with time-based metadata. - Endpoint: https://developers.cimediacloud.com/#medialogs ``` -------------------------------- ### Removed Aspera Download Configuration Properties Source: https://developers.cimediacloud.com/change-log Several properties related to Aspera download configuration have been removed from the API response for 'Aspera Download' configuration information. These properties are still available at the root of the response. ```APIDOC POST /download/aspera-download Description: Retrieves Aspera Download configuration information. Removed properties from asperaDownloadConfigurations array items: - host - sshPort - targetRate - minRate - httpFallback ``` -------------------------------- ### Bulk Archive and Restore Operations Source: https://developers.cimediacloud.com/change-log Provides endpoints for performing bulk operations on assets, including archiving, canceling archives, and restoring multiple assets simultaneously. ```APIDOC APIDOC: Bulk Operations: Archive Multiple Assets: POST /archive/bulk/archive Cancel Multiple Archives: POST /archive/bulk/cancel Restore Multiple Assets: POST /archive/bulk/restore ``` -------------------------------- ### Set Asset Description Source: https://developers.cimediacloud.com/change-log It is now possible to set the description for an asset during the creation or update process. ```APIDOC Functionality to set asset description during create/update operations. ``` -------------------------------- ### Aspera Push Transfer API Source: https://developers.cimediacloud.com/change-log Enables sending folders to external Aspera nodes via the Aspera push transfer resource. ```APIDOC Create Aspera Push Transfer: POST /aspera/push-transfer Description: Creates an Aspera push transfer. Can send folders to external Aspera nodes. URL: https://developers.cimediacloud.com/developers.cimediacloud.com/#aspera-push-transfer-create-aspera-push-transfer-post ``` -------------------------------- ### Asset Previews: Upload Cover Elements Source: https://developers.cimediacloud.com/change-log Upload custom cover elements for assets, which appear in the thumbnails array of the Asset Object. This replaces the default cover element generated by Ci. ```APIDOC Upload Cover Elements: POST /element/singlepart-upload/upload-cover-element Description: Uploads a custom cover element for an asset. ``` -------------------------------- ### Adaptive Streaming for Videos Source: https://developers.cimediacloud.com/change-log Introduction of the hlsPlaylistUrl property to the asset object, enabling adaptive streaming for video assets. ```APIDOC Asset Object - Video Properties: hlsPlaylistUrl: URL to the HLS playlist for adaptive streaming. ``` -------------------------------- ### Asset Runtime Information Source: https://developers.cimediacloud.com/change-log The asset runtime, if available, is now returned by several endpoints. This provides information about the execution time of assets. ```APIDOC Asset runtime information is now available in: - GET /workspaces/list-workspaces-contents - GET /folders/list-folder-contents - GET /workspaces/list-trash-bin-contents ``` -------------------------------- ### Waveform Specifications Available Source: https://developers.cimediacloud.com/change-log Access additional waveform fields: sampleMethod, maxAmplitude, and samplesPerSecond when retrieving asset details. ```APIDOC Get Asset Details: GET /assets/{assetId} Response Body (Waveform Fields): - sampleMethod (string): Method used for sampling. - maxAmplitude (number): Maximum amplitude value. - samplesPerSecond (integer): Number of samples per second. ``` -------------------------------- ### Playback Streams API - Custom Creation Source: https://developers.cimediacloud.com/change-log Introduces the capability to create custom playback streams for assets using the Create Playback Streams API. ```APIDOC APIDOC: Create Playback Streams: POST /assets/playback-streams Description: Creates custom playback streams for an asset. ``` -------------------------------- ### API Endpoints Returning Asset Description Source: https://developers.cimediacloud.com/change-log Several API endpoints now include the asset description in their responses if it is available. This provides more comprehensive asset information. ```APIDOC List Workspace Contents: GET /workspaces/{workspaceId}/contents Returns a list of contents within a workspace, including asset descriptions. List Folder Contents: GET /folders/{folderId}/contents Returns a list of contents within a folder, including asset descriptions. List Trash Bin Contents: GET /workspaces/{workspaceId}/trash Returns a list of trashed items within a workspace, including asset descriptions. Get Asset Details: GET /assets/{assetId} Returns detailed information about a specific asset, including its description. ```