Show video conversion information

👍

IMPORTANT

We strongly recommend using our Webhooks to monitor transcoding progress instead of polling this endpoint. Calls to this endpoint count against the rate limit, so excessive calls can result in Rate Limit Exceeded errors and failed uploads.



RESPONSE PARAMETERS

ParameterDescription
code stringError code
conversions objectProperties of the video conversion

See: conversions object
limit numberMaximum number of conversions that should be returned, as specified in the result_limit request parameter
message stringError message
offset numberNumber of conversions that should be skipped at the beginning of the result set, as specified in the result_offset request parameter
rate_limit objectNumber of requests that can be made to a route per minute per property

Only 60 calls per minute per property can be made.

See: rate_limit object
status stringCall execution status

Set to ok if the call executed successfully.
title stringError title
total numberTotal number of conversions this video has

conversions

ParameterDescription
duration stringDuration of the conversion in seconds

This is set to -1 if conversion duration in unknown.
filesize stringSize of the conversion in bytes

This is set to -1 if conversion file size in unknown.
height numberConversion height

This is set to -1 if conversion height in unknown.
key stringKey of the conversion template
link objectConversion download link split into 3 parts:

   • protocol: (string) Protocol part of the conversion download link
   • address: (string) Address part of the conversion download link
   • path: (string) Path part of the conversion download link

Included in response only when conversion status is Ready.
mediatype stringConversion media type

Possible values include the following:

   • audio: Conversion media type is audio.
   • video: Conversion media type is video.
status stringConversion status

Possible values include the following:

   • Failed: Failed to encode or upload the conversion
   • Queued: Conversion is being transcoded
   • Ready: Conversion is ready and can be streamed
template objectDetails of the conversion template

See: conversions[].template object
width numberConversion width

This is set to -1 if conversion width in unknown.

conversions[].template

ParameterDescription
format objectFormat details of the conversion template

See: conversions[].template.format object
id numberIdentifier for the conversion template
key stringType of key
name stringName of the conversion template
required booleanIdentifies if a conversion template is required template

conversions[].template.format
ParameterDescription
key stringKey of the video format used for this template

Possible values include the following:

   • mp4: H.264 video and AAC audio in MP4 container
   • aac: AAC audio in MP4 container
   • mp3: MP3 audio
   • passthrough: Passthrough format
   • original: Original unmodified video or audio
name stringName of the video format used for this template

rate_limit

ParameterDescription
limit numberTotal number of requests that can be made to this route before the reset time
remaining numberNumber of remaining requests that can be made to this route before the reset time
reset numberUnix timestamp identifying when the rate limit renews

Language
URL