Videos

Retrieve video status and details

Retrieve upload status and 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.

get/videos/{videoId}/status

Path parameters

videoIdstring required

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

Response

Success

Example response

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

Changes

Changed in 6 of the 50 revisions of this API.101010

Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Feb 19, 2024739298a67b8f21See the full diff
- ●
  added the new ingested enum value to the / response property for the response status
  response-property-enum-value-added
- ●
  added the new ingesting enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  removed the missing enum value from the / response property for the response status
  response-property-enum-value-removed
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 1, 20223b62057249379See the full diff
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ▲
  the response property / became nullable for the status
  response-property-became-nullable
Mar 21, 202259b70096c2b611See the full diff
- ▲
  the response property // became nullable for the status
  response-property-became-nullable
- ○
  added the optional property / to the response with the status
  response-optional-property-added
Feb 7, 20222a4d90a64f8885See the full diff
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 404
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 404
  optional-response-header-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  added the new missing enum value to the / response property for the response status
  response-property-enum-value-added
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the ingested enum value from the / response property for the response status
  response-property-enum-value-removed
- ○
  removed the ingesting enum value from the / response property for the response status
  response-property-enum-value-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history