Sign in

v13

latestOpenAPI 3.0.0raw.githubusercontent.com2023-04-201625158.8 KB
Inputs

Get Input Details

Get job input Details. Job details are available for two months after the job is submitted.

get/inputs/{input_id}

Path parameters

input_idstring required

A Zencoder job input id

Query parameters

pageinteger

The page of results to return

per_pageinteger

The number of results to return for each page

Headers

Content-Typestring required

Content-Type: application/json

Zencoder-Api-Keystring required

Your API key

Response

Input properties.

audio_bitrate_in_kbpsinteger

Audio bitrate of the input media file

audio_codecstring

Audio codec of the input media file

audio_sample_rateinteger

Audio sample rate of the input media file

audio_tracksinteger

The number of audio tracks in the input media file

channelsinteger

The number of audio channels in the input media file

created_atstring

ISO 8601 date-time string representing when the input file was created

updated_atstring

ISO 8601 date-time string representing when state of processing on the input file last changed

finished_atstring

ISO 8601 date-time string representing when processing the input file finished

duration_in_msinteger

Duration in ms of the input media file

error_classstring

The type of error thrown if an error occurred in processing the input file

error_messagestring

The error message thrown if an error occurred in processing the input file

file_size_bytesinteger

The file size in bytes of the input file

formatstring

The format of the input file

frame_rateinteger

The frame_rate of the input file

heightinteger

The frame height of the input file in pixels

idinteger

The id of the input file, an integer in the 64-bit range.

md5_checksuminteger

The checksum of the input file

privacyboolean

Privacy mode

statestring

The current state of the file:

  • pending (not yet submitted to Zencoder)
  • submitting (currently submitting to Zencoder)
  • finished (Zencoder finished processing the file)
  • failed (Zencoder was unable to process the file)
testboolean

Test mode

video_bitrate_in_kbpsinteger

video bitrate of the input file

video_codecstring

video codec of the input file

widthinteger

frame width of the input file in pixels

total_bitrate_in_kbpsinteger

total audio+video bitrate of the input file

urlstring

URL of the input file

Example response

{
  "audio_bitrate_in_kbps": 90,
  "audio_codec": "aac",
  "audio_sample_rate": 44100,
  "audio_tracks": 2,
  "channels": 2,
  "created_at": "2017-04-20T16:08:02Z",
  "updated_at": "2017-04-20T16:08:02Z",
  "finished_at": "2017-04-20T16:08:02Z",
  "duration_in_ms": 51312,
  "error_class": "InvalidAudioSettingsError",
  "error_message": "The supplied audio encoding settings were not valid",
  "file_size_bytes": 922620,
  "format": "mpeg4",
  "frame_rate": 30,
  "height": 360,
  "id": 365495537,
  "privacy": true,
  "test": true,
  "video_bitrate_in_kbps": 1402,
  "video_codec": "h264",
  "width": 640,
  "total_bitrate_in_kbps": 7906,
  "url": "s3://zencodertesting/test.mov"
}