List Transforms

get https://app.mk.io/api/v1/projects/:project_name/media/transforms

Listing, Sorting and Filtering Transforms

This endpoint returns the list of transforms in the specified project.

Sorting

The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas where each one can optionally specify asc or desc.

Sorting is valid on the following fields: created, createdBy, id, name, properties/created, properties/lastModified, updated, updatedBy

Filtering

The $filter query parameter allows for transforms to be filtered on the basis of fields in the schema using OData query syntax. See this document for more details on the syntax used.

Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, id, name, properties/created, properties/lastModified, updated, updatedBy, updatedByEmail, updatedByName

Examples:

?$top=10 - Returns only the first 10 transforms from the list.

?$orderby=name desc - Sorts transforms by name in descending order.

?$filter=name eq 'descriptive name' - Returns transforms that match the provided name.

?$orderby=created desc - Sorts transforms by creation date in descending order.

?$filter=created ge 2021-01-01T00:00:00Z - Returns transforms created after January 1, 2021.

Authentication

Authorization Bearer

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

Path parameters

project_name string Required

Query parameters

$orderby string Optional
Specifies the key by which the result collection should be ordered.
$filter string Optional
Restricts the set of items returned.
$top string Optional
Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n.
$skiptoken string Optional
Specifies a start offset to support paginated results. Use @odata.nextLink in the result object to enumerate the collection - it will be present only if there's more than one page of entities.

Response

200 A list of transforms
@odata.nextLinkstringOptional
@odata.nextLink URL if the page length and number of items match.
supplementalobjectListResponseSupplementalSchemaRequired
Supplemental info
Show 5 propertiesHide 5 properties
countintegerRequired
Number of items returned
kindstringRequired
Type of items in the list
operationstringRequired
Operation type. Should always say 'list'
paginationobjectPaginationInfoSchemaRequired
Pagination info
Show 4 propertiesHide 4 properties
endintegerRequired
Position of the last item in the list
recordsintegerRequired
Total number of items returned in the list
startintegerRequired
Position of the first item in the list
totalintegerRequired
Total number of items in the project
subscriptionobjectProjectInfoSchemaOptional
Project info
Show 2 propertiesHide 2 properties
idstringRequired
Project ID
namestringRequired
Project name
valuelist of objectsTransformSchemaRequired
A list of Transforms
Show 5 propertiesHide 5 properties
idstringOptional
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
namestringOptional1-260 characterspattern: ^[^\^\'<>%&:\\?/*+]+$
The name of the resource
propertiesobjectTransformPropertiesRequired
The properties of the Transform
Show 4 propertiesHide 4 properties
createdstringOptionalformat: date-time
The creation date and time of the Transform. Set by the system.
descriptionstringOptional<=1024 characters
The description of the Transform.
lastModifiedstringOptionalformat: date-time
The last modified date and time of the Transform. Set by the system.
outputslist of objectsTransformOutputRequired
An array of TransformOutputs that the Transform should generate. Currently limited to one.
Show 3 propertiesHide 3 properties
onErrorenumOptional
Defines what the service should do when one output fails. Continue to produce other outputs, or stop processing.
Allowed values:ContinueJobStopProcessingJob
presetobjectRequired
Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output.
Show 7 variantsHide 7 variants

Discriminated by @odata.type. Select one variant:

#Microsoft.Media.BuiltInStandardEncoderPresetobjectBuiltInStandardEncoderPreset
@odata.typestringRequired
The discriminator for derived types.
advancedSettingsNamestringOptional
Name of the advanced settings configuration to apply to this transform's config. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
presetNamestringRequired

The built-in preset to be used for encoding videos. Options include:

  • H264SingleBitrateSD
  • H264SingleBitrate720p
  • H264SingleBitrate1080p
  • H264MultipleBitrateSD
  • H264MultipleBitrate720p
  • H264MultipleBitrate1080p
  • H264MultipleBitrateSDWithCVQ
  • H264MultipleBitrate720pWithCVQ
  • H264MultipleBitrate1080pWithCVQ
  • H265SingleBitrate720p
  • H265SingleBitrate1080p
  • H265SingleBitrate4K
  • AACGoodQualityAudio
#MediaKind.BuiltInAssetConverterPresetobjectBuiltInAssetConverterPreset
@odata.typestringRequired
The discriminator for derived types.
presetNameenumRequired
The built-in preset to be used for performing asset conversion.
Allowed values:CopyTopBitrateInterleavedCopyAllBitrateNonInterleavedCopyAllBitrateInterleaved
#Microsoft.Media.BuiltInAssetConverterPresetobjectBuiltInAssetConverterPreset
@odata.typestringRequired
The discriminator for derived types.
presetNameenumRequired
The built-in preset to be used for performing asset conversion.
Allowed values:CopyTopBitrateInterleavedCopyAllBitrateNonInterleavedCopyAllBitrateInterleaved
#MediaKind.ThumbnailGeneratorPresetobjectThumbnailGeneratorPreset
@odata.typestringRequired
The discriminator for derived types.
baseFilenamestringOptional<=64 characterspattern: ^[A-Za-z0-9_-]+$
Used to create the output filename as {BaseFilename}_{Label}{Index}{Extension}. The default is the name of the input file. If the name of the input file is too long then it will be truncated to 64 characters.
thumbnailslist of objectsThumbnailGeneratorConfigurationRequired1+ items
The set of thumbnails to be produced.
Show 9 propertiesHide 9 properties
formatenumRequired
The output format for the thumbnails.
Allowed values:JpegPng
heightstringOptional
Either an integer size in pixels, or a percentage of the input resolution. If either width/height is defined as percentage, the other dimension must be the same percentage.
labelstringOptional<=64 characterspattern: ^[A-Za-z0-9_-]+$
Used to create the output filename as {BaseFilename}_{Label}{Index}{Extension}. When generating sprites, the output vtt file will be named {BaseFilename}_{Label}.vtt
qualityintegerOptional0 to 100Defaults to 70
The compression quality for JPEG images. Between 0-100, default: 70.
rangestringOptionalDefaults to 1
Either an ISO8601 duration, or a percentage of the asset duration, or the value '1'. The default is '1', a single thumbnail is produced.
spriteColumnintegerOptional1 to 10
The number of columns used if you want a thumbnail sprite image. Default: Single image output files.
startstringOptionalDefaults to PT10S
Either an ISO8601 duration, or a percentage of the asset duration. Default: PT10S.
stepstringOptional
The intervals at which thumbnails are generated. Either an ISO8601 duration, or a percentage of the asset duration.
widthstringOptional
Either an integer size in pixels, or a percentage of the input resolution. If only one of width/height is present, the aspect ratio from the source is preserved.
#MediaKind.TrackInserterPresetobjectTrackInserterPreset
@odata.typestringRequired
The discriminator for derived types.
baseFilenamestringOptional<=64 characterspattern: ^[A-Za-z0-9_-]+$

Used to create the output filename.

  • For text tracks: {BaseFilename}.cmft, the default being the input .vtt filename minus the extension, e.g. subtitles.vtt -> subtitles.cmft.
  • For audio tracks: {BaseFilename}.mp4, the default being the input .mp4 filename, ignored if the audio file is already present in the output asset.
trackslist of objectsRequired1-1 items
The set of tracks to be inserted. Currently limited to one.
Show 2 variantsHide 2 variants

Discriminated by @odata.type. Select one variant:

#MediaKind.TextTrackobjectTextTrack
@odata.typestringRequired
The discriminator for derived types.
displayNamestringOptional
The display name of the track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
hlsSettingsobjectHlsSettingsOptional
The HLS specific setting for the track.
Show 3 propertiesHide 3 properties
characteristicsstringOptional
The characteristics for the HLS setting.
defaultbooleanOptionalDefaults to false
Default track?
forcedbooleanOptionalDefaults to false
Forced track?
languageCodestringOptional
The RFC5646 language code for the track.
playerVisibilityenumOptionalDefaults to Visible
When PlayerVisibility is set to 'Visible', the track will be present in the DASH manifest or HLS playlist when requested by a client. When the PlayerVisibility is set to 'Hidden', the track will not be available to the client. The default value is 'Visible'.
Allowed values:VisibleHidden
trackNamestringRequired
The name of the track in the manifest.
#MediaKind.AudioTrackobjectAudioTrack
@odata.typestringRequired
The discriminator for derived types.
dashSettingsobjectDashSettingsOptional
The DASH specific setting for the audio track.
Show 1 propertyHide 1 property
rolestringOptional
The role for the DASH setting.
displayNamestringOptional
The display name of the audio track on a video player. In HLS, this maps to the NAME attribute of EXT-X-MEDIA.
hlsSettingsobjectHlsSettingsOptional
The HLS specific setting for the audio track.
Show 3 propertiesHide 3 properties
characteristicsstringOptional
The characteristics for the HLS setting.
defaultbooleanOptionalDefaults to false
Default track?
forcedbooleanOptionalDefaults to false
Forced track?
languageCodestringOptional
The RFC5646 language code for the audio track.
trackNamestringRequired
The name of the audio track in the manifest.
#MediaKind.AIPipelinePresetobjectAIPipelinePreset
@odata.typestringRequired
The discriminator for derived types.
pipelineobjectPipelineArgumentsRequired
AI pipeline settings
Show 2 propertiesHide 2 properties
argumentsmap from strings to list of objectsArgumentSchemaOptional
Arguments to each operation in the AI pipeline
Show value schemaHide value schema
[any key]list of objects
Show 2 propertiesHide 2 properties
namestringRequired1-260 characterspattern: ^[A-Za-z0-9_-]+$
The name of the argument
valueanyAnyValueRequired
The value of the argument
namestringRequired0-255 characters
The name of the AI pipeline the Transform will execute.
#MediaKind.EncoderPresetobjectEncoderPreset
@odata.typestringRequired
The discriminator for derived types.
advancedSettingsNamestringOptional
Name of the advanced settings configuration to apply to this transform's config. These configuration blocks are managed by MediaKind and you should not set this field unless MediaKind support has asked you to.
configmap from strings to anyRequired
The configuration for the custom preset.
Show value schemaHide value schema
[any key]any
presetNamestringRequired
Name of this preset.
relativePriorityenumOptionalDefaults to Normal
Sets the relative priority of the TransformOutputs within a Transform
Allowed values:HighLowNormal
systemDataobjectSystemDataSchemaOptional
Metadata pertaining to creation and last modification of the resource.
Show 7 propertiesHide 7 properties
createdAtstringRequiredformat: date-time
The timestamp of resource creation (UTC).
createdBystringRequired
The identity that created the resource.
createdByTypeenumRequired
The type of identity that created the resource.
Allowed values:UserApplicationManagedIdentityKey
internalIdstringRequiredformat: uuid
The internal ID of the resource.
lastModifiedAtstringRequiredformat: date-time
The timestamp of resource last modification (UTC).
lastModifiedBystringRequired
The identity that last modified the resource.
lastModifiedByTypeenumRequired
The type of identity that last modified the resource.
Allowed values:UserApplicationManagedIdentityKey
typestringOptional
The type of the resource. E.g. "Microsoft.Media/mediaservices/assets"

Errors

400 Bad Request
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
errorobjectErrorDetailRequired
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code