Video Playlists

Create a video playlist

POST

https://peertube2.cpy.re/api/v1/video-playlists

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

curl -X POST 'https://peertube2.cpy.re/api/v1/video-playlists' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --form-string 'displayName=string' \
  --form-string 'privacy=1' \
  --form-string 'description=string'

const form = new FormData();
form.append('displayName', 'string');
form.append('privacy', '1');
form.append('description', 'string');
const response = await fetch('https://peertube2.cpy.re/api/v1/video-playlists', {
  method: 'POST',
  headers: {"Authorization":"Bearer YOUR_TOKEN"},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('displayName', (None, 'string')),
        ('privacy', (None, '1')),
        ('description', (None, 'string')),
    ]
    response = requests.request('POST', 'https://peertube2.cpy.re/api/v1/video-playlists', headers={"Authorization":"Bearer YOUR_TOKEN"}, files=files)
    print(response.text)

Request Body

{
  "displayName": "string",
  "thumbnailfile": "<binary>",
  "privacy": 1,
  "description": "string"
}

200

{
  "videoPlaylist": {
    "id": 42,
    "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
  }
}

Body

multipart/form-data

multipart/form-dataobject

Encoding

thumbnailfileimage/jpeg

displayNamestringrequired

Video playlist display name

thumbnailfilestring<binary>

Video playlist thumbnail file

privacyVideoPlaylistPrivacySet123

Video playlist privacy policy (see /video-playlists/privacies)

descriptionstring

Video playlist description

videoChannelIdid

Video channel in which the playlist will be published

Show child attributes

id>= 1

Example

Response

200OKobject

successful operation

Response fields application/json

videoPlaylistobject

Show child attributes

idid>= 1

Example

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

shortUUIDshortUUID

Show child attributes

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

shortUUID

Example

2y84q2MQUMWPbiEcxNXMgC

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey