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:
1675 $ref: '#/components/schemas/VideoCreateImport'
1678 contentType: application/x-bittorrent
1680 contentType: image/jpeg
1682 contentType: image/jpeg
1685 description: successful operation
1689 $ref: '#/components/schemas/VideoUploadResponse'
1691 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1693 description: video didn't pass pre-import filter
1695 description: HTTP or Torrent/magnetURI import not enabled
1699 summary: Create a live
1700 operationId: createLive
1708 description: successful operation
1712 $ref: '#/components/schemas/VideoUploadResponse'
1714 description: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
1717 multipart/form-data:
1722 description: Channel id that will contain this live video
1727 description: User can stream multiple times in a permanent live
1730 description: Live video/replay thumbnail file
1734 description: Live video/replay preview file
1738 $ref: '#/components/schemas/VideoPrivacySet'
1740 $ref: '#/components/schemas/VideoCategorySet'
1742 $ref: '#/components/schemas/VideoLicenceSet'
1744 $ref: '#/components/schemas/VideoLanguageSet'
1746 description: Live video/replay description
1749 description: A text tell the audience how to support the creator
1750 example: Please support my work on <insert crowdfunding plateform>! <3
1753 description: Whether or not this live video/replay contains sensitive content
1756 description: Live video/replay name
1761 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
1770 description: Enable or disable comments for this live video/replay
1773 description: Enable or disable downloading for the replay of this live
1780 contentType: image/jpeg
1782 contentType: image/jpeg
1786 summary: Get information about a live
1787 operationId: getLiveId
1794 - $ref: '#/components/parameters/idOrUUID'
1797 description: successful operation
1801 $ref: '#/components/schemas/LiveVideoResponse'
1803 summary: Update information about a live
1804 operationId: updateLiveId
1811 - $ref: '#/components/parameters/idOrUUID'
1816 $ref: '#/components/schemas/LiveVideoUpdate'
1819 description: successful operation
1821 description: bad parameters or trying to update a live that has already started
1823 description: trying to save replay of the live but saving replay is not enabled on the instance
1827 summary: List my abuses
1828 operationId: getMyAbuses
1837 description: only list the report with this id
1843 $ref: '#/components/schemas/AbuseStateSet'
1844 - $ref: '#/components/parameters/abusesSort'
1845 - $ref: '#/components/parameters/start'
1846 - $ref: '#/components/parameters/count'
1849 description: successful operation
1861 $ref: '#/components/schemas/Abuse'
1865 summary: List abuses
1866 operationId: getAbuses
1876 description: only list the report with this id
1879 - name: predefinedReason
1881 description: predefined reason the listed reports should contain
1883 $ref: '#/components/schemas/PredefinedAbuseReasons'
1886 description: plain search that will match with video titles, reporter names and more
1892 $ref: '#/components/schemas/AbuseStateSet'
1893 - name: searchReporter
1895 description: only list reports of a specific reporter
1898 - name: searchReportee
1899 description: only list reports of a specific reportee
1905 description: only list reports of a specific video
1908 - name: searchVideoChannel
1910 description: only list reports of a specific video channel
1915 description: only list blacklisted or deleted videos
1923 description: only list account, comment or video reports
1930 - $ref: '#/components/parameters/start'
1931 - $ref: '#/components/parameters/count'
1932 - $ref: '#/components/parameters/abusesSort'
1935 description: successful operation
1947 $ref: '#/components/schemas/Abuse'
1950 summary: Report an abuse
1963 description: Reason why the user reports this video
1968 $ref: '#/components/schemas/PredefinedAbuseReasons'
1973 description: Video id to report
1975 - $ref: '#/components/schemas/Video/properties/id'
1978 description: Timestamp in the video that marks the beginning of the report
1982 description: Timestamp in the video that marks the ending of the report
1988 description: Comment id to report
1990 - $ref: '#/components/schemas/VideoComment/properties/id'
1995 description: Account id to report
2001 description: successful operation
2003 description: incorrect request parameters
2004 '/abuses/{abuseId}':
2006 summary: Update an abuse
2014 - $ref: '#/components/parameters/abuseId'
2022 $ref: '#/components/schemas/AbuseStateSet'
2025 description: Update the report comment visible only to the moderation team
2030 description: successful operation
2032 description: abuse not found
2036 summary: Delete an abuse
2042 - $ref: '#/components/parameters/abuseId'
2045 description: successful operation
2047 description: block not found
2048 '/abuses/{abuseId}/messages':
2050 summary: List messages of an abuse
2056 - $ref: '#/components/parameters/abuseId'
2059 description: successful operation
2065 $ref: '#/components/schemas/AbuseMessage'
2068 summary: Add message to an abuse
2074 - $ref: '#/components/parameters/abuseId'
2083 description: Message to send
2091 description: successful operation
2093 description: incorrect request parameters
2094 '/abuses/{abuseId}/messages/{abuseMessageId}':
2096 summary: Delete an abuse message
2102 - $ref: '#/components/parameters/abuseId'
2103 - $ref: '#/components/parameters/abuseMessageId'
2106 description: successful operation
2108 '/videos/{id}/blacklist':
2110 summary: Block a video
2118 - $ref: '#/components/parameters/idOrUUID'
2121 description: successful operation
2123 summary: Unblock a video by its id
2131 - $ref: '#/components/parameters/idOrUUID'
2134 description: successful operation
2136 description: block not found
2141 summary: List video blocks
2150 list only blocks that match this type:
2154 - `2`: automatic block that needs review
2162 description: plain search that will match with video titles, and more
2165 - $ref: '#/components/parameters/start'
2166 - $ref: '#/components/parameters/count'
2167 - $ref: '#/components/parameters/blacklistsSort'
2170 description: successful operation
2182 $ref: '#/components/schemas/VideoBlacklist'
2183 /videos/{id}/captions:
2185 summary: List captions of a video
2189 - $ref: '#/components/parameters/idOrUUID'
2192 description: successful operation
2204 $ref: '#/components/schemas/VideoCaption'
2205 /videos/{id}/captions/{captionLanguage}:
2207 summary: Add or replace a video caption
2214 - $ref: '#/components/parameters/idOrUUID'
2215 - $ref: '#/components/parameters/captionLanguage'
2218 multipart/form-data:
2223 description: The file to upload.
2228 contentType: text/vtt, application/x-subrip, text/plain
2231 description: successful operation
2233 description: video or language not found
2235 summary: Delete a video caption
2242 - $ref: '#/components/parameters/idOrUUID'
2243 - $ref: '#/components/parameters/captionLanguage'
2246 description: successful operation
2248 description: video or language or caption for that language not found
2251 summary: List video channels
2255 - $ref: '#/components/parameters/start'
2256 - $ref: '#/components/parameters/count'
2257 - $ref: '#/components/parameters/sort'
2260 description: successful operation
2264 $ref: '#/components/schemas/VideoChannelList'
2266 summary: Create a video channel
2273 description: successful operation
2278 $ref: '#/components/schemas/VideoChannelCreate'
2279 '/video-channels/{channelHandle}':
2281 summary: Get a video channel
2285 - $ref: '#/components/parameters/channelHandle'
2288 description: successful operation
2292 $ref: '#/components/schemas/VideoChannel'
2294 summary: Update a video channel
2300 - $ref: '#/components/parameters/channelHandle'
2303 description: successful operation
2308 $ref: '#/components/schemas/VideoChannelUpdate'
2310 summary: Delete a video channel
2316 - $ref: '#/components/parameters/channelHandle'
2319 description: successful operation
2320 '/video-channels/{channelHandle}/videos':
2322 summary: List videos of a video channel
2327 - $ref: '#/components/parameters/channelHandle'
2328 - $ref: '#/components/parameters/categoryOneOf'
2329 - $ref: '#/components/parameters/isLive'
2330 - $ref: '#/components/parameters/tagsOneOf'
2331 - $ref: '#/components/parameters/tagsAllOf'
2332 - $ref: '#/components/parameters/licenceOneOf'
2333 - $ref: '#/components/parameters/languageOneOf'
2334 - $ref: '#/components/parameters/nsfw'
2335 - $ref: '#/components/parameters/filter'
2336 - $ref: '#/components/parameters/skipCount'
2337 - $ref: '#/components/parameters/start'
2338 - $ref: '#/components/parameters/count'
2339 - $ref: '#/components/parameters/videosSort'
2342 description: successful operation
2346 $ref: '#/components/schemas/VideoListResponse'
2347 '/video-channels/{channelHandle}/avatar/pick':
2349 summary: Update channel avatar
2355 - $ref: '#/components/parameters/channelHandle'
2358 description: successful operation
2365 $ref: '#/components/schemas/ActorImage'
2367 description: image file too large
2369 X-File-Maximum-Size:
2373 description: Maximum file size for the avatar
2376 multipart/form-data:
2381 description: The file to upload.
2386 contentType: image/png, image/jpeg
2387 '/video-channels/{channelHandle}/avatar':
2389 summary: Delete channel avatar
2395 - $ref: '#/components/parameters/channelHandle'
2398 description: successful operation
2401 '/video-channels/{channelHandle}/banner/pick':
2403 summary: Update channel banner
2409 - $ref: '#/components/parameters/channelHandle'
2412 description: successful operation
2419 $ref: '#/components/schemas/ActorImage'
2421 description: image file too large
2423 X-File-Maximum-Size:
2427 description: Maximum file size for the banner
2430 multipart/form-data:
2435 description: The file to upload.
2440 contentType: image/png, image/jpeg
2441 '/video-channels/{channelHandle}/banner':
2443 summary: Delete channel banner
2449 - $ref: '#/components/parameters/channelHandle'
2452 description: successful operation
2454 /video-playlists/privacies:
2456 summary: List available playlist privacy policies
2457 operationId: getPlaylistPrivacyPolicies
2462 description: successful operation
2471 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
2475 summary: List video playlists
2476 operationId: getPlaylists
2480 - $ref: '#/components/parameters/start'
2481 - $ref: '#/components/parameters/count'
2482 - $ref: '#/components/parameters/sort'
2485 description: successful operation
2497 $ref: '#/components/schemas/VideoPlaylist'
2499 summary: Create a video playlist
2500 description: If the video playlist is set as public, `videoChannelId` is mandatory.
2501 operationId: createPlaylist
2508 description: successful operation
2518 $ref: '#/components/schemas/VideoPlaylist/properties/id'
2520 $ref: '#/components/schemas/VideoPlaylist/properties/uuid'
2523 multipart/form-data:
2528 description: Video playlist display name
2533 description: Video playlist thumbnail file
2537 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2539 description: Video playlist description
2545 - $ref: '#/components/schemas/id'
2546 description: Video channel in which the playlist will be published
2551 contentType: image/jpeg
2553 /video-playlists/{id}:
2555 summary: Get a video playlist
2559 - $ref: '#/components/parameters/idOrUUID'
2562 description: successful operation
2566 $ref: '#/components/schemas/VideoPlaylist'
2568 summary: Update a video playlist
2569 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2576 description: successful operation
2578 - $ref: '#/components/parameters/idOrUUID'
2581 multipart/form-data:
2586 description: Video playlist display name
2591 description: Video playlist thumbnail file
2595 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2597 description: Video playlist description
2601 - $ref: '#/components/schemas/id'
2602 description: Video channel in which the playlist will be published
2605 contentType: image/jpeg
2607 summary: Delete a video playlist
2613 - $ref: '#/components/parameters/idOrUUID'
2616 description: successful operation
2618 /video-playlists/{id}/videos:
2620 summary: 'List videos of a playlist'
2625 - $ref: '#/components/parameters/idOrUUID'
2628 description: successful operation
2632 $ref: '#/components/schemas/VideoListResponse'
2634 summary: 'Add a video in a playlist'
2641 - $ref: '#/components/parameters/idOrUUID'
2644 description: successful operation
2650 videoPlaylistElement:
2663 - $ref: '#/components/schemas/Video/properties/id'
2664 description: Video to add in the playlist
2667 description: Start the video at this specific timestamp (in seconds)
2670 description: Stop the video at this specific timestamp (in seconds)
2674 /video-playlists/{id}/videos/reorder:
2676 summary: 'Reorder a playlist'
2682 - $ref: '#/components/parameters/idOrUUID'
2685 description: successful operation
2694 description: 'Start position of the element to reorder'
2696 insertAfterPosition:
2698 description: 'New position for the block to reorder, to add the block before the first element'
2702 description: 'How many element from `startPosition` to reorder'
2706 - insertAfterPosition
2708 /video-playlists/{id}/videos/{playlistElementId}:
2710 summary: 'Update a playlist element'
2716 - $ref: '#/components/parameters/idOrUUID'
2717 - $ref: '#/components/parameters/playlistElementId'
2720 description: successful operation
2729 description: 'Start the video at this specific timestamp (in seconds)'
2732 description: 'Stop the video at this specific timestamp (in seconds)'
2734 summary: 'Delete an element from a playlist'
2740 - $ref: '#/components/parameters/idOrUUID'
2741 - $ref: '#/components/parameters/playlistElementId'
2744 description: successful operation
2746 '/users/me/video-playlists/videos-exist':
2748 summary: 'Check video exists in my playlists'
2757 description: The video ids to check
2761 $ref: '#/components/schemas/Video/properties/id'
2764 description: successful operation
2784 '/accounts/{name}/video-channels':
2786 summary: List video channels of an account
2791 - $ref: '#/components/parameters/name'
2794 description: include view statistics for the last 30 days (only if authentified as the account user)
2797 - $ref: '#/components/parameters/start'
2798 - $ref: '#/components/parameters/count'
2799 - $ref: '#/components/parameters/sort'
2802 description: successful operation
2806 $ref: '#/components/schemas/VideoChannelList'
2807 '/accounts/{name}/ratings':
2809 summary: List ratings of an account
2815 - $ref: '#/components/parameters/name'
2816 - $ref: '#/components/parameters/start'
2817 - $ref: '#/components/parameters/count'
2818 - $ref: '#/components/parameters/sort'
2822 description: Optionally filter which ratings to retrieve
2830 description: successful operation
2836 $ref: '#/components/schemas/VideoRating'
2837 '/videos/{id}/comment-threads':
2839 summary: List threads of a video
2843 - $ref: '#/components/parameters/idOrUUID'
2844 - $ref: '#/components/parameters/start'
2845 - $ref: '#/components/parameters/count'
2846 - $ref: '#/components/parameters/commentsSort'
2849 description: successful operation
2853 $ref: '#/components/schemas/CommentThreadResponse'
2855 summary: Create a thread
2861 - $ref: '#/components/parameters/idOrUUID'
2864 description: successful operation
2868 $ref: '#/components/schemas/CommentThreadPostResponse'
2870 description: video does not exist
2879 description: 'Text comment'
2883 '/videos/{id}/comment-threads/{threadId}':
2885 summary: Get a thread
2889 - $ref: '#/components/parameters/idOrUUID'
2890 - $ref: '#/components/parameters/threadId'
2893 description: successful operation
2897 $ref: '#/components/schemas/VideoCommentThreadTree'
2898 '/videos/{id}/comments/{commentId}':
2900 summary: Reply to a thread of a video
2906 - $ref: '#/components/parameters/idOrUUID'
2907 - $ref: '#/components/parameters/commentId'
2910 description: successful operation
2914 $ref: '#/components/schemas/CommentThreadPostResponse'
2916 description: thread or video does not exist
2924 $ref: '#/components/schemas/VideoComment/properties/text'
2929 summary: Delete a comment or a reply
2935 - $ref: '#/components/parameters/idOrUUID'
2936 - $ref: '#/components/parameters/commentId'
2939 description: successful operation
2941 description: cannot remove comment of another user
2943 description: comment or video does not exist
2945 description: comment is already deleted
2946 '/videos/{id}/rate':
2948 summary: Like/dislike a video
2954 - $ref: '#/components/parameters/idOrUUID'
2957 description: successful operation
2959 description: video does not exist
2964 summary: Search videos
2969 allowEmptyValue: false
2971 String to search. If the user can make a remote URI search, and the string is an URI then the
2972 PeerTube instance will fetch the remote object and add it to its database. Then,
2973 you can use the REST API to fetch the complete video information and interact with it.
2976 - $ref: '#/components/parameters/categoryOneOf'
2977 - $ref: '#/components/parameters/isLive'
2978 - $ref: '#/components/parameters/tagsOneOf'
2979 - $ref: '#/components/parameters/tagsAllOf'
2980 - $ref: '#/components/parameters/licenceOneOf'
2981 - $ref: '#/components/parameters/languageOneOf'
2982 - $ref: '#/components/parameters/nsfw'
2983 - $ref: '#/components/parameters/filter'
2984 - $ref: '#/components/parameters/skipCount'
2985 - $ref: '#/components/parameters/start'
2986 - $ref: '#/components/parameters/count'
2987 - $ref: '#/components/parameters/searchTarget'
2988 - $ref: '#/components/parameters/videosSearchSort'
2991 description: Get videos that are published after this date
2997 description: Get videos that are published before this date
3001 - name: originallyPublishedStartDate
3003 description: Get videos that are originally published after this date
3007 - name: originallyPublishedEndDate
3009 description: Get videos that are originally published before this date
3015 description: Get videos that have this minimum duration
3020 description: Get videos that have this maximum duration
3024 'searchTarget === search-index':
3025 $ref: '#/components/callbacks/searchIndex'
3028 description: successful operation
3032 $ref: '#/components/schemas/VideoListResponse'
3034 description: search index unavailable
3035 /search/video-channels:
3039 summary: Search channels
3045 String to search. If the user can make a remote URI search, and the string is an URI then the
3046 PeerTube instance will fetch the remote object and add it to its database. Then,
3047 you can use the REST API to fetch the complete channel information and interact with it.
3050 - $ref: '#/components/parameters/start'
3051 - $ref: '#/components/parameters/count'
3052 - $ref: '#/components/parameters/searchTarget'
3053 - $ref: '#/components/parameters/sort'
3055 'searchTarget === search-index':
3056 $ref: '#/components/callbacks/searchIndex'
3059 description: successful operation
3063 $ref: '#/components/schemas/VideoChannelList'
3065 description: search index unavailable
3066 /blocklist/accounts:
3070 summary: List account blocks
3075 - $ref: '#/components/parameters/start'
3076 - $ref: '#/components/parameters/count'
3077 - $ref: '#/components/parameters/sort'
3080 description: successful operation
3084 summary: Block an account
3096 example: chocobozzz@example.org
3097 description: account to block, in the form `username@domain`
3102 description: successful operation
3104 description: self-blocking forbidden
3105 '/blocklist/accounts/{accountName}':
3109 summary: Unblock an account by its handle
3117 description: account to unblock, in the form `username@domain`
3122 description: successful operation
3124 description: account or account block does not exist
3129 summary: List server blocks
3134 - $ref: '#/components/parameters/start'
3135 - $ref: '#/components/parameters/count'
3136 - $ref: '#/components/parameters/sort'
3139 description: successful operation
3143 summary: Block a server
3156 description: server domain to block
3161 description: successful operation
3163 description: self-blocking forbidden
3164 '/blocklist/servers/{host}':
3168 summary: Unblock a server by its domain
3176 description: server domain to unblock
3182 description: successful operation
3184 description: account block does not exist
3188 - Instance Redundancy
3189 summary: Update a server redundancy policy
3197 description: server domain to mirror
3209 description: allow mirroring of the host's local videos
3214 description: successful operation
3216 description: server is not already known
3221 summary: List videos being mirrored
3229 description: direction of the mirror
3235 - $ref: '#/components/parameters/start'
3236 - $ref: '#/components/parameters/count'
3237 - $ref: '#/components/parameters/videoRedundanciesSort'
3240 description: successful operation
3246 $ref: '#/components/schemas/VideoRedundancy'
3250 summary: Mirror a video
3261 $ref: '#/components/schemas/Video/properties/id'
3266 description: successful operation
3268 description: cannot mirror a local video
3270 description: video does not exist
3272 description: video is already mirrored
3273 /redundancy/videos/{redundancyId}:
3277 summary: Delete a mirror done on a video
3282 - name: redundancyId
3285 description: id of an existing redundancy on a video
3290 description: successful operation
3292 description: video redundancy not found
3293 '/feeds/video-comments.{format}':
3297 summary: List comments on videos
3302 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3315 description: 'limit listing to a specific video'
3320 description: 'limit listing to a specific account'
3325 description: 'limit listing to a specific account'
3328 - name: videoChannelId
3330 description: 'limit listing to a specific video channel'
3333 - name: videoChannelName
3335 description: 'limit listing to a specific video channel'
3340 description: successful operation
3345 default: 'max-age=900' # 15 min cache
3349 $ref: '#/components/schemas/VideoCommentsForXML'
3352 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3353 application/rss+xml:
3355 $ref: '#/components/schemas/VideoCommentsForXML'
3358 externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
3361 $ref: '#/components/schemas/VideoCommentsForXML'
3364 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3365 application/atom+xml:
3367 $ref: '#/components/schemas/VideoCommentsForXML'
3370 externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
3376 externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local
3378 x-summary: field inconsistencies
3381 - videoId filter is mixed with a channel filter
3383 description: video, video channel or account not found
3385 description: accept header unsupported
3386 '/feeds/videos.{format}':
3390 summary: List videos
3395 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3408 description: 'limit listing to a specific account'
3413 description: 'limit listing to a specific account'
3416 - name: videoChannelId
3418 description: 'limit listing to a specific video channel'
3421 - name: videoChannelName
3423 description: 'limit listing to a specific video channel'
3426 - $ref: '#/components/parameters/sort'
3427 - $ref: '#/components/parameters/nsfw'
3428 - $ref: '#/components/parameters/filter'
3431 description: successful operation
3436 default: 'max-age=900' # 15 min cache
3440 $ref: '#/components/schemas/VideosForXML'
3443 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3444 application/rss+xml:
3446 $ref: '#/components/schemas/VideosForXML'
3449 externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local
3452 $ref: '#/components/schemas/VideosForXML'
3455 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3456 application/atom+xml:
3458 $ref: '#/components/schemas/VideosForXML'
3461 externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local
3467 externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local
3469 description: video channel or account not found
3471 description: accept header unsupported
3472 '/feeds/subscriptions.{format}':
3477 summary: List videos of subscriptions tied to a token
3482 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3495 description: limit listing to a specific account
3501 description: private token allowing access
3505 - $ref: '#/components/parameters/sort'
3506 - $ref: '#/components/parameters/nsfw'
3507 - $ref: '#/components/parameters/filter'
3510 description: successful operation
3515 default: 'max-age=900' # 15 min cache
3519 $ref: '#/components/schemas/VideosForXML'
3520 application/rss+xml:
3522 $ref: '#/components/schemas/VideosForXML'
3525 $ref: '#/components/schemas/VideosForXML'
3526 application/atom+xml:
3528 $ref: '#/components/schemas/VideosForXML'
3533 description: accept header unsupported
3538 summary: List plugins
3551 - $ref: '#/components/parameters/start'
3552 - $ref: '#/components/parameters/count'
3553 - $ref: '#/components/parameters/sort'
3556 description: successful operation
3560 $ref: '#/components/schemas/PluginResponse'
3565 summary: List available plugins
3578 - name: currentPeerTubeEngine
3582 - $ref: '#/components/parameters/start'
3583 - $ref: '#/components/parameters/count'
3584 - $ref: '#/components/parameters/sort'
3587 description: successful operation
3591 $ref: '#/components/schemas/PluginResponse'
3593 description: plugin index unavailable
3598 summary: Install a plugin
3611 example: peertube-plugin-auth-ldap
3614 additionalProperties: false
3621 additionalProperties: false
3624 description: successful operation
3626 description: should have either `npmName` or `path` set
3631 summary: Update a plugin
3644 example: peertube-plugin-auth-ldap
3647 additionalProperties: false
3654 additionalProperties: false
3657 description: successful operation
3659 description: should have either `npmName` or `path` set
3661 description: existing plugin not found
3666 summary: Uninstall a plugin
3678 description: name of the plugin/theme in its package.json
3679 example: peertube-plugin-auth-ldap
3684 description: successful operation
3686 description: existing plugin not found
3691 summary: Get a plugin
3696 - $ref: '#/components/parameters/npmName'
3699 description: successful operation
3703 $ref: '#/components/schemas/Plugin'
3705 description: plugin not found
3706 /plugins/{npmName}/settings:
3710 summary: Set a plugin's settings
3715 - $ref: '#/components/parameters/npmName'
3724 additionalProperties: true
3727 description: successful operation
3729 description: plugin not found
3730 /plugins/{npmName}/public-settings:
3734 summary: Get a plugin's public settings
3736 - $ref: '#/components/parameters/npmName'
3739 description: successful operation
3744 additionalProperties: true
3746 description: plugin not found
3747 /plugins/{npmName}/registered-settings:
3751 summary: Get a plugin's registered settings
3756 - $ref: '#/components/parameters/npmName'
3759 description: successful operation
3764 additionalProperties: true
3766 description: plugin not found
3768 - url: 'https://peertube2.cpy.re/api/v1'
3769 description: Live Test Server (live data - latest nightly version)
3770 - url: 'https://peertube3.cpy.re/api/v1'
3771 description: Live Test Server (live data - latest RC version)
3772 - url: 'https://peertube.cpy.re/api/v1'
3773 description: Live Test Server (live data - stable version)
3780 description: Offset used to paginate results
3788 description: "Number of items to return"
3798 description: Sort column
3806 description: Plain text search, applied to various parts of the model depending on endpoint
3814 If the administrator enabled search index support, you can override the default search target.
3817 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3818 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3819 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3820 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3821 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3822 * 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
3823 the data from the origin instance API
3833 description: Sort videos by criteria
3849 description: Sort videos by criteria
3864 description: Sort comments by criteria
3874 description: Sort blacklists by criteria
3890 description: Plain text search that will match with user usernames or emails
3897 description: Filter results down to (un)banned users
3904 description: Sort users by criteria
3915 description: Sort abuses by criteria
3922 videoRedundanciesSort:
3926 description: Sort abuses by criteria
3935 description: The username or handle of the account
3938 example: chocobozzz | chocobozzz@example.org
3943 description: The user id
3945 $ref: '#/components/schemas/id'
3950 description: The object id or uuid
3953 - $ref: '#/components/schemas/id'
3954 - $ref: '#/components/schemas/UUIDv4'
3956 name: playlistElementId
3959 description: Playlist element id
3961 $ref: '#/components/schemas/id'
3966 description: Abuse id
3968 $ref: '#/components/schemas/Abuse/properties/id'
3970 name: abuseMessageId
3973 description: Abuse message id
3975 $ref: '#/components/schemas/AbuseMessage/properties/id'
3977 name: captionLanguage
3980 description: The caption language
3982 $ref: '#/components/schemas/VideoLanguageSet'
3987 description: The video channel handle
3990 example: my_username | my_username@example.com
3992 name: subscriptionHandle
3995 description: The subscription handle
3998 example: my_username | my_username@example.com
4003 description: The thread id (root comment id)
4005 $ref: '#/components/schemas/VideoCommentThreadTree/properties/comment/properties/id'
4010 description: The comment id
4012 $ref: '#/components/schemas/VideoComment/properties/id'
4017 description: whether or not the video is a live
4024 description: category id of the video (see [/videos/categories](#operation/getCategories))
4027 - $ref: '#/components/schemas/VideoCategorySet'
4030 $ref: '#/components/schemas/VideoCategorySet'
4037 description: tag(s) of the video
4051 description: tag(s) of the video, where all should be present in the video
4064 description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
4067 - $ref: '#/components/schemas/VideoLanguageSet'
4070 $ref: '#/components/schemas/VideoLanguageSet'
4077 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4080 - $ref: '#/components/schemas/VideoLicenceSet'
4083 $ref: '#/components/schemas/VideoLicenceSet'
4090 description: if you don't need the `total` in the response
4101 description: whether to include nsfw videos, if any
4112 Special filters which might require special rights:
4113 * `local` - only videos local to the instance
4114 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
4115 * `all` - all videos, showing private and unlisted videos (requires Admin privileges)
4125 description: list of uris to check if each is part of the user subscriptions
4135 description: name of the plugin/theme on npmjs.com or in its package.json
4138 example: peertube-plugin-auth-ldap
4143 description: job type
4147 - activitypub-follow
4148 - activitypub-http-broadcast
4149 - activitypub-http-fetcher
4150 - activitypub-http-unicast
4156 - activitypub-refresher
4162 Authenticating via OAuth requires the following steps:
4163 - Have an activated account
4164 - [Generate](https://docs.joinpeertube.org/api-rest-getting-started) a
4165 Bearer Token for that account at `/api/v1/users/token`
4166 - Make authenticated requests, putting *Authorization: Bearer <token\>*
4167 - Profit, depending on the role assigned to the account
4169 Note that the __access token is valid for 1 day__ and, and is given
4170 along with a __refresh token valid for 2 weeks__.
4174 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
4177 moderator: Moderator scope
4180 # Resuable core properties
4188 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4189 pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
4194 description: The username of the user
4196 pattern: '/^[a-z0-9._]{1,50}$/'
4201 description: The username for the default channel
4202 example: The Capybara Channel
4203 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4207 description: The password of the user
4213 description: category id of the video (see [/videos/categories](#operation/getCategories))
4215 VideoConstantNumber-Category:
4218 $ref: '#/components/schemas/VideoCategorySet'
4221 example: Science & Technology
4225 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4227 VideoConstantNumber-Licence:
4230 $ref: '#/components/schemas/VideoLicenceSet'
4233 example: Attribution - Share Alike
4237 description: language id of the video (see [/videos/languages](#operation/getLanguages))
4239 VideoConstantString-Language:
4242 $ref: '#/components/schemas/VideoLanguageSet'
4247 VideoPlaylistPrivacySet:
4253 description: Video playlist privacy policy (see [/video-playlists/privacies])
4254 VideoPlaylistPrivacyConstant:
4257 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
4261 VideoPlaylistTypeSet:
4266 description: The video playlist type (Regular = `1`, Watch Later = `2`)
4267 VideoPlaylistTypeConstant:
4270 $ref: '#/components/schemas/VideoPlaylistTypeSet'
4281 description: privacy id of the video (see [/videos/privacies](#operation/getPrivacyPolicies))
4282 VideoPrivacyConstant:
4285 $ref: '#/components/schemas/VideoPrivacySet'
4302 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
4309 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
4320 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
4330 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
4334 $ref: '#/components/schemas/AbuseStateSet'
4337 AbusePredefinedReasons:
4350 example: [spamOrMisleading]
4355 Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
4357 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
4359 VideoResolutionConstant:
4360 description: resolutions and their labels for the video
4363 $ref: '#/components/schemas/VideoResolutionSet'
4367 VideoScheduledUpdate:
4370 $ref: '#/components/schemas/VideoPrivacySet'
4374 description: When to update the video
4394 - $ref: '#/components/schemas/ActorImage'
4395 VideoChannelSummary:
4398 $ref: '#/components/schemas/id'
4412 - $ref: '#/components/schemas/ActorImage'
4424 - $ref: '#/components/schemas/Video'
4431 description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
4432 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
4433 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4435 $ref: '#/components/schemas/VideoResolutionConstant'
4438 description: Video file size in bytes
4441 description: Direct URL of the torrent file
4445 description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
4449 description: Direct URL of the video
4453 description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
4457 description: Frames per second of the video file
4461 description: URL dereferencing the output of ffprobe on the file
4462 VideoStreamingPlaylists:
4467 $ref: '#/components/schemas/id'
4475 - $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'
4476 VideoStreamingPlaylists-HLS:
4487 Video files associated to this playlist.
4489 The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
4491 $ref: '#/components/schemas/VideoFile'
4503 $ref: '#/components/schemas/Video/properties/id'
4505 $ref: '#/components/schemas/Video/properties/uuid'
4507 $ref: '#/components/schemas/Video/properties/name'
4511 description: object id for the video
4513 - $ref: '#/components/schemas/id'
4515 description: universal identifier for the video, that can be used across instances
4517 - $ref: '#/components/schemas/UUIDv4'
4523 example: 2017-10-01T10:52:46.396Z
4524 description: time at which the video object was first drafted
4528 example: 2018-10-01T10:52:46.396Z
4529 description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
4533 example: 2021-05-04T08:01:01.502Z
4534 description: last time the video's metadata was modified
4535 originallyPublishedAt:
4538 example: 2010-10-01T10:52:46.396Z
4539 description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
4542 - $ref: '#/components/schemas/VideoConstantNumber-Category'
4543 description: category in which the video is classified
4546 - $ref: '#/components/schemas/VideoConstantNumber-Licence'
4547 description: licence under which the video is distributed
4550 - $ref: '#/components/schemas/VideoConstantString-Language'
4551 description: main language used in the video
4554 - $ref: '#/components/schemas/VideoPrivacyConstant'
4555 description: privacy policy used to distribute the video
4559 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
4560 **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
4564 truncated description of the video, written in Markdown.
4565 Resolve `descriptionPath` to get the full description of maximum `10000` characters.
4569 description: duration of the video in seconds
4574 description: title of the video
4575 example: What is PeerTube?
4580 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4583 example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4586 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
4603 - $ref: '#/components/schemas/VideoStateConstant'
4604 description: represents the internal state of the video processing within the PeerTube instance
4608 - $ref: '#/components/schemas/VideoScheduledUpdate'
4616 $ref: '#/components/schemas/AccountSummary'
4618 $ref: '#/components/schemas/VideoChannelSummary'
4627 - $ref: '#/components/schemas/Video'
4632 example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
4633 description: path at which to get the full description of maximum `10000` characters
4636 description: A text tell the audience how to support the video creator
4637 example: Please support my work on <insert crowdfunding plateform>! <3
4641 $ref: '#/components/schemas/VideoChannel'
4643 $ref: '#/components/schemas/Account'
4645 example: [flowers, gardening]
4663 - https://peertube2.cpy.re/tracker/announce
4664 - wss://peertube2.cpy.re/tracker/socket
4668 $ref: '#/components/schemas/VideoFile'
4670 WebTorrent/raw video files. If WebTorrent is disabled on the server:
4672 - field will be empty
4673 - video files will be found in `streamingPlaylists[].files` field
4677 $ref: '#/components/schemas/VideoStreamingPlaylists'
4679 HLS playlists/manifest files. If HLS is disabled on the server:
4681 - field will be empty
4682 - video files will be found in `files` field
4683 FileRedundancyInformation:
4686 $ref: '#/components/schemas/id'
4711 $ref: '#/components/schemas/id'
4718 $ref: '#/components/schemas/UUIDv4'
4725 $ref: '#/components/schemas/FileRedundancyInformation'
4729 $ref: '#/components/schemas/FileRedundancyInformation'
4730 VideoImportStateConstant:
4738 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
4745 additionalProperties: false
4749 $ref: '#/components/schemas/VideoImport/properties/targetUrl'
4750 required: [targetUrl]
4753 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
4754 required: [magnetUri]
4757 $ref: '#/components/schemas/VideoImport/properties/torrentfile'
4758 required: [torrentfile]
4759 - $ref: '#/components/schemas/VideoUploadRequestCommon'
4768 - $ref: '#/components/schemas/id'
4772 description: remote URL where to find the import's source video
4773 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4777 description: magnet URI allowing to resolve the import's source video
4778 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
4779 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4784 description: Torrent file containing only the video file
4791 - $ref: '#/components/schemas/VideoImportStateConstant'
4807 - $ref: '#/components/schemas/Video'
4817 $ref: '#/components/schemas/VideoImport'
4821 $ref: '#/components/schemas/id'
4824 example: The video is a spam
4828 $ref: '#/components/schemas/AbusePredefinedReasons'
4830 $ref: '#/components/schemas/Account'
4832 $ref: '#/components/schemas/AbuseStateConstant'
4835 example: Decided to ban the server since it spams us regularly
4839 $ref: '#/components/schemas/VideoInfo'
4846 $ref: '#/components/schemas/id'
4857 $ref: '#/components/schemas/AccountSummary'
4861 $ref: '#/components/schemas/id'
4863 $ref: '#/components/schemas/Video/properties/id'
4875 $ref: '#/components/schemas/UUIDv4'
4893 $ref: '#/components/schemas/id'
4895 $ref: '#/components/schemas/UUIDv4'
4918 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4920 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4922 $ref: '#/components/schemas/AccountSummary'
4924 $ref: '#/components/schemas/VideoChannelSummary'
4928 $ref: '#/components/schemas/id'
4934 description: Text of the comment in Markdown
4940 $ref: '#/components/schemas/id'
4942 $ref: '#/components/schemas/Video/properties/id'
4949 totalRepliesFromVideoAuthor:
4956 $ref: '#/components/schemas/Account'
4957 VideoCommentThreadTree:
4960 $ref: '#/components/schemas/VideoComment'
4964 $ref: '#/components/schemas/VideoCommentThreadTree'
4968 $ref: '#/components/schemas/VideoConstantString-Language'
4984 $ref: '#/components/schemas/id'
5001 $ref: '#/components/schemas/id'
5006 description: immutable name of the actor
5008 - $ref: '#/components/schemas/username'
5012 description: server on which the actor is resident
5013 hostRedundancyAllowed:
5015 description: whether this actor's host allows redundancy of its videos
5019 description: number of actors subscribed to by this actor, as seen by this instance
5023 description: number of followers of this actor, as seen by this instance
5031 $ref: '#/components/schemas/ActorImage'
5034 - $ref: '#/components/schemas/Actor'
5037 description: object id for the user tied to this account
5039 - $ref: '#/components/schemas/User/properties/id'
5042 description: name displayed on the account's profile
5045 description: text or bio displayed on the account's profile
5050 description: timestamp within the video, in seconds
5117 allowedForCurrentIP:
5119 requiresEmailVerification:
5137 $ref: '#/components/schemas/VideoResolutionSet'
5222 example: 16810141515
5325 requiresEmailVerification:
5340 description: Settings that apply to new users, if registration is enabled
5344 example: 16810141515
5350 description: Settings pertaining to transcoding jobs
5354 allowAdditionalExtensions:
5356 description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
5359 description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
5362 description: Amount of threads used by ffmpeg for 1 transcoding job
5365 description: Amount of transcoding jobs to execute in parallel
5371 New profiles can be added by plugins ; available in core PeerTube: 'default'.
5374 description: Resolutions to transcode _new videos_ to
5394 description: WebTorrent-specific settings
5400 description: HLS-specific settings
5444 $ref: '#/components/schemas/id'
5446 $ref: '#/components/schemas/Actor'
5448 $ref: '#/components/schemas/Actor'
5451 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
5464 PredefinedAbuseReasons:
5465 description: Reason categories that help triage reports
5483 $ref: '#/components/schemas/id'
5495 - activitypub-http-unicast
5496 - activitypub-http-broadcast
5497 - activitypub-http-fetcher
5498 - activitypub-follow
5504 - activitypub-refresher
5508 additionalProperties: true
5511 additionalProperties: true
5527 $ref: '#/components/schemas/id'
5532 $ref: '#/components/schemas/id'
5533 VideoUploadRequestCommon:
5536 description: Video name
5538 example: What is PeerTube?
5542 description: Channel id that will contain this video
5547 $ref: '#/components/schemas/VideoPrivacySet'
5549 $ref: '#/components/schemas/VideoCategorySet'
5551 $ref: '#/components/schemas/VideoLicenceSet'
5553 $ref: '#/components/schemas/VideoLanguageSet'
5555 description: Video description
5558 **[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)**
5560 description: Whether or not we wait transcoding before publish the video
5563 description: A text tell the audience how to support the video creator
5564 example: Please support my work on <insert crowdfunding plateform>! <3
5567 description: Whether or not this video contains sensitive content
5570 description: Video tags (maximum 5 tags each between 2 and 30 characters)
5583 description: Enable or disable comments for this video
5586 description: Enable or disable downloading for this video
5588 originallyPublishedAt:
5589 description: Date when the content was originally published
5593 $ref: '#/components/schemas/VideoScheduledUpdate'
5595 description: Video thumbnail file
5599 description: Video preview file
5605 VideoUploadRequestLegacy:
5607 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5613 description: Video file
5616 VideoUploadRequestResumable:
5618 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5624 description: Video filename including extension
5627 example: what_is_peertube.mp4
5629 description: Video thumbnail file
5633 description: Video preview file
5636 VideoUploadResponse:
5642 $ref: '#/components/schemas/Video/properties/id'
5644 $ref: '#/components/schemas/Video/properties/uuid'
5645 CommentThreadResponse:
5654 $ref: '#/components/schemas/VideoComment'
5655 CommentThreadPostResponse:
5658 $ref: '#/components/schemas/VideoComment'
5668 $ref: '#/components/schemas/Video'
5672 $ref: '#/components/schemas/Account'
5675 description: Automatically start playing the upcoming video after the currently playing video
5676 autoPlayNextVideoPlaylist:
5678 description: Automatically start playing the video on the playlist after the currently playing video
5681 description: Automatically start playing the video on the watch page
5691 description: The user email
5694 description: Has the user confirmed their email address?
5697 - $ref: '#/components/schemas/id'
5701 description: Auth plugin to use to authenticate the user
5705 noInstanceConfigWarningModal:
5710 $ref: '#/components/schemas/NSFWPolicy'
5712 $ref: '#/components/schemas/UserRole'
5721 description: Theme enabled by this user
5723 $ref: '#/components/schemas/username'
5727 $ref: '#/components/schemas/VideoChannel'
5730 description: The user video quota in bytes
5734 description: The user daily video quota in bytes
5738 description: Enable P2P in the player
5741 - $ref: '#/components/schemas/User'
5743 # optionally present fields: they require WITH_STATS scope
5746 description: Count of videos published
5749 description: Count of reports/abuses of which the user is a target
5750 abusesAcceptedCount:
5752 description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team
5755 description: Count of reports/abuses created by the user
5758 description: Count of comments published
5762 $ref: '#/components/schemas/username'
5764 $ref: '#/components/schemas/password'
5768 description: The user email
5771 description: The user video quota in bytes
5775 description: The user daily video quota in bytes
5778 $ref: '#/components/schemas/usernameChannel'
5780 $ref: '#/components/schemas/UserRole'
5782 $ref: '#/components/schemas/UserAdminFlags'
5795 description: The updated email of the user
5798 description: Set the email as verified
5801 description: The updated video quota of the user in bytes
5804 description: The updated daily video quota of the user in bytes
5808 description: The auth plugin to use to authenticate the user
5809 example: 'peertube-plugin-auth-saml2'
5811 $ref: '#/components/schemas/UserRole'
5813 $ref: '#/components/schemas/UserAdminFlags'
5817 $ref: '#/components/schemas/password'
5821 description: Your new email
5824 description: Your new displayNSFW
5831 description: Your new autoPlayVideo
5840 $ref: '#/components/schemas/id'
5847 description: Rating of the video
5854 $ref: '#/components/schemas/Video'
5861 description: Rating of the video
5868 $ref: '#/components/schemas/username'
5870 $ref: '#/components/schemas/password'
5874 description: The email of the user
5877 description: The user display name
5884 $ref: '#/components/schemas/usernameChannel'
5887 description: The display name for the default channel
5897 # GET/POST/PUT properties
5900 example: Videos of Framasoft
5905 example: Videos made with <3 by Framasoft
5910 description: text shown by default on all videos of this channel, to tell the audience how to support it
5911 example: Please support my work on <insert crowdfunding plateform>! <3
5914 # GET-only properties
5918 - $ref: '#/components/schemas/id'
5934 $ref: '#/components/schemas/UUIDv4'
5937 - $ref: '#/components/schemas/VideoChannel'
5940 description: username of the channel to create
5942 - $ref: '#/components/schemas/usernameChannel'
5948 - $ref: '#/components/schemas/VideoChannel'
5950 bulkVideosSupportUpdate:
5952 description: Update the support field for all videos of this channel
5962 - $ref: '#/components/schemas/VideoChannel'
5963 - $ref: '#/components/schemas/Actor'
5968 name: 'media:peerLink'
5977 - application/x-bittorrent
5983 name: 'media:content'
6014 VideoCommentsForXML:
6049 description: video watch page URL
6052 description: video canonical URL
6056 description: video publication date
6059 description: video description
6062 description: video description
6065 description: publisher user name
6068 description: video category (MRSS)
6071 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
6086 description: video embed path, relative to the canonical URL domain (MRSS)
6095 description: video watch path, relative to the canonical URL domain (MRSS)
6116 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
6117 'media:description':
6124 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
6127 description: main streamable file for the video
6137 - application/x-bittorrent
6146 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)
6149 - $ref: '#/components/schemas/MRSSPeerLink'
6150 - $ref: '#/components/schemas/MRSSGroupContent'
6151 NotificationSettingValue:
6168 $ref: '#/components/schemas/id'
6172 Notification type, following the `UserNotificationType` enum:
6174 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
6176 - `2` NEW_COMMENT_ON_MY_VIDEO
6178 - `3` NEW_ABUSE_FOR_MODERATORS
6180 - `4` BLACKLIST_ON_MY_VIDEO
6182 - `5` UNBLACKLIST_ON_MY_VIDEO
6184 - `6` MY_VIDEO_PUBLISHED
6186 - `7` MY_VIDEO_IMPORT_SUCCESS
6188 - `8` MY_VIDEO_IMPORT_ERROR
6190 - `9` NEW_USER_REGISTRATION
6194 - `11` COMMENT_MENTION
6196 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
6198 - `13` NEW_INSTANCE_FOLLOWER
6200 - `14` AUTO_INSTANCE_FOLLOWING
6206 - $ref: '#/components/schemas/VideoInfo'
6210 $ref: '#/components/schemas/ActorInfo'
6216 $ref: '#/components/schemas/id'
6219 $ref: '#/components/schemas/VideoInfo'
6224 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
6234 $ref: '#/components/schemas/id'
6238 $ref: '#/components/schemas/VideoInfo'
6240 $ref: '#/components/schemas/ActorInfo'
6246 $ref: '#/components/schemas/id'
6249 - $ref: '#/components/schemas/VideoInfo'
6255 $ref: '#/components/schemas/id'
6258 - $ref: '#/components/schemas/VideoInfo'
6262 - $ref: '#/components/schemas/ActorInfo'
6268 $ref: '#/components/schemas/id'
6270 $ref: '#/components/schemas/ActorInfo'
6298 NotificationListResponse:
6307 $ref: '#/components/schemas/Notification'
6312 example: peertube-plugin-auth-ldap
6340 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
6343 additionalProperties: true
6359 $ref: '#/components/schemas/Plugin'
6366 description: User can stream multiple times in a permanent live
6375 description: RTMP stream key to use to stream into this live video
6379 description: User can stream multiple times in a permanent live
6386 'https://search.example.org/api/v1/search/videos':
6388 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
6391 description: successful operation
6395 $ref: '#/components/schemas/VideoListResponse'