PeerTube · Example Payload

Addplaylist

If the video playlist is set as public, `videoChannelId` is mandatory.

Video Playlists

Addplaylist is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "addPlaylist",
  "method": "POST",
  "path": "/api/v1/video-playlists",
  "summary": "Create a video playlist",
  "description": "If the video playlist is set as public, `videoChannelId` is mandatory.",
  "tags": [
    "Video Playlists"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "multipart/form-data",
    "schema": {
      "type": "object",
      "properties": {
        "displayName": {
          "description": "Video playlist display name",
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        },
        "thumbnailfile": {
          "description": "Video playlist thumbnail file",
          "type": "string",
          "format": "binary"
        },
        "privacy": {
          "$ref": "#/components/schemas/VideoPlaylistPrivacySet"
        },
        "description": {
          "description": "Video playlist description",
          "type": "string",
          "minLength": 3,
          "maxLength": 1000
        },
        "videoChannelId": {
          "allOf": [
            {
              "$ref": "#/components/schemas/id"
            }
          ],
          "description": "Video channel in which the playlist will be published"
        }
      },
      "required": [
        "displayName"
      ]
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    }
  }
}