Show video status

GET

/videos/{videoId}/status

Videos

This API provides upload status & encoding status to determine when the video is uploaded or ready to playback. Once encoding is completed, the response also lists the available stream qualities. Tutorials using video status.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://ws.api.video/videos/vi4k0jvEUuaTdRAEjQ4Jfrgz/status'

Response Example

200 - response

{
  "encoding": {
    "metadata": {
      "aspectRatio": "16/9",
      "audioCodec": "aac",
      "bitrate": 411.218,
      "duration": 4176,
      "framerate": 24,
      "height": 240,
      "samplerate": 48000,
      "videoCodec": "h264",
      "width": 424
    },
    "playable": true,
    "qualities": [
      {
        "quality": "360p",
        "status": "encoded"
      },
      {
        "quality": "480p",
        "status": "encoded"
      },
      {
        "quality": "720p",
        "status": "encoded"
      },
      {
        "quality": "1080p",
        "status": "encoding"
      },
      {
        "quality": "2160p",
        "status": "waiting"
      }
    ]
  },
  "ingest": {
    "filesize": 273579401,
    "receivedBytes": [
      {
        "from": 0,
        "to": 134217727,
        "total": 273579401
      },
      {
        "from": 134217728,
        "to": 268435455,
        "total": 273579401
      },
      {
        "from": 268435456,
        "to": 273579400,
        "total": 273579401
      }
    ],
    "status": "uploaded"
  }
}

Request

Path Params

videoId

string

required

The unique identifier for the video you want the status for.

Example:

vi4k0jvEUuaTdRAEjQ4Jfrgz

Responses

🟢200Success

application/json

Body

encoding

object (videostatus_encoding)

optional

metadata

object (videostatus_encoding_metadata)

optional

playable

boolean

optional

Whether the video is playable or not.

Example:

true

qualities

array[object (quality) {2}]

optional

Available qualities the video can be viewed in.

ingest

object (videostatus_ingest)

optional

Details about the capturing, transferring, and storing of your video for use immediately or in the future.

filesize

integer

optional

The size of your file in bytes.

Example:

200000

receivedBytes

array[object (bytes_range) {3}]

optional

The total number of bytes received, listed for each chunk of the upload.

status

enum<string>

optional

There are three possible ingest statuses. missing - you are missing information required to ingest the video. uploading - the video is in the process of being uploaded. uploaded - the video is ready for use.

Allowed values:

missinguploadinguploaded

Example:

uploaded

🟠404Not Found

Modified at 2023-08-15 05:52:15

Upload a video

Pick a thumbnail