Video API, REST: Video.BatchGet
Retrieves multiple videos by their IDs in a specific channel in a single request.
This is more efficient than making multiple Get requests when retrieving several videos.
HTTP request
POST https://video.api.cloud.yandex.net/video/v1/videos:batchGet
Body parameters
{
"channelId": "string",
"videoIds": [
"string"
]
}
|
Field |
Description |
|
channelId |
string Required field. ID of the channel containing the videos to retrieve. |
|
videoIds[] |
string List of video IDs to retrieve. |
Response
HTTP Code: 200 - OK
{
"videos": [
{
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"status": "string",
"errorMessage": "string",
"visibilityStatus": "string",
"duration": "string",
"autoTranscode": "string",
"stylePresetId": "string",
"enableAd": "boolean",
"subtitleIds": [
"string"
],
"features": {
"summary": {
"result": "string",
"urls": [
{
"url": "string",
"trackIndex": "string",
"srcLang": "string"
}
]
}
},
// Includes only one of the fields `tusd`
"tusd": {
"url": "string",
"fileSize": "string"
},
// end of the list of possible fields
// Includes only one of the fields `publicAccess`, `signUrlAccess`
"publicAccess": "object",
"signUrlAccess": "object",
// end of the list of possible fields
"createdAt": "string",
"updatedAt": "string",
"labels": "object"
}
]
}
|
Field |
Description |
|
videos[] |
List of videos matching the requested IDs. |
Video
Main entity representing a video in the platform.
|
Field |
Description |
|
id |
string Unique identifier of the video. |
|
channelId |
string Identifier of the channel where the video is created and managed. |
|
title |
string Title of the video displayed to users in interfaces and players. |
|
description |
string Detailed description of the video content and context. |
|
thumbnailId |
string Identifier of the thumbnail image used to represent the video visually. |
|
status |
enum (VideoStatus) Current processing status of the video.
|
|
errorMessage |
string Error message describing the reason for video processing failure, if any. |
|
visibilityStatus |
enum (VisibilityStatus) Current visibility status controlling whether the video is publicly available.
|
|
duration |
string (duration) Total duration of the video. |
|
autoTranscode |
enum (AutoTranscode) Auto-transcoding setting that controls the video processing workflow.
|
|
stylePresetId |
string Identifier of the style preset applied to the video during processing. |
|
enableAd |
boolean Controls the ability to display advertisements for this video. |
|
subtitleIds[] |
string List of identifiers defining the active subtitles available for the video. |
|
features |
Additional video processing features and their results, such as summarization. |
|
tusd |
Upload video using the TUS (Tus Resumable Upload Protocol) protocol. Includes only one of the fields Specifies the video upload source method (one source variant must be chosen). |
|
publicAccess |
object Allows unrestricted public access to the video via direct link. Includes only one of the fields Specifies the video access permission settings. |
|
signUrlAccess |
object Restricts video access using URL signatures for secure time-limited access. Includes only one of the fields Specifies the video access permission settings. |
|
createdAt |
string (date-time) Timestamp when the video was initially created in the system. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Timestamp of the last modification to the video or its metadata. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
labels |
object (map<string, string>) Custom user-defined labels as |
VideoFeatures
Contains additional processing features and their results for the video.
|
Field |
Description |
|
summary |
Results of the video content summarization process. |
Summary
Contains the results of video summarization.
|
Field |
Description |
|
result |
enum (FeatureResult) Current status of the summarization process.
|
|
urls[] |
List of URLs to summarization results for different audio tracks. |
SummaryURL
Contains a URL to a summarization result for a specific audio track.
|
Field |
Description |
|
url |
string URL to the summarization result file. |
|
trackIndex |
string (int64) Input audio track index (one-based) that was summarized. |
|
srcLang |
string Source track language represented as a three-letter code according to ISO 639-2/T. |
VideoTUSDSource
Represents a video upload source using the TUS (Tus Resumable Upload Protocol) protocol.
This is a push-based upload method where the client pushes data to the server.
@see https://tus.io/
|
Field |
Description |
|
url |
string URL endpoint for uploading the video via the TUS protocol. |
|
fileSize |
string (int64) Total size of the uploaded file, in bytes. |