v13

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

Jobs

Get Job Details

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

get/jobs/{job_id}

Path parameters

job_idstring required

The Zencoder job 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

Job properties.

idinteger

The job id, an integer in the 64-bit range.

submitted_atstring

ISO 8601 date-time string representing when the job was submitted

created_atstring

ISO 8601 date-time string representing when the job was created

updated_atstring

ISO 8601 date-time string representing when the job was last updated

finished_atstring

ISO 8601 date-time string representing when the job was completed

state'pending' | 'submitting' | 'transcoding' | 'finished' | 'failed'

The current state of the job:

pending (not yet submitted to Zencoder)
submitting (currently submitting to Zencoder)
transcoding (successfully submitted to Zencoder)
finished (Zencoder finished transcoding, and the job is done)
failed (Zencoder was unable to transcode the video)

Example response

{
  "id": 365524597,
  "submitted_at": "2017-04-20T16:08:02Z",
  "created_at": "2017-04-20T16:08:02Z",
  "updated_at": "2017-04-20T16:08:02Z",
  "finished_at": "2017-04-20T16:08:02Z",
  "input_media_file": {
    "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"
  },
  "output_media_files": [
    {
      "audio_bitrate_in_kbps": 90,
      "audio_codec": "aac",
      "audio_sample_rate": 44100,
      "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,
      "fragment_duration_in_ms": 5478,
      "format": "mpeg4",
      "frame_rate": 30,
      "height": 360,
      "id": 365495537,
      "label": "mp4 high",
      "privacy": true,
      "rfc_6381_audio_codec": "avc1.42001e",
      "rfc_6381_video_codec": "mp4a.40.2",
      "test": true,
      "video_bitrate_in_kbps": 1402,
      "video_codec": "h264",
      "width": 640,
      "total_bitrate_in_kbps": 7906,
      "url": "s3://zencodertesting/test.mov"
    }
  ]
}