Skip to navigation
VOS APIAsset Acquisition

Extract an asset as mp4

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
ID of asset

Query parameters

forcebooleanOptionalDefaults to false
Allow to force the creation of a new extract even if one already exists from a previous extraction and has not expired

Request

extractionParameters
audioLanguageslist of stringsOptional
A list of audio languages to include in the extraction. To include all languages, set this null or remove it.
expirationDurationintegerOptional

Download link expiration duration in minutes Default value 1440. Minimum value 5 minutes and maximum value 1440 minutes (24 hours).

ismGenerationbooleanOptional
Flag to indicate if ISM file needs to be generated for the extracted asset. Default value is false.
profileIndexintegerOptional

An index (from 1 to xx) for the size of the rendition to convert. index '1' means the bigger rendition in size will be converted. To convert all renditions, set this to null or remove it. The trimming is not frame accurate, the extracted file will be larger than the requested parameters, based on I frames position.

trimParameterslist of objectsOptional
A list of trim parameters to include in the conversion the full or a portion of the asset. To not apply any trimming, set this to null or remove it.
whitelistIpslist of stringsOptional

White list of comma separated IP addresses. Example: 192.168.1.1, 10.10.10.0/24

Response

Request successfully processed

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
408
Request Timeout Error
504
Gateway Timeout Error