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 Abuses deal with reports of local or remote videos/comments/accounts 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 curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
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'
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
1355 USERNAME="<your_username>"
1356 PASSWORD="<your_password>"
1357 FILE_PATH="<your_file_path>"
1358 CHANNEL_ID="<your_channel_id>"
1361 API_PATH="https://peertube2.cpy.re/api/v1"
1363 client_id=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1364 client_secret=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1365 token=$(curl -s "$API_PATH/users/token" \
1366 --data client_id="$client_id" \
1367 --data client_secret="$client_secret" \
1368 --data grant_type=password \
1369 --data response_type=code \
1370 --data username="$USERNAME" \
1371 --data password="$PASSWORD" \
1372 | jq -r ".access_token")
1374 curl -s "$API_PATH/videos/upload" \
1375 -H "Authorization: Bearer $token" \
1377 --form videofile=@"$FILE_PATH" \
1378 --form channelId=$CHANNEL_ID \
1382 summary: Import a video
1383 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1390 multipart/form-data:
1395 description: Torrent File
1399 description: HTTP target URL
1402 description: Magnet URI
1405 description: Channel id that will contain this video
1408 description: Video thumbnail file
1412 description: Video preview file
1416 $ref: '#/components/schemas/VideoPrivacySet'
1418 description: Video category
1421 description: Video licence
1424 description: Video language
1427 description: Video description
1430 description: Whether or not we wait transcoding before publish the video
1433 description: A text tell the audience how to support the video creator
1434 example: Please support my work on <insert crowdfunding plateform>! <3
1437 description: Whether or not this video contains sensitive content
1440 description: Video name
1443 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1452 description: Enable or disable comments for this video
1455 $ref: '#/components/schemas/VideoScheduledUpdate'
1461 contentType: application/x-bittorrent
1463 contentType: image/jpeg
1465 contentType: image/jpeg
1468 description: successful operation
1472 $ref: '#/components/schemas/VideoUploadResponse'
1474 description: HTTP or Torrent/magnetURI import not enabled
1476 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1480 summary: List my abuses
1489 description: only list the report with this id
1495 $ref: '#/components/schemas/AbuseStateSet'
1496 - $ref: '#/components/parameters/start'
1497 - $ref: '#/components/parameters/count'
1498 - $ref: '#/components/parameters/abusesSort'
1501 description: successful operation
1507 $ref: '#/components/schemas/Abuse'
1511 summary: List abuses
1521 description: only list the report with this id
1524 - name: predefinedReason
1526 description: predefined reason the listed reports should contain
1528 $ref: '#/components/schemas/PredefinedAbuseReasons'
1531 description: plain search that will match with video titles, reporter names and more
1537 $ref: '#/components/schemas/AbuseStateSet'
1538 - name: searchReporter
1540 description: only list reports of a specific reporter
1543 - name: searchReportee
1544 description: only list reports of a specific reportee
1550 description: only list reports of a specific video
1553 - name: searchVideoChannel
1555 description: only list reports of a specific video channel
1560 description: only list blacklisted or deleted videos
1568 description: only list account, comment or video reports
1575 - $ref: '#/components/parameters/start'
1576 - $ref: '#/components/parameters/count'
1577 - $ref: '#/components/parameters/abusesSort'
1580 description: successful operation
1586 $ref: '#/components/schemas/Abuse'
1589 summary: Report an abuse
1602 description: Reason why the user reports this video
1606 $ref: '#/components/schemas/PredefinedAbuseReasons'
1612 description: Video id to report
1616 description: Timestamp in the video that marks the beginning of the report
1620 description: Timestamp in the video that marks the ending of the report
1626 description: Comment id to report
1632 description: Account id to report
1638 description: successful operation
1640 description: incorrect request parameters
1641 '/abuses/{abuseId}':
1643 summary: Update an abuse
1651 - $ref: '#/components/parameters/abuseId'
1659 $ref: '#/components/schemas/AbuseStateSet'
1662 description: Update the report comment visible only to the moderation team
1665 description: successful operation
1667 description: abuse not found
1671 summary: Delete an abuse
1677 - $ref: '#/components/parameters/abuseId'
1680 description: successful operation
1682 description: block not found
1683 '/abuses/{abuseId}/messages':
1685 summary: List messages of an abuse
1691 - $ref: '#/components/parameters/abuseId'
1694 description: successful operation
1700 $ref: '#/components/schemas/AbuseMessage'
1703 summary: Add message to an abuse
1716 description: Message to send
1722 description: successful operation
1724 description: incorrect request parameters
1725 '/abuses/{abuseId}/messages/{abuseMessageId}':
1727 summary: Delete an abuse message
1733 - $ref: '#/components/parameters/abuseId'
1734 - $ref: '#/components/parameters/abuseMessageId'
1737 description: successful operation
1739 '/videos/{id}/blacklist':
1741 summary: Block a video
1749 - $ref: '#/components/parameters/idOrUUID'
1752 description: successful operation
1754 summary: Unblock a video by its id
1762 - $ref: '#/components/parameters/idOrUUID'
1765 description: successful operation
1767 description: block not found
1772 summary: List video blocks
1781 list only blocks that match this type:
1785 - `2`: automatic block that needs review
1793 description: plain search that will match with video titles, and more
1796 - $ref: '#/components/parameters/start'
1797 - $ref: '#/components/parameters/count'
1798 - $ref: '#/components/parameters/blacklistsSort'
1801 description: successful operation
1813 $ref: '#/components/schemas/VideoBlacklist'
1814 /videos/{id}/captions:
1816 summary: List captions of a video
1820 - $ref: '#/components/parameters/idOrUUID'
1823 description: successful operation
1835 $ref: '#/components/schemas/VideoCaption'
1836 /videos/{id}/captions/{captionLanguage}:
1838 summary: Add or replace a video caption
1842 - $ref: '#/components/parameters/idOrUUID'
1843 - $ref: '#/components/parameters/captionLanguage'
1846 multipart/form-data:
1851 description: The file to upload.
1856 contentType: text/vtt, application/x-subrip, text/plain
1859 description: successful operation
1861 description: video or language not found
1863 summary: Delete a video caption
1867 - $ref: '#/components/parameters/idOrUUID'
1868 - $ref: '#/components/parameters/captionLanguage'
1871 description: successful operation
1873 description: video or language or caption for that language not found
1876 summary: List video channels
1880 - $ref: '#/components/parameters/start'
1881 - $ref: '#/components/parameters/count'
1882 - $ref: '#/components/parameters/sort'
1885 description: successful operation
1897 $ref: '#/components/schemas/VideoChannel'
1899 summary: Create a video channel
1906 description: successful operation
1911 $ref: '#/components/schemas/VideoChannelCreate'
1912 '/video-channels/{channelHandle}':
1914 summary: Get a video channel
1918 - $ref: '#/components/parameters/channelHandle'
1921 description: successful operation
1925 $ref: '#/components/schemas/VideoChannel'
1927 summary: Update a video channel
1933 - $ref: '#/components/parameters/channelHandle'
1936 description: successful operation
1941 $ref: '#/components/schemas/VideoChannelUpdate'
1943 summary: Delete a video channel
1949 - $ref: '#/components/parameters/channelHandle'
1952 description: successful operation
1953 '/video-channels/{channelHandle}/videos':
1955 summary: List videos of a video channel
1960 - $ref: '#/components/parameters/channelHandle'
1961 - $ref: '#/components/parameters/categoryOneOf'
1962 - $ref: '#/components/parameters/tagsOneOf'
1963 - $ref: '#/components/parameters/tagsAllOf'
1964 - $ref: '#/components/parameters/licenceOneOf'
1965 - $ref: '#/components/parameters/languageOneOf'
1966 - $ref: '#/components/parameters/nsfw'
1967 - $ref: '#/components/parameters/filter'
1968 - $ref: '#/components/parameters/skipCount'
1969 - $ref: '#/components/parameters/start'
1970 - $ref: '#/components/parameters/count'
1971 - $ref: '#/components/parameters/videosSort'
1974 description: successful operation
1978 $ref: '#/components/schemas/VideoListResponse'
1980 /video-playlists/privacies:
1982 summary: List available playlist privacies
1987 description: successful operation
1996 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
2000 summary: List video playlists
2004 - $ref: '#/components/parameters/start'
2005 - $ref: '#/components/parameters/count'
2006 - $ref: '#/components/parameters/sort'
2009 description: successful operation
2021 $ref: '#/components/schemas/VideoPlaylist'
2023 summary: Create a video playlist
2024 description: 'If the video playlist is set as public, the videoChannelId is mandatory.'
2031 description: successful operation
2046 multipart/form-data:
2051 description: Video playlist display name
2054 description: Video playlist thumbnail file
2058 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2060 description: Video playlist description
2063 description: Video channel in which the playlist will be published
2069 contentType: image/jpeg
2071 /video-playlists/{id}:
2073 summary: Get a video playlist
2077 - $ref: '#/components/parameters/idOrUUID'
2080 description: successful operation
2084 $ref: '#/components/schemas/VideoPlaylist'
2086 summary: Update a video playlist
2087 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2094 description: successful operation
2096 - $ref: '#/components/parameters/idOrUUID'
2099 multipart/form-data:
2104 description: Video playlist display name
2107 description: Video playlist thumbnail file
2111 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2113 description: Video playlist description
2116 description: Video channel in which the playlist will be published
2120 contentType: image/jpeg
2122 summary: Delete a video playlist
2128 - $ref: '#/components/parameters/idOrUUID'
2131 description: successful operation
2133 /video-playlists/{id}/videos:
2135 summary: 'List videos of a playlist'
2140 - $ref: '#/components/parameters/idOrUUID'
2143 description: successful operation
2147 $ref: '#/components/schemas/VideoListResponse'
2149 summary: 'Add a video in a playlist'
2156 - $ref: '#/components/parameters/idOrUUID'
2159 description: successful operation
2165 videoPlaylistElement:
2178 description: 'Video to add in the playlist'
2181 description: 'Start the video at this specific timestamp (in seconds)'
2184 description: 'Stop the video at this specific timestamp (in seconds)'
2188 /video-playlists/{id}/videos/reorder:
2190 summary: 'Reorder a playlist'
2196 - $ref: '#/components/parameters/idOrUUID'
2199 description: successful operation
2208 description: 'Start position of the element to reorder'
2210 insertAfterPosition:
2212 description: 'New position for the block to reorder, to add the block before the first element'
2216 description: 'How many element from `startPosition` to reorder'
2220 - insertAfterPosition
2222 /video-playlists/{id}/videos/{playlistElementId}:
2224 summary: 'Update a playlist element'
2230 - $ref: '#/components/parameters/idOrUUID'
2231 - $ref: '#/components/parameters/playlistElementId'
2234 description: successful operation
2243 description: 'Start the video at this specific timestamp (in seconds)'
2246 description: 'Stop the video at this specific timestamp (in seconds)'
2248 summary: 'Delete an element from a playlist'
2254 - $ref: '#/components/parameters/idOrUUID'
2255 - $ref: '#/components/parameters/playlistElementId'
2258 description: successful operation
2260 '/users/me/video-playlists/videos-exist':
2262 summary: 'Check video exists in my playlists'
2271 description: The video ids to check
2278 description: successful operation
2298 '/accounts/{name}/video-channels':
2300 summary: List video channels of an account
2305 - $ref: '#/components/parameters/name'
2308 description: include view statistics for the last 30 days (only if authentified as the account user)
2311 - $ref: '#/components/parameters/start'
2312 - $ref: '#/components/parameters/count'
2313 - $ref: '#/components/parameters/sort'
2316 description: successful operation
2322 $ref: '#/components/schemas/VideoChannel'
2323 '/accounts/{name}/ratings':
2325 summary: List ratings of an account
2331 - $ref: '#/components/parameters/name'
2332 - $ref: '#/components/parameters/start'
2333 - $ref: '#/components/parameters/count'
2334 - $ref: '#/components/parameters/sort'
2338 description: Optionally filter which ratings to retrieve
2346 description: successful operation
2352 $ref: '#/components/schemas/VideoRating'
2353 '/videos/{id}/comment-threads':
2355 summary: List threads of a video
2359 - $ref: '#/components/parameters/idOrUUID'
2360 - $ref: '#/components/parameters/start'
2361 - $ref: '#/components/parameters/count'
2362 - $ref: '#/components/parameters/commentsSort'
2365 description: successful operation
2369 $ref: '#/components/schemas/CommentThreadResponse'
2371 summary: Create a thread
2377 - $ref: '#/components/parameters/idOrUUID'
2380 description: successful operation
2384 $ref: '#/components/schemas/CommentThreadPostResponse'
2386 description: video does not exist
2395 description: 'Text comment'
2399 '/videos/{id}/comment-threads/{threadId}':
2401 summary: Get a thread
2405 - $ref: '#/components/parameters/idOrUUID'
2406 - $ref: '#/components/parameters/threadId'
2409 description: successful operation
2413 $ref: '#/components/schemas/VideoCommentThreadTree'
2414 '/videos/{id}/comments/{commentId}':
2416 summary: Reply to a thread of a video
2422 - $ref: '#/components/parameters/idOrUUID'
2423 - $ref: '#/components/parameters/commentId'
2426 description: successful operation
2430 $ref: '#/components/schemas/CommentThreadPostResponse'
2432 description: thread or video does not exist
2441 description: 'Text comment'
2446 summary: Delete a comment or a reply
2452 - $ref: '#/components/parameters/idOrUUID'
2453 - $ref: '#/components/parameters/commentId'
2456 description: successful operation
2458 description: cannot remove comment of another user
2460 description: comment or video does not exist
2462 description: comment is already deleted
2463 '/videos/{id}/rate':
2465 summary: Like/dislike a video
2471 - $ref: '#/components/parameters/idOrUUID'
2474 description: successful operation
2476 description: video does not exist
2481 summary: Search videos
2486 allowEmptyValue: false
2488 String to search. If the user can make a remote URI search, and the string is an URI then the
2489 PeerTube instance will fetch the remote object and add it to its database. Then,
2490 you can use the REST API to fetch the complete video information and interact with it.
2493 - $ref: '#/components/parameters/categoryOneOf'
2494 - $ref: '#/components/parameters/tagsOneOf'
2495 - $ref: '#/components/parameters/tagsAllOf'
2496 - $ref: '#/components/parameters/licenceOneOf'
2497 - $ref: '#/components/parameters/languageOneOf'
2498 - $ref: '#/components/parameters/nsfw'
2499 - $ref: '#/components/parameters/filter'
2500 - $ref: '#/components/parameters/skipCount'
2501 - $ref: '#/components/parameters/start'
2502 - $ref: '#/components/parameters/count'
2503 - $ref: '#/components/parameters/searchTarget'
2504 - $ref: '#/components/parameters/videosSearchSort'
2507 description: Get videos that are published after this date
2513 description: Get videos that are published before this date
2517 - name: originallyPublishedStartDate
2519 description: Get videos that are originally published after this date
2523 - name: originallyPublishedEndDate
2525 description: Get videos that are originally published before this date
2531 description: Get videos that have this minimum duration
2536 description: Get videos that have this maximum duration
2540 'searchTarget === search-index':
2541 $ref: '#/components/callbacks/searchIndex'
2544 description: successful operation
2548 $ref: '#/components/schemas/VideoListResponse'
2550 description: search index unavailable
2551 /search/video-channels:
2555 summary: Search channels
2561 String to search. If the user can make a remote URI search, and the string is an URI then the
2562 PeerTube instance will fetch the remote object and add it to its database. Then,
2563 you can use the REST API to fetch the complete channel information and interact with it.
2566 - $ref: '#/components/parameters/start'
2567 - $ref: '#/components/parameters/count'
2568 - $ref: '#/components/parameters/searchTarget'
2569 - $ref: '#/components/parameters/sort'
2571 'searchTarget === search-index':
2572 $ref: '#/components/callbacks/searchIndex'
2575 description: successful operation
2581 $ref: '#/components/schemas/VideoChannel'
2583 description: search index unavailable
2584 /blocklist/accounts:
2588 summary: List account blocks
2593 - $ref: '#/components/parameters/start'
2594 - $ref: '#/components/parameters/count'
2595 - $ref: '#/components/parameters/sort'
2598 description: successful operation
2602 summary: Block an account
2614 example: chocobozzz@example.org
2615 description: account to block, in the form `username@domain`
2620 description: successful operation
2622 description: self-blocking forbidden
2623 '/blocklist/accounts/{accountName}':
2627 summary: Unblock an account by its handle
2635 description: account to unblock, in the form `username@domain`
2640 description: successful operation
2642 description: account or account block does not exist
2647 summary: List server blocks
2652 - $ref: '#/components/parameters/start'
2653 - $ref: '#/components/parameters/count'
2654 - $ref: '#/components/parameters/sort'
2657 description: successful operation
2661 summary: Block a server
2674 description: server domain to block
2679 description: successful operation
2681 description: self-blocking forbidden
2682 '/blocklist/servers/{host}':
2686 summary: Unblock a server by its domain
2694 description: server domain to unblock
2700 description: successful operation
2702 description: account block does not exist
2706 - Instance Redundancy
2707 summary: Update a server redundancy policy
2715 description: server domain to mirror
2727 description: allow mirroring of the host's local videos
2732 description: successful operation
2734 description: server is not already known
2739 summary: List videos being mirrored
2747 description: direction of the mirror
2753 - $ref: '#/components/parameters/start'
2754 - $ref: '#/components/parameters/count'
2755 - $ref: '#/components/parameters/videoRedundanciesSort'
2758 description: successful operation
2764 $ref: '#/components/schemas/VideoRedundancy'
2768 summary: Mirror a video
2784 description: successful operation
2786 description: cannot mirror a local video
2788 description: video does not exist
2790 description: video is already mirrored
2791 /redundancy/videos/{redundancyId}:
2795 summary: Delete a mirror done on a video
2800 - name: redundancyId
2803 description: id of an existing redundancy on a video
2808 description: successful operation
2810 description: video redundancy not found
2811 '/feeds/video-comments.{format}':
2815 summary: List comments on videos
2817 - url: 'https://peertube2.cpy.re'
2818 description: Live Test Server (live data - latest nightly version)
2819 - url: 'https://peertube3.cpy.re'
2820 description: Live Test Server (live data - latest RC version)
2821 - url: 'https://peertube.cpy.re'
2822 description: Live Test Server (live data - stable version)
2827 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
2840 description: 'limit listing to a specific video'
2845 description: 'limit listing to a specific account'
2850 description: 'limit listing to a specific account'
2853 - name: videoChannelId
2855 description: 'limit listing to a specific video channel'
2858 - name: videoChannelName
2860 description: 'limit listing to a specific video channel'
2865 description: successful operation
2870 default: 'max-age=900' # 15 min cache
2874 $ref: '#/components/schemas/VideoCommentsForXML'
2875 application/rss+xml:
2877 $ref: '#/components/schemas/VideoCommentsForXML'
2880 $ref: '#/components/schemas/VideoCommentsForXML'
2881 application/atom+xml:
2883 $ref: '#/components/schemas/VideoCommentsForXML'
2888 x-summary: field inconsistencies
2891 - videoId filter is mixed with a channel filter
2893 description: video, video channel or account not found
2895 description: accept header unsupported
2896 '/feeds/videos.{format}':
2900 summary: List videos
2902 - url: 'https://peertube2.cpy.re'
2903 description: Live Test Server (live data - latest nightly version)
2904 - url: 'https://peertube3.cpy.re'
2905 description: Live Test Server (live data - latest RC version)
2906 - url: 'https://peertube.cpy.re'
2907 description: Live Test Server (live data - stable version)
2912 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
2925 description: 'limit listing to a specific account'
2930 description: 'limit listing to a specific account'
2933 - name: videoChannelId
2935 description: 'limit listing to a specific video channel'
2938 - name: videoChannelName
2940 description: 'limit listing to a specific video channel'
2943 - $ref: '#/components/parameters/sort'
2944 - $ref: '#/components/parameters/nsfw'
2945 - $ref: '#/components/parameters/filter'
2948 description: successful operation
2953 default: 'max-age=900' # 15 min cache
2957 $ref: '#/components/schemas/VideosForXML'
2960 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
2961 application/rss+xml:
2963 $ref: '#/components/schemas/VideosForXML'
2966 $ref: '#/components/schemas/VideosForXML'
2967 application/atom+xml:
2969 $ref: '#/components/schemas/VideosForXML'
2974 description: video channel or account not found
2976 description: accept header unsupported
2981 summary: List plugins
2994 - $ref: '#/components/parameters/start'
2995 - $ref: '#/components/parameters/count'
2996 - $ref: '#/components/parameters/sort'
2999 description: successful operation
3003 $ref: '#/components/schemas/PluginResponse'
3008 summary: List available plugins
3021 - name: currentPeerTubeEngine
3025 - $ref: '#/components/parameters/start'
3026 - $ref: '#/components/parameters/count'
3027 - $ref: '#/components/parameters/sort'
3030 description: successful operation
3034 $ref: '#/components/schemas/PluginResponse'
3036 description: plugin index unavailable
3041 summary: Install a plugin
3054 example: peertube-plugin-auth-ldap
3057 additionalProperties: false
3064 additionalProperties: false
3067 description: successful operation
3069 description: should have either `npmName` or `path` set
3074 summary: Update a plugin
3087 example: peertube-plugin-auth-ldap
3090 additionalProperties: false
3097 additionalProperties: false
3100 description: successful operation
3102 description: should have either `npmName` or `path` set
3104 description: existing plugin not found
3109 summary: Uninstall a plugin
3121 description: name of the plugin/theme in its package.json
3122 example: peertube-plugin-auth-ldap
3127 description: successful operation
3129 description: existing plugin not found
3134 summary: Get a plugin
3139 - $ref: '#/components/parameters/npmName'
3142 description: successful operation
3146 $ref: '#/components/schemas/Plugin'
3148 description: plugin not found
3149 /plugins/{npmName}/settings:
3153 summary: Set a plugin's settings
3158 - $ref: '#/components/parameters/npmName'
3167 additionalProperties: true
3170 description: successful operation
3172 description: plugin not found
3173 /plugins/{npmName}/public-settings:
3177 summary: Get a plugin's public settings
3179 - $ref: '#/components/parameters/npmName'
3182 description: successful operation
3187 additionalProperties: true
3189 description: plugin not found
3190 /plugins/{npmName}/registered-settings:
3194 summary: Get a plugin's registered settings
3199 - $ref: '#/components/parameters/npmName'
3202 description: successful operation
3207 additionalProperties: true
3209 description: plugin not found
3211 - url: 'https://peertube2.cpy.re/api/v1'
3212 description: Live Test Server (live data - latest nightly version)
3213 - url: 'https://peertube3.cpy.re/api/v1'
3214 description: Live Test Server (live data - latest RC version)
3215 - url: 'https://peertube.cpy.re/api/v1'
3216 description: Live Test Server (live data - stable version)
3223 description: Offset used to paginate results
3231 description: "Number of items to return"
3241 description: Sort column
3249 description: Plain text search, applied to various parts of the model depending on endpoint
3257 If the administrator enabled search index support, you can override the default search target.
3260 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3261 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3262 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3263 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3264 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3265 * 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
3266 the data from the origin instance API
3276 description: Sort videos by criteria
3291 description: Sort videos by criteria
3306 description: Sort comments by criteria
3316 description: Sort blacklists by criteria
3332 description: Plain text search that will match with user usernames or emails
3339 description: Filter results down to (un)banned users
3346 description: Sort users by criteria
3357 description: Sort abuses by criteria
3364 videoRedundanciesSort:
3368 description: Sort abuses by criteria
3377 description: The name of the account
3380 example: chocobozzz | chocobozzz@example.org
3385 description: The user id
3394 description: The object id or uuid
3402 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3404 name: playlistElementId
3407 description: Playlist element id
3414 description: Abuse id
3418 name: abuseMessageId
3421 description: Abuse message id
3425 name: captionLanguage
3428 description: The caption language
3435 description: The video channel handle
3438 example: my_username | my_username@example.com
3440 name: subscriptionHandle
3443 description: The subscription handle
3446 example: my_username | my_username@example.com
3451 description: The thread id (root comment id)
3458 description: The comment id
3465 description: category id of the video (see [/videos/categories](#tag/Video/paths/~1videos~1categories/get))
3478 description: tag(s) of the video
3491 description: tag(s) of the video, where all should be present in the video
3504 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
3517 description: licence id of the video (see [/videos/licences](#tag/Video/paths/~1videos~1licences/get))
3530 description: if you don't need the `total` in the response
3541 description: whether to include nsfw videos, if any
3552 Special filters (local for instance) which might require special rights:
3553 * `local` - only videos local to the instance
3554 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
3564 description: list of uris to check if each is part of the user subscriptions
3574 description: name of the plugin/theme on npmjs.com or in its package.json
3577 example: peertube-plugin-auth-ldap
3581 In the header: *Authorization: Bearer <token\>*
3584 Authenticating via OAuth requires the following steps:
3587 - Have an account with sufficient authorization levels
3589 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
3592 - Make Authenticated Requests
3596 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
3599 moderator: Moderator scope
3602 VideoConstantNumber:
3608 VideoConstantString:
3615 VideoPlaylistPrivacySet:
3621 description: 'The video playlist privacy (Public = `1`, Unlisted = `2`, Private = `3`)'
3622 VideoPlaylistPrivacyConstant:
3625 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
3629 VideoPlaylistTypeSet:
3634 description: 'The video playlist type (Regular = `1`, Watch Later = `2`)'
3635 VideoPlaylistTypeConstant:
3638 $ref: '#/components/schemas/VideoPlaylistTypeSet'
3649 description: 'The video privacy (Public = `1`, Unlisted = `2`, Private = `3`, Internal = `4`)'
3650 VideoPrivacyConstant:
3653 $ref: '#/components/schemas/VideoPrivacySet'
3670 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
3681 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
3691 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
3695 $ref: '#/components/schemas/AbuseStateSet'
3698 AbusePredefinedReasons:
3711 example: [spamOrMisleading]
3713 VideoResolutionConstant:
3717 description: 'Video resolution (240, 360, 720 ...)'
3722 VideoScheduledUpdate:
3725 $ref: '#/components/schemas/VideoPrivacySet'
3729 description: When to update the video
3749 - $ref: '#/components/schemas/Avatar'
3750 VideoChannelSummary:
3767 - $ref: '#/components/schemas/Avatar'
3779 - $ref: '#/components/schemas/Video'
3785 $ref: '#/components/schemas/VideoResolutionConstant'
3788 description: 'Video file size in bytes'
3806 VideoStreamingPlaylists:
3814 description: 'Playlist type (HLS = `1`)'
3824 $ref: '#/components/schemas/VideoFile'
3840 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3851 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3861 originallyPublishedAt:
3865 $ref: '#/components/schemas/VideoConstantNumber'
3867 $ref: '#/components/schemas/VideoConstantNumber'
3869 $ref: '#/components/schemas/VideoConstantString'
3871 $ref: '#/components/schemas/VideoPrivacyConstant'
3881 example: What is PeerTube?
3884 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
3887 example: /static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
3890 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
3906 $ref: '#/components/schemas/VideoStateConstant'
3910 - $ref: '#/components/schemas/VideoScheduledUpdate'
3918 $ref: '#/components/schemas/AccountSummary'
3920 $ref: '#/components/schemas/VideoChannelSummary'
3929 - $ref: '#/components/schemas/Video'
3936 description: A text tell the audience how to support the video creator
3937 example: Please support my work on <insert crowdfunding plateform>! <3
3939 $ref: '#/components/schemas/VideoChannel'
3941 $ref: '#/components/schemas/Account'
3946 example: [flowers, gardening]
3950 $ref: '#/components/schemas/VideoFile'
3963 $ref: '#/components/schemas/VideoStreamingPlaylists'
3964 FileRedundancyInformation:
4001 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4008 $ref: '#/components/schemas/FileRedundancyInformation'
4012 $ref: '#/components/schemas/FileRedundancyInformation'
4013 VideoImportStateConstant:
4021 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
4033 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4037 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
4041 $ref: '#/components/schemas/VideoImportStateConstant'
4051 $ref: '#/components/schemas/Video'
4059 example: The video is a spam
4061 $ref: '#/components/schemas/AbusePredefinedReasons'
4063 $ref: '#/components/schemas/Account'
4065 $ref: '#/components/schemas/AbuseStateConstant'
4068 example: Decided to ban the server since it spams us regularly
4079 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4095 $ref: '#/components/schemas/AccountSummary'
4113 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4142 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4158 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4168 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4170 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4172 $ref: '#/components/schemas/AccountSummary'
4174 $ref: '#/components/schemas/VideoChannelSummary'
4196 totalRepliesFromVideoAuthor:
4201 $ref: '#/components/schemas/Account'
4202 VideoCommentThreadTree:
4205 $ref: '#/components/schemas/VideoComment'
4209 $ref: '#/components/schemas/VideoCommentThreadTree'
4213 $ref: '#/components/schemas/VideoConstantString'
4268 $ref: '#/components/schemas/Avatar'
4271 - $ref: '#/components/schemas/Actor'
4284 description: timestamp within the video, in seconds
4351 allowedForCurrentIP:
4353 requiresEmailVerification:
4557 requiresEmailVerification:
4582 allowAdditionalExtensions:
4650 $ref: '#/components/schemas/Actor'
4652 $ref: '#/components/schemas/Actor'
4655 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
4668 PredefinedAbuseReasons:
4669 description: Reason categories that help triage reports
4700 - activitypub-http-unicast
4701 - activitypub-http-broadcast
4702 - activitypub-http-fetcher
4703 - activitypub-follow
4709 - activitypub-refresher
4713 additionalProperties: true
4716 additionalProperties: true
4740 VideoUploadResponse:
4751 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4752 CommentThreadResponse:
4761 $ref: '#/components/schemas/VideoComment'
4762 CommentThreadPostResponse:
4765 $ref: '#/components/schemas/VideoComment'
4775 $ref: '#/components/schemas/Video'
4783 description: The user username
4789 description: The user email
4792 description: Theme enabled by this user
4795 description: Has the user confirmed their email address?
4797 $ref: '#/components/schemas/NSFWPolicy'
4800 description: Enable P2P in the player
4803 description: Automatically start playing the video on the watch page
4805 $ref: '#/components/schemas/UserRole'
4814 description: The user video quota
4817 description: The user daily video quota
4822 abusesAcceptedCount:
4828 noInstanceConfigWarningModal:
4839 $ref: '#/components/schemas/Account'
4843 $ref: '#/components/schemas/VideoChannel'
4848 description: The user username
4854 description: The user password. If the smtp server is configured, you can leave empty and an email will be sent
4860 description: The user email
4863 description: The user video quota
4866 description: The user daily video quota
4868 $ref: '#/components/schemas/UserRole'
4880 description: The user id
4884 description: The updated email of the user
4887 description: The updated video quota of the user
4890 description: The updated daily video quota of the user
4892 $ref: '#/components/schemas/UserRole'
4904 description: Your new password
4910 description: Your new email
4913 description: Your new displayNSFW
4920 description: Your new autoPlayVideo
4930 description: Id of the video
4933 description: Rating of the video
4940 $ref: '#/components/schemas/Video'
4943 description: 'Rating of the video'
4951 description: The username of the user
4954 pattern: '/^[a-z0-9._]{1,50}$/'
4958 description: The password of the user
4964 description: The email of the user
4967 description: The user display name
4975 description: The name for the default channel
4976 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4979 description: The display name for the default channel
4996 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
4997 example: Please support my work on <insert crowdfunding plateform>! <3
5009 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
5010 example: Please support my work on <insert crowdfunding plateform>! <3
5011 bulkVideosSupportUpdate:
5013 description: 'Update the support field for all videos of this channel'
5018 name: 'media:peerLink'
5027 - application/x-bittorrent
5033 name: 'media:content'
5064 VideoCommentsForXML:
5099 description: video watch page URL
5102 description: video canonical URL
5106 description: video publication date
5109 description: video description
5112 description: video description
5115 description: publisher user name
5118 description: video category (MRSS)
5121 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
5136 description: video embed path, relative to the canonical URL domain (MRSS)
5145 description: video watch path, relative to the canonical URL domain (MRSS)
5166 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
5167 'media:description':
5174 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
5177 description: main streamable file for the video
5187 - application/x-bittorrent
5196 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)
5199 - $ref: '#/components/schemas/MRSSPeerLink'
5200 - $ref: '#/components/schemas/MRSSGroupContent'
5201 NotificationSettingValue:
5222 Notification type, following the `UserNotificationType` enum:
5224 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
5226 - `2` NEW_COMMENT_ON_MY_VIDEO
5228 - `3` NEW_ABUSE_FOR_MODERATORS
5230 - `4` BLACKLIST_ON_MY_VIDEO
5232 - `5` UNBLACKLIST_ON_MY_VIDEO
5234 - `6` MY_VIDEO_PUBLISHED
5236 - `7` MY_VIDEO_IMPORT_SUCCESS
5238 - `8` MY_VIDEO_IMPORT_ERROR
5240 - `9` NEW_USER_REGISTRATION
5244 - `11` COMMENT_MENTION
5246 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
5248 - `13` NEW_INSTANCE_FOLLOWER
5250 - `14` AUTO_INSTANCE_FOLLOWING
5256 - $ref: '#/components/schemas/VideoInfo'
5260 $ref: '#/components/schemas/ActorInfo'
5269 $ref: '#/components/schemas/VideoInfo'
5290 $ref: '#/components/schemas/VideoInfo'
5292 $ref: '#/components/schemas/ActorInfo'
5301 - $ref: '#/components/schemas/VideoInfo'
5310 - $ref: '#/components/schemas/VideoInfo'
5314 - $ref: '#/components/schemas/ActorInfo'
5322 $ref: '#/components/schemas/ActorInfo'
5350 NotificationListResponse:
5359 $ref: '#/components/schemas/Notification'
5364 example: peertube-plugin-auth-ldap
5392 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
5395 additionalProperties: true
5411 $ref: '#/components/schemas/Plugin'
5414 '{%CONFIG.SEARCH.SEARCH_INDEX.URL%}/api/v1/search/videos/':
5416 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
5419 description: successful operation
5423 $ref: '#/components/schemas/VideoListResponse'