Video API, REST: Thumbnail.Create
Creates a new thumbnail record for a specific resource.
This method only creates the metadata record; the actual image must be uploaded
using the URL obtained from the GenerateUploadURL method.
HTTP request
POST https://video.api.yandexcloud.kz/video/v1/thumbnails
Body parameters
{
"channelId": "string",
// Includes only one of the fields `episodeId`, `videoId`
"episodeId": "string",
"videoId": "string"
// end of the list of possible fields
}
|
Field |
Description |
|
channelId |
string [Deprecated] ID of the channel. The maximum string length in characters is 50. |
|
episodeId |
string ID of the episode to associate the thumbnail with. The maximum string length in characters is 50. Includes only one of the fields |
|
videoId |
string ID of the video to associate the thumbnail with. The maximum string length in characters is 50. Includes only one of the fields |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"thumbnailId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"channelId": "string",
// Includes only one of the fields `episodeId`, `videoId`
"episodeId": "string",
"videoId": "string",
// end of the list of possible fields
"createdAt": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
|
Field |
Description |
|
id |
string ID of the operation. |
|
description |
string Description of the operation. 0-256 characters long. |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
|
createdBy |
string ID of the user or service account who initiated the operation. |
|
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
|
done |
boolean If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
CreateThumbnailMetadata
|
Field |
Description |
|
thumbnailId |
string ID of the thumbnail being created. |
Status
The error result of the operation in case of failure or cancellation.
|
Field |
Description |
|
code |
integer (int32) Error code. An enum value of google.rpc.Code |
|
message |
string An error message. |
|
details[] |
object A list of messages that carry the error details. |
Thumbnail
Entity representing an image used as a visual representation for various content entities.
Thumbnails provide preview images for channels, streams, episodes, videos, and stream lines.
|
Field |
Description |
|
id |
string Unique identifier of the thumbnail. |
|
channelId |
string Identifier of the channel where the thumbnail is created and managed. |
|
episodeId |
string ID of the episode which the thumbnail is associated with. Includes only one of the fields |
|
videoId |
string ID of the video which the thumbnail is associated with. Includes only one of the fields |
|
createdAt |
string (date-time) Timestamp when the thumbnail was initially created in the system. String in RFC3339 To work with values in this field, use the APIs described in the |