Video API, REST: Video.Create

Статья создана

Обновлена 24 апреля 2025 г.

HTTP request
Body parameters
VideoTUSDParams
Response
CreateVideoMetadata
Status
Video
VideoFeatures
Summary
SummaryURL
VideoTUSDSource

Create video.

HTTP request

POST https://video.api.cloud.yandex.net/video/v1/videos

Body parameters

{
  "channelId": "string",
  "title": "string",
  "description": "string",
  "thumbnailId": "string",
  "autoTranscode": "string",
  "autoPublish": "boolean",
  "enableAd": "boolean",
  "labels": "object",
  // Includes only one of the fields `tusd`
  "tusd": {
    "fileSize": "string",
    "fileName": "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
}

Field	Description
channelId	string Required field. ID of the channel.
title	string Required field. Video title.
description	string Video description.
thumbnailId	string ID of the thumbnail.
autoTranscode	enum (AutoTranscode) Auto start transcoding. `AUTO_TRANSCODE_UNSPECIFIED`: Unspecified auto transcoding value. `ENABLE`: Enable auto transcoding. `DISABLE`: Disable auto transcoding.
autoPublish	boolean Automatically publish video after transcoding. Switches visibility status to PUBLISHED.
enableAd	boolean Enable advertisement for this video. Default: true. Set explicitly to false to disable advertisements for a specific video.
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.
tusd	VideoTUSDParams Upload video using the tus protocol. Includes only one of the fields `tusd`. Source type.
publicAccess	object Publicly accessible video available for viewing by anyone with the direct link. No additional authorization or access control is applied. Includes only one of the fields `publicAccess`, `signUrlAccess`. Video access permission settings.
signUrlAccess	object Checking access rights using url's signature. Includes only one of the fields `publicAccess`, `signUrlAccess`. Video access permission settings.

VideoTUSDParams

Field

Description

fileSize

string (int64)

File size.

fileName

string

File name.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "videoId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "channelId": "string",
    "title": "string",
    "description": "string",
    "thumbnailId": "string",
    "status": "string",
    "errorMessage": "string",
    "visibilityStatus": "string",
    "duration": "string",
    "autoTranscode": "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"
  }
  // 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 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
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 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	CreateVideoMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Video The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

CreateVideoMetadata

Field

Description

videoId

string

ID of the video.

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.

Video

Field	Description
id	string ID of the video.
channelId	string ID of the channel where the video was created.
title	string Video title displayed to users.
description	string Detailed description of the video.
thumbnailId	string ID of the video's thumbnail image.
status	enum (VideoStatus) Video status. `VIDEO_STATUS_UNSPECIFIED`: Video status unspecified. `WAIT_UPLOADING`: Waiting for all the bytes to be loaded. `UPLOADED`: Fully uploaded, ready to be transcoded. `PROCESSING`: Video is being processed. `READY`: Successfully processed and ready for use. `ERROR`: Video processing has failed.
errorMessage	string Error message describing the reason for video processing failure, if any.
visibilityStatus	enum (VisibilityStatus) Visibility status of the video. `VISIBILITY_STATUS_UNSPECIFIED`: Visibility status unspecified. `PUBLISHED`: Video published and available for public viewing. `UNPUBLISHED`: Video unpublished, available only to administrators.
duration	string (duration) Video duration. Optional, may be empty until the transcoding result is ready.
autoTranscode	enum (AutoTranscode) Auto-transcoding setting. Set ENABLE to automatically initiate transcoding after upload, or DISABLE for manual initiation via the Transcode() method. `AUTO_TRANSCODE_UNSPECIFIED`: Unspecified auto transcoding value. `ENABLE`: Enable auto transcoding. `DISABLE`: Disable auto transcoding.
enableAd	boolean Enable advertisement for this video. Default: true. Set explicitly to false to disable advertisements for a specific video.
subtitleIds[]	string List of IDs defining the active subtitles for the video.
features	VideoFeatures Additional video processing features and their results.
tusd	VideoTUSDSource Upload video using the tus protocol. Includes only one of the fields `tusd`. Video upload source definition (one source variant must be chosen).
publicAccess	object Publicly accessible video available for viewing by anyone with the direct link. No additional authorization or access control is applied. Includes only one of the fields `publicAccess`, `signUrlAccess`. Video access permission settings.
signUrlAccess	object Checking access rights using url's signature. Includes only one of the fields `publicAccess`, `signUrlAccess`. Video access permission settings.
createdAt	string (date-time) Time when video was created. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) Time of last video update. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
labels	object (map<string, string>) Custom labels as `key:value` pairs. Maximum 64 per resource.

VideoFeatures

Field

Description

summary

Summary

Summarization result.

Summary

Field

Description

result

enum (FeatureResult)

FEATURE_RESULT_UNSPECIFIED
NOT_REQUESTED: Feature has not been requested.
PROCESSING: Feature is being processed.
SUCCESS: Feature processing completed successfully.
FAILED: Feature processing has failed.

urls[]

SummaryURL

SummaryURL

Field	Description
url	string
trackIndex	string (int64) Input audio track index (one-based).
srcLang	string Source track language (three-letter code according to ISO 639-2/T, ISO 639-2/B, or ISO 639-3). Either provided in transcoding settings earlier or automatically deduced.

VideoTUSDSource

Video upload source via tus protocol.

Field

Description

url

string

URL for uploading video via the tus protocol.

fileSize

string (int64)

Size of the uploaded file, in bytes.

Video API, REST: Video.Create

HTTP requestHTTP request

Body parametersBody parameters

VideoTUSDParamsVideoTUSDParams

ResponseResponse

CreateVideoMetadataCreateVideoMetadata

StatusStatus

VideoVideo

VideoFeaturesVideoFeatures

SummarySummary

SummaryURLSummaryURL

VideoTUSDSourceVideoTUSDSource

Была ли статья полезна?

HTTP request

Body parameters

VideoTUSDParams

Response

CreateVideoMetadata

Status

Video

VideoFeatures

Summary

SummaryURL

VideoTUSDSource