v13

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

Jobs

List jobs

'A list of jobs can be obtained by sending an HTTP GET request to https://app.zencoder.com/api/v2/jobs?api_key=93h630j1dsyshjef620qlkavnmzui3 (replace the api_key with your own). It will return an array of jobs similar to the example below. The list of thumbnails will be empty until the job is completed. By default, the results are paginated with 50 jobs per page and sorted by ID in descending order. You can pass two parameters to control the paging: page and per_page. per_page has a limit of 50. Note that historical jobs data is kept by Zencoder for 60 days - if you need to keep jobs data for longer periods, you need to retrieve it within 60 days and save it in your own data storage.'

get/jobs

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

A List of Jobs.

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"
      }
    ]
  }
]

All 16 operations