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
16 The PeerTube API is built on HTTP(S). Our API is RESTful. It has predictable
17 resource URLs. It returns HTTP response codes to indicate errors. It also
18 accepts and returns JSON in the HTTP body. You can use your favorite
19 HTTP/REST library for your programming language to use PeerTube. No official
20 SDK is currently provided, but the spec API is fully compatible with
21 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
22 which generates a client SDK in the language of your choice.
25 When you sign up for an account, you are given the possibility to generate
26 sessions, and authenticate using this session token. One session token can
27 currently be used at a time.
30 The API uses standard HTTP status codes to indicate the success or failure
31 of the API call. The body of the response will be JSON in the following
36 "code": "unauthorized_request", // example inner error code
37 "error": "Token is invalid." // example exposed error message
41 url: https://docs.joinpeertube.org/api-rest-reference.html
45 Using some features of PeerTube require authentication, for which Accounts
46 provide different levels of permission as well as associated user
47 information. Accounts also encompass remote accounts discovered across the federation.
50 Each server exposes public information regarding supported videos and
54 Feeds of videos and feeds of comments allow to see updates and get them in
55 an aggregator or script of your choice.
58 Jobs are long-running tasks enqueued and processed by the instance
59 itself. No additional worker registration is currently available.
60 - name: Server Following
62 Managing servers which the instance interacts with is crucial to the
63 concept of federation in PeerTube and external video indexation. The PeerTube
64 server then deals with inter-server ActivityPub operations and propagates
65 information across its social graph by posting activities to actors' inbox
69 Video abuses deal with reports of local or remote videos alike.
72 Operations dealing with listing, uploading, fetching or modifying videos.
75 The search helps to find _videos_ from within the instance and beyond.
76 Videos from other instances federated by the instance (that is, instances
77 followed by the instance) can be found via keywords and other criteria of
81 Operations dealing with comments to a video. Comments are organized in
85 Operations dealing with creation, modification and video listing of a
87 - name: Video Blacklist
89 Operations dealing with blacklisting videos (removing them from view and
90 preventing interactions).
112 - name: Instance Configuration
116 - name: Notifications
130 summary: Get the account by name
132 - $ref: '#/components/parameters/name'
135 description: successful operation
139 $ref: '#/components/schemas/Account'
140 '/accounts/{name}/videos':
145 summary: 'Get videos for an account, provided the name of that account'
147 - $ref: '#/components/parameters/name'
150 description: successful operation
154 $ref: '#/components/schemas/VideoListResponse'
158 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
159 .then(function(response) {
160 return response.json()
161 }).then(function(data) {
167 http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
173 url = URI("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
175 http = Net::HTTP.new(url.host, url.port)
177 http.verify_mode = OpenSSL::SSL::VERIFY_NONE
179 request = Net::HTTP::Post.new(url)
180 request["content-type"] = 'application/json'
181 response = http.request(request)
182 puts response.read_body
187 conn = http.client.HTTPSConnection("https://peertube2.cpy.re/api/v1")
190 'content-type': "application/json"
193 conn.request("POST", "/accounts/{name}/videos", None, headers)
195 res = conn.getresponse()
198 print(data.decode("utf-8"))
203 summary: Get all accounts
205 - $ref: '#/components/parameters/start'
206 - $ref: '#/components/parameters/count'
207 - $ref: '#/components/parameters/sort'
210 description: successful operation
216 $ref: '#/components/schemas/Account'
221 summary: Get the public configuration of the server
224 description: successful operation
228 $ref: '#/components/schemas/ServerConfig'
231 summary: Get the instance about page content
236 description: successful operation
240 $ref: '#/components/schemas/ServerConfigAbout'
243 summary: Get the runtime configuration of the server
251 description: successful operation
255 $ref: '#/components/schemas/ServerConfigCustom'
257 summary: Set the runtime configuration of the server
265 description: successful operation
267 summary: Delete the runtime configuration of the server
275 description: successful operation
276 '/feeds/videos.{format}':
279 Get the feed of videos for the server, with optional filter by account
288 The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and
289 json to JSON FEED 1.0
301 The id of the local account to filter to (beware, users IDs and not
302 actors IDs which will return empty feeds
308 description: The name of the local account to filter to
313 description: successful operation
316 summary: Get list of jobs
326 description: The state of the job
335 - $ref: '#/components/parameters/start'
336 - $ref: '#/components/parameters/count'
337 - $ref: '#/components/parameters/sort'
340 description: successful operation
346 $ref: '#/components/schemas/Job'
347 '/server/following/{host}':
354 summary: Unfollow a server by hostname
359 description: 'The host to unfollow '
364 description: successful operation
369 summary: Get followers of the server
371 - $ref: '#/components/parameters/start'
372 - $ref: '#/components/parameters/count'
373 - $ref: '#/components/parameters/sort'
376 description: successful operation
382 $ref: '#/components/schemas/Follow'
387 summary: Get servers followed by the server
389 - $ref: '#/components/parameters/start'
390 - $ref: '#/components/parameters/count'
391 - $ref: '#/components/parameters/sort'
394 description: successful operation
400 $ref: '#/components/schemas/Follow'
407 summary: Follow a server
410 $ref: '#/paths/~1users~1me/put/responses/204'
415 $ref: '#/components/schemas/Follow'
418 summary: Creates user
426 description: successful operation
430 $ref: '#/components/schemas/AddUserResponse'
435 $ref: '#/components/schemas/AddUser'
436 description: User to create
439 summary: Get a list of users
445 - $ref: '#/components/parameters/start'
446 - $ref: '#/components/parameters/count'
447 - $ref: '#/components/parameters/usersSort'
450 description: successful operation
456 $ref: '#/components/schemas/User'
459 summary: Delete a user by its id
466 - $ref: '#/components/parameters/id'
469 $ref: '#/paths/~1users~1me/put/responses/204'
471 summary: Get user by its id
477 - $ref: '#/components/parameters/id'
480 description: successful operation
484 $ref: '#/components/schemas/User'
486 summary: Update user profile by its id
492 - $ref: '#/components/parameters/id'
495 $ref: '#/paths/~1users~1me/put/responses/204'
500 $ref: '#/components/schemas/UpdateUser'
504 summary: Register a user
509 $ref: '#/paths/~1users~1me/put/responses/204'
514 $ref: '#/components/schemas/RegisterUser'
518 summary: Get current user information
526 description: successful operation
532 $ref: '#/components/schemas/User'
534 summary: Update current user information
542 description: successful operation
547 $ref: '#/components/schemas/UpdateMe'
549 /users/me/videos/imports:
551 summary: Get video imports of current user
558 - $ref: '#/components/parameters/start'
559 - $ref: '#/components/parameters/count'
560 - $ref: '#/components/parameters/sort'
563 description: successful operation
567 $ref: '#/components/schemas/VideoImport'
568 /users/me/video-quota-used:
570 summary: Get current user used quota
578 description: successful operation
583 '/users/me/videos/{videoId}/rating':
585 summary: 'Get rating of video by its id, among those of the current user'
594 description: 'The video id '
599 description: successful operation
603 $ref: '#/components/schemas/GetMeVideoRating'
606 summary: Get videos of the current user
613 - $ref: '#/components/parameters/start'
614 - $ref: '#/components/parameters/count'
615 - $ref: '#/components/parameters/sort'
618 description: successful operation
622 $ref: '#/components/schemas/VideoListResponse'
623 /users/me/subscriptions:
625 summary: Get subscriptions of the current user
632 - $ref: '#/components/parameters/start'
633 - $ref: '#/components/parameters/count'
634 - $ref: '#/components/parameters/sort'
637 description: successful operation
639 summary: Add subscription to the current user
647 description: successful operation
648 /users/me/subscriptions/exist:
650 summary: Get if subscriptions exist for the current user
657 - $ref: '#/components/parameters/subscriptionsUris'
660 description: successful operation
665 /users/me/subscriptions/videos:
667 summary: Get videos of subscriptions of the current user
674 - $ref: '#/components/parameters/start'
675 - $ref: '#/components/parameters/count'
676 - $ref: '#/components/parameters/sort'
679 description: successful operation
683 $ref: '#/components/schemas/VideoListResponse'
684 '/users/me/subscriptions/{subscriptionHandle}':
686 summary: Get subscription of the current user for a given uri
693 - $ref: '#/components/parameters/subscriptionHandle'
696 description: successful operation
700 $ref: '#/components/schemas/VideoChannel'
702 summary: Delete subscription of the current user for a given uri
709 - $ref: '#/components/parameters/subscriptionHandle'
712 description: successful operation
713 /users/me/avatar/pick:
715 summary: Update current user avatar
722 description: successful operation
726 $ref: '#/components/schemas/Avatar'
734 description: The file to upload.
739 contentType: image/png, image/jpeg
742 summary: Get list of videos
746 - $ref: '#/components/parameters/categoryOneOf'
747 - $ref: '#/components/parameters/tagsOneOf'
748 - $ref: '#/components/parameters/tagsAllOf'
749 - $ref: '#/components/parameters/licenceOneOf'
750 - $ref: '#/components/parameters/languageOneOf'
751 - $ref: '#/components/parameters/nsfw'
752 - $ref: '#/components/parameters/filter'
753 - $ref: '#/components/parameters/start'
754 - $ref: '#/components/parameters/count'
755 - $ref: '#/components/parameters/videosSort'
758 description: successful operation
762 $ref: '#/components/schemas/VideoListResponse'
765 summary: Get list of video categories known by the server
770 description: successful operation
779 summary: Get list of video licences known by the server
784 description: successful operation
793 summary: Get list of languages known by the server
798 description: successful operation
807 summary: Get list of privacy policies supported by the server
812 description: successful operation
821 summary: Update metadata for a video by its id
827 - $ref: '#/components/parameters/idOrUUID'
830 description: successful operation
838 description: Video thumbnail file
842 description: Video preview file
846 description: Video category
849 description: Video licence
852 description: Video language
855 description: Video description
858 description: Whether or not we wait transcoding before publish the video
861 description: Text describing how to support the video uploader
864 description: Whether or not this video contains sensitive content
867 description: Video name
870 description: Video tags (maximum 5 tags each between 2 and 30 characters)
879 description: Enable or disable comments for this video
881 originallyPublishedAt:
882 description: Date when the content was originally published
886 $ref: '#/components/schemas/VideoScheduledUpdate'
889 contentType: image/jpeg
891 contentType: image/jpeg
893 summary: Get a video by its id
897 - $ref: '#/components/parameters/idOrUUID'
900 description: successful operation
904 $ref: '#/components/schemas/VideoDetails'
906 summary: Delete a video by its id
912 - $ref: '#/components/parameters/idOrUUID'
915 $ref: '#/paths/~1users~1me/put/responses/204'
916 '/videos/{id}/description':
918 summary: Get a video description by its id
922 - $ref: '#/components/parameters/idOrUUID'
925 description: successful operation
930 '/videos/{id}/views':
932 summary: Add a view to the video by its id
936 - $ref: '#/components/parameters/idOrUUID'
939 $ref: '#/paths/~1users~1me/put/responses/204'
940 '/videos/{id}/watching':
942 summary: Set watching progress of a video by its id for a user
948 - $ref: '#/components/parameters/idOrUUID'
953 $ref: '#/components/schemas/UserWatchingVideo'
957 $ref: '#/paths/~1users~1me/put/responses/204'
960 summary: Get list of video ownership changes requests
967 description: successful operation
968 '/videos/ownership/{id}/accept':
970 summary: Refuse ownership change request for video by its id
976 - $ref: '#/components/parameters/idOrUUID'
979 $ref: '#/paths/~1users~1me/put/responses/204'
980 '/videos/ownership/{id}/refuse':
982 summary: Accept ownership change request for video by its id
988 - $ref: '#/components/parameters/idOrUUID'
991 $ref: '#/paths/~1users~1me/put/responses/204'
992 '/videos/{id}/give-ownership':
994 summary: Request change of ownership for a video you own, by its id
1000 - $ref: '#/components/parameters/idOrUUID'
1004 application/x-www-form-urlencoded:
1014 $ref: '#/paths/~1users~1me/put/responses/204'
1016 description: 'Changing video ownership to a remote account is not supported yet'
1019 summary: Upload a video file with its metadata
1026 description: successful operation
1030 $ref: '#/components/schemas/VideoUploadResponse'
1033 multipart/form-data:
1038 description: Video file
1042 description: Channel id that will contain this video
1045 description: Video thumbnail file
1049 description: Video preview file
1053 $ref: '#/components/schemas/VideoPrivacySet'
1055 description: Video category
1058 description: Video licence
1061 description: Video language
1064 description: Video description
1067 description: Whether or not we wait transcoding before publish the video
1070 description: Text describing how to support the video uploader
1073 description: Whether or not this video contains sensitive content
1076 description: Video name
1079 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1088 description: Enable or disable comments for this video
1090 originallyPublishedAt:
1091 description: Date when the content was originally published
1095 $ref: '#/components/schemas/VideoScheduledUpdate'
1102 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1104 contentType: image/jpeg
1106 contentType: image/jpeg
1110 ## DEPENDENCIES: httpie, jq
1111 # pip install httpie
1112 USERNAME="<your_username>"
1113 PASSWORD="<your_password>"
1114 FILE_PATH="<your_file_path>"
1115 CHANNEL_ID="<your_channel_id>"
1118 API_PATH="https://peertube2.cpy.re/api/v1"
1120 client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1121 client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1122 token=$(http -b --form POST "$API_PATH/users/token" \
1123 client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
1124 username=$USERNAME \
1125 password=$PASSWORD \
1126 | jq -r ".access_token")
1128 http -b --form POST "$API_PATH/videos/upload" \
1129 videofile@$FILE_PATH \
1130 channelId=$CHANNEL_ID \
1132 "Authorization:Bearer $token"
1135 summary: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1142 description: successful operation
1146 $ref: '#/components/schemas/VideoUploadResponse'
1149 multipart/form-data:
1154 description: Torrent File
1158 description: HTTP target URL
1161 description: Magnet URI
1164 description: Channel id that will contain this video
1167 description: Video thumbnail file
1171 description: Video preview file
1175 $ref: '#/components/schemas/VideoPrivacySet'
1177 description: Video category
1180 description: Video licence
1183 description: Video language
1186 description: Video description
1189 description: Whether or not we wait transcoding before publish the video
1192 description: Text describing how to support the video uploader
1195 description: Whether or not this video contains sensitive content
1198 description: Video name
1201 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1210 description: Enable or disable comments for this video
1213 $ref: '#/components/schemas/VideoScheduledUpdate'
1219 contentType: application/x-bittorrent
1221 contentType: image/jpeg
1223 contentType: image/jpeg
1226 summary: Get list of reported video abuses
1232 - $ref: '#/components/parameters/start'
1233 - $ref: '#/components/parameters/count'
1234 - $ref: '#/components/parameters/abusesSort'
1237 description: successful operation
1243 $ref: '#/components/schemas/VideoAbuse'
1244 '/videos/{id}/abuse':
1246 summary: 'Report an abuse, on a video by its id'
1252 - $ref: '#/components/parameters/idOrUUID'
1255 $ref: '#/paths/~1users~1me/put/responses/204'
1256 '/videos/{id}/blacklist':
1258 summary: Put on blacklist a video by its id
1266 - $ref: '#/components/parameters/idOrUUID'
1269 $ref: '#/paths/~1users~1me/put/responses/204'
1271 summary: Delete an entry of the blacklist of a video by its id
1279 - $ref: '#/components/parameters/idOrUUID'
1282 $ref: '#/paths/~1users~1me/put/responses/204'
1285 summary: Get list of videos on blacklist
1293 - $ref: '#/components/parameters/start'
1294 - $ref: '#/components/parameters/count'
1295 - $ref: '#/components/parameters/blacklistsSort'
1298 description: successful operation
1304 $ref: '#/components/schemas/VideoBlacklist'
1305 /videos/{id}/captions:
1307 summary: Get list of video's captions
1311 - $ref: '#/components/parameters/idOrUUID'
1314 description: successful operation
1325 $ref: '#/components/schemas/VideoCaption'
1326 /videos/{id}/captions/{captionLanguage}:
1328 summary: Add or replace a video caption
1332 - $ref: '#/components/parameters/idOrUUID'
1333 - $ref: '#/components/parameters/captionLanguage'
1336 multipart/form-data:
1341 description: The file to upload.
1346 contentType: text/vtt, application/x-subrip
1349 $ref: '#/paths/~1users~1me/put/responses/204'
1351 summary: Delete a video caption
1355 - $ref: '#/components/parameters/idOrUUID'
1356 - $ref: '#/components/parameters/captionLanguage'
1359 $ref: '#/paths/~1users~1me/put/responses/204'
1362 summary: Get list of video channels
1366 - $ref: '#/components/parameters/start'
1367 - $ref: '#/components/parameters/count'
1368 - $ref: '#/components/parameters/sort'
1371 description: successful operation
1377 $ref: '#/components/schemas/VideoChannel'
1379 summary: Creates a video channel for the current user
1386 $ref: '#/paths/~1users~1me/put/responses/204'
1391 $ref: '#/components/schemas/VideoChannelCreate'
1392 '/video-channels/{channelHandle}':
1394 summary: Get a video channel by its id
1398 - $ref: '#/components/parameters/channelHandle'
1401 description: successful operation
1405 $ref: '#/components/schemas/VideoChannel'
1407 summary: Update a video channel by its id
1413 - $ref: '#/components/parameters/channelHandle'
1416 $ref: '#/paths/~1users~1me/put/responses/204'
1421 $ref: '#/components/schemas/VideoChannelUpdate'
1423 summary: Delete a video channel by its id
1429 - $ref: '#/components/parameters/channelHandle'
1432 $ref: '#/paths/~1users~1me/put/responses/204'
1433 '/video-channels/{channelHandle}/videos':
1435 summary: Get videos of a video channel by its id
1440 - $ref: '#/components/parameters/channelHandle'
1443 description: successful operation
1447 $ref: '#/components/schemas/VideoListResponse'
1448 '/accounts/{name}/video-channels':
1450 summary: Get video channels of an account by its name
1454 - $ref: '#/components/parameters/name'
1457 description: successful operation
1463 $ref: '#/components/schemas/VideoChannel'
1464 '/accounts/{name}/ratings':
1466 summary: Get ratings of an account by its name
1472 - $ref: '#/components/parameters/name'
1473 - $ref: '#/components/parameters/start'
1474 - $ref: '#/components/parameters/count'
1475 - $ref: '#/components/parameters/sort'
1479 description: Optionally filter which ratings to retrieve
1487 description: successful operation
1493 $ref: '#/components/schemas/VideoRating'
1494 '/videos/{id}/comment-threads':
1496 summary: Get the comment threads of a video by its id
1500 - $ref: '#/components/parameters/idOrUUID'
1501 - $ref: '#/components/parameters/start'
1502 - $ref: '#/components/parameters/count'
1503 - $ref: '#/components/parameters/sort'
1506 description: successful operation
1510 $ref: '#/components/schemas/CommentThreadResponse'
1512 summary: 'Creates a comment thread, on a video by its id'
1518 - $ref: '#/components/parameters/idOrUUID'
1521 description: successful operation
1525 $ref: '#/components/schemas/CommentThreadPostResponse'
1526 '/videos/{id}/comment-threads/{threadId}':
1528 summary: 'Get the comment thread by its id, of a video by its id'
1532 - $ref: '#/components/parameters/idOrUUID'
1533 - $ref: '#/components/parameters/threadId'
1536 description: successful operation
1540 $ref: '#/components/schemas/VideoCommentThreadTree'
1541 '/videos/{id}/comments/{commentId}':
1543 summary: 'Creates a comment in a comment thread by its id, of a video by its id'
1549 - $ref: '#/components/parameters/idOrUUID'
1550 - $ref: '#/components/parameters/commentId'
1553 description: successful operation
1557 $ref: '#/components/schemas/CommentThreadPostResponse'
1559 summary: 'Delete a comment in a comment thread by its id, of a video by its id'
1565 - $ref: '#/components/parameters/idOrUUID'
1566 - $ref: '#/components/parameters/commentId'
1569 $ref: '#/paths/~1users~1me/put/responses/204'
1570 '/videos/{id}/rate':
1572 summary: Vote for a video by its id
1578 - $ref: '#/components/parameters/idOrUUID'
1581 $ref: '#/paths/~1users~1me/put/responses/204'
1586 summary: Get the videos corresponding to a given query
1588 - $ref: '#/components/parameters/start'
1589 - $ref: '#/components/parameters/count'
1590 - $ref: '#/components/parameters/videosSearchSort'
1594 description: String to search
1599 description: successful operation
1603 $ref: '#/components/schemas/VideoListResponse'
1605 - url: 'https://peertube.cpy.re/api/v1'
1606 description: Live Test Server (live data - stable version)
1607 - url: 'https://peertube2.cpy.re/api/v1'
1608 description: Live Test Server (live data - bleeding edge version)
1609 - url: 'https://peertube3.cpy.re/api/v1'
1610 description: Live Test Server (live data - bleeding edge version)
1624 description: Number of items
1631 description: Sort column (-createdAt for example)
1638 description: Sort videos by criteria
1653 description: Sort videos by criteria
1668 description: Sort blacklists by criteria
1684 description: Sort users by criteria
1695 description: Sort abuses by criteria
1707 The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
1715 description: The user id
1722 description: The video id or uuid
1726 name: captionLanguage
1729 description: The caption language
1736 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
1740 name: subscriptionHandle
1743 description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
1750 description: The thread id (root comment id)
1757 description: The comment id
1764 description: category id of the video
1777 description: tag(s) of the video
1790 description: tag(s) of the video, where all should be present in the video
1803 description: language id of the video
1816 description: licence id of the video
1829 description: whether to include nsfw videos, if any
1840 Special filters (local for instance) which might require special rights:
1841 * `local` - only videos local to the instance
1842 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
1852 description: list of uris to check if each is part of the user subscriptions
1860 In the header: *Authorization: Bearer <token\>*
1863 Authenticating via OAuth requires the following steps:
1866 - Have an account with sufficient authorization levels
1868 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
1871 - Make Authenticated Requests
1875 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
1878 moderator: Moderator scope
1881 VideoConstantNumber:
1887 VideoConstantString:
1899 description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
1900 VideoPrivacyConstant:
1918 description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
1921 VideoResolutionConstant:
1925 description: 'Video resolution (240, 360, 720 ...)'
1928 VideoScheduledUpdate:
1931 $ref: '#/components/schemas/VideoPrivacySet'
1932 description: Video privacy target
1936 description: When to update the video
1939 VideoAccountSummary:
1953 $ref: '#/components/schemas/Avatar'
1954 VideoChannelSummary:
1968 $ref: '#/components/schemas/Avatar'
1979 $ref: '#/components/schemas/Video'
1985 $ref: '#/components/schemas/VideoResolutionConstant'
1988 description: 'Video file size in bytes'
1999 VideoStreamingPlaylists:
2007 description: 'Playlist type (HLS = 1)'
2031 originallyPublishedAt:
2034 $ref: '#/components/schemas/VideoConstantNumber'
2036 $ref: '#/components/schemas/VideoConstantNumber'
2038 $ref: '#/components/schemas/VideoConstantString'
2040 $ref: '#/components/schemas/VideoPrivacyConstant'
2067 $ref: '#/components/schemas/VideoStateConstant'
2070 $ref: '#/components/schemas/VideoScheduledUpdate'
2078 $ref: '#/components/schemas/VideoAccountSummary'
2080 $ref: '#/components/schemas/VideoChannelSummary'
2089 - $ref: '#/components/schemas/Video'
2097 $ref: '#/components/schemas/VideoChannel'
2099 $ref: '#/components/schemas/Account'
2107 $ref: '#/components/schemas/VideoFile'
2119 $ref: '#/components/schemas/VideoStreamingPlaylists'
2120 VideoImportStateConstant:
2128 description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
2145 $ref: '#/components/schemas/VideoImportStateConstant'
2155 $ref: '#/components/schemas/Video'
2163 $ref: '#/components/schemas/Account'
2239 $ref: '#/components/schemas/Account'
2240 VideoCommentThreadTree:
2243 $ref: '#/components/schemas/VideoComment'
2247 $ref: '#/components/schemas/VideoCommentThreadTree'
2251 $ref: '#/components/schemas/VideoConstantString'
2281 $ref: '#/components/schemas/Avatar'
2284 - $ref: '#/components/schemas/Actor'
2310 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2324 $ref: '#/components/schemas/Account'
2328 $ref: '#/components/schemas/VideoChannel'
2388 allowedForCurrentIP:
2390 requiresEmailVerification:
2577 requiresEmailVerification:
2601 allowAdditionalExtensions:
2669 $ref: '#/components/schemas/Actor'
2671 $ref: '#/components/schemas/Actor'
2713 VideoUploadResponse:
2722 CommentThreadResponse:
2729 $ref: '#/components/schemas/VideoComment'
2730 CommentThreadPostResponse:
2733 $ref: '#/components/schemas/VideoComment'
2741 $ref: '#/components/schemas/Video'
2746 description: 'The user username '
2749 description: 'The user password '
2752 description: 'The user email '
2755 description: 'The user videoQuota '
2758 description: 'The user daily video quota '
2765 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2777 description: 'The user id '
2780 description: 'The updated email of the user '
2783 description: 'The updated videoQuota of the user '
2786 description: 'The updated daily video quota of the user '
2793 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2804 description: 'Your new password '
2807 description: 'Your new email '
2810 description: 'Your new displayNSFW '
2813 description: 'Your new autoPlayVideo '
2823 description: 'Id of the video '
2826 description: 'Rating of the video '
2833 $ref: '#/components/schemas/Video'
2836 description: 'Rating of the video'
2844 description: 'The username of the user '
2847 description: 'The password of the user '
2850 description: 'The email of the user '
2853 description: 'The user display name'
2859 description: 'The default channel name'
2862 description: 'The default channel display name'
2889 bulkVideosSupportUpdate:
2891 description: 'Update all videos support field of this channel'