Video APIv1 Home OpenAPI spec

Docs › Concepts

Concepts

Video lifecycle

UPLOADING→ complete →RUNNING→SUCCEEDEDorFAILED/TIMED_OUT/ABORTED
StatusMeaning
UPLOADINGCreated; waiting for parts and complete.
READY_TO_STARTUpload finished but processing didn't start; call complete again.
RUNNINGProcessing. progress shows the stages.
SUCCEEDEDDone. downloadUrl is present.
FAILED / TIMED_OUTProcessing failed. Check the file plays elsewhere, then upload again or reprocess.
ABORTEDCancelled.

Priority processing

Paid plans get priority. Videos from paid plans are scheduled ahead of free-tier videos when capacity is contended, so paid customers never wait behind a free-tier backlog. Plan changes take effect within ~60 seconds.

Conventions

  • IDs: videoId is 32 lowercase hex characters.
  • Times are seconds (decimals allowed). An end of null means "to the end".
  • Positions on screen (x, y, w, h) are fractions of the frame from 0 to 1, so they work at every quality level.
  • Strict input: unknown fields are refused with 400 INVALID_REQUEST, so a typo can't be silently ignored.
  • Results: each finished video has an MP4 (H.264/AAC, with fast start for streaming playback).