Skip to main content
GET
Get a video and its status

Authorizations

Authorization
string
header
required

Project API key. Server-side only.

Path Parameters

projectId
string
required
Pattern: ^prj_[A-Za-z0-9]+$
videoId
string
required
Pattern: ^vid_[A-Za-z0-9]+$

Response

The video.

id
string
required
Example:

"vid_9xR4tL"

projectId
string
required
title
string
required
Required string length: 1 - 200
Example:

"Lesson 1 - Introduction"

status
enum<string>
required
  • uploading: waiting for the parts and the complete call.
  • processing: encoding to HLS.
  • ready: can play.
  • failed: encoding failed; see failure.
  • held: held by our team; does not play.
Available options:
uploading,
processing,
ready,
failed,
held
durationSeconds
number | null
required

Known after encoding.

qualities
enum<string>[]
required

Qualities that can play. Empty until ready.

1440p and 2160p are only on the Pro and Agency plans, and never above the source.

Available options:
360p,
720p,
1080p,
1440p,
2160p
sizeBytes
integer
required

Size of the original file.

failure
object | null
required

Set only when status is failed.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
readyAt
string<date-time> | null
required