api.video's Public API Documentation
Retrieve video status and details
GET {{baseUrl}}/videos/:videoId/status
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.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"ingest": {
"status": "uploading",
"filesize": "<integer>",
"receivedBytes": [
{
"from": "<integer>",
"to": "<integer>",
"total": "<integer>"
},
{
"from": "<integer>",
"to": "<integer>",
"total": "<integer>"
}
],
"receivedParts": {
"parts": [
"<integer>",
"<integer>"
],
"total": "<integer>"
}
},
"encoding": {
"playable": "<boolean>",
"qualities": [
{
"type": "hls",
"quality": "2160p",
"status": "failed"
},
{
"type": "hls",
"quality": "480p",
"status": "encoding"
}
],
"metadata": {
"width": "<integer>",
"height": "<integer>",
"bitrate": "<number>",
"duration": "<integer>",
"framerate": "<integer>",
"samplerate": "<integer>",
"videoCodec": "<string>",
"audioCodec": "<string>",
"aspectRatio": "<string>"
}
}
} |
Curl
curl -X GET 'https://ws.api.video/videos/:videoId/status' -H 'Accept: application/json'
ENDPOINTS