videos

Report a video's ingest state

Changed on

Replaces the video's ingest state with the one given. Reserved for the ingest service; the whole state is sent every time, so a retried report is indistinguishable from the first.

put/api/videos/{id}/ingest

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Path parameters

idinteger required

Request body

state'pending' | 'probing' | 'archiving' | 'transcoding' | 'done' | 'failed' required
  • pending - Waiting to be picked up
  • probing - Inspecting the uploaded file
  • archiving - Storing the original
  • transcoding - Generating derived files
  • done - Finished
  • failed - Failed
priorityinteger

Claim order among waiting jobs; higher is claimed sooner.

kind'upload' | 'backfill'
  • upload - Source is a fresh upload in the tusd volume
  • backfill - Source is the media archive
percentageDoneinteger nullable

Progress through the current state, not through the pipeline as a whole. Null where the current state has no progress to report.

statusTextstring
errorCodestring

Machine-readable reason the ingest failed; empty otherwise. The wording shown to the uploader is the frontend's to choose, not ingest's.

Response

videointeger required
state'pending' | 'probing' | 'archiving' | 'transcoding' | 'done' | 'failed' required
  • pending - Waiting to be picked up
  • probing - Inspecting the uploaded file
  • archiving - Storing the original
  • transcoding - Generating derived files
  • done - Finished
  • failed - Failed
priorityinteger

Claim order among waiting jobs; higher is claimed sooner.

kind'upload' | 'backfill'
  • upload - Source is a fresh upload in the tusd volume
  • backfill - Source is the media archive
claimedBystring nullable required

Identity of the worker that last claimed this job, if any.

percentageDoneinteger nullable

Progress through the current state, not through the pipeline as a whole. Null where the current state has no progress to report.

errorCodestring

Machine-readable reason the ingest failed; empty otherwise. The wording shown to the uploader is the frontend's to choose, not ingest's.

updatedTimestring date-time nullable required

Changes

  • 3761c2b166bbRevision changes
    • breaking

      for the path request parameter id, the type changed from string to integer

    • breaking

      added to the ///// response property oneOf list for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      removed the pattern ^\d+$ from the path request parameter id

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added priority kind discriminator mapping keys to the ///// response property for the response status

    • info

      added the required property to the response with the status

  • baf6b00d7559Revision changes
    • info

      endpoint added