5 description: Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
6 host: peertube.example.com
9 description: 'In the header: *Authorization: Bearer mytoken*'
13 # authorizationUrl: https://example.com/oauth/authorize
14 tokenUrl: https://peertube.example.com/api/v1/users/token
32 description: 'The id of the account'
37 description: 'starting page'
42 description: 'stopping page'
47 description: 'sorting'
50 description: successful operation
52 $ref: '#/definitions/Account'
63 description: successful operation
67 $ref: '#/definitions/Account'
78 description: successful operation
80 $ref: '#/definitions/ServerConfig'
81 /feeds/videos.{format}:
86 - application/atom+xml
94 enum: ['xml', 'atom' 'json']
96 description: 'The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0'
101 description: 'The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds'
106 description: 'The name of the local account to filter to'
109 description: successful operation
125 description: 'The id of the account'
130 description: 'starting page'
140 description: 'sorting'
143 description: successful operation
147 $ref: '#/definitions/Job'
148 '/server/following/{host}':
163 description: 'The host to unfollow '
166 description: successful operation
180 description: 'starting page'
185 description: 'stopping page'
190 description: 'sorting'
193 description: successful operation
197 $ref: '#/definitions/Follow'
211 description: 'starting page'
216 description: 'stopping page'
221 description: 'sorting'
224 description: successful operation
228 $ref: '#/definitions/Follow'
242 $ref: '#/definitions/Follow'
245 description: successful operation
260 description: 'User to create'
262 $ref: '#/definitions/AddUser'
265 description: successful operation
267 $ref: '#/definitions/AddUserResponse'
282 description: 'starting page'
287 description: 'stopping page'
292 description: 'sorting'
295 description: successful operation
299 $ref: '#/definitions/User'
315 description: 'The user id '
318 description: successful operation
333 description: 'The user id '
336 description: successful operation
338 $ref: '#/definitions/User'
353 description: 'The user id '
358 $ref: '#/definitions/UpdateUser'
361 description: successful operation
374 description: successful operation
378 $ref: '#/definitions/User'
393 $ref: '#/definitions/UpdateMe'
396 description: successful operation
397 /users/me/video-quota-used:
410 description: successful operation
413 '/users/me/videos/{videoId}/rating':
428 description: 'The video id '
431 description: successful operation
433 $ref: '#/definitions/GetMeVideoRating'
449 description: 'starting page'
454 description: 'stopping page'
459 description: 'sorting'
462 description: successful operation
466 $ref: '#/definitions/Video'
480 $ref: '#/definitions/RegisterUser'
483 description: successful operation
484 /users/me/avatar/pick:
491 - multipart/form-data
498 description: The file to upload.
501 description: successful operation
503 $ref: '#/definitions/Avatar'
517 description: 'starting page'
522 description: 'stopping page'
527 description: 'sorting'
530 description: successful operation
534 $ref: '#/definitions/Video'
545 description: successful operation
560 description: successful operation
575 description: successful operation
590 description: successful operation
608 description: 'starting page'
613 description: 'stopping page'
618 description: 'sorting'
621 description: successful operation
625 $ref: '#/definitions/Video'
633 - multipart/form-data
641 description: 'The video id'
642 - name: thumbnailfile
645 description: 'Video thumbnail file'
649 description: 'Video preview file'
653 description: 'Video category'
657 description: 'Video licence'
661 description: 'Video language'
665 description: 'Video description'
669 description: 'Text describing how to support the video uploader'
673 description: 'Whether or not this video contains sensitive content'
677 description: 'Video name'
681 description: 'Video tags'
682 - name: commentsEnabled
685 description: 'Enable or disable comments for this video'
689 enum: [Public, Unlisted]
690 description: 'Video privacy'
693 description: successful operation
695 $ref: '#/definitions/Video'
708 description: 'The video id '
711 description: successful operation
713 $ref: '#/definitions/Video'
728 description: 'The video id '
731 description: successful operation
732 "/videos/{id}/description":
745 description: 'The video id '
748 description: successful operation
751 "/videos/{id}/views":
764 description: 'The video id '
767 description: successful operation
775 - multipart/form-data
783 description: 'Video file'
784 - name: thumbnailfile
788 description: 'Video thumbnail file'
793 description: 'Video preview file'
797 description: 'Video category'
801 description: 'Video licence'
805 description: 'Video language'
809 description: 'Video description'
813 description: 'Text describing how to support the video uploader'
818 description: 'Channel id that will contain this video'
823 description: 'Whether or not this video contains sensitive content'
828 description: 'Video name'
832 description: 'Video tags'
833 - name: commentsEnabled
836 description: 'Enable or disable comments for this video'
841 enum: [Public, Unlisted, Private]
842 description: 'Video privacy'
845 description: successful operation
847 $ref: '#/definitions/VideoUploadResponse'
863 description: 'starting page'
868 description: 'stopping page'
873 description: 'sorting'
876 description: successful operation
880 $ref: '#/definitions/VideoAbuse'
881 "/videos/{id}/abuse":
896 description: 'The video id '
899 description: successful operation
900 "/videos/{videoId}/blacklist":
915 description: 'The video id '
918 description: successful operation
933 description: 'The video id '
936 description: successful operation
952 description: 'starting page'
957 description: 'stopping page'
962 description: 'sorting'
965 description: successful operation
969 $ref: '#/definitions/VideoBlacklist'
983 description: 'starting page'
988 description: 'stopping page'
993 description: 'sorting'
996 description: successful operation
1000 $ref: '#/definitions/VideoChannel'
1014 $ref: '#/definitions/VideoChannelInput'
1017 description: successful operation
1018 "/videos/channels/{id}":
1031 description: 'The video id '
1034 description: successful operation
1036 $ref: '#/definitions/VideoChannel'
1051 description: 'The video id '
1055 $ref: '#/definitions/VideoChannelInput'
1058 description: successful operation
1073 description: 'The video id '
1076 description: successful operation
1077 /videos/accounts/{accountId}/channels:
1090 description: 'The account id '
1093 description: successful operation
1097 $ref: '#/definitions/VideoChannel'
1098 "/videos/{videoId}/comment-threads":
1111 description: 'The video id '
1116 description: 'starting page'
1121 description: 'stopping page'
1126 description: 'sorting'
1129 description: successful operation
1131 $ref: '#/definitions/CommentThreadResponse'
1146 description: 'The video id '
1149 description: successful operation
1151 $ref: '#/definitions/CommentThreadPostResponse'
1152 "/videos/{videoId}/comment-threads/{threadId}":
1165 description: 'The video id '
1170 description: 'The thread id '
1173 description: successful operation
1175 $ref: '#/definitions/VideoCommentThreadTree'
1176 "/videos/{videoId}/comments/{commentId}":
1191 description: 'The video id '
1196 description: 'The comment id '
1199 description: successful operation
1201 $ref: '#/definitions/CommentThreadPostResponse'
1216 description: 'The video id '
1221 description: 'The comment id '
1224 description: successful operation
1225 "/videos/{id}/rate":
1240 description: 'The video id '
1243 description: successful operation
1245 VideoConstantNumber:
1251 VideoConstantString:
1259 enum: [Public, Unlisted, Private]
1273 $ref: "#/definitions/VideoConstantNumber"
1275 $ref: "#/definitions/VideoConstantNumber"
1277 $ref: "#/definitions/VideoConstantString"
1279 $ref: "#/definitions/VideoPrivacy"
1314 $ref: "#/definitions/Avatar"
1322 $ref: "#/definitions/Account"
1380 $ref: "#/definitions/Video"
1402 $ref: "#/definitions/Account"
1403 VideoCommentThreadTree:
1406 $ref: "#/definitions/VideoComment"
1410 $ref: "#/definitions/VideoCommentThreadTree"
1440 $ref: "#/definitions/Avatar"
1443 - $ref: "#/definitions/Actor"
1461 enum: [User, Moderator, Administrator]
1467 $ref: "#/definitions/Account"
1471 $ref: "#/definitions/VideoChannel"
1516 $ref: "#/definitions/Actor"
1518 $ref: "#/definitions/Actor"
1523 enum: [pending, accepted]
1534 enum: [pending, processing, error, success]
1537 enum: [transcoding, activitypub-http]
1554 VideoUploadResponse:
1563 CommentThreadResponse:
1570 $ref: "#/definitions/VideoComment"
1571 CommentThreadPostResponse:
1574 $ref: "#/definitions/VideoComment"
1581 description: 'The user username '
1584 description: 'The user password '
1587 description: 'The user email '
1590 description: 'The user videoQuota '
1593 description: 'The user role '
1604 description: 'The user id '
1607 description: 'The updated email of the user '
1610 description: 'The updated videoQuota of the user '
1613 description: 'The updated role of the user '
1623 description: 'Your new password '
1626 description: 'Your new email '
1629 description: 'Your new displayNSFW '
1632 description: 'Your new autoPlayVideo '
1642 description: 'Id of the video '
1645 description: 'Rating of the video '
1653 description: 'The username of the user '
1656 description: 'The password of the user '
1659 description: 'The email of the user '