Accounts - PeerTube REST API

Accounts

Accounts encompass remote accounts discovered across the federation, and correspond to the main Actor, along with video channels a user can create, which are also Actors. When a comment is posted, it is done with your Account's Actor.

Get an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}

Get an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org')
print(response.text)

200

{
  "id": 42,
  "url": "https://example.com",
  "avatars": [
    {
      "path": "string",
      "fileUrl": "string",
      "width": 0,
      "height": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "host": "example.com",
  "hostRedundancyAllowed": true,
  "followingCount": 0,
  "followersCount": 0,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "displayName": "string",
  "description": "string"
}

Parameters

namestringrequiredpath

The username or handle of the account

Response

200OKActor & any

successful operation

Response fields application/json

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

404Not Found

account not found

List videos of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/videos

List videos of an account

fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
.then(function(response) {
  return response.json()
}).then(function(data) {
  console.log(data)
})

## DEPENDENCIES: jq
curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq

require 'net/http'
require 'json'

uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

response = http.get(uri.request_uri)

puts JSON.parse(response.read_body)

import requests

r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
json = r.json()

print(json)

200

{
  "total": 1,
  "data": [
    {
      "isLive": true,
      "liveSchedules": [
        {
          "startAt": "2024-01-15T09:30:00Z"
        }
      ],
      "createdAt": "2017-10-01T10:52:46.396Z",
      "publishedAt": "2018-10-01T10:52:46.396Z",
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
      "category": {
        "id": 15,
        "label": "Science & Technology"
      },
      "licence": {
        "id": 2,
        "label": "Attribution - Share Alike"
      },
      "language": {
        "id": "en",
        "label": "English"
      },
      "privacy": {
        "id": 1,
        "label": "string"
      },
      "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
      "duration": 1419,
      "aspectRatio": 1.778,
      "isLocal": true,
      "name": "What is PeerTube?",
      "thumbnailPath": "string",
      "previewPath": "string",
      "thumbnails": [
        {
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "aspectRatio": "16:9"
        }
      ],
      "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
      "views": 1337,
      "likes": 42,
      "dislikes": 7,
      "comments": 0,
      "nsfw": true,
      "nsfwSummary": "string",
      "aiUsage": {
        "id": 1,
        "label": "string"
      },
      "commercialContent": {
        "id": 1,
        "label": "string"
      },
      "recommendationScope": {
        "id": 1,
        "label": "string"
      },
      "waitTranscoding": true,
      "state": {
        "id": 1,
        "label": "string"
      },
      "scheduledUpdate": {
        "privacy": 1,
        "updateAt": "2024-01-15T09:30:00Z"
      },
      "blacklisted": true,
      "blacklistedReason": "string",
      "account": {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "channel": {
        "id": 42,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "userHistory": {
        "currentTime": 0
      },
      "captionLanguages": [
        "fr"
      ]
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

skipCountstringtruefalsefalsequery

if you don't need the total in the response

sortstringname-duration-createdAt-publishedAt-views-likes-comments-trending-hot-bestquery

nsfwstringtruefalsequery

whether to include nsfw videos, if any

nsfwFlagsIncludedNSFWFlag0124query

nsfwFlagsExcludedNSFWFlag0124query

aiUsageOneOfVideoAIUsageSet | Array<VideoAIUsageSet>query

PeerTube >= 9.0 Only list videos with one of these AI usages, declared by video creators. If not provided, the preference of the authenticated user (aiUsagesHidden) is used

isLivebooleanquery

whether or not the video is a live

includeScheduledLivebooleanquery

whether or not include live that are scheduled for later

categoryOneOfVideoCategorySet | Array<VideoCategorySet>query

category id of the video (see /videos/categories)

licenceOneOfVideoLicenceSet | Array<VideoLicenceSet>query

licence id of the video (see /videos/licences)

languageOneOfVideoLanguageSet | Array<VideoLanguageSet>query

language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language

tagsOneOfstring | Array<string>query

tag(s) of the video

tagsAllOfstring | Array<string>query

tag(s) of the video, where all should be present in the video

isLocalbooleanquery

PeerTube >= 4.0 Display only local or remote objects

includeinteger012481632query

Only administrators and moderators can use this parameter

Include additional videos in results (can be combined using bitwise or operator)

0 NONE
1 NOT_PUBLISHED_STATE
2 BLACKLISTED
4 BLOCKED_OWNER
8 FILES
16 CAPTIONS
32 VIDEO SOURCE

hasHLSFilesbooleanquery

PeerTube >= 4.0 Display only videos that have HLS files

hasWebVideoFilesbooleanquery

PeerTube >= 6.0 Display only videos that have Web Video files

hoststringquery

Find elements owned by this host

autoTagOneOfstring | Array<string>query

PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags

stateOneOfid | Array<id>query

PeerTube >= 8.2 Admins and moderators only filter on videos that have one of these states

privacyOneOfVideoPrivacySet12345query

PeerTube >= 4.0 Display only videos in this specific privacy/privacies

excludeAlreadyWatchedbooleanquery

Whether or not to exclude videos that are in the user's video history

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

Response

200OKVideoListResponse

successful operation

Response fields application/json

totalinteger

Example

dataArray<Video>

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes

UUIDv4<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

isLiveboolean

liveSchedulesArray<LiveSchedule>

Show child attributes

startAtstring<date-time>

Date when the stream is scheduled to air at

createdAtstring<date-time>

time at which the video object was first drafted

Example

2017-10-01T10:52:46.396Z

publishedAtstring<date-time>

time at which the video was marked as ready for playback (with restrictions depending on privacy). Usually set after a state evolution.

Example

2018-10-01T10:52:46.396Z

updatedAtstring<date-time>

last time the video's metadata was modified

Example

2021-05-04T08:01:01.502Z

originallyPublishedAtstring<date-time> | null

used to represent a date of first publication, prior to the practical publication date of publishedAt

Example

2010-10-01T10:52:46.396Z

categoryVideoConstantNumber-Category

category in which the video is classified

Show child attributes

idVideoCategorySet

category id of the video (see /videos/categories)

Example

labelstring

Example

Science & Technology

licenceVideoConstantNumber-Licence

licence under which the video is distributed

Show child attributes

idVideoLicenceSet

licence id of the video (see /videos/licences)

Example

labelstring

Example

Attribution - Share Alike

languageVideoConstantString-Language

main language used in the video

Show child attributes

idVideoLanguageSet

language id of the video (see /videos/languages)

Example

en

labelstring

Example

English

privacyVideoPrivacyConstant

Show child attributes

idVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

labelstring

truncatedDescriptionstring | null

truncated description of the video, written in Markdown.

Example

**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...

durationinteger<seconds>

duration of the video in seconds

Example

aspectRationumber<float> | null

PeerTube >= 6.1 Aspect ratio of the video stream

Example

1.778

isLocalboolean

namename

title of the video

Example

What is PeerTube?

thumbnailPathstring | nulldeprecated

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

previewPathstring | nulldeprecated

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

thumbnailsArray<Thumbnail>

PeerTube >= 8.1 Array of thumbnails for the video

Show child attributes

fileUrlstring

widthinteger

heightinteger

aspectRatiostring

Example

16:9

embedPathstring

Example

/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee

viewsinteger

Example

likesinteger

Example

dislikesinteger

Example

commentsinteger

PeerTube >= 7.2 Number of comments on the video

nsfwboolean

nsfwFlagsNSFWFlag

Show child attributes

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

NSFWFlag0124

nsfwSummarystring

PeerTube >= 7.2 More information about the sensitive content of the video

aiUsageVideoAIUsageConstant

Show child attributes

idVideoAIUsageSet1234

PeerTube >= 9.0 Use of AI in the video, declared by the video creator:

1 Not specified
2 No AI-generated content: nothing seen or heard in the video has been generated by AI
3 Contains AI-generated content: some parts of the video have been generated by AI
4 AI-generated: the whole video, or most of it, has been generated by AI

labelstring

commercialContentVideoCommercialContentConstant

Show child attributes

idVideoCommercialContentSet123

PeerTube >= 9.0 Commercial content in the video, declared by the video creator:

1 None
2 Promotional content: the creator promotes their own products, services or business
3 Paid partnership: a third party paid, or provided goods or services, in exchange for the promotion

labelstring

recommendationScopeVideoRecommendationScopeConstant

Show child attributes

idVideoRecommendationScopeSet1234

Videos that can be recommended next to a video:

1 All videos
2 Only videos of the platform that owns the reference video (or of the current platform if no video is given)
3 Only videos of the account that owns the reference video
4 Only videos of the channel of the reference video

This is a preference of the video owner: applications displaying recommendations may not apply it

labelstring

waitTranscodingboolean | null

stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes

idid123456789101112131415

The video state:

1: Published
2: To transcode
3: To import
4: Waiting for live stream
5: Live ended
6: To move to an external storage (object storage...)
7: Transcoding failed
8: Moving to an external storage failed
9: To edit using studio edition feature
10: To move to the file system
11: Moving to the file system failed
12: Import failed
13: To duplicate, the files of another video are being copied
14: Duplication failed, the files of the other video could not be copied
15: The studio edition of a video saved as a new video failed

Same fields as data.id

labelstring

scheduledUpdateVideoScheduledUpdate | null

Show child attributes

privacyVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

updateAtstring<date-time>required

When to update the video

blacklistedboolean | null

blacklistedReasonstring | null

accountAccountSummary

Show child attributes

idinteger

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

channelVideoChannelSummary

Show child attributes

idid>= 1

Example

Same fields as data.id

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

userHistoryobject | null

Show child attributes

currentTimeinteger

captionLanguagesArray<string>

PeerTube >= 9.0 Languages of the video captions. Only returned by video lists

List followers of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/followers

List followers of an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/followers?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/followers?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/followers?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "follower": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      },
      "following": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      },
      "score": 0,
      "state": "pending",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringcreatedAtquery

Sort followers by criteria

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<Follow>

Show child attributes

idid>= 1

Example

followerActor

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

followingActor

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

scorenumber

score reflecting the reachability of the actor, with steps of 10 and a base score of 1000.

statestringpendingaccepted

createdAtstring<date-time>

updatedAtstring<date-time>

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.

List accounts

GET

https://peertube2.cpy.re/api/v1/accounts

List accounts

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts?count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts?count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts?count=15')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "url": "https://example.com",
      "avatars": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "host": "example.com",
      "hostRedundancyAllowed": true,
      "followingCount": 0,
      "followersCount": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "displayName": "string",
      "description": "string"
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<Account>

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

List playlists of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/video-playlists

List playlists of an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-playlists?count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-playlists?count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-playlists?count=15')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "description": "string",
      "displayName": "string",
      "isLocal": true,
      "videoLength": 0,
      "thumbnailPath": "string",
      "thumbnails": [
        {
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "aspectRatio": "16:9"
        }
      ],
      "privacy": {
        "id": 1,
        "label": "string"
      },
      "type": {
        "id": 1,
        "label": "string"
      },
      "ownerAccount": {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "videoChannel": {
        "id": 42,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "videoChannelPosition": 1
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

playlistTypeVideoPlaylistTypeSet12query

includeCollaborationsbooleanquery

PeerTube >= 8.0 Include objects from collaborated channels

channelNameOneOfstring | Array<string>query

PeerTube >= 8.0 Filter on playlists that are published on a channel with one of these names

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoPlaylist>

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

createdAtstring<date-time>

updatedAtstring<date-time>

descriptionstring

displayNamestring

isLocalboolean

videoLengthinteger>= 0

thumbnailPathstring | nulldeprecated

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

thumbnailsArray<Thumbnail>

PeerTube >= 8.1 Array of thumbnails for the playlist

Show child attributes

fileUrlstring

widthinteger

heightinteger

aspectRatiostring

Example

16:9

privacyVideoPlaylistPrivacyConstant

Show child attributes

idVideoPlaylistPrivacySet123

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

labelstring

typeVideoPlaylistTypeConstant

Show child attributes

idVideoPlaylistTypeSet12

The video playlist type (Regular = 1, Watch Later = 2)

labelstring

ownerAccountAccountSummary

Show child attributes

idinteger

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

videoChannelVideoChannelSummary

Show child attributes

idid>= 1

Example

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

videoChannelPositioninteger>= 1

Position of the playlist in the channel

List video channels of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/video-channels

List video channels of an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channels?statsDays=30&count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channels?statsDays=30&count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channels?statsDays=30&count=15')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "url": "https://example.com",
      "avatars": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "host": "example.com",
      "hostRedundancyAllowed": true,
      "followingCount": 0,
      "followersCount": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "displayName": "Videos of Framasoft",
      "description": "Videos made with <3 by Framasoft",
      "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
      "publicEmail": "user@example.com",
      "isLocal": true,
      "banners": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ],
      "ownerAccount": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "videosCount": 0,
      "viewsPerDay": [
        {
          "date": "2024-01-15T09:30:00Z",
          "views": 0
        }
      ],
      "viewsGroupInterval": "day",
      "totalViews": 0
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

withStatsbooleanquery

include view statistics time series and total views (only if authenticated as the account user)

statsDaysinteger3090365030query

number of days of view statistics to include in viewsPerDay when withStats is true (only if authenticated as the account user). 0 means all time (since the channel's earliest recorded stat). viewsPerDay always spans the whole requested range so channels can be compared to each other. Its bucket size is reported in viewsGroupInterval: it is derived from the requested range, narrowed to the channel history so that a young channel on a long range is not aggregated into a single coarse bucket. totalViews is unaffected by this parameter and always reports lifetime views.

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

sortstringquery

Sort column

includeCollaborationsbooleanquery

PeerTube >= 8.0 Include objects from collaborated channels

Response

200OKVideoChannelList

successful operation

Response fields application/json

totalinteger

Example

dataArray<Actor & object & Actor>

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

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>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

List the synchronizations of video channels of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/video-channel-syncs

List the synchronizations of video channels of an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/video-channel-syncs?count=15')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "state": {
        "id": 2,
        "label": "PROCESSING"
      },
      "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
      "createdAt": "2024-01-15T09:30:00Z",
      "lastSyncAt": "2024-01-15T09:30:00Z",
      "channel": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "Videos of Framasoft",
        "description": "Videos made with <3 by Framasoft",
        "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
        "publicEmail": "user@example.com",
        "isLocal": true,
        "banners": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "ownerAccount": {
          "id": 42,
          "url": "https://example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ],
          "host": "example.com",
          "hostRedundancyAllowed": true,
          "followingCount": 0,
          "followersCount": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z",
          "displayName": "string",
          "description": "string"
        },
        "videosCount": 0,
        "viewsPerDay": [
          {
            "date": "2024-01-15T09:30:00Z",
            "views": 0
          }
        ],
        "viewsGroupInterval": "day",
        "totalViews": 0
      },
      "videoPrivacy": 0
    }
  ]
}

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

includeCollaborationsbooleanquery

PeerTube >= 8.0 Include objects from collaborated channels

Response

200OKVideoChannelSyncList

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoChannelSync>

Show child attributes

idid>= 1

Example

stateobject

Show child attributes

idinteger

Example

labelstring

Example

PROCESSING

externalChannelUrlstring

Example

https://youtube.com/c/UC_myfancychannel

createdAtstring<date-time>

lastSyncAtstring<date-time> | null

channelActor & object

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

displayNamestring

editable name of the channel, displayed in its representations

Example

Videos of Framasoft

descriptionstring | null

Example

Videos made with <3 by Framasoft

supportstring | null

text shown by default on all videos of this channel, to tell the audience how to support it

Example

Please support our work on https://soutenir.framasoft.org/en/ <3

publicEmailstring<email> | null

Public email visible in podcast RSS feeds

isLocalboolean

updatedAtstring<date-time>

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>

ownerAccountActor & any

Show child attributes

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<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>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videosCountinteger

only included when withStats is true

viewsPerDayArray<object>

only included when withStats is true. Chronologically ordered, spans the whole statsDays range. Each point aggregates viewsGroupInterval worth of views, starting at date

Show child attributes

datestring<date-time>

viewsinteger

viewsGroupIntervalstringdayweekmonth

bucket size of viewsPerDay, only included when withStats is true

totalViewsinteger

lifetime views of all the channel videos, only included when withStats is true

videoPrivacyinteger | null

Default privacy of videos imported by this synchronization

List ratings of an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}/ratings

List ratings of an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/ratings?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/ratings?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org/ratings?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

[
  {
    "video": {
      "isLive": true,
      "liveSchedules": [
        {
          "startAt": "2024-01-15T09:30:00Z"
        }
      ],
      "createdAt": "2017-10-01T10:52:46.396Z",
      "publishedAt": "2018-10-01T10:52:46.396Z",
      "updatedAt": "2021-05-04T08:01:01.502Z",
      "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
      "category": {
        "id": 15,
        "label": "Science & Technology"
      },
      "licence": {
        "id": 2,
        "label": "Attribution - Share Alike"
      },
      "language": {
        "id": "en",
        "label": "English"
      },
      "privacy": {
        "id": 1,
        "label": "string"
      },
      "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
      "duration": 1419,
      "aspectRatio": 1.778,
      "isLocal": true,
      "name": "What is PeerTube?",
      "thumbnailPath": "string",
      "previewPath": "string",
      "thumbnails": [
        {
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "aspectRatio": "16:9"
        }
      ],
      "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
      "views": 1337,
      "likes": 42,
      "dislikes": 7,
      "comments": 0,
      "nsfw": true,
      "nsfwSummary": "string",
      "aiUsage": {
        "id": 1,
        "label": "string"
      },
      "commercialContent": {
        "id": 1,
        "label": "string"
      },
      "recommendationScope": {
        "id": 1,
        "label": "string"
      },
      "waitTranscoding": true,
      "state": {
        "id": 1,
        "label": "string"
      },
      "scheduledUpdate": {
        "privacy": 1,
        "updateAt": "2024-01-15T09:30:00Z"
      },
      "blacklisted": true,
      "blacklistedReason": "string",
      "account": {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "channel": {
        "id": 42,
        "name": "string",
        "displayName": "string",
        "url": "https://example.com",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "userHistory": {
        "currentTime": 0
      },
      "captionLanguages": [
        "fr"
      ]
    },
    "rating": "like"
  }
]

Parameters

namestringrequiredpath

The username or handle of the account

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

ratingstringlikedislikequery

Optionally filter which ratings to retrieve

Response

200OKArray<VideoRating>

successful operation

Response fields application/json

Array<VideoRating>

Show child attributes

videoVideorequired

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes

UUIDv4<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

isLiveboolean

liveSchedulesArray<LiveSchedule>

Show child attributes

startAtstring<date-time>

Date when the stream is scheduled to air at

createdAtstring<date-time>

time at which the video object was first drafted

Example

2017-10-01T10:52:46.396Z

publishedAtstring<date-time>

time at which the video was marked as ready for playback (with restrictions depending on privacy). Usually set after a state evolution.

Example

2018-10-01T10:52:46.396Z

updatedAtstring<date-time>

last time the video's metadata was modified

Example

2021-05-04T08:01:01.502Z

originallyPublishedAtstring<date-time> | null

used to represent a date of first publication, prior to the practical publication date of publishedAt

Example

2010-10-01T10:52:46.396Z

categoryVideoConstantNumber-Category

category in which the video is classified

Show child attributes

idVideoCategorySet

category id of the video (see /videos/categories)

Example

labelstring

Example

Science & Technology

licenceVideoConstantNumber-Licence

licence under which the video is distributed

Show child attributes

idVideoLicenceSet

licence id of the video (see /videos/licences)

Example

labelstring

Example

Attribution - Share Alike

languageVideoConstantString-Language

main language used in the video

Show child attributes

idVideoLanguageSet

language id of the video (see /videos/languages)

Example

en

labelstring

Example

English

privacyVideoPrivacyConstant

Show child attributes

idVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

labelstring

truncatedDescriptionstring | null

truncated description of the video, written in Markdown.

Example

**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...

durationinteger<seconds>

duration of the video in seconds

Example

aspectRationumber<float> | null

PeerTube >= 6.1 Aspect ratio of the video stream

Example

1.778

isLocalboolean

namename

title of the video

Example

What is PeerTube?

thumbnailPathstring | nulldeprecated

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

previewPathstring | nulldeprecated

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

thumbnailsArray<Thumbnail>

PeerTube >= 8.1 Array of thumbnails for the video

Show child attributes

fileUrlstring

widthinteger

heightinteger

aspectRatiostring

Example

16:9

embedPathstring

Example

/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee

viewsinteger

Example

likesinteger

Example

dislikesinteger

Example

commentsinteger

PeerTube >= 7.2 Number of comments on the video

nsfwboolean

nsfwFlagsNSFWFlag

Show child attributes

NSFW flags (can be combined using bitwise or operator)

0 NONE
1 VIOLENT
2 EXPLICIT_SEX

NSFWFlag0124

nsfwSummarystring

PeerTube >= 7.2 More information about the sensitive content of the video

aiUsageVideoAIUsageConstant

Show child attributes

idVideoAIUsageSet1234

PeerTube >= 9.0 Use of AI in the video, declared by the video creator:

1 Not specified
2 No AI-generated content: nothing seen or heard in the video has been generated by AI
3 Contains AI-generated content: some parts of the video have been generated by AI
4 AI-generated: the whole video, or most of it, has been generated by AI

labelstring

commercialContentVideoCommercialContentConstant

Show child attributes

idVideoCommercialContentSet123

PeerTube >= 9.0 Commercial content in the video, declared by the video creator:

1 None
2 Promotional content: the creator promotes their own products, services or business
3 Paid partnership: a third party paid, or provided goods or services, in exchange for the promotion

labelstring

recommendationScopeVideoRecommendationScopeConstant

Show child attributes

idVideoRecommendationScopeSet1234

Videos that can be recommended next to a video:

1 All videos
2 Only videos of the platform that owns the reference video (or of the current platform if no video is given)
3 Only videos of the account that owns the reference video
4 Only videos of the channel of the reference video

This is a preference of the video owner: applications displaying recommendations may not apply it

labelstring

waitTranscodingboolean | null

stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes

idid123456789101112131415

The video state:

1: Published
2: To transcode
3: To import
4: Waiting for live stream
5: Live ended
6: To move to an external storage (object storage...)
7: Transcoding failed
8: Moving to an external storage failed
9: To edit using studio edition feature
10: To move to the file system
11: Moving to the file system failed
12: Import failed
13: To duplicate, the files of another video are being copied
14: Duplication failed, the files of the other video could not be copied
15: The studio edition of a video saved as a new video failed

Same fields as video.id

labelstring

scheduledUpdateVideoScheduledUpdate | null

Show child attributes

privacyVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

updateAtstring<date-time>required

When to update the video

blacklistedboolean | null

blacklistedReasonstring | null

accountAccountSummary

Show child attributes

idinteger

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

channelVideoChannelSummary

Show child attributes

idid>= 1

Example

Same fields as video.id

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<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>

userHistoryobject | null

Show child attributes

currentTimeinteger

captionLanguagesArray<string>

PeerTube >= 9.0 Languages of the video captions. Only returned by video lists

ratingstringlikedislikenonerequired

Rating of the video

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