6 name: PeerTube Community
7 url: 'https://joinpeertube.org'
10 url: 'https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE'
12 url: 'https://joinpeertube.org/img/brand.png'
13 altText: PeerTube Project Homepage
17 The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
18 HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
19 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
20 which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
22 - [Python](https://framagit.org/framasoft/peertube/clients/python)
23 - [Go](https://framagit.org/framasoft/peertube/clients/go)
24 - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
26 See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API.
30 When you sign up for an account, you are given the possibility to generate
31 sessions, and authenticate using this session token. One session token can
32 currently be used at a time.
36 Accounts are given permissions based on their role. There are three roles on
37 PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/#/admin-managing-users?id=roles) for a detail of their permissions.
41 The API uses standard HTTP status codes to indicate the success or failure
42 of the API call. The body of the response will be JSON in the following
47 "code": "unauthorized_request", // example inner error code
48 "error": "Token is invalid." // example exposed error message
52 url: https://docs.joinpeertube.org/api-rest-reference.html
56 Accounts encompass remote accounts discovered across the federation,
57 and correspond to the main Actor, along with video channels a user can create, which
60 When a comment is posted, it is done with your Account's Actor.
63 Using some features of PeerTube require authentication, for which User
64 provide different levels of permission as well as associated user
65 information. Each user has a corresponding local Account for federation.
68 Operations related to your own User, when logged-in.
69 - name: My Subscriptions
71 Operations related to your subscriptions to video channels, their
72 new videos, and how to keep up to date with their latest publications!
73 - name: My Notifications
75 Notifications following new videos, follows or reports. They allow you
76 to keep track of the interactions and overall important information that
77 concerns you. You MAY set per-notification type delivery preference, to
78 receive the info either by mail, by in-browser notification or both.
81 Each server exposes public information regarding supported videos and
85 Jobs are long-running tasks enqueued and processed by the instance
86 itself. No additional worker registration is currently available.
87 - name: Instance Follows
89 Managing servers which the instance interacts with is crucial to the
90 concept of federation in PeerTube and external video indexation. The PeerTube
91 server then deals with inter-server ActivityPub operations and propagates
92 information across its social graph by posting activities to actors' inbox
95 url: https://docs.joinpeertube.org/#/admin-following-instances?id=instances-follows
96 - name: Instance Redundancy
98 Redundancy is part of the inter-server solidarity that PeerTube fosters.
99 Manage the list of instances you wish to help by seeding their videos according
100 to the policy of video selection of your choice. Note that you have a similar functionality
101 to mirror individual videos, see `Video Mirroring`.
103 url: https://docs.joinpeertube.org/#/admin-following-instances?id=instances-redundancy
106 Managing plugins installed from a local path or from NPM, or search for new ones.
108 url: https://docs.joinpeertube.org/#/api-plugins
111 Video abuses deal with reports of local or remote videos alike.
114 Operations dealing with listing, uploading, fetching or modifying videos.
117 The search helps to find _videos_ or _channels_ from within the instance and beyond.
118 Videos from other instances federated by the instance (that is, instances
119 followed by the instance) can be found via keywords and other criteria of
122 Administrators can also enable the use of a remote search system, indexing
123 videos and channels not could be not federated by the instance.
124 - name: Video Comments
126 Operations dealing with comments to a video. Comments are organized in
128 - name: Video Playlists
130 Operations dealing with playlists of videos. Playlists are bound to users
132 - name: Video Channels
134 Operations dealing with the creation, modification and listing of videos within a channel.
137 Operations dealing with blocking videos (removing them from view and
138 preventing interactions).
141 Like/dislike a video.
144 Server syndication feeds
161 - Video Ownership Change
173 - name: Instance Configuration
177 - Instance Redundancy
187 summary: Get an account
189 - $ref: '#/components/parameters/name'
192 description: successful operation
196 $ref: '#/components/schemas/Account'
198 description: account not found
199 '/accounts/{name}/videos':
204 summary: 'List videos of an account'
206 - $ref: '#/components/parameters/name'
207 - $ref: '#/components/parameters/categoryOneOf'
208 - $ref: '#/components/parameters/tagsOneOf'
209 - $ref: '#/components/parameters/tagsAllOf'
210 - $ref: '#/components/parameters/licenceOneOf'
211 - $ref: '#/components/parameters/languageOneOf'
212 - $ref: '#/components/parameters/nsfw'
213 - $ref: '#/components/parameters/filter'
214 - $ref: '#/components/parameters/skipCount'
215 - $ref: '#/components/parameters/start'
216 - $ref: '#/components/parameters/count'
217 - $ref: '#/components/parameters/videosSort'
220 description: successful operation
224 $ref: '#/components/schemas/VideoListResponse'
228 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
229 .then(function(response) {
230 return response.json()
231 }).then(function(data) {
237 http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
243 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
245 http = Net::HTTP.new(uri.host, uri.port)
248 response = http.get(uri.request_uri)
250 puts JSON.parse(response.read_body)
255 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
263 summary: List accounts
265 - $ref: '#/components/parameters/start'
266 - $ref: '#/components/parameters/count'
267 - $ref: '#/components/parameters/sort'
270 description: successful operation
276 $ref: '#/components/schemas/Account'
281 summary: Get instance public configuration
284 description: successful operation
288 $ref: '#/components/schemas/ServerConfig'
291 summary: Get instance "About" information
296 description: successful operation
300 $ref: '#/components/schemas/ServerConfigAbout'
303 summary: Get instance runtime configuration
311 description: successful operation
315 $ref: '#/components/schemas/ServerConfigCustom'
317 summary: Set instance runtime configuration
325 description: successful operation
327 x-summary: field inconsistencies
330 - the emailer is disabled and the instance is open to registrations
331 - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
333 summary: Delete instance runtime configuration
341 description: successful operation
344 summary: List instance jobs
354 description: The state of the job
363 - $ref: '#/components/parameters/start'
364 - $ref: '#/components/parameters/count'
365 - $ref: '#/components/parameters/sort'
368 description: successful operation
381 $ref: '#/components/schemas/Job'
382 '/server/following/{host}':
389 summary: Unfollow a server
394 description: 'The host to unfollow '
400 description: successful operation
405 summary: List instance followers
407 - $ref: '#/components/parameters/start'
408 - $ref: '#/components/parameters/count'
409 - $ref: '#/components/parameters/sort'
412 description: successful operation
418 $ref: '#/components/schemas/Follow'
423 summary: List instances followed by the server
442 - $ref: '#/components/parameters/start'
443 - $ref: '#/components/parameters/count'
444 - $ref: '#/components/parameters/sort'
447 description: successful operation
453 $ref: '#/components/schemas/Follow'
460 summary: Follow a server
463 description: successful operation
465 description: cannot follow a non-HTTPS server
480 summary: Create a user
488 description: user created
492 $ref: '#/components/schemas/AddUserResponse'
496 operationId: getUserId
498 id: '$response.body#/user/id'
501 operationId: putUserId
503 id: '$response.body#/user/id'
506 operationId: delUserId
508 id: '$response.body#/user/id'
510 description: insufficient authority to create an admin or moderator
515 $ref: '#/components/schemas/AddUser'
516 description: User to create
526 - $ref: '#/components/parameters/usersSearch'
527 - $ref: '#/components/parameters/usersBlocked'
528 - $ref: '#/components/parameters/start'
529 - $ref: '#/components/parameters/count'
530 - $ref: '#/components/parameters/usersSort'
533 description: successful operation
539 $ref: '#/components/schemas/User'
542 - $ref: '#/components/parameters/id'
544 summary: Delete a user
550 operationId: delUserId
553 description: successful operation
560 operationId: getUserId
563 description: successful operation
567 $ref: '#/components/schemas/User'
569 summary: Update a user
574 operationId: putUserId
577 description: successful operation
582 $ref: '#/components/schemas/UpdateUser'
586 summary: Register a user
591 description: successful operation
596 $ref: '#/components/schemas/RegisterUser'
600 summary: Get my user information
608 description: successful operation
614 $ref: '#/components/schemas/User'
616 summary: Update my user information
624 description: successful operation
629 $ref: '#/components/schemas/UpdateMe'
631 /users/me/videos/imports:
633 summary: Get video imports of my user
641 - $ref: '#/components/parameters/start'
642 - $ref: '#/components/parameters/count'
643 - $ref: '#/components/parameters/sort'
646 description: successful operation
650 $ref: '#/components/schemas/VideoImport'
651 /users/me/video-quota-used:
653 summary: Get my user used quota
661 description: successful operation
666 '/users/me/videos/{videoId}/rating':
668 summary: Get rate of my user for a video
678 description: 'The video id '
683 description: successful operation
687 $ref: '#/components/schemas/GetMeVideoRating'
690 summary: Get videos of my user
698 - $ref: '#/components/parameters/start'
699 - $ref: '#/components/parameters/count'
700 - $ref: '#/components/parameters/sort'
703 description: successful operation
707 $ref: '#/components/schemas/VideoListResponse'
708 /users/me/subscriptions:
710 summary: Get my user subscriptions
717 - $ref: '#/components/parameters/start'
718 - $ref: '#/components/parameters/count'
719 - $ref: '#/components/parameters/sort'
722 description: successful operation
726 summary: Add subscription to my user
739 description: uri of the video channels to subscribe to
745 uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
748 description: successful operation
749 /users/me/subscriptions/exist:
751 summary: Get if subscriptions exist for my user
758 - $ref: '#/components/parameters/subscriptionsUris'
761 description: successful operation
766 /users/me/subscriptions/videos:
768 summary: List videos of subscriptions of my user
776 - $ref: '#/components/parameters/categoryOneOf'
777 - $ref: '#/components/parameters/tagsOneOf'
778 - $ref: '#/components/parameters/tagsAllOf'
779 - $ref: '#/components/parameters/licenceOneOf'
780 - $ref: '#/components/parameters/languageOneOf'
781 - $ref: '#/components/parameters/nsfw'
782 - $ref: '#/components/parameters/filter'
783 - $ref: '#/components/parameters/skipCount'
784 - $ref: '#/components/parameters/start'
785 - $ref: '#/components/parameters/count'
786 - $ref: '#/components/parameters/videosSort'
789 description: successful operation
793 $ref: '#/components/schemas/VideoListResponse'
794 '/users/me/subscriptions/{subscriptionHandle}':
796 summary: Get subscription of my user
803 - $ref: '#/components/parameters/subscriptionHandle'
806 description: successful operation
810 $ref: '#/components/schemas/VideoChannel'
812 summary: Delete subscription of my user
819 - $ref: '#/components/parameters/subscriptionHandle'
822 description: successful operation
823 /users/me/notifications:
825 summary: List my notifications
833 description: only list unread notifications
836 - $ref: '#/components/parameters/start'
837 - $ref: '#/components/parameters/count'
838 - $ref: '#/components/parameters/sort'
841 description: successful operation
845 $ref: '#/components/schemas/NotificationListResponse'
846 /users/me/notifications/read:
848 summary: Mark notifications as read by their id
861 description: ids of the notifications to mark as read
868 description: successful operation
869 /users/me/notifications/read-all:
871 summary: Mark all my notification as read
878 description: successful operation
879 /users/me/notification-settings:
881 summary: Update my notification settings
892 newVideoFromSubscription:
893 $ref: '#/components/schemas/NotificationSettingValue'
895 $ref: '#/components/schemas/NotificationSettingValue'
896 videoAbuseAsModerator:
897 $ref: '#/components/schemas/NotificationSettingValue'
898 videoAutoBlacklistAsModerator:
899 $ref: '#/components/schemas/NotificationSettingValue'
901 $ref: '#/components/schemas/NotificationSettingValue'
903 $ref: '#/components/schemas/NotificationSettingValue'
904 myVideoImportFinished:
905 $ref: '#/components/schemas/NotificationSettingValue'
907 $ref: '#/components/schemas/NotificationSettingValue'
909 $ref: '#/components/schemas/NotificationSettingValue'
911 $ref: '#/components/schemas/NotificationSettingValue'
913 $ref: '#/components/schemas/NotificationSettingValue'
914 autoInstanceFollowing:
915 $ref: '#/components/schemas/NotificationSettingValue'
918 description: successful operation
919 /users/me/avatar/pick:
921 summary: Update my user avatar
928 description: successful operation
932 $ref: '#/components/schemas/Avatar'
940 description: The file to upload.
945 contentType: image/png, image/jpeg
948 summary: List video ownership changes
950 - Video Ownership Change
955 description: successful operation
956 '/videos/ownership/{id}/accept':
958 summary: Accept ownership change request
960 - Video Ownership Change
964 - $ref: '#/components/parameters/idOrUUID'
967 description: successful operation
969 description: cannot terminate an ownership change of another user
971 description: video owneship change not found
972 '/videos/ownership/{id}/refuse':
974 summary: Refuse ownership change request
976 - Video Ownership Change
980 - $ref: '#/components/parameters/idOrUUID'
983 description: successful operation
985 description: cannot terminate an ownership change of another user
987 description: video owneship change not found
988 '/videos/{id}/give-ownership':
990 summary: Request ownership change
992 - Video Ownership Change
996 - $ref: '#/components/parameters/idOrUUID'
1000 application/x-www-form-urlencoded:
1010 description: successful operation
1012 description: changing video ownership to a remote account is not supported yet
1014 description: video not found
1017 summary: List videos
1021 - $ref: '#/components/parameters/categoryOneOf'
1022 - $ref: '#/components/parameters/tagsOneOf'
1023 - $ref: '#/components/parameters/tagsAllOf'
1024 - $ref: '#/components/parameters/licenceOneOf'
1025 - $ref: '#/components/parameters/languageOneOf'
1026 - $ref: '#/components/parameters/nsfw'
1027 - $ref: '#/components/parameters/filter'
1028 - $ref: '#/components/parameters/skipCount'
1029 - $ref: '#/components/parameters/start'
1030 - $ref: '#/components/parameters/count'
1031 - $ref: '#/components/parameters/videosSort'
1034 description: successful operation
1038 $ref: '#/components/schemas/VideoListResponse'
1041 summary: List available video categories
1046 description: successful operation
1055 externalValue: https://peertube2.cpy.re/api/v1/videos/categories
1058 summary: List available video licences
1063 description: successful operation
1072 externalValue: https://peertube2.cpy.re/api/v1/videos/licences
1075 summary: List available video languages
1080 description: successful operation
1089 externalValue: https://peertube2.cpy.re/api/v1/videos/languages
1092 summary: List available video privacies
1097 description: successful operation
1106 externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
1109 summary: Update a video
1115 - $ref: '#/components/parameters/idOrUUID'
1118 description: successful operation
1121 multipart/form-data:
1126 description: Video thumbnail file
1130 description: Video preview file
1134 description: Video category
1138 description: Video licence
1142 description: Video language
1145 $ref: '#/components/schemas/VideoPrivacySet'
1147 description: Video description
1150 description: Whether or not we wait transcoding before publish the video
1153 description: A text tell the audience how to support the video creator
1154 example: Please support my work on <insert crowdfunding plateform>! <3
1157 description: Whether or not this video contains sensitive content
1160 description: Video name
1163 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1172 description: Enable or disable comments for this video
1174 originallyPublishedAt:
1175 description: Date when the content was originally published
1179 $ref: '#/components/schemas/VideoScheduledUpdate'
1182 contentType: image/jpeg
1184 contentType: image/jpeg
1186 summary: Get a video
1190 - $ref: '#/components/parameters/idOrUUID'
1193 description: successful operation
1197 $ref: '#/components/schemas/VideoDetails'
1199 summary: Delete a video
1205 - $ref: '#/components/parameters/idOrUUID'
1208 description: successful operation
1209 '/videos/{id}/description':
1211 summary: Get complete video description
1215 - $ref: '#/components/parameters/idOrUUID'
1218 description: successful operation
1223 '/videos/{id}/views':
1225 summary: Add a view to a video
1229 - $ref: '#/components/parameters/idOrUUID'
1232 description: successful operation
1233 '/videos/{id}/watching':
1235 summary: Set watching progress of a video
1241 - $ref: '#/components/parameters/idOrUUID'
1246 $ref: '#/components/schemas/UserWatchingVideo'
1250 description: successful operation
1253 summary: Upload a video
1260 description: successful operation
1264 $ref: '#/components/schemas/VideoUploadResponse'
1266 description: user video quota is exceeded with this video
1268 description: upload has timed out
1270 description: invalid input file
1273 multipart/form-data:
1278 description: Video file
1282 description: Channel id that will contain this video
1285 description: Video thumbnail file
1289 description: Video preview file
1293 $ref: '#/components/schemas/VideoPrivacySet'
1295 description: Video category
1299 description: Video licence
1302 description: Video language
1306 description: Video description
1309 description: Whether or not we wait transcoding before publish the video
1312 description: A text tell the audience how to support the video creator
1313 example: Please support my work on <insert crowdfunding plateform>! <3
1316 description: Whether or not this video contains sensitive content
1319 description: Video name
1322 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1332 description: Enable or disable comments for this video
1334 originallyPublishedAt:
1335 description: Date when the content was originally published
1339 $ref: '#/components/schemas/VideoScheduledUpdate'
1346 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1348 contentType: image/jpeg
1350 contentType: image/jpeg
1354 ## DEPENDENCIES: httpie, jq
1355 # pip install httpie
1356 USERNAME="<your_username>"
1357 PASSWORD="<your_password>"
1358 FILE_PATH="<your_file_path>"
1359 CHANNEL_ID="<your_channel_id>"
1362 API_PATH="https://peertube2.cpy.re/api/v1"
1364 client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1365 client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1366 token=$(http -b --form POST "$API_PATH/users/token" \
1367 client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
1368 username=$USERNAME \
1369 password=$PASSWORD \
1370 | jq -r ".access_token")
1372 http -b --form POST "$API_PATH/videos/upload" \
1373 videofile@$FILE_PATH \
1374 channelId=$CHANNEL_ID \
1376 "Authorization:Bearer $token"
1379 summary: Import a video
1380 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1387 multipart/form-data:
1392 description: Torrent File
1396 description: HTTP target URL
1399 description: Magnet URI
1402 description: Channel id that will contain this video
1405 description: Video thumbnail file
1409 description: Video preview file
1413 $ref: '#/components/schemas/VideoPrivacySet'
1415 description: Video category
1418 description: Video licence
1421 description: Video language
1424 description: Video description
1427 description: Whether or not we wait transcoding before publish the video
1430 description: A text tell the audience how to support the video creator
1431 example: Please support my work on <insert crowdfunding plateform>! <3
1434 description: Whether or not this video contains sensitive content
1437 description: Video name
1440 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1449 description: Enable or disable comments for this video
1452 $ref: '#/components/schemas/VideoScheduledUpdate'
1458 contentType: application/x-bittorrent
1460 contentType: image/jpeg
1462 contentType: image/jpeg
1465 description: successful operation
1469 $ref: '#/components/schemas/VideoUploadResponse'
1471 description: HTTP or Torrent/magnetURI import not enabled
1473 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1477 summary: List video abuses
1487 description: only list the report with this id
1490 - name: predefinedReason
1492 description: predefined reason the listed reports should contain
1506 description: plain search that will match with video titles, reporter names and more
1511 description: 'The video playlist privacy (Pending = `1`, Rejected = `2`, Accepted = `3`)'
1518 - name: searchReporter
1520 description: only list reports of a specific reporter
1523 - name: searchReportee
1524 description: only list reports of a specific reportee
1530 description: only list reports of a specific video
1533 - name: searchVideoChannel
1535 description: only list reports of a specific video channel
1538 - $ref: '#/components/parameters/start'
1539 - $ref: '#/components/parameters/count'
1540 - $ref: '#/components/parameters/abusesSort'
1543 description: successful operation
1549 $ref: '#/components/schemas/VideoAbuse'
1550 '/videos/{id}/abuse':
1553 summary: Report an abuse
1560 - $ref: '#/components/parameters/idOrUUID'
1569 description: Reason why the user reports this video
1573 description: Reason categories that help triage reports
1588 description: Timestamp in the video that marks the beginning of the report
1592 description: Timestamp in the video that marks the ending of the report
1598 description: successful operation
1600 description: incorrect request parameters
1601 '/videos/{id}/abuse/{abuseId}':
1604 summary: Update an abuse
1612 - $ref: '#/components/parameters/idOrUUID'
1613 - $ref: '#/components/parameters/abuseId'
1621 $ref: '#/components/schemas/VideoAbuseStateSet'
1624 description: Update the report comment visible only to the moderation team
1627 description: successful operation
1629 description: video abuse not found
1634 summary: Delete an abuse
1640 - $ref: '#/components/parameters/idOrUUID'
1641 - $ref: '#/components/parameters/abuseId'
1644 description: successful operation
1646 description: block not found
1648 '/videos/{id}/blacklist':
1650 summary: Block a video
1658 - $ref: '#/components/parameters/idOrUUID'
1661 description: successful operation
1663 summary: Unblock a video by its id
1671 - $ref: '#/components/parameters/idOrUUID'
1674 description: successful operation
1676 description: block not found
1681 summary: List video blocks
1690 list only blocks that match this type:
1694 - `2`: automatic block that needs review
1702 description: plain search that will match with video titles, and more
1705 - $ref: '#/components/parameters/start'
1706 - $ref: '#/components/parameters/count'
1707 - $ref: '#/components/parameters/blacklistsSort'
1710 description: successful operation
1722 $ref: '#/components/schemas/VideoBlacklist'
1723 /videos/{id}/captions:
1725 summary: List captions of a video
1729 - $ref: '#/components/parameters/idOrUUID'
1732 description: successful operation
1744 $ref: '#/components/schemas/VideoCaption'
1745 /videos/{id}/captions/{captionLanguage}:
1747 summary: Add or replace a video caption
1751 - $ref: '#/components/parameters/idOrUUID'
1752 - $ref: '#/components/parameters/captionLanguage'
1755 multipart/form-data:
1760 description: The file to upload.
1765 contentType: text/vtt, application/x-subrip, text/plain
1768 description: successful operation
1770 description: video or language not found
1772 summary: Delete a video caption
1776 - $ref: '#/components/parameters/idOrUUID'
1777 - $ref: '#/components/parameters/captionLanguage'
1780 description: successful operation
1782 description: video or language or caption for that language not found
1785 summary: List video channels
1789 - $ref: '#/components/parameters/start'
1790 - $ref: '#/components/parameters/count'
1791 - $ref: '#/components/parameters/sort'
1794 description: successful operation
1806 $ref: '#/components/schemas/VideoChannel'
1808 summary: Create a video channel
1815 description: successful operation
1820 $ref: '#/components/schemas/VideoChannelCreate'
1821 '/video-channels/{channelHandle}':
1823 summary: Get a video channel
1827 - $ref: '#/components/parameters/channelHandle'
1830 description: successful operation
1834 $ref: '#/components/schemas/VideoChannel'
1836 summary: Update a video channel
1842 - $ref: '#/components/parameters/channelHandle'
1845 description: successful operation
1850 $ref: '#/components/schemas/VideoChannelUpdate'
1852 summary: Delete a video channel
1858 - $ref: '#/components/parameters/channelHandle'
1861 description: successful operation
1862 '/video-channels/{channelHandle}/videos':
1864 summary: List videos of a video channel
1869 - $ref: '#/components/parameters/channelHandle'
1870 - $ref: '#/components/parameters/categoryOneOf'
1871 - $ref: '#/components/parameters/tagsOneOf'
1872 - $ref: '#/components/parameters/tagsAllOf'
1873 - $ref: '#/components/parameters/licenceOneOf'
1874 - $ref: '#/components/parameters/languageOneOf'
1875 - $ref: '#/components/parameters/nsfw'
1876 - $ref: '#/components/parameters/filter'
1877 - $ref: '#/components/parameters/skipCount'
1878 - $ref: '#/components/parameters/start'
1879 - $ref: '#/components/parameters/count'
1880 - $ref: '#/components/parameters/videosSort'
1883 description: successful operation
1887 $ref: '#/components/schemas/VideoListResponse'
1889 /video-playlists/privacies:
1891 summary: List available playlist privacies
1896 description: successful operation
1905 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
1909 summary: List video playlists
1913 - $ref: '#/components/parameters/start'
1914 - $ref: '#/components/parameters/count'
1915 - $ref: '#/components/parameters/sort'
1918 description: successful operation
1930 $ref: '#/components/schemas/VideoPlaylist'
1932 summary: Create a video playlist
1933 description: 'If the video playlist is set as public, the videoChannelId is mandatory.'
1940 description: successful operation
1955 multipart/form-data:
1960 description: Video playlist display name
1963 description: Video playlist thumbnail file
1967 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
1969 description: Video playlist description
1972 description: Video channel in which the playlist will be published
1978 contentType: image/jpeg
1980 /video-playlists/{id}:
1982 summary: Get a video playlist
1986 - $ref: '#/components/parameters/idOrUUID'
1989 description: successful operation
1993 $ref: '#/components/schemas/VideoPlaylist'
1995 summary: Update a video playlist
1996 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2003 description: successful operation
2005 - $ref: '#/components/parameters/idOrUUID'
2008 multipart/form-data:
2013 description: Video playlist display name
2016 description: Video playlist thumbnail file
2020 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2022 description: Video playlist description
2025 description: Video channel in which the playlist will be published
2029 contentType: image/jpeg
2031 summary: Delete a video playlist
2037 - $ref: '#/components/parameters/idOrUUID'
2040 description: successful operation
2042 /video-playlists/{id}/videos:
2044 summary: 'List videos of a playlist'
2049 - $ref: '#/components/parameters/idOrUUID'
2052 description: successful operation
2056 $ref: '#/components/schemas/VideoListResponse'
2058 summary: 'Add a video in a playlist'
2065 - $ref: '#/components/parameters/idOrUUID'
2068 description: successful operation
2074 videoPlaylistElement:
2087 description: 'Video to add in the playlist'
2090 description: 'Start the video at this specific timestamp (in seconds)'
2093 description: 'Stop the video at this specific timestamp (in seconds)'
2097 /video-playlists/{id}/videos/reorder:
2099 summary: 'Reorder a playlist'
2105 - $ref: '#/components/parameters/idOrUUID'
2108 description: successful operation
2117 description: 'Start position of the element to reorder'
2119 insertAfterPosition:
2121 description: 'New position for the block to reorder, to add the block before the first element'
2125 description: 'How many element from `startPosition` to reorder'
2129 - insertAfterPosition
2131 /video-playlists/{id}/videos/{playlistElementId}:
2133 summary: 'Update a playlist element'
2139 - $ref: '#/components/parameters/idOrUUID'
2140 - $ref: '#/components/parameters/playlistElementId'
2143 description: successful operation
2152 description: 'Start the video at this specific timestamp (in seconds)'
2155 description: 'Stop the video at this specific timestamp (in seconds)'
2157 summary: 'Delete an element from a playlist'
2163 - $ref: '#/components/parameters/idOrUUID'
2164 - $ref: '#/components/parameters/playlistElementId'
2167 description: successful operation
2169 '/users/me/video-playlists/videos-exist':
2171 summary: 'Check video exists in my playlists'
2180 description: The video ids to check
2187 description: successful operation
2207 '/accounts/{name}/video-channels':
2209 summary: List video channels of an account
2214 - $ref: '#/components/parameters/name'
2217 description: include view statistics for the last 30 days (only if authentified as the account user)
2220 - $ref: '#/components/parameters/start'
2221 - $ref: '#/components/parameters/count'
2222 - $ref: '#/components/parameters/sort'
2225 description: successful operation
2231 $ref: '#/components/schemas/VideoChannel'
2232 '/accounts/{name}/ratings':
2234 summary: List ratings of an account
2240 - $ref: '#/components/parameters/name'
2241 - $ref: '#/components/parameters/start'
2242 - $ref: '#/components/parameters/count'
2243 - $ref: '#/components/parameters/sort'
2247 description: Optionally filter which ratings to retrieve
2255 description: successful operation
2261 $ref: '#/components/schemas/VideoRating'
2262 '/videos/{id}/comment-threads':
2264 summary: List threads of a video
2268 - $ref: '#/components/parameters/idOrUUID'
2269 - $ref: '#/components/parameters/start'
2270 - $ref: '#/components/parameters/count'
2271 - $ref: '#/components/parameters/commentsSort'
2274 description: successful operation
2278 $ref: '#/components/schemas/CommentThreadResponse'
2280 summary: Create a thread
2286 - $ref: '#/components/parameters/idOrUUID'
2289 description: successful operation
2293 $ref: '#/components/schemas/CommentThreadPostResponse'
2295 description: video does not exist
2304 description: 'Text comment'
2308 '/videos/{id}/comment-threads/{threadId}':
2310 summary: Get a thread
2314 - $ref: '#/components/parameters/idOrUUID'
2315 - $ref: '#/components/parameters/threadId'
2318 description: successful operation
2322 $ref: '#/components/schemas/VideoCommentThreadTree'
2323 '/videos/{id}/comments/{commentId}':
2325 summary: Reply to a thread of a video
2331 - $ref: '#/components/parameters/idOrUUID'
2332 - $ref: '#/components/parameters/commentId'
2335 description: successful operation
2339 $ref: '#/components/schemas/CommentThreadPostResponse'
2341 description: thread or video does not exist
2350 description: 'Text comment'
2355 summary: Delete a comment or a reply
2361 - $ref: '#/components/parameters/idOrUUID'
2362 - $ref: '#/components/parameters/commentId'
2365 description: successful operation
2367 description: cannot remove comment of another user
2369 description: comment or video does not exist
2371 description: comment is already deleted
2372 '/videos/{id}/rate':
2374 summary: Like/dislike a video
2380 - $ref: '#/components/parameters/idOrUUID'
2383 description: successful operation
2385 description: video does not exist
2390 summary: Search videos
2395 allowEmptyValue: false
2397 String to search. If the user can make a remote URI search, and the string is an URI then the
2398 PeerTube instance will fetch the remote object and add it to its database. Then,
2399 you can use the REST API to fetch the complete video information and interact with it.
2402 - $ref: '#/components/parameters/categoryOneOf'
2403 - $ref: '#/components/parameters/tagsOneOf'
2404 - $ref: '#/components/parameters/tagsAllOf'
2405 - $ref: '#/components/parameters/licenceOneOf'
2406 - $ref: '#/components/parameters/languageOneOf'
2407 - $ref: '#/components/parameters/nsfw'
2408 - $ref: '#/components/parameters/filter'
2409 - $ref: '#/components/parameters/skipCount'
2410 - $ref: '#/components/parameters/start'
2411 - $ref: '#/components/parameters/count'
2412 - $ref: '#/components/parameters/searchTarget'
2413 - $ref: '#/components/parameters/videosSearchSort'
2416 description: Get videos that are published after this date
2422 description: Get videos that are published before this date
2426 - name: originallyPublishedStartDate
2428 description: Get videos that are originally published after this date
2432 - name: originallyPublishedEndDate
2434 description: Get videos that are originally published before this date
2440 description: Get videos that have this minimum duration
2445 description: Get videos that have this maximum duration
2449 'searchTarget === search-index':
2450 $ref: '#/components/callbacks/searchIndex'
2453 description: successful operation
2457 $ref: '#/components/schemas/VideoListResponse'
2459 description: search index unavailable
2460 /search/video-channels:
2464 summary: Search channels
2470 String to search. If the user can make a remote URI search, and the string is an URI then the
2471 PeerTube instance will fetch the remote object and add it to its database. Then,
2472 you can use the REST API to fetch the complete channel information and interact with it.
2475 - $ref: '#/components/parameters/start'
2476 - $ref: '#/components/parameters/count'
2477 - $ref: '#/components/parameters/searchTarget'
2478 - $ref: '#/components/parameters/sort'
2480 'searchTarget === search-index':
2481 $ref: '#/components/callbacks/searchIndex'
2484 description: successful operation
2490 $ref: '#/components/schemas/VideoChannel'
2492 description: search index unavailable
2493 /blocklist/accounts:
2497 summary: List account blocks
2502 - $ref: '#/components/parameters/start'
2503 - $ref: '#/components/parameters/count'
2504 - $ref: '#/components/parameters/sort'
2507 description: successful operation
2511 summary: Block an account
2523 example: chocobozzz@example.org
2524 description: account to block, in the form `username@domain`
2529 description: successful operation
2531 description: self-blocking forbidden
2532 '/blocklist/accounts/{accountName}':
2536 summary: Unblock an account by its handle
2544 description: account to unblock, in the form `username@domain`
2549 description: successful operation
2551 description: account or account block does not exist
2556 summary: List server blocks
2561 - $ref: '#/components/parameters/start'
2562 - $ref: '#/components/parameters/count'
2563 - $ref: '#/components/parameters/sort'
2566 description: successful operation
2570 summary: Block a server
2583 description: server domain to block
2588 description: successful operation
2590 description: self-blocking forbidden
2591 '/blocklist/servers/{host}':
2595 summary: Unblock a server by its domain
2603 description: server domain to unblock
2609 description: successful operation
2611 description: account block does not exist
2615 - Instance Redundancy
2616 summary: Update a server redundancy policy
2624 description: server domain to mirror
2636 description: allow mirroring of the host's local videos
2641 description: successful operation
2643 description: server is not already known
2648 summary: List videos being mirrored
2656 description: direction of the mirror
2662 - $ref: '#/components/parameters/start'
2663 - $ref: '#/components/parameters/count'
2664 - $ref: '#/components/parameters/videoRedundanciesSort'
2667 description: successful operation
2673 $ref: '#/components/schemas/VideoRedundancy'
2677 summary: Mirror a video
2693 description: successful operation
2695 description: cannot mirror a local video
2697 description: video does not exist
2699 description: video is already mirrored
2700 /redundancy/videos/{redundancyId}:
2704 summary: Delete a mirror done on a video
2709 - name: redundancyId
2712 description: id of an existing redundancy on a video
2717 description: successful operation
2719 description: video redundancy not found
2720 '/feeds/video-comments.{format}':
2724 summary: List comments on videos
2726 - url: 'https://peertube2.cpy.re'
2727 description: Live Test Server (live data - latest nightly version)
2728 - url: 'https://peertube3.cpy.re'
2729 description: Live Test Server (live data - latest RC version)
2730 - url: 'https://peertube.cpy.re'
2731 description: Live Test Server (live data - stable version)
2736 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
2749 description: 'limit listing to a specific video'
2754 description: 'limit listing to a specific account'
2759 description: 'limit listing to a specific account'
2762 - name: videoChannelId
2764 description: 'limit listing to a specific video channel'
2767 - name: videoChannelName
2769 description: 'limit listing to a specific video channel'
2774 description: successful operation
2779 default: 'max-age=900' # 15 min cache
2783 $ref: '#/components/schemas/VideoCommentsForXML'
2784 application/rss+xml:
2786 $ref: '#/components/schemas/VideoCommentsForXML'
2789 $ref: '#/components/schemas/VideoCommentsForXML'
2790 application/atom+xml:
2792 $ref: '#/components/schemas/VideoCommentsForXML'
2797 x-summary: field inconsistencies
2800 - videoId filter is mixed with a channel filter
2802 description: video, video channel or account not found
2804 description: accept header unsupported
2805 '/feeds/videos.{format}':
2809 summary: List videos
2811 - url: 'https://peertube2.cpy.re'
2812 description: Live Test Server (live data - latest nightly version)
2813 - url: 'https://peertube3.cpy.re'
2814 description: Live Test Server (live data - latest RC version)
2815 - url: 'https://peertube.cpy.re'
2816 description: Live Test Server (live data - stable version)
2821 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
2834 description: 'limit listing to a specific account'
2839 description: 'limit listing to a specific account'
2842 - name: videoChannelId
2844 description: 'limit listing to a specific video channel'
2847 - name: videoChannelName
2849 description: 'limit listing to a specific video channel'
2852 - $ref: '#/components/parameters/sort'
2853 - $ref: '#/components/parameters/nsfw'
2854 - $ref: '#/components/parameters/filter'
2857 description: successful operation
2862 default: 'max-age=900' # 15 min cache
2866 $ref: '#/components/schemas/VideosForXML'
2869 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
2870 application/rss+xml:
2872 $ref: '#/components/schemas/VideosForXML'
2875 $ref: '#/components/schemas/VideosForXML'
2876 application/atom+xml:
2878 $ref: '#/components/schemas/VideosForXML'
2883 description: video channel or account not found
2885 description: accept header unsupported
2890 summary: List plugins
2903 - $ref: '#/components/parameters/start'
2904 - $ref: '#/components/parameters/count'
2905 - $ref: '#/components/parameters/sort'
2908 description: successful operation
2912 $ref: '#/components/schemas/PluginResponse'
2917 summary: List available plugins
2930 - name: currentPeerTubeEngine
2934 - $ref: '#/components/parameters/start'
2935 - $ref: '#/components/parameters/count'
2936 - $ref: '#/components/parameters/sort'
2939 description: successful operation
2943 $ref: '#/components/schemas/PluginResponse'
2945 description: plugin index unavailable
2950 summary: Install a plugin
2963 example: peertube-plugin-auth-ldap
2966 additionalProperties: false
2973 additionalProperties: false
2976 description: successful operation
2978 description: should have either `npmName` or `path` set
2983 summary: Update a plugin
2996 example: peertube-plugin-auth-ldap
2999 additionalProperties: false
3006 additionalProperties: false
3009 description: successful operation
3011 description: should have either `npmName` or `path` set
3013 description: existing plugin not found
3018 summary: Uninstall a plugin
3030 description: name of the plugin/theme in its package.json
3031 example: peertube-plugin-auth-ldap
3036 description: successful operation
3038 description: existing plugin not found
3043 summary: Get a plugin
3048 - $ref: '#/components/parameters/npmName'
3051 description: successful operation
3055 $ref: '#/components/schemas/Plugin'
3057 description: plugin not found
3058 /plugins/{npmName}/settings:
3062 summary: Set a plugin's settings
3067 - $ref: '#/components/parameters/npmName'
3076 additionalProperties: true
3079 description: successful operation
3081 description: plugin not found
3082 /plugins/{npmName}/public-settings:
3086 summary: Get a plugin's public settings
3088 - $ref: '#/components/parameters/npmName'
3091 description: successful operation
3096 additionalProperties: true
3098 description: plugin not found
3099 /plugins/{npmName}/registered-settings:
3103 summary: Get a plugin's registered settings
3108 - $ref: '#/components/parameters/npmName'
3111 description: successful operation
3116 additionalProperties: true
3118 description: plugin not found
3120 - url: 'https://peertube2.cpy.re/api/v1'
3121 description: Live Test Server (live data - latest nightly version)
3122 - url: 'https://peertube3.cpy.re/api/v1'
3123 description: Live Test Server (live data - latest RC version)
3124 - url: 'https://peertube.cpy.re/api/v1'
3125 description: Live Test Server (live data - stable version)
3132 description: Offset used to paginate results
3140 description: "Number of items to return"
3150 description: Sort column
3158 description: Plain text search, applied to various parts of the model depending on endpoint
3166 If the administrator enabled search index support, you can override the default search target.
3169 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3170 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3171 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3172 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3173 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3174 * If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch
3175 the data from the origin instance API
3185 description: Sort videos by criteria
3200 description: Sort videos by criteria
3215 description: Sort comments by criteria
3225 description: Sort blacklists by criteria
3241 description: Plain text search that will match with user usernames or emails
3248 description: Filter results down to (un)banned users
3255 description: Sort users by criteria
3266 description: Sort abuses by criteria
3273 videoRedundanciesSort:
3277 description: Sort abuses by criteria
3286 description: The name of the account
3289 example: chocobozzz | chocobozzz@example.org
3294 description: The user id
3303 description: The object id or uuid
3311 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3313 name: playlistElementId
3316 description: Playlist element id
3323 description: Video abuse id
3327 name: captionLanguage
3330 description: The caption language
3337 description: The video channel handle
3340 example: my_username | my_username@example.com
3342 name: subscriptionHandle
3345 description: The subscription handle
3348 example: my_username | my_username@example.com
3353 description: The thread id (root comment id)
3360 description: The comment id
3367 description: category id of the video (see [/videos/categories](#tag/Video/paths/~1videos~1categories/get))
3380 description: tag(s) of the video
3393 description: tag(s) of the video, where all should be present in the video
3406 description: language id of the video (see [/videos/languages](#tag/Video/paths/~1videos~1languages/get)). Use `_unknown` to filter on videos that don't have a video language
3419 description: licence id of the video (see [/videos/licences](#tag/Video/paths/~1videos~1licences/get))
3432 description: if you don't need the `total` in the response
3443 description: whether to include nsfw videos, if any
3454 Special filters (local for instance) which might require special rights:
3455 * `local` - only videos local to the instance
3456 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
3466 description: list of uris to check if each is part of the user subscriptions
3476 description: name of the plugin/theme on npmjs.com or in its package.json
3479 example: peertube-plugin-auth-ldap
3483 In the header: *Authorization: Bearer <token\>*
3486 Authenticating via OAuth requires the following steps:
3489 - Have an account with sufficient authorization levels
3491 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
3494 - Make Authenticated Requests
3498 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
3501 moderator: Moderator scope
3504 VideoConstantNumber:
3510 VideoConstantString:
3517 VideoPlaylistPrivacySet:
3523 description: 'The video playlist privacy (Public = `1`, Unlisted = `2`, Private = `3`)'
3524 VideoPlaylistPrivacyConstant:
3527 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
3531 VideoPlaylistTypeSet:
3536 description: 'The video playlist type (Regular = `1`, Watch Later = `2`)'
3537 VideoPlaylistTypeConstant:
3540 $ref: '#/components/schemas/VideoPlaylistTypeSet'
3551 description: 'The video privacy (Public = `1`, Unlisted = `2`, Private = `3`, Internal = `4`)'
3552 VideoPrivacyConstant:
3555 $ref: '#/components/schemas/VideoPrivacySet'
3572 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
3583 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
3593 description: 'The video playlist privacy (Pending = `1`, Rejected = `2`, Accepted = `3`)'
3594 VideoAbuseStateConstant:
3597 $ref: '#/components/schemas/VideoAbuseStateSet'
3600 VideoAbusePredefinedReasons:
3613 example: [spamOrMisleading]
3615 VideoResolutionConstant:
3619 description: 'Video resolution (240, 360, 720 ...)'
3624 VideoScheduledUpdate:
3627 $ref: '#/components/schemas/VideoPrivacySet'
3631 description: When to update the video
3651 - $ref: '#/components/schemas/Avatar'
3652 VideoChannelSummary:
3669 - $ref: '#/components/schemas/Avatar'
3681 - $ref: '#/components/schemas/Video'
3687 $ref: '#/components/schemas/VideoResolutionConstant'
3690 description: 'Video file size in bytes'
3708 VideoStreamingPlaylists:
3716 description: 'Playlist type (HLS = `1`)'
3726 $ref: '#/components/schemas/VideoFile'
3742 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3753 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3763 originallyPublishedAt:
3767 $ref: '#/components/schemas/VideoConstantNumber'
3769 $ref: '#/components/schemas/VideoConstantNumber'
3771 $ref: '#/components/schemas/VideoConstantString'
3773 $ref: '#/components/schemas/VideoPrivacyConstant'
3783 example: What is PeerTube?
3786 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
3789 example: /static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
3792 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
3808 $ref: '#/components/schemas/VideoStateConstant'
3812 - $ref: '#/components/schemas/VideoScheduledUpdate'
3820 $ref: '#/components/schemas/AccountSummary'
3822 $ref: '#/components/schemas/VideoChannelSummary'
3831 - $ref: '#/components/schemas/Video'
3838 description: A text tell the audience how to support the video creator
3839 example: Please support my work on <insert crowdfunding plateform>! <3
3841 $ref: '#/components/schemas/VideoChannel'
3843 $ref: '#/components/schemas/Account'
3848 example: [flowers, gardening]
3852 $ref: '#/components/schemas/VideoFile'
3865 $ref: '#/components/schemas/VideoStreamingPlaylists'
3866 FileRedundancyInformation:
3903 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3910 $ref: '#/components/schemas/FileRedundancyInformation'
3914 $ref: '#/components/schemas/FileRedundancyInformation'
3915 VideoImportStateConstant:
3923 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
3935 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
3939 example: magnet:?xs=https%3A%2F%2Fframatube.org%2Fstatic%2Ftorrents%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.torrent&xt=urn:btih:38b4747ff788b30bf61f59d1965cd38f9e48e01f&dn=What+is+PeerTube%3F&tr=wss%3A%2F%2Fframatube.org%2Ftracker%2Fsocket&tr=https%3A%2F%2Fframatube.org%2Ftracker%2Fannounce&ws=https%3A%2F%2Fframatube.org%2Fstatic%2Fwebseed%2F9c9de5e8-0a1e-484a-b099-e80766180a6d-240.mp4
3943 $ref: '#/components/schemas/VideoImportStateConstant'
3953 $ref: '#/components/schemas/Video'
3961 example: The video is a spam
3963 $ref: '#/components/schemas/VideoAbusePredefinedReasons'
3965 $ref: '#/components/schemas/Account'
3967 $ref: '#/components/schemas/VideoAbuseStateConstant'
3970 example: Decided to ban the server since it spams us regularly
3981 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4002 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4031 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4047 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4057 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4059 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4061 $ref: '#/components/schemas/AccountSummary'
4063 $ref: '#/components/schemas/VideoChannelSummary'
4085 totalRepliesFromVideoAuthor:
4090 $ref: '#/components/schemas/Account'
4091 VideoCommentThreadTree:
4094 $ref: '#/components/schemas/VideoComment'
4098 $ref: '#/components/schemas/VideoCommentThreadTree'
4102 $ref: '#/components/schemas/VideoConstantString'
4157 $ref: '#/components/schemas/Avatar'
4160 - $ref: '#/components/schemas/Actor'
4173 description: timestamp within the video, in seconds
4240 allowedForCurrentIP:
4242 requiresEmailVerification:
4446 requiresEmailVerification:
4471 allowAdditionalExtensions:
4539 $ref: '#/components/schemas/Actor'
4541 $ref: '#/components/schemas/Actor'
4544 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
4573 - activitypub-http-unicast
4574 - activitypub-http-broadcast
4575 - activitypub-http-fetcher
4576 - activitypub-follow
4582 - activitypub-refresher
4586 additionalProperties: true
4589 additionalProperties: true
4613 VideoUploadResponse:
4624 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4625 CommentThreadResponse:
4634 $ref: '#/components/schemas/VideoComment'
4635 CommentThreadPostResponse:
4638 $ref: '#/components/schemas/VideoComment'
4648 $ref: '#/components/schemas/Video'
4656 description: The user username
4662 description: The user email
4665 description: Theme enabled by this user
4668 description: Has the user confirmed their email address?
4670 $ref: '#/components/schemas/NSFWPolicy'
4673 description: Enable P2P in the player
4676 description: Automatically start playing the video on the watch page
4678 $ref: '#/components/schemas/UserRole'
4687 description: The user video quota
4690 description: The user daily video quota
4695 videoAbusesAcceptedCount:
4697 videoAbusesCreatedCount:
4701 noInstanceConfigWarningModal:
4712 $ref: '#/components/schemas/Account'
4716 $ref: '#/components/schemas/VideoChannel'
4721 description: The user username
4727 description: The user password. If the smtp server is configured, you can leave empty and an email will be sent
4733 description: The user email
4736 description: The user video quota
4739 description: The user daily video quota
4741 $ref: '#/components/schemas/UserRole'
4753 description: The user id
4757 description: The updated email of the user
4760 description: The updated video quota of the user
4763 description: The updated daily video quota of the user
4765 $ref: '#/components/schemas/UserRole'
4777 description: Your new password
4783 description: Your new email
4786 description: Your new displayNSFW
4793 description: Your new autoPlayVideo
4803 description: Id of the video
4806 description: Rating of the video
4813 $ref: '#/components/schemas/Video'
4816 description: 'Rating of the video'
4824 description: The username of the user
4827 pattern: '/^[a-z0-9._]{1,50}$/'
4831 description: The password of the user
4837 description: The email of the user
4840 description: The user display name
4848 description: The name for the default channel
4849 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4852 description: The display name for the default channel
4869 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
4870 example: Please support my work on <insert crowdfunding plateform>! <3
4882 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
4883 example: Please support my work on <insert crowdfunding plateform>! <3
4884 bulkVideosSupportUpdate:
4886 description: 'Update the support field for all videos of this channel'
4891 name: 'media:peerLink'
4900 - application/x-bittorrent
4906 name: 'media:content'
4937 VideoCommentsForXML:
4972 description: video watch page URL
4975 description: video canonical URL
4979 description: video publication date
4982 description: video description
4985 description: video description
4988 description: publisher user name
4991 description: video category (MRSS)
4994 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
5009 description: video embed path, relative to the canonical URL domain (MRSS)
5018 description: video watch path, relative to the canonical URL domain (MRSS)
5039 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
5040 'media:description':
5047 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
5050 description: main streamable file for the video
5060 - application/x-bittorrent
5069 description: list of streamable files for the video. see [media:peerLink](https://www.rssboard.org/media-rss#media-peerlink) and [media:content](https://www.rssboard.org/media-rss#media-content) or (MRSS)
5072 - $ref: '#/components/schemas/MRSSPeerLink'
5073 - $ref: '#/components/schemas/MRSSGroupContent'
5074 NotificationSettingValue:
5095 Notification type, following the `UserNotificationType` enum:
5097 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
5099 - `2` NEW_COMMENT_ON_MY_VIDEO
5101 - `3` NEW_VIDEO_ABUSE_FOR_MODERATORS
5103 - `4` BLACKLIST_ON_MY_VIDEO
5105 - `5` UNBLACKLIST_ON_MY_VIDEO
5107 - `6` MY_VIDEO_PUBLISHED
5109 - `7` MY_VIDEO_IMPORT_SUCCESS
5111 - `8` MY_VIDEO_IMPORT_ERROR
5113 - `9` NEW_USER_REGISTRATION
5117 - `11` COMMENT_MENTION
5119 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
5121 - `13` NEW_INSTANCE_FOLLOWER
5123 - `14` AUTO_INSTANCE_FOLLOWING
5129 - $ref: '#/components/schemas/VideoInfo'
5133 $ref: '#/components/schemas/ActorInfo'
5142 $ref: '#/components/schemas/VideoInfo'
5163 $ref: '#/components/schemas/VideoInfo'
5165 $ref: '#/components/schemas/ActorInfo'
5174 - $ref: '#/components/schemas/VideoInfo'
5183 - $ref: '#/components/schemas/VideoInfo'
5187 - $ref: '#/components/schemas/ActorInfo'
5195 $ref: '#/components/schemas/ActorInfo'
5223 NotificationListResponse:
5232 $ref: '#/components/schemas/Notification'
5237 example: peertube-plugin-auth-ldap
5265 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
5268 additionalProperties: true
5284 $ref: '#/components/schemas/Plugin'
5287 '{%CONFIG.SEARCH.SEARCH_INDEX.URL%}/api/v1/search/videos/':
5289 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
5292 description: successful operation
5296 $ref: '#/components/schemas/VideoListResponse'