Video API, gRPC: VideoService.Create
Creates a new video in the specified channel.
The video can be created from different sources: TUS upload, direct link, or S3 storage.
gRPC request
rpc Create (CreateVideoRequest) returns (operation.Operation)
CreateVideoRequest
{
"channel_id": "string",
"title": "string",
"description": "string",
"thumbnail_id": "string",
"auto_transcode": "AutoTranscode",
"style_preset_id": "string",
"auto_publish": "google.protobuf.BoolValue",
"enable_ad": "google.protobuf.BoolValue",
"labels": "map<string, string>",
// Includes only one of the fields `tusd`
"tusd": {
"file_size": "int64",
"file_name": "string",
"is_deferred": "bool"
},
// end of the list of possible fields
// Includes only one of the fields `public_access`, `sign_url_access`
"public_access": "VideoPublicAccessParams",
"sign_url_access": "VideoSignURLAccessParams"
// end of the list of possible fields
}
|
Field |
Description |
|
channel_id |
string Required field. ID of the channel where the video will be created. The maximum string length in characters is 50. |
|
title |
string Required field. Title of the video to be displayed in interfaces and players. The maximum string length in characters is 300. |
|
description |
string Detailed description of the video content and context. The maximum string length in characters is 5000. |
|
thumbnail_id |
string ID of the thumbnail image to be used for the video. The maximum string length in characters is 50. |
|
auto_transcode |
enum AutoTranscode Controls whether transcoding starts automatically after upload.
|
|
style_preset_id |
string ID of the style preset to apply to the video during processing. The maximum string length in characters is 50. |
|
auto_publish |
Controls whether the video is automatically published after transcoding. |
|
enable_ad |
Controls the ability to display advertisements for this video. |
|
labels |
object (map<string, string>) Custom user-defined labels as The maximum string length in characters for each value is 63. The maximum string length in characters for each key is 63. Each key must match the regular expression |
|
tusd |
Upload video using the TUS (Tus Resumable Upload Protocol) protocol. Includes only one of the fields Specifies the video upload source method (exactly one must be chosen). |
|
public_access |
Video is publicly available. Includes only one of the fields Video access permission settings (exactly one must be chosen). |
|
sign_url_access |
Access to the video is restricted by temporarily signed links. Includes only one of the fields Video access permission settings (exactly one must be chosen). |
VideoTUSDParams
|
Field |
Description |
|
file_size |
int64 Total size of the file to be uploaded, in bytes. The minimum value is 0. |
|
file_name |
string Original name of the file being uploaded. |
|
is_deferred |
bool Defer upload file size. |
VideoPublicAccessParams
Parameters for video public access rights.
|
Field |
Description |
|
Empty |
|
VideoSignURLAccessParams
Parameters for video access restrictions based on temporary signed links.
|
Field |
Description |
|
Empty |
|
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// 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. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool 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. |