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
15 The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
16 HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
17 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
18 which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
20 - [Python](https://framagit.org/framasoft/peertube/clients/python)
21 - [Go](https://framagit.org/framasoft/peertube/clients/go)
22 - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
24 See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few
25 examples of using with the PeerTube API.
29 When you sign up for an account on a PeerTube instance, you are given the possibility
30 to generate sessions on it, and authenticate there using a session token. Only __one
31 session token can currently be used at a time__.
35 Accounts are given permissions based on their role. There are three roles on
36 PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions.
40 The API uses standard HTTP status codes to indicate the success or failure
41 of the API call. The body of the response will be JSON in the following
46 "error": "Account not found" // error debug message
50 Some errors benefit from a more detailed message:
54 "id": { // where 'id' is the name of the parameter concerned by the error.
55 "value": "a117eb-c6a9-4756-bb09-2a956239f", // value that triggered the error.
56 "msg": "Should have an valid id", // error debug message
58 "location": "params" // 'params', 'body', 'header', 'query' or 'cookies'
66 We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
68 | Endpoint | Calls | Time frame |
69 |-------------------------|------------------|---------------------------|
70 | `/*` | 50 | 10 seconds |
71 | `POST /users/token` | 15 | 5 minutes |
72 | `POST /users/register` | 2¹ | 5 minutes |
73 | `POST /users/ask-send-verify-email` | 3 | 5 minutes |
75 Depending on the endpoint, ¹failed requests are not taken into account. A service
76 limit is announced by a `429 Too Many Requests` status code.
78 You can get details about the current state of your rate limit by reading the
81 | Header | Description |
82 |-------------------------|------------------------------------------------------------|
83 | X-RateLimit-Limit | Number of max requests allowed in the current time period |
84 | X-RateLimit-Remaining | Number of remaining requests in the current time period |
85 | X-RateLimit-Reset | Timestamp of end of current time period as UNIX timestamp |
86 | Retry-After | Seconds to delay after the first `429` is received |
88 url: https://docs.joinpeertube.org/api-rest-reference.html
92 Accounts encompass remote accounts discovered across the federation,
93 and correspond to the main Actor, along with video channels a user can create, which
96 When a comment is posted, it is done with your Account's Actor.
99 Using some features of PeerTube require authentication, for which User
100 provide different levels of permission as well as associated user
101 information. Each user has a corresponding local Account for federation.
104 Operations related to your own User, when logged-in.
105 - name: My Subscriptions
107 Operations related to your subscriptions to video channels, their
108 new videos, and how to keep up to date with their latest publications!
111 Operations related to your watch history.
112 - name: My Notifications
114 Notifications following new videos, follows or reports. They allow you
115 to keep track of the interactions and overall important information that
116 concerns you. You MAY set per-notification type delivery preference, to
117 receive the info either by mail, by in-browser notification or both.
120 Each server exposes public information regarding supported videos and
124 Jobs are long-running tasks enqueued and processed by the instance
125 itself. No additional worker registration is currently available.
126 - name: Instance Follows
128 Managing servers which the instance interacts with is crucial to the
129 concept of federation in PeerTube and external video indexation. The PeerTube
130 server then deals with inter-server ActivityPub operations and propagates
131 information across its social graph by posting activities to actors' inbox
134 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows
135 - name: Instance Redundancy
137 Redundancy is part of the inter-server solidarity that PeerTube fosters.
138 Manage the list of instances you wish to help by seeding their videos according
139 to the policy of video selection of your choice. Note that you have a similar functionality
140 to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
142 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy
145 Managing plugins installed from a local path or from NPM, or search for new ones.
147 url: https://docs.joinpeertube.org/api-plugins
150 Abuses deal with reports of local or remote videos/comments/accounts alike.
153 Operations dealing with listing, uploading, fetching or modifying videos.
156 Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
160 - [_legacy_](#operation/uploadLegacy), where the video file is sent in a single request
161 - [_resumable_](#operation/uploadResumableInit), where the video file is sent in chunks
163 You can upload videos more reliably by using the resumable variant. Its protocol lets
164 you resume an upload operation after a network interruption or other transmission failure,
165 saving time and bandwidth in the event of network failures.
167 Favor using resumable uploads in any of the following cases:
168 - You are transferring large files
169 - The likelihood of a network interruption is high
170 - Uploads are originating from a device with a low-bandwidth or unstable Internet connection,
171 such as a mobile device
175 - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
176 - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file
177 - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file
179 The import function is practical when the desired video/audio is available online. It makes PeerTube
180 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
181 - name: Video Captions
182 description: Operations dealing with listing, adding and removing closed captions of a video.
183 - name: Video Channels
184 description: Operations dealing with the creation, modification and listing of videos within a channel.
185 - name: Video Comments
187 Operations dealing with comments to a video. Comments are organized in threads: adding a
188 comment in response to the video starts a thread, adding a reply to a comment adds it to
189 its root comment thread.
191 description: Operations dealing with blocking videos (removing them from view and preventing interactions).
193 description: Like/dislike a video.
194 - name: Video Playlists
195 description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
197 description: Server syndication feeds
200 The search helps to find _videos_ or _channels_ from within the instance and beyond.
201 Videos from other instances federated by the instance (that is, instances
202 followed by the instance) can be found via keywords and other criteria of
205 Administrators can also enable the use of a remote search system, indexing
206 videos and channels not could be not federated by the instance.
207 - name: Video Mirroring
209 PeerTube instances can mirror videos from one another, and help distribute some videos.
211 For importing videos as your own, refer to [video imports](#operation/importVideo).
230 - Video Ownership Change
243 - name: Instance Configuration
247 - Instance Redundancy
257 summary: Get an account
259 - $ref: '#/components/parameters/name'
262 description: successful operation
266 $ref: '#/components/schemas/Account'
268 description: account not found
269 '/accounts/{name}/videos':
274 summary: 'List videos of an account'
276 - $ref: '#/components/parameters/name'
277 - $ref: '#/components/parameters/categoryOneOf'
278 - $ref: '#/components/parameters/isLive'
279 - $ref: '#/components/parameters/tagsOneOf'
280 - $ref: '#/components/parameters/tagsAllOf'
281 - $ref: '#/components/parameters/licenceOneOf'
282 - $ref: '#/components/parameters/languageOneOf'
283 - $ref: '#/components/parameters/nsfw'
284 - $ref: '#/components/parameters/filter'
285 - $ref: '#/components/parameters/skipCount'
286 - $ref: '#/components/parameters/start'
287 - $ref: '#/components/parameters/count'
288 - $ref: '#/components/parameters/videosSort'
291 description: successful operation
295 $ref: '#/components/schemas/VideoListResponse'
299 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
300 .then(function(response) {
301 return response.json()
302 }).then(function(data) {
308 curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
314 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
316 http = Net::HTTP.new(uri.host, uri.port)
319 response = http.get(uri.request_uri)
321 puts JSON.parse(response.read_body)
326 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
334 summary: List accounts
336 - $ref: '#/components/parameters/start'
337 - $ref: '#/components/parameters/count'
338 - $ref: '#/components/parameters/sort'
341 description: successful operation
347 $ref: '#/components/schemas/Account'
352 summary: Get instance public configuration
355 description: successful operation
359 $ref: '#/components/schemas/ServerConfig'
362 externalValue: https://peertube2.cpy.re/api/v1/config
365 summary: Get instance "About" information
370 description: successful operation
374 $ref: '#/components/schemas/ServerConfigAbout'
377 externalValue: https://peertube2.cpy.re/api/v1/config/about
380 summary: Get instance runtime configuration
388 description: successful operation
392 $ref: '#/components/schemas/ServerConfigCustom'
394 summary: Set instance runtime configuration
402 description: successful operation
404 x-summary: field inconsistencies
407 - the emailer is disabled and the instance is open to registrations
408 - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
410 summary: Delete instance runtime configuration
418 description: successful operation
421 summary: List instance jobs
431 description: The state of the job ('' for for no filter)
441 - $ref: '#/components/parameters/jobType'
442 - $ref: '#/components/parameters/start'
443 - $ref: '#/components/parameters/count'
444 - $ref: '#/components/parameters/sort'
447 description: successful operation
460 $ref: '#/components/schemas/Job'
461 '/server/following/{host}':
468 summary: Unfollow a server
473 description: 'The host to unfollow '
479 description: successful operation
484 summary: List instance followers
486 - $ref: '#/components/parameters/start'
487 - $ref: '#/components/parameters/count'
488 - $ref: '#/components/parameters/sort'
491 description: successful operation
497 $ref: '#/components/schemas/Follow'
502 summary: List instances followed by the server
521 - $ref: '#/components/parameters/start'
522 - $ref: '#/components/parameters/count'
523 - $ref: '#/components/parameters/sort'
526 description: successful operation
532 $ref: '#/components/schemas/Follow'
539 summary: Follow a server
542 description: successful operation
544 description: cannot follow a non-HTTPS server
559 summary: Create a user
567 description: user created
571 $ref: '#/components/schemas/AddUserResponse'
575 operationId: getUserId
577 id: '$response.body#/user/id'
580 operationId: putUserId
582 id: '$response.body#/user/id'
585 operationId: delUserId
587 id: '$response.body#/user/id'
589 description: insufficient authority to create an admin or moderator
594 $ref: '#/components/schemas/AddUser'
596 If the smtp server is configured, you can leave the password empty and an email will be sent
597 asking the user to set it first.
607 - $ref: '#/components/parameters/usersSearch'
608 - $ref: '#/components/parameters/usersBlocked'
609 - $ref: '#/components/parameters/start'
610 - $ref: '#/components/parameters/count'
611 - $ref: '#/components/parameters/usersSort'
614 description: successful operation
620 $ref: '#/components/schemas/User'
623 - $ref: '#/components/parameters/id'
625 summary: Delete a user
631 operationId: delUserId
634 description: successful operation
641 operationId: getUserId
645 description: include statistics about the user (only available as a moderator/admin)
650 x-summary: successful operation
652 As an admin/moderator, you can request a response augmented with statistics about the user's
653 moderation relations and videos usage, by using the `withStats` parameter.
658 - $ref: '#/components/schemas/User'
659 - $ref: '#/components/schemas/UserWithStats'
661 summary: Update a user
666 operationId: putUserId
669 description: successful operation
674 $ref: '#/components/schemas/UpdateUser'
678 summary: Register a user
683 description: successful operation
688 $ref: '#/components/schemas/RegisterUser'
692 summary: Get my user information
700 description: successful operation
706 $ref: '#/components/schemas/User'
708 summary: Update my user information
716 description: successful operation
721 $ref: '#/components/schemas/UpdateMe'
723 /users/me/videos/imports:
725 summary: Get video imports of my user
733 - $ref: '#/components/parameters/start'
734 - $ref: '#/components/parameters/count'
735 - $ref: '#/components/parameters/sort'
738 description: successful operation
742 $ref: '#/components/schemas/VideoImportsList'
743 /users/me/video-quota-used:
745 summary: Get my user used quota
753 description: successful operation
761 description: The user video quota used so far in bytes
765 description: The user video quota used today in bytes
767 '/users/me/videos/{videoId}/rating':
769 summary: Get rate of my user for a video
779 description: The video id
781 $ref: '#/components/schemas/Video/properties/id'
784 description: successful operation
788 $ref: '#/components/schemas/GetMeVideoRating'
791 summary: Get videos of my user
799 - $ref: '#/components/parameters/start'
800 - $ref: '#/components/parameters/count'
801 - $ref: '#/components/parameters/sort'
804 description: successful operation
808 $ref: '#/components/schemas/VideoListResponse'
809 /users/me/subscriptions:
811 summary: Get my user subscriptions
818 - $ref: '#/components/parameters/start'
819 - $ref: '#/components/parameters/count'
820 - $ref: '#/components/parameters/sort'
823 description: successful operation
827 $ref: '#/components/schemas/VideoChannelList'
831 summary: Add subscription to my user
844 description: uri of the video channels to subscribe to
850 uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
853 description: successful operation
854 /users/me/subscriptions/exist:
856 summary: Get if subscriptions exist for my user
863 - $ref: '#/components/parameters/subscriptionsUris'
866 description: successful operation
871 /users/me/subscriptions/videos:
873 summary: List videos of subscriptions of my user
881 - $ref: '#/components/parameters/categoryOneOf'
882 - $ref: '#/components/parameters/isLive'
883 - $ref: '#/components/parameters/tagsOneOf'
884 - $ref: '#/components/parameters/tagsAllOf'
885 - $ref: '#/components/parameters/licenceOneOf'
886 - $ref: '#/components/parameters/languageOneOf'
887 - $ref: '#/components/parameters/nsfw'
888 - $ref: '#/components/parameters/filter'
889 - $ref: '#/components/parameters/skipCount'
890 - $ref: '#/components/parameters/start'
891 - $ref: '#/components/parameters/count'
892 - $ref: '#/components/parameters/videosSort'
895 description: successful operation
899 $ref: '#/components/schemas/VideoListResponse'
900 '/users/me/subscriptions/{subscriptionHandle}':
902 summary: Get subscription of my user
909 - $ref: '#/components/parameters/subscriptionHandle'
912 description: successful operation
916 $ref: '#/components/schemas/VideoChannel'
918 summary: Delete subscription of my user
925 - $ref: '#/components/parameters/subscriptionHandle'
928 description: successful operation
929 /users/me/notifications:
931 summary: List my notifications
939 description: only list unread notifications
942 - $ref: '#/components/parameters/start'
943 - $ref: '#/components/parameters/count'
944 - $ref: '#/components/parameters/sort'
947 description: successful operation
951 $ref: '#/components/schemas/NotificationListResponse'
952 /users/me/notifications/read:
954 summary: Mark notifications as read by their id
967 description: ids of the notifications to mark as read
974 description: successful operation
975 /users/me/notifications/read-all:
977 summary: Mark all my notification as read
984 description: successful operation
985 /users/me/notification-settings:
987 summary: Update my notification settings
998 newVideoFromSubscription:
999 $ref: '#/components/schemas/NotificationSettingValue'
1000 newCommentOnMyVideo:
1001 $ref: '#/components/schemas/NotificationSettingValue'
1003 $ref: '#/components/schemas/NotificationSettingValue'
1004 videoAutoBlacklistAsModerator:
1005 $ref: '#/components/schemas/NotificationSettingValue'
1007 $ref: '#/components/schemas/NotificationSettingValue'
1009 $ref: '#/components/schemas/NotificationSettingValue'
1010 myVideoImportFinished:
1011 $ref: '#/components/schemas/NotificationSettingValue'
1013 $ref: '#/components/schemas/NotificationSettingValue'
1014 newUserRegistration:
1015 $ref: '#/components/schemas/NotificationSettingValue'
1017 $ref: '#/components/schemas/NotificationSettingValue'
1018 newInstanceFollower:
1019 $ref: '#/components/schemas/NotificationSettingValue'
1020 autoInstanceFollowing:
1021 $ref: '#/components/schemas/NotificationSettingValue'
1024 description: successful operation
1025 /users/me/history/videos:
1027 summary: List watched videos history
1033 - $ref: '#/components/parameters/start'
1034 - $ref: '#/components/parameters/count'
1035 - $ref: '#/components/parameters/search'
1038 description: successful operation
1042 $ref: '#/components/schemas/VideoListResponse'
1043 /users/me/history/videos/remove:
1045 summary: Clear video history
1052 multipart/form-data:
1057 description: history before this date will be deleted
1062 description: successful operation
1063 /users/me/avatar/pick:
1065 summary: Update my user avatar
1072 description: successful operation
1079 $ref: '#/components/schemas/ActorImage'
1081 description: image file too large
1083 X-File-Maximum-Size:
1087 description: Maximum file size for the avatar
1090 multipart/form-data:
1095 description: The file to upload
1100 contentType: image/png, image/jpeg
1103 summary: Delete my avatar
1110 description: successful operation
1114 summary: List video ownership changes
1116 - Video Ownership Change
1121 description: successful operation
1122 '/videos/ownership/{id}/accept':
1124 summary: Accept ownership change request
1126 - Video Ownership Change
1130 - $ref: '#/components/parameters/idOrUUID'
1133 description: successful operation
1135 description: cannot terminate an ownership change of another user
1137 description: video owneship change not found
1138 '/videos/ownership/{id}/refuse':
1140 summary: Refuse ownership change request
1142 - Video Ownership Change
1146 - $ref: '#/components/parameters/idOrUUID'
1149 description: successful operation
1151 description: cannot terminate an ownership change of another user
1153 description: video owneship change not found
1154 '/videos/{id}/give-ownership':
1156 summary: Request ownership change
1158 - Video Ownership Change
1162 - $ref: '#/components/parameters/idOrUUID'
1166 application/x-www-form-urlencoded:
1176 description: successful operation
1178 description: changing video ownership to a remote account is not supported yet
1180 description: video not found
1183 summary: List videos
1187 - $ref: '#/components/parameters/categoryOneOf'
1188 - $ref: '#/components/parameters/isLive'
1189 - $ref: '#/components/parameters/tagsOneOf'
1190 - $ref: '#/components/parameters/tagsAllOf'
1191 - $ref: '#/components/parameters/licenceOneOf'
1192 - $ref: '#/components/parameters/languageOneOf'
1193 - $ref: '#/components/parameters/nsfw'
1194 - $ref: '#/components/parameters/filter'
1195 - $ref: '#/components/parameters/skipCount'
1196 - $ref: '#/components/parameters/start'
1197 - $ref: '#/components/parameters/count'
1198 - $ref: '#/components/parameters/videosSort'
1201 description: successful operation
1205 $ref: '#/components/schemas/VideoListResponse'
1208 summary: List available video categories
1209 operationId: getCategories
1214 description: successful operation
1223 externalValue: https://peertube2.cpy.re/api/v1/videos/categories
1226 summary: List available video licences
1227 operationId: getLicences
1232 description: successful operation
1241 externalValue: https://peertube2.cpy.re/api/v1/videos/licences
1244 summary: List available video languages
1245 operationId: getLanguages
1250 description: successful operation
1259 externalValue: https://peertube2.cpy.re/api/v1/videos/languages
1262 summary: List available video privacy policies
1263 operationId: getPrivacyPolicies
1268 description: successful operation
1277 externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
1280 summary: Update a video
1286 - $ref: '#/components/parameters/idOrUUID'
1289 description: successful operation
1292 multipart/form-data:
1297 description: Video thumbnail file
1301 description: Video preview file
1305 $ref: '#/components/schemas/VideoCategorySet'
1307 $ref: '#/components/schemas/VideoLicenceSet'
1309 $ref: '#/components/schemas/VideoLanguageSet'
1311 $ref: '#/components/schemas/VideoPrivacySet'
1313 description: Video description
1316 description: Whether or not we wait transcoding before publish the video
1319 description: A text tell the audience how to support the video creator
1320 example: Please support my work on <insert crowdfunding plateform>! <3
1323 description: Whether or not this video contains sensitive content
1326 description: Video name
1331 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1340 description: Enable or disable comments for this video
1342 originallyPublishedAt:
1343 description: Date when the content was originally published
1347 $ref: '#/components/schemas/VideoScheduledUpdate'
1350 contentType: image/jpeg
1352 contentType: image/jpeg
1354 summary: Get a video
1358 - $ref: '#/components/parameters/idOrUUID'
1361 description: successful operation
1365 $ref: '#/components/schemas/VideoDetails'
1367 summary: Delete a video
1373 - $ref: '#/components/parameters/idOrUUID'
1376 description: successful operation
1377 '/videos/{id}/description':
1379 summary: Get complete video description
1383 - $ref: '#/components/parameters/idOrUUID'
1386 description: successful operation
1395 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
1396 '/videos/{id}/views':
1398 summary: Add a view to a video
1402 - $ref: '#/components/parameters/idOrUUID'
1405 description: successful operation
1406 '/videos/{id}/watching':
1408 summary: Set watching progress of a video
1414 - $ref: '#/components/parameters/idOrUUID'
1419 $ref: '#/components/schemas/UserWatchingVideo'
1423 description: successful operation
1426 summary: Upload a video
1427 description: Uses a single request to upload a video.
1428 operationId: uploadLegacy
1436 description: successful operation
1440 $ref: '#/components/schemas/VideoUploadResponse'
1442 description: invalid file field, schedule date or parameter
1444 description: video didn't pass upload filter
1446 description: upload has timed out
1448 description: video file too large, due to quota or max body size limit set by the reverse-proxy
1450 X-File-Maximum-Size:
1454 description: Maximum file size for the video
1456 description: video type unsupported
1458 description: video unreadable
1461 multipart/form-data:
1463 $ref: '#/components/schemas/VideoUploadRequestLegacy'
1466 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1468 contentType: image/jpeg
1470 contentType: image/jpeg
1475 USERNAME="<your_username>"
1476 PASSWORD="<your_password>"
1477 FILE_PATH="<your_file_path>"
1478 CHANNEL_ID="<your_channel_id>"
1481 API_PATH="https://peertube2.cpy.re/api/v1"
1483 client_id=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1484 client_secret=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1485 token=$(curl -s "$API_PATH/users/token" \
1486 --data client_id="$client_id" \
1487 --data client_secret="$client_secret" \
1488 --data grant_type=password \
1489 --data response_type=code \
1490 --data username="$USERNAME" \
1491 --data password="$PASSWORD" \
1492 | jq -r ".access_token")
1494 curl -s "$API_PATH/videos/upload" \
1495 -H "Authorization: Bearer $token" \
1497 --form videofile=@"$FILE_PATH" \
1498 --form channelId=$CHANNEL_ID \
1500 /videos/upload-resumable:
1502 summary: Initialize the resumable upload of a video
1503 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video
1504 operationId: uploadResumableInit
1511 - name: X-Upload-Content-Length
1517 description: Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
1518 - name: X-Upload-Content-Type
1525 description: MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
1530 $ref: '#/components/schemas/VideoUploadRequestResumable'
1533 description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
1535 description: created
1541 example: /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51
1547 description: invalid file field, schedule date or parameter
1549 description: video file too large, due to quota, absolute max file size or concurrent partial upload limit
1551 description: video type unsupported
1553 summary: Send chunk for the resumable upload of a video
1554 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the upload of a video
1555 operationId: uploadResumable
1566 Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
1567 not valid anymore and you need to initialize a new upload.
1570 - name: Content-Range
1574 example: bytes 0-262143/2469036
1577 Specifies the bytes in the file that the request is uploading.
1579 For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first
1580 262144 bytes (256 x 1024) in a 2,469,036 byte file.
1581 - name: Content-Length
1588 Size of the chunk that the request is sending.
1590 The chunk size __must be a multiple of 256 KB__, and unlike [Google Resumable](https://developers.google.com/youtube/v3/guides/using_resumable_upload_protocol)
1591 doesn't mandate for chunks to have the same size throughout the upload sequence.
1593 Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
1594 1048576 bytes (~1MB) and increases or reduces size depending on connection health.
1597 application/octet-stream:
1603 description: last chunk received
1611 $ref: '#/components/schemas/VideoUploadResponse'
1613 description: resume incomplete
1618 example: bytes=0-262143
1624 description: video didn't pass upload filter
1626 description: video file too large, due to quota or max body size limit set by the reverse-proxy
1628 description: video unreadable
1630 summary: Cancel the resumable upload of a video, deleting any data uploaded so far
1631 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
1632 operationId: uploadResumableCancel
1643 Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
1644 not valid anymore and the upload session has already been deleted with its data ;-)
1647 - name: Content-Length
1655 description: upload cancelled
1663 summary: Import a video
1664 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1665 operationId: importVideo
1673 multipart/form-data:
1678 description: Torrent File
1682 $ref: '#/components/schemas/VideoImport/properties/targetUrl'
1684 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
1686 description: Channel id that will contain this video
1688 - $ref: '#/components/schemas/VideoChannel/properties/id'
1690 description: Video thumbnail file
1694 description: Video preview file
1698 $ref: '#/components/schemas/VideoPrivacySet'
1700 $ref: '#/components/schemas/VideoCategorySet'
1702 $ref: '#/components/schemas/VideoLicenceSet'
1704 $ref: '#/components/schemas/VideoLanguageSet'
1706 description: Video description
1709 description: Whether or not we wait transcoding before publish the video
1712 description: A text tell the audience how to support the video creator
1713 example: Please support my work on <insert crowdfunding plateform>! <3
1716 description: Whether or not this video contains sensitive content
1719 description: Video name
1724 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1733 description: Enable or disable comments for this video
1736 description: Enable or disable downloading for this video
1739 $ref: '#/components/schemas/VideoScheduledUpdate'
1745 contentType: application/x-bittorrent
1747 contentType: image/jpeg
1749 contentType: image/jpeg
1752 description: successful operation
1756 $ref: '#/components/schemas/VideoUploadResponse'
1758 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1760 description: video didn't pass pre-import filter
1762 description: HTTP or Torrent/magnetURI import not enabled
1766 summary: Create a live
1767 operationId: createLive
1775 description: successful operation
1779 $ref: '#/components/schemas/VideoUploadResponse'
1781 description: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
1784 multipart/form-data:
1789 description: Channel id that will contain this live video
1794 description: User can stream multiple times in a permanent live
1797 description: Live video/replay thumbnail file
1801 description: Live video/replay preview file
1805 $ref: '#/components/schemas/VideoPrivacySet'
1807 $ref: '#/components/schemas/VideoCategorySet'
1809 $ref: '#/components/schemas/VideoLicenceSet'
1811 $ref: '#/components/schemas/VideoLanguageSet'
1813 description: Live video/replay description
1816 description: A text tell the audience how to support the creator
1817 example: Please support my work on <insert crowdfunding plateform>! <3
1820 description: Whether or not this live video/replay contains sensitive content
1823 description: Live video/replay name
1828 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
1837 description: Enable or disable comments for this live video/replay
1840 description: Enable or disable downloading for the replay of this live
1847 contentType: image/jpeg
1849 contentType: image/jpeg
1853 summary: Get information about a live
1854 operationId: getLiveId
1861 - $ref: '#/components/parameters/idOrUUID'
1864 description: successful operation
1868 $ref: '#/components/schemas/LiveVideoResponse'
1870 summary: Update information about a live
1871 operationId: updateLiveId
1878 - $ref: '#/components/parameters/idOrUUID'
1883 $ref: '#/components/schemas/LiveVideoUpdate'
1886 description: successful operation
1888 description: bad parameters or trying to update a live that has already started
1890 description: trying to save replay of the live but saving replay is not enabled on the instance
1894 summary: List my abuses
1895 operationId: getMyAbuses
1904 description: only list the report with this id
1910 $ref: '#/components/schemas/AbuseStateSet'
1911 - $ref: '#/components/parameters/abusesSort'
1912 - $ref: '#/components/parameters/start'
1913 - $ref: '#/components/parameters/count'
1916 description: successful operation
1928 $ref: '#/components/schemas/Abuse'
1932 summary: List abuses
1933 operationId: getAbuses
1943 description: only list the report with this id
1946 - name: predefinedReason
1948 description: predefined reason the listed reports should contain
1950 $ref: '#/components/schemas/PredefinedAbuseReasons'
1953 description: plain search that will match with video titles, reporter names and more
1959 $ref: '#/components/schemas/AbuseStateSet'
1960 - name: searchReporter
1962 description: only list reports of a specific reporter
1965 - name: searchReportee
1966 description: only list reports of a specific reportee
1972 description: only list reports of a specific video
1975 - name: searchVideoChannel
1977 description: only list reports of a specific video channel
1982 description: only list blacklisted or deleted videos
1990 description: only list account, comment or video reports
1997 - $ref: '#/components/parameters/start'
1998 - $ref: '#/components/parameters/count'
1999 - $ref: '#/components/parameters/abusesSort'
2002 description: successful operation
2014 $ref: '#/components/schemas/Abuse'
2017 summary: Report an abuse
2030 description: Reason why the user reports this video
2035 $ref: '#/components/schemas/PredefinedAbuseReasons'
2040 description: Video id to report
2042 - $ref: '#/components/schemas/Video/properties/id'
2045 description: Timestamp in the video that marks the beginning of the report
2049 description: Timestamp in the video that marks the ending of the report
2055 description: Comment id to report
2057 - $ref: '#/components/schemas/VideoComment/properties/id'
2062 description: Account id to report
2068 description: successful operation
2070 description: incorrect request parameters
2071 '/abuses/{abuseId}':
2073 summary: Update an abuse
2081 - $ref: '#/components/parameters/abuseId'
2089 $ref: '#/components/schemas/AbuseStateSet'
2092 description: Update the report comment visible only to the moderation team
2097 description: successful operation
2099 description: abuse not found
2103 summary: Delete an abuse
2109 - $ref: '#/components/parameters/abuseId'
2112 description: successful operation
2114 description: block not found
2115 '/abuses/{abuseId}/messages':
2117 summary: List messages of an abuse
2123 - $ref: '#/components/parameters/abuseId'
2126 description: successful operation
2132 $ref: '#/components/schemas/AbuseMessage'
2135 summary: Add message to an abuse
2141 - $ref: '#/components/parameters/abuseId'
2150 description: Message to send
2158 description: successful operation
2160 description: incorrect request parameters
2161 '/abuses/{abuseId}/messages/{abuseMessageId}':
2163 summary: Delete an abuse message
2169 - $ref: '#/components/parameters/abuseId'
2170 - $ref: '#/components/parameters/abuseMessageId'
2173 description: successful operation
2175 '/videos/{id}/blacklist':
2177 summary: Block a video
2185 - $ref: '#/components/parameters/idOrUUID'
2188 description: successful operation
2190 summary: Unblock a video by its id
2198 - $ref: '#/components/parameters/idOrUUID'
2201 description: successful operation
2203 description: block not found
2208 summary: List video blocks
2217 list only blocks that match this type:
2221 - `2`: automatic block that needs review
2229 description: plain search that will match with video titles, and more
2232 - $ref: '#/components/parameters/start'
2233 - $ref: '#/components/parameters/count'
2234 - $ref: '#/components/parameters/blacklistsSort'
2237 description: successful operation
2249 $ref: '#/components/schemas/VideoBlacklist'
2250 /videos/{id}/captions:
2252 summary: List captions of a video
2256 - $ref: '#/components/parameters/idOrUUID'
2259 description: successful operation
2271 $ref: '#/components/schemas/VideoCaption'
2272 /videos/{id}/captions/{captionLanguage}:
2274 summary: Add or replace a video caption
2281 - $ref: '#/components/parameters/idOrUUID'
2282 - $ref: '#/components/parameters/captionLanguage'
2285 multipart/form-data:
2290 description: The file to upload.
2295 contentType: text/vtt, application/x-subrip, text/plain
2298 description: successful operation
2300 description: video or language not found
2302 summary: Delete a video caption
2309 - $ref: '#/components/parameters/idOrUUID'
2310 - $ref: '#/components/parameters/captionLanguage'
2313 description: successful operation
2315 description: video or language or caption for that language not found
2318 summary: List video channels
2322 - $ref: '#/components/parameters/start'
2323 - $ref: '#/components/parameters/count'
2324 - $ref: '#/components/parameters/sort'
2327 description: successful operation
2331 $ref: '#/components/schemas/VideoChannelList'
2333 summary: Create a video channel
2340 description: successful operation
2345 $ref: '#/components/schemas/VideoChannelCreate'
2346 '/video-channels/{channelHandle}':
2348 summary: Get a video channel
2352 - $ref: '#/components/parameters/channelHandle'
2355 description: successful operation
2359 $ref: '#/components/schemas/VideoChannel'
2361 summary: Update a video channel
2367 - $ref: '#/components/parameters/channelHandle'
2370 description: successful operation
2375 $ref: '#/components/schemas/VideoChannelUpdate'
2377 summary: Delete a video channel
2383 - $ref: '#/components/parameters/channelHandle'
2386 description: successful operation
2387 '/video-channels/{channelHandle}/videos':
2389 summary: List videos of a video channel
2394 - $ref: '#/components/parameters/channelHandle'
2395 - $ref: '#/components/parameters/categoryOneOf'
2396 - $ref: '#/components/parameters/isLive'
2397 - $ref: '#/components/parameters/tagsOneOf'
2398 - $ref: '#/components/parameters/tagsAllOf'
2399 - $ref: '#/components/parameters/licenceOneOf'
2400 - $ref: '#/components/parameters/languageOneOf'
2401 - $ref: '#/components/parameters/nsfw'
2402 - $ref: '#/components/parameters/filter'
2403 - $ref: '#/components/parameters/skipCount'
2404 - $ref: '#/components/parameters/start'
2405 - $ref: '#/components/parameters/count'
2406 - $ref: '#/components/parameters/videosSort'
2409 description: successful operation
2413 $ref: '#/components/schemas/VideoListResponse'
2414 '/video-channels/{channelHandle}/avatar/pick':
2416 summary: Update channel avatar
2422 - $ref: '#/components/parameters/channelHandle'
2425 description: successful operation
2432 $ref: '#/components/schemas/ActorImage'
2434 description: image file too large
2436 X-File-Maximum-Size:
2440 description: Maximum file size for the avatar
2443 multipart/form-data:
2448 description: The file to upload.
2453 contentType: image/png, image/jpeg
2454 '/video-channels/{channelHandle}/avatar':
2456 summary: Delete channel avatar
2462 - $ref: '#/components/parameters/channelHandle'
2465 description: successful operation
2468 '/video-channels/{channelHandle}/banner/pick':
2470 summary: Update channel banner
2476 - $ref: '#/components/parameters/channelHandle'
2479 description: successful operation
2486 $ref: '#/components/schemas/ActorImage'
2488 description: image file too large
2490 X-File-Maximum-Size:
2494 description: Maximum file size for the banner
2497 multipart/form-data:
2502 description: The file to upload.
2507 contentType: image/png, image/jpeg
2508 '/video-channels/{channelHandle}/banner':
2510 summary: Delete channel banner
2516 - $ref: '#/components/parameters/channelHandle'
2519 description: successful operation
2521 /video-playlists/privacies:
2523 summary: List available playlist privacy policies
2524 operationId: getPlaylistPrivacyPolicies
2529 description: successful operation
2538 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
2542 summary: List video playlists
2543 operationId: getPlaylists
2547 - $ref: '#/components/parameters/start'
2548 - $ref: '#/components/parameters/count'
2549 - $ref: '#/components/parameters/sort'
2552 description: successful operation
2564 $ref: '#/components/schemas/VideoPlaylist'
2566 summary: Create a video playlist
2567 description: If the video playlist is set as public, `videoChannelId` is mandatory.
2568 operationId: createPlaylist
2575 description: successful operation
2585 $ref: '#/components/schemas/VideoPlaylist/properties/id'
2587 $ref: '#/components/schemas/VideoPlaylist/properties/uuid'
2590 multipart/form-data:
2595 description: Video playlist display name
2600 description: Video playlist thumbnail file
2604 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2606 description: Video playlist description
2612 - $ref: '#/components/schemas/id'
2613 description: Video channel in which the playlist will be published
2618 contentType: image/jpeg
2620 /video-playlists/{id}:
2622 summary: Get a video playlist
2626 - $ref: '#/components/parameters/idOrUUID'
2629 description: successful operation
2633 $ref: '#/components/schemas/VideoPlaylist'
2635 summary: Update a video playlist
2636 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2643 description: successful operation
2645 - $ref: '#/components/parameters/idOrUUID'
2648 multipart/form-data:
2653 description: Video playlist display name
2658 description: Video playlist thumbnail file
2662 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2664 description: Video playlist description
2668 - $ref: '#/components/schemas/id'
2669 description: Video channel in which the playlist will be published
2672 contentType: image/jpeg
2674 summary: Delete a video playlist
2680 - $ref: '#/components/parameters/idOrUUID'
2683 description: successful operation
2685 /video-playlists/{id}/videos:
2687 summary: 'List videos of a playlist'
2692 - $ref: '#/components/parameters/idOrUUID'
2695 description: successful operation
2699 $ref: '#/components/schemas/VideoListResponse'
2701 summary: 'Add a video in a playlist'
2708 - $ref: '#/components/parameters/idOrUUID'
2711 description: successful operation
2717 videoPlaylistElement:
2730 - $ref: '#/components/schemas/Video/properties/id'
2731 description: Video to add in the playlist
2734 description: Start the video at this specific timestamp (in seconds)
2737 description: Stop the video at this specific timestamp (in seconds)
2741 /video-playlists/{id}/videos/reorder:
2743 summary: 'Reorder a playlist'
2749 - $ref: '#/components/parameters/idOrUUID'
2752 description: successful operation
2761 description: 'Start position of the element to reorder'
2763 insertAfterPosition:
2765 description: 'New position for the block to reorder, to add the block before the first element'
2769 description: 'How many element from `startPosition` to reorder'
2773 - insertAfterPosition
2775 /video-playlists/{id}/videos/{playlistElementId}:
2777 summary: 'Update a playlist element'
2783 - $ref: '#/components/parameters/idOrUUID'
2784 - $ref: '#/components/parameters/playlistElementId'
2787 description: successful operation
2796 description: 'Start the video at this specific timestamp (in seconds)'
2799 description: 'Stop the video at this specific timestamp (in seconds)'
2801 summary: 'Delete an element from a playlist'
2807 - $ref: '#/components/parameters/idOrUUID'
2808 - $ref: '#/components/parameters/playlistElementId'
2811 description: successful operation
2813 '/users/me/video-playlists/videos-exist':
2815 summary: 'Check video exists in my playlists'
2824 description: The video ids to check
2828 $ref: '#/components/schemas/Video/properties/id'
2831 description: successful operation
2851 '/accounts/{name}/video-channels':
2853 summary: List video channels of an account
2858 - $ref: '#/components/parameters/name'
2861 description: include view statistics for the last 30 days (only if authentified as the account user)
2864 - $ref: '#/components/parameters/start'
2865 - $ref: '#/components/parameters/count'
2866 - $ref: '#/components/parameters/sort'
2869 description: successful operation
2873 $ref: '#/components/schemas/VideoChannelList'
2874 '/accounts/{name}/ratings':
2876 summary: List ratings of an account
2882 - $ref: '#/components/parameters/name'
2883 - $ref: '#/components/parameters/start'
2884 - $ref: '#/components/parameters/count'
2885 - $ref: '#/components/parameters/sort'
2889 description: Optionally filter which ratings to retrieve
2897 description: successful operation
2903 $ref: '#/components/schemas/VideoRating'
2904 '/videos/{id}/comment-threads':
2906 summary: List threads of a video
2910 - $ref: '#/components/parameters/idOrUUID'
2911 - $ref: '#/components/parameters/start'
2912 - $ref: '#/components/parameters/count'
2913 - $ref: '#/components/parameters/commentsSort'
2916 description: successful operation
2920 $ref: '#/components/schemas/CommentThreadResponse'
2922 summary: Create a thread
2928 - $ref: '#/components/parameters/idOrUUID'
2931 description: successful operation
2935 $ref: '#/components/schemas/CommentThreadPostResponse'
2937 description: video does not exist
2946 description: 'Text comment'
2950 '/videos/{id}/comment-threads/{threadId}':
2952 summary: Get a thread
2956 - $ref: '#/components/parameters/idOrUUID'
2957 - $ref: '#/components/parameters/threadId'
2960 description: successful operation
2964 $ref: '#/components/schemas/VideoCommentThreadTree'
2965 '/videos/{id}/comments/{commentId}':
2967 summary: Reply to a thread of a video
2973 - $ref: '#/components/parameters/idOrUUID'
2974 - $ref: '#/components/parameters/commentId'
2977 description: successful operation
2981 $ref: '#/components/schemas/CommentThreadPostResponse'
2983 description: thread or video does not exist
2991 $ref: '#/components/schemas/VideoComment/properties/text'
2996 summary: Delete a comment or a reply
3002 - $ref: '#/components/parameters/idOrUUID'
3003 - $ref: '#/components/parameters/commentId'
3006 description: successful operation
3008 description: cannot remove comment of another user
3010 description: comment or video does not exist
3012 description: comment is already deleted
3013 '/videos/{id}/rate':
3015 summary: Like/dislike a video
3021 - $ref: '#/components/parameters/idOrUUID'
3024 description: successful operation
3026 description: video does not exist
3031 summary: Search videos
3036 allowEmptyValue: false
3038 String to search. If the user can make a remote URI search, and the string is an URI then the
3039 PeerTube instance will fetch the remote object and add it to its database. Then,
3040 you can use the REST API to fetch the complete video information and interact with it.
3043 - $ref: '#/components/parameters/categoryOneOf'
3044 - $ref: '#/components/parameters/isLive'
3045 - $ref: '#/components/parameters/tagsOneOf'
3046 - $ref: '#/components/parameters/tagsAllOf'
3047 - $ref: '#/components/parameters/licenceOneOf'
3048 - $ref: '#/components/parameters/languageOneOf'
3049 - $ref: '#/components/parameters/nsfw'
3050 - $ref: '#/components/parameters/filter'
3051 - $ref: '#/components/parameters/skipCount'
3052 - $ref: '#/components/parameters/start'
3053 - $ref: '#/components/parameters/count'
3054 - $ref: '#/components/parameters/searchTarget'
3055 - $ref: '#/components/parameters/videosSearchSort'
3058 description: Get videos that are published after this date
3064 description: Get videos that are published before this date
3068 - name: originallyPublishedStartDate
3070 description: Get videos that are originally published after this date
3074 - name: originallyPublishedEndDate
3076 description: Get videos that are originally published before this date
3082 description: Get videos that have this minimum duration
3087 description: Get videos that have this maximum duration
3091 'searchTarget === search-index':
3092 $ref: '#/components/callbacks/searchIndex'
3095 description: successful operation
3099 $ref: '#/components/schemas/VideoListResponse'
3101 description: search index unavailable
3102 /search/video-channels:
3106 summary: Search channels
3112 String to search. If the user can make a remote URI search, and the string is an URI then the
3113 PeerTube instance will fetch the remote object and add it to its database. Then,
3114 you can use the REST API to fetch the complete channel information and interact with it.
3117 - $ref: '#/components/parameters/start'
3118 - $ref: '#/components/parameters/count'
3119 - $ref: '#/components/parameters/searchTarget'
3120 - $ref: '#/components/parameters/sort'
3122 'searchTarget === search-index':
3123 $ref: '#/components/callbacks/searchIndex'
3126 description: successful operation
3130 $ref: '#/components/schemas/VideoChannelList'
3132 description: search index unavailable
3133 /blocklist/accounts:
3137 summary: List account blocks
3142 - $ref: '#/components/parameters/start'
3143 - $ref: '#/components/parameters/count'
3144 - $ref: '#/components/parameters/sort'
3147 description: successful operation
3151 summary: Block an account
3163 example: chocobozzz@example.org
3164 description: account to block, in the form `username@domain`
3169 description: successful operation
3171 description: self-blocking forbidden
3172 '/blocklist/accounts/{accountName}':
3176 summary: Unblock an account by its handle
3184 description: account to unblock, in the form `username@domain`
3189 description: successful operation
3191 description: account or account block does not exist
3196 summary: List server blocks
3201 - $ref: '#/components/parameters/start'
3202 - $ref: '#/components/parameters/count'
3203 - $ref: '#/components/parameters/sort'
3206 description: successful operation
3210 summary: Block a server
3223 description: server domain to block
3228 description: successful operation
3230 description: self-blocking forbidden
3231 '/blocklist/servers/{host}':
3235 summary: Unblock a server by its domain
3243 description: server domain to unblock
3249 description: successful operation
3251 description: account block does not exist
3255 - Instance Redundancy
3256 summary: Update a server redundancy policy
3264 description: server domain to mirror
3276 description: allow mirroring of the host's local videos
3281 description: successful operation
3283 description: server is not already known
3288 summary: List videos being mirrored
3296 description: direction of the mirror
3302 - $ref: '#/components/parameters/start'
3303 - $ref: '#/components/parameters/count'
3304 - $ref: '#/components/parameters/videoRedundanciesSort'
3307 description: successful operation
3313 $ref: '#/components/schemas/VideoRedundancy'
3317 summary: Mirror a video
3328 $ref: '#/components/schemas/Video/properties/id'
3333 description: successful operation
3335 description: cannot mirror a local video
3337 description: video does not exist
3339 description: video is already mirrored
3340 /redundancy/videos/{redundancyId}:
3344 summary: Delete a mirror done on a video
3349 - name: redundancyId
3352 description: id of an existing redundancy on a video
3357 description: successful operation
3359 description: video redundancy not found
3360 '/feeds/video-comments.{format}':
3364 summary: List comments on videos
3369 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3382 description: 'limit listing to a specific video'
3387 description: 'limit listing to a specific account'
3392 description: 'limit listing to a specific account'
3395 - name: videoChannelId
3397 description: 'limit listing to a specific video channel'
3400 - name: videoChannelName
3402 description: 'limit listing to a specific video channel'
3407 description: successful operation
3412 default: 'max-age=900' # 15 min cache
3416 $ref: '#/components/schemas/VideoCommentsForXML'
3419 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3420 application/rss+xml:
3422 $ref: '#/components/schemas/VideoCommentsForXML'
3425 externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
3428 $ref: '#/components/schemas/VideoCommentsForXML'
3431 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3432 application/atom+xml:
3434 $ref: '#/components/schemas/VideoCommentsForXML'
3437 externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
3443 externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local
3445 x-summary: field inconsistencies
3448 - videoId filter is mixed with a channel filter
3450 description: video, video channel or account not found
3452 description: accept header unsupported
3453 '/feeds/videos.{format}':
3457 summary: List videos
3462 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3475 description: 'limit listing to a specific account'
3480 description: 'limit listing to a specific account'
3483 - name: videoChannelId
3485 description: 'limit listing to a specific video channel'
3488 - name: videoChannelName
3490 description: 'limit listing to a specific video channel'
3493 - $ref: '#/components/parameters/sort'
3494 - $ref: '#/components/parameters/nsfw'
3495 - $ref: '#/components/parameters/filter'
3498 description: successful operation
3503 default: 'max-age=900' # 15 min cache
3507 $ref: '#/components/schemas/VideosForXML'
3510 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3511 application/rss+xml:
3513 $ref: '#/components/schemas/VideosForXML'
3516 externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local
3519 $ref: '#/components/schemas/VideosForXML'
3522 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3523 application/atom+xml:
3525 $ref: '#/components/schemas/VideosForXML'
3528 externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local
3534 externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local
3536 description: video channel or account not found
3538 description: accept header unsupported
3539 '/feeds/subscriptions.{format}':
3544 summary: List videos of subscriptions tied to a token
3549 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3562 description: limit listing to a specific account
3568 description: private token allowing access
3572 - $ref: '#/components/parameters/sort'
3573 - $ref: '#/components/parameters/nsfw'
3574 - $ref: '#/components/parameters/filter'
3577 description: successful operation
3582 default: 'max-age=900' # 15 min cache
3586 $ref: '#/components/schemas/VideosForXML'
3587 application/rss+xml:
3589 $ref: '#/components/schemas/VideosForXML'
3592 $ref: '#/components/schemas/VideosForXML'
3593 application/atom+xml:
3595 $ref: '#/components/schemas/VideosForXML'
3600 description: accept header unsupported
3605 summary: List plugins
3618 - $ref: '#/components/parameters/start'
3619 - $ref: '#/components/parameters/count'
3620 - $ref: '#/components/parameters/sort'
3623 description: successful operation
3627 $ref: '#/components/schemas/PluginResponse'
3632 summary: List available plugins
3645 - name: currentPeerTubeEngine
3649 - $ref: '#/components/parameters/start'
3650 - $ref: '#/components/parameters/count'
3651 - $ref: '#/components/parameters/sort'
3654 description: successful operation
3658 $ref: '#/components/schemas/PluginResponse'
3660 description: plugin index unavailable
3665 summary: Install a plugin
3678 example: peertube-plugin-auth-ldap
3681 additionalProperties: false
3688 additionalProperties: false
3691 description: successful operation
3693 description: should have either `npmName` or `path` set
3698 summary: Update a plugin
3711 example: peertube-plugin-auth-ldap
3714 additionalProperties: false
3721 additionalProperties: false
3724 description: successful operation
3726 description: should have either `npmName` or `path` set
3728 description: existing plugin not found
3733 summary: Uninstall a plugin
3745 description: name of the plugin/theme in its package.json
3746 example: peertube-plugin-auth-ldap
3751 description: successful operation
3753 description: existing plugin not found
3758 summary: Get a plugin
3763 - $ref: '#/components/parameters/npmName'
3766 description: successful operation
3770 $ref: '#/components/schemas/Plugin'
3772 description: plugin not found
3773 /plugins/{npmName}/settings:
3777 summary: Set a plugin's settings
3782 - $ref: '#/components/parameters/npmName'
3791 additionalProperties: true
3794 description: successful operation
3796 description: plugin not found
3797 /plugins/{npmName}/public-settings:
3801 summary: Get a plugin's public settings
3803 - $ref: '#/components/parameters/npmName'
3806 description: successful operation
3811 additionalProperties: true
3813 description: plugin not found
3814 /plugins/{npmName}/registered-settings:
3818 summary: Get a plugin's registered settings
3823 - $ref: '#/components/parameters/npmName'
3826 description: successful operation
3831 additionalProperties: true
3833 description: plugin not found
3835 - url: 'https://peertube2.cpy.re/api/v1'
3836 description: Live Test Server (live data - latest nightly version)
3837 - url: 'https://peertube3.cpy.re/api/v1'
3838 description: Live Test Server (live data - latest RC version)
3839 - url: 'https://peertube.cpy.re/api/v1'
3840 description: Live Test Server (live data - stable version)
3847 description: Offset used to paginate results
3855 description: "Number of items to return"
3865 description: Sort column
3873 description: Plain text search, applied to various parts of the model depending on endpoint
3881 If the administrator enabled search index support, you can override the default search target.
3884 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3885 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3886 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3887 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3888 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3889 * 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
3890 the data from the origin instance API
3900 description: Sort videos by criteria
3916 description: Sort videos by criteria
3931 description: Sort comments by criteria
3941 description: Sort blacklists by criteria
3957 description: Plain text search that will match with user usernames or emails
3964 description: Filter results down to (un)banned users
3971 description: Sort users by criteria
3982 description: Sort abuses by criteria
3989 videoRedundanciesSort:
3993 description: Sort abuses by criteria
4002 description: The username or handle of the account
4005 example: chocobozzz | chocobozzz@example.org
4010 description: The user id
4012 $ref: '#/components/schemas/id'
4017 description: The object id or uuid
4020 - $ref: '#/components/schemas/id'
4021 - $ref: '#/components/schemas/UUIDv4'
4023 name: playlistElementId
4026 description: Playlist element id
4028 $ref: '#/components/schemas/id'
4033 description: Abuse id
4035 $ref: '#/components/schemas/Abuse/properties/id'
4037 name: abuseMessageId
4040 description: Abuse message id
4042 $ref: '#/components/schemas/AbuseMessage/properties/id'
4044 name: captionLanguage
4047 description: The caption language
4049 $ref: '#/components/schemas/VideoLanguageSet'
4054 description: The video channel handle
4057 example: my_username | my_username@example.com
4059 name: subscriptionHandle
4062 description: The subscription handle
4065 example: my_username | my_username@example.com
4070 description: The thread id (root comment id)
4072 $ref: '#/components/schemas/VideoCommentThreadTree/properties/comment/properties/id'
4077 description: The comment id
4079 $ref: '#/components/schemas/VideoComment/properties/id'
4084 description: whether or not the video is a live
4091 description: category id of the video (see [/videos/categories](#operation/getCategories))
4094 - $ref: '#/components/schemas/VideoCategorySet'
4097 $ref: '#/components/schemas/VideoCategorySet'
4104 description: tag(s) of the video
4118 description: tag(s) of the video, where all should be present in the video
4131 description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
4134 - $ref: '#/components/schemas/VideoLanguageSet'
4137 $ref: '#/components/schemas/VideoLanguageSet'
4144 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4147 - $ref: '#/components/schemas/VideoLicenceSet'
4150 $ref: '#/components/schemas/VideoLicenceSet'
4157 description: if you don't need the `total` in the response
4168 description: whether to include nsfw videos, if any
4179 Special filters which might require special rights:
4180 * `local` - only videos local to the instance
4181 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
4182 * `all` - all videos, showing private and unlisted videos (requires Admin privileges)
4192 description: list of uris to check if each is part of the user subscriptions
4202 description: name of the plugin/theme on npmjs.com or in its package.json
4205 example: peertube-plugin-auth-ldap
4210 description: job type
4214 - activitypub-follow
4215 - activitypub-http-broadcast
4216 - activitypub-http-fetcher
4217 - activitypub-http-unicast
4223 - activitypub-refresher
4229 Authenticating via OAuth requires the following steps:
4230 - Have an activated account
4231 - [Generate](https://docs.joinpeertube.org/api-rest-getting-started) a
4232 Bearer Token for that account at `/api/v1/users/token`
4233 - Make authenticated requests, putting *Authorization: Bearer <token\>*
4234 - Profit, depending on the role assigned to the account
4236 Note that the __access token is valid for 1 day__ and, and is given
4237 along with a __refresh token valid for 2 weeks__.
4241 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
4244 moderator: Moderator scope
4247 # Resuable core properties
4255 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4256 pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
4261 description: The username of the user
4263 pattern: '/^[a-z0-9._]{1,50}$/'
4268 description: The username for the default channel
4269 example: The Capybara Channel
4270 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4274 description: The password of the user
4280 description: category id of the video (see [/videos/categories](#operation/getCategories))
4282 VideoConstantNumber-Category:
4285 $ref: '#/components/schemas/VideoCategorySet'
4288 example: Science & Technology
4292 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4294 VideoConstantNumber-Licence:
4297 $ref: '#/components/schemas/VideoLicenceSet'
4300 example: Attribution - Share Alike
4304 description: language id of the video (see [/videos/languages](#operation/getLanguages))
4306 VideoConstantString-Language:
4309 $ref: '#/components/schemas/VideoLanguageSet'
4314 VideoPlaylistPrivacySet:
4320 description: Video playlist privacy policy (see [/video-playlists/privacies])
4321 VideoPlaylistPrivacyConstant:
4324 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
4328 VideoPlaylistTypeSet:
4333 description: The video playlist type (Regular = `1`, Watch Later = `2`)
4334 VideoPlaylistTypeConstant:
4337 $ref: '#/components/schemas/VideoPlaylistTypeSet'
4348 description: privacy id of the video (see [/videos/privacies](#operation/getPrivacyPolicies))
4349 VideoPrivacyConstant:
4352 $ref: '#/components/schemas/VideoPrivacySet'
4369 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
4376 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
4387 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
4397 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
4401 $ref: '#/components/schemas/AbuseStateSet'
4404 AbusePredefinedReasons:
4417 example: [spamOrMisleading]
4422 Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
4424 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
4426 VideoResolutionConstant:
4427 description: resolutions and their labels for the video
4430 $ref: '#/components/schemas/VideoResolutionSet'
4434 VideoScheduledUpdate:
4437 $ref: '#/components/schemas/VideoPrivacySet'
4441 description: When to update the video
4461 - $ref: '#/components/schemas/ActorImage'
4462 VideoChannelSummary:
4465 $ref: '#/components/schemas/id'
4479 - $ref: '#/components/schemas/ActorImage'
4491 - $ref: '#/components/schemas/Video'
4498 description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
4499 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
4500 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4502 $ref: '#/components/schemas/VideoResolutionConstant'
4505 description: Video file size in bytes
4508 description: Direct URL of the torrent file
4512 description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
4516 description: Direct URL of the video
4520 description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
4524 description: Frames per second of the video file
4528 description: URL dereferencing the output of ffprobe on the file
4529 VideoStreamingPlaylists:
4534 $ref: '#/components/schemas/id'
4542 - $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'
4543 VideoStreamingPlaylists-HLS:
4554 Video files associated to this playlist.
4556 The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
4558 $ref: '#/components/schemas/VideoFile'
4570 $ref: '#/components/schemas/Video/properties/id'
4572 $ref: '#/components/schemas/Video/properties/uuid'
4574 $ref: '#/components/schemas/Video/properties/name'
4578 description: object id for the video
4580 - $ref: '#/components/schemas/id'
4582 description: universal identifier for the video, that can be used across instances
4584 - $ref: '#/components/schemas/UUIDv4'
4590 example: 2017-10-01T10:52:46.396Z
4591 description: time at which the video object was first drafted
4595 example: 2018-10-01T10:52:46.396Z
4596 description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
4600 example: 2021-05-04T08:01:01.502Z
4601 description: last time the video's metadata was modified
4602 originallyPublishedAt:
4605 example: 2010-10-01T10:52:46.396Z
4606 description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
4609 - $ref: '#/components/schemas/VideoConstantNumber-Category'
4610 description: category in which the video is classified
4613 - $ref: '#/components/schemas/VideoConstantNumber-Licence'
4614 description: licence under which the video is distributed
4617 - $ref: '#/components/schemas/VideoConstantString-Language'
4618 description: main language used in the video
4621 - $ref: '#/components/schemas/VideoPrivacyConstant'
4622 description: privacy policy used to distribute the video
4626 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
4627 **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
4631 truncated description of the video, written in Markdown.
4632 Resolve `descriptionPath` to get the full description of maximum `10000` characters.
4636 description: duration of the video in seconds
4641 description: title of the video
4642 example: What is PeerTube?
4647 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4650 example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4653 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
4670 - $ref: '#/components/schemas/VideoStateConstant'
4671 description: represents the internal state of the video processing within the PeerTube instance
4675 - $ref: '#/components/schemas/VideoScheduledUpdate'
4683 $ref: '#/components/schemas/AccountSummary'
4685 $ref: '#/components/schemas/VideoChannelSummary'
4694 - $ref: '#/components/schemas/Video'
4699 example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
4700 description: path at which to get the full description of maximum `10000` characters
4703 description: A text tell the audience how to support the video creator
4704 example: Please support my work on <insert crowdfunding plateform>! <3
4708 $ref: '#/components/schemas/VideoChannel'
4710 $ref: '#/components/schemas/Account'
4712 example: [flowers, gardening]
4730 - https://peertube2.cpy.re/tracker/announce
4731 - wss://peertube2.cpy.re/tracker/socket
4735 $ref: '#/components/schemas/VideoFile'
4737 WebTorrent/raw video files. If WebTorrent is disabled on the server:
4739 - field will be empty
4740 - video files will be found in `streamingPlaylists[].files` field
4744 $ref: '#/components/schemas/VideoStreamingPlaylists'
4746 HLS playlists/manifest files. If HLS is disabled on the server:
4748 - field will be empty
4749 - video files will be found in `files` field
4750 FileRedundancyInformation:
4753 $ref: '#/components/schemas/id'
4778 $ref: '#/components/schemas/id'
4785 $ref: '#/components/schemas/UUIDv4'
4792 $ref: '#/components/schemas/FileRedundancyInformation'
4796 $ref: '#/components/schemas/FileRedundancyInformation'
4797 VideoImportStateConstant:
4805 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
4812 $ref: '#/components/schemas/id'
4816 description: remote URL where to find the import's source video
4817 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4821 description: magnet URI allowing to resolve the import's source video
4822 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
4823 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4827 $ref: '#/components/schemas/VideoImportStateConstant'
4839 - $ref: '#/components/schemas/Video'
4849 $ref: '#/components/schemas/VideoImport'
4853 $ref: '#/components/schemas/id'
4856 example: The video is a spam
4860 $ref: '#/components/schemas/AbusePredefinedReasons'
4862 $ref: '#/components/schemas/Account'
4864 $ref: '#/components/schemas/AbuseStateConstant'
4867 example: Decided to ban the server since it spams us regularly
4871 $ref: '#/components/schemas/VideoInfo'
4878 $ref: '#/components/schemas/id'
4889 $ref: '#/components/schemas/AccountSummary'
4893 $ref: '#/components/schemas/id'
4895 $ref: '#/components/schemas/Video/properties/id'
4907 $ref: '#/components/schemas/UUIDv4'
4925 $ref: '#/components/schemas/id'
4927 $ref: '#/components/schemas/UUIDv4'
4950 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4952 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4954 $ref: '#/components/schemas/AccountSummary'
4956 $ref: '#/components/schemas/VideoChannelSummary'
4960 $ref: '#/components/schemas/id'
4966 description: Text of the comment in Markdown
4972 $ref: '#/components/schemas/id'
4974 $ref: '#/components/schemas/Video/properties/id'
4981 totalRepliesFromVideoAuthor:
4988 $ref: '#/components/schemas/Account'
4989 VideoCommentThreadTree:
4992 $ref: '#/components/schemas/VideoComment'
4996 $ref: '#/components/schemas/VideoCommentThreadTree'
5000 $ref: '#/components/schemas/VideoConstantString-Language'
5016 $ref: '#/components/schemas/id'
5033 $ref: '#/components/schemas/id'
5038 description: immutable name of the actor
5040 - $ref: '#/components/schemas/username'
5044 description: server on which the actor is resident
5045 hostRedundancyAllowed:
5047 description: whether this actor's host allows redundancy of its videos
5051 description: number of actors subscribed to by this actor, as seen by this instance
5055 description: number of followers of this actor, as seen by this instance
5063 $ref: '#/components/schemas/ActorImage'
5066 - $ref: '#/components/schemas/Actor'
5069 description: object id for the user tied to this account
5071 - $ref: '#/components/schemas/User/properties/id'
5074 description: name displayed on the account's profile
5077 description: text or bio displayed on the account's profile
5082 description: timestamp within the video, in seconds
5149 allowedForCurrentIP:
5151 requiresEmailVerification:
5169 $ref: '#/components/schemas/VideoResolutionSet'
5254 example: 16810141515
5357 requiresEmailVerification:
5372 description: Settings that apply to new users, if registration is enabled
5376 example: 16810141515
5382 description: Settings pertaining to transcoding jobs
5386 allowAdditionalExtensions:
5388 description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
5391 description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
5394 description: Amount of threads used by ffmpeg for 1 transcoding job
5397 description: Amount of transcoding jobs to execute in parallel
5403 New profiles can be added by plugins ; available in core PeerTube: 'default'.
5406 description: Resolutions to transcode _new videos_ to
5426 description: WebTorrent-specific settings
5432 description: HLS-specific settings
5476 $ref: '#/components/schemas/id'
5478 $ref: '#/components/schemas/Actor'
5480 $ref: '#/components/schemas/Actor'
5483 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
5496 PredefinedAbuseReasons:
5497 description: Reason categories that help triage reports
5515 $ref: '#/components/schemas/id'
5527 - activitypub-http-unicast
5528 - activitypub-http-broadcast
5529 - activitypub-http-fetcher
5530 - activitypub-follow
5536 - activitypub-refresher
5540 additionalProperties: true
5543 additionalProperties: true
5559 $ref: '#/components/schemas/id'
5564 $ref: '#/components/schemas/id'
5565 VideoUploadRequestCommon:
5568 description: Video name
5570 example: What is PeerTube?
5574 description: Channel id that will contain this video
5579 $ref: '#/components/schemas/VideoPrivacySet'
5581 $ref: '#/components/schemas/VideoCategorySet'
5583 $ref: '#/components/schemas/VideoLicenceSet'
5585 $ref: '#/components/schemas/VideoLanguageSet'
5587 description: Video description
5590 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
5592 description: Whether or not we wait transcoding before publish the video
5595 description: A text tell the audience how to support the video creator
5596 example: Please support my work on <insert crowdfunding plateform>! <3
5599 description: Whether or not this video contains sensitive content
5602 description: Video tags (maximum 5 tags each between 2 and 30 characters)
5615 description: Enable or disable comments for this video
5618 description: Enable or disable downloading for this video
5620 originallyPublishedAt:
5621 description: Date when the content was originally published
5625 $ref: '#/components/schemas/VideoScheduledUpdate'
5627 description: Video thumbnail file
5631 description: Video preview file
5637 VideoUploadRequestLegacy:
5639 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5645 description: Video file
5648 VideoUploadRequestResumable:
5650 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5656 description: Video filename including extension
5659 example: what_is_peertube.mp4
5661 description: Video thumbnail file
5665 description: Video preview file
5668 VideoUploadResponse:
5674 $ref: '#/components/schemas/Video/properties/id'
5676 $ref: '#/components/schemas/Video/properties/uuid'
5677 CommentThreadResponse:
5686 $ref: '#/components/schemas/VideoComment'
5687 CommentThreadPostResponse:
5690 $ref: '#/components/schemas/VideoComment'
5700 $ref: '#/components/schemas/Video'
5704 $ref: '#/components/schemas/Account'
5707 description: Automatically start playing the upcoming video after the currently playing video
5708 autoPlayNextVideoPlaylist:
5710 description: Automatically start playing the video on the playlist after the currently playing video
5713 description: Automatically start playing the video on the watch page
5723 description: The user email
5726 description: Has the user confirmed their email address?
5729 - $ref: '#/components/schemas/id'
5733 description: Auth plugin to use to authenticate the user
5737 noInstanceConfigWarningModal:
5742 $ref: '#/components/schemas/NSFWPolicy'
5744 $ref: '#/components/schemas/UserRole'
5753 description: Theme enabled by this user
5755 $ref: '#/components/schemas/username'
5759 $ref: '#/components/schemas/VideoChannel'
5762 description: The user video quota in bytes
5766 description: The user daily video quota in bytes
5770 description: Enable P2P in the player
5773 - $ref: '#/components/schemas/User'
5775 # optionally present fields: they require WITH_STATS scope
5778 description: Count of videos published
5781 description: Count of reports/abuses of which the user is a target
5782 abusesAcceptedCount:
5784 description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team
5787 description: Count of reports/abuses created by the user
5790 description: Count of comments published
5794 $ref: '#/components/schemas/username'
5796 $ref: '#/components/schemas/password'
5800 description: The user email
5803 description: The user video quota in bytes
5807 description: The user daily video quota in bytes
5810 $ref: '#/components/schemas/usernameChannel'
5812 $ref: '#/components/schemas/UserRole'
5814 $ref: '#/components/schemas/UserAdminFlags'
5827 description: The updated email of the user
5830 description: Set the email as verified
5833 description: The updated video quota of the user in bytes
5836 description: The updated daily video quota of the user in bytes
5840 description: The auth plugin to use to authenticate the user
5841 example: 'peertube-plugin-auth-saml2'
5843 $ref: '#/components/schemas/UserRole'
5845 $ref: '#/components/schemas/UserAdminFlags'
5849 $ref: '#/components/schemas/password'
5853 description: Your new email
5856 description: Your new displayNSFW
5863 description: Your new autoPlayVideo
5872 $ref: '#/components/schemas/id'
5879 description: Rating of the video
5886 $ref: '#/components/schemas/Video'
5893 description: Rating of the video
5900 $ref: '#/components/schemas/username'
5902 $ref: '#/components/schemas/password'
5906 description: The email of the user
5909 description: The user display name
5916 $ref: '#/components/schemas/usernameChannel'
5919 description: The display name for the default channel
5929 # GET/POST/PUT properties
5932 example: Videos of Framasoft
5937 example: Videos made with <3 by Framasoft
5942 description: text shown by default on all videos of this channel, to tell the audience how to support it
5943 example: Please support my work on <insert crowdfunding plateform>! <3
5946 # GET-only properties
5950 - $ref: '#/components/schemas/id'
5966 $ref: '#/components/schemas/UUIDv4'
5969 - $ref: '#/components/schemas/VideoChannel'
5972 description: username of the channel to create
5974 - $ref: '#/components/schemas/usernameChannel'
5980 - $ref: '#/components/schemas/VideoChannel'
5982 bulkVideosSupportUpdate:
5984 description: Update the support field for all videos of this channel
5994 - $ref: '#/components/schemas/VideoChannel'
5995 - $ref: '#/components/schemas/Actor'
6000 name: 'media:peerLink'
6009 - application/x-bittorrent
6015 name: 'media:content'
6046 VideoCommentsForXML:
6081 description: video watch page URL
6084 description: video canonical URL
6088 description: video publication date
6091 description: video description
6094 description: video description
6097 description: publisher user name
6100 description: video category (MRSS)
6103 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
6118 description: video embed path, relative to the canonical URL domain (MRSS)
6127 description: video watch path, relative to the canonical URL domain (MRSS)
6148 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
6149 'media:description':
6156 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
6159 description: main streamable file for the video
6169 - application/x-bittorrent
6178 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)
6181 - $ref: '#/components/schemas/MRSSPeerLink'
6182 - $ref: '#/components/schemas/MRSSGroupContent'
6183 NotificationSettingValue:
6200 $ref: '#/components/schemas/id'
6204 Notification type, following the `UserNotificationType` enum:
6206 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
6208 - `2` NEW_COMMENT_ON_MY_VIDEO
6210 - `3` NEW_ABUSE_FOR_MODERATORS
6212 - `4` BLACKLIST_ON_MY_VIDEO
6214 - `5` UNBLACKLIST_ON_MY_VIDEO
6216 - `6` MY_VIDEO_PUBLISHED
6218 - `7` MY_VIDEO_IMPORT_SUCCESS
6220 - `8` MY_VIDEO_IMPORT_ERROR
6222 - `9` NEW_USER_REGISTRATION
6226 - `11` COMMENT_MENTION
6228 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
6230 - `13` NEW_INSTANCE_FOLLOWER
6232 - `14` AUTO_INSTANCE_FOLLOWING
6238 - $ref: '#/components/schemas/VideoInfo'
6242 $ref: '#/components/schemas/ActorInfo'
6248 $ref: '#/components/schemas/id'
6251 $ref: '#/components/schemas/VideoInfo'
6256 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
6266 $ref: '#/components/schemas/id'
6270 $ref: '#/components/schemas/VideoInfo'
6272 $ref: '#/components/schemas/ActorInfo'
6278 $ref: '#/components/schemas/id'
6281 - $ref: '#/components/schemas/VideoInfo'
6287 $ref: '#/components/schemas/id'
6290 - $ref: '#/components/schemas/VideoInfo'
6294 - $ref: '#/components/schemas/ActorInfo'
6300 $ref: '#/components/schemas/id'
6302 $ref: '#/components/schemas/ActorInfo'
6330 NotificationListResponse:
6339 $ref: '#/components/schemas/Notification'
6344 example: peertube-plugin-auth-ldap
6372 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
6375 additionalProperties: true
6391 $ref: '#/components/schemas/Plugin'
6398 description: User can stream multiple times in a permanent live
6407 description: RTMP stream key to use to stream into this live video
6411 description: User can stream multiple times in a permanent live
6418 'https://search.example.org/api/v1/search/videos':
6420 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
6423 description: successful operation
6427 $ref: '#/components/schemas/VideoListResponse'