Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Video API, gRPC: VideoService.List

Written by
Updated at April 24, 2025

List videos for channel.

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.

page_size

int64

The maximum number of the results per page to return.
Default value: 100.

page_token

string

Page token for getting the next page of the result.

order_by

string

By which column the listing should be ordered and in which direction,
format is " " (e.g. "createdAt desc").
Default: "id asc".
Possible fields: ["id", "title", "createdAt", "updatedAt"].
Both snake_case and camelCase are supported for fields.

filter

string

Filter expression that filters resources listed in the response.
Expressions are composed of terms connected by logic operators.
If value contains spaces or quotes,
it should be in quotes (' or ") with the inner quotes being backslash escaped.
Supported logical operators: ["AND", "OR"].
Supported string match operators: ["=", "!=", ":"].
Operator ":" stands for substring matching.
Filter expressions may also contain parentheses to group logical operands.
Example: key1='value' AND (key2!='\'value\'' OR key2:"\"value\"")
Supported fields: ["id", "title", "status", "visibilityStatus"].
Both snake_case and camelCase are supported for fields.

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",
      "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

next_page_token

string

Token for getting the next page.

Video

Field

Description

id

string

ID of the video.

channel_id

string

ID of the channel where the video was created.

title

string

Video title displayed to users.

description

string

Detailed description of the video.

thumbnail_id

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.

error_message

string

Error message describing the reason for video processing failure, if any.

visibility_status

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

google.protobuf.Duration

Video duration. Optional, may be empty until the transcoding result is ready.

auto_transcode

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.

enable_ad

google.protobuf.BoolValue

Enable advertisement for this video.
Default: true.
Set explicitly to false to disable advertisements for a specific video.

subtitle_ids[]

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).

public_access

VideoPublicAccessRights

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 public_access, sign_url_access.

Video access permission settings.

sign_url_access

VideoSignURLAccessRights

Checking access rights using url's signature.

Includes only one of the fields public_access, sign_url_access.

Video access permission settings.

created_at

google.protobuf.Timestamp

Time when video was created.

updated_at

google.protobuf.Timestamp

Time of last video update.

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

track_index

int64

Input audio track index (one-based).

src_lang

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.

file_size

int64

Size of the uploaded file, in bytes.

VideoPublicAccessRights

Field

Description

Empty

VideoSignURLAccessRights

Field

Description

Empty
Previous
Get
Next
BatchGet