My User

Update my user information

PUT

https://peertube2.cpy.re/api/v1/users/me

curl -X PUT 'https://peertube2.cpy.re/api/v1/users/me' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "password": "********",
  "currentPassword": "********",
  "displayName": "string",
  "nsfwPolicy": "true",
  "nsfwFlagsDisplayed": 0,
  "nsfwFlagsHidden": 0,
  "nsfwFlagsWarned": 0,
  "nsfwFlagsBlurred": 0,
  "aiUsagesHidden": [
    1
  ],
  "p2pEnabled": true,
  "autoPlayVideo": true,
  "autoPlayNextVideo": true,
  "autoPlayNextVideoPlaylist": true,
  "videosHistoryEnabled": true,
  "videoLanguages": [
    "string"
  ],
  "videoCategories": [
    0
  ],
  "videoLive": "true",
  "language": "string",
  "theme": "string",
  "noInstanceConfigWarningModal": true,
  "noAccountSetupWarningModal": true,
  "noWelcomeModal": true
}'

const body = `{
  "password": "********",
  "currentPassword": "********",
  "displayName": "string",
  "nsfwPolicy": "true",
  "nsfwFlagsDisplayed": 0,
  "nsfwFlagsHidden": 0,
  "nsfwFlagsWarned": 0,
  "nsfwFlagsBlurred": 0,
  "aiUsagesHidden": [
    1
  ],
  "p2pEnabled": true,
  "autoPlayVideo": true,
  "autoPlayNextVideo": true,
  "autoPlayNextVideoPlaylist": true,
  "videosHistoryEnabled": true,
  "videoLanguages": [
    "string"
  ],
  "videoCategories": [
    0
  ],
  "videoLive": "true",
  "language": "string",
  "theme": "string",
  "noInstanceConfigWarningModal": true,
  "noAccountSetupWarningModal": true,
  "noWelcomeModal": true
}`;

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

const data = await response.text();

import requests

body = '''{
  "password": "********",
  "currentPassword": "********",
  "displayName": "string",
  "nsfwPolicy": "true",
  "nsfwFlagsDisplayed": 0,
  "nsfwFlagsHidden": 0,
  "nsfwFlagsWarned": 0,
  "nsfwFlagsBlurred": 0,
  "aiUsagesHidden": [
    1
  ],
  "p2pEnabled": true,
  "autoPlayVideo": true,
  "autoPlayNextVideo": true,
  "autoPlayNextVideoPlaylist": true,
  "videosHistoryEnabled": true,
  "videoLanguages": [
    "string"
  ],
  "videoCategories": [
    0
  ],
  "videoLive": "true",
  "language": "string",
  "theme": "string",
  "noInstanceConfigWarningModal": true,
  "noAccountSetupWarningModal": true,
  "noWelcomeModal": true
}'''

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

Request Body

{
  "password": "********",
  "currentPassword": "********",
  "displayName": "string",
  "nsfwPolicy": "true",
  "nsfwFlagsDisplayed": 0,
  "nsfwFlagsHidden": 0,
  "nsfwFlagsWarned": 0,
  "nsfwFlagsBlurred": 0,
  "aiUsagesHidden": [
    1
  ],
  "p2pEnabled": true,
  "autoPlayVideo": true,
  "autoPlayNextVideo": true,
  "autoPlayNextVideoPlaylist": true,
  "videosHistoryEnabled": true,
  "videoLanguages": [
    "string"
  ],
  "videoCategories": [
    0
  ],
  "videoLive": "true",
  "language": "string",
  "theme": "string",
  "noInstanceConfigWarningModal": true,
  "noAccountSetupWarningModal": true,
  "noWelcomeModal": true
}

Body

application/json

passwordpassword<password>

currentPasswordpassword<password>

emailemail

new email used for login and service communications

Show child attributes

The user email

email<email>

displayNamestring

new name of the user in its representations

nsfwPolicystringtruefalseboth

new NSFW display policy

nsfwFlagsDisplayedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsHiddenNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsWarnedNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

nsfwFlagsBlurredNSFWFlag0124

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

aiUsagesHiddenArray<VideoAIUsageSet>1234

PeerTube >= 9.0 Videos with these AI usages are hidden from video lists

p2pEnabledboolean

whether to enable P2P in the player or not

autoPlayVideoboolean

new preference regarding playing videos automatically

autoPlayNextVideoboolean

new preference regarding playing following videos automatically

autoPlayNextVideoPlaylistboolean

new preference regarding playing following playlist videos automatically

videosHistoryEnabledboolean

whether to keep track of watched history or not

videoLanguagesArray<string>

list of languages to filter videos down to

videoCategoriesArray<integer> | null

list of categories to filter videos down to (null means all categories)

videoLivestringtruefalseboth

filter videos down to lives (true), VODs (false) or display both

languagestring

default language for this user

themestring

noInstanceConfigWarningModalboolean

noAccountSetupWarningModalboolean

noWelcomeModalboolean

Response

204No Content

successful operation

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.

Scopes: user

Docs by Sourcey