Videos

Channels Sync

Operations dealing with synchronizing PeerTube user's channel with channels of other platforms

Create a synchronization for a video channel

POST

https://peertube2.cpy.re/api/v1/video-channel-syncs

Create a synchronization for a video channel

curl -X POST 'https://peertube2.cpy.re/api/v1/video-channel-syncs' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}'

const body = `{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}`;

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

const data = await response.text();

import requests

body = '''{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}'''

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

Request Body

{
  "externalChannelUrl": "https://youtube.com/c/UC_myfancychannel",
  "videoChannelId": 42,
  "videoPrivacy": 0
}

200

{
  "videoChannelSync": {
    "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
  }
}

Body

application/json

externalChannelUrlstring

Example

https://youtube.com/c/UC_myfancychannel

videoChannelIdid>= 1

Example

videoPrivacyinteger

Privacy of imported videos (1 = PUBLIC, 2 = UNLISTED, 3 = PRIVATE, 4 = INTERNAL). Password protected privacy is not supported

Response

200OKobject

successful operation

Response fields application/json

videoChannelSyncVideoChannelSync

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

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.

Delete a video channel synchronization

DELETE

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

Delete a video channel synchronization

curl -X DELETE 'https://peertube2.cpy.re/api/v1/video-channel-syncs/42' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/video-channel-syncs/42', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/video-channel-syncs/42',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

channelSyncIdid>= 1requiredpath

Channel Sync id

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.

Triggers the channel synchronization job, fetching all the videos from the remote channel

POST

https://peertube2.cpy.re/api/v1/video-channel-syncs/{channelSyncId}/sync

Triggers the channel synchronization job, fetching all the videos from the remote channel

curl -X POST 'https://peertube2.cpy.re/api/v1/video-channel-syncs/42/sync' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/video-channel-syncs/42/sync', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://peertube2.cpy.re/api/v1/video-channel-syncs/42/sync',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

channelSyncIdid>= 1requiredpath

Channel Sync id

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.

Docs by Sourcey