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

Video API, gRPC: EpisodeService.Get

Written by
Updated at November 25, 2025

Retrieves detailed information about a specific episode by its ID.
Returns all episode metadata, status, and related information.

gRPC request

rpc Get (GetEpisodeRequest) returns (Episode)

GetEpisodeRequest

{
  "episode_id": "string"
}

Field

Description

episode_id

string

Required field. ID of the episode to retrieve.

The maximum string length in characters is 50.

Episode

{
  "id": "string",
  "stream_id": "string",
  "line_id": "string",
  "title": "string",
  "description": "string",
  "thumbnail_id": "string",
  "start_time": "google.protobuf.Timestamp",
  "finish_time": "google.protobuf.Timestamp",
  "dvr_seconds": "int64",
  "visibility_status": "VisibilityStatus",
  "style_preset_id": "string",
  // Includes only one of the fields `public_access`, `sign_url_access`
  "public_access": "EpisodePublicAccessRights",
  "sign_url_access": "EpisodeSignURLAccessRights",
  // end of the list of possible fields
  "created_at": "google.protobuf.Timestamp",
  "updated_at": "google.protobuf.Timestamp"
}

Entity representing a stream fragment that can be accessed independently.
Episodes can be linked to either a stream or a line
and provide a way to reference specific portions of the corresponding content.

Field

Description

id

string

Unique identifier of the episode.

stream_id

string

Identifier of the stream this episode is linked to.
Optional, empty if the episode is linked to a line.

line_id

string

Identifier of the line this episode is linked to.
Optional, empty if the episode is linked to a stream.

title

string

Title of the episode displayed in interfaces and players.

description

string

Detailed description of the episode content and context.

thumbnail_id

string

Identifier of the thumbnail image used to represent the episode visually.

start_time

google.protobuf.Timestamp

Timestamp marking the beginning of the episode content.

finish_time

google.protobuf.Timestamp

Timestamp marking the end of the episode content.

dvr_seconds

int64

Controls the Digital Video Recording (DVR) functionality for the episode.
Determines how many seconds of the stream are available for time-shifted viewing.

Possible values:

  • 0: Infinite DVR size, the full length of the stream is available for viewing.
  • >0: Size of DVR window in seconds, the minimum value is 30s.

visibility_status

enum VisibilityStatus

Current visibility status controlling whether the episode is publicly available.

  • VISIBILITY_STATUS_UNSPECIFIED: The visibility status is not specified.
  • PUBLISHED: The episode is publicly available, subject to its access permission settings.
  • UNPUBLISHED: The episode is available only to administrators.

style_preset_id

string

Identifier of the style preset used in the player during episode playback.

public_access

EpisodePublicAccessRights

Allows unrestricted public access to the episode via direct link.
No additional authorization or access control is applied.

Includes only one of the fields public_access, sign_url_access.

Specifies the episode access permission settings.

sign_url_access

EpisodeSignURLAccessRights

Restricts episode access using URL signatures for secure time-limited access.

Includes only one of the fields public_access, sign_url_access.

Specifies the episode access permission settings.

created_at

google.protobuf.Timestamp

Timestamp when the episode was initially created in the system.

updated_at

google.protobuf.Timestamp

Timestamp of the last modification to the episode or its metadata.

EpisodePublicAccessRights

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

Field

Description

Empty

EpisodeSignURLAccessRights

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

Field

Description

Empty
Previous
Overview
Next
List