6 name: PeerTube Community
7 url: 'https://joinpeertube.org'
10 url: 'https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE'
12 url: 'https://joinpeertube.org/img/brand.png'
13 altText: PeerTube Project Homepage
17 The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
18 HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
19 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
20 which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
22 - [Python](https://framagit.org/framasoft/peertube/clients/python)
23 - [Go](https://framagit.org/framasoft/peertube/clients/go)
24 - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
26 See the [Quick Start guide](https://docs.joinpeertube.org/api-rest-getting-started) so you can play with the PeerTube API.
30 When you sign up for an account, you are given the possibility to generate
31 sessions, and authenticate using this session token. One session token can
32 currently be used at a time.
36 Accounts are given permissions based on their role. There are three roles on
37 PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions.
41 The API uses standard HTTP status codes to indicate the success or failure
42 of the API call. The body of the response will be JSON in the following
47 "code": "unauthorized_request", // example inner error code
48 "error": "Token is invalid." // example exposed error message
52 url: https://docs.joinpeertube.org/api-rest-reference.html
56 Accounts encompass remote accounts discovered across the federation,
57 and correspond to the main Actor, along with video channels a user can create, which
60 When a comment is posted, it is done with your Account's Actor.
63 Using some features of PeerTube require authentication, for which User
64 provide different levels of permission as well as associated user
65 information. Each user has a corresponding local Account for federation.
68 Operations related to your own User, when logged-in.
69 - name: My Subscriptions
71 Operations related to your subscriptions to video channels, their
72 new videos, and how to keep up to date with their latest publications!
75 Operations related to your watch history.
76 - name: My Notifications
78 Notifications following new videos, follows or reports. They allow you
79 to keep track of the interactions and overall important information that
80 concerns you. You MAY set per-notification type delivery preference, to
81 receive the info either by mail, by in-browser notification or both.
84 Each server exposes public information regarding supported videos and
88 Jobs are long-running tasks enqueued and processed by the instance
89 itself. No additional worker registration is currently available.
90 - name: Instance Follows
92 Managing servers which the instance interacts with is crucial to the
93 concept of federation in PeerTube and external video indexation. The PeerTube
94 server then deals with inter-server ActivityPub operations and propagates
95 information across its social graph by posting activities to actors' inbox
98 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows
99 - name: Instance Redundancy
101 Redundancy is part of the inter-server solidarity that PeerTube fosters.
102 Manage the list of instances you wish to help by seeding their videos according
103 to the policy of video selection of your choice. Note that you have a similar functionality
104 to mirror individual videos, see `Video Mirroring`.
106 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy
109 Managing plugins installed from a local path or from NPM, or search for new ones.
111 url: https://docs.joinpeertube.org/api-plugins
114 Abuses deal with reports of local or remote videos/comments/accounts alike.
117 Operations dealing with listing, uploading, fetching or modifying videos.
120 The search helps to find _videos_ or _channels_ from within the instance and beyond.
121 Videos from other instances federated by the instance (that is, instances
122 followed by the instance) can be found via keywords and other criteria of
125 Administrators can also enable the use of a remote search system, indexing
126 videos and channels not could be not federated by the instance.
127 - name: Video Comments
129 Operations dealing with comments to a video. Comments are organized in
131 - name: Video Playlists
133 Operations dealing with playlists of videos. Playlists are bound to users
135 - name: Video Channels
137 Operations dealing with the creation, modification and listing of videos within a channel.
140 Operations dealing with blocking videos (removing them from view and
141 preventing interactions).
144 Like/dislike a video.
147 Server syndication feeds
165 - Video Ownership Change
178 - name: Instance Configuration
182 - Instance Redundancy
192 summary: Get an account
194 - $ref: '#/components/parameters/name'
197 description: successful operation
201 $ref: '#/components/schemas/Account'
203 description: account not found
204 '/accounts/{name}/videos':
209 summary: 'List videos of an account'
211 - $ref: '#/components/parameters/name'
212 - $ref: '#/components/parameters/categoryOneOf'
213 - $ref: '#/components/parameters/tagsOneOf'
214 - $ref: '#/components/parameters/tagsAllOf'
215 - $ref: '#/components/parameters/licenceOneOf'
216 - $ref: '#/components/parameters/languageOneOf'
217 - $ref: '#/components/parameters/nsfw'
218 - $ref: '#/components/parameters/filter'
219 - $ref: '#/components/parameters/skipCount'
220 - $ref: '#/components/parameters/start'
221 - $ref: '#/components/parameters/count'
222 - $ref: '#/components/parameters/videosSort'
225 description: successful operation
229 $ref: '#/components/schemas/VideoListResponse'
233 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
234 .then(function(response) {
235 return response.json()
236 }).then(function(data) {
242 curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
248 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
250 http = Net::HTTP.new(uri.host, uri.port)
253 response = http.get(uri.request_uri)
255 puts JSON.parse(response.read_body)
260 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
268 summary: List accounts
270 - $ref: '#/components/parameters/start'
271 - $ref: '#/components/parameters/count'
272 - $ref: '#/components/parameters/sort'
275 description: successful operation
281 $ref: '#/components/schemas/Account'
286 summary: Get instance public configuration
289 description: successful operation
293 $ref: '#/components/schemas/ServerConfig'
296 summary: Get instance "About" information
301 description: successful operation
305 $ref: '#/components/schemas/ServerConfigAbout'
308 summary: Get instance runtime configuration
316 description: successful operation
320 $ref: '#/components/schemas/ServerConfigCustom'
322 summary: Set instance runtime configuration
330 description: successful operation
332 x-summary: field inconsistencies
335 - the emailer is disabled and the instance is open to registrations
336 - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
338 summary: Delete instance runtime configuration
346 description: successful operation
349 summary: List instance jobs
359 description: The state of the job ('' for for no filter)
369 - $ref: '#/components/parameters/jobType'
370 - $ref: '#/components/parameters/start'
371 - $ref: '#/components/parameters/count'
372 - $ref: '#/components/parameters/sort'
375 description: successful operation
388 $ref: '#/components/schemas/Job'
389 '/server/following/{host}':
396 summary: Unfollow a server
401 description: 'The host to unfollow '
407 description: successful operation
412 summary: List instance followers
414 - $ref: '#/components/parameters/start'
415 - $ref: '#/components/parameters/count'
416 - $ref: '#/components/parameters/sort'
419 description: successful operation
425 $ref: '#/components/schemas/Follow'
430 summary: List instances followed by the server
449 - $ref: '#/components/parameters/start'
450 - $ref: '#/components/parameters/count'
451 - $ref: '#/components/parameters/sort'
454 description: successful operation
460 $ref: '#/components/schemas/Follow'
467 summary: Follow a server
470 description: successful operation
472 description: cannot follow a non-HTTPS server
487 summary: Create a user
495 description: user created
499 $ref: '#/components/schemas/AddUserResponse'
503 operationId: getUserId
505 id: '$response.body#/user/id'
508 operationId: putUserId
510 id: '$response.body#/user/id'
513 operationId: delUserId
515 id: '$response.body#/user/id'
517 description: insufficient authority to create an admin or moderator
522 $ref: '#/components/schemas/AddUser'
523 description: User to create
533 - $ref: '#/components/parameters/usersSearch'
534 - $ref: '#/components/parameters/usersBlocked'
535 - $ref: '#/components/parameters/start'
536 - $ref: '#/components/parameters/count'
537 - $ref: '#/components/parameters/usersSort'
540 description: successful operation
546 $ref: '#/components/schemas/User'
549 - $ref: '#/components/parameters/id'
551 summary: Delete a user
557 operationId: delUserId
560 description: successful operation
567 operationId: getUserId
570 description: successful operation
574 $ref: '#/components/schemas/User'
576 summary: Update a user
581 operationId: putUserId
584 description: successful operation
589 $ref: '#/components/schemas/UpdateUser'
593 summary: Register a user
598 description: successful operation
603 $ref: '#/components/schemas/RegisterUser'
607 summary: Get my user information
615 description: successful operation
621 $ref: '#/components/schemas/User'
623 summary: Update my user information
631 description: successful operation
636 $ref: '#/components/schemas/UpdateMe'
638 /users/me/videos/imports:
640 summary: Get video imports of my user
648 - $ref: '#/components/parameters/start'
649 - $ref: '#/components/parameters/count'
650 - $ref: '#/components/parameters/sort'
653 description: successful operation
657 $ref: '#/components/schemas/VideoImport'
658 /users/me/video-quota-used:
660 summary: Get my user used quota
668 description: successful operation
673 '/users/me/videos/{videoId}/rating':
675 summary: Get rate of my user for a video
685 description: 'The video id '
690 description: successful operation
694 $ref: '#/components/schemas/GetMeVideoRating'
697 summary: Get videos of my user
705 - $ref: '#/components/parameters/start'
706 - $ref: '#/components/parameters/count'
707 - $ref: '#/components/parameters/sort'
710 description: successful operation
714 $ref: '#/components/schemas/VideoListResponse'
715 /users/me/subscriptions:
717 summary: Get my user subscriptions
724 - $ref: '#/components/parameters/start'
725 - $ref: '#/components/parameters/count'
726 - $ref: '#/components/parameters/sort'
729 description: successful operation
733 summary: Add subscription to my user
746 description: uri of the video channels to subscribe to
752 uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
755 description: successful operation
756 /users/me/subscriptions/exist:
758 summary: Get if subscriptions exist for my user
765 - $ref: '#/components/parameters/subscriptionsUris'
768 description: successful operation
773 /users/me/subscriptions/videos:
775 summary: List videos of subscriptions of my user
783 - $ref: '#/components/parameters/categoryOneOf'
784 - $ref: '#/components/parameters/tagsOneOf'
785 - $ref: '#/components/parameters/tagsAllOf'
786 - $ref: '#/components/parameters/licenceOneOf'
787 - $ref: '#/components/parameters/languageOneOf'
788 - $ref: '#/components/parameters/nsfw'
789 - $ref: '#/components/parameters/filter'
790 - $ref: '#/components/parameters/skipCount'
791 - $ref: '#/components/parameters/start'
792 - $ref: '#/components/parameters/count'
793 - $ref: '#/components/parameters/videosSort'
796 description: successful operation
800 $ref: '#/components/schemas/VideoListResponse'
801 '/users/me/subscriptions/{subscriptionHandle}':
803 summary: Get subscription of my user
810 - $ref: '#/components/parameters/subscriptionHandle'
813 description: successful operation
817 $ref: '#/components/schemas/VideoChannel'
819 summary: Delete subscription of my user
826 - $ref: '#/components/parameters/subscriptionHandle'
829 description: successful operation
830 /users/me/notifications:
832 summary: List my notifications
840 description: only list unread notifications
843 - $ref: '#/components/parameters/start'
844 - $ref: '#/components/parameters/count'
845 - $ref: '#/components/parameters/sort'
848 description: successful operation
852 $ref: '#/components/schemas/NotificationListResponse'
853 /users/me/notifications/read:
855 summary: Mark notifications as read by their id
868 description: ids of the notifications to mark as read
875 description: successful operation
876 /users/me/notifications/read-all:
878 summary: Mark all my notification as read
885 description: successful operation
886 /users/me/notification-settings:
888 summary: Update my notification settings
899 newVideoFromSubscription:
900 $ref: '#/components/schemas/NotificationSettingValue'
902 $ref: '#/components/schemas/NotificationSettingValue'
904 $ref: '#/components/schemas/NotificationSettingValue'
905 videoAutoBlacklistAsModerator:
906 $ref: '#/components/schemas/NotificationSettingValue'
908 $ref: '#/components/schemas/NotificationSettingValue'
910 $ref: '#/components/schemas/NotificationSettingValue'
911 myVideoImportFinished:
912 $ref: '#/components/schemas/NotificationSettingValue'
914 $ref: '#/components/schemas/NotificationSettingValue'
916 $ref: '#/components/schemas/NotificationSettingValue'
918 $ref: '#/components/schemas/NotificationSettingValue'
920 $ref: '#/components/schemas/NotificationSettingValue'
921 autoInstanceFollowing:
922 $ref: '#/components/schemas/NotificationSettingValue'
925 description: successful operation
926 /users/me/history/videos:
928 summary: List watched videos history
934 - $ref: '#/components/parameters/start'
935 - $ref: '#/components/parameters/count'
936 - $ref: '#/components/parameters/search'
939 description: successful operation
943 $ref: '#/components/schemas/VideoListResponse'
944 /users/me/history/videos/remove:
946 summary: Clear video history
958 description: history before this date will be deleted
963 description: successful operation
964 /users/me/avatar/pick:
966 summary: Update my user avatar
973 description: successful operation
977 $ref: '#/components/schemas/Avatar'
979 description: image file too large
985 description: Maximum file size for the avatar
993 description: The file to upload.
998 contentType: image/png, image/jpeg
1001 summary: List video ownership changes
1003 - Video Ownership Change
1008 description: successful operation
1009 '/videos/ownership/{id}/accept':
1011 summary: Accept ownership change request
1013 - Video Ownership Change
1017 - $ref: '#/components/parameters/idOrUUID'
1020 description: successful operation
1022 description: cannot terminate an ownership change of another user
1024 description: video owneship change not found
1025 '/videos/ownership/{id}/refuse':
1027 summary: Refuse ownership change request
1029 - Video Ownership Change
1033 - $ref: '#/components/parameters/idOrUUID'
1036 description: successful operation
1038 description: cannot terminate an ownership change of another user
1040 description: video owneship change not found
1041 '/videos/{id}/give-ownership':
1043 summary: Request ownership change
1045 - Video Ownership Change
1049 - $ref: '#/components/parameters/idOrUUID'
1053 application/x-www-form-urlencoded:
1063 description: successful operation
1065 description: changing video ownership to a remote account is not supported yet
1067 description: video not found
1070 summary: List videos
1074 - $ref: '#/components/parameters/categoryOneOf'
1075 - $ref: '#/components/parameters/tagsOneOf'
1076 - $ref: '#/components/parameters/tagsAllOf'
1077 - $ref: '#/components/parameters/licenceOneOf'
1078 - $ref: '#/components/parameters/languageOneOf'
1079 - $ref: '#/components/parameters/nsfw'
1080 - $ref: '#/components/parameters/filter'
1081 - $ref: '#/components/parameters/skipCount'
1082 - $ref: '#/components/parameters/start'
1083 - $ref: '#/components/parameters/count'
1084 - $ref: '#/components/parameters/videosSort'
1087 description: successful operation
1091 $ref: '#/components/schemas/VideoListResponse'
1094 summary: List available video categories
1099 description: successful operation
1108 externalValue: https://peertube2.cpy.re/api/v1/videos/categories
1111 summary: List available video licences
1116 description: successful operation
1125 externalValue: https://peertube2.cpy.re/api/v1/videos/licences
1128 summary: List available video languages
1133 description: successful operation
1142 externalValue: https://peertube2.cpy.re/api/v1/videos/languages
1145 summary: List available video privacies
1150 description: successful operation
1159 externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
1162 summary: Update a video
1168 - $ref: '#/components/parameters/idOrUUID'
1171 description: successful operation
1174 multipart/form-data:
1179 description: Video thumbnail file
1183 description: Video preview file
1187 description: Video category
1191 description: Video licence
1195 description: Video language
1198 $ref: '#/components/schemas/VideoPrivacySet'
1200 description: Video description
1203 description: Whether or not we wait transcoding before publish the video
1206 description: A text tell the audience how to support the video creator
1207 example: Please support my work on <insert crowdfunding plateform>! <3
1210 description: Whether or not this video contains sensitive content
1213 description: Video name
1216 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1225 description: Enable or disable comments for this video
1227 originallyPublishedAt:
1228 description: Date when the content was originally published
1232 $ref: '#/components/schemas/VideoScheduledUpdate'
1235 contentType: image/jpeg
1237 contentType: image/jpeg
1239 summary: Get a video
1243 - $ref: '#/components/parameters/idOrUUID'
1246 description: successful operation
1250 $ref: '#/components/schemas/VideoDetails'
1252 summary: Delete a video
1258 - $ref: '#/components/parameters/idOrUUID'
1261 description: successful operation
1262 '/videos/{id}/description':
1264 summary: Get complete video description
1268 - $ref: '#/components/parameters/idOrUUID'
1271 description: successful operation
1276 '/videos/{id}/views':
1278 summary: Add a view to a video
1282 - $ref: '#/components/parameters/idOrUUID'
1285 description: successful operation
1286 '/videos/{id}/watching':
1288 summary: Set watching progress of a video
1294 - $ref: '#/components/parameters/idOrUUID'
1299 $ref: '#/components/schemas/UserWatchingVideo'
1303 description: successful operation
1306 summary: Upload a video
1313 description: successful operation
1317 $ref: '#/components/schemas/VideoUploadResponse'
1319 description: invalid file field, schedule date or parameter
1321 description: video didn't pass upload filter
1323 description: upload has timed out
1325 description: video file too large, due to quota or max body size limit set by the reverse-proxy
1327 X-File-Maximum-Size:
1331 description: Maximum file size for the video
1333 description: video type unsupported
1335 description: video unreadable
1338 multipart/form-data:
1343 description: Video file
1347 description: Channel id that will contain this video
1350 description: Video thumbnail file
1354 description: Video preview file
1358 $ref: '#/components/schemas/VideoPrivacySet'
1360 description: Video category
1364 description: Video licence
1368 description: Video language
1371 description: Video description
1374 description: Whether or not we wait transcoding before publish the video
1377 description: A text tell the audience how to support the video creator
1378 example: Please support my work on <insert crowdfunding plateform>! <3
1381 description: Whether or not this video contains sensitive content
1384 description: Video name
1387 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1397 description: Enable or disable comments for this video
1400 description: Enable or disable downloading for this video
1402 originallyPublishedAt:
1403 description: Date when the content was originally published
1407 $ref: '#/components/schemas/VideoScheduledUpdate'
1414 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1416 contentType: image/jpeg
1418 contentType: image/jpeg
1423 USERNAME="<your_username>"
1424 PASSWORD="<your_password>"
1425 FILE_PATH="<your_file_path>"
1426 CHANNEL_ID="<your_channel_id>"
1429 API_PATH="https://peertube2.cpy.re/api/v1"
1431 client_id=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1432 client_secret=$(curl -s "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1433 token=$(curl -s "$API_PATH/users/token" \
1434 --data client_id="$client_id" \
1435 --data client_secret="$client_secret" \
1436 --data grant_type=password \
1437 --data response_type=code \
1438 --data username="$USERNAME" \
1439 --data password="$PASSWORD" \
1440 | jq -r ".access_token")
1442 curl -s "$API_PATH/videos/upload" \
1443 -H "Authorization: Bearer $token" \
1445 --form videofile=@"$FILE_PATH" \
1446 --form channelId=$CHANNEL_ID \
1450 summary: Import a video
1451 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1458 multipart/form-data:
1463 description: Torrent File
1467 description: HTTP target URL
1470 description: Magnet URI
1473 description: Channel id that will contain this video
1476 description: Video thumbnail file
1480 description: Video preview file
1484 $ref: '#/components/schemas/VideoPrivacySet'
1486 description: Video category
1490 description: Video licence
1494 description: Video language
1497 description: Video description
1500 description: Whether or not we wait transcoding before publish the video
1503 description: A text tell the audience how to support the video creator
1504 example: Please support my work on <insert crowdfunding plateform>! <3
1507 description: Whether or not this video contains sensitive content
1510 description: Video name
1513 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1522 description: Enable or disable comments for this video
1525 description: Enable or disable downloading for this video
1528 $ref: '#/components/schemas/VideoScheduledUpdate'
1534 contentType: application/x-bittorrent
1536 contentType: image/jpeg
1538 contentType: image/jpeg
1541 description: successful operation
1545 $ref: '#/components/schemas/VideoUploadResponse'
1547 description: '`magnetUri` or `targetUrl` or a torrent file missing'
1549 description: video didn't pass pre-import filter
1551 description: HTTP or Torrent/magnetURI import not enabled
1555 summary: Create a live
1563 description: successful operation
1567 $ref: '#/components/schemas/VideoUploadResponse'
1569 description: Live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
1572 multipart/form-data:
1577 description: Channel id that will contain this live video
1582 description: User can stream multiple times in a permanent live
1585 description: Live video/replay thumbnail file
1589 description: Live video/replay preview file
1593 $ref: '#/components/schemas/VideoPrivacySet'
1595 description: Live video/replay category
1598 description: Live video/replay licence
1601 description: Live video/replay language
1604 description: Live video/replay description
1607 description: A text tell the audience how to support the creator
1608 example: Please support my work on <insert crowdfunding plateform>! <3
1611 description: Whether or not this live video/replay contains sensitive content
1614 description: Live video/replay name
1617 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
1626 description: Enable or disable comments for this live video/replay
1629 description: Enable or disable downloading for the replay of this live
1636 contentType: image/jpeg
1638 contentType: image/jpeg
1642 summary: Get a live information
1649 - $ref: '#/components/parameters/idOrUUID'
1652 description: successful operation
1656 $ref: '#/components/schemas/LiveVideoResponse'
1658 summary: Update a live information
1665 - $ref: '#/components/parameters/idOrUUID'
1670 $ref: '#/components/schemas/LiveVideoUpdate'
1673 description: Successful operation
1675 description: Bad parameters or trying to update a live that has already started
1677 description: Trying to save replay of the live but saving replay is not enabled on the instance
1681 summary: List my abuses
1690 description: only list the report with this id
1696 $ref: '#/components/schemas/AbuseStateSet'
1697 - $ref: '#/components/parameters/start'
1698 - $ref: '#/components/parameters/count'
1699 - $ref: '#/components/parameters/abusesSort'
1702 description: successful operation
1708 $ref: '#/components/schemas/Abuse'
1712 summary: List abuses
1722 description: only list the report with this id
1725 - name: predefinedReason
1727 description: predefined reason the listed reports should contain
1729 $ref: '#/components/schemas/PredefinedAbuseReasons'
1732 description: plain search that will match with video titles, reporter names and more
1738 $ref: '#/components/schemas/AbuseStateSet'
1739 - name: searchReporter
1741 description: only list reports of a specific reporter
1744 - name: searchReportee
1745 description: only list reports of a specific reportee
1751 description: only list reports of a specific video
1754 - name: searchVideoChannel
1756 description: only list reports of a specific video channel
1761 description: only list blacklisted or deleted videos
1769 description: only list account, comment or video reports
1776 - $ref: '#/components/parameters/start'
1777 - $ref: '#/components/parameters/count'
1778 - $ref: '#/components/parameters/abusesSort'
1781 description: successful operation
1787 $ref: '#/components/schemas/Abuse'
1790 summary: Report an abuse
1803 description: Reason why the user reports this video
1807 $ref: '#/components/schemas/PredefinedAbuseReasons'
1813 description: Video id to report
1817 description: Timestamp in the video that marks the beginning of the report
1821 description: Timestamp in the video that marks the ending of the report
1827 description: Comment id to report
1833 description: Account id to report
1839 description: successful operation
1841 description: incorrect request parameters
1842 '/abuses/{abuseId}':
1844 summary: Update an abuse
1852 - $ref: '#/components/parameters/abuseId'
1860 $ref: '#/components/schemas/AbuseStateSet'
1863 description: Update the report comment visible only to the moderation team
1866 description: successful operation
1868 description: abuse not found
1872 summary: Delete an abuse
1878 - $ref: '#/components/parameters/abuseId'
1881 description: successful operation
1883 description: block not found
1884 '/abuses/{abuseId}/messages':
1886 summary: List messages of an abuse
1892 - $ref: '#/components/parameters/abuseId'
1895 description: successful operation
1901 $ref: '#/components/schemas/AbuseMessage'
1904 summary: Add message to an abuse
1910 - $ref: '#/components/parameters/abuseId'
1919 description: Message to send
1925 description: successful operation
1927 description: incorrect request parameters
1928 '/abuses/{abuseId}/messages/{abuseMessageId}':
1930 summary: Delete an abuse message
1936 - $ref: '#/components/parameters/abuseId'
1937 - $ref: '#/components/parameters/abuseMessageId'
1940 description: successful operation
1942 '/videos/{id}/blacklist':
1944 summary: Block a video
1952 - $ref: '#/components/parameters/idOrUUID'
1955 description: successful operation
1957 summary: Unblock a video by its id
1965 - $ref: '#/components/parameters/idOrUUID'
1968 description: successful operation
1970 description: block not found
1975 summary: List video blocks
1984 list only blocks that match this type:
1988 - `2`: automatic block that needs review
1996 description: plain search that will match with video titles, and more
1999 - $ref: '#/components/parameters/start'
2000 - $ref: '#/components/parameters/count'
2001 - $ref: '#/components/parameters/blacklistsSort'
2004 description: successful operation
2016 $ref: '#/components/schemas/VideoBlacklist'
2017 /videos/{id}/captions:
2019 summary: List captions of a video
2023 - $ref: '#/components/parameters/idOrUUID'
2026 description: successful operation
2038 $ref: '#/components/schemas/VideoCaption'
2039 /videos/{id}/captions/{captionLanguage}:
2041 summary: Add or replace a video caption
2048 - $ref: '#/components/parameters/idOrUUID'
2049 - $ref: '#/components/parameters/captionLanguage'
2052 multipart/form-data:
2057 description: The file to upload.
2062 contentType: text/vtt, application/x-subrip, text/plain
2065 description: successful operation
2067 description: video or language not found
2069 summary: Delete a video caption
2076 - $ref: '#/components/parameters/idOrUUID'
2077 - $ref: '#/components/parameters/captionLanguage'
2080 description: successful operation
2082 description: video or language or caption for that language not found
2085 summary: List video channels
2089 - $ref: '#/components/parameters/start'
2090 - $ref: '#/components/parameters/count'
2091 - $ref: '#/components/parameters/sort'
2094 description: successful operation
2106 $ref: '#/components/schemas/VideoChannel'
2108 summary: Create a video channel
2115 description: successful operation
2120 $ref: '#/components/schemas/VideoChannelCreate'
2121 '/video-channels/{channelHandle}':
2123 summary: Get a video channel
2127 - $ref: '#/components/parameters/channelHandle'
2130 description: successful operation
2134 $ref: '#/components/schemas/VideoChannel'
2136 summary: Update a video channel
2142 - $ref: '#/components/parameters/channelHandle'
2145 description: successful operation
2150 $ref: '#/components/schemas/VideoChannelUpdate'
2152 summary: Delete a video channel
2158 - $ref: '#/components/parameters/channelHandle'
2161 description: successful operation
2162 '/video-channels/{channelHandle}/videos':
2164 summary: List videos of a video channel
2169 - $ref: '#/components/parameters/channelHandle'
2170 - $ref: '#/components/parameters/categoryOneOf'
2171 - $ref: '#/components/parameters/tagsOneOf'
2172 - $ref: '#/components/parameters/tagsAllOf'
2173 - $ref: '#/components/parameters/licenceOneOf'
2174 - $ref: '#/components/parameters/languageOneOf'
2175 - $ref: '#/components/parameters/nsfw'
2176 - $ref: '#/components/parameters/filter'
2177 - $ref: '#/components/parameters/skipCount'
2178 - $ref: '#/components/parameters/start'
2179 - $ref: '#/components/parameters/count'
2180 - $ref: '#/components/parameters/videosSort'
2183 description: successful operation
2187 $ref: '#/components/schemas/VideoListResponse'
2189 /video-playlists/privacies:
2191 summary: List available playlist privacies
2196 description: successful operation
2205 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
2209 summary: List video playlists
2213 - $ref: '#/components/parameters/start'
2214 - $ref: '#/components/parameters/count'
2215 - $ref: '#/components/parameters/sort'
2218 description: successful operation
2230 $ref: '#/components/schemas/VideoPlaylist'
2232 summary: Create a video playlist
2233 description: 'If the video playlist is set as public, the videoChannelId is mandatory.'
2240 description: successful operation
2255 multipart/form-data:
2260 description: Video playlist display name
2263 description: Video playlist thumbnail file
2267 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2269 description: Video playlist description
2272 description: Video channel in which the playlist will be published
2278 contentType: image/jpeg
2280 /video-playlists/{id}:
2282 summary: Get a video playlist
2286 - $ref: '#/components/parameters/idOrUUID'
2289 description: successful operation
2293 $ref: '#/components/schemas/VideoPlaylist'
2295 summary: Update a video playlist
2296 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
2303 description: successful operation
2305 - $ref: '#/components/parameters/idOrUUID'
2308 multipart/form-data:
2313 description: Video playlist display name
2316 description: Video playlist thumbnail file
2320 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
2322 description: Video playlist description
2325 description: Video channel in which the playlist will be published
2329 contentType: image/jpeg
2331 summary: Delete a video playlist
2337 - $ref: '#/components/parameters/idOrUUID'
2340 description: successful operation
2342 /video-playlists/{id}/videos:
2344 summary: 'List videos of a playlist'
2349 - $ref: '#/components/parameters/idOrUUID'
2352 description: successful operation
2356 $ref: '#/components/schemas/VideoListResponse'
2358 summary: 'Add a video in a playlist'
2365 - $ref: '#/components/parameters/idOrUUID'
2368 description: successful operation
2374 videoPlaylistElement:
2387 description: 'Video to add in the playlist'
2390 description: 'Start the video at this specific timestamp (in seconds)'
2393 description: 'Stop the video at this specific timestamp (in seconds)'
2397 /video-playlists/{id}/videos/reorder:
2399 summary: 'Reorder a playlist'
2405 - $ref: '#/components/parameters/idOrUUID'
2408 description: successful operation
2417 description: 'Start position of the element to reorder'
2419 insertAfterPosition:
2421 description: 'New position for the block to reorder, to add the block before the first element'
2425 description: 'How many element from `startPosition` to reorder'
2429 - insertAfterPosition
2431 /video-playlists/{id}/videos/{playlistElementId}:
2433 summary: 'Update a playlist element'
2439 - $ref: '#/components/parameters/idOrUUID'
2440 - $ref: '#/components/parameters/playlistElementId'
2443 description: successful operation
2452 description: 'Start the video at this specific timestamp (in seconds)'
2455 description: 'Stop the video at this specific timestamp (in seconds)'
2457 summary: 'Delete an element from a playlist'
2463 - $ref: '#/components/parameters/idOrUUID'
2464 - $ref: '#/components/parameters/playlistElementId'
2467 description: successful operation
2469 '/users/me/video-playlists/videos-exist':
2471 summary: 'Check video exists in my playlists'
2480 description: The video ids to check
2487 description: successful operation
2507 '/accounts/{name}/video-channels':
2509 summary: List video channels of an account
2514 - $ref: '#/components/parameters/name'
2517 description: include view statistics for the last 30 days (only if authentified as the account user)
2520 - $ref: '#/components/parameters/start'
2521 - $ref: '#/components/parameters/count'
2522 - $ref: '#/components/parameters/sort'
2525 description: successful operation
2531 $ref: '#/components/schemas/VideoChannel'
2532 '/accounts/{name}/ratings':
2534 summary: List ratings of an account
2540 - $ref: '#/components/parameters/name'
2541 - $ref: '#/components/parameters/start'
2542 - $ref: '#/components/parameters/count'
2543 - $ref: '#/components/parameters/sort'
2547 description: Optionally filter which ratings to retrieve
2555 description: successful operation
2561 $ref: '#/components/schemas/VideoRating'
2562 '/videos/{id}/comment-threads':
2564 summary: List threads of a video
2568 - $ref: '#/components/parameters/idOrUUID'
2569 - $ref: '#/components/parameters/start'
2570 - $ref: '#/components/parameters/count'
2571 - $ref: '#/components/parameters/commentsSort'
2574 description: successful operation
2578 $ref: '#/components/schemas/CommentThreadResponse'
2580 summary: Create a thread
2586 - $ref: '#/components/parameters/idOrUUID'
2589 description: successful operation
2593 $ref: '#/components/schemas/CommentThreadPostResponse'
2595 description: video does not exist
2604 description: 'Text comment'
2608 '/videos/{id}/comment-threads/{threadId}':
2610 summary: Get a thread
2614 - $ref: '#/components/parameters/idOrUUID'
2615 - $ref: '#/components/parameters/threadId'
2618 description: successful operation
2622 $ref: '#/components/schemas/VideoCommentThreadTree'
2623 '/videos/{id}/comments/{commentId}':
2625 summary: Reply to a thread of a video
2631 - $ref: '#/components/parameters/idOrUUID'
2632 - $ref: '#/components/parameters/commentId'
2635 description: successful operation
2639 $ref: '#/components/schemas/CommentThreadPostResponse'
2641 description: thread or video does not exist
2650 description: 'Text comment'
2655 summary: Delete a comment or a reply
2661 - $ref: '#/components/parameters/idOrUUID'
2662 - $ref: '#/components/parameters/commentId'
2665 description: successful operation
2667 description: cannot remove comment of another user
2669 description: comment or video does not exist
2671 description: comment is already deleted
2672 '/videos/{id}/rate':
2674 summary: Like/dislike a video
2680 - $ref: '#/components/parameters/idOrUUID'
2683 description: successful operation
2685 description: video does not exist
2690 summary: Search videos
2695 allowEmptyValue: false
2697 String to search. If the user can make a remote URI search, and the string is an URI then the
2698 PeerTube instance will fetch the remote object and add it to its database. Then,
2699 you can use the REST API to fetch the complete video information and interact with it.
2702 - $ref: '#/components/parameters/categoryOneOf'
2703 - $ref: '#/components/parameters/tagsOneOf'
2704 - $ref: '#/components/parameters/tagsAllOf'
2705 - $ref: '#/components/parameters/licenceOneOf'
2706 - $ref: '#/components/parameters/languageOneOf'
2707 - $ref: '#/components/parameters/nsfw'
2708 - $ref: '#/components/parameters/filter'
2709 - $ref: '#/components/parameters/skipCount'
2710 - $ref: '#/components/parameters/start'
2711 - $ref: '#/components/parameters/count'
2712 - $ref: '#/components/parameters/searchTarget'
2713 - $ref: '#/components/parameters/videosSearchSort'
2716 description: Get videos that are published after this date
2722 description: Get videos that are published before this date
2726 - name: originallyPublishedStartDate
2728 description: Get videos that are originally published after this date
2732 - name: originallyPublishedEndDate
2734 description: Get videos that are originally published before this date
2740 description: Get videos that have this minimum duration
2745 description: Get videos that have this maximum duration
2749 'searchTarget === search-index':
2750 $ref: '#/components/callbacks/searchIndex'
2753 description: successful operation
2757 $ref: '#/components/schemas/VideoListResponse'
2759 description: search index unavailable
2760 /search/video-channels:
2764 summary: Search channels
2770 String to search. If the user can make a remote URI search, and the string is an URI then the
2771 PeerTube instance will fetch the remote object and add it to its database. Then,
2772 you can use the REST API to fetch the complete channel information and interact with it.
2775 - $ref: '#/components/parameters/start'
2776 - $ref: '#/components/parameters/count'
2777 - $ref: '#/components/parameters/searchTarget'
2778 - $ref: '#/components/parameters/sort'
2780 'searchTarget === search-index':
2781 $ref: '#/components/callbacks/searchIndex'
2784 description: successful operation
2790 $ref: '#/components/schemas/VideoChannel'
2792 description: search index unavailable
2793 /blocklist/accounts:
2797 summary: List account blocks
2802 - $ref: '#/components/parameters/start'
2803 - $ref: '#/components/parameters/count'
2804 - $ref: '#/components/parameters/sort'
2807 description: successful operation
2811 summary: Block an account
2823 example: chocobozzz@example.org
2824 description: account to block, in the form `username@domain`
2829 description: successful operation
2831 description: self-blocking forbidden
2832 '/blocklist/accounts/{accountName}':
2836 summary: Unblock an account by its handle
2844 description: account to unblock, in the form `username@domain`
2849 description: successful operation
2851 description: account or account block does not exist
2856 summary: List server blocks
2861 - $ref: '#/components/parameters/start'
2862 - $ref: '#/components/parameters/count'
2863 - $ref: '#/components/parameters/sort'
2866 description: successful operation
2870 summary: Block a server
2883 description: server domain to block
2888 description: successful operation
2890 description: self-blocking forbidden
2891 '/blocklist/servers/{host}':
2895 summary: Unblock a server by its domain
2903 description: server domain to unblock
2909 description: successful operation
2911 description: account block does not exist
2915 - Instance Redundancy
2916 summary: Update a server redundancy policy
2924 description: server domain to mirror
2936 description: allow mirroring of the host's local videos
2941 description: successful operation
2943 description: server is not already known
2948 summary: List videos being mirrored
2956 description: direction of the mirror
2962 - $ref: '#/components/parameters/start'
2963 - $ref: '#/components/parameters/count'
2964 - $ref: '#/components/parameters/videoRedundanciesSort'
2967 description: successful operation
2973 $ref: '#/components/schemas/VideoRedundancy'
2977 summary: Mirror a video
2993 description: successful operation
2995 description: cannot mirror a local video
2997 description: video does not exist
2999 description: video is already mirrored
3000 /redundancy/videos/{redundancyId}:
3004 summary: Delete a mirror done on a video
3009 - name: redundancyId
3012 description: id of an existing redundancy on a video
3017 description: successful operation
3019 description: video redundancy not found
3020 '/feeds/video-comments.{format}':
3024 summary: List comments on videos
3026 - url: 'https://peertube2.cpy.re'
3027 description: Live Test Server (live data - latest nightly version)
3028 - url: 'https://peertube3.cpy.re'
3029 description: Live Test Server (live data - latest RC version)
3030 - url: 'https://peertube.cpy.re'
3031 description: Live Test Server (live data - stable version)
3036 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3049 description: 'limit listing to a specific video'
3054 description: 'limit listing to a specific account'
3059 description: 'limit listing to a specific account'
3062 - name: videoChannelId
3064 description: 'limit listing to a specific video channel'
3067 - name: videoChannelName
3069 description: 'limit listing to a specific video channel'
3074 description: successful operation
3079 default: 'max-age=900' # 15 min cache
3083 $ref: '#/components/schemas/VideoCommentsForXML'
3084 application/rss+xml:
3086 $ref: '#/components/schemas/VideoCommentsForXML'
3089 $ref: '#/components/schemas/VideoCommentsForXML'
3090 application/atom+xml:
3092 $ref: '#/components/schemas/VideoCommentsForXML'
3097 x-summary: field inconsistencies
3100 - videoId filter is mixed with a channel filter
3102 description: video, video channel or account not found
3104 description: accept header unsupported
3105 '/feeds/videos.{format}':
3109 summary: List videos
3111 - url: 'https://peertube2.cpy.re'
3112 description: Live Test Server (live data - latest nightly version)
3113 - url: 'https://peertube3.cpy.re'
3114 description: Live Test Server (live data - latest RC version)
3115 - url: 'https://peertube.cpy.re'
3116 description: Live Test Server (live data - stable version)
3121 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
3134 description: 'limit listing to a specific account'
3139 description: 'limit listing to a specific account'
3142 - name: videoChannelId
3144 description: 'limit listing to a specific video channel'
3147 - name: videoChannelName
3149 description: 'limit listing to a specific video channel'
3152 - $ref: '#/components/parameters/sort'
3153 - $ref: '#/components/parameters/nsfw'
3154 - $ref: '#/components/parameters/filter'
3157 description: successful operation
3162 default: 'max-age=900' # 15 min cache
3166 $ref: '#/components/schemas/VideosForXML'
3169 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
3170 application/rss+xml:
3172 $ref: '#/components/schemas/VideosForXML'
3175 $ref: '#/components/schemas/VideosForXML'
3176 application/atom+xml:
3178 $ref: '#/components/schemas/VideosForXML'
3183 description: video channel or account not found
3185 description: accept header unsupported
3190 summary: List plugins
3203 - $ref: '#/components/parameters/start'
3204 - $ref: '#/components/parameters/count'
3205 - $ref: '#/components/parameters/sort'
3208 description: successful operation
3212 $ref: '#/components/schemas/PluginResponse'
3217 summary: List available plugins
3230 - name: currentPeerTubeEngine
3234 - $ref: '#/components/parameters/start'
3235 - $ref: '#/components/parameters/count'
3236 - $ref: '#/components/parameters/sort'
3239 description: successful operation
3243 $ref: '#/components/schemas/PluginResponse'
3245 description: plugin index unavailable
3250 summary: Install a plugin
3263 example: peertube-plugin-auth-ldap
3266 additionalProperties: false
3273 additionalProperties: false
3276 description: successful operation
3278 description: should have either `npmName` or `path` set
3283 summary: Update a plugin
3296 example: peertube-plugin-auth-ldap
3299 additionalProperties: false
3306 additionalProperties: false
3309 description: successful operation
3311 description: should have either `npmName` or `path` set
3313 description: existing plugin not found
3318 summary: Uninstall a plugin
3330 description: name of the plugin/theme in its package.json
3331 example: peertube-plugin-auth-ldap
3336 description: successful operation
3338 description: existing plugin not found
3343 summary: Get a plugin
3348 - $ref: '#/components/parameters/npmName'
3351 description: successful operation
3355 $ref: '#/components/schemas/Plugin'
3357 description: plugin not found
3358 /plugins/{npmName}/settings:
3362 summary: Set a plugin's settings
3367 - $ref: '#/components/parameters/npmName'
3376 additionalProperties: true
3379 description: successful operation
3381 description: plugin not found
3382 /plugins/{npmName}/public-settings:
3386 summary: Get a plugin's public settings
3388 - $ref: '#/components/parameters/npmName'
3391 description: successful operation
3396 additionalProperties: true
3398 description: plugin not found
3399 /plugins/{npmName}/registered-settings:
3403 summary: Get a plugin's registered settings
3408 - $ref: '#/components/parameters/npmName'
3411 description: successful operation
3416 additionalProperties: true
3418 description: plugin not found
3420 - url: 'https://peertube2.cpy.re/api/v1'
3421 description: Live Test Server (live data - latest nightly version)
3422 - url: 'https://peertube3.cpy.re/api/v1'
3423 description: Live Test Server (live data - latest RC version)
3424 - url: 'https://peertube.cpy.re/api/v1'
3425 description: Live Test Server (live data - stable version)
3432 description: Offset used to paginate results
3440 description: "Number of items to return"
3450 description: Sort column
3458 description: Plain text search, applied to various parts of the model depending on endpoint
3466 If the administrator enabled search index support, you can override the default search target.
3469 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
3470 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
3471 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
3472 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
3473 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
3474 * 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
3475 the data from the origin instance API
3485 description: Sort videos by criteria
3501 description: Sort videos by criteria
3516 description: Sort comments by criteria
3526 description: Sort blacklists by criteria
3542 description: Plain text search that will match with user usernames or emails
3549 description: Filter results down to (un)banned users
3556 description: Sort users by criteria
3567 description: Sort abuses by criteria
3574 videoRedundanciesSort:
3578 description: Sort abuses by criteria
3587 description: The username or handle of the account
3590 example: chocobozzz | chocobozzz@example.org
3595 description: The user id
3604 description: The object id or uuid
3612 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
3614 name: playlistElementId
3617 description: Playlist element id
3624 description: Abuse id
3628 name: abuseMessageId
3631 description: Abuse message id
3635 name: captionLanguage
3638 description: The caption language
3645 description: The video channel handle
3648 example: my_username | my_username@example.com
3650 name: subscriptionHandle
3653 description: The subscription handle
3656 example: my_username | my_username@example.com
3661 description: The thread id (root comment id)
3668 description: The comment id
3675 description: category id of the video (see [/videos/categories](#tag/Video/paths/~1videos~1categories/get))
3688 description: tag(s) of the video
3701 description: tag(s) of the video, where all should be present in the video
3714 description: language id of the video (see [/videos/languages](#tag/Video/paths/~1videos~1languages/get)). Use `_unknown` to filter on videos that don't have a video language
3727 description: licence id of the video (see [/videos/licences](#tag/Video/paths/~1videos~1licences/get))
3740 description: if you don't need the `total` in the response
3751 description: whether to include nsfw videos, if any
3762 Special filters which might require special rights:
3763 * `local` - only videos local to the instance
3764 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
3765 * `all` - all videos, showing private and unlisted videos (requires Admin privileges)
3775 description: list of uris to check if each is part of the user subscriptions
3785 description: name of the plugin/theme on npmjs.com or in its package.json
3788 example: peertube-plugin-auth-ldap
3793 description: job type
3797 - activitypub-follow
3798 - activitypub-http-broadcast
3799 - activitypub-http-fetcher
3800 - activitypub-http-unicast
3806 - activitypub-refresher
3812 In the header: *Authorization: Bearer <token\>*
3815 Authenticating via OAuth requires the following steps:
3818 - Have an account with sufficient authorization levels
3820 - [Generate](https://docs.joinpeertube.org/api-rest-getting-started) a
3823 - Make Authenticated Requests
3827 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
3830 moderator: Moderator scope
3833 VideoConstantNumber:
3839 VideoConstantString:
3846 VideoPlaylistPrivacySet:
3852 description: 'The video playlist privacy (Public = `1`, Unlisted = `2`, Private = `3`)'
3853 VideoPlaylistPrivacyConstant:
3856 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
3860 VideoPlaylistTypeSet:
3865 description: 'The video playlist type (Regular = `1`, Watch Later = `2`)'
3866 VideoPlaylistTypeConstant:
3869 $ref: '#/components/schemas/VideoPlaylistTypeSet'
3880 description: 'The video privacy (Public = `1`, Unlisted = `2`, Private = `3`, Internal = `4`)'
3881 VideoPrivacyConstant:
3884 $ref: '#/components/schemas/VideoPrivacySet'
3901 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
3908 description: 'Admin flags for the user (None = `0`, Bypass video blacklist = `1`)'
3919 description: 'The video state (Published = `1`, to transcode = `2`, to import = `3`)'
3929 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
3933 $ref: '#/components/schemas/AbuseStateSet'
3936 AbusePredefinedReasons:
3949 example: [spamOrMisleading]
3951 VideoResolutionConstant:
3955 description: 'Video resolution (240, 360, 720, 1080, 1440 or 2160)'
3960 VideoScheduledUpdate:
3963 $ref: '#/components/schemas/VideoPrivacySet'
3967 description: When to update the video
3987 - $ref: '#/components/schemas/Avatar'
3988 VideoChannelSummary:
4005 - $ref: '#/components/schemas/Avatar'
4017 - $ref: '#/components/schemas/Video'
4023 $ref: '#/components/schemas/VideoResolutionConstant'
4026 description: 'Video file size in bytes'
4044 VideoStreamingPlaylists:
4052 description: 'Playlist type (HLS = `1`)'
4061 description: 'Video files associated to this playlist. The difference with the root "files" property is that these files are fragmented, so they can be used in this streaming playlist (HLS etc)'
4063 $ref: '#/components/schemas/VideoFile'
4079 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4090 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4102 originallyPublishedAt:
4106 $ref: '#/components/schemas/VideoConstantNumber'
4108 $ref: '#/components/schemas/VideoConstantNumber'
4110 $ref: '#/components/schemas/VideoConstantString'
4112 $ref: '#/components/schemas/VideoPrivacyConstant'
4122 example: What is PeerTube?
4125 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4128 example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
4131 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
4147 $ref: '#/components/schemas/VideoStateConstant'
4151 - $ref: '#/components/schemas/VideoScheduledUpdate'
4159 $ref: '#/components/schemas/AccountSummary'
4161 $ref: '#/components/schemas/VideoChannelSummary'
4170 - $ref: '#/components/schemas/Video'
4177 description: A text tell the audience how to support the video creator
4178 example: Please support my work on <insert crowdfunding plateform>! <3
4180 $ref: '#/components/schemas/VideoChannel'
4182 $ref: '#/components/schemas/Account'
4187 example: [flowers, gardening]
4190 description: 'WebTorrent/raw video files. Can be empty if WebTorrent is disabled on the server. In this case, video files will be in the "streamingPlaylists[].files" property'
4192 $ref: '#/components/schemas/VideoFile'
4205 $ref: '#/components/schemas/VideoStreamingPlaylists'
4206 FileRedundancyInformation:
4243 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4250 $ref: '#/components/schemas/FileRedundancyInformation'
4254 $ref: '#/components/schemas/FileRedundancyInformation'
4255 VideoImportStateConstant:
4263 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
4275 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
4279 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
4283 $ref: '#/components/schemas/VideoImportStateConstant'
4293 $ref: '#/components/schemas/Video'
4301 example: The video is a spam
4303 $ref: '#/components/schemas/AbusePredefinedReasons'
4305 $ref: '#/components/schemas/Account'
4307 $ref: '#/components/schemas/AbuseStateConstant'
4310 example: Decided to ban the server since it spams us regularly
4321 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4337 $ref: '#/components/schemas/AccountSummary'
4355 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4384 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4400 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4410 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
4412 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
4414 $ref: '#/components/schemas/AccountSummary'
4416 $ref: '#/components/schemas/VideoChannelSummary'
4438 totalRepliesFromVideoAuthor:
4443 $ref: '#/components/schemas/Account'
4444 VideoCommentThreadTree:
4447 $ref: '#/components/schemas/VideoComment'
4451 $ref: '#/components/schemas/VideoCommentThreadTree'
4455 $ref: '#/components/schemas/VideoConstantString'
4510 $ref: '#/components/schemas/Avatar'
4513 - $ref: '#/components/schemas/Actor'
4526 description: timestamp within the video, in seconds
4593 allowedForCurrentIP:
4595 requiresEmailVerification:
4799 requiresEmailVerification:
4824 allowAdditionalExtensions:
4894 $ref: '#/components/schemas/Actor'
4896 $ref: '#/components/schemas/Actor'
4899 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
4912 PredefinedAbuseReasons:
4913 description: Reason categories that help triage reports
4944 - activitypub-http-unicast
4945 - activitypub-http-broadcast
4946 - activitypub-http-fetcher
4947 - activitypub-follow
4953 - activitypub-refresher
4957 additionalProperties: true
4960 additionalProperties: true
4984 VideoUploadResponse:
4995 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
4996 CommentThreadResponse:
5005 $ref: '#/components/schemas/VideoComment'
5006 CommentThreadPostResponse:
5009 $ref: '#/components/schemas/VideoComment'
5019 $ref: '#/components/schemas/Video'
5027 description: The user username
5033 description: The user email
5036 description: Auth plugin to use to authenticate the user
5039 description: Theme enabled by this user
5042 description: Has the user confirmed their email address?
5044 $ref: '#/components/schemas/NSFWPolicy'
5047 description: Enable P2P in the player
5050 description: Automatically start playing the video on the watch page
5052 $ref: '#/components/schemas/UserRole'
5061 description: The user video quota
5064 description: The user daily video quota
5069 abusesAcceptedCount:
5075 noInstanceConfigWarningModal:
5086 $ref: '#/components/schemas/Account'
5090 $ref: '#/components/schemas/VideoChannel'
5095 description: The user username
5101 description: The user password. If the smtp server is configured, you can leave empty and an email will be sent
5107 description: The user email
5110 description: The user video quota
5113 description: The user daily video quota
5116 description: The user default channel username
5118 $ref: '#/components/schemas/UserRole'
5120 $ref: '#/components/schemas/UserAdminFlags'
5132 description: The user id
5136 description: The updated email of the user
5139 description: Set the email as verified
5142 description: The updated video quota of the user
5145 description: The updated daily video quota of the user
5149 description: The auth plugin to use to authenticate the user
5150 example: 'peertube-plugin-auth-saml2'
5152 $ref: '#/components/schemas/UserRole'
5154 $ref: '#/components/schemas/UserAdminFlags'
5162 description: Your new password
5168 description: Your new email
5171 description: Your new displayNSFW
5178 description: Your new autoPlayVideo
5188 description: Id of the video
5191 description: Rating of the video
5198 $ref: '#/components/schemas/Video'
5201 description: 'Rating of the video'
5209 description: The username of the user
5212 pattern: '/^[a-z0-9._]{1,50}$/'
5216 description: The password of the user
5222 description: The email of the user
5225 description: The user display name
5233 description: The username for the default channel
5234 pattern: '/^[ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789\\-_.:]+$/'
5237 description: The display name for the default channel
5254 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
5255 example: Please support my work on <insert crowdfunding plateform>! <3
5267 description: 'A text shown by default on all videos of this channel, to tell the audience how to support it'
5268 example: Please support my work on <insert crowdfunding plateform>! <3
5269 bulkVideosSupportUpdate:
5271 description: 'Update the support field for all videos of this channel'
5276 name: 'media:peerLink'
5285 - application/x-bittorrent
5291 name: 'media:content'
5322 VideoCommentsForXML:
5357 description: video watch page URL
5360 description: video canonical URL
5364 description: video publication date
5367 description: video description
5370 description: video description
5373 description: publisher user name
5376 description: video category (MRSS)
5379 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
5394 description: video embed path, relative to the canonical URL domain (MRSS)
5403 description: video watch path, relative to the canonical URL domain (MRSS)
5424 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
5425 'media:description':
5432 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
5435 description: main streamable file for the video
5445 - application/x-bittorrent
5454 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)
5457 - $ref: '#/components/schemas/MRSSPeerLink'
5458 - $ref: '#/components/schemas/MRSSGroupContent'
5459 NotificationSettingValue:
5480 Notification type, following the `UserNotificationType` enum:
5482 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
5484 - `2` NEW_COMMENT_ON_MY_VIDEO
5486 - `3` NEW_ABUSE_FOR_MODERATORS
5488 - `4` BLACKLIST_ON_MY_VIDEO
5490 - `5` UNBLACKLIST_ON_MY_VIDEO
5492 - `6` MY_VIDEO_PUBLISHED
5494 - `7` MY_VIDEO_IMPORT_SUCCESS
5496 - `8` MY_VIDEO_IMPORT_ERROR
5498 - `9` NEW_USER_REGISTRATION
5502 - `11` COMMENT_MENTION
5504 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
5506 - `13` NEW_INSTANCE_FOLLOWER
5508 - `14` AUTO_INSTANCE_FOLLOWING
5514 - $ref: '#/components/schemas/VideoInfo'
5518 $ref: '#/components/schemas/ActorInfo'
5527 $ref: '#/components/schemas/VideoInfo'
5548 $ref: '#/components/schemas/VideoInfo'
5550 $ref: '#/components/schemas/ActorInfo'
5559 - $ref: '#/components/schemas/VideoInfo'
5568 - $ref: '#/components/schemas/VideoInfo'
5572 - $ref: '#/components/schemas/ActorInfo'
5580 $ref: '#/components/schemas/ActorInfo'
5608 NotificationListResponse:
5617 $ref: '#/components/schemas/Notification'
5622 example: peertube-plugin-auth-ldap
5650 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
5653 additionalProperties: true
5669 $ref: '#/components/schemas/Plugin'
5676 description: User can stream multiple times in a permanent live
5685 description: RTMP stream key to use to stream into this live video
5689 description: User can stream multiple times in a permanent live
5694 'https://search.example.org/api/v1/search/videos':
5696 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
5699 description: successful operation
5703 $ref: '#/components/schemas/VideoListResponse'