Video API, gRPC: VideoService.List

Written by

Updated at November 25, 2025

gRPC request
ListVideoRequest
ListVideoResponse
Video
VideoFeatures
Summary
SummaryURL
VideoTUSDSource
VideoPublicAccessRights
VideoSignURLAccessRights

Lists all videos in a specific channel with pagination support.
Results can be filtered and sorted using the provided parameters.

gRPC request

rpc List (ListVideoRequest) returns (ListVideoResponse)

ListVideoRequest

{
  "channel_id": "string",
  "page_size": "int64",
  "page_token": "string",
  "order_by": "string",
  "filter": "string"
}

Field	Description
channel_id	string Required field. ID of the channel containing the videos to list. The maximum string length in characters is 50.
page_size	int64 The maximum number of videos to return per page. The maximum value is 100.
page_token	string Page token for retrieving the next page of results. This token is obtained from the next_page_token field in the previous ListVideoResponse. The maximum string length in characters is 15000.
order_by	string Specifies the ordering of results. Format is "<field> <order>" (e.g., "createdAt desc"). Default: "id asc". Supported fields: ["id", "title", "createdAt", "updatedAt"]. Both snake_case and camelCase field names are supported. The maximum string length in characters is 50.
filter	string Filter expression to narrow down the list of returned videos. Expressions consist of terms connected by logical operators. Values containing spaces or quotes must be enclosed in quotes (`'` or `"`) with inner quotes being backslash-escaped. Supported logical operators: ["AND", "OR"]. Supported comparison operators: ["=", "!=", ":"] where ":" enables substring matching. Parentheses can be used to group logical expressions. Example: `title:'sample' AND (status='READY' OR visibilityStatus='PUBLISHED')` Filterable fields: ["id", "title", "status", "visibilityStatus"]. Both snake_case and camelCase field names are supported. The maximum string length in characters is 1000.

ListVideoResponse

{
  "videos": [
    {
      "id": "string",
      "channel_id": "string",
      "title": "string",
      "description": "string",
      "thumbnail_id": "string",
      "status": "VideoStatus",
      "error_message": "string",
      "visibility_status": "VisibilityStatus",
      "duration": "google.protobuf.Duration",
      "auto_transcode": "AutoTranscode",
      "style_preset_id": "string",
      "enable_ad": "google.protobuf.BoolValue",
      "subtitle_ids": [
        "string"
      ],
      "features": {
        "summary": {
          "result": "FeatureResult",
          "urls": [
            {
              "url": "string",
              "track_index": "int64",
              "src_lang": "string"
            }
          ]
        }
      },
      // Includes only one of the fields `tusd`
      "tusd": {
        "url": "string",
        "file_size": "int64"
      },
      // end of the list of possible fields
      // Includes only one of the fields `public_access`, `sign_url_access`
      "public_access": "VideoPublicAccessRights",
      "sign_url_access": "VideoSignURLAccessRights",
      // end of the list of possible fields
      "created_at": "google.protobuf.Timestamp",
      "updated_at": "google.protobuf.Timestamp",
      "labels": "map<string, string>"
    }
  ],
  "next_page_token": "string"
}

Field

Description

videos[]

Video

List of videos matching the request criteria.
May be empty if no videos match the criteria or if the channel is empty.

next_page_token

string

Token for retrieving the next page of results.
Empty if there are no more results available.

Video

Main entity representing a video in the platform.

Field	Description
id	string Unique identifier of the video.
channel_id	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.
thumbnail_id	string Identifier of the thumbnail image used to represent the video visually.
status	enum VideoStatus Current processing status of the video. `VIDEO_STATUS_UNSPECIFIED`: The video status is not specified. `WAIT_UPLOADING`: The video upload is in progress, waiting for all bytes to be received. `UPLOADED`: The video has been fully uploaded and is ready for transcoding. `PROCESSING`: The video is currently being processed. `READY`: The video has been successfully processed and is ready for watching. `ERROR`: An error occurred during video processing.
error_message	string Error message describing the reason for video processing failure, if any.
visibility_status	enum VisibilityStatus Current visibility status controlling whether the video is publicly available. `VISIBILITY_STATUS_UNSPECIFIED`: The visibility status is not specified. `PUBLISHED`: The video is publicly available, subject to its access permission settings. `UNPUBLISHED`: The video is available only to administrators.
duration	google.protobuf.Duration Total duration of the video. Optional, may be empty until the transcoding result is ready.
auto_transcode	enum AutoTranscode Auto-transcoding setting that controls the video processing workflow. Set ENABLE to automatically initiate transcoding after upload, or DISABLE for manual initiation via the Transcode() method. `AUTO_TRANSCODE_UNSPECIFIED`: The auto-transcoding setting is not specified. `ENABLE`: Automatically start transcoding after the video upload is complete. `DISABLE`: Do not automatically transcode; requires manual initiation via the Transcode() method.
style_preset_id	string Identifier of the style preset applied to the video during processing.
enable_ad	google.protobuf.BoolValue Controls the ability to display advertisements for this video. Default: true. Set explicitly to false to disable advertisements for a specific video.
subtitle_ids[]	string List of identifiers defining the active subtitles available for the video.
features	VideoFeatures Additional video processing features and their results, such as summarization.
tusd	VideoTUSDSource Upload video using the TUS (Tus Resumable Upload Protocol) protocol. @see https://tus.io/ Includes only one of the fields `tusd`. Specifies the video upload source method (one source variant must be chosen).
public_access	VideoPublicAccessRights Allows unrestricted public access to the video via direct link. No additional authorization or access control is applied. Includes only one of the fields `public_access`, `sign_url_access`. Specifies the video access permission settings.
sign_url_access	VideoSignURLAccessRights Restricts video access using URL signatures for secure time-limited access. Includes only one of the fields `public_access`, `sign_url_access`. Specifies the video access permission settings.
created_at	google.protobuf.Timestamp Timestamp when the video was initially created in the system.
updated_at	google.protobuf.Timestamp Timestamp of the last modification to the video or its metadata.
labels	object (map<string, string>) Custom user-defined labels as `key:value` pairs. Maximum 64 labels per video. Labels can be used for organization, filtering, and metadata purposes.

VideoFeatures

Contains additional processing features and their results for the video.

Field

Description

summary

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.

FEATURE_RESULT_UNSPECIFIED: The feature result status is not specified.
NOT_REQUESTED: The feature processing has not been requested.
PROCESSING: The feature is currently being processed.
SUCCESS: The feature processing has completed successfully.
FAILED: The feature processing has failed.

urls[]

SummaryURL

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.
track_index	int64 Input audio track index (one-based) that was summarized.
src_lang	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.

file_size

int64

Total size of the uploaded file, in bytes.

VideoPublicAccessRights

Represents public access rights for a video.
When this access type is set, the video is publicly accessible via direct link.

Field	Description
Empty

VideoSignURLAccessRights

Represents access rights controlled by URL signatures.
When this access type is set, the video is accessible only via properly signed temporary link.

Field	Description
Empty

Video API, gRPC: VideoService.List

gRPC requestgRPC request

ListVideoRequestListVideoRequest

ListVideoResponseListVideoResponse

VideoVideo

VideoFeaturesVideoFeatures

SummarySummary

SummaryURLSummaryURL

VideoTUSDSourceVideoTUSDSource

VideoPublicAccessRightsVideoPublicAccessRights

VideoSignURLAccessRightsVideoSignURLAccessRights

Was the article helpful?

gRPC request

ListVideoRequest

ListVideoResponse

Video

VideoFeatures

Summary

SummaryURL

VideoTUSDSource

VideoPublicAccessRights

VideoSignURLAccessRights