How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PeerTube Video Channels API

Operations dealing with the creation, modification and listing of videos within a channel.

PeerTube Video Channels API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Video Channels. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 23 operations across 20 paths, and defines 45 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

23 operations 20 paths 45 schemas 4 DELETE10 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube Video Channels API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 23

Across 20 paths, the API surfaces 23 operations — 4 DELETE, 10 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Video Channels 23

Operations dealing with the creation, modification and listing of videos within a channel.

GET
/api/v1/video-channels
List video channels
getVideoChannels 3 params → 200
POST
/api/v1/video-channels
Create a video channel
addVideoChannel body → 200
GET
/api/v1/video-channels/{channelHandle}
Get a video channel
getVideoChannel 1 param → 200
PUT
/api/v1/video-channels/{channelHandle}
Update a video channel
putVideoChannel 1 param body → 204
DELETE
/api/v1/video-channels/{channelHandle}
Delete a video channel
delVideoChannel 1 param → 204
GET
/api/v1/video-channels/{channelHandle}/videos
List videos of a video channel
getVideoChannelVideos 25 params → 200
GET
/api/v1/video-channels/{channelHandle}/activities
List activities of a video channel
listVideoChannelActivities 4 params → 200
GET
/api/v1/video-channels/{channelHandle}/video-playlists
List playlists of a channel
5 params → 200
POST
/api/v1/video-channels/{channelHandle}/video-playlists/reorder
Reorder channel playlists
reorderVideoPlaylistsOfChannel 1 param body → 204
GET
/api/v1/video-channels/{channelHandle}/followers
List followers of a video channel
getVideoChannelFollowers 5 params → 200
POST
/api/v1/video-channels/{channelHandle}/avatar/pick
Update channel avatar
1 param body → 200413
DELETE
/api/v1/video-channels/{channelHandle}/avatar
Delete channel avatar
1 param → 204
POST
/api/v1/video-channels/{channelHandle}/banner/pick
Update channel banner
1 param body → 200413
DELETE
/api/v1/video-channels/{channelHandle}/banner
Delete channel banner
1 param → 204
POST
/api/v1/video-channels/{channelHandle}/import-videos
Import videos in channel
1 param body → 204
GET
/api/v1/accounts/{name}/video-channels
List video channels of an account
7 params → 200
GET
/api/v1/accounts/{name}/video-channel-syncs
List the synchronizations of video channels of an account
5 params → 200
GET
/api/v1/search/video-channels
Search channels
searchChannels 7 params → 200500
GET
/api/v1/video-channels/{channelHandle}/collaborators
List channel collaborators
listVideoChannelCollaborators 1 param → 200
POST
/api/v1/video-channels/{channelHandle}/collaborators/invite
Invite a collaborator
inviteVideoChannelCollaborator 1 param body → 200
POST
/api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}/accept
Accept a collaboration invitation
acceptVideoChannelCollaborator 2 params → 204
POST
/api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}/reject
Reject a collaboration invitation
rejectVideoChannelCollaborator 2 params → 204
DELETE
/api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}
Remove a channel collaborator
removeVideoChannelCollaborator 2 params → 204

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are Video (37 properties), VideoPlaylist (16 properties), Actor (10 properties), Follow (7 properties). Each schema is shown below with its type and property counts.

VideoPlaylistTypeConstant
object
2 properties
VideoConstantNumber-Licence
object
2 properties
VideoConstantString-Language
object
2 properties
ImportVideosInChannelCreate
object
2 properties 1 required
VideoStateConstant
object
2 properties
username
string
immutable name of the user, used to find or mention its actor
VideoChannelCollaborator
object
Representation of a channel collaboration
5 properties
ActorImage
object
6 properties
VideoChannelSummary
object
6 properties
VideoPlaylist
object
16 properties
VideoChannelUpdate
VideoPrivacySet
integer
privacy id of the video (see [/videos/privacies](operation/getVideoPrivacyPolicies))
AccountSummary
object
6 properties
VideoPlaylistPrivacyConstant
object
2 properties
VideoCategorySet
integer
category id of the video (see [/videos/categories](operation/getCategories))
usernameChannel
string
immutable name of the channel, used to interact with its actor
VideoChannelActivityAction
integer
The activity action: - CREATE: 1 - UPDATE: 2 - DELETE: 3 - UPDATECAPTIONS: 4 - UPDATECHAPTERS: 5 - UPDATEPASSWORDS: 6 - CREATESTUDIOTASKS: 7 - UPDATESOURCEFILE…
VideoListResponse
object
2 properties
VideoChannelSync
object
6 properties
VideoPrivacyConstant
object
2 properties
id
integer
Video
object
37 properties
VideoLanguageSet
string
language id of the video (see [/videos/languages](operation/getLanguages))
shortUUID
string
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
VideoChannelSyncList
object
2 properties
UUIDv4
string
VideoChannelEdit
object
3 properties
Thumbnail
object
4 properties
User
object
1 property
VideoChannelList
object
2 properties
ChannelActivityListResponse
object
2 properties
VideoChannel
VideoPlaylistPrivacySet
integer
Video playlist privacy policy (see [/video-playlists/privacies](operation/getPlaylistPrivacyPolicies))
VideoChannelActivityTarget
integer
The activity target: - VIDEO: 1, - PLAYLIST: 2, - CHANNEL: 3, - CHANNELSYNC: 4, - VIDEOIMPORT: 5
VideoChannelCollaboratorState
integer
The user import state: - 1: Pending - 2: Accepted
NSFWFlag
integer
NSFW flags (can be combined using bitwise or operator) - 0 NONE - 1 VIOLENT - 2 EXPLICITSEX
VideoLicenceSet
integer
licence id of the video (see [/videos/licences](operation/getLicences))
VideoScheduledUpdate
object
2 properties 1 required
VideoPlaylistTypeSet
integer
The video playlist type (Regular = 1, Watch Later = 2)
Actor
object
10 properties
LiveSchedule
object
1 property
Follow
object
7 properties
VideoConstantNumber-Category
object
2 properties
VideoChannelCreate
2 required
Account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-video-channels-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
Where this information came from

This is an independent, third-party profile of PeerTube Video Channels API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.