Video Channels

Update channel banner

POST

https://peertube2.cpy.re/api/v1/video-channels/{channelHandle}/banner/pick

curl -X POST 'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/banner/pick' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const form = new FormData();
const response = await fetch('https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/banner/pick', {
  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 = [
    ]
    response = requests.request('POST', 'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/banner/pick', headers={"Authorization":"Bearer YOUR_TOKEN"}, files=files)
    print(response.text)

Request Body

{
  "bannerfile": "<binary>"
}

200

{
  "banners": [
    {
      "path": "string",
      "fileUrl": "string",
      "width": 0,
      "height": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Body

multipart/form-data

multipart/form-dataobject

Encoding

bannerfileimage/png, image/jpeg

bannerfilestring<binary>

The file to upload.

Parameters

channelHandlestringrequiredpath

The video channel handle

Response

200OKobject

successful operation

Response fields application/json

bannersArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

413Payload Too Large

image file too large

Response headers

X-File-Maximum-Sizestring<Nginx size>header

Maximum file size for the banner

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