Video Channels

Create a video channel

POST

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

curl -X POST 'https://peertube2.cpy.re/api/v1/video-channels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "publicEmail": "user@example.com"
}'

const body = `{
  "publicEmail": "user@example.com"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/video-channels', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "publicEmail": "user@example.com"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/video-channels',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "publicEmail": "user@example.com"
}

200

{
  "videoChannel": {
    "id": 42
  }
}

Body

application/json

displayNameanyrequired

Channel display name

descriptionany

Channel description

supportany

How to support/fund the channel

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

nameusernameChannelrequired

username of the channel to create

Show child attributes

immutable name of the channel, used to interact with its actor

usernameChannel

Example

framasoft_videos

Response

200OKobject

successful operation

Response fields application/json

videoChannelobject

Show child attributes

idid>= 1

Example

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