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
81 Operations dealing with creation, modification and video listing of a
83 - name: Video Blacklist
85 Operations dealing with blacklisting videos (removing them from view and
86 preventing interactions).
108 - name: Instance Configuration
123 summary: Get the account by name
125 - $ref: '#/components/parameters/name'
128 description: successful operation
132 $ref: '#/components/schemas/Account'
133 '/accounts/{name}/videos':
138 summary: 'Get videos for an account, provided the name of that account'
140 - $ref: '#/components/parameters/name'
143 description: successful operation
147 $ref: '#/components/schemas/VideoListResponse'
151 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
152 .then(function(response) {
153 return response.json()
154 }).then(function(data) {
160 http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
166 url = URI("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
168 http = Net::HTTP.new(url.host, url.port)
170 http.verify_mode = OpenSSL::SSL::VERIFY_NONE
172 request = Net::HTTP::Post.new(url)
173 request["content-type"] = 'application/json'
174 response = http.request(request)
175 puts response.read_body
180 conn = http.client.HTTPSConnection("https://peertube2.cpy.re/api/v1")
183 'content-type': "application/json"
186 conn.request("POST", "/accounts/{name}/videos", None, headers)
188 res = conn.getresponse()
191 print(data.decode("utf-8"))
196 summary: Get all accounts
198 - $ref: '#/components/parameters/start'
199 - $ref: '#/components/parameters/count'
200 - $ref: '#/components/parameters/sort'
203 description: successful operation
209 $ref: '#/components/schemas/Account'
214 summary: Get the public configuration of the server
217 description: successful operation
221 $ref: '#/components/schemas/ServerConfig'
224 summary: Get the instance about page content
229 description: successful operation
233 $ref: '#/components/schemas/ServerConfigAbout'
236 summary: Get the runtime configuration of the server
244 description: successful operation
248 $ref: '#/components/schemas/ServerConfigCustom'
250 summary: Set the runtime configuration of the server
258 description: successful operation
260 summary: Delete the runtime configuration of the server
268 description: successful operation
271 summary: Get list of jobs
281 description: The state of the job
290 - $ref: '#/components/parameters/start'
291 - $ref: '#/components/parameters/count'
292 - $ref: '#/components/parameters/sort'
295 description: successful operation
301 $ref: '#/components/schemas/Job'
302 '/server/following/{host}':
309 summary: Unfollow a server by hostname
314 description: 'The host to unfollow '
319 description: successful operation
324 summary: Get followers of the server
326 - $ref: '#/components/parameters/start'
327 - $ref: '#/components/parameters/count'
328 - $ref: '#/components/parameters/sort'
331 description: successful operation
337 $ref: '#/components/schemas/Follow'
342 summary: Get servers followed by the server
344 - $ref: '#/components/parameters/start'
345 - $ref: '#/components/parameters/count'
346 - $ref: '#/components/parameters/sort'
349 description: successful operation
355 $ref: '#/components/schemas/Follow'
362 summary: Follow a server
365 $ref: '#/paths/~1users~1me/put/responses/204'
370 $ref: '#/components/schemas/Follow'
373 summary: Creates user
381 description: successful operation
385 $ref: '#/components/schemas/AddUserResponse'
390 $ref: '#/components/schemas/AddUser'
391 description: User to create
394 summary: Get a list of users
400 - $ref: '#/components/parameters/start'
401 - $ref: '#/components/parameters/count'
402 - $ref: '#/components/parameters/usersSort'
405 description: successful operation
411 $ref: '#/components/schemas/User'
414 summary: Delete a user by its id
421 - $ref: '#/components/parameters/id'
424 $ref: '#/paths/~1users~1me/put/responses/204'
426 summary: Get user by its id
432 - $ref: '#/components/parameters/id'
435 description: successful operation
439 $ref: '#/components/schemas/User'
441 summary: Update user profile by its id
447 - $ref: '#/components/parameters/id'
450 $ref: '#/paths/~1users~1me/put/responses/204'
455 $ref: '#/components/schemas/UpdateUser'
459 summary: Register a user
464 $ref: '#/paths/~1users~1me/put/responses/204'
469 $ref: '#/components/schemas/RegisterUser'
473 summary: Get current user information
481 description: successful operation
487 $ref: '#/components/schemas/User'
489 summary: Update current user information
497 description: successful operation
502 $ref: '#/components/schemas/UpdateMe'
504 /users/me/videos/imports:
506 summary: Get video imports of current user
513 - $ref: '#/components/parameters/start'
514 - $ref: '#/components/parameters/count'
515 - $ref: '#/components/parameters/sort'
518 description: successful operation
522 $ref: '#/components/schemas/VideoImport'
523 /users/me/video-quota-used:
525 summary: Get current user used quota
533 description: successful operation
538 '/users/me/videos/{videoId}/rating':
540 summary: 'Get rating of video by its id, among those of the current user'
549 description: 'The video id '
554 description: successful operation
558 $ref: '#/components/schemas/GetMeVideoRating'
561 summary: Get videos of the current user
568 - $ref: '#/components/parameters/start'
569 - $ref: '#/components/parameters/count'
570 - $ref: '#/components/parameters/sort'
573 description: successful operation
577 $ref: '#/components/schemas/VideoListResponse'
578 /users/me/subscriptions:
580 summary: Get subscriptions of the current user
587 - $ref: '#/components/parameters/start'
588 - $ref: '#/components/parameters/count'
589 - $ref: '#/components/parameters/sort'
592 description: successful operation
594 summary: Add subscription to the current user
602 description: successful operation
603 /users/me/subscriptions/exist:
605 summary: Get if subscriptions exist for the current user
612 - $ref: '#/components/parameters/subscriptionsUris'
615 description: successful operation
620 /users/me/subscriptions/videos:
622 summary: Get videos of subscriptions of the current user
629 - $ref: '#/components/parameters/start'
630 - $ref: '#/components/parameters/count'
631 - $ref: '#/components/parameters/sort'
634 description: successful operation
638 $ref: '#/components/schemas/VideoListResponse'
639 '/users/me/subscriptions/{subscriptionHandle}':
641 summary: Get subscription of the current user for a given uri
648 - $ref: '#/components/parameters/subscriptionHandle'
651 description: successful operation
655 $ref: '#/components/schemas/VideoChannel'
657 summary: Delete subscription of the current user for a given uri
664 - $ref: '#/components/parameters/subscriptionHandle'
667 description: successful operation
668 /users/me/avatar/pick:
670 summary: Update current user avatar
677 description: successful operation
681 $ref: '#/components/schemas/Avatar'
689 description: The file to upload.
694 contentType: image/png, image/jpeg
697 summary: Get list of videos
701 - $ref: '#/components/parameters/categoryOneOf'
702 - $ref: '#/components/parameters/tagsOneOf'
703 - $ref: '#/components/parameters/tagsAllOf'
704 - $ref: '#/components/parameters/licenceOneOf'
705 - $ref: '#/components/parameters/languageOneOf'
706 - $ref: '#/components/parameters/nsfw'
707 - $ref: '#/components/parameters/filter'
708 - $ref: '#/components/parameters/start'
709 - $ref: '#/components/parameters/count'
710 - $ref: '#/components/parameters/videosSort'
713 description: successful operation
717 $ref: '#/components/schemas/VideoListResponse'
720 summary: Get list of video categories known by the server
725 description: successful operation
734 summary: Get list of video licences known by the server
739 description: successful operation
748 summary: Get list of languages known by the server
753 description: successful operation
762 summary: Get list of privacy policies supported by the server
767 description: successful operation
776 summary: Update metadata for a video by its id
782 - $ref: '#/components/parameters/idOrUUID'
785 description: successful operation
793 description: Video thumbnail file
797 description: Video preview file
801 description: Video category
804 description: Video licence
807 description: Video language
810 description: Video description
813 description: Whether or not we wait transcoding before publish the video
816 description: Text describing how to support the video uploader
819 description: Whether or not this video contains sensitive content
822 description: Video name
825 description: Video tags (maximum 5 tags each between 2 and 30 characters)
834 description: Enable or disable comments for this video
836 originallyPublishedAt:
837 description: Date when the content was originally published
841 $ref: '#/components/schemas/VideoScheduledUpdate'
844 contentType: image/jpeg
846 contentType: image/jpeg
848 summary: Get a video by its id
852 - $ref: '#/components/parameters/idOrUUID'
855 description: successful operation
859 $ref: '#/components/schemas/VideoDetails'
861 summary: Delete a video by its id
867 - $ref: '#/components/parameters/idOrUUID'
870 $ref: '#/paths/~1users~1me/put/responses/204'
871 '/videos/{id}/description':
873 summary: Get a video description by its id
877 - $ref: '#/components/parameters/idOrUUID'
880 description: successful operation
885 '/videos/{id}/views':
887 summary: Add a view to the video by its id
891 - $ref: '#/components/parameters/idOrUUID'
894 $ref: '#/paths/~1users~1me/put/responses/204'
895 '/videos/{id}/watching':
897 summary: Set watching progress of a video by its id for a user
903 - $ref: '#/components/parameters/idOrUUID'
908 $ref: '#/components/schemas/UserWatchingVideo'
912 $ref: '#/paths/~1users~1me/put/responses/204'
915 summary: Get list of video ownership changes requests
922 description: successful operation
923 '/videos/ownership/{id}/accept':
925 summary: Refuse ownership change request for video by its id
931 - $ref: '#/components/parameters/idOrUUID'
934 $ref: '#/paths/~1users~1me/put/responses/204'
935 '/videos/ownership/{id}/refuse':
937 summary: Accept ownership change request for video by its id
943 - $ref: '#/components/parameters/idOrUUID'
946 $ref: '#/paths/~1users~1me/put/responses/204'
947 '/videos/{id}/give-ownership':
949 summary: Request change of ownership for a video you own, by its id
955 - $ref: '#/components/parameters/idOrUUID'
959 application/x-www-form-urlencoded:
969 $ref: '#/paths/~1users~1me/put/responses/204'
971 description: 'Changing video ownership to a remote account is not supported yet'
974 summary: Upload a video file with its metadata
981 description: successful operation
985 $ref: '#/components/schemas/VideoUploadResponse'
993 description: Video file
997 description: Channel id that will contain this video
1000 description: Video thumbnail file
1004 description: Video preview file
1008 $ref: '#/components/schemas/VideoPrivacySet'
1010 description: Video category
1013 description: Video licence
1016 description: Video language
1019 description: Video description
1022 description: Whether or not we wait transcoding before publish the video
1025 description: Text describing how to support the video uploader
1028 description: Whether or not this video contains sensitive content
1031 description: Video name
1034 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1043 description: Enable or disable comments for this video
1045 originallyPublishedAt:
1046 description: Date when the content was originally published
1050 $ref: '#/components/schemas/VideoScheduledUpdate'
1057 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1059 contentType: image/jpeg
1061 contentType: image/jpeg
1065 ## DEPENDENCIES: httpie, jq
1066 # pip install httpie
1067 USERNAME="<your_username>"
1068 PASSWORD="<your_password>"
1069 FILE_PATH="<your_file_path>"
1070 CHANNEL_ID="<your_channel_id>"
1073 API_PATH="https://peertube2.cpy.re/api/v1"
1075 client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1076 client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1077 token=$(http -b --form POST "$API_PATH/users/token" \
1078 client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
1079 username=$USERNAME \
1080 password=$PASSWORD \
1081 | jq -r ".access_token")
1083 http -b --form POST "$API_PATH/videos/upload" \
1084 videofile@$FILE_PATH \
1085 channelId=$CHANNEL_ID \
1087 "Authorization:Bearer $token"
1090 summary: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1097 description: successful operation
1101 $ref: '#/components/schemas/VideoUploadResponse'
1104 multipart/form-data:
1109 description: Torrent File
1113 description: HTTP target URL
1116 description: Magnet URI
1119 description: Channel id that will contain this video
1122 description: Video thumbnail file
1126 description: Video preview file
1130 $ref: '#/components/schemas/VideoPrivacySet'
1132 description: Video category
1135 description: Video licence
1138 description: Video language
1141 description: Video description
1144 description: Whether or not we wait transcoding before publish the video
1147 description: Text describing how to support the video uploader
1150 description: Whether or not this video contains sensitive content
1153 description: Video name
1156 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1165 description: Enable or disable comments for this video
1168 $ref: '#/components/schemas/VideoScheduledUpdate'
1174 contentType: application/x-bittorrent
1176 contentType: image/jpeg
1178 contentType: image/jpeg
1181 summary: Get list of reported video abuses
1187 - $ref: '#/components/parameters/start'
1188 - $ref: '#/components/parameters/count'
1189 - $ref: '#/components/parameters/abusesSort'
1192 description: successful operation
1198 $ref: '#/components/schemas/VideoAbuse'
1199 '/videos/{id}/abuse':
1201 summary: 'Report an abuse, on a video by its id'
1207 - $ref: '#/components/parameters/idOrUUID'
1210 $ref: '#/paths/~1users~1me/put/responses/204'
1211 '/videos/{id}/blacklist':
1213 summary: Put on blacklist a video by its id
1221 - $ref: '#/components/parameters/idOrUUID'
1224 $ref: '#/paths/~1users~1me/put/responses/204'
1226 summary: Delete an entry of the blacklist of a video by its id
1234 - $ref: '#/components/parameters/idOrUUID'
1237 $ref: '#/paths/~1users~1me/put/responses/204'
1240 summary: Get list of videos on blacklist
1248 - $ref: '#/components/parameters/start'
1249 - $ref: '#/components/parameters/count'
1250 - $ref: '#/components/parameters/blacklistsSort'
1253 description: successful operation
1259 $ref: '#/components/schemas/VideoBlacklist'
1260 /videos/{id}/captions:
1262 summary: Get list of video's captions
1266 - $ref: '#/components/parameters/idOrUUID'
1269 description: successful operation
1280 $ref: '#/components/schemas/VideoCaption'
1281 /videos/{id}/captions/{captionLanguage}:
1283 summary: Add or replace a video caption
1287 - $ref: '#/components/parameters/idOrUUID'
1288 - $ref: '#/components/parameters/captionLanguage'
1291 multipart/form-data:
1296 description: The file to upload.
1301 contentType: text/vtt, application/x-subrip
1304 $ref: '#/paths/~1users~1me/put/responses/204'
1306 summary: Delete a video caption
1310 - $ref: '#/components/parameters/idOrUUID'
1311 - $ref: '#/components/parameters/captionLanguage'
1314 $ref: '#/paths/~1users~1me/put/responses/204'
1317 summary: Get list of video channels
1321 - $ref: '#/components/parameters/start'
1322 - $ref: '#/components/parameters/count'
1323 - $ref: '#/components/parameters/sort'
1326 description: successful operation
1332 $ref: '#/components/schemas/VideoChannel'
1334 summary: Creates a video channel for the current user
1341 $ref: '#/paths/~1users~1me/put/responses/204'
1346 $ref: '#/components/schemas/VideoChannelCreate'
1347 '/video-channels/{channelHandle}':
1349 summary: Get a video channel by its id
1353 - $ref: '#/components/parameters/channelHandle'
1356 description: successful operation
1360 $ref: '#/components/schemas/VideoChannel'
1362 summary: Update a video channel by its id
1368 - $ref: '#/components/parameters/channelHandle'
1371 $ref: '#/paths/~1users~1me/put/responses/204'
1376 $ref: '#/components/schemas/VideoChannelUpdate'
1378 summary: Delete a video channel by its id
1384 - $ref: '#/components/parameters/channelHandle'
1387 $ref: '#/paths/~1users~1me/put/responses/204'
1388 '/video-channels/{channelHandle}/videos':
1390 summary: Get videos of a video channel by its id
1395 - $ref: '#/components/parameters/channelHandle'
1398 description: successful operation
1402 $ref: '#/components/schemas/VideoListResponse'
1403 '/accounts/{name}/video-channels':
1405 summary: Get video channels of an account by its name
1409 - $ref: '#/components/parameters/name'
1412 description: successful operation
1418 $ref: '#/components/schemas/VideoChannel'
1419 '/accounts/{name}/ratings':
1421 summary: Get ratings of an account by its name
1427 - $ref: '#/components/parameters/name'
1428 - $ref: '#/components/parameters/start'
1429 - $ref: '#/components/parameters/count'
1430 - $ref: '#/components/parameters/sort'
1434 description: Optionally filter which ratings to retrieve
1442 description: successful operation
1448 $ref: '#/components/schemas/VideoRating'
1449 '/videos/{id}/comment-threads':
1451 summary: Get the comment threads of a video by its id
1455 - $ref: '#/components/parameters/idOrUUID'
1456 - $ref: '#/components/parameters/start'
1457 - $ref: '#/components/parameters/count'
1458 - $ref: '#/components/parameters/sort'
1461 description: successful operation
1465 $ref: '#/components/schemas/CommentThreadResponse'
1467 summary: 'Creates a comment thread, on a video by its id'
1473 - $ref: '#/components/parameters/idOrUUID'
1476 description: successful operation
1480 $ref: '#/components/schemas/CommentThreadPostResponse'
1481 '/videos/{id}/comment-threads/{threadId}':
1483 summary: 'Get the comment thread by its id, of a video by its id'
1487 - $ref: '#/components/parameters/idOrUUID'
1488 - $ref: '#/components/parameters/threadId'
1491 description: successful operation
1495 $ref: '#/components/schemas/VideoCommentThreadTree'
1496 '/videos/{id}/comments/{commentId}':
1498 summary: 'Creates a comment in a comment thread by its id, of a video by its id'
1504 - $ref: '#/components/parameters/idOrUUID'
1505 - $ref: '#/components/parameters/commentId'
1508 description: successful operation
1512 $ref: '#/components/schemas/CommentThreadPostResponse'
1514 summary: 'Delete a comment in a comment thread by its id, of a video by its id'
1520 - $ref: '#/components/parameters/idOrUUID'
1521 - $ref: '#/components/parameters/commentId'
1524 $ref: '#/paths/~1users~1me/put/responses/204'
1525 '/videos/{id}/rate':
1527 summary: Vote for a video by its id
1533 - $ref: '#/components/parameters/idOrUUID'
1536 $ref: '#/paths/~1users~1me/put/responses/204'
1541 summary: Get the videos corresponding to a given query
1543 - $ref: '#/components/parameters/start'
1544 - $ref: '#/components/parameters/count'
1545 - $ref: '#/components/parameters/videosSearchSort'
1549 description: String to search
1554 description: successful operation
1558 $ref: '#/components/schemas/VideoListResponse'
1560 - url: 'https://peertube.cpy.re/api/v1'
1561 description: Live Test Server (live data - stable version)
1562 - url: 'https://peertube2.cpy.re/api/v1'
1563 description: Live Test Server (live data - bleeding edge version)
1564 - url: 'https://peertube3.cpy.re/api/v1'
1565 description: Live Test Server (live data - bleeding edge version)
1579 description: Number of items
1586 description: Sort column (-createdAt for example)
1593 description: Sort videos by criteria
1608 description: Sort videos by criteria
1623 description: Sort blacklists by criteria
1639 description: Sort users by criteria
1650 description: Sort abuses by criteria
1662 The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
1670 description: The user id
1677 description: The video id or uuid
1681 name: captionLanguage
1684 description: The caption language
1691 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
1695 name: subscriptionHandle
1698 description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
1705 description: The thread id (root comment id)
1712 description: The comment id
1719 description: category id of the video
1732 description: tag(s) of the video
1745 description: tag(s) of the video, where all should be present in the video
1758 description: language id of the video
1771 description: licence id of the video
1784 description: whether to include nsfw videos, if any
1795 Special filters (local for instance) which might require special rights:
1796 * `local` - only videos local to the instance
1797 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
1807 description: list of uris to check if each is part of the user subscriptions
1815 In the header: *Authorization: Bearer <token\>*
1818 Authenticating via OAuth requires the following steps:
1821 - Have an account with sufficient authorization levels
1823 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
1826 - Make Authenticated Requests
1830 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
1833 moderator: Moderator scope
1836 VideoConstantNumber:
1842 VideoConstantString:
1854 description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
1855 VideoPrivacyConstant:
1873 description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
1876 VideoResolutionConstant:
1880 description: 'Video resolution (240, 360, 720 ...)'
1883 VideoScheduledUpdate:
1886 $ref: '#/components/schemas/VideoPrivacySet'
1887 description: Video privacy target
1891 description: When to update the video
1894 VideoAccountSummary:
1908 $ref: '#/components/schemas/Avatar'
1909 VideoChannelSummary:
1923 $ref: '#/components/schemas/Avatar'
1934 $ref: '#/components/schemas/Video'
1940 $ref: '#/components/schemas/VideoResolutionConstant'
1943 description: 'Video file size in bytes'
1954 VideoStreamingPlaylists:
1962 description: 'Playlist type (HLS = 1)'
1986 originallyPublishedAt:
1989 $ref: '#/components/schemas/VideoConstantNumber'
1991 $ref: '#/components/schemas/VideoConstantNumber'
1993 $ref: '#/components/schemas/VideoConstantString'
1995 $ref: '#/components/schemas/VideoPrivacyConstant'
2022 $ref: '#/components/schemas/VideoStateConstant'
2025 $ref: '#/components/schemas/VideoScheduledUpdate'
2033 $ref: '#/components/schemas/VideoAccountSummary'
2035 $ref: '#/components/schemas/VideoChannelSummary'
2044 - $ref: '#/components/schemas/Video'
2052 $ref: '#/components/schemas/VideoChannel'
2054 $ref: '#/components/schemas/Account'
2062 $ref: '#/components/schemas/VideoFile'
2074 $ref: '#/components/schemas/VideoStreamingPlaylists'
2075 VideoImportStateConstant:
2083 description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
2100 $ref: '#/components/schemas/VideoImportStateConstant'
2110 $ref: '#/components/schemas/Video'
2118 $ref: '#/components/schemas/Account'
2194 $ref: '#/components/schemas/Account'
2195 VideoCommentThreadTree:
2198 $ref: '#/components/schemas/VideoComment'
2202 $ref: '#/components/schemas/VideoCommentThreadTree'
2206 $ref: '#/components/schemas/VideoConstantString'
2236 $ref: '#/components/schemas/Avatar'
2239 - $ref: '#/components/schemas/Actor'
2265 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2279 $ref: '#/components/schemas/Account'
2283 $ref: '#/components/schemas/VideoChannel'
2343 allowedForCurrentIP:
2345 requiresEmailVerification:
2532 requiresEmailVerification:
2556 allowAdditionalExtensions:
2624 $ref: '#/components/schemas/Actor'
2626 $ref: '#/components/schemas/Actor'
2668 VideoUploadResponse:
2677 CommentThreadResponse:
2684 $ref: '#/components/schemas/VideoComment'
2685 CommentThreadPostResponse:
2688 $ref: '#/components/schemas/VideoComment'
2696 $ref: '#/components/schemas/Video'
2701 description: 'The user username '
2704 description: 'The user password '
2707 description: 'The user email '
2710 description: 'The user videoQuota '
2713 description: 'The user daily video quota '
2720 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2732 description: 'The user id '
2735 description: 'The updated email of the user '
2738 description: 'The updated videoQuota of the user '
2741 description: 'The updated daily video quota of the user '
2748 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2759 description: 'Your new password '
2762 description: 'Your new email '
2765 description: 'Your new displayNSFW '
2768 description: 'Your new autoPlayVideo '
2778 description: 'Id of the video '
2781 description: 'Rating of the video '
2788 $ref: '#/components/schemas/Video'
2791 description: 'Rating of the video'
2799 description: 'The username of the user '
2802 description: 'The password of the user '
2805 description: 'The email of the user '
2808 description: 'The user display name'
2814 description: 'The default channel name'
2817 description: 'The default channel display name'
2844 bulkVideosSupportUpdate:
2846 description: 'Update all videos support field of this channel'