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 Jobs are long-running tasks enqueued and processed by the instance
55 itself. No additional worker registration is currently available.
56 - name: Server Following
58 Managing servers which the instance interacts with is crucial to the
59 concept of federation in PeerTube and external video indexation. The PeerTube
60 server then deals with inter-server ActivityPub operations and propagates
61 information across its social graph by posting activities to actors' inbox
65 Video abuses deal with reports of local or remote videos alike.
68 Operations dealing with listing, uploading, fetching or modifying videos.
71 The search helps to find _videos_ from within the instance and beyond.
72 Videos from other instances federated by the instance (that is, instances
73 followed by the instance) can be found via keywords and other criteria of
77 Operations dealing with comments to a video. Comments are organized in
79 - name: Video Playlist
81 Operations dealing with playlists of videos. Playlists are bound to users
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
127 summary: Get the account by name
129 - $ref: '#/components/parameters/name'
132 description: successful operation
136 $ref: '#/components/schemas/Account'
137 '/accounts/{name}/videos':
142 summary: 'Get videos for an account, provided the name of that account'
144 - $ref: '#/components/parameters/name'
147 description: successful operation
151 $ref: '#/components/schemas/VideoListResponse'
155 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
156 .then(function(response) {
157 return response.json()
158 }).then(function(data) {
164 http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
170 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
172 http = Net::HTTP.new(uri.host, uri.port)
175 response = http.get(uri.request_uri)
177 puts JSON.parse(response.read_body)
182 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
190 summary: Get all accounts
192 - $ref: '#/components/parameters/start'
193 - $ref: '#/components/parameters/count'
194 - $ref: '#/components/parameters/sort'
197 description: successful operation
203 $ref: '#/components/schemas/Account'
208 summary: Get the public configuration of the server
211 description: successful operation
215 $ref: '#/components/schemas/ServerConfig'
218 summary: Get the instance about page content
223 description: successful operation
227 $ref: '#/components/schemas/ServerConfigAbout'
230 summary: Get the runtime configuration of the server
238 description: successful operation
242 $ref: '#/components/schemas/ServerConfigCustom'
244 summary: Set the runtime configuration of the server
252 description: successful operation
254 summary: Delete the runtime configuration of the server
262 description: successful operation
265 summary: Get list of jobs
275 description: The state of the job
284 - $ref: '#/components/parameters/start'
285 - $ref: '#/components/parameters/count'
286 - $ref: '#/components/parameters/sort'
289 description: successful operation
295 $ref: '#/components/schemas/Job'
296 '/server/following/{host}':
303 summary: Unfollow a server by hostname
308 description: 'The host to unfollow '
313 description: successful operation
318 summary: Get followers of the server
320 - $ref: '#/components/parameters/start'
321 - $ref: '#/components/parameters/count'
322 - $ref: '#/components/parameters/sort'
325 description: successful operation
331 $ref: '#/components/schemas/Follow'
336 summary: Get servers followed by the server
338 - $ref: '#/components/parameters/start'
339 - $ref: '#/components/parameters/count'
340 - $ref: '#/components/parameters/sort'
343 description: successful operation
349 $ref: '#/components/schemas/Follow'
356 summary: Follow a server
359 $ref: '#/paths/~1users~1me/put/responses/204'
364 $ref: '#/components/schemas/Follow'
367 summary: Creates user
375 description: successful operation
379 $ref: '#/components/schemas/AddUserResponse'
384 $ref: '#/components/schemas/AddUser'
385 description: User to create
388 summary: Get a list of users
394 - $ref: '#/components/parameters/start'
395 - $ref: '#/components/parameters/count'
396 - $ref: '#/components/parameters/usersSort'
399 description: successful operation
405 $ref: '#/components/schemas/User'
408 summary: Delete a user by its id
415 - $ref: '#/components/parameters/id'
418 $ref: '#/paths/~1users~1me/put/responses/204'
420 summary: Get user by its id
426 - $ref: '#/components/parameters/id'
429 description: successful operation
433 $ref: '#/components/schemas/User'
435 summary: Update user profile by its id
441 - $ref: '#/components/parameters/id'
444 $ref: '#/paths/~1users~1me/put/responses/204'
449 $ref: '#/components/schemas/UpdateUser'
453 summary: Register a user
458 $ref: '#/paths/~1users~1me/put/responses/204'
463 $ref: '#/components/schemas/RegisterUser'
467 summary: Get current user information
475 description: successful operation
481 $ref: '#/components/schemas/User'
483 summary: Update current user information
491 description: successful operation
496 $ref: '#/components/schemas/UpdateMe'
498 /users/me/videos/imports:
500 summary: Get video imports of current user
507 - $ref: '#/components/parameters/start'
508 - $ref: '#/components/parameters/count'
509 - $ref: '#/components/parameters/sort'
512 description: successful operation
516 $ref: '#/components/schemas/VideoImport'
517 /users/me/video-quota-used:
519 summary: Get current user used quota
527 description: successful operation
532 '/users/me/videos/{videoId}/rating':
534 summary: 'Get rating of video by its id, among those of the current user'
543 description: 'The video id '
548 description: successful operation
552 $ref: '#/components/schemas/GetMeVideoRating'
555 summary: Get videos of the current user
562 - $ref: '#/components/parameters/start'
563 - $ref: '#/components/parameters/count'
564 - $ref: '#/components/parameters/sort'
567 description: successful operation
571 $ref: '#/components/schemas/VideoListResponse'
572 /users/me/subscriptions:
574 summary: Get subscriptions of the current user
581 - $ref: '#/components/parameters/start'
582 - $ref: '#/components/parameters/count'
583 - $ref: '#/components/parameters/sort'
586 description: successful operation
588 summary: Add subscription to the current user
596 description: successful operation
597 /users/me/subscriptions/exist:
599 summary: Get if subscriptions exist for the current user
606 - $ref: '#/components/parameters/subscriptionsUris'
609 description: successful operation
614 /users/me/subscriptions/videos:
616 summary: Get videos of subscriptions of the current user
623 - $ref: '#/components/parameters/start'
624 - $ref: '#/components/parameters/count'
625 - $ref: '#/components/parameters/sort'
628 description: successful operation
632 $ref: '#/components/schemas/VideoListResponse'
633 '/users/me/subscriptions/{subscriptionHandle}':
635 summary: Get subscription of the current user for a given uri
642 - $ref: '#/components/parameters/subscriptionHandle'
645 description: successful operation
649 $ref: '#/components/schemas/VideoChannel'
651 summary: Delete subscription of the current user for a given uri
658 - $ref: '#/components/parameters/subscriptionHandle'
661 description: successful operation
662 /users/me/avatar/pick:
664 summary: Update current user avatar
671 description: successful operation
675 $ref: '#/components/schemas/Avatar'
683 description: The file to upload.
688 contentType: image/png, image/jpeg
691 summary: Get list of videos
695 - $ref: '#/components/parameters/categoryOneOf'
696 - $ref: '#/components/parameters/tagsOneOf'
697 - $ref: '#/components/parameters/tagsAllOf'
698 - $ref: '#/components/parameters/licenceOneOf'
699 - $ref: '#/components/parameters/languageOneOf'
700 - $ref: '#/components/parameters/nsfw'
701 - $ref: '#/components/parameters/filter'
702 - $ref: '#/components/parameters/start'
703 - $ref: '#/components/parameters/count'
704 - $ref: '#/components/parameters/videosSort'
707 description: successful operation
711 $ref: '#/components/schemas/VideoListResponse'
714 summary: Get list of video categories known by the server
719 description: successful operation
728 summary: Get list of video licences known by the server
733 description: successful operation
742 summary: Get list of languages known by the server
747 description: successful operation
756 summary: Get list of privacy policies supported by the server
761 description: successful operation
770 summary: Update metadata for a video by its id
776 - $ref: '#/components/parameters/idOrUUID'
779 description: successful operation
787 description: Video thumbnail file
791 description: Video preview file
795 description: Video category
798 description: Video licence
801 description: Video language
804 description: Video description
807 description: Whether or not we wait transcoding before publish the video
810 description: Text describing how to support the video uploader
813 description: Whether or not this video contains sensitive content
816 description: Video name
819 description: Video tags (maximum 5 tags each between 2 and 30 characters)
828 description: Enable or disable comments for this video
830 originallyPublishedAt:
831 description: Date when the content was originally published
835 $ref: '#/components/schemas/VideoScheduledUpdate'
838 contentType: image/jpeg
840 contentType: image/jpeg
842 summary: Get a video by its id
846 - $ref: '#/components/parameters/idOrUUID'
849 description: successful operation
853 $ref: '#/components/schemas/VideoDetails'
855 summary: Delete a video by its id
861 - $ref: '#/components/parameters/idOrUUID'
864 $ref: '#/paths/~1users~1me/put/responses/204'
865 '/videos/{id}/description':
867 summary: Get a video description by its id
871 - $ref: '#/components/parameters/idOrUUID'
874 description: successful operation
879 '/videos/{id}/views':
881 summary: Add a view to the video by its id
885 - $ref: '#/components/parameters/idOrUUID'
888 $ref: '#/paths/~1users~1me/put/responses/204'
889 '/videos/{id}/watching':
891 summary: Set watching progress of a video by its id for a user
897 - $ref: '#/components/parameters/idOrUUID'
902 $ref: '#/components/schemas/UserWatchingVideo'
906 $ref: '#/paths/~1users~1me/put/responses/204'
909 summary: Get list of video ownership changes requests
916 description: successful operation
917 '/videos/ownership/{id}/accept':
919 summary: Refuse ownership change request for video by its id
925 - $ref: '#/components/parameters/idOrUUID'
928 $ref: '#/paths/~1users~1me/put/responses/204'
929 '/videos/ownership/{id}/refuse':
931 summary: Accept ownership change request for video by its id
937 - $ref: '#/components/parameters/idOrUUID'
940 $ref: '#/paths/~1users~1me/put/responses/204'
941 '/videos/{id}/give-ownership':
943 summary: Request change of ownership for a video you own, by its id
949 - $ref: '#/components/parameters/idOrUUID'
953 application/x-www-form-urlencoded:
963 $ref: '#/paths/~1users~1me/put/responses/204'
965 description: 'Changing video ownership to a remote account is not supported yet'
968 summary: Upload a video file with its metadata
975 description: successful operation
979 $ref: '#/components/schemas/VideoUploadResponse'
987 description: Video file
991 description: Channel id that will contain this video
994 description: Video thumbnail file
998 description: Video preview file
1002 $ref: '#/components/schemas/VideoPrivacySet'
1004 description: Video category
1007 description: Video licence
1010 description: Video language
1013 description: Video description
1016 description: Whether or not we wait transcoding before publish the video
1019 description: Text describing how to support the video uploader
1022 description: Whether or not this video contains sensitive content
1025 description: Video name
1028 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1037 description: Enable or disable comments for this video
1039 originallyPublishedAt:
1040 description: Date when the content was originally published
1044 $ref: '#/components/schemas/VideoScheduledUpdate'
1051 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1053 contentType: image/jpeg
1055 contentType: image/jpeg
1059 ## DEPENDENCIES: httpie, jq
1060 # pip install httpie
1061 USERNAME="<your_username>"
1062 PASSWORD="<your_password>"
1063 FILE_PATH="<your_file_path>"
1064 CHANNEL_ID="<your_channel_id>"
1067 API_PATH="https://peertube2.cpy.re/api/v1"
1069 client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1070 client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1071 token=$(http -b --form POST "$API_PATH/users/token" \
1072 client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
1073 username=$USERNAME \
1074 password=$PASSWORD \
1075 | jq -r ".access_token")
1077 http -b --form POST "$API_PATH/videos/upload" \
1078 videofile@$FILE_PATH \
1079 channelId=$CHANNEL_ID \
1081 "Authorization:Bearer $token"
1084 summary: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1091 description: successful operation
1095 $ref: '#/components/schemas/VideoUploadResponse'
1098 multipart/form-data:
1103 description: Torrent File
1107 description: HTTP target URL
1110 description: Magnet URI
1113 description: Channel id that will contain this video
1116 description: Video thumbnail file
1120 description: Video preview file
1124 $ref: '#/components/schemas/VideoPrivacySet'
1126 description: Video category
1129 description: Video licence
1132 description: Video language
1135 description: Video description
1138 description: Whether or not we wait transcoding before publish the video
1141 description: Text describing how to support the video uploader
1144 description: Whether or not this video contains sensitive content
1147 description: Video name
1150 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1159 description: Enable or disable comments for this video
1162 $ref: '#/components/schemas/VideoScheduledUpdate'
1168 contentType: application/x-bittorrent
1170 contentType: image/jpeg
1172 contentType: image/jpeg
1175 summary: Get list of reported video abuses
1181 - $ref: '#/components/parameters/start'
1182 - $ref: '#/components/parameters/count'
1183 - $ref: '#/components/parameters/abusesSort'
1186 description: successful operation
1192 $ref: '#/components/schemas/VideoAbuse'
1193 '/videos/{id}/abuse':
1195 summary: 'Report an abuse, on a video by its id'
1201 - $ref: '#/components/parameters/idOrUUID'
1204 $ref: '#/paths/~1users~1me/put/responses/204'
1205 '/videos/{id}/blacklist':
1207 summary: Put on blacklist a video by its id
1215 - $ref: '#/components/parameters/idOrUUID'
1218 $ref: '#/paths/~1users~1me/put/responses/204'
1220 summary: Delete an entry of the blacklist of a video by its id
1228 - $ref: '#/components/parameters/idOrUUID'
1231 $ref: '#/paths/~1users~1me/put/responses/204'
1234 summary: Get list of videos on blacklist
1242 - $ref: '#/components/parameters/start'
1243 - $ref: '#/components/parameters/count'
1244 - $ref: '#/components/parameters/blacklistsSort'
1247 description: successful operation
1253 $ref: '#/components/schemas/VideoBlacklist'
1254 /videos/{id}/captions:
1256 summary: Get list of video's captions
1260 - $ref: '#/components/parameters/idOrUUID'
1263 description: successful operation
1274 $ref: '#/components/schemas/VideoCaption'
1275 /videos/{id}/captions/{captionLanguage}:
1277 summary: Add or replace a video caption
1281 - $ref: '#/components/parameters/idOrUUID'
1282 - $ref: '#/components/parameters/captionLanguage'
1285 multipart/form-data:
1290 description: The file to upload.
1295 contentType: text/vtt, application/x-subrip
1298 $ref: '#/paths/~1users~1me/put/responses/204'
1300 summary: Delete a video caption
1304 - $ref: '#/components/parameters/idOrUUID'
1305 - $ref: '#/components/parameters/captionLanguage'
1308 $ref: '#/paths/~1users~1me/put/responses/204'
1311 summary: Get list of video channels
1315 - $ref: '#/components/parameters/start'
1316 - $ref: '#/components/parameters/count'
1317 - $ref: '#/components/parameters/sort'
1320 description: successful operation
1326 $ref: '#/components/schemas/VideoChannel'
1328 summary: Creates a video channel for the current user
1335 $ref: '#/paths/~1users~1me/put/responses/204'
1340 $ref: '#/components/schemas/VideoChannelCreate'
1341 '/video-channels/{channelHandle}':
1343 summary: Get a video channel by its id
1347 - $ref: '#/components/parameters/channelHandle'
1350 description: successful operation
1354 $ref: '#/components/schemas/VideoChannel'
1356 summary: Update a video channel by its id
1362 - $ref: '#/components/parameters/channelHandle'
1365 $ref: '#/paths/~1users~1me/put/responses/204'
1370 $ref: '#/components/schemas/VideoChannelUpdate'
1372 summary: Delete a video channel by its id
1378 - $ref: '#/components/parameters/channelHandle'
1381 $ref: '#/paths/~1users~1me/put/responses/204'
1382 '/video-channels/{channelHandle}/videos':
1384 summary: Get videos of a video channel by its id
1389 - $ref: '#/components/parameters/channelHandle'
1392 description: successful operation
1396 $ref: '#/components/schemas/VideoListResponse'
1399 summary: Get list of video playlists
1403 - $ref: '#/components/parameters/start'
1404 - $ref: '#/components/parameters/count'
1405 - $ref: '#/components/parameters/sort'
1408 description: successful operation
1414 $ref: '#/components/schemas/VideoPlaylist'
1415 '/accounts/{name}/video-channels':
1417 summary: Get video channels of an account by its name
1421 - $ref: '#/components/parameters/name'
1424 description: successful operation
1430 $ref: '#/components/schemas/VideoChannel'
1431 '/accounts/{name}/ratings':
1433 summary: Get ratings of an account by its name
1439 - $ref: '#/components/parameters/name'
1440 - $ref: '#/components/parameters/start'
1441 - $ref: '#/components/parameters/count'
1442 - $ref: '#/components/parameters/sort'
1446 description: Optionally filter which ratings to retrieve
1454 description: successful operation
1460 $ref: '#/components/schemas/VideoRating'
1461 '/videos/{id}/comment-threads':
1463 summary: Get the comment threads of a video by its id
1467 - $ref: '#/components/parameters/idOrUUID'
1468 - $ref: '#/components/parameters/start'
1469 - $ref: '#/components/parameters/count'
1470 - $ref: '#/components/parameters/commentsSort'
1473 description: successful operation
1477 $ref: '#/components/schemas/CommentThreadResponse'
1479 summary: 'Creates a comment thread, on a video by its id'
1485 - $ref: '#/components/parameters/idOrUUID'
1488 description: successful operation
1492 $ref: '#/components/schemas/CommentThreadPostResponse'
1493 '/videos/{id}/comment-threads/{threadId}':
1495 summary: 'Get the comment thread by its id, of a video by its id'
1499 - $ref: '#/components/parameters/idOrUUID'
1500 - $ref: '#/components/parameters/threadId'
1503 description: successful operation
1507 $ref: '#/components/schemas/VideoCommentThreadTree'
1508 '/videos/{id}/comments/{commentId}':
1510 summary: 'Creates a comment in a comment thread by its id, of a video by its id'
1516 - $ref: '#/components/parameters/idOrUUID'
1517 - $ref: '#/components/parameters/commentId'
1520 description: successful operation
1524 $ref: '#/components/schemas/CommentThreadPostResponse'
1526 summary: 'Delete a comment in a comment thread by its id, of a video by its id'
1532 - $ref: '#/components/parameters/idOrUUID'
1533 - $ref: '#/components/parameters/commentId'
1536 $ref: '#/paths/~1users~1me/put/responses/204'
1537 '/videos/{id}/rate':
1539 summary: Vote for a video by its id
1545 - $ref: '#/components/parameters/idOrUUID'
1548 $ref: '#/paths/~1users~1me/put/responses/204'
1553 summary: Get the videos corresponding to a given query
1555 - $ref: '#/components/parameters/start'
1556 - $ref: '#/components/parameters/count'
1557 - $ref: '#/components/parameters/videosSearchSort'
1561 description: String to search
1566 description: successful operation
1570 $ref: '#/components/schemas/VideoListResponse'
1572 - url: 'https://peertube.cpy.re/api/v1'
1573 description: Live Test Server (live data - stable version)
1574 - url: 'https://peertube2.cpy.re/api/v1'
1575 description: Live Test Server (live data - bleeding edge version)
1576 - url: 'https://peertube3.cpy.re/api/v1'
1577 description: Live Test Server (live data - bleeding edge version)
1591 description: Number of items
1598 description: Sort column (-createdAt for example)
1605 description: Sort videos by criteria
1620 description: Sort videos by criteria
1635 description: Sort comments by criteria
1645 description: Sort blacklists by criteria
1661 description: Sort users by criteria
1672 description: Sort abuses by criteria
1684 The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
1692 description: The user id
1699 description: The video id or uuid
1703 name: captionLanguage
1706 description: The caption language
1713 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
1717 name: subscriptionHandle
1720 description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
1727 description: The thread id (root comment id)
1734 description: The comment id
1741 description: category id of the video
1754 description: tag(s) of the video
1767 description: tag(s) of the video, where all should be present in the video
1780 description: language id of the video
1793 description: licence id of the video
1806 description: whether to include nsfw videos, if any
1817 Special filters (local for instance) which might require special rights:
1818 * `local` - only videos local to the instance
1819 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
1829 description: list of uris to check if each is part of the user subscriptions
1837 In the header: *Authorization: Bearer <token\>*
1840 Authenticating via OAuth requires the following steps:
1843 - Have an account with sufficient authorization levels
1845 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
1848 - Make Authenticated Requests
1852 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
1855 moderator: Moderator scope
1858 VideoConstantNumber:
1864 VideoConstantString:
1876 description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
1877 VideoPrivacyConstant:
1895 description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
1898 VideoResolutionConstant:
1902 description: 'Video resolution (240, 360, 720 ...)'
1905 VideoScheduledUpdate:
1908 $ref: '#/components/schemas/VideoPrivacySet'
1909 description: Video privacy target
1913 description: When to update the video
1916 VideoAccountSummary:
1930 $ref: '#/components/schemas/Avatar'
1931 VideoChannelSummary:
1945 $ref: '#/components/schemas/Avatar'
1956 $ref: '#/components/schemas/Video'
1962 $ref: '#/components/schemas/VideoResolutionConstant'
1965 description: 'Video file size in bytes'
1976 VideoStreamingPlaylists:
1984 description: 'Playlist type (HLS = 1)'
2008 originallyPublishedAt:
2011 $ref: '#/components/schemas/VideoConstantNumber'
2013 $ref: '#/components/schemas/VideoConstantNumber'
2015 $ref: '#/components/schemas/VideoConstantString'
2017 $ref: '#/components/schemas/VideoPrivacyConstant'
2044 $ref: '#/components/schemas/VideoStateConstant'
2047 $ref: '#/components/schemas/VideoScheduledUpdate'
2055 $ref: '#/components/schemas/VideoAccountSummary'
2057 $ref: '#/components/schemas/VideoChannelSummary'
2066 - $ref: '#/components/schemas/Video'
2074 $ref: '#/components/schemas/VideoChannel'
2076 $ref: '#/components/schemas/Account'
2084 $ref: '#/components/schemas/VideoFile'
2096 $ref: '#/components/schemas/VideoStreamingPlaylists'
2097 VideoImportStateConstant:
2105 description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
2122 $ref: '#/components/schemas/VideoImportStateConstant'
2132 $ref: '#/components/schemas/Video'
2140 $ref: '#/components/schemas/Account'
2263 $ref: '#/components/schemas/Account'
2264 VideoCommentThreadTree:
2267 $ref: '#/components/schemas/VideoComment'
2271 $ref: '#/components/schemas/VideoCommentThreadTree'
2275 $ref: '#/components/schemas/VideoConstantString'
2305 $ref: '#/components/schemas/Avatar'
2308 - $ref: '#/components/schemas/Actor'
2334 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2348 $ref: '#/components/schemas/Account'
2352 $ref: '#/components/schemas/VideoChannel'
2412 allowedForCurrentIP:
2414 requiresEmailVerification:
2601 requiresEmailVerification:
2625 allowAdditionalExtensions:
2693 $ref: '#/components/schemas/Actor'
2695 $ref: '#/components/schemas/Actor'
2737 VideoUploadResponse:
2746 CommentThreadResponse:
2753 $ref: '#/components/schemas/VideoComment'
2754 CommentThreadPostResponse:
2757 $ref: '#/components/schemas/VideoComment'
2765 $ref: '#/components/schemas/Video'
2770 description: 'The user username '
2773 description: 'The user password '
2776 description: 'The user email '
2779 description: 'The user videoQuota '
2782 description: 'The user daily video quota '
2789 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2801 description: 'The user id '
2804 description: 'The updated email of the user '
2807 description: 'The updated videoQuota of the user '
2810 description: 'The updated daily video quota of the user '
2817 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2828 description: 'Your new password '
2831 description: 'Your new email '
2834 description: 'Your new displayNSFW '
2837 description: 'Your new autoPlayVideo '
2847 description: 'Id of the video '
2850 description: 'Rating of the video '
2857 $ref: '#/components/schemas/Video'
2860 description: 'Rating of the video'
2868 description: 'The username of the user '
2871 description: 'The password of the user '
2874 description: 'The email of the user '
2877 description: 'The user display name'
2883 description: 'The default channel name'
2886 description: 'The default channel display name'
2913 bulkVideosSupportUpdate:
2915 description: 'Update all videos support field of this channel'