Sign in

v13

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

Get Input Progress

Get the progress of processing for the input file. The current_event_progress number is the percent complete of the current event – so if the event is Downloading, and current_event_progress is 99.3421, then the file is almost finished downloading, but hasn't started Inspecting yet.

The progress number is the overall percentage of completion for the input. The progress number is the percent complete of the current event – so if the event is Downloading, and progress is 99.3421, then the file is almost finished downloading, but hasn't started Inspecting yet.

Valid states include:

  • waiting
  • pending
  • assigning
  • processing
  • finished
  • failed
  • cancelled

Events include:

  • downloading
  • inspecting

If you're getting a 404 to an input progress request, make sure that you're using the input ID, not the job or output ID, and make sure your API key is correct. A 404 means that we didn't find an input file with the specified ID for the account linked to the provided API key.

get/inputs/{input_id}/progress

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 processing progress.

idinteger

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

state'waiting' | 'pending' | 'assigning' | 'processing' | 'finished' | 'failed' | 'cancelled'

The state of input processing

progressnumber

Input processing percentage completed

current_event'downloading' | 'inspecting'

The current activity

current_event_progressnumber

The current activity percentage completed