Sign in

v13

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

Get Output Progress

Get the progress of processing for an output file. The current_event_progress number is the percent complete of the current event – so if the event is Transcoding, and current_event_progress is 99.3421, then the file is almost finished transcoding, but hasn't started uploading yet.

The progress number is the overall percentage of completion for the output. The progress number is the percent complete of the current event – so if the event is Transcoding, and progress is 99.3421, then the file is almost finished transcoding, but hasn't started Uploading yet.

Valid states include:

  • waiting
  • queued
  • assigning
  • processing
  • finished
  • failed
  • cancelled
  • no input
  • skipped

Events include:

  • downloading
  • transcoding
  • uploading

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

get/outputs/{output_id}/progress

Path parameters

output_idinteger required

A Zencoder job output 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

Output processing progress.

idinteger

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

state'waiting' | 'queued' | 'assigning' | 'processing' | 'finished' | 'failed' | 'cancelle`' | 'no input' | 'skipped'

The state of output processing

progressnumber

Input processing percentage completed

current_event'downloading' | 'transcoding' | 'uploading'

The current activity

current_event_progressnumber

The current activity percentage completed