Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Video API, gRPC: PlaylistService.Create

Written by
Updated at May 28, 2026

Creates a new playlist in the specified channel with the provided items.
Playlists can contain videos, episodes, or a mix of both content types.

gRPC request

rpc Create (CreatePlaylistRequest) returns (operation.Operation)

CreatePlaylistRequest

{
  "channel_id": "string",
  "title": "string",
  "description": "string",
  "items": [
    {
      // Includes only one of the fields `video_id`, `episode_id`
      "video_id": "string",
      "episode_id": "string",
      // end of the list of possible fields
      "position": "int64"
    }
  ],
  "style_preset_id": "string"
}

Field

Description

channel_id

string

Required field. ID of the channel where the playlist will be created.

The maximum string length in characters is 50.

title

string

Required field. Title of the playlist to be displayed in interfaces and players.

The maximum string length in characters is 300.

description

string

Detailed description of the playlist content and context.
Optional field that can provide additional information about the playlist.

The maximum string length in characters is 5000.

items[]

PlaylistItem

List of items to include in the playlist.
Each item represents a video or episode to be played in sequence.
The order of items in this list determines the playback order.

The maximum number of elements is 100.

style_preset_id

string

ID of the style preset to be applied to the playlist player.
Style presets control the visual appearance of the player.

The maximum string length in characters is 50.

PlaylistItem

Represents a single item in a playlist.
Each item references either a video or an episode and specifies its position in the sequence.

Field

Description

video_id

string

Identifier of a video included in the playlist.

The maximum string length in characters is 50.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

episode_id

string

Identifier of an episode included in the playlist.

The maximum string length in characters is 50.

Includes only one of the fields video_id, episode_id.

Specifies the content identifier type for this playlist item.

position

int64

Position of this item in the playlist sequence (zero-indexed).
Determines the playback order of content in the playlist.

Acceptable values are 0 to 100, inclusive.

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": "google.protobuf.Any",
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": "google.protobuf.Any"
  // 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.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

ID of the user or service account who initiated the operation.

modified_at

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

google.protobuf.Any

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

google.rpc.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

google.protobuf.Any

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.
Previous
List
Next
Update