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 Validation errors benefit from a more detailed error type and return the HTTP `400 Bad Request` status code.
55 "id": { // where 'id' is the name of the parameter concerned by the error.
56 "value": "a117eb-c6a9-4756-bb09-2a956239f", // value that triggered the error.
57 "msg": "Should have an valid id", // error debug message
59 "location": "params" // 'params', 'body', 'header', 'query' or 'cookies'
67 We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
69 | Endpoint | Calls | Time frame |
70 |-------------------------|------------------|---------------------------|
71 | `/*` | 50 | 10 seconds |
72 | `POST /users/token` | 15 | 5 minutes |
73 | `POST /users/register` | 2<sup>*</sup> | 5 minutes |
74 | `POST /users/ask-send-verify-email` | 3 | 5 minutes |
76 Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
77 limit is announced by a `429 Too Many Requests` status code.
79 You can get details about the current state of your rate limit by reading the
82 | Header | Description |
83 |-------------------------|------------------------------------------------------------|
84 | `X-RateLimit-Limit` | Number of max requests allowed in the current time period |
85 | `X-RateLimit-Remaining` | Number of remaining requests in the current time period |
86 | `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp |
87 | `Retry-After` | Seconds to delay after the first `429` is received |
89 url: https://docs.joinpeertube.org/api-rest-reference.html
93 Accounts encompass remote accounts discovered across the federation,
94 and correspond to the main Actor, along with video channels a user can create, which
97 When a comment is posted, it is done with your Account's Actor.
100 Using some features of PeerTube require authentication, for which User
101 provide different levels of permission as well as associated user
102 information. Each user has a corresponding local Account for federation.
105 Operations related to your own User, when logged-in.
106 - name: My Subscriptions
108 Operations related to your subscriptions to video channels, their
109 new videos, and how to keep up to date with their latest publications!
112 Operations related to your watch history.
113 - name: My Notifications
115 Notifications following new videos, follows or reports. They allow you
116 to keep track of the interactions and overall important information that
117 concerns you. You MAY set per-notification type delivery preference, to
118 receive the info either by mail, by in-browser notification or both.
121 Each server exposes public information regarding supported videos and
125 Jobs are long-running tasks enqueued and processed by the instance
126 itself. No additional worker registration is currently available.
127 - name: Instance Follows
129 Managing servers which the instance interacts with is crucial to the
130 concept of federation in PeerTube and external video indexation. The PeerTube
131 server then deals with inter-server ActivityPub operations and propagates
132 information across its social graph by posting activities to actors' inbox
135 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows
136 - name: Instance Redundancy
138 Redundancy is part of the inter-server solidarity that PeerTube fosters.
139 Manage the list of instances you wish to help by seeding their videos according
140 to the policy of video selection of your choice. Note that you have a similar functionality
141 to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
143 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy
146 Managing plugins installed from a local path or from NPM, or search for new ones.
148 url: https://docs.joinpeertube.org/api-plugins
151 Abuses deal with reports of local or remote videos/comments/accounts alike.
154 Operations dealing with listing, uploading, fetching or modifying videos.
157 Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
161 - [_legacy_](#operation/uploadLegacy), where the video file is sent in a single request
162 - [_resumable_](#operation/uploadResumableInit), where the video file is sent in chunks
164 You can upload videos more reliably by using the resumable variant. Its protocol lets
165 you resume an upload operation after a network interruption or other transmission failure,
166 saving time and bandwidth in the event of network failures.
168 Favor using resumable uploads in any of the following cases:
169 - You are transferring large files
170 - The likelihood of a network interruption is high
171 - Uploads are originating from a device with a low-bandwidth or unstable Internet connection,
172 such as a mobile device
176 - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
177 - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file
178 - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file
180 The import function is practical when the desired video/audio is available online. It makes PeerTube
181 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
182 - name: Video Captions
183 description: Operations dealing with listing, adding and removing closed captions of a video.
184 - name: Video Channels
185 description: Operations dealing with the creation, modification and listing of videos within a channel.
186 - name: Video Comments
188 Operations dealing with comments to a video. Comments are organized in threads: adding a
189 comment in response to the video starts a thread, adding a reply to a comment adds it to
190 its root comment thread.
192 description: Operations dealing with blocking videos (removing them from view and preventing interactions).
194 description: Like/dislike a video.
195 - name: Video Playlists
196 description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
198 description: Server syndication feeds
201 The search helps to find _videos_ or _channels_ from within the instance and beyond.
202 Videos from other instances federated by the instance (that is, instances
203 followed by the instance) can be found via keywords and other criteria of
206 Administrators can also enable the use of a remote search system, indexing
207 videos and channels not could be not federated by the instance.
208 - name: Video Mirroring
210 PeerTube instances can mirror videos from one another, and help distribute some videos.
212 For importing videos as your own, refer to [video imports](#operation/importVideo).
231 - Video Ownership Change
244 - name: Instance Configuration
248 - Instance Redundancy
258 summary: Get an account
260 - $ref: '#/components/parameters/name'
263 description: successful operation
267 $ref: '#/components/schemas/Account'
269 description: account not found
270 '/accounts/{name}/videos':
275 summary: 'List videos of an account'
277 - $ref: '#/components/parameters/name'
278 - $ref: '#/components/parameters/categoryOneOf'
279 - $ref: '#/components/parameters/isLive'
280 - $ref: '#/components/parameters/tagsOneOf'
281 - $ref: '#/components/parameters/tagsAllOf'
282 - $ref: '#/components/parameters/licenceOneOf'
283 - $ref: '#/components/parameters/languageOneOf'
284 - $ref: '#/components/parameters/nsfw'
285 - $ref: '#/components/parameters/filter'
286 - $ref: '#/components/parameters/skipCount'
287 - $ref: '#/components/parameters/start'
288 - $ref: '#/components/parameters/count'
289 - $ref: '#/components/parameters/videosSort'
292 description: successful operation
296 $ref: '#/components/schemas/VideoListResponse'
300 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
301 .then(function(response) {
302 return response.json()
303 }).then(function(data) {
309 curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
315 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
317 http = Net::HTTP.new(uri.host, uri.port)
320 response = http.get(uri.request_uri)
322 puts JSON.parse(response.read_body)
327 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
335 summary: List accounts
337 - $ref: '#/components/parameters/start'
338 - $ref: '#/components/parameters/count'
339 - $ref: '#/components/parameters/sort'
342 description: successful operation
348 $ref: '#/components/schemas/Account'
353 summary: Get instance public configuration
356 description: successful operation
360 $ref: '#/components/schemas/ServerConfig'
363 externalValue: https://peertube2.cpy.re/api/v1/config
366 summary: Get instance "About" information
371 description: successful operation
375 $ref: '#/components/schemas/ServerConfigAbout'
378 externalValue: https://peertube2.cpy.re/api/v1/config/about
381 summary: Get instance runtime configuration
389 description: successful operation
393 $ref: '#/components/schemas/ServerConfigCustom'
395 summary: Set instance runtime configuration
403 description: successful operation
405 x-summary: field inconsistencies
408 - the emailer is disabled and the instance is open to registrations
409 - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
411 summary: Delete instance runtime configuration
419 description: successful operation
422 summary: List instance jobs
432 description: The state of the job ('' for for no filter)
442 - $ref: '#/components/parameters/jobType'
443 - $ref: '#/components/parameters/start'
444 - $ref: '#/components/parameters/count'
445 - $ref: '#/components/parameters/sort'
448 description: successful operation
461 $ref: '#/components/schemas/Job'
462 '/server/following/{host}':
469 summary: Unfollow a server
474 description: 'The host to unfollow '
480 description: successful operation
485 summary: List instance followers
487 - $ref: '#/components/parameters/start'
488 - $ref: '#/components/parameters/count'
489 - $ref: '#/components/parameters/sort'
492 description: successful operation
498 $ref: '#/components/schemas/Follow'
503 summary: List instances followed by the server
522 - $ref: '#/components/parameters/start'
523 - $ref: '#/components/parameters/count'
524 - $ref: '#/components/parameters/sort'
527 description: successful operation
533 $ref: '#/components/schemas/Follow'
540 summary: Follow a server
543 description: successful operation
545 description: cannot follow a non-HTTPS server
560 summary: Create a user
568 description: user created
572 $ref: '#/components/schemas/AddUserResponse'
576 operationId: getUserId
578 id: '$response.body#/user/id'
581 operationId: putUserId
583 id: '$response.body#/user/id'
586 operationId: delUserId
588 id: '$response.body#/user/id'
590 description: insufficient authority to create an admin or moderator
595 $ref: '#/components/schemas/AddUser'
597 If the smtp server is configured, you can leave the password empty and an email will be sent
598 asking the user to set it first.
608 - $ref: '#/components/parameters/usersSearch'
609 - $ref: '#/components/parameters/usersBlocked'
610 - $ref: '#/components/parameters/start'
611 - $ref: '#/components/parameters/count'
612 - $ref: '#/components/parameters/usersSort'
615 description: successful operation
621 $ref: '#/components/schemas/User'
624 - $ref: '#/components/parameters/id'
626 summary: Delete a user
632 operationId: delUserId
635 description: successful operation
642 operationId: getUserId
646 description: include statistics about the user (only available as a moderator/admin)
651 x-summary: successful operation
653 As an admin/moderator, you can request a response augmented with statistics about the user's
654 moderation relations and videos usage, by using the `withStats` parameter.
659 - $ref: '#/components/schemas/User'
660 - $ref: '#/components/schemas/UserWithStats'
662 summary: Update a user
667 operationId: putUserId
670 description: successful operation
675 $ref: '#/components/schemas/UpdateUser'
679 summary: Register a user
684 description: successful operation
689 $ref: '#/components/schemas/RegisterUser'
693 summary: Get my user information
701 description: successful operation
707 $ref: '#/components/schemas/User'
709 summary: Update my user information
717 description: successful operation
722 $ref: '#/components/schemas/UpdateMe'
724 /users/me/videos/imports:
726 summary: Get video imports of my user
734 - $ref: '#/components/parameters/start'
735 - $ref: '#/components/parameters/count'
736 - $ref: '#/components/parameters/sort'
739 description: successful operation
743 $ref: '#/components/schemas/VideoImportsList'
744 /users/me/video-quota-used:
746 summary: Get my user used quota
754 description: successful operation
762 description: The user video quota used so far in bytes
766 description: The user video quota used today in bytes
768 '/users/me/videos/{videoId}/rating':
770 summary: Get rate of my user for a video
780 description: The video id
782 $ref: '#/components/schemas/Video/properties/id'
785 description: successful operation
789 $ref: '#/components/schemas/GetMeVideoRating'
792 summary: Get videos of my user
800 - $ref: '#/components/parameters/start'
801 - $ref: '#/components/parameters/count'
802 - $ref: '#/components/parameters/sort'
805 description: successful operation
809 $ref: '#/components/schemas/VideoListResponse'
810 /users/me/subscriptions:
812 summary: Get my user subscriptions
819 - $ref: '#/components/parameters/start'
820 - $ref: '#/components/parameters/count'
821 - $ref: '#/components/parameters/sort'
824 description: successful operation
828 $ref: '#/components/schemas/VideoChannelList'
832 summary: Add subscription to my user
845 description: uri of the video channels to subscribe to
851 uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
854 description: successful operation
855 /users/me/subscriptions/exist:
857 summary: Get if subscriptions exist for my user
864 - $ref: '#/components/parameters/subscriptionsUris'
867 description: successful operation
872 /users/me/subscriptions/videos:
874 summary: List videos of subscriptions of my user
882 - $ref: '#/components/parameters/categoryOneOf'
883 - $ref: '#/components/parameters/isLive'
884 - $ref: '#/components/parameters/tagsOneOf'
885 - $ref: '#/components/parameters/tagsAllOf'
886 - $ref: '#/components/parameters/licenceOneOf'
887 - $ref: '#/components/parameters/languageOneOf'
888 - $ref: '#/components/parameters/nsfw'
889 - $ref: '#/components/parameters/filter'
890 - $ref: '#/components/parameters/skipCount'
891 - $ref: '#/components/parameters/start'
892 - $ref: '#/components/parameters/count'
893 - $ref: '#/components/parameters/videosSort'
896 description: successful operation
900 $ref: '#/components/schemas/VideoListResponse'
901 '/users/me/subscriptions/{subscriptionHandle}':
903 summary: Get subscription of my user
910 - $ref: '#/components/parameters/subscriptionHandle'
913 description: successful operation
917 $ref: '#/components/schemas/VideoChannel'
919 summary: Delete subscription of my user
926 - $ref: '#/components/parameters/subscriptionHandle'
929 description: successful operation
930 /users/me/notifications:
932 summary: List my notifications
940 description: only list unread notifications
943 - $ref: '#/components/parameters/start'
944 - $ref: '#/components/parameters/count'
945 - $ref: '#/components/parameters/sort'
948 description: successful operation
952 $ref: '#/components/schemas/NotificationListResponse'
953 /users/me/notifications/read:
955 summary: Mark notifications as read by their id
968 description: ids of the notifications to mark as read
975 description: successful operation
976 /users/me/notifications/read-all:
978 summary: Mark all my notification as read
985 description: successful operation
986 /users/me/notification-settings:
988 summary: Update my notification settings
999 newVideoFromSubscription:
1000 $ref: '#/components/schemas/NotificationSettingValue'
1001 newCommentOnMyVideo:
1002 $ref: '#/components/schemas/NotificationSettingValue'
1004 $ref: '#/components/schemas/NotificationSettingValue'
1005 videoAutoBlacklistAsModerator:
1006 $ref: '#/components/schemas/NotificationSettingValue'
1008 $ref: '#/components/schemas/NotificationSettingValue'
1010 $ref: '#/components/schemas/NotificationSettingValue'
1011 myVideoImportFinished:
1012 $ref: '#/components/schemas/NotificationSettingValue'
1014 $ref: '#/components/schemas/NotificationSettingValue'
1015 newUserRegistration:
1016 $ref: '#/components/schemas/NotificationSettingValue'
1018 $ref: '#/components/schemas/NotificationSettingValue'
1019 newInstanceFollower:
1020 $ref: '#/components/schemas/NotificationSettingValue'
1021 autoInstanceFollowing:
1022 $ref: '#/components/schemas/NotificationSettingValue'
1025 description: successful operation
1026 /users/me/history/videos:
1028 summary: List watched videos history
1034 - $ref: '#/components/parameters/start'
1035 - $ref: '#/components/parameters/count'
1036 - $ref: '#/components/parameters/search'
1039 description: successful operation
1043 $ref: '#/components/schemas/VideoListResponse'
1044 /users/me/history/videos/remove:
1046 summary: Clear video history
1053 multipart/form-data:
1058 description: history before this date will be deleted
1063 description: successful operation
1064 /users/me/avatar/pick:
1066 summary: Update my user avatar
1073 description: successful operation
1080 $ref: '#/components/schemas/ActorImage'
1082 description: image file too large
1084 X-File-Maximum-Size:
1088 description: Maximum file size for the avatar
1091 multipart/form-data:
1096 description: The file to upload
1101 contentType: image/png, image/jpeg
1104 summary: Delete my avatar
1111 description: successful operation
1115 summary: List video ownership changes
1117 - Video Ownership Change
1122 description: successful operation
1123 '/videos/ownership/{id}/accept':
1125 summary: Accept ownership change request
1127 - Video Ownership Change
1131 - $ref: '#/components/parameters/idOrUUID'
1134 description: successful operation
1136 description: cannot terminate an ownership change of another user
1138 description: video owneship change not found
1139 '/videos/ownership/{id}/refuse':
1141 summary: Refuse ownership change request
1143 - Video Ownership Change
1147 - $ref: '#/components/parameters/idOrUUID'
1150 description: successful operation
1152 description: cannot terminate an ownership change of another user
1154 description: video owneship change not found
1155 '/videos/{id}/give-ownership':
1157 summary: Request ownership change
1159 - Video Ownership Change
1163 - $ref: '#/components/parameters/idOrUUID'
1167 application/x-www-form-urlencoded:
1177 description: successful operation
1179 description: changing video ownership to a remote account is not supported yet
1181 description: video not found
1184 summary: List videos
1188 - $ref: '#/components/parameters/categoryOneOf'
1189 - $ref: '#/components/parameters/isLive'
1190 - $ref: '#/components/parameters/tagsOneOf'
1191 - $ref: '#/components/parameters/tagsAllOf'
1192 - $ref: '#/components/parameters/licenceOneOf'
1193 - $ref: '#/components/parameters/languageOneOf'
1194 - $ref: '#/components/parameters/nsfw'
1195 - $ref: '#/components/parameters/filter'
1196 - $ref: '#/components/parameters/skipCount'
1197 - $ref: '#/components/parameters/start'
1198 - $ref: '#/components/parameters/count'
1199 - $ref: '#/components/parameters/videosSort'
1202 description: successful operation
1206 $ref: '#/components/schemas/VideoListResponse'
1209 summary: List available video categories
1210 operationId: getCategories
1215 description: successful operation
1224 externalValue: https://peertube2.cpy.re/api/v1/videos/categories
1227 summary: List available video licences
1228 operationId: getLicences
1233 description: successful operation
1242 externalValue: https://peertube2.cpy.re/api/v1/videos/licences
1245 summary: List available video languages
1246 operationId: getLanguages
1251 description: successful operation
1260 externalValue: https://peertube2.cpy.re/api/v1/videos/languages
1263 summary: List available video privacy policies
1264 operationId: getPrivacyPolicies
1269 description: successful operation
1278 externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
1281 summary: Update a video
1287 - $ref: '#/components/parameters/idOrUUID'
1290 description: successful operation
1293 multipart/form-data:
1298 description: Video thumbnail file
1302 description: Video preview file
1306 $ref: '#/components/schemas/VideoCategorySet'
1308 $ref: '#/components/schemas/VideoLicenceSet'
1310 $ref: '#/components/schemas/VideoLanguageSet'
1312 $ref: '#/components/schemas/VideoPrivacySet'
1314 description: Video description
1317 description: Whether or not we wait transcoding before publish the video
1320 description: A text tell the audience how to support the video creator
1321 example: Please support our work on https://soutenir.framasoft.org/en/ <3
1324 description: Whether or not this video contains sensitive content
1327 description: Video name
1332 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1341 description: Enable or disable comments for this video
1343 originallyPublishedAt:
1344 description: Date when the content was originally published
1348 $ref: '#/components/schemas/VideoScheduledUpdate'
1351 contentType: image/jpeg
1353 contentType: image/jpeg
1355 summary: Get a video
1359 - $ref: '#/components/parameters/idOrUUID'
1362 description: successful operation
1366 $ref: '#/components/schemas/VideoDetails'
1368 summary: Delete a video
1374 - $ref: '#/components/parameters/idOrUUID'
1377 description: successful operation
1378 '/videos/{id}/description':
1380 summary: Get complete video description
1384 - $ref: '#/components/parameters/idOrUUID'
1387 description: successful operation
1396 **[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)**
1397 '/videos/{id}/views':
1399 summary: Add a view to a video
1403 - $ref: '#/components/parameters/idOrUUID'
1406 description: successful operation
1407 '/videos/{id}/watching':
1409 summary: Set watching progress of a video
1415 - $ref: '#/components/parameters/idOrUUID'
1420 $ref: '#/components/schemas/UserWatchingVideo'
1424 description: successful operation
1427 summary: Upload a video
1428 description: Uses a single request to upload a video.
1429 operationId: uploadLegacy
1437 description: successful operation
1441 $ref: '#/components/schemas/VideoUploadResponse'
1443 description: invalid file field, schedule date or parameter
1445 description: video didn't pass upload filter
1447 description: upload has timed out
1449 description: video file too large, due to quota or max body size limit set by the reverse-proxy
1451 X-File-Maximum-Size:
1455 description: Maximum file size for the video
1457 description: video type unsupported
1459 description: video unreadable
1462 multipart/form-data:
1464 $ref: '#/components/schemas/VideoUploadRequestLegacy'
1467 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1469 contentType: image/jpeg
1471 contentType: image/jpeg
1476 USERNAME="<your_username>"
1477 PASSWORD="<your_password>"
1478 FILE_PATH="<your_file_path>"
1479 CHANNEL_ID="<your_channel_id>"
1482 API_PATH="https://peertube2.cpy.re/api/v1"
1484 client_id=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1485 client_secret=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1486 token=$(curl -s "$API_PATH/users/token" \
1487 --data client_id="$client_id" \
1488 --data client_secret="$client_secret" \
1489 --data grant_type=password \
1490 --data response_type=code \
1491 --data username="$USERNAME" \
1492 --data password="$PASSWORD" \
1493 | jq -r ".access_token")
1495 curl -s "$API_PATH/videos/upload" \
1496 -H "Authorization: Bearer $token" \
1498 --form videofile=@"$FILE_PATH" \
1499 --form channelId=$CHANNEL_ID \
1501 /videos/upload-resumable:
1503 summary: Initialize the resumable upload of a video
1504 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video
1505 operationId: uploadResumableInit
1512 - name: X-Upload-Content-Length
1518 description: Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
1519 - name: X-Upload-Content-Type
1526 description: MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
1531 $ref: '#/components/schemas/VideoUploadRequestResumable'
1534 description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
1536 description: created
1542 example: /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51
1548 description: invalid file field, schedule date or parameter
1550 description: video file too large, due to quota, absolute max file size or concurrent partial upload limit
1552 description: video type unsupported
1554 summary: Send chunk for the resumable upload of a video
1555 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
1556 operationId: uploadResumable
1567 Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
1568 not valid anymore and you need to initialize a new upload.
1571 - name: Content-Range
1575 example: bytes 0-262143/2469036
1578 Specifies the bytes in the file that the request is uploading.
1580 For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first
1581 262144 bytes (256 x 1024) in a 2,469,036 byte file.
1582 - name: Content-Length
1589 Size of the chunk that the request is sending.
1591 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)
1592 doesn't mandate for chunks to have the same size throughout the upload sequence.
1594 Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
1595 1048576 bytes (~1MB) and increases or reduces size depending on connection health.
1598 application/octet-stream:
1604 description: last chunk received
1612 $ref: '#/components/schemas/VideoUploadResponse'
1614 description: resume incomplete
1619 example: bytes=0-262143
1625 description: video didn't pass upload filter
1627 description: video file too large, due to quota or max body size limit set by the reverse-proxy
1629 description: video unreadable
1631 summary: Cancel the resumable upload of a video, deleting any data uploaded so far
1632 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
1633 operationId: uploadResumableCancel
1644 Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
1645 not valid anymore and the upload session has already been deleted with its data ;-)
1648 - name: Content-Length
1656 description: upload cancelled
1664 summary: Import a video
1665 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1666 operationId: importVideo
1674 multipart/form-data:
1676 $ref: '#/components/schemas/VideoCreateImport'
1679 contentType: application/x-bittorrent
1681 contentType: image/jpeg
1683 contentType: image/jpeg
1686 description: successful operation
1690 $ref: '#/components/schemas/VideoUploadResponse'
1692 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1694 description: video didn't pass pre-import filter
1696 description: HTTP or Torrent/magnetURI import not enabled
1700 summary: Create a live
1701 operationId: createLive
1709 description: successful operation
1713 $ref: '#/components/schemas/VideoUploadResponse'
1715 description: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
1718 multipart/form-data:
1723 description: Channel id that will contain this live video
1728 description: User can stream multiple times in a permanent live
1731 description: Live video/replay thumbnail file
1735 description: Live video/replay preview file
1739 $ref: '#/components/schemas/VideoPrivacySet'
1741 $ref: '#/components/schemas/VideoCategorySet'
1743 $ref: '#/components/schemas/VideoLicenceSet'
1745 $ref: '#/components/schemas/VideoLanguageSet'
1747 description: Live video/replay description
1750 description: A text tell the audience how to support the creator
1751 example: Please support our work on https://soutenir.framasoft.org/en/ <3
1754 description: Whether or not this live video/replay contains sensitive content
1757 description: Live video/replay name
1762 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
1771 description: Enable or disable comments for this live video/replay
1774 description: Enable or disable downloading for the replay of this live
1781 contentType: image/jpeg
1783 contentType: image/jpeg
1787 summary: Get information about a live
1788 operationId: getLiveId
1795 - $ref: '#/components/parameters/idOrUUID'
1798 description: successful operation
1802 $ref: '#/components/schemas/LiveVideoResponse'
1804 summary: Update information about a live
1805 operationId: updateLiveId
1812 - $ref: '#/components/parameters/idOrUUID'
1817 $ref: '#/components/schemas/LiveVideoUpdate'
1820 description: successful operation
1822 description: bad parameters or trying to update a live that has already started
1824 description: trying to save replay of the live but saving replay is not enabled on the instance
1828 summary: List my abuses
1829 operationId: getMyAbuses
1838 description: only list the report with this id
1844 $ref: '#/components/schemas/AbuseStateSet'
1845 - $ref: '#/components/parameters/abusesSort'
1846 - $ref: '#/components/parameters/start'
1847 - $ref: '#/components/parameters/count'
1850 description: successful operation
1862 $ref: '#/components/schemas/Abuse'
1866 summary: List abuses
1867 operationId: getAbuses
1877 description: only list the report with this id
1880 - name: predefinedReason
1882 description: predefined reason the listed reports should contain
1884 $ref: '#/components/schemas/PredefinedAbuseReasons'
1887 description: plain search that will match with video titles, reporter names and more
1893 $ref: '#/components/schemas/AbuseStateSet'
1894 - name: searchReporter
1896 description: only list reports of a specific reporter
1899 - name: searchReportee
1900 description: only list reports of a specific reportee
1906 description: only list reports of a specific video
1909 - name: searchVideoChannel
1911 description: only list reports of a specific video channel
1916 description: only list blacklisted or deleted videos
1924 description: only list account, comment or video reports
1931 - $ref: '#/components/parameters/start'
1932 - $ref: '#/components/parameters/count'
1933 - $ref: '#/components/parameters/abusesSort'
1936 description: successful operation
1948 $ref: '#/components/schemas/Abuse'
1951 summary: Report an abuse
1964 description: Reason why the user reports this video
1969 $ref: '#/components/schemas/PredefinedAbuseReasons'
1974 description: Video id to report
1976 - $ref: '#/components/schemas/Video/properties/id'
1979 description: Timestamp in the video that marks the beginning of the report
1983 description: Timestamp in the video that marks the ending of the report
1989 description: Comment id to report
1991 - $ref: '#/components/schemas/VideoComment/properties/id'
1996 description: Account id to report
2002 description: successful operation
2004 description: incorrect request parameters
2005 '/abuses/{abuseId}':
2007 summary: Update an abuse
2015 - $ref: '#/components/parameters/abuseId'
2023 $ref: '#/components/schemas/AbuseStateSet'
2026 description: Update the report comment visible only to the moderation team
2031 description: successful operation
2033 description: abuse not found
2037 summary: Delete an abuse
2043 - $ref: '#/components/parameters/abuseId'
2046 description: successful operation
2048 description: block not found
2049 '/abuses/{abuseId}/messages':
2051 summary: List messages of an abuse
2057 - $ref: '#/components/parameters/abuseId'
2060 description: successful operation
2066 $ref: '#/components/schemas/AbuseMessage'
2069 summary: Add message to an abuse
2075 - $ref: '#/components/parameters/abuseId'
2084 description: Message to send
2092 description: successful operation
2094 description: incorrect request parameters
2095 '/abuses/{abuseId}/messages/{abuseMessageId}':
2097 summary: Delete an abuse message
2103 - $ref: '#/components/parameters/abuseId'
2104 - $ref: '#/components/parameters/abuseMessageId'
2107 description: successful operation
2109 '/videos/{id}/blacklist':
2111 summary: Block a video
2119 - $ref: '#/components/parameters/idOrUUID'
2122 description: successful operation
2124 summary: Unblock a video by its id
2132 - $ref: '#/components/parameters/idOrUUID'
2135 description: successful operation
2137 description: block not found
2142 summary: List video blocks
2151 list only blocks that match this type:
2155 - `2`: automatic block that needs review
2163 description: plain search that will match with video titles, and more
2166 - $ref: '#/components/parameters/start'
2167 - $ref: '#/components/parameters/count'
2168 - $ref: '#/components/parameters/blacklistsSort'
2171 description: successful operation
2183 $ref: '#/components/schemas/VideoBlacklist'
2184 /videos/{id}/captions:
2186 summary: List captions of a video
2190 - $ref: '#/components/parameters/idOrUUID'
2193 description: successful operation
2205 $ref: '#/components/schemas/VideoCaption'
2206 /videos/{id}/captions/{captionLanguage}:
2208 summary: Add or replace a video caption
2215 - $ref: '#/components/parameters/idOrUUID'
2216 - $ref: '#/components/parameters/captionLanguage'
2219 multipart/form-data:
2224 description: The file to upload.
2229 contentType: text/vtt, application/x-subrip, text/plain
2232 description: successful operation
2234 description: video or language not found
2236 summary: Delete a video caption
2243 - $ref: '#/components/parameters/idOrUUID'
2244 - $ref: '#/components/parameters/captionLanguage'
2247 description: successful operation
2249 description: video or language or caption for that language not found
2252 summary: List video channels
2253 operationId: getVideoChannels
2257 - $ref: '#/components/parameters/start'
2258 - $ref: '#/components/parameters/count'
2259 - $ref: '#/components/parameters/sort'
2262 description: successful operation
2266 $ref: '#/components/schemas/VideoChannelList'
2268 summary: Create a video channel
2269 operationId: createVideoChannel
2276 description: successful operation
2286 $ref: '#/components/schemas/VideoChannel/properties/id'
2291 $ref: '#/components/schemas/VideoChannelCreate'
2292 '/video-channels/{channelHandle}':
2294 summary: Get a video channel
2295 operationId: getVideoChannel
2299 - $ref: '#/components/parameters/channelHandle'
2302 description: successful operation
2306 $ref: '#/components/schemas/VideoChannel'
2308 summary: Update a video channel
2314 - $ref: '#/components/parameters/channelHandle'
2317 description: successful operation
2322 $ref: '#/components/schemas/VideoChannelUpdate'
2324 summary: Delete a video channel
2330 - $ref: '#/components/parameters/channelHandle'
2333 description: successful operation
2334 '/video-channels/{channelHandle}/videos':
2336 summary: List videos of a video channel
2341 - $ref: '#/components/parameters/channelHandle'
2342 - $ref: '#/components/parameters/categoryOneOf'
2343 - $ref: '#/components/parameters/isLive'
2344 - $ref: '#/components/parameters/tagsOneOf'
2345 - $ref: '#/components/parameters/tagsAllOf'
2346 - $ref: '#/components/parameters/licenceOneOf'
2347 - $ref: '#/components/parameters/languageOneOf'
2348 - $ref: '#/components/parameters/nsfw'
2349 - $ref: '#/components/parameters/filter'
2350 - $ref: '#/components/parameters/skipCount'
2351 - $ref: '#/components/parameters/start'
2352 - $ref: '#/components/parameters/count'
2353 - $ref: '#/components/parameters/videosSort'
2356 description: successful operation
2360 $ref: '#/components/schemas/VideoListResponse'
2361 '/video-channels/{channelHandle}/avatar/pick':
2363 summary: Update channel avatar
2369 - $ref: '#/components/parameters/channelHandle'
2372 description: successful operation
2379 $ref: '#/components/schemas/ActorImage'
2381 description: image file too large
2383 X-File-Maximum-Size:
2387 description: Maximum file size for the avatar
2390 multipart/form-data:
2395 description: The file to upload.
2400 contentType: image/png, image/jpeg
2401 '/video-channels/{channelHandle}/avatar':
2403 summary: Delete channel avatar
2409 - $ref: '#/components/parameters/channelHandle'
2412 description: successful operation
2415 '/video-channels/{channelHandle}/banner/pick':
2417 summary: Update channel banner
2423 - $ref: '#/components/parameters/channelHandle'
2426 description: successful operation
2433 $ref: '#/components/schemas/ActorImage'
2435 description: image file too large
2437 X-File-Maximum-Size:
2441 description: Maximum file size for the banner
2444 multipart/form-data:
2449 description: The file to upload.
2454 contentType: image/png, image/jpeg
2455 '/video-channels/{channelHandle}/banner':
2457 summary: Delete channel banner
2463 - $ref: '#/components/parameters/channelHandle'
2466 description: successful operation
2468 /video-playlists/privacies:
2470 summary: List available playlist privacy policies
2471 operationId: getPlaylistPrivacyPolicies
2476 description: successful operation
2485 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
2489 summary: List video playlists
2490 operationId: getPlaylists
2494 - $ref: '#/components/parameters/start'
2495 - $ref: '#/components/parameters/count'
2496 - $ref: '#/components/parameters/sort'
2499 description: successful operation
2511 $ref: '#/components/schemas/VideoPlaylist'
2513 summary: Create a video playlist
2514 description: If the video playlist is set as public, `videoChannelId` is mandatory.
2515 operationId: createPlaylist
2522 description: successful operation
2532 $ref: '#/components/schemas/VideoPlaylist/properties/id'
2534 $ref: '#/components/schemas/VideoPlaylist/properties/uuid'
2537 multipart/form-data:
2542 description: Video playlist display name
2547 description: Video playlist thumbnail file
2551 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2553 description: Video playlist description
2559 - $ref: '#/components/schemas/id'
2560 description: Video channel in which the playlist will be published
2565 contentType: image/jpeg
2567 /video-playlists/{id}:
2569 summary: Get a video playlist
2573 - $ref: '#/components/parameters/idOrUUID'
2576 description: successful operation
2580 $ref: '#/components/schemas/VideoPlaylist'
2582 summary: Update a video playlist
2583 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2590 description: successful operation
2592 - $ref: '#/components/parameters/idOrUUID'
2595 multipart/form-data:
2600 description: Video playlist display name
2605 description: Video playlist thumbnail file
2609 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2611 description: Video playlist description
2615 - $ref: '#/components/schemas/id'
2616 description: Video channel in which the playlist will be published
2619 contentType: image/jpeg
2621 summary: Delete a video playlist
2627 - $ref: '#/components/parameters/idOrUUID'
2630 description: successful operation
2632 /video-playlists/{id}/videos:
2634 summary: 'List videos of a playlist'
2639 - $ref: '#/components/parameters/idOrUUID'
2642 description: successful operation
2646 $ref: '#/components/schemas/VideoListResponse'
2648 summary: 'Add a video in a playlist'
2655 - $ref: '#/components/parameters/idOrUUID'
2658 description: successful operation
2664 videoPlaylistElement:
2677 - $ref: '#/components/schemas/Video/properties/id'
2678 description: Video to add in the playlist
2681 description: Start the video at this specific timestamp (in seconds)
2684 description: Stop the video at this specific timestamp (in seconds)
2688 /video-playlists/{id}/videos/reorder:
2690 summary: 'Reorder a playlist'
2696 - $ref: '#/components/parameters/idOrUUID'
2699 description: successful operation
2708 description: 'Start position of the element to reorder'
2710 insertAfterPosition:
2712 description: 'New position for the block to reorder, to add the block before the first element'
2716 description: 'How many element from `startPosition` to reorder'
2720 - insertAfterPosition
2722 /video-playlists/{id}/videos/{playlistElementId}:
2724 summary: 'Update a playlist element'
2730 - $ref: '#/components/parameters/idOrUUID'
2731 - $ref: '#/components/parameters/playlistElementId'
2734 description: successful operation
2743 description: 'Start the video at this specific timestamp (in seconds)'
2746 description: 'Stop the video at this specific timestamp (in seconds)'
2748 summary: 'Delete an element from a playlist'
2754 - $ref: '#/components/parameters/idOrUUID'
2755 - $ref: '#/components/parameters/playlistElementId'
2758 description: successful operation
2760 '/users/me/video-playlists/videos-exist':
2762 summary: 'Check video exists in my playlists'
2771 description: The video ids to check
2775 $ref: '#/components/schemas/Video/properties/id'
2778 description: successful operation
2798 '/accounts/{name}/video-channels':
2800 summary: List video channels of an account
2805 - $ref: '#/components/parameters/name'
2808 description: include view statistics for the last 30 days (only if authentified as the account user)
2811 - $ref: '#/components/parameters/start'
2812 - $ref: '#/components/parameters/count'
2813 - $ref: '#/components/parameters/sort'
2816 description: successful operation
2820 $ref: '#/components/schemas/VideoChannelList'
2821 '/accounts/{name}/ratings':
2823 summary: List ratings of an account
2829 - $ref: '#/components/parameters/name'
2830 - $ref: '#/components/parameters/start'
2831 - $ref: '#/components/parameters/count'
2832 - $ref: '#/components/parameters/sort'
2836 description: Optionally filter which ratings to retrieve
2844 description: successful operation
2850 $ref: '#/components/schemas/VideoRating'
2851 '/videos/{id}/comment-threads':
2853 summary: List threads of a video
2857 - $ref: '#/components/parameters/idOrUUID'
2858 - $ref: '#/components/parameters/start'
2859 - $ref: '#/components/parameters/count'
2860 - $ref: '#/components/parameters/commentsSort'
2863 description: successful operation
2867 $ref: '#/components/schemas/CommentThreadResponse'
2869 summary: Create a thread
2875 - $ref: '#/components/parameters/idOrUUID'
2878 description: successful operation
2882 $ref: '#/components/schemas/CommentThreadPostResponse'
2884 description: video does not exist
2893 - $ref: '#/components/schemas/VideoComment/properties/text'
2899 '/videos/{id}/comment-threads/{threadId}':
2901 summary: Get a thread
2905 - $ref: '#/components/parameters/idOrUUID'
2906 - $ref: '#/components/parameters/threadId'
2909 description: successful operation
2913 $ref: '#/components/schemas/VideoCommentThreadTree'
2914 '/videos/{id}/comments/{commentId}':
2916 summary: Reply to a thread of a video
2922 - $ref: '#/components/parameters/idOrUUID'
2923 - $ref: '#/components/parameters/commentId'
2926 description: successful operation
2930 $ref: '#/components/schemas/CommentThreadPostResponse'
2932 description: thread or video does not exist
2941 - $ref: '#/components/schemas/VideoComment/properties/text'
2948 summary: Delete a comment or a reply
2954 - $ref: '#/components/parameters/idOrUUID'
2955 - $ref: '#/components/parameters/commentId'
2958 description: successful operation
2960 description: cannot remove comment of another user
2962 description: comment or video does not exist
2964 description: comment is already deleted
2965 '/videos/{id}/rate':
2967 summary: Like/dislike a video
2973 - $ref: '#/components/parameters/idOrUUID'
2989 description: successful operation
2991 description: video does not exist
2996 summary: Search videos
3001 allowEmptyValue: false
3003 String to search. If the user can make a remote URI search, and the string is an URI then the
3004 PeerTube instance will fetch the remote object and add it to its database. Then,
3005 you can use the REST API to fetch the complete video information and interact with it.
3008 - $ref: '#/components/parameters/categoryOneOf'
3009 - $ref: '#/components/parameters/isLive'
3010 - $ref: '#/components/parameters/tagsOneOf'
3011 - $ref: '#/components/parameters/tagsAllOf'
3012 - $ref: '#/components/parameters/licenceOneOf'
3013 - $ref: '#/components/parameters/languageOneOf'
3014 - $ref: '#/components/parameters/nsfw'
3015 - $ref: '#/components/parameters/filter'
3016 - $ref: '#/components/parameters/skipCount'
3017 - $ref: '#/components/parameters/start'
3018 - $ref: '#/components/parameters/count'
3019 - $ref: '#/components/parameters/searchTarget'
3020 - $ref: '#/components/parameters/videosSearchSort'
3023 description: Get videos that are published after this date
3029 description: Get videos that are published before this date
3033 - name: originallyPublishedStartDate
3035 description: Get videos that are originally published after this date
3039 - name: originallyPublishedEndDate
3041 description: Get videos that are originally published before this date
3047 description: Get videos that have this minimum duration
3052 description: Get videos that have this maximum duration
3056 'searchTarget === search-index':
3057 $ref: '#/components/callbacks/searchIndex'
3060 description: successful operation
3064 $ref: '#/components/schemas/VideoListResponse'
3066 description: search index unavailable
3067 /search/video-channels:
3071 summary: Search channels
3077 String to search. If the user can make a remote URI search, and the string is an URI then the
3078 PeerTube instance will fetch the remote object and add it to its database. Then,
3079 you can use the REST API to fetch the complete channel information and interact with it.
3082 - $ref: '#/components/parameters/start'
3083 - $ref: '#/components/parameters/count'
3084 - $ref: '#/components/parameters/searchTarget'
3085 - $ref: '#/components/parameters/sort'
3087 'searchTarget === search-index':
3088 $ref: '#/components/callbacks/searchIndex'
3091 description: successful operation
3095 $ref: '#/components/schemas/VideoChannelList'
3097 description: search index unavailable
3098 /blocklist/accounts:
3102 summary: List account blocks
3107 - $ref: '#/components/parameters/start'
3108 - $ref: '#/components/parameters/count'
3109 - $ref: '#/components/parameters/sort'
3112 description: successful operation
3116 summary: Block an account
3128 example: chocobozzz@example.org
3129 description: account to block, in the form `username@domain`
3134 description: successful operation
3136 description: self-blocking forbidden
3137 '/blocklist/accounts/{accountName}':
3141 summary: Unblock an account by its handle
3149 description: account to unblock, in the form `username@domain`
3154 description: successful operation
3156 description: account or account block does not exist
3161 summary: List server blocks
3166 - $ref: '#/components/parameters/start'
3167 - $ref: '#/components/parameters/count'
3168 - $ref: '#/components/parameters/sort'
3171 description: successful operation
3175 summary: Block a server
3188 description: server domain to block
3193 description: successful operation
3195 description: self-blocking forbidden
3196 '/blocklist/servers/{host}':
3200 summary: Unblock a server by its domain
3208 description: server domain to unblock
3214 description: successful operation
3216 description: account block does not exist
3220 - Instance Redundancy
3221 summary: Update a server redundancy policy
3229 description: server domain to mirror
3241 description: allow mirroring of the host's local videos
3246 description: successful operation
3248 description: server is not already known
3253 summary: List videos being mirrored
3261 description: direction of the mirror
3267 - $ref: '#/components/parameters/start'
3268 - $ref: '#/components/parameters/count'
3269 - $ref: '#/components/parameters/videoRedundanciesSort'
3272 description: successful operation
3278 $ref: '#/components/schemas/VideoRedundancy'
3282 summary: Mirror a video
3293 $ref: '#/components/schemas/Video/properties/id'
3298 description: successful operation
3300 description: cannot mirror a local video
3302 description: video does not exist
3304 description: video is already mirrored
3305 /redundancy/videos/{redundancyId}:
3309 summary: Delete a mirror done on a video
3314 - name: redundancyId
3317 description: id of an existing redundancy on a video
3322 description: successful operation
3324 description: video redundancy not found
3325 '/feeds/video-comments.{format}':
3329 summary: List comments on videos
3334 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3347 description: 'limit listing to a specific video'
3352 description: 'limit listing to a specific account'
3357 description: 'limit listing to a specific account'
3360 - name: videoChannelId
3362 description: 'limit listing to a specific video channel'
3365 - name: videoChannelName
3367 description: 'limit listing to a specific video channel'
3372 description: successful operation
3377 default: 'max-age=900' # 15 min cache
3381 $ref: '#/components/schemas/VideoCommentsForXML'
3384 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3385 application/rss+xml:
3387 $ref: '#/components/schemas/VideoCommentsForXML'
3390 externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
3393 $ref: '#/components/schemas/VideoCommentsForXML'
3396 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
3397 application/atom+xml:
3399 $ref: '#/components/schemas/VideoCommentsForXML'
3402 externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
3408 externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local
3410 x-summary: field inconsistencies
3413 - videoId filter is mixed with a channel filter
3415 description: video, video channel or account not found
3417 description: accept header unsupported
3418 '/feeds/videos.{format}':
3422 summary: List videos
3427 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3440 description: 'limit listing to a specific account'
3445 description: 'limit listing to a specific account'
3448 - name: videoChannelId
3450 description: 'limit listing to a specific video channel'
3453 - name: videoChannelName
3455 description: 'limit listing to a specific video channel'
3458 - $ref: '#/components/parameters/sort'
3459 - $ref: '#/components/parameters/nsfw'
3460 - $ref: '#/components/parameters/filter'
3463 description: successful operation
3468 default: 'max-age=900' # 15 min cache
3472 $ref: '#/components/schemas/VideosForXML'
3475 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3476 application/rss+xml:
3478 $ref: '#/components/schemas/VideosForXML'
3481 externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local
3484 $ref: '#/components/schemas/VideosForXML'
3487 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3488 application/atom+xml:
3490 $ref: '#/components/schemas/VideosForXML'
3493 externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local
3499 externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local
3501 description: video channel or account not found
3503 description: accept header unsupported
3504 '/feeds/subscriptions.{format}':
3509 summary: List videos of subscriptions tied to a token
3514 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3527 description: limit listing to a specific account
3533 description: private token allowing access
3537 - $ref: '#/components/parameters/sort'
3538 - $ref: '#/components/parameters/nsfw'
3539 - $ref: '#/components/parameters/filter'
3542 description: successful operation
3547 default: 'max-age=900' # 15 min cache
3551 $ref: '#/components/schemas/VideosForXML'
3552 application/rss+xml:
3554 $ref: '#/components/schemas/VideosForXML'
3557 $ref: '#/components/schemas/VideosForXML'
3558 application/atom+xml:
3560 $ref: '#/components/schemas/VideosForXML'
3565 description: accept header unsupported
3570 summary: List plugins
3583 - $ref: '#/components/parameters/start'
3584 - $ref: '#/components/parameters/count'
3585 - $ref: '#/components/parameters/sort'
3588 description: successful operation
3592 $ref: '#/components/schemas/PluginResponse'
3597 summary: List available plugins
3610 - name: currentPeerTubeEngine
3614 - $ref: '#/components/parameters/start'
3615 - $ref: '#/components/parameters/count'
3616 - $ref: '#/components/parameters/sort'
3619 description: successful operation
3623 $ref: '#/components/schemas/PluginResponse'
3625 description: plugin index unavailable
3630 summary: Install a plugin
3643 example: peertube-plugin-auth-ldap
3646 additionalProperties: false
3653 additionalProperties: false
3656 description: successful operation
3658 description: should have either `npmName` or `path` set
3663 summary: Update a plugin
3676 example: peertube-plugin-auth-ldap
3679 additionalProperties: false
3686 additionalProperties: false
3689 description: successful operation
3691 description: should have either `npmName` or `path` set
3693 description: existing plugin not found
3698 summary: Uninstall a plugin
3710 description: name of the plugin/theme in its package.json
3711 example: peertube-plugin-auth-ldap
3716 description: successful operation
3718 description: existing plugin not found
3723 summary: Get a plugin
3728 - $ref: '#/components/parameters/npmName'
3731 description: successful operation
3735 $ref: '#/components/schemas/Plugin'
3737 description: plugin not found
3738 /plugins/{npmName}/settings:
3742 summary: Set a plugin's settings
3747 - $ref: '#/components/parameters/npmName'
3756 additionalProperties: true
3759 description: successful operation
3761 description: plugin not found
3762 /plugins/{npmName}/public-settings:
3766 summary: Get a plugin's public settings
3768 - $ref: '#/components/parameters/npmName'
3771 description: successful operation
3776 additionalProperties: true
3778 description: plugin not found
3779 /plugins/{npmName}/registered-settings:
3783 summary: Get a plugin's registered settings
3788 - $ref: '#/components/parameters/npmName'
3791 description: successful operation
3796 additionalProperties: true
3798 description: plugin not found
3800 - url: 'https://peertube2.cpy.re/api/v1'
3801 description: Live Test Server (live data - latest nightly version)
3802 - url: 'https://peertube3.cpy.re/api/v1'
3803 description: Live Test Server (live data - latest RC version)
3804 - url: 'https://peertube.cpy.re/api/v1'
3805 description: Live Test Server (live data - stable version)
3812 description: Offset used to paginate results
3820 description: "Number of items to return"
3830 description: Sort column
3838 description: Plain text search, applied to various parts of the model depending on endpoint
3846 If the administrator enabled search index support, you can override the default search target.
3849 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3850 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3851 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3852 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3853 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3854 * 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
3855 the data from the origin instance API
3865 description: Sort videos by criteria
3881 description: Sort videos by criteria
3896 description: Sort comments by criteria
3906 description: Sort blacklists by criteria
3922 description: Plain text search that will match with user usernames or emails
3929 description: Filter results down to (un)banned users
3936 description: Sort users by criteria
3947 description: Sort abuses by criteria
3954 videoRedundanciesSort:
3958 description: Sort abuses by criteria
3967 description: The username or handle of the account
3970 example: chocobozzz | chocobozzz@example.org
3975 description: The user id
3977 $ref: '#/components/schemas/id'
3982 description: The object id or uuid
3985 - $ref: '#/components/schemas/id'
3986 - $ref: '#/components/schemas/UUIDv4'
3988 name: playlistElementId
3991 description: Playlist element id
3993 $ref: '#/components/schemas/id'
3998 description: Abuse id
4000 $ref: '#/components/schemas/Abuse/properties/id'
4002 name: abuseMessageId
4005 description: Abuse message id
4007 $ref: '#/components/schemas/AbuseMessage/properties/id'
4009 name: captionLanguage
4012 description: The caption language
4014 $ref: '#/components/schemas/VideoLanguageSet'
4019 description: The video channel handle
4022 example: my_username | my_username@example.com
4024 name: subscriptionHandle
4027 description: The subscription handle
4030 example: my_username | my_username@example.com
4035 description: The thread id (root comment id)
4037 $ref: '#/components/schemas/VideoCommentThreadTree/properties/comment/properties/id'
4042 description: The comment id
4044 $ref: '#/components/schemas/VideoComment/properties/id'
4049 description: whether or not the video is a live
4056 description: category id of the video (see [/videos/categories](#operation/getCategories))
4059 - $ref: '#/components/schemas/VideoCategorySet'
4062 $ref: '#/components/schemas/VideoCategorySet'
4069 description: tag(s) of the video
4083 description: tag(s) of the video, where all should be present in the video
4096 description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
4099 - $ref: '#/components/schemas/VideoLanguageSet'
4102 $ref: '#/components/schemas/VideoLanguageSet'
4109 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4112 - $ref: '#/components/schemas/VideoLicenceSet'
4115 $ref: '#/components/schemas/VideoLicenceSet'
4122 description: if you don't need the `total` in the response
4133 description: whether to include nsfw videos, if any
4144 Special filters which might require special rights:
4145 * `local` - only videos local to the instance
4146 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
4147 * `all` - all videos, showing private and unlisted videos (requires Admin privileges)
4157 description: list of uris to check if each is part of the user subscriptions
4167 description: name of the plugin/theme on npmjs.com or in its package.json
4170 example: peertube-plugin-auth-ldap
4175 description: job type
4179 - activitypub-follow
4180 - activitypub-http-broadcast
4181 - activitypub-http-fetcher
4182 - activitypub-http-unicast
4188 - activitypub-refresher
4194 Authenticating via OAuth requires the following steps:
4195 - Have an activated account
4196 - [Generate](https://docs.joinpeertube.org/api-rest-getting-started) a
4197 Bearer Token for that account at `/api/v1/users/token`
4198 - Make authenticated requests, putting *Authorization: Bearer <token\>*
4199 - Profit, depending on the role assigned to the account
4201 Note that the __access token is valid for 1 day__ and, and is given
4202 along with a __refresh token valid for 2 weeks__.
4206 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
4209 moderator: Moderator scope
4212 # Resuable core properties
4220 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4221 pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
4226 description: immutable name of the user, used to find or mention its actor
4228 pattern: '/^[a-z0-9._]{1,50}$/'
4233 description: immutable name of the channel, used to interact with its actor
4234 example: framasoft_videos
4235 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
4244 description: category id of the video (see [/videos/categories](#operation/getCategories))
4246 VideoConstantNumber-Category:
4249 $ref: '#/components/schemas/VideoCategorySet'
4252 example: Science & Technology
4256 description: licence id of the video (see [/videos/licences](#operation/getLicences))
4258 VideoConstantNumber-Licence:
4261 $ref: '#/components/schemas/VideoLicenceSet'
4264 example: Attribution - Share Alike
4268 description: language id of the video (see [/videos/languages](#operation/getLanguages))
4270 VideoConstantString-Language:
4273 $ref: '#/components/schemas/VideoLanguageSet'
4278 VideoPlaylistPrivacySet:
4284 description: Video playlist privacy policy (see [/video-playlists/privacies])
4285 VideoPlaylistPrivacyConstant:
4288 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
4292 VideoPlaylistTypeSet:
4297 description: The video playlist type (Regular = `1`, Watch Later = `2`)
4298 VideoPlaylistTypeConstant:
4301 $ref: '#/components/schemas/VideoPlaylistTypeSet'
4312 description: privacy id of the video (see [/videos/privacies](#operation/getPrivacyPolicies))
4313 VideoPrivacyConstant:
4316 $ref: '#/components/schemas/VideoPrivacySet'
4333 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
4340 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
4351 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
4361 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
4365 $ref: '#/components/schemas/AbuseStateSet'
4368 AbusePredefinedReasons:
4381 example: [spamOrMisleading]
4386 Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
4388 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
4390 VideoResolutionConstant:
4391 description: resolutions and their labels for the video
4394 $ref: '#/components/schemas/VideoResolutionSet'
4398 VideoScheduledUpdate:
4401 $ref: '#/components/schemas/VideoPrivacySet'
4405 description: When to update the video
4425 - $ref: '#/components/schemas/ActorImage'
4426 VideoChannelSummary:
4429 $ref: '#/components/schemas/id'
4443 - $ref: '#/components/schemas/ActorImage'
4455 - $ref: '#/components/schemas/Video'
4462 description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
4463 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
4464 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4466 $ref: '#/components/schemas/VideoResolutionConstant'
4469 description: Video file size in bytes
4472 description: Direct URL of the torrent file
4476 description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
4480 description: Direct URL of the video
4484 description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
4488 description: Frames per second of the video file
4492 description: URL dereferencing the output of ffprobe on the file
4493 VideoStreamingPlaylists:
4498 $ref: '#/components/schemas/id'
4506 - $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'
4507 VideoStreamingPlaylists-HLS:
4518 Video files associated to this playlist.
4520 The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
4522 $ref: '#/components/schemas/VideoFile'
4534 $ref: '#/components/schemas/Video/properties/id'
4536 $ref: '#/components/schemas/Video/properties/uuid'
4538 $ref: '#/components/schemas/Video/properties/name'
4542 description: object id for the video
4544 - $ref: '#/components/schemas/id'
4546 description: universal identifier for the video, that can be used across instances
4548 - $ref: '#/components/schemas/UUIDv4'
4554 example: 2017-10-01T10:52:46.396Z
4555 description: time at which the video object was first drafted
4559 example: 2018-10-01T10:52:46.396Z
4560 description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
4564 example: 2021-05-04T08:01:01.502Z
4565 description: last time the video's metadata was modified
4566 originallyPublishedAt:
4569 example: 2010-10-01T10:52:46.396Z
4570 description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
4573 - $ref: '#/components/schemas/VideoConstantNumber-Category'
4574 description: category in which the video is classified
4577 - $ref: '#/components/schemas/VideoConstantNumber-Licence'
4578 description: licence under which the video is distributed
4581 - $ref: '#/components/schemas/VideoConstantString-Language'
4582 description: main language used in the video
4585 - $ref: '#/components/schemas/VideoPrivacyConstant'
4586 description: privacy policy used to distribute the video
4590 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
4591 **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
4595 truncated description of the video, written in Markdown.
4596 Resolve `descriptionPath` to get the full description of maximum `10000` characters.
4600 description: duration of the video in seconds
4605 description: title of the video
4606 example: What is PeerTube?
4611 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4614 example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4617 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
4634 - $ref: '#/components/schemas/VideoStateConstant'
4635 description: represents the internal state of the video processing within the PeerTube instance
4639 - $ref: '#/components/schemas/VideoScheduledUpdate'
4647 $ref: '#/components/schemas/AccountSummary'
4649 $ref: '#/components/schemas/VideoChannelSummary'
4658 - $ref: '#/components/schemas/Video'
4663 example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
4664 description: path at which to get the full description of maximum `10000` characters
4667 description: A text tell the audience how to support the video creator
4668 example: Please support our work on https://soutenir.framasoft.org/en/ <3
4672 $ref: '#/components/schemas/VideoChannel'
4674 $ref: '#/components/schemas/Account'
4676 example: [flowers, gardening]
4694 - https://peertube2.cpy.re/tracker/announce
4695 - wss://peertube2.cpy.re/tracker/socket
4699 $ref: '#/components/schemas/VideoFile'
4701 WebTorrent/raw video files. If WebTorrent is disabled on the server:
4703 - field will be empty
4704 - video files will be found in `streamingPlaylists[].files` field
4708 $ref: '#/components/schemas/VideoStreamingPlaylists'
4710 HLS playlists/manifest files. If HLS is disabled on the server:
4712 - field will be empty
4713 - video files will be found in `files` field
4714 FileRedundancyInformation:
4717 $ref: '#/components/schemas/id'
4742 $ref: '#/components/schemas/id'
4749 $ref: '#/components/schemas/UUIDv4'
4756 $ref: '#/components/schemas/FileRedundancyInformation'
4760 $ref: '#/components/schemas/FileRedundancyInformation'
4761 VideoImportStateConstant:
4769 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
4776 additionalProperties: false
4780 $ref: '#/components/schemas/VideoImport/properties/targetUrl'
4781 required: [targetUrl]
4784 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
4785 required: [magnetUri]
4788 $ref: '#/components/schemas/VideoImport/properties/torrentfile'
4789 required: [torrentfile]
4790 - $ref: '#/components/schemas/VideoUploadRequestCommon'
4799 - $ref: '#/components/schemas/id'
4803 description: remote URL where to find the import's source video
4804 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4808 description: magnet URI allowing to resolve the import's source video
4809 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
4810 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
4815 description: Torrent file containing only the video file
4822 - $ref: '#/components/schemas/VideoImportStateConstant'
4838 - $ref: '#/components/schemas/Video'
4848 $ref: '#/components/schemas/VideoImport'
4852 $ref: '#/components/schemas/id'
4855 example: The video is a spam
4859 $ref: '#/components/schemas/AbusePredefinedReasons'
4861 $ref: '#/components/schemas/Account'
4863 $ref: '#/components/schemas/AbuseStateConstant'
4866 example: Decided to ban the server since it spams us regularly
4870 $ref: '#/components/schemas/VideoInfo'
4877 $ref: '#/components/schemas/id'
4888 $ref: '#/components/schemas/AccountSummary'
4892 $ref: '#/components/schemas/id'
4894 $ref: '#/components/schemas/Video/properties/id'
4906 $ref: '#/components/schemas/UUIDv4'
4924 $ref: '#/components/schemas/id'
4926 $ref: '#/components/schemas/UUIDv4'
4949 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4951 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4953 $ref: '#/components/schemas/AccountSummary'
4955 $ref: '#/components/schemas/VideoChannelSummary'
4959 $ref: '#/components/schemas/id'
4966 description: Text of the comment
4968 example: This video is wonderful!
4970 $ref: '#/components/schemas/id'
4974 - $ref: '#/components/schemas/id'
4976 $ref: '#/components/schemas/Video/properties/id'
4991 totalRepliesFromVideoAuthor:
4998 $ref: '#/components/schemas/Account'
4999 VideoCommentThreadTree:
5002 $ref: '#/components/schemas/VideoComment'
5006 $ref: '#/components/schemas/VideoCommentThreadTree'
5010 $ref: '#/components/schemas/VideoConstantString-Language'
5026 $ref: '#/components/schemas/id'
5043 $ref: '#/components/schemas/id'
5048 description: immutable name of the actor, used to find or mention it
5050 - $ref: '#/components/schemas/username'
5054 description: server on which the actor is resident
5055 hostRedundancyAllowed:
5057 description: whether this actor's host allows redundancy of its videos
5061 description: number of actors subscribed to by this actor, as seen by this instance
5065 description: number of followers of this actor, as seen by this instance
5073 $ref: '#/components/schemas/ActorImage'
5076 - $ref: '#/components/schemas/Actor'
5079 description: object id for the user tied to this account
5081 - $ref: '#/components/schemas/User/properties/id'
5084 description: editable name of the account, displayed in its representations
5089 description: text or bio displayed on the account's profile
5094 description: timestamp within the video, in seconds
5161 allowedForCurrentIP:
5163 requiresEmailVerification:
5181 $ref: '#/components/schemas/VideoResolutionSet'
5266 example: 16810141515
5369 requiresEmailVerification:
5384 description: Settings that apply to new users, if registration is enabled
5388 example: 16810141515
5394 description: Settings pertaining to transcoding jobs
5398 allowAdditionalExtensions:
5400 description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
5403 description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
5406 description: Amount of threads used by ffmpeg for 1 transcoding job
5409 description: Amount of transcoding jobs to execute in parallel
5415 New profiles can be added by plugins ; available in core PeerTube: 'default'.
5418 description: Resolutions to transcode _new videos_ to
5438 description: WebTorrent-specific settings
5444 description: HLS-specific settings
5488 $ref: '#/components/schemas/id'
5490 $ref: '#/components/schemas/Actor'
5492 $ref: '#/components/schemas/Actor'
5495 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
5508 PredefinedAbuseReasons:
5509 description: Reason categories that help triage reports
5527 $ref: '#/components/schemas/id'
5539 - activitypub-http-unicast
5540 - activitypub-http-broadcast
5541 - activitypub-http-fetcher
5542 - activitypub-follow
5548 - activitypub-refresher
5552 additionalProperties: true
5555 additionalProperties: true
5571 $ref: '#/components/schemas/id'
5576 $ref: '#/components/schemas/id'
5577 VideoUploadRequestCommon:
5580 description: Video name
5582 example: What is PeerTube?
5586 description: Channel id that will contain this video
5591 $ref: '#/components/schemas/VideoPrivacySet'
5593 $ref: '#/components/schemas/VideoCategorySet'
5595 $ref: '#/components/schemas/VideoLicenceSet'
5597 $ref: '#/components/schemas/VideoLanguageSet'
5599 description: Video description
5602 **[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)**
5604 description: Whether or not we wait transcoding before publish the video
5607 description: A text tell the audience how to support the video creator
5608 example: Please support our work on https://soutenir.framasoft.org/en/ <3
5611 description: Whether or not this video contains sensitive content
5614 description: Video tags (maximum 5 tags each between 2 and 30 characters)
5627 description: Enable or disable comments for this video
5630 description: Enable or disable downloading for this video
5632 originallyPublishedAt:
5633 description: Date when the content was originally published
5637 $ref: '#/components/schemas/VideoScheduledUpdate'
5639 description: Video thumbnail file
5643 description: Video preview file
5649 VideoUploadRequestLegacy:
5651 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5657 description: Video file
5660 VideoUploadRequestResumable:
5662 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5668 description: Video filename including extension
5671 example: what_is_peertube.mp4
5673 description: Video thumbnail file
5677 description: Video preview file
5680 VideoUploadResponse:
5686 $ref: '#/components/schemas/Video/properties/id'
5688 $ref: '#/components/schemas/Video/properties/uuid'
5689 CommentThreadResponse:
5698 $ref: '#/components/schemas/VideoComment'
5699 CommentThreadPostResponse:
5702 $ref: '#/components/schemas/VideoComment'
5712 $ref: '#/components/schemas/Video'
5716 $ref: '#/components/schemas/Account'
5719 description: Automatically start playing the upcoming video after the currently playing video
5720 autoPlayNextVideoPlaylist:
5722 description: Automatically start playing the video on the playlist after the currently playing video
5725 description: Automatically start playing the video on the watch page
5735 description: The user email
5738 description: Has the user confirmed their email address?
5741 - $ref: '#/components/schemas/id'
5745 description: Auth plugin to use to authenticate the user
5749 noInstanceConfigWarningModal:
5754 $ref: '#/components/schemas/NSFWPolicy'
5756 $ref: '#/components/schemas/UserRole'
5765 description: Theme enabled by this user
5767 $ref: '#/components/schemas/username'
5771 $ref: '#/components/schemas/VideoChannel'
5774 description: The user video quota in bytes
5778 description: The user daily video quota in bytes
5782 description: Enable P2P in the player
5785 - $ref: '#/components/schemas/User'
5787 # optionally present fields: they require WITH_STATS scope
5790 description: Count of videos published
5793 description: Count of reports/abuses of which the user is a target
5794 abusesAcceptedCount:
5796 description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team
5799 description: Count of reports/abuses created by the user
5802 description: Count of comments published
5806 $ref: '#/components/schemas/username'
5808 $ref: '#/components/schemas/password'
5812 description: The user email
5815 description: The user video quota in bytes
5819 description: The user daily video quota in bytes
5822 $ref: '#/components/schemas/usernameChannel'
5824 $ref: '#/components/schemas/UserRole'
5826 $ref: '#/components/schemas/UserAdminFlags'
5837 description: The updated email of the user
5839 - $ref: '#/components/schemas/User/properties/email'
5842 description: Set the email as verified
5845 description: The updated video quota of the user in bytes
5848 description: The updated daily video quota of the user in bytes
5852 description: The auth plugin to use to authenticate the user
5853 example: 'peertube-plugin-auth-saml2'
5855 $ref: '#/components/schemas/UserRole'
5857 $ref: '#/components/schemas/UserAdminFlags'
5859 # see shared/models/users/user-update-me.model.ts:
5862 $ref: '#/components/schemas/password'
5864 $ref: '#/components/schemas/password'
5866 description: new email used for login and service communications
5868 - $ref: '#/components/schemas/User/properties/email'
5871 description: new name of the user in its representations
5876 description: new NSFW display policy
5883 description: whether to enable P2P in the player or not
5886 description: new preference regarding playing videos automatically
5889 description: new preference regarding playing following videos automatically
5890 autoPlayNextVideoPlaylist:
5892 description: new preference regarding playing following playlist videos automatically
5893 videosHistoryEnabled:
5895 description: whether to keep track of watched history or not
5900 description: list of languages to filter videos down to
5903 noInstanceConfigWarningModal:
5910 $ref: '#/components/schemas/id'
5917 description: Rating of the video
5924 $ref: '#/components/schemas/Video'
5931 description: Rating of the video
5938 description: immutable name of the user, used to find or mention its actor
5940 - $ref: '#/components/schemas/username'
5942 $ref: '#/components/schemas/password'
5946 description: email of the user, used for login or service communications
5949 description: editable name of the user, displayed in its representations
5954 description: channel base information used to create the first channel of the user
5957 $ref: '#/components/schemas/usernameChannel'
5959 $ref: '#/components/schemas/VideoChannel/properties/displayName'
5967 # GET/POST/PUT properties
5970 description: editable name of the channel, displayed in its representations
5971 example: Videos of Framasoft
5976 example: Videos made with <3 by Framasoft
5981 description: text shown by default on all videos of this channel, to tell the audience how to support it
5982 example: Please support our work on https://soutenir.framasoft.org/en/ <3
5985 # GET-only properties
5989 - $ref: '#/components/schemas/id'
6005 $ref: '#/components/schemas/UUIDv4'
6008 - $ref: '#/components/schemas/VideoChannel'
6011 description: username of the channel to create
6013 - $ref: '#/components/schemas/usernameChannel'
6019 - $ref: '#/components/schemas/VideoChannel'
6021 bulkVideosSupportUpdate:
6023 description: Update the support field for all videos of this channel
6033 - $ref: '#/components/schemas/VideoChannel'
6034 - $ref: '#/components/schemas/Actor'
6039 name: 'media:peerLink'
6048 - application/x-bittorrent
6054 name: 'media:content'
6085 VideoCommentsForXML:
6120 description: video watch page URL
6123 description: video canonical URL
6127 description: video publication date
6130 description: video description
6133 description: video description
6136 description: publisher user name
6139 description: video category (MRSS)
6142 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
6157 description: video embed path, relative to the canonical URL domain (MRSS)
6166 description: video watch path, relative to the canonical URL domain (MRSS)
6187 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
6188 'media:description':
6195 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
6198 description: main streamable file for the video
6208 - application/x-bittorrent
6217 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)
6220 - $ref: '#/components/schemas/MRSSPeerLink'
6221 - $ref: '#/components/schemas/MRSSGroupContent'
6222 NotificationSettingValue:
6239 $ref: '#/components/schemas/id'
6243 Notification type, following the `UserNotificationType` enum:
6245 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
6247 - `2` NEW_COMMENT_ON_MY_VIDEO
6249 - `3` NEW_ABUSE_FOR_MODERATORS
6251 - `4` BLACKLIST_ON_MY_VIDEO
6253 - `5` UNBLACKLIST_ON_MY_VIDEO
6255 - `6` MY_VIDEO_PUBLISHED
6257 - `7` MY_VIDEO_IMPORT_SUCCESS
6259 - `8` MY_VIDEO_IMPORT_ERROR
6261 - `9` NEW_USER_REGISTRATION
6265 - `11` COMMENT_MENTION
6267 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
6269 - `13` NEW_INSTANCE_FOLLOWER
6271 - `14` AUTO_INSTANCE_FOLLOWING
6277 - $ref: '#/components/schemas/VideoInfo'
6281 $ref: '#/components/schemas/ActorInfo'
6287 $ref: '#/components/schemas/id'
6290 $ref: '#/components/schemas/VideoInfo'
6295 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
6305 $ref: '#/components/schemas/id'
6309 $ref: '#/components/schemas/VideoInfo'
6311 $ref: '#/components/schemas/ActorInfo'
6317 $ref: '#/components/schemas/id'
6320 - $ref: '#/components/schemas/VideoInfo'
6326 $ref: '#/components/schemas/id'
6329 - $ref: '#/components/schemas/VideoInfo'
6333 - $ref: '#/components/schemas/ActorInfo'
6339 $ref: '#/components/schemas/id'
6341 $ref: '#/components/schemas/ActorInfo'
6369 NotificationListResponse:
6378 $ref: '#/components/schemas/Notification'
6383 example: peertube-plugin-auth-ldap
6411 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
6414 additionalProperties: true
6430 $ref: '#/components/schemas/Plugin'
6437 description: User can stream multiple times in a permanent live
6446 description: RTMP stream key to use to stream into this live video
6450 description: User can stream multiple times in a permanent live
6457 'https://search.example.org/api/v1/search/videos':
6459 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
6462 description: successful operation
6466 $ref: '#/components/schemas/VideoListResponse'