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 Playlists API

Operations dealing with playlists of videos. Playlists are bound to users and/or channels.

PeerTube Video Playlists 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 Playlists. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 16 operations across 11 paths, and defines 25 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.

16 operations 11 paths 25 schemas 2 DELETE8 GET4 POST2 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 Playlists 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 16

Across 11 paths, the API surfaces 16 operations — 2 DELETE, 8 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Video Playlists 16

Operations dealing with playlists of videos. Playlists are bound to users and/or channels.

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-playlists/privacies
List available playlist privacy policies
getPlaylistPrivacyPolicies → 200
GET
/api/v1/video-playlists
List video playlists
getPlaylists 4 params → 200
POST
/api/v1/video-playlists
Create a video playlist
addPlaylist body → 200
GET
/api/v1/video-playlists/{playlistId}
Get a video playlist
1 param → 200
PUT
/api/v1/video-playlists/{playlistId}
Update a video playlist
1 param body → 204
DELETE
/api/v1/video-playlists/{playlistId}
Delete a video playlist
1 param → 204
GET
/api/v1/video-playlists/{playlistId}/videos
List videos of a playlist
getVideoPlaylistVideos 3 params → 200
POST
/api/v1/video-playlists/{playlistId}/videos
Add a video in a playlist
addVideoPlaylistVideo 1 param body → 200
POST
/api/v1/video-playlists/{playlistId}/videos/reorder
Reorder playlist elements
reorderVideoPlaylist 1 param body → 204
PUT
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}
Update a playlist element
putVideoPlaylistVideo 2 params body → 204
DELETE
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}
Delete an element from a playlist
delVideoPlaylistVideo 2 params → 204
GET
/api/v1/users/me/video-playlists/videos-exist
Check video exists in my playlists
1 param → 200
GET
/api/v1/accounts/{name}/video-playlists
List playlists of an account
8 params → 200
GET
/api/v1/search/video-playlists
Search playlists
searchPlaylists 7 params → 200500

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are Video (37 properties), VideoPlaylist (16 properties), ActorImage (6 properties), VideoChannelSummary (6 properties). Each schema is shown below with its type and property counts.

VideoPlaylistTypeConstant
object
2 properties
VideoPlaylistTypeSet
integer
The video playlist type (Regular = 1, Watch Later = 2)
VideoConstantNumber-Licence
object
2 properties
VideoStateConstant
object
2 properties
VideoConstantString-Language
object
2 properties
VideoPlaylist
object
16 properties
Thumbnail
object
4 properties
Video
object
37 properties
VideoPrivacyConstant
object
2 properties
id
integer
LiveSchedule
object
1 property
ActorImage
object
6 properties
VideoPlaylistPrivacySet
integer
Video playlist privacy policy (see [/video-playlists/privacies](operation/getPlaylistPrivacyPolicies))
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
VideoChannelSummary
object
6 properties
UUIDv4
string
VideoPrivacySet
integer
privacy id of the video (see [/videos/privacies](operation/getVideoPrivacyPolicies))
VideoConstantNumber-Category
object
2 properties
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))
AccountSummary
object
6 properties
VideoPlaylistPrivacyConstant
object
2 properties
VideoCategorySet
integer
category id of the video (see [/videos/categories](operation/getCategories))
VideoScheduledUpdate
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-video-playlists-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 Playlists 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.