Uploading a video

To create a Cloud Video video using the API, register the video on the channel and then upload the video file into it via the tus protocol. If the upload fails, resume it from the same position in the file it was interrupted at.

1. Register your video on the channel:

   curl \
     --request POST \
     --url 'https://video.api.cloud.yandex.net/video/v1/videos' \
     --header 'Authorization: Bearer <IAM_token>' \
     --header 'Content-Type: application/json' \
     --data '{
       "channel_id": "<channel_ID>",
       "title": "<video_name>",
       "tusd": {
         "file_size": <video_file_size>,
         "file_name": "<video_file_name>"
       },
       "public_access": {}
     }'
   

   Where:

   • <IAM_token>: IAM token required for authenticating with the Cloud Video API.
   • <channel_ID>: ID of the channel where you want to create the video.
   • <video_name>: Name the video will get when uploaded to the channel.
   • <video_file_size>: Size of the video file to upload, in bytes.
   • <video_file_name>: Name of the video file you are going to upload.
   • Access type for the video:

     • public_access: Available indefinitely to anyone with a link to it.

     • signUrlAccess: Available via a temporary link.

       The video is available via a temporary link for a maximum of 12 hours.

   Result:

   {
    "done": true,
    "metadata": {
     "@type": "type.googleapis.com/yandex.cloud.video.v1.CreateVideoMetadata",
     "videoId": "vplvh4wvqimx********"
    },
    "response": {
     "@type": "type.googleapis.com/yandex.cloud.video.v1.Video",
     "tusd": {
      "url": "https://tusd.video.cloud.yandex.net/files/75925d89ddc05c0d5ca3282781f13c6f+00062241********"
     },
     "publicAccess": {},
     "id": "vplvh4wvqimx********",
     "channelId": "vplcdyphvqik********",
     "title": "my-very-first-video",
     "status": "WAIT_UPLOADING",
     "visibilityStatus": "PUBLISHED",
     "createdAt": "2024-09-16T19:18:08.384540Z",
     "updatedAt": "2024-09-16T19:18:08.384540Z"
    },
    "id": "vplpjlgda3c2********",
    "description": "Video create",
    "createdAt": "2024-09-16T19:18:08.393546Z",
    "createdBy": "ajeol2afu1js********",
    "modifiedAt": "2024-09-16T19:18:08.393546Z"
   }
   

   Save the video upload link (url field value) and video ID (videoId field value) as you will need them later.

2. Upload the video file:

   curl \
     --location \
     --request PATCH '<video_upload_link>' \
     --header 'Content-Type: application/offset+octet-stream' \
     --header 'Upload-Offset: 0' \
     --header 'Tus-Resumable: 1.0.0' \
     --data-binary '@<video_file_path>'
   

   Where:

   • <video_upload_link>: Previously saved upload link you got when creating the video.

   • <video_file_path>: Full video file path preceded with @.

     E.g., @/Users/myuser/Downloads/sample-video.MOV.

     Do not use any shortcuts, including ~, in the file path.

3. Make sure your video file has been fully uploaded by specifying the video ID you saved before:

   curl \
     --request GET \
     --url 'https://video.api.cloud.yandex.net/video/v1/videos/<video_ID>' \
     --header 'Authorization: Bearer <IAM_token>'
   

   Result:

   {
    "tusd": {
     "url": "https://tusd.video.cloud.yandex.net/files/75925d89ddc05c0d5ca3282781f13c6f+00062241********"
    },
    "publicAccess": {},
    "id": "vplvh4wvqimx********",
    "channelId": "vplcdyphvqik********",
    "title": "my-very-first-video",
    "status": "READY",
    "duration": "39.981s",
    "visibilityStatus": "PUBLISHED",
    "createdAt": "2024-09-16T19:18:08.384540Z",
    "updatedAt": "2024-09-16T19:31:31.471857Z"
   }
   

   If you see PROCESSING or READY in the status field, the video file has been fully uploaded.

4. If you see WAIT_UPLOADING in the status field, the video file upload was interrupted. In this case you need to resume and complete the upload. To do this, you need to know the offset point the previous upload attempt was interrupted at.

   1. Get the offset position of the interrupted upload using the previously saved video upload link:

      curl \
        --head '<video_upload_link>' \
        --header 'Host: tusd.video.cloud.yandex.net' \
        --header 'Tus-Resumable: 1.0.0'
      

      Result:

      HTTP/1.1 200 OK
      Server: nginx/1.18.0
      Date: Mon, 16 Sep 2024 15:21:52 GMT
      Connection: keep-alive
      Cache-Control: no-cache
      Tus-Resumable: 1.0.0
      Upload-Length: 100100627
      Upload-Metadata: filename c2FtcGxlLXZpZGVv********,video_id dnBsdjVpeWh2M2F6ZnYz********
      Upload-Offset: 28231123
      X-Content-Type-Options: nosniff
      X-Request-Id: 3b775c2a********
      X-Trace-Id: 95ab2f994557ce1b1ee9dd09********
      X_h: edge-5b647c8d67-*****
      Access-Control-Allow-Origin: *
      Access-Control-Allow-Headers: *
      Access-Control-Expose-Headers: *
      Expires: Thu, 01 Jan 1970 00:00:01 GMT
      

      Save the Upload-Offset field value as you will need it to complete the video file upload.

   2. Complete the file upload by running this command:

      curl \
        --location \
        --request PATCH '<video_upload_link>' \
        --header 'Content-Type: application/offset+octet-stream' \
        --header 'Upload-Offset: <offset_value>' \
        --header 'Tus-Resumable: 1.0.0' \
        --data-binary '@<video_file_path>'
      

      Where:

      • <video_upload_link>: Previously saved upload link you got when creating the video.

      • <offset_value>: Previously saved offset value indicating the position in the file the previous upload attempt was interrupted at.

      • <video_file_path>: Full video file path preceded with @.

        E.g., @/Users/myuser/Downloads/sample-video.MOV.

        Do not use any shortcuts, including ~, in the file path.

   Check once again that the video file has been fully uploaded. If the upload was interrupted again, repeat this step.

To create a Cloud Video video using the API, register the video on the channel and then upload the video file into it via the tus protocol. If the upload fails, resume it from the same position in the file it was interrupted at.

1. Register your video on the channel:

   grpcurl \
     -rpc-header "Authorization: Bearer <IAM_token>" \
     -d '{
       "channel_id": "<channel_ID>",
       "title": "<video_name>",
       "tusd": {
         "file_size": <video_file_size>,
         "file_name": "<video_file_name>"
       },
       "public_access": {}
     }' \
     video.api.cloud.yandex.net:443 yandex.cloud.video.v1.VideoService/Create
   

   Where:

   • <IAM_token>: IAM token required for authenticating with the Cloud Video API.
   • <channel_ID>: ID of the channel where you want to create the video.
   • <video_name>: Name the video will get when uploaded to the channel.
   • <video_file_size>: Size of the video file to upload, in bytes.
   • <video_file_name>: Name of the video file you are going to upload.
   • Access type for the video:

     • public_access: Available indefinitely to anyone with a link to it.

     • signUrlAccess: Available via a temporary link.

       The video is available via a temporary link for a maximum of 12 hours.

   Result:

   {
     "id": "vplpskiedayr********",
     "description": "Video create",
     "createdAt": "2024-09-16T12:16:03.921095Z",
     "createdBy": "ajeol2afu1js********",
     "modifiedAt": "2024-09-16T12:16:03.921095Z",
     "done": true,
     "metadata": {
       "@type": "type.googleapis.com/yandex.cloud.video.v1.CreateVideoMetadata",
       "videoId": "vplvio5377ux********"
     },
     "response": {
       "@type": "type.googleapis.com/yandex.cloud.video.v1.Video",
       "channelId": "vplcqy2qxkjy********",
       "createdAt": "2024-09-16T12:16:03.905662Z",
       "id": "vplvio5377ux********",
       "publicAccess": {},
       "status": "WAIT_UPLOADING",
       "title": "my-very-first-video",
       "tusd": {
         "url": "https://tusd.video.cloud.yandex.net/files/5e7d6b3b68f9dc0d279ce719144c9caa+0006223B********"
       },
       "updatedAt": "2024-09-16T12:16:03.905662Z",
       "visibilityStatus": "PUBLISHED"
     }
   }
   

   Save the video upload link (url field value) and video ID (videoId field value) as you will need them later.

2. Upload the video file:

   curl \
     --location \
     --request PATCH '<video_upload_link>' \
     --header 'Content-Type: application/offset+octet-stream' \
     --header 'Upload-Offset: 0' \
     --header 'Tus-Resumable: 1.0.0' \
     --data-binary '@<video_file_path>'
   

   Where:

   • <video_upload_link>: Previously saved upload link you got when creating the video.

   • <video_file_path>: Full video file path preceded with @.

     E.g., @/Users/myuser/Downloads/sample-video.MOV.

     Do not use any shortcuts, including ~, in the file path.

3. Make sure your video file has been fully uploaded by specifying the video ID you saved before:

   grpcurl \
     -rpc-header "Authorization: Bearer <IAM_token>" \
     -d '{"video_id": "<video_ID>"}' \
     video.api.cloud.yandex.net:443 yandex.cloud.video.v1.VideoService/Get
   

   Result:

   {
     "id": "vplva3626rvh********",
     "channelId": "vplcqy2qxkjy********",
     "title": "my-very-first-video",
     "status": "READY",
     "duration": "39.981s",
     "visibilityStatus": "PUBLISHED",
     "createdAt": "2024-09-16T14:11:04.803285Z",
     "updatedAt": "2024-09-16T14:14:36.467614Z",
     "tusd": {
       "url": "https://tusd.video.cloud.yandex.net/files/55994a57bd30b2161399ccab7eb5f2de+0006223D********"
     },
     "publicAccess": {}
   }
   

   If you see PROCESSING or READY in the status field, the video file has been fully uploaded.

4. If you see WAIT_UPLOADING in the status field, the video file upload was interrupted. In this case you need to resume and complete the upload. To do this, you need to know the offset point the previous upload attempt was interrupted at.

   1. Get the offset position of the interrupted upload using the previously saved video upload link:

      curl \
        --head '<video_upload_link>' \
        --header 'Host: tusd.video.cloud.yandex.net' \
        --header 'Tus-Resumable: 1.0.0'
      

      Result:

      HTTP/1.1 200 OK
      Server: nginx/1.18.0
      Date: Mon, 16 Sep 2024 15:21:52 GMT
      Connection: keep-alive
      Cache-Control: no-cache
      Tus-Resumable: 1.0.0
      Upload-Length: 100100627
      Upload-Metadata: filename c2FtcGxlLXZpZGVv********,video_id dnBsdjVpeWh2M2F6ZnYz********
      Upload-Offset: 28231123
      X-Content-Type-Options: nosniff
      X-Request-Id: 3b775c2a********
      X-Trace-Id: 95ab2f994557ce1b1ee9dd09********
      X_h: edge-5b647c8d67-*****
      Access-Control-Allow-Origin: *
      Access-Control-Allow-Headers: *
      Access-Control-Expose-Headers: *
      Expires: Thu, 01 Jan 1970 00:00:01 GMT
      

      Save the Upload-Offset field value as you will need it to complete the video file upload.

   2. Complete the file upload by running this command:

      curl \
        --location \
        --request PATCH '<video_upload_link>' \
        --header 'Content-Type: application/offset+octet-stream' \
        --header 'Upload-Offset: <offset_value>' \
        --header 'Tus-Resumable: 1.0.0' \
        --data-binary '@<video_file_path>'
      

      Where:

      • <video_upload_link>: Previously saved upload link you got when creating the video.

      • <offset_value>: Previously saved offset value indicating the position in the file the previous upload attempt was interrupted at.

      • <video_file_path>: Full video file path preceded with @.

        E.g., @/Users/myuser/Downloads/sample-video.MOV.

        Do not use any shortcuts, including ~, in the file path.

   Check once again that the video file has been fully uploaded. If the upload was interrupted again, repeat this step.