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). Our API is RESTful. It has predictable
18 resource URLs. It returns HTTP response codes to indicate errors. It also
19 accepts and returns JSON in the HTTP body. You can use your favorite
20 HTTP/REST library for your programming language to use PeerTube. No official
21 SDK is currently provided, but the spec API is fully compatible with
22 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
23 which generates a client SDK in the language of your choice.
27 When you sign up for an account, you are given the possibility to generate
28 sessions, and authenticate using this session token. One session token can
29 currently be used at a time.
33 The API uses standard HTTP status codes to indicate the success or failure
34 of the API call. The body of the response will be JSON in the following
39 "code": "unauthorized_request", // example inner error code
40 "error": "Token is invalid." // example exposed error message
44 url: https://docs.joinpeertube.org/api-rest-reference.html
48 Using some features of PeerTube require authentication, for which Accounts
49 provide different levels of permission as well as associated user
50 information. Accounts also encompass remote accounts discovered across the federation.
53 Each server exposes public information regarding supported videos and
57 Jobs are long-running tasks enqueued and processed by the instance
58 itself. No additional worker registration is currently available.
59 - name: Server Following
61 Managing servers which the instance interacts with is crucial to the
62 concept of federation in PeerTube and external video indexation. The PeerTube
63 server then deals with inter-server ActivityPub operations and propagates
64 information across its social graph by posting activities to actors' inbox
68 Video abuses deal with reports of local or remote videos alike.
71 Operations dealing with listing, uploading, fetching or modifying videos.
74 The search helps to find _videos_ from within the instance and beyond.
75 Videos from other instances federated by the instance (that is, instances
76 followed by the instance) can be found via keywords and other criteria of
80 Operations dealing with comments to a video. Comments are organized in
82 - name: Video Playlist
84 Operations dealing with playlists of videos. Playlists are bound to users
88 Operations dealing with creation, modification and video listing of a
90 - name: Video Blacklist
92 Operations dealing with blacklisting videos (removing them from view and
93 preventing interactions).
115 - name: Instance Configuration
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 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
175 http = Net::HTTP.new(uri.host, uri.port)
178 response = http.get(uri.request_uri)
180 puts JSON.parse(response.read_body)
185 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
193 summary: Get all accounts
195 - $ref: '#/components/parameters/start'
196 - $ref: '#/components/parameters/count'
197 - $ref: '#/components/parameters/sort'
200 description: successful operation
206 $ref: '#/components/schemas/Account'
211 summary: Get the public configuration of the server
214 description: successful operation
218 $ref: '#/components/schemas/ServerConfig'
221 summary: Get the instance about page content
226 description: successful operation
230 $ref: '#/components/schemas/ServerConfigAbout'
233 summary: Get the runtime configuration of the server
241 description: successful operation
245 $ref: '#/components/schemas/ServerConfigCustom'
247 summary: Set the runtime configuration of the server
255 description: successful operation
257 summary: Delete the runtime configuration of the server
265 description: successful operation
268 summary: Get list of jobs
278 description: The state of the job
287 - $ref: '#/components/parameters/start'
288 - $ref: '#/components/parameters/count'
289 - $ref: '#/components/parameters/sort'
292 description: successful operation
298 $ref: '#/components/schemas/Job'
299 '/server/following/{host}':
306 summary: Unfollow a server by hostname
311 description: 'The host to unfollow '
316 description: successful operation
321 summary: Get followers of the server
323 - $ref: '#/components/parameters/start'
324 - $ref: '#/components/parameters/count'
325 - $ref: '#/components/parameters/sort'
328 description: successful operation
334 $ref: '#/components/schemas/Follow'
339 summary: Get servers followed by the server
341 - $ref: '#/components/parameters/start'
342 - $ref: '#/components/parameters/count'
343 - $ref: '#/components/parameters/sort'
346 description: successful operation
352 $ref: '#/components/schemas/Follow'
359 summary: Follow a server
362 $ref: '#/paths/~1users~1me/put/responses/204'
367 $ref: '#/components/schemas/Follow'
370 summary: Creates user
378 description: successful operation
382 $ref: '#/components/schemas/AddUserResponse'
387 $ref: '#/components/schemas/AddUser'
388 description: User to create
391 summary: Get a list of users
397 - $ref: '#/components/parameters/start'
398 - $ref: '#/components/parameters/count'
399 - $ref: '#/components/parameters/usersSort'
402 description: successful operation
408 $ref: '#/components/schemas/User'
411 summary: Delete a user by its id
418 - $ref: '#/components/parameters/id'
421 $ref: '#/paths/~1users~1me/put/responses/204'
423 summary: Get user by its id
429 - $ref: '#/components/parameters/id'
432 description: successful operation
436 $ref: '#/components/schemas/User'
438 summary: Update user profile by its id
444 - $ref: '#/components/parameters/id'
447 $ref: '#/paths/~1users~1me/put/responses/204'
452 $ref: '#/components/schemas/UpdateUser'
456 summary: Register a user
461 $ref: '#/paths/~1users~1me/put/responses/204'
466 $ref: '#/components/schemas/RegisterUser'
470 summary: Get current user information
478 description: successful operation
484 $ref: '#/components/schemas/User'
486 summary: Update current user information
494 description: successful operation
499 $ref: '#/components/schemas/UpdateMe'
501 /users/me/videos/imports:
503 summary: Get video imports of current user
510 - $ref: '#/components/parameters/start'
511 - $ref: '#/components/parameters/count'
512 - $ref: '#/components/parameters/sort'
515 description: successful operation
519 $ref: '#/components/schemas/VideoImport'
520 /users/me/video-quota-used:
522 summary: Get current user used quota
530 description: successful operation
535 '/users/me/videos/{videoId}/rating':
537 summary: 'Get rating of video by its id, among those of the current user'
546 description: 'The video id '
551 description: successful operation
555 $ref: '#/components/schemas/GetMeVideoRating'
558 summary: Get videos of the current user
565 - $ref: '#/components/parameters/start'
566 - $ref: '#/components/parameters/count'
567 - $ref: '#/components/parameters/sort'
570 description: successful operation
574 $ref: '#/components/schemas/VideoListResponse'
575 /users/me/subscriptions:
577 summary: Get subscriptions of the current user
584 - $ref: '#/components/parameters/start'
585 - $ref: '#/components/parameters/count'
586 - $ref: '#/components/parameters/sort'
589 description: successful operation
591 summary: Add subscription to the current user
599 description: successful operation
600 /users/me/subscriptions/exist:
602 summary: Get if subscriptions exist for the current user
609 - $ref: '#/components/parameters/subscriptionsUris'
612 description: successful operation
617 /users/me/subscriptions/videos:
619 summary: Get videos of subscriptions of the current user
626 - $ref: '#/components/parameters/start'
627 - $ref: '#/components/parameters/count'
628 - $ref: '#/components/parameters/sort'
631 description: successful operation
635 $ref: '#/components/schemas/VideoListResponse'
636 '/users/me/subscriptions/{subscriptionHandle}':
638 summary: Get subscription of the current user for a given uri
645 - $ref: '#/components/parameters/subscriptionHandle'
648 description: successful operation
652 $ref: '#/components/schemas/VideoChannel'
654 summary: Delete subscription of the current user for a given uri
661 - $ref: '#/components/parameters/subscriptionHandle'
664 description: successful operation
665 /users/me/avatar/pick:
667 summary: Update current user avatar
674 description: successful operation
678 $ref: '#/components/schemas/Avatar'
686 description: The file to upload.
691 contentType: image/png, image/jpeg
694 summary: Get list of videos
698 - $ref: '#/components/parameters/categoryOneOf'
699 - $ref: '#/components/parameters/tagsOneOf'
700 - $ref: '#/components/parameters/tagsAllOf'
701 - $ref: '#/components/parameters/licenceOneOf'
702 - $ref: '#/components/parameters/languageOneOf'
703 - $ref: '#/components/parameters/nsfw'
704 - $ref: '#/components/parameters/filter'
705 - $ref: '#/components/parameters/start'
706 - $ref: '#/components/parameters/count'
707 - $ref: '#/components/parameters/videosSort'
710 description: successful operation
714 $ref: '#/components/schemas/VideoListResponse'
717 summary: Get list of video categories known by the server
722 description: successful operation
731 summary: Get list of video licences known by the server
736 description: successful operation
745 summary: Get list of languages known by the server
750 description: successful operation
759 summary: Get list of privacy policies supported by the server
764 description: successful operation
773 summary: Update metadata for a video by its id
779 - $ref: '#/components/parameters/idOrUUID'
782 description: successful operation
790 description: Video thumbnail file
794 description: Video preview file
798 description: Video category
801 description: Video licence
804 description: Video language
807 description: Video description
810 description: Whether or not we wait transcoding before publish the video
813 description: Text describing how to support the video uploader
816 description: Whether or not this video contains sensitive content
819 description: Video name
822 description: Video tags (maximum 5 tags each between 2 and 30 characters)
831 description: Enable or disable comments for this video
833 originallyPublishedAt:
834 description: Date when the content was originally published
838 $ref: '#/components/schemas/VideoScheduledUpdate'
841 contentType: image/jpeg
843 contentType: image/jpeg
845 summary: Get a video by its id
849 - $ref: '#/components/parameters/idOrUUID'
852 description: successful operation
856 $ref: '#/components/schemas/VideoDetails'
858 summary: Delete a video by its id
864 - $ref: '#/components/parameters/idOrUUID'
867 $ref: '#/paths/~1users~1me/put/responses/204'
868 '/videos/{id}/description':
870 summary: Get a video description by its id
874 - $ref: '#/components/parameters/idOrUUID'
877 description: successful operation
882 '/videos/{id}/views':
884 summary: Add a view to the video by its id
888 - $ref: '#/components/parameters/idOrUUID'
891 $ref: '#/paths/~1users~1me/put/responses/204'
892 '/videos/{id}/watching':
894 summary: Set watching progress of a video by its id for a user
900 - $ref: '#/components/parameters/idOrUUID'
905 $ref: '#/components/schemas/UserWatchingVideo'
909 $ref: '#/paths/~1users~1me/put/responses/204'
912 summary: Get list of video ownership changes requests
919 description: successful operation
920 '/videos/ownership/{id}/accept':
922 summary: Refuse ownership change request for video by its id
928 - $ref: '#/components/parameters/idOrUUID'
931 $ref: '#/paths/~1users~1me/put/responses/204'
932 '/videos/ownership/{id}/refuse':
934 summary: Accept ownership change request for video by its id
940 - $ref: '#/components/parameters/idOrUUID'
943 $ref: '#/paths/~1users~1me/put/responses/204'
944 '/videos/{id}/give-ownership':
946 summary: Request change of ownership for a video you own, by its id
952 - $ref: '#/components/parameters/idOrUUID'
956 application/x-www-form-urlencoded:
966 $ref: '#/paths/~1users~1me/put/responses/204'
968 description: 'Changing video ownership to a remote account is not supported yet'
971 summary: Upload a video file with its metadata
978 description: successful operation
982 $ref: '#/components/schemas/VideoUploadResponse'
984 description: 'The user video quota is exceeded with this video.'
986 description: 'Upload has timed out'
988 description: 'Invalid input file.'
996 description: Video file
1000 description: Channel id that will contain this video
1003 description: Video thumbnail file
1007 description: Video preview file
1011 $ref: '#/components/schemas/VideoPrivacySet'
1013 description: Video category
1016 description: Video licence
1019 description: Video language
1022 description: Video description
1025 description: Whether or not we wait transcoding before publish the video
1028 description: Text describing how to support the video uploader
1031 description: Whether or not this video contains sensitive content
1034 description: Video name
1037 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1046 description: Enable or disable comments for this video
1048 originallyPublishedAt:
1049 description: Date when the content was originally published
1053 $ref: '#/components/schemas/VideoScheduledUpdate'
1060 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
1062 contentType: image/jpeg
1064 contentType: image/jpeg
1068 ## DEPENDENCIES: httpie, jq
1069 # pip install httpie
1070 USERNAME="<your_username>"
1071 PASSWORD="<your_password>"
1072 FILE_PATH="<your_file_path>"
1073 CHANNEL_ID="<your_channel_id>"
1076 API_PATH="https://peertube2.cpy.re/api/v1"
1078 client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
1079 client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
1080 token=$(http -b --form POST "$API_PATH/users/token" \
1081 client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
1082 username=$USERNAME \
1083 password=$PASSWORD \
1084 | jq -r ".access_token")
1086 http -b --form POST "$API_PATH/videos/upload" \
1087 videofile@$FILE_PATH \
1088 channelId=$CHANNEL_ID \
1090 "Authorization:Bearer $token"
1093 summary: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
1100 description: successful operation
1104 $ref: '#/components/schemas/VideoUploadResponse'
1107 multipart/form-data:
1112 description: Torrent File
1116 description: HTTP target URL
1119 description: Magnet URI
1122 description: Channel id that will contain this video
1125 description: Video thumbnail file
1129 description: Video preview file
1133 $ref: '#/components/schemas/VideoPrivacySet'
1135 description: Video category
1138 description: Video licence
1141 description: Video language
1144 description: Video description
1147 description: Whether or not we wait transcoding before publish the video
1150 description: Text describing how to support the video uploader
1153 description: Whether or not this video contains sensitive content
1156 description: Video name
1159 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1168 description: Enable or disable comments for this video
1171 $ref: '#/components/schemas/VideoScheduledUpdate'
1177 contentType: application/x-bittorrent
1179 contentType: image/jpeg
1181 contentType: image/jpeg
1184 summary: Get list of reported video abuses
1190 - $ref: '#/components/parameters/start'
1191 - $ref: '#/components/parameters/count'
1192 - $ref: '#/components/parameters/abusesSort'
1195 description: successful operation
1201 $ref: '#/components/schemas/VideoAbuse'
1202 '/videos/{id}/abuse':
1204 summary: 'Report an abuse, on a video by its id'
1210 - $ref: '#/components/parameters/idOrUUID'
1213 $ref: '#/paths/~1users~1me/put/responses/204'
1214 '/videos/{id}/blacklist':
1216 summary: Put on blacklist a video by its id
1224 - $ref: '#/components/parameters/idOrUUID'
1227 $ref: '#/paths/~1users~1me/put/responses/204'
1229 summary: Delete an entry of the blacklist of a video by its id
1237 - $ref: '#/components/parameters/idOrUUID'
1240 $ref: '#/paths/~1users~1me/put/responses/204'
1243 summary: Get list of videos on blacklist
1251 - $ref: '#/components/parameters/start'
1252 - $ref: '#/components/parameters/count'
1253 - $ref: '#/components/parameters/blacklistsSort'
1256 description: successful operation
1262 $ref: '#/components/schemas/VideoBlacklist'
1263 /videos/{id}/captions:
1265 summary: Get list of video's captions
1269 - $ref: '#/components/parameters/idOrUUID'
1272 description: successful operation
1283 $ref: '#/components/schemas/VideoCaption'
1284 /videos/{id}/captions/{captionLanguage}:
1286 summary: Add or replace a video caption
1290 - $ref: '#/components/parameters/idOrUUID'
1291 - $ref: '#/components/parameters/captionLanguage'
1294 multipart/form-data:
1299 description: The file to upload.
1304 contentType: text/vtt, application/x-subrip, text/plain
1307 $ref: '#/paths/~1users~1me/put/responses/204'
1309 summary: Delete a video caption
1313 - $ref: '#/components/parameters/idOrUUID'
1314 - $ref: '#/components/parameters/captionLanguage'
1317 $ref: '#/paths/~1users~1me/put/responses/204'
1320 summary: Get list of video channels
1324 - $ref: '#/components/parameters/start'
1325 - $ref: '#/components/parameters/count'
1326 - $ref: '#/components/parameters/sort'
1329 description: successful operation
1335 $ref: '#/components/schemas/VideoChannel'
1337 summary: Creates a video channel for the current user
1344 $ref: '#/paths/~1users~1me/put/responses/204'
1349 $ref: '#/components/schemas/VideoChannelCreate'
1350 '/video-channels/{channelHandle}':
1352 summary: Get a video channel by its id
1356 - $ref: '#/components/parameters/channelHandle'
1359 description: successful operation
1363 $ref: '#/components/schemas/VideoChannel'
1365 summary: Update a video channel by its id
1371 - $ref: '#/components/parameters/channelHandle'
1374 $ref: '#/paths/~1users~1me/put/responses/204'
1379 $ref: '#/components/schemas/VideoChannelUpdate'
1381 summary: Delete a video channel by its id
1387 - $ref: '#/components/parameters/channelHandle'
1390 $ref: '#/paths/~1users~1me/put/responses/204'
1391 '/video-channels/{channelHandle}/videos':
1393 summary: Get videos of a video channel by its id
1398 - $ref: '#/components/parameters/channelHandle'
1401 description: successful operation
1405 $ref: '#/components/schemas/VideoListResponse'
1408 summary: Get list of video playlists
1412 - $ref: '#/components/parameters/start'
1413 - $ref: '#/components/parameters/count'
1414 - $ref: '#/components/parameters/sort'
1417 description: successful operation
1423 $ref: '#/components/schemas/VideoPlaylist'
1424 '/accounts/{name}/video-channels':
1426 summary: Get video channels of an account by its name
1430 - $ref: '#/components/parameters/name'
1433 description: successful operation
1439 $ref: '#/components/schemas/VideoChannel'
1440 '/accounts/{name}/ratings':
1442 summary: Get ratings of an account by its name
1448 - $ref: '#/components/parameters/name'
1449 - $ref: '#/components/parameters/start'
1450 - $ref: '#/components/parameters/count'
1451 - $ref: '#/components/parameters/sort'
1455 description: Optionally filter which ratings to retrieve
1463 description: successful operation
1469 $ref: '#/components/schemas/VideoRating'
1470 '/videos/{id}/comment-threads':
1472 summary: Get the comment threads of a video by its id
1476 - $ref: '#/components/parameters/idOrUUID'
1477 - $ref: '#/components/parameters/start'
1478 - $ref: '#/components/parameters/count'
1479 - $ref: '#/components/parameters/commentsSort'
1482 description: successful operation
1486 $ref: '#/components/schemas/CommentThreadResponse'
1488 summary: 'Creates a comment thread, on a video by its id'
1494 - $ref: '#/components/parameters/idOrUUID'
1497 description: successful operation
1501 $ref: '#/components/schemas/CommentThreadPostResponse'
1502 '/videos/{id}/comment-threads/{threadId}':
1504 summary: 'Get the comment thread by its id, of a video by its id'
1508 - $ref: '#/components/parameters/idOrUUID'
1509 - $ref: '#/components/parameters/threadId'
1512 description: successful operation
1516 $ref: '#/components/schemas/VideoCommentThreadTree'
1517 '/videos/{id}/comments/{commentId}':
1519 summary: 'Creates a comment in a comment thread by its id, of a video by its id'
1525 - $ref: '#/components/parameters/idOrUUID'
1526 - $ref: '#/components/parameters/commentId'
1529 description: successful operation
1533 $ref: '#/components/schemas/CommentThreadPostResponse'
1535 summary: 'Delete a comment in a comment thread by its id, of a video by its id'
1541 - $ref: '#/components/parameters/idOrUUID'
1542 - $ref: '#/components/parameters/commentId'
1545 $ref: '#/paths/~1users~1me/put/responses/204'
1546 '/videos/{id}/rate':
1548 summary: Vote for a video by its id
1554 - $ref: '#/components/parameters/idOrUUID'
1557 $ref: '#/paths/~1users~1me/put/responses/204'
1562 summary: Get the videos corresponding to a given query
1564 - $ref: '#/components/parameters/start'
1565 - $ref: '#/components/parameters/count'
1566 - $ref: '#/components/parameters/videosSearchSort'
1570 description: String to search
1575 description: successful operation
1579 $ref: '#/components/schemas/VideoListResponse'
1581 - url: 'https://peertube.cpy.re/api/v1'
1582 description: Live Test Server (live data - stable version)
1583 - url: 'https://peertube2.cpy.re/api/v1'
1584 description: Live Test Server (live data - bleeding edge version)
1585 - url: 'https://peertube3.cpy.re/api/v1'
1586 description: Live Test Server (live data - bleeding edge version)
1600 description: Number of items
1607 description: Sort column (-createdAt for example)
1614 description: Sort videos by criteria
1629 description: Sort videos by criteria
1644 description: Sort comments by criteria
1654 description: Sort blacklists by criteria
1670 description: Sort users by criteria
1681 description: Sort abuses by criteria
1693 The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
1701 description: The user id
1708 description: The video id or uuid
1712 name: captionLanguage
1715 description: The caption language
1722 description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
1726 name: subscriptionHandle
1729 description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
1736 description: The thread id (root comment id)
1743 description: The comment id
1750 description: category id of the video
1763 description: tag(s) of the video
1776 description: tag(s) of the video, where all should be present in the video
1789 description: language id of the video
1802 description: licence id of the video
1815 description: whether to include nsfw videos, if any
1826 Special filters (local for instance) which might require special rights:
1827 * `local` - only videos local to the instance
1828 * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
1838 description: list of uris to check if each is part of the user subscriptions
1846 In the header: *Authorization: Bearer <token\>*
1849 Authenticating via OAuth requires the following steps:
1852 - Have an account with sufficient authorization levels
1854 - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
1857 - Make Authenticated Requests
1861 tokenUrl: 'https://peertube.example.com/api/v1/users/token'
1864 moderator: Moderator scope
1867 VideoConstantNumber:
1873 VideoConstantString:
1885 description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
1886 VideoPrivacyConstant:
1904 description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
1907 VideoResolutionConstant:
1911 description: 'Video resolution (240, 360, 720 ...)'
1914 VideoScheduledUpdate:
1917 $ref: '#/components/schemas/VideoPrivacySet'
1918 description: Video privacy target
1922 description: When to update the video
1925 VideoAccountSummary:
1939 $ref: '#/components/schemas/Avatar'
1940 VideoChannelSummary:
1954 $ref: '#/components/schemas/Avatar'
1965 $ref: '#/components/schemas/Video'
1971 $ref: '#/components/schemas/VideoResolutionConstant'
1974 description: 'Video file size in bytes'
1985 VideoStreamingPlaylists:
1993 description: 'Playlist type (HLS = 1)'
2017 originallyPublishedAt:
2020 $ref: '#/components/schemas/VideoConstantNumber'
2022 $ref: '#/components/schemas/VideoConstantNumber'
2024 $ref: '#/components/schemas/VideoConstantString'
2026 $ref: '#/components/schemas/VideoPrivacyConstant'
2053 $ref: '#/components/schemas/VideoStateConstant'
2056 $ref: '#/components/schemas/VideoScheduledUpdate'
2064 $ref: '#/components/schemas/VideoAccountSummary'
2066 $ref: '#/components/schemas/VideoChannelSummary'
2075 - $ref: '#/components/schemas/Video'
2083 $ref: '#/components/schemas/VideoChannel'
2085 $ref: '#/components/schemas/Account'
2093 $ref: '#/components/schemas/VideoFile'
2105 $ref: '#/components/schemas/VideoStreamingPlaylists'
2106 VideoImportStateConstant:
2114 description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
2131 $ref: '#/components/schemas/VideoImportStateConstant'
2141 $ref: '#/components/schemas/Video'
2149 $ref: '#/components/schemas/Account'
2269 totalRepliesFromVideoAuthor:
2274 $ref: '#/components/schemas/Account'
2275 VideoCommentThreadTree:
2278 $ref: '#/components/schemas/VideoComment'
2282 $ref: '#/components/schemas/VideoCommentThreadTree'
2286 $ref: '#/components/schemas/VideoConstantString'
2316 $ref: '#/components/schemas/Avatar'
2319 - $ref: '#/components/schemas/Actor'
2345 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2359 $ref: '#/components/schemas/Account'
2363 $ref: '#/components/schemas/VideoChannel'
2433 allowedForCurrentIP:
2435 requiresEmailVerification:
2638 requiresEmailVerification:
2662 allowAdditionalExtensions:
2730 $ref: '#/components/schemas/Actor'
2732 $ref: '#/components/schemas/Actor'
2774 VideoUploadResponse:
2783 CommentThreadResponse:
2790 $ref: '#/components/schemas/VideoComment'
2791 CommentThreadPostResponse:
2794 $ref: '#/components/schemas/VideoComment'
2802 $ref: '#/components/schemas/Video'
2807 description: 'The user username '
2810 description: 'The user password. If the smtp server is configured, you can leave empty and an email will be sent '
2813 description: 'The user email '
2816 description: 'The user videoQuota '
2819 description: 'The user daily video quota '
2826 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2838 description: 'The user id '
2841 description: 'The updated email of the user '
2844 description: 'The updated videoQuota of the user '
2847 description: 'The updated daily video quota of the user '
2854 description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
2865 description: 'Your new password '
2868 description: 'Your new email '
2871 description: 'Your new displayNSFW '
2874 description: 'Your new autoPlayVideo '
2884 description: 'Id of the video '
2887 description: 'Rating of the video '
2894 $ref: '#/components/schemas/Video'
2897 description: 'Rating of the video'
2905 description: 'The username of the user '
2908 description: 'The password of the user '
2911 description: 'The email of the user '
2914 description: 'The user display name'
2920 description: 'The default channel name'
2923 description: 'The default channel display name'
2950 bulkVideosSupportUpdate:
2952 description: 'Update all videos support field of this channel'