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
15 The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
16 HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
17 [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
18 which generates a client SDK in the language of your choice - we generate some client SDKs automatically:
20 - [Python](https://framagit.org/framasoft/peertube/clients/python)
21 - [Go](https://framagit.org/framasoft/peertube/clients/go)
22 - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
24 See the [REST API quick start](https://docs.joinpeertube.org/api-rest-getting-started) for a few
25 examples of using the PeerTube API.
29 When you sign up for an account on a PeerTube instance, you are given the possibility
30 to generate sessions on it, and authenticate there using an access token. Only __one
31 access token can currently be used at a time__.
35 Accounts are given permissions based on their role. There are three roles on
36 PeerTube: Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin-managing-users?id=roles) for a detail of their permissions.
40 The API uses standard HTTP status codes to indicate the success or failure
41 of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.
44 HTTP 1.1 404 Not Found
45 Content-Type: application/problem+json; charset=utf-8
48 "detail": "Video not found",
49 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
56 We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/shared/models/server/server-error-code.enum.ts),
57 but it is still optional. Types are used to disambiguate errors that bear the same status code
61 HTTP 1.1 403 Forbidden
62 Content-Type: application/problem+json; charset=utf-8
65 "detail": "Cannot get this video regarding follow constraints",
66 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
69 "type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
73 Here a 403 error could otherwise mean that the video is private or blocklisted.
77 Each parameter is evaluated on its own against a set of rules before the route validator
78 proceeds with potential testing involving parameter combinations. Errors coming from validation
79 errors appear earlier and benefit from a more detailed error description:
82 HTTP 1.1 400 Bad Request
83 Content-Type: application/problem+json; charset=utf-8
86 "detail": "Incorrect request parameters: id",
87 "docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
88 "instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
92 "msg": "Invalid value",
94 "value": "9c9de5e8-0a1e-484a-b099-e80766180"
98 "title": "Bad Request",
103 Where `id` is the name of the field concerned by the error, within the route definition.
104 `invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and
105 `invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg`
108 ### Deprecated error fields
110 Some fields could be included with previous versions. They are still included but their use is deprecated:
111 - `error`: superseded by `detail`
112 - `code`: superseded by `type` (which is now an URI)
116 We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
118 | Endpoint (prefix: `/api/v1`) | Calls | Time frame |
119 |------------------------------|---------------|--------------|
120 | `/*` | 50 | 10 seconds |
121 | `POST /users/token` | 15 | 5 minutes |
122 | `POST /users/register` | 2<sup>*</sup> | 5 minutes |
123 | `POST /users/ask-send-verify-email` | 3 | 5 minutes |
125 Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
126 limit is announced by a `429 Too Many Requests` status code.
128 You can get details about the current state of your rate limit by reading the
131 | Header | Description |
132 |-------------------------|------------------------------------------------------------|
133 | `X-RateLimit-Limit` | Number of max requests allowed in the current time period |
134 | `X-RateLimit-Remaining` | Number of remaining requests in the current time period |
135 | `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp |
136 | `Retry-After` | Seconds to delay after the first `429` is received |
140 This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
141 allowing cross-domain communication from the browser for some routes:
144 |------------------------- ---|
148 | `/live/segments-sha256/*` |
149 | `/.well-known/webfinger` |
151 In addition, all routes serving ActivityPub are CORS-enabled for all origins.
153 url: https://docs.joinpeertube.org/api-rest-reference.html
157 As a visitor, you can use this API to open an account (if registrations are open on
158 that PeerTube instance). As an admin, you should use the dedicated [User creation
159 API](#operation/addUser) instead.
161 x-displayName: Login/Logout
163 Sessions deal with access tokens over time. Only __one session token can currently be used at a time__.
166 Accounts encompass remote accounts discovered across the federation,
167 and correspond to the main Actor, along with video channels a user can create, which
170 When a comment is posted, it is done with your Account's Actor.
173 Using some features of PeerTube require authentication, for which User
174 provide different levels of permission as well as associated user
175 information. Each user has a corresponding local Account for federation.
178 Operations related to your own User, when logged-in.
179 - name: My Subscriptions
181 Operations related to your subscriptions to video channels, their
182 new videos, and how to keep up to date with their latest publications!
185 Operations related to your watch history.
186 - name: My Notifications
188 Notifications following new videos, follows or reports. They allow you
189 to keep track of the interactions and overall important information that
190 concerns you. You MAY set per-notification type delivery preference, to
191 receive the info either by mail, by in-browser notification or both.
194 Each server exposes public information regarding supported videos and
198 Jobs are long-running tasks enqueued and processed by the instance
199 itself. No additional worker registration is currently available.
200 - name: Instance Follows
202 Managing servers which the instance interacts with is crucial to the
203 concept of federation in PeerTube and external video indexation. The PeerTube
204 server then deals with inter-server ActivityPub operations and propagates
205 information across its social graph by posting activities to actors' inbox
208 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-follows
209 - name: Instance Redundancy
211 Redundancy is part of the inter-server solidarity that PeerTube fosters.
212 Manage the list of instances you wish to help by seeding their videos according
213 to the policy of video selection of your choice. Note that you have a similar functionality
214 to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
216 url: https://docs.joinpeertube.org/admin-following-instances?id=instances-redundancy
219 Managing plugins installed from a local path or from NPM, or search for new ones.
221 url: https://docs.joinpeertube.org/api-plugins
224 Abuses deal with reports of local or remote videos/comments/accounts alike.
227 Operations dealing with listing, uploading, fetching or modifying videos.
230 Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
234 - [_legacy_](#operation/uploadLegacy), where the video file is sent in a single request
235 - [_resumable_](#operation/uploadResumableInit), where the video file is sent in chunks
237 You can upload videos more reliably by using the resumable variant. Its protocol lets
238 you resume an upload operation after a network interruption or other transmission failure,
239 saving time and bandwidth in the event of network failures.
241 Favor using resumable uploads in any of the following cases:
242 - You are transferring large files
243 - The likelihood of a network interruption is high
244 - Uploads are originating from a device with a low-bandwidth or unstable Internet connection,
245 such as a mobile device
249 - _URL_-based: where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
250 - _magnet_-based: where the URI resolves to a BitTorrent ressource containing a single supported video file
251 - _torrent_-based: where the metainfo file resolves to a BitTorrent ressource containing a single supported video file
253 The import function is practical when the desired video/audio is available online. It makes PeerTube
254 download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
255 - name: Video Imports
256 description: Operations dealing with listing, adding and removing video imports.
257 - name: Video Captions
258 description: Operations dealing with listing, adding and removing closed captions of a video.
259 - name: Video Channels
260 description: Operations dealing with the creation, modification and listing of videos within a channel.
261 - name: Video Comments
263 Operations dealing with comments to a video. Comments are organized in threads: adding a
264 comment in response to the video starts a thread, adding a reply to a comment adds it to
265 its root comment thread.
267 description: Operations dealing with blocking videos (removing them from view and preventing interactions).
269 description: Like/dislike a video.
270 - name: Video Playlists
271 description: Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
273 description: Operations on video files
274 - name: Video Transcoding
275 description: Video transcoding related operations
277 description: Video statistics
279 description: Server syndication feeds
282 The search helps to find _videos_ or _channels_ from within the instance and beyond.
283 Videos from other instances federated by the instance (that is, instances
284 followed by the instance) can be found via keywords and other criteria of
287 Administrators can also enable the use of a remote search system, indexing
288 videos and channels not could be not federated by the instance.
290 description: Get and update the custom homepage
291 - name: Video Mirroring
293 PeerTube instances can mirror videos from one another, and help distribute some videos.
295 For importing videos as your own, refer to [video imports](#operation/importVideo).
320 - Video Ownership Change
338 - name: Instance Configuration
342 - Instance Redundancy
352 summary: Get an account
353 operationId: getAccount
355 - $ref: '#/components/parameters/name'
358 description: successful operation
362 $ref: '#/components/schemas/Account'
364 description: account not found
366 '/accounts/{name}/videos':
371 summary: 'List videos of an account'
372 operationId: getAccountVideos
374 - $ref: '#/components/parameters/name'
375 - $ref: '#/components/parameters/categoryOneOf'
376 - $ref: '#/components/parameters/isLive'
377 - $ref: '#/components/parameters/tagsOneOf'
378 - $ref: '#/components/parameters/tagsAllOf'
379 - $ref: '#/components/parameters/licenceOneOf'
380 - $ref: '#/components/parameters/languageOneOf'
381 - $ref: '#/components/parameters/nsfw'
382 - $ref: '#/components/parameters/isLocal'
383 - $ref: '#/components/parameters/include'
384 - $ref: '#/components/parameters/privacyOneOf'
385 - $ref: '#/components/parameters/hasHLSFiles'
386 - $ref: '#/components/parameters/hasWebtorrentFiles'
387 - $ref: '#/components/parameters/skipCount'
388 - $ref: '#/components/parameters/start'
389 - $ref: '#/components/parameters/count'
390 - $ref: '#/components/parameters/videosSort'
393 description: successful operation
397 $ref: '#/components/schemas/VideoListResponse'
401 fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
402 .then(function(response) {
403 return response.json()
404 }).then(function(data) {
410 curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
416 uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
418 http = Net::HTTP.new(uri.host, uri.port)
421 response = http.get(uri.request_uri)
423 puts JSON.parse(response.read_body)
428 r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
433 '/accounts/{name}/followers':
437 summary: 'List followers of an account'
440 operationId: getAccountFollowers
442 - $ref: '#/components/parameters/name'
443 - $ref: '#/components/parameters/start'
444 - $ref: '#/components/parameters/count'
445 - $ref: '#/components/parameters/followersSort'
446 - $ref: '#/components/parameters/search'
449 description: successful operation
461 $ref: '#/components/schemas/Follow'
467 summary: List accounts
468 operationId: getAccounts
470 - $ref: '#/components/parameters/start'
471 - $ref: '#/components/parameters/count'
472 - $ref: '#/components/parameters/sort'
475 description: successful operation
481 $ref: '#/components/schemas/Account'
487 summary: Get instance public configuration
488 operationId: getConfig
491 description: successful operation
495 $ref: '#/components/schemas/ServerConfig'
498 externalValue: https://peertube2.cpy.re/api/v1/config
502 summary: Get instance "About" information
503 operationId: getAbout
508 description: successful operation
512 $ref: '#/components/schemas/ServerConfigAbout'
515 externalValue: https://peertube2.cpy.re/api/v1/config/about
519 summary: Get instance runtime configuration
520 operationId: getCustomConfig
528 description: successful operation
532 $ref: '#/components/schemas/ServerConfigCustom'
534 summary: Set instance runtime configuration
535 operationId: putCustomConfig
543 description: successful operation
545 x-summary: field inconsistencies
548 - the emailer is disabled and the instance is open to registrations
549 - webtorrent and hls are disabled with transcoding enabled - you need at least one enabled
551 summary: Delete instance runtime configuration
552 operationId: delCustomConfig
560 description: successful operation
562 /custom-pages/homepage/instance:
564 summary: Get instance custom homepage
569 description: No homepage set
571 description: successful operation
575 $ref: '#/components/schemas/CustomHomepage'
577 summary: Set instance custom homepage
591 description: content of the homepage, that will be injected in the client
594 description: successful operation
598 summary: Pause job queue
606 description: successful operation
610 summary: Resume job queue
618 description: successful operation
622 summary: List instance jobs
633 description: The state of the job ('' for for no filter)
643 - $ref: '#/components/parameters/jobType'
644 - $ref: '#/components/parameters/start'
645 - $ref: '#/components/parameters/count'
646 - $ref: '#/components/parameters/sort'
649 description: successful operation
662 $ref: '#/components/schemas/Job'
668 summary: List instances following the server
670 - $ref: '#/components/parameters/followState'
671 - $ref: '#/components/parameters/actorType'
672 - $ref: '#/components/parameters/start'
673 - $ref: '#/components/parameters/count'
674 - $ref: '#/components/parameters/sort'
677 description: successful operation
689 $ref: '#/components/schemas/Follow'
691 '/server/followers/{nameWithHost}':
693 summary: Remove or reject a follower to your server
703 description: The remote actor handle to remove from your followers
709 description: successful operation
711 description: follower not found
713 '/server/followers/{nameWithHost}/reject':
715 summary: Reject a pending follower to your server
725 description: The remote actor handle to remove from your followers
731 description: successful operation
733 description: follower not found
735 '/server/followers/{nameWithHost}/accept':
737 summary: Accept a pending follower to your server
747 description: The remote actor handle to remove from your followers
753 description: successful operation
755 description: follower not found
761 summary: List instances followed by the server
763 - $ref: '#/components/parameters/followState'
764 - $ref: '#/components/parameters/actorType'
765 - $ref: '#/components/parameters/start'
766 - $ref: '#/components/parameters/count'
767 - $ref: '#/components/parameters/sort'
770 description: successful operation
782 $ref: '#/components/schemas/Follow'
789 summary: Follow a list of actors (PeerTube instance, channel or account)
792 description: successful operation
794 description: cannot follow a non-HTTPS server
813 '/server/following/{hostOrHandle}':
815 summary: Unfollow an actor (PeerTube instance, channel or account)
825 description: The hostOrHandle to unfollow
830 description: successful operation
832 description: host or handle not found
836 summary: Create a user
845 description: user created
849 $ref: '#/components/schemas/AddUserResponse'
855 id: '$response.body#/user/id'
860 id: '$response.body#/user/id'
865 id: '$response.body#/user/id'
867 description: insufficient authority to create an admin or moderator
872 $ref: '#/components/schemas/AddUser'
874 If the smtp server is configured, you can leave the password empty and an email will be sent
875 asking the user to set it first.
879 operationId: getUsers
886 - $ref: '#/components/parameters/usersSearch'
887 - $ref: '#/components/parameters/usersBlocked'
888 - $ref: '#/components/parameters/start'
889 - $ref: '#/components/parameters/count'
890 - $ref: '#/components/parameters/usersSort'
893 description: successful operation
899 $ref: '#/components/schemas/User'
903 - $ref: '#/components/parameters/id'
905 summary: Delete a user
914 description: successful operation
925 description: include statistics about the user (only available as a moderator/admin)
930 x-summary: successful operation
932 As an admin/moderator, you can request a response augmented with statistics about the user's
933 moderation relations and videos usage, by using the `withStats` parameter.
938 - $ref: '#/components/schemas/User'
939 - $ref: '#/components/schemas/UserWithStats'
941 summary: Update a user
949 description: successful operation
954 $ref: '#/components/schemas/UpdateUser'
957 /oauth-clients/local:
959 summary: Login prerequisite
960 description: You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken).
961 operationId: getOAuthClient
966 description: successful operation
970 $ref: '#/components/schemas/OAuthClient'
972 UseOAuthClientToLogin:
973 operationId: getOAuthToken
975 client_id: '$response.body#/client_id'
976 client_secret: '$response.body#/client_secret'
980 API="https://peertube2.cpy.re/api/v1"
983 curl -s "$API/oauth-clients/local"
988 operationId: getOAuthToken
989 description: With your [client id and secret](#operation/getOAuthClient), you can retrieve an access and refresh tokens.
994 application/x-www-form-urlencoded:
997 - $ref: '#/components/schemas/OAuthToken-password'
998 - $ref: '#/components/schemas/OAuthToken-refresh_token'
1000 propertyName: grant_type
1002 password: '#/components/schemas/OAuthToken-password'
1003 refresh_token: '#/components/schemas/OAuthToken-refresh_token'
1006 description: successful operation
1017 example: 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0
1018 description: valid for 1 day
1021 example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
1022 description: valid for 2 weeks
1027 refresh_token_expires_in:
1032 x-summary: client or credentials are invalid
1034 Disambiguate via `type`:
1035 - `invalid_client` for an unmatched `client_id`
1036 - `invalid_grant` for unmatched credentials
1038 x-summary: token expired
1040 Disambiguate via `type`:
1041 - default value for a regular authentication failure
1042 - `invalid_token` for an expired token
1047 API="https://peertube2.cpy.re/api/v1"
1048 USERNAME="<your_username>"
1049 PASSWORD="<your_password>"
1052 client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
1053 client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
1054 curl -s "$API/users/token" \
1055 --data client_id="$client_id" \
1056 --data client_secret="$client_secret" \
1057 --data grant_type=password \
1058 --data username="$USERNAME" \
1059 --data password="$PASSWORD" \
1060 | jq -r ".access_token"
1062 /users/revoke-token:
1065 description: Revokes your access token and its associated refresh token, destroying your current session.
1066 operationId: revokeOAuthToken
1073 description: successful operation
1077 summary: Register a user
1078 operationId: registerUser
1084 description: successful operation
1089 $ref: '#/components/schemas/RegisterUser'
1092 /users/{id}/verify-email:
1094 summary: Verify a user
1095 operationId: verifyUser
1097 Following a user registration, the new user will receive an email asking to click a link
1098 containing a secret.
1103 - $ref: '#/components/parameters/id'
1116 - verificationString
1119 description: successful operation
1121 description: invalid verification string
1123 description: user not found
1125 /users/ask-send-verify-email:
1127 summary: Resend user verification link
1128 operationId: resendEmailToVerifyUser
1134 description: successful operation
1138 summary: Get my user information
1139 operationId: getUserInfo
1147 description: successful operation
1153 $ref: '#/components/schemas/User'
1155 summary: Update my user information
1156 operationId: putUserInfo
1164 description: successful operation
1169 $ref: '#/components/schemas/UpdateMe'
1172 /users/me/videos/imports:
1174 summary: Get video imports of my user
1182 - $ref: '#/components/parameters/start'
1183 - $ref: '#/components/parameters/count'
1184 - $ref: '#/components/parameters/sort'
1187 description: successful operation
1191 $ref: '#/components/schemas/VideoImportsList'
1193 /users/me/video-quota-used:
1195 summary: Get my user used quota
1203 description: successful operation
1211 description: The user video quota used so far in bytes
1212 example: 16810141515
1213 videoQuotaUsedDaily:
1215 description: The user video quota used today in bytes
1218 '/users/me/videos/{videoId}/rating':
1220 summary: Get rate of my user for a video
1230 description: The video id
1232 $ref: '#/components/schemas/Video/properties/id'
1235 description: successful operation
1239 $ref: '#/components/schemas/GetMeVideoRating'
1243 summary: Get videos of my user
1251 - $ref: '#/components/parameters/start'
1252 - $ref: '#/components/parameters/count'
1253 - $ref: '#/components/parameters/sort'
1256 description: successful operation
1260 $ref: '#/components/schemas/VideoListResponse'
1262 /users/me/subscriptions:
1264 summary: Get my user subscriptions
1271 - $ref: '#/components/parameters/start'
1272 - $ref: '#/components/parameters/count'
1273 - $ref: '#/components/parameters/sort'
1276 description: successful operation
1280 $ref: '#/components/schemas/VideoChannelList'
1284 summary: Add subscription to my user
1297 description: uri of the video channels to subscribe to
1303 uri: 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
1306 description: successful operation
1308 /users/me/subscriptions/exist:
1310 summary: Get if subscriptions exist for my user
1317 - $ref: '#/components/parameters/subscriptionsUris'
1320 description: successful operation
1326 /users/me/subscriptions/videos:
1328 summary: List videos of subscriptions of my user
1336 - $ref: '#/components/parameters/categoryOneOf'
1337 - $ref: '#/components/parameters/isLive'
1338 - $ref: '#/components/parameters/tagsOneOf'
1339 - $ref: '#/components/parameters/tagsAllOf'
1340 - $ref: '#/components/parameters/licenceOneOf'
1341 - $ref: '#/components/parameters/languageOneOf'
1342 - $ref: '#/components/parameters/nsfw'
1343 - $ref: '#/components/parameters/isLocal'
1344 - $ref: '#/components/parameters/include'
1345 - $ref: '#/components/parameters/privacyOneOf'
1346 - $ref: '#/components/parameters/hasHLSFiles'
1347 - $ref: '#/components/parameters/hasWebtorrentFiles'
1348 - $ref: '#/components/parameters/skipCount'
1349 - $ref: '#/components/parameters/start'
1350 - $ref: '#/components/parameters/count'
1351 - $ref: '#/components/parameters/videosSort'
1354 description: successful operation
1358 $ref: '#/components/schemas/VideoListResponse'
1360 '/users/me/subscriptions/{subscriptionHandle}':
1362 summary: Get subscription of my user
1369 - $ref: '#/components/parameters/subscriptionHandle'
1372 description: successful operation
1376 $ref: '#/components/schemas/VideoChannel'
1378 summary: Delete subscription of my user
1385 - $ref: '#/components/parameters/subscriptionHandle'
1388 description: successful operation
1390 /users/me/notifications:
1392 summary: List my notifications
1400 description: only list unread notifications
1403 - $ref: '#/components/parameters/start'
1404 - $ref: '#/components/parameters/count'
1405 - $ref: '#/components/parameters/sort'
1408 description: successful operation
1412 $ref: '#/components/schemas/NotificationListResponse'
1414 /users/me/notifications/read:
1416 summary: Mark notifications as read by their id
1429 description: ids of the notifications to mark as read
1436 description: successful operation
1438 /users/me/notifications/read-all:
1440 summary: Mark all my notification as read
1447 description: successful operation
1449 /users/me/notification-settings:
1451 summary: Update my notification settings
1462 newVideoFromSubscription:
1463 $ref: '#/components/schemas/NotificationSettingValue'
1464 newCommentOnMyVideo:
1465 $ref: '#/components/schemas/NotificationSettingValue'
1467 $ref: '#/components/schemas/NotificationSettingValue'
1468 videoAutoBlacklistAsModerator:
1469 $ref: '#/components/schemas/NotificationSettingValue'
1471 $ref: '#/components/schemas/NotificationSettingValue'
1473 $ref: '#/components/schemas/NotificationSettingValue'
1474 myVideoImportFinished:
1475 $ref: '#/components/schemas/NotificationSettingValue'
1477 $ref: '#/components/schemas/NotificationSettingValue'
1478 newUserRegistration:
1479 $ref: '#/components/schemas/NotificationSettingValue'
1481 $ref: '#/components/schemas/NotificationSettingValue'
1482 newInstanceFollower:
1483 $ref: '#/components/schemas/NotificationSettingValue'
1484 autoInstanceFollowing:
1485 $ref: '#/components/schemas/NotificationSettingValue'
1488 description: successful operation
1490 /users/me/history/videos:
1492 summary: List watched videos history
1498 - $ref: '#/components/parameters/start'
1499 - $ref: '#/components/parameters/count'
1500 - $ref: '#/components/parameters/search'
1503 description: successful operation
1507 $ref: '#/components/schemas/VideoListResponse'
1509 /users/me/history/videos/{videoId}:
1511 summary: Delete history element
1521 $ref: '#/components/schemas/Video/properties/id'
1524 description: successful operation
1526 /users/me/history/videos/remove:
1528 summary: Clear video history
1535 multipart/form-data:
1540 description: history before this date will be deleted
1545 description: successful operation
1547 /users/me/avatar/pick:
1549 summary: Update my user avatar
1556 description: successful operation
1565 $ref: '#/components/schemas/ActorImage'
1567 description: image file too large
1569 X-File-Maximum-Size:
1573 description: Maximum file size for the avatar
1576 multipart/form-data:
1581 description: The file to upload
1586 contentType: image/png, image/jpeg
1590 summary: Delete my avatar
1597 description: successful operation
1601 summary: List video ownership changes
1603 - Video Ownership Change
1608 description: successful operation
1610 '/videos/ownership/{id}/accept':
1612 summary: Accept ownership change request
1614 - Video Ownership Change
1618 - $ref: '#/components/parameters/idOrUUID'
1621 description: successful operation
1623 description: cannot terminate an ownership change of another user
1625 description: video ownership change not found
1627 '/videos/ownership/{id}/refuse':
1629 summary: Refuse ownership change request
1631 - Video Ownership Change
1635 - $ref: '#/components/parameters/idOrUUID'
1638 description: successful operation
1640 description: cannot terminate an ownership change of another user
1642 description: video ownership change not found
1644 '/videos/{id}/give-ownership':
1646 summary: Request ownership change
1648 - Video Ownership Change
1652 - $ref: '#/components/parameters/idOrUUID'
1656 application/x-www-form-urlencoded:
1666 description: successful operation
1668 description: changing video ownership to a remote account is not supported yet
1670 description: video not found
1674 summary: List videos
1675 operationId: getVideos
1679 - $ref: '#/components/parameters/categoryOneOf'
1680 - $ref: '#/components/parameters/isLive'
1681 - $ref: '#/components/parameters/tagsOneOf'
1682 - $ref: '#/components/parameters/tagsAllOf'
1683 - $ref: '#/components/parameters/licenceOneOf'
1684 - $ref: '#/components/parameters/languageOneOf'
1685 - $ref: '#/components/parameters/nsfw'
1686 - $ref: '#/components/parameters/isLocal'
1687 - $ref: '#/components/parameters/include'
1688 - $ref: '#/components/parameters/privacyOneOf'
1689 - $ref: '#/components/parameters/hasHLSFiles'
1690 - $ref: '#/components/parameters/hasWebtorrentFiles'
1691 - $ref: '#/components/parameters/skipCount'
1692 - $ref: '#/components/parameters/start'
1693 - $ref: '#/components/parameters/count'
1694 - $ref: '#/components/parameters/videosSort'
1697 description: successful operation
1701 $ref: '#/components/schemas/VideoListResponse'
1705 summary: List available video categories
1706 operationId: getCategories
1711 description: successful operation
1720 externalValue: https://peertube2.cpy.re/api/v1/videos/categories
1724 summary: List available video licences
1725 operationId: getLicences
1730 description: successful operation
1739 externalValue: https://peertube2.cpy.re/api/v1/videos/licences
1743 summary: List available video languages
1744 operationId: getLanguages
1749 description: successful operation
1758 externalValue: https://peertube2.cpy.re/api/v1/videos/languages
1762 summary: List available video privacy policies
1763 operationId: getPrivacyPolicies
1768 description: successful operation
1777 externalValue: https://peertube2.cpy.re/api/v1/videos/privacies
1781 summary: Update a video
1782 operationId: putVideo
1788 - $ref: '#/components/parameters/idOrUUID'
1791 description: successful operation
1794 multipart/form-data:
1799 description: Video thumbnail file
1803 description: Video preview file
1807 $ref: '#/components/schemas/VideoCategorySet'
1809 $ref: '#/components/schemas/VideoLicenceSet'
1811 $ref: '#/components/schemas/VideoLanguageSet'
1813 $ref: '#/components/schemas/VideoPrivacySet'
1815 description: Video description
1818 description: Whether or not we wait transcoding before publish the video
1821 description: A text tell the audience how to support the video creator
1822 example: Please support our work on https://soutenir.framasoft.org/en/ <3
1825 description: Whether or not this video contains sensitive content
1828 description: Video name
1833 description: Video tags (maximum 5 tags each between 2 and 30 characters)
1842 description: Enable or disable comments for this video
1845 description: Enable or disable downloading for this video
1847 originallyPublishedAt:
1848 description: Date when the content was originally published
1852 $ref: '#/components/schemas/VideoScheduledUpdate'
1855 contentType: image/jpeg
1857 contentType: image/jpeg
1859 summary: Get a video
1860 operationId: getVideo
1864 - $ref: '#/components/parameters/idOrUUID'
1867 description: successful operation
1871 $ref: '#/components/schemas/VideoDetails'
1873 summary: Delete a video
1874 operationId: delVideo
1880 - $ref: '#/components/parameters/idOrUUID'
1883 description: successful operation
1885 '/videos/{id}/description':
1887 summary: Get complete video description
1888 operationId: getVideoDesc
1892 - $ref: '#/components/parameters/idOrUUID'
1895 description: successful operation
1904 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
1906 '/videos/{id}/views':
1908 summary: Notify user is watching a video
1909 description: Call this endpoint regularly (every 5-10 seconds for example) to notify the server the user is watching the video. After a while, PeerTube will increase video's viewers counter. If the user is authenticated, PeerTube will also store the current player time.
1910 operationId: addView
1914 - $ref: '#/components/parameters/idOrUUID'
1919 $ref: '#/components/schemas/UserViewingVideo'
1923 description: successful operation
1925 '/videos/{id}/watching':
1927 summary: Set watching progress of a video
1929 description: This endpoint has been deprecated. Use `/videos/{id}/views` instead
1935 - $ref: '#/components/parameters/idOrUUID'
1940 $ref: '#/components/schemas/UserViewingVideo'
1944 description: successful operation
1946 '/videos/{id}/stats/overall':
1948 summary: Get overall stats of a video
1954 - $ref: '#/components/parameters/idOrUUID'
1957 description: Filter stats by start date
1963 description: Filter stats by end date
1969 description: successful operation
1973 $ref: '#/components/schemas/VideoStatsOverall'
1975 '/videos/{id}/stats/retention':
1977 summary: Get retention stats of a video
1983 - $ref: '#/components/parameters/idOrUUID'
1986 description: successful operation
1990 $ref: '#/components/schemas/VideoStatsRetention'
1992 '/videos/{id}/stats/timeseries/{metric}':
1994 summary: Get timeserie stats of a video
2000 - $ref: '#/components/parameters/idOrUUID'
2005 description: The metric to get
2010 - 'aggregateWatchTime'
2013 description: Filter stats by start date
2019 description: Filter stats by end date
2025 description: successful operation
2029 $ref: '#/components/schemas/VideoStatsTimeserie'
2033 summary: Upload a video
2034 description: Uses a single request to upload a video.
2035 operationId: uploadLegacy
2043 description: successful operation
2047 $ref: '#/components/schemas/VideoUploadResponse'
2049 description: video didn't pass upload filter
2051 description: upload has timed out
2053 x-summary: video file too large, due to quota or max body size limit set by the reverse-proxy
2055 If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type`:
2056 - `quota_reached` for quota limits wether daily or global
2058 X-File-Maximum-Size:
2062 description: Maximum file size for the video
2064 description: video type unsupported
2066 description: video unreadable
2069 multipart/form-data:
2071 $ref: '#/components/schemas/VideoUploadRequestLegacy'
2074 contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
2076 contentType: image/jpeg
2078 contentType: image/jpeg
2083 USERNAME="<your_username>"
2084 PASSWORD="<your_password>"
2085 FILE_PATH="<your_file_path>"
2086 CHANNEL_ID="<your_channel_id>"
2088 API="https://peertube2.cpy.re/api/v1"
2091 client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
2092 client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
2093 token=$(curl -s "$API/users/token" \
2094 --data client_id="$client_id" \
2095 --data client_secret="$client_secret" \
2096 --data grant_type=password \
2097 --data username="$USERNAME" \
2098 --data password="$PASSWORD" \
2099 | jq -r ".access_token")
2102 curl -s "$API/videos/upload" \
2103 -H "Authorization: Bearer $token" \
2105 --form videofile=@"$FILE_PATH" \
2106 --form channelId=$CHANNEL_ID \
2109 /videos/upload-resumable:
2111 summary: Initialize the resumable upload of a video
2112 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video
2113 operationId: uploadResumableInit
2120 - name: X-Upload-Content-Length
2126 description: Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
2127 - name: X-Upload-Content-Type
2134 description: MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
2139 $ref: '#/components/schemas/VideoUploadRequestResumable'
2142 description: file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
2144 description: created
2150 example: /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51
2156 x-summary: video file too large, due to quota, absolute max file size or concurrent partial upload limit
2158 Disambiguate via `type`:
2159 - `max_file_size_reached` for the absolute file size limit
2160 - `quota_reached` for quota limits whether daily or global
2162 description: video type unsupported
2164 summary: Send chunk for the resumable upload of a video
2165 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the upload of a video
2166 operationId: uploadResumable
2177 Created session id to proceed with. If you didn't send chunks in the last hour, it is
2178 not valid anymore and you need to initialize a new upload.
2181 - name: Content-Range
2185 example: bytes 0-262143/2469036
2188 Specifies the bytes in the file that the request is uploading.
2190 For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first
2191 262144 bytes (256 x 1024) in a 2,469,036 byte file.
2192 - name: Content-Length
2199 Size of the chunk that the request is sending.
2201 Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
2202 1048576 bytes (~1MB) and increases or reduces size depending on connection health.
2205 application/octet-stream:
2211 description: last chunk received
2219 $ref: '#/components/schemas/VideoUploadResponse'
2221 description: resume incomplete
2226 example: bytes=0-262143
2232 description: video didn't pass upload filter
2234 description: upload not found
2236 description: chunk doesn't match range
2238 description: video unreadable
2240 description: too many concurrent requests
2242 description: upload is already being processed
2249 summary: Cancel the resumable upload of a video, deleting any data uploaded so far
2250 description: Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
2251 operationId: uploadResumableCancel
2262 Created session id to proceed with. If you didn't send chunks in the last 12 hours, it is
2263 not valid anymore and the upload session has already been deleted with its data ;-)
2266 - name: Content-Length
2274 description: upload cancelled
2281 description: upload not found
2285 summary: Import a video
2286 description: Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
2287 operationId: importVideo
2295 multipart/form-data:
2297 $ref: '#/components/schemas/VideoCreateImport'
2300 contentType: application/x-bittorrent
2302 contentType: image/jpeg
2304 contentType: image/jpeg
2307 description: successful operation
2311 $ref: '#/components/schemas/VideoUploadResponse'
2313 description: '`magnetUri` or `targetUrl` or a torrent file missing'
2315 description: video didn't pass pre-import filter
2317 description: HTTP or Torrent/magnetURI import not enabled
2319 /videos/imports/{id}/cancel:
2321 summary: Cancel video import
2322 description: Cancel a pending video import
2328 - $ref: '#/components/parameters/id'
2331 description: successful operation
2333 /videos/imports/{id}:
2335 summary: Delete video import
2336 description: Delete ended video import
2342 - $ref: '#/components/parameters/id'
2345 description: successful operation
2349 summary: Create a live
2350 operationId: addLive
2358 description: successful operation
2362 $ref: '#/components/schemas/VideoUploadResponse'
2364 x-summary: validation error, or conflicting `saveReplay` and `permanentLive` parameter set
2366 Disambiguate via `type`:
2367 - default type for a validation error
2368 - `live_conflicting_permanent_and_save_replay` for conflicting parameters set
2370 x-summary: live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
2372 Disambiguate via `type`:
2373 - `live_not_enabled` for a disabled live feature
2374 - `live_not_allowing_replay` for a disabled replay feature
2375 - `max_instance_lives_limit_reached` for the absolute concurrent live limit
2376 - `max_user_lives_limit_reached` for the user concurrent live limit
2379 multipart/form-data:
2384 description: Channel id that will contain this live video
2389 description: User can stream multiple times in a permanent live
2392 description: User can select live latency mode if enabled by the instance
2393 $ref: '#/components/schemas/LiveVideoLatencyMode'
2395 description: Live video/replay thumbnail file
2399 description: Live video/replay preview file
2403 $ref: '#/components/schemas/VideoPrivacySet'
2405 $ref: '#/components/schemas/VideoCategorySet'
2407 $ref: '#/components/schemas/VideoLicenceSet'
2409 $ref: '#/components/schemas/VideoLanguageSet'
2411 description: Live video/replay description
2414 description: A text tell the audience how to support the creator
2415 example: Please support our work on https://soutenir.framasoft.org/en/ <3
2418 description: Whether or not this live video/replay contains sensitive content
2421 description: Live video/replay name
2426 description: Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
2435 description: Enable or disable comments for this live video/replay
2438 description: Enable or disable downloading for the replay of this live video
2445 contentType: image/jpeg
2447 contentType: image/jpeg
2451 summary: Get information about a live
2452 operationId: getLiveId
2459 - $ref: '#/components/parameters/idOrUUID'
2462 description: successful operation
2466 $ref: '#/components/schemas/LiveVideoResponse'
2468 summary: Update information about a live
2469 operationId: updateLiveId
2476 - $ref: '#/components/parameters/idOrUUID'
2481 $ref: '#/components/schemas/LiveVideoUpdate'
2484 description: successful operation
2486 description: bad parameters or trying to update a live that has already started
2488 description: trying to save replay of the live but saving replay is not enabled on the instance
2489 /videos/live/{id}/sessions:
2491 summary: List live sessions
2492 description: List all sessions created in a particular live
2498 - $ref: '#/components/parameters/idOrUUID'
2501 description: successful operation
2513 $ref: '#/components/schemas/LiveVideoSessionResponse'
2514 /videos/{id}/live-session:
2516 summary: Get live session of a replay
2517 description: If the video is a replay of a live, you can find the associated live session using this endpoint
2523 - $ref: '#/components/parameters/idOrUUID'
2526 description: successful operation
2530 $ref: '#/components/schemas/LiveVideoSessionResponse'
2534 summary: List my abuses
2535 operationId: getMyAbuses
2544 description: only list the report with this id
2550 $ref: '#/components/schemas/AbuseStateSet'
2551 - $ref: '#/components/parameters/abusesSort'
2552 - $ref: '#/components/parameters/start'
2553 - $ref: '#/components/parameters/count'
2556 description: successful operation
2568 $ref: '#/components/schemas/Abuse'
2572 summary: List abuses
2573 operationId: getAbuses
2583 description: only list the report with this id
2586 - name: predefinedReason
2588 description: predefined reason the listed reports should contain
2590 $ref: '#/components/schemas/PredefinedAbuseReasons'
2593 description: plain search that will match with video titles, reporter names and more
2599 $ref: '#/components/schemas/AbuseStateSet'
2600 - name: searchReporter
2602 description: only list reports of a specific reporter
2605 - name: searchReportee
2606 description: only list reports of a specific reportee
2612 description: only list reports of a specific video
2615 - name: searchVideoChannel
2617 description: only list reports of a specific video channel
2622 description: only list deleted or blocklisted videos
2630 description: only list account, comment or video reports
2637 - $ref: '#/components/parameters/start'
2638 - $ref: '#/components/parameters/count'
2639 - $ref: '#/components/parameters/abusesSort'
2642 description: successful operation
2654 $ref: '#/components/schemas/Abuse'
2656 summary: Report an abuse
2669 description: Reason why the user reports this video
2674 $ref: '#/components/schemas/PredefinedAbuseReasons'
2679 description: Video id to report
2681 - $ref: '#/components/schemas/Video/properties/id'
2685 description: Timestamp in the video that marks the beginning of the report
2690 description: Timestamp in the video that marks the ending of the report
2696 description: Comment id to report
2698 - $ref: '#/components/schemas/VideoComment/properties/id'
2703 description: Account id to report
2709 description: successful operation
2719 $ref: '#/components/schemas/id'
2721 description: incorrect request parameters
2723 '/abuses/{abuseId}':
2725 summary: Update an abuse
2733 - $ref: '#/components/parameters/abuseId'
2741 $ref: '#/components/schemas/AbuseStateSet'
2744 description: Update the report comment visible only to the moderation team
2749 description: successful operation
2751 description: abuse not found
2755 summary: Delete an abuse
2761 - $ref: '#/components/parameters/abuseId'
2764 description: successful operation
2766 description: block not found
2768 '/abuses/{abuseId}/messages':
2770 summary: List messages of an abuse
2776 - $ref: '#/components/parameters/abuseId'
2779 description: successful operation
2791 $ref: '#/components/schemas/AbuseMessage'
2793 summary: Add message to an abuse
2799 - $ref: '#/components/parameters/abuseId'
2808 description: Message to send
2816 description: successful operation
2818 description: incorrect request parameters
2820 '/abuses/{abuseId}/messages/{abuseMessageId}':
2822 summary: Delete an abuse message
2828 - $ref: '#/components/parameters/abuseId'
2829 - $ref: '#/components/parameters/abuseMessageId'
2832 description: successful operation
2834 '/videos/{id}/blacklist':
2836 summary: Block a video
2837 operationId: addVideoBlock
2845 - $ref: '#/components/parameters/idOrUUID'
2848 description: successful operation
2850 summary: Unblock a video by its id
2851 operationId: delVideoBlock
2859 - $ref: '#/components/parameters/idOrUUID'
2862 description: successful operation
2864 description: block not found
2870 summary: List video blocks
2871 operationId: getVideoBlocks
2880 list only blocks that match this type:
2884 - `2`: automatic block that needs review
2892 description: plain search that will match with video titles, and more
2895 - $ref: '#/components/parameters/start'
2896 - $ref: '#/components/parameters/count'
2897 - $ref: '#/components/parameters/blacklistsSort'
2900 description: successful operation
2912 $ref: '#/components/schemas/VideoBlacklist'
2914 /videos/{id}/captions:
2916 summary: List captions of a video
2917 operationId: getVideoCaptions
2921 - $ref: '#/components/parameters/idOrUUID'
2924 description: successful operation
2936 $ref: '#/components/schemas/VideoCaption'
2938 /videos/{id}/captions/{captionLanguage}:
2940 summary: Add or replace a video caption
2941 operationId: addVideoCaption
2948 - $ref: '#/components/parameters/idOrUUID'
2949 - $ref: '#/components/parameters/captionLanguage'
2952 multipart/form-data:
2957 description: The file to upload.
2962 contentType: text/vtt, application/x-subrip, text/plain
2965 description: successful operation
2967 description: video or language not found
2969 summary: Delete a video caption
2970 operationId: delVideoCaption
2977 - $ref: '#/components/parameters/idOrUUID'
2978 - $ref: '#/components/parameters/captionLanguage'
2981 description: successful operation
2983 description: video or language or caption for that language not found
2987 summary: List video channels
2988 operationId: getVideoChannels
2992 - $ref: '#/components/parameters/start'
2993 - $ref: '#/components/parameters/count'
2994 - $ref: '#/components/parameters/sort'
2997 description: successful operation
3001 $ref: '#/components/schemas/VideoChannelList'
3003 summary: Create a video channel
3004 operationId: addVideoChannel
3011 description: successful operation
3021 $ref: '#/components/schemas/id'
3026 $ref: '#/components/schemas/VideoChannelCreate'
3028 '/video-channels/{channelHandle}':
3030 summary: Get a video channel
3031 operationId: getVideoChannel
3035 - $ref: '#/components/parameters/channelHandle'
3038 description: successful operation
3042 $ref: '#/components/schemas/VideoChannel'
3044 summary: Update a video channel
3045 operationId: putVideoChannel
3051 - $ref: '#/components/parameters/channelHandle'
3054 description: successful operation
3059 $ref: '#/components/schemas/VideoChannelUpdate'
3061 summary: Delete a video channel
3062 operationId: delVideoChannel
3068 - $ref: '#/components/parameters/channelHandle'
3071 description: successful operation
3073 '/video-channels/{channelHandle}/videos':
3075 summary: List videos of a video channel
3076 operationId: getVideoChannelVideos
3081 - $ref: '#/components/parameters/channelHandle'
3082 - $ref: '#/components/parameters/categoryOneOf'
3083 - $ref: '#/components/parameters/isLive'
3084 - $ref: '#/components/parameters/tagsOneOf'
3085 - $ref: '#/components/parameters/tagsAllOf'
3086 - $ref: '#/components/parameters/licenceOneOf'
3087 - $ref: '#/components/parameters/languageOneOf'
3088 - $ref: '#/components/parameters/nsfw'
3089 - $ref: '#/components/parameters/isLocal'
3090 - $ref: '#/components/parameters/include'
3091 - $ref: '#/components/parameters/privacyOneOf'
3092 - $ref: '#/components/parameters/hasHLSFiles'
3093 - $ref: '#/components/parameters/hasWebtorrentFiles'
3094 - $ref: '#/components/parameters/skipCount'
3095 - $ref: '#/components/parameters/start'
3096 - $ref: '#/components/parameters/count'
3097 - $ref: '#/components/parameters/videosSort'
3100 description: successful operation
3104 $ref: '#/components/schemas/VideoListResponse'
3106 '/video-channels/{channelHandle}/followers':
3110 summary: 'List followers of a video channel'
3113 operationId: getVideoChannelFollowers
3115 - $ref: '#/components/parameters/channelHandle'
3116 - $ref: '#/components/parameters/start'
3117 - $ref: '#/components/parameters/count'
3118 - $ref: '#/components/parameters/followersSort'
3119 - $ref: '#/components/parameters/search'
3122 description: successful operation
3134 $ref: '#/components/schemas/Follow'
3136 '/video-channels/{channelHandle}/avatar/pick':
3138 summary: Update channel avatar
3144 - $ref: '#/components/parameters/channelHandle'
3147 description: successful operation
3156 $ref: '#/components/schemas/ActorImage'
3158 description: image file too large
3160 X-File-Maximum-Size:
3164 description: Maximum file size for the avatar
3167 multipart/form-data:
3172 description: The file to upload.
3177 contentType: image/png, image/jpeg
3179 '/video-channels/{channelHandle}/avatar':
3181 summary: Delete channel avatar
3187 - $ref: '#/components/parameters/channelHandle'
3190 description: successful operation
3192 '/video-channels/{channelHandle}/banner/pick':
3194 summary: Update channel banner
3200 - $ref: '#/components/parameters/channelHandle'
3203 description: successful operation
3212 $ref: '#/components/schemas/ActorImage'
3214 description: image file too large
3216 X-File-Maximum-Size:
3220 description: Maximum file size for the banner
3223 multipart/form-data:
3228 description: The file to upload.
3233 contentType: image/png, image/jpeg
3235 '/video-channels/{channelHandle}/banner':
3237 summary: Delete channel banner
3243 - $ref: '#/components/parameters/channelHandle'
3246 description: successful operation
3248 /video-playlists/privacies:
3250 summary: List available playlist privacy policies
3251 operationId: getPlaylistPrivacyPolicies
3256 description: successful operation
3265 externalValue: https://peertube2.cpy.re/api/v1/video-playlists/privacies
3269 summary: List video playlists
3270 operationId: getPlaylists
3274 - $ref: '#/components/parameters/start'
3275 - $ref: '#/components/parameters/count'
3276 - $ref: '#/components/parameters/sort'
3279 description: successful operation
3291 $ref: '#/components/schemas/VideoPlaylist'
3293 summary: Create a video playlist
3294 description: If the video playlist is set as public, `videoChannelId` is mandatory.
3295 operationId: addPlaylist
3302 description: successful operation
3312 $ref: '#/components/schemas/VideoPlaylist/properties/id'
3314 $ref: '#/components/schemas/VideoPlaylist/properties/uuid'
3316 $ref: '#/components/schemas/VideoPlaylist/properties/shortUUID'
3319 multipart/form-data:
3324 description: Video playlist display name
3329 description: Video playlist thumbnail file
3333 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
3335 description: Video playlist description
3341 - $ref: '#/components/schemas/id'
3342 description: Video channel in which the playlist will be published
3347 contentType: image/jpeg
3349 /video-playlists/{playlistId}:
3351 summary: Get a video playlist
3355 - $ref: '#/components/parameters/playlistId'
3358 description: successful operation
3362 $ref: '#/components/schemas/VideoPlaylist'
3364 summary: Update a video playlist
3365 description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
3372 description: successful operation
3374 - $ref: '#/components/parameters/playlistId'
3377 multipart/form-data:
3382 description: Video playlist display name
3387 description: Video playlist thumbnail file
3391 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
3393 description: Video playlist description
3397 - $ref: '#/components/schemas/id'
3398 description: Video channel in which the playlist will be published
3401 contentType: image/jpeg
3403 summary: Delete a video playlist
3409 - $ref: '#/components/parameters/playlistId'
3412 description: successful operation
3414 /video-playlists/{playlistId}/videos:
3416 summary: 'List videos of a playlist'
3417 operationId: getVideoPlaylistVideos
3422 - $ref: '#/components/parameters/playlistId'
3423 - $ref: '#/components/parameters/start'
3424 - $ref: '#/components/parameters/count'
3427 description: successful operation
3431 $ref: '#/components/schemas/VideoListResponse'
3433 summary: Add a video in a playlist
3434 operationId: addVideoPlaylistVideo
3441 - $ref: '#/components/parameters/playlistId'
3444 description: successful operation
3450 videoPlaylistElement:
3464 - $ref: '#/components/schemas/Video/properties/uuid'
3465 - $ref: '#/components/schemas/Video/properties/id'
3466 description: Video to add in the playlist
3470 description: Start the video at this specific timestamp
3474 description: Stop the video at this specific timestamp
3478 /video-playlists/{playlistId}/videos/reorder:
3480 summary: 'Reorder a playlist'
3481 operationId: reorderVideoPlaylist
3487 - $ref: '#/components/parameters/playlistId'
3490 description: successful operation
3499 description: 'Start position of the element to reorder'
3501 insertAfterPosition:
3503 description: 'New position for the block to reorder, to add the block before the first element'
3507 description: 'How many element from `startPosition` to reorder'
3511 - insertAfterPosition
3513 /video-playlists/{playlistId}/videos/{playlistElementId}:
3515 summary: Update a playlist element
3516 operationId: putVideoPlaylistVideo
3522 - $ref: '#/components/parameters/playlistId'
3523 - $ref: '#/components/parameters/playlistElementId'
3526 description: successful operation
3536 description: Start the video at this specific timestamp
3540 description: Stop the video at this specific timestamp
3542 summary: Delete an element from a playlist
3543 operationId: delVideoPlaylistVideo
3549 - $ref: '#/components/parameters/playlistId'
3550 - $ref: '#/components/parameters/playlistElementId'
3553 description: successful operation
3555 '/users/me/video-playlists/videos-exist':
3557 summary: Check video exists in my playlists
3566 description: The video ids to check
3570 $ref: '#/components/schemas/Video/properties/id'
3573 description: successful operation
3595 '/accounts/{name}/video-channels':
3597 summary: List video channels of an account
3602 - $ref: '#/components/parameters/name'
3605 description: include daily view statistics for the last 30 days and total views (only if authentified as the account user)
3608 - $ref: '#/components/parameters/start'
3609 - $ref: '#/components/parameters/count'
3610 - $ref: '#/components/parameters/sort'
3613 description: successful operation
3617 $ref: '#/components/schemas/VideoChannelList'
3619 '/accounts/{name}/ratings':
3621 summary: List ratings of an account
3627 - $ref: '#/components/parameters/name'
3628 - $ref: '#/components/parameters/start'
3629 - $ref: '#/components/parameters/count'
3630 - $ref: '#/components/parameters/sort'
3634 description: Optionally filter which ratings to retrieve
3642 description: successful operation
3648 $ref: '#/components/schemas/VideoRating'
3650 '/videos/{id}/comment-threads':
3652 summary: List threads of a video
3656 - $ref: '#/components/parameters/idOrUUID'
3657 - $ref: '#/components/parameters/start'
3658 - $ref: '#/components/parameters/count'
3659 - $ref: '#/components/parameters/commentsSort'
3662 description: successful operation
3666 $ref: '#/components/schemas/CommentThreadResponse'
3668 summary: Create a thread
3674 - $ref: '#/components/parameters/idOrUUID'
3677 description: successful operation
3681 $ref: '#/components/schemas/CommentThreadPostResponse'
3683 description: video does not exist
3692 - $ref: '#/components/schemas/VideoComment/properties/text'
3698 '/videos/{id}/comment-threads/{threadId}':
3700 summary: Get a thread
3704 - $ref: '#/components/parameters/idOrUUID'
3705 - $ref: '#/components/parameters/threadId'
3708 description: successful operation
3712 $ref: '#/components/schemas/VideoCommentThreadTree'
3714 '/videos/{id}/comments/{commentId}':
3716 summary: Reply to a thread of a video
3722 - $ref: '#/components/parameters/idOrUUID'
3723 - $ref: '#/components/parameters/commentId'
3726 description: successful operation
3730 $ref: '#/components/schemas/CommentThreadPostResponse'
3732 description: thread or video does not exist
3741 - $ref: '#/components/schemas/VideoComment/properties/text'
3747 summary: Delete a comment or a reply
3753 - $ref: '#/components/parameters/idOrUUID'
3754 - $ref: '#/components/parameters/commentId'
3757 description: successful operation
3759 description: cannot remove comment of another user
3761 description: comment or video does not exist
3763 description: comment is already deleted
3765 '/videos/{id}/rate':
3767 summary: Like/dislike a video
3773 - $ref: '#/components/parameters/idOrUUID'
3789 description: successful operation
3791 description: video does not exist
3795 summary: Delete video HLS files
3801 operationId: delVideoHLS
3803 - $ref: '#/components/parameters/idOrUUID'
3806 description: successful operation
3808 description: video does not exist
3809 '/videos/{id}/webtorrent':
3811 summary: Delete video WebTorrent files
3817 operationId: delVideoWebTorrent
3819 - $ref: '#/components/parameters/idOrUUID'
3822 description: successful operation
3824 description: video does not exist
3826 '/videos/{id}/transcoding':
3828 summary: Create a transcoding job
3834 operationId: createVideoTranscoding
3836 - $ref: '#/components/parameters/idOrUUID'
3852 description: successful operation
3854 description: video does not exist
3860 summary: Search videos
3861 operationId: searchVideos
3866 allowEmptyValue: false
3868 String to search. If the user can make a remote URI search, and the string is an URI then the
3869 PeerTube instance will fetch the remote object and add it to its database. Then,
3870 you can use the REST API to fetch the complete video information and interact with it.
3873 - $ref: '#/components/parameters/categoryOneOf'
3874 - $ref: '#/components/parameters/isLive'
3875 - $ref: '#/components/parameters/tagsOneOf'
3876 - $ref: '#/components/parameters/tagsAllOf'
3877 - $ref: '#/components/parameters/licenceOneOf'
3878 - $ref: '#/components/parameters/languageOneOf'
3879 - $ref: '#/components/parameters/nsfw'
3880 - $ref: '#/components/parameters/isLocal'
3881 - $ref: '#/components/parameters/include'
3882 - $ref: '#/components/parameters/privacyOneOf'
3883 - $ref: '#/components/parameters/hasHLSFiles'
3884 - $ref: '#/components/parameters/hasWebtorrentFiles'
3885 - $ref: '#/components/parameters/skipCount'
3886 - $ref: '#/components/parameters/start'
3887 - $ref: '#/components/parameters/count'
3888 - $ref: '#/components/parameters/searchTarget'
3889 - $ref: '#/components/parameters/videosSearchSort'
3892 description: Get videos that are published after this date
3898 description: Get videos that are published before this date
3902 - name: originallyPublishedStartDate
3904 description: Get videos that are originally published after this date
3908 - name: originallyPublishedEndDate
3910 description: Get videos that are originally published before this date
3916 description: Get videos that have this minimum duration
3921 description: Get videos that have this maximum duration
3925 'searchTarget === search-index':
3926 $ref: '#/components/callbacks/searchIndex'
3929 description: successful operation
3933 $ref: '#/components/schemas/VideoListResponse'
3935 description: search index unavailable
3937 /search/video-channels:
3941 summary: Search channels
3942 operationId: searchChannels
3948 String to search. If the user can make a remote URI search, and the string is an URI then the
3949 PeerTube instance will fetch the remote object and add it to its database. Then,
3950 you can use the REST API to fetch the complete channel information and interact with it.
3953 - $ref: '#/components/parameters/start'
3954 - $ref: '#/components/parameters/count'
3955 - $ref: '#/components/parameters/searchTarget'
3956 - $ref: '#/components/parameters/sort'
3958 'searchTarget === search-index':
3959 $ref: '#/components/callbacks/searchIndex'
3962 description: successful operation
3966 $ref: '#/components/schemas/VideoChannelList'
3968 description: search index unavailable
3970 /search/video-playlists:
3974 summary: Search playlists
3975 operationId: searchPlaylists
3981 String to search. If the user can make a remote URI search, and the string is an URI then the
3982 PeerTube instance will fetch the remote object and add it to its database. Then,
3983 you can use the REST API to fetch the complete playlist information and interact with it.
3986 - $ref: '#/components/parameters/start'
3987 - $ref: '#/components/parameters/count'
3988 - $ref: '#/components/parameters/searchTarget'
3989 - $ref: '#/components/parameters/sort'
3991 'searchTarget === search-index':
3992 $ref: '#/components/callbacks/searchIndex'
3995 description: successful operation
4007 $ref: '#/components/schemas/VideoPlaylist'
4009 description: search index unavailable
4016 summary: Get block status of accounts/hosts
4021 description: 'Check if these accounts are blocked'
4022 example: [ 'goofy@example.com', 'donald@example.com' ]
4030 description: 'Check if these hosts are blocked'
4031 example: [ 'example.com' ]
4038 description: successful operation
4042 $ref: '#/components/schemas/BlockStatus'
4044 /server/blocklist/accounts:
4048 summary: List account blocks
4053 - $ref: '#/components/parameters/start'
4054 - $ref: '#/components/parameters/count'
4055 - $ref: '#/components/parameters/sort'
4058 description: successful operation
4062 summary: Block an account
4074 example: chocobozzz@example.org
4075 description: account to block, in the form `username@domain`
4080 description: successful operation
4082 description: self-blocking forbidden
4084 '/server/blocklist/accounts/{accountName}':
4088 summary: Unblock an account by its handle
4096 description: account to unblock, in the form `username@domain`
4101 description: successful operation
4103 description: account or account block does not exist
4105 /server/blocklist/servers:
4109 summary: List server blocks
4114 - $ref: '#/components/parameters/start'
4115 - $ref: '#/components/parameters/count'
4116 - $ref: '#/components/parameters/sort'
4119 description: successful operation
4123 summary: Block a server
4136 description: server domain to block
4141 description: successful operation
4143 description: self-blocking forbidden
4145 '/server/blocklist/servers/{host}':
4149 summary: Unblock a server by its domain
4157 description: server domain to unblock
4163 description: successful operation
4165 description: account block does not exist
4167 /server/redundancy/{host}:
4170 - Instance Redundancy
4171 summary: Update a server redundancy policy
4179 description: server domain to mirror
4191 description: allow mirroring of the host's local videos
4196 description: successful operation
4198 description: server is not already known
4200 /server/redundancy/videos:
4204 summary: List videos being mirrored
4205 operationId: getMirroredVideos
4213 description: direction of the mirror
4219 - $ref: '#/components/parameters/start'
4220 - $ref: '#/components/parameters/count'
4221 - $ref: '#/components/parameters/videoRedundanciesSort'
4224 description: successful operation
4230 $ref: '#/components/schemas/VideoRedundancy'
4234 summary: Mirror a video
4235 operationId: putMirroredVideo
4246 $ref: '#/components/schemas/Video/properties/id'
4251 description: successful operation
4253 description: cannot mirror a local video
4255 description: video does not exist
4257 description: video is already mirrored
4259 /server/redundancy/videos/{redundancyId}:
4263 summary: Delete a mirror done on a video
4264 operationId: delMirroredVideo
4269 - name: redundancyId
4272 description: id of an existing redundancy on a video
4277 description: successful operation
4279 description: video redundancy not found
4281 '/feeds/video-comments.{format}':
4285 summary: List comments on videos
4286 operationId: getSyndicatedComments
4291 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
4304 description: 'limit listing to a specific video'
4309 description: 'limit listing to a specific account'
4314 description: 'limit listing to a specific account'
4317 - name: videoChannelId
4319 description: 'limit listing to a specific video channel'
4322 - name: videoChannelName
4324 description: 'limit listing to a specific video channel'
4329 description: successful operation
4334 default: 'max-age=900' # 15 min cache
4338 $ref: '#/components/schemas/VideoCommentsForXML'
4341 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
4342 application/rss+xml:
4344 $ref: '#/components/schemas/VideoCommentsForXML'
4347 externalValue: https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
4350 $ref: '#/components/schemas/VideoCommentsForXML'
4353 externalValue: https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
4354 application/atom+xml:
4356 $ref: '#/components/schemas/VideoCommentsForXML'
4359 externalValue: https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
4365 externalValue: https://peertube2.cpy.re/feeds/video-comments.json?filter=local
4367 x-summary: field inconsistencies
4370 - videoId filter is mixed with a channel filter
4372 description: video, video channel or account not found
4374 description: accept header unsupported
4376 '/feeds/videos.{format}':
4380 summary: List videos
4381 operationId: getSyndicatedVideos
4386 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
4399 description: 'limit listing to a specific account'
4404 description: 'limit listing to a specific account'
4407 - name: videoChannelId
4409 description: 'limit listing to a specific video channel'
4412 - name: videoChannelName
4414 description: 'limit listing to a specific video channel'
4417 - $ref: '#/components/parameters/sort'
4418 - $ref: '#/components/parameters/nsfw'
4419 - $ref: '#/components/parameters/isLocal'
4420 - $ref: '#/components/parameters/include'
4421 - $ref: '#/components/parameters/privacyOneOf'
4422 - $ref: '#/components/parameters/hasHLSFiles'
4423 - $ref: '#/components/parameters/hasWebtorrentFiles'
4426 description: successful operation
4431 default: 'max-age=900' # 15 min cache
4435 $ref: '#/components/schemas/VideosForXML'
4438 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
4439 application/rss+xml:
4441 $ref: '#/components/schemas/VideosForXML'
4444 externalValue: https://peertube2.cpy.re/feeds/videos.rss?filter=local
4447 $ref: '#/components/schemas/VideosForXML'
4450 externalValue: https://peertube2.cpy.re/feeds/videos.xml?filter=local
4451 application/atom+xml:
4453 $ref: '#/components/schemas/VideosForXML'
4456 externalValue: https://peertube2.cpy.re/feeds/videos.atom?filter=local
4462 externalValue: https://peertube2.cpy.re/feeds/videos.json?filter=local
4464 description: video channel or account not found
4466 description: accept header unsupported
4468 '/feeds/subscriptions.{format}':
4473 summary: List videos of subscriptions tied to a token
4474 operationId: getSyndicatedSubscriptionVideos
4479 description: 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
4492 description: limit listing to a specific account
4498 description: private token allowing access
4502 - $ref: '#/components/parameters/sort'
4503 - $ref: '#/components/parameters/nsfw'
4504 - $ref: '#/components/parameters/isLocal'
4505 - $ref: '#/components/parameters/include'
4506 - $ref: '#/components/parameters/privacyOneOf'
4507 - $ref: '#/components/parameters/hasHLSFiles'
4508 - $ref: '#/components/parameters/hasWebtorrentFiles'
4511 description: successful operation
4516 default: 'max-age=900' # 15 min cache
4520 $ref: '#/components/schemas/VideosForXML'
4521 application/rss+xml:
4523 $ref: '#/components/schemas/VideosForXML'
4526 $ref: '#/components/schemas/VideosForXML'
4527 application/atom+xml:
4529 $ref: '#/components/schemas/VideosForXML'
4534 description: accept header unsupported
4540 summary: List plugins
4541 operationId: getPlugins
4554 - $ref: '#/components/parameters/start'
4555 - $ref: '#/components/parameters/count'
4556 - $ref: '#/components/parameters/sort'
4559 description: successful operation
4563 $ref: '#/components/schemas/PluginResponse'
4569 summary: List available plugins
4570 operationId: getAvailablePlugins
4583 - name: currentPeerTubeEngine
4587 - $ref: '#/components/parameters/start'
4588 - $ref: '#/components/parameters/count'
4589 - $ref: '#/components/parameters/sort'
4592 description: successful operation
4596 $ref: '#/components/schemas/PluginResponse'
4598 description: plugin index unavailable
4604 summary: Install a plugin
4605 operationId: addPlugin
4618 example: peertube-plugin-auth-ldap
4621 additionalProperties: false
4628 additionalProperties: false
4631 description: successful operation
4633 description: should have either `npmName` or `path` set
4639 summary: Update a plugin
4640 operationId: updatePlugin
4653 example: peertube-plugin-auth-ldap
4656 additionalProperties: false
4663 additionalProperties: false
4666 description: successful operation
4668 description: should have either `npmName` or `path` set
4670 description: existing plugin not found
4676 summary: Uninstall a plugin
4677 operationId: uninstallPlugin
4689 description: name of the plugin/theme in its package.json
4690 example: peertube-plugin-auth-ldap
4695 description: successful operation
4697 description: existing plugin not found
4703 summary: Get a plugin
4704 operationId: getPlugin
4709 - $ref: '#/components/parameters/npmName'
4712 description: successful operation
4716 $ref: '#/components/schemas/Plugin'
4718 description: plugin not found
4720 /plugins/{npmName}/settings:
4724 summary: Set a plugin's settings
4729 - $ref: '#/components/parameters/npmName'
4738 additionalProperties: true
4741 description: successful operation
4743 description: plugin not found
4745 /plugins/{npmName}/public-settings:
4749 summary: Get a plugin's public settings
4751 - $ref: '#/components/parameters/npmName'
4754 description: successful operation
4759 additionalProperties: true
4761 description: plugin not found
4763 /plugins/{npmName}/registered-settings:
4767 summary: Get a plugin's registered settings
4772 - $ref: '#/components/parameters/npmName'
4775 description: successful operation
4780 additionalProperties: true
4782 description: plugin not found
4785 - url: 'https://peertube2.cpy.re/api/v1'
4786 description: Live Test Server (live data - latest nightly version)
4787 - url: 'https://peertube3.cpy.re/api/v1'
4788 description: Live Test Server (live data - latest RC version)
4789 - url: 'https://peertube.cpy.re/api/v1'
4790 description: Live Test Server (live data - stable version)
4797 description: Offset used to paginate results
4805 description: "Number of items to return"
4815 description: Sort column
4823 description: Plain text search, applied to various parts of the model depending on endpoint
4831 If the administrator enabled search index support, you can override the default search target.
4834 **Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
4835 It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
4836 * If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
4837 then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
4838 After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
4839 * If the current user doesn't have the ability to make a remote URI search, then redirect the user on the origin instance or fetch
4840 the data from the origin instance API
4863 Sort videos by criteria (prefixing with `-` means `DESC` order):
4864 * `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
4865 * `best` - Same than `hot`, but also takes into account user video history
4866 * `trending` - Sort videos by recent views ("recent" is defined by the admin)
4867 * `views` - Sort videos using their `views` counter
4868 * `publishedAt` - Sort by video publication date (when it became publicly available)
4874 Sort videos by criteria (prefixing with `-` means `DESC` order):
4889 description: Sort comments by criteria
4899 description: Sort blocklists by criteria
4915 description: Plain text search that will match with user usernames or emails
4922 description: Filter results down to (un)banned users
4929 description: Sort users by criteria
4940 description: Sort abuses by criteria
4947 videoRedundanciesSort:
4951 description: Sort abuses by criteria
4960 description: Sort followers by criteria
4969 description: The username or handle of the account
4972 example: chocobozzz | chocobozzz@example.org
4977 description: Entity id
4979 $ref: '#/components/schemas/id'
4984 description: The object id, uuid or short uuid
4987 - $ref: '#/components/schemas/id'
4988 - $ref: '#/components/schemas/UUIDv4'
4989 - $ref: '#/components/schemas/shortUUID'
4994 description: Playlist id
4996 $ref: '#/components/schemas/VideoPlaylist/properties/id'
4998 name: playlistElementId
5001 description: Playlist element id
5003 $ref: '#/components/schemas/id'
5008 description: Abuse id
5010 $ref: '#/components/schemas/Abuse/properties/id'
5012 name: abuseMessageId
5015 description: Abuse message id
5017 $ref: '#/components/schemas/AbuseMessage/properties/id'
5019 name: captionLanguage
5022 description: The caption language
5024 $ref: '#/components/schemas/VideoLanguageSet'
5029 description: The video channel handle
5032 example: my_username | my_username@example.com
5034 name: subscriptionHandle
5037 description: The subscription handle
5040 example: my_username | my_username@example.com
5045 description: The thread id (root comment id)
5052 description: The comment id
5054 $ref: '#/components/schemas/VideoComment/properties/id'
5059 description: whether or not the video is a live
5066 description: category id of the video (see [/videos/categories](#operation/getCategories))
5069 - $ref: '#/components/schemas/VideoCategorySet'
5072 $ref: '#/components/schemas/VideoCategorySet'
5079 description: tag(s) of the video
5093 description: tag(s) of the video, where all should be present in the video
5106 description: language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
5109 - $ref: '#/components/schemas/VideoLanguageSet'
5112 $ref: '#/components/schemas/VideoLanguageSet'
5119 description: licence id of the video (see [/videos/licences](#operation/getLicences))
5122 - $ref: '#/components/schemas/VideoLicenceSet'
5125 $ref: '#/components/schemas/VideoLicenceSet'
5132 description: if you don't need the `total` in the response
5143 description: whether to include nsfw videos, if any
5155 description: '**PeerTube >= 4.0** Display only local or remote videos'
5162 description: '**PeerTube >= 4.0** Display only videos that have HLS files'
5164 name: hasWebtorrentFiles
5169 description: '**PeerTube >= 4.0** Display only videos that have WebTorrent files'
5175 $ref: '#/components/schemas/VideoPrivacySet'
5176 description: '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'
5190 **PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator)
5194 - `1` NOT_PUBLISHED_STATE
5205 description: list of uris to check if each is part of the user subscriptions
5215 description: name of the plugin/theme on npmjs.com or in its package.json
5218 example: peertube-plugin-auth-ldap
5223 description: job type
5227 - activitypub-follow
5228 - activitypub-http-broadcast
5229 - activitypub-http-fetcher
5230 - activitypub-http-unicast
5235 - videos-views-stats
5236 - activitypub-refresher
5261 Authenticating via OAuth requires the following steps:
5262 - Have an activated account
5263 - [Generate] an access token for that account at `/api/v1/users/token`.
5264 - Make requests with the *Authorization: Bearer <token\>* header
5265 - Profit, depending on the role assigned to the account
5267 Note that the __access token is valid for 1 day__ and is given
5268 along with a __refresh token valid for 2 weeks__.
5270 [Generate]: https://docs.joinpeertube.org/api-rest-getting-started
5274 tokenUrl: /api/v1/users/token
5277 moderator: Moderator scope
5280 # Resuable core properties
5288 example: 9c9de5e8-0a1e-484a-b099-e80766180a6d
5289 pattern: '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
5294 description: translation of a uuid v4 with a bigger alphabet to have a shorter uuid
5295 example: 2y84q2MQUMWPbiEcxNXMgC
5298 description: immutable name of the user, used to find or mention its actor
5300 pattern: '/^[a-z0-9._]+$/'
5305 description: immutable name of the channel, used to interact with its actor
5306 example: framasoft_videos
5307 pattern: '/^[a-zA-Z0-9\\-_.:]+$/'
5318 description: category id of the video (see [/videos/categories](#operation/getCategories))
5320 VideoConstantNumber-Category:
5323 $ref: '#/components/schemas/VideoCategorySet'
5326 example: Science & Technology
5330 description: licence id of the video (see [/videos/licences](#operation/getLicences))
5332 VideoConstantNumber-Licence:
5335 $ref: '#/components/schemas/VideoLicenceSet'
5338 example: Attribution - Share Alike
5342 description: language id of the video (see [/videos/languages](#operation/getLanguages))
5344 VideoConstantString-Language:
5347 $ref: '#/components/schemas/VideoLanguageSet'
5352 VideoPlaylistPrivacySet:
5358 description: Video playlist privacy policy (see [/video-playlists/privacies])
5359 VideoPlaylistPrivacyConstant:
5362 $ref: '#/components/schemas/VideoPlaylistPrivacySet'
5366 VideoPlaylistTypeSet:
5371 description: The video playlist type (Regular = `1`, Watch Later = `2`)
5372 VideoPlaylistTypeConstant:
5375 $ref: '#/components/schemas/VideoPlaylistTypeSet'
5386 description: privacy id of the video (see [/videos/privacies](#operation/getPrivacyPolicies))
5387 VideoPrivacyConstant:
5390 $ref: '#/components/schemas/VideoPrivacySet'
5398 additionalProperties:
5399 x-additionalPropertiesName: account
5408 additionalProperties:
5409 x-additionalPropertiesName: host
5430 description: 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
5437 description: 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'
5440 LiveVideoLatencyMode:
5446 description: 'The live latency mode (Default = `1`, HIght latency = `2`, Small Latency = `3`)'
5467 - `4`: Waiting for live stream
5469 - `6`: To move to an external storage (object storage...)
5470 - `7`: Transcoding failed
5471 - `8`: Moving to an external storage failed
5472 - `9`: To edit using studio edition feature
5482 description: 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
5486 $ref: '#/components/schemas/AbuseStateSet'
5489 AbusePredefinedReasons:
5502 example: [spamOrMisleading]
5507 Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
5509 `0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
5511 VideoResolutionConstant:
5512 description: resolutions and their labels for the video
5515 $ref: '#/components/schemas/VideoResolutionSet'
5519 VideoScheduledUpdate:
5522 $ref: '#/components/schemas/VideoPrivacySet'
5526 description: When to update the video
5546 $ref: '#/components/schemas/ActorImage'
5547 VideoChannelSummary:
5550 $ref: '#/components/schemas/id'
5564 $ref: '#/components/schemas/ActorImage'
5578 - $ref: '#/components/schemas/Video'
5585 description: magnet URI allowing to resolve the video via BitTorrent without a metainfo file
5586 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
5588 $ref: '#/components/schemas/VideoResolutionConstant'
5591 description: Video file size in bytes
5594 description: Direct URL of the torrent file
5598 description: URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
5602 description: Direct URL of the video
5606 description: URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
5610 description: Frames per second of the video file
5614 description: URL dereferencing the output of ffprobe on the file
5615 VideoStreamingPlaylists:
5620 $ref: '#/components/schemas/id'
5628 - $ref: '#/components/schemas/VideoStreamingPlaylists-HLS'
5629 VideoStreamingPlaylists-HLS:
5640 Video files associated to this playlist.
5642 The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
5644 $ref: '#/components/schemas/VideoFile'
5656 $ref: '#/components/schemas/Video/properties/id'
5658 $ref: '#/components/schemas/Video/properties/uuid'
5660 $ref: '#/components/schemas/Video/properties/name'
5664 description: object id for the video
5666 - $ref: '#/components/schemas/id'
5668 description: universal identifier for the video, that can be used across instances
5670 - $ref: '#/components/schemas/UUIDv4'
5673 - $ref: '#/components/schemas/shortUUID'
5679 example: 2017-10-01T10:52:46.396Z
5680 description: time at which the video object was first drafted
5684 example: 2018-10-01T10:52:46.396Z
5685 description: time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
5689 example: 2021-05-04T08:01:01.502Z
5690 description: last time the video's metadata was modified
5691 originallyPublishedAt:
5694 example: 2010-10-01T10:52:46.396Z
5695 description: used to represent a date of first publication, prior to the practical publication date of `publishedAt`
5698 - $ref: '#/components/schemas/VideoConstantNumber-Category'
5699 description: category in which the video is classified
5702 - $ref: '#/components/schemas/VideoConstantNumber-Licence'
5703 description: licence under which the video is distributed
5706 - $ref: '#/components/schemas/VideoConstantString-Language'
5707 description: main language used in the video
5710 - $ref: '#/components/schemas/VideoPrivacyConstant'
5711 description: privacy policy used to distribute the video
5715 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n
5716 **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
5720 truncated description of the video, written in Markdown.
5721 Resolve `descriptionPath` to get the full description of maximum `10000` characters.
5726 description: duration of the video in seconds
5731 description: title of the video
5732 example: What is PeerTube?
5737 example: /static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
5740 example: /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
5743 example: /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
5760 - $ref: '#/components/schemas/VideoStateConstant'
5761 description: represents the internal state of the video processing within the PeerTube instance
5765 - $ref: '#/components/schemas/VideoScheduledUpdate'
5773 $ref: '#/components/schemas/AccountSummary'
5775 $ref: '#/components/schemas/VideoChannelSummary'
5784 - $ref: '#/components/schemas/Video'
5789 description: If the video is a live, you have the amount of current viewers
5792 example: /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
5793 description: path at which to get the full description of maximum `10000` characters
5796 description: A text tell the audience how to support the video creator
5797 example: Please support our work on https://soutenir.framasoft.org/en/ <3
5801 $ref: '#/components/schemas/VideoChannel'
5803 $ref: '#/components/schemas/Account'
5805 example: [flowers, gardening]
5823 - https://peertube2.cpy.re/tracker/announce
5824 - wss://peertube2.cpy.re/tracker/socket
5828 $ref: '#/components/schemas/VideoFile'
5830 WebTorrent/raw video files. If WebTorrent is disabled on the server:
5832 - field will be empty
5833 - video files will be found in `streamingPlaylists[].files` field
5837 $ref: '#/components/schemas/VideoStreamingPlaylists'
5839 HLS playlists/manifest files. If HLS is disabled on the server:
5841 - field will be empty
5842 - video files will be found in `files` field
5843 FileRedundancyInformation:
5846 $ref: '#/components/schemas/id'
5871 $ref: '#/components/schemas/id'
5878 $ref: '#/components/schemas/UUIDv4'
5885 $ref: '#/components/schemas/FileRedundancyInformation'
5889 $ref: '#/components/schemas/FileRedundancyInformation'
5890 VideoImportStateConstant:
5898 description: 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
5905 additionalProperties: false
5909 $ref: '#/components/schemas/VideoImport/properties/targetUrl'
5910 required: [targetUrl]
5913 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
5914 required: [magnetUri]
5917 $ref: '#/components/schemas/VideoImport/properties/torrentfile'
5918 required: [torrentfile]
5919 - $ref: '#/components/schemas/VideoUploadRequestCommon'
5928 - $ref: '#/components/schemas/id'
5932 description: remote URL where to find the import's source video
5933 example: https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
5937 description: magnet URI allowing to resolve the import's source video
5938 pattern: /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
5943 description: Torrent file containing only the video file
5950 - $ref: '#/components/schemas/VideoImportStateConstant'
5966 - $ref: '#/components/schemas/Video'
5976 $ref: '#/components/schemas/VideoImport'
5980 $ref: '#/components/schemas/id'
5983 example: The video is a spam
5987 $ref: '#/components/schemas/AbusePredefinedReasons'
5989 $ref: '#/components/schemas/Account'
5991 $ref: '#/components/schemas/AbuseStateConstant'
5994 example: Decided to ban the server since it spams us regularly
5998 $ref: '#/components/schemas/VideoInfo'
6005 $ref: '#/components/schemas/id'
6016 $ref: '#/components/schemas/AccountSummary'
6020 $ref: '#/components/schemas/id'
6022 $ref: '#/components/schemas/Video/properties/id'
6034 $ref: '#/components/schemas/UUIDv4'
6052 $ref: '#/components/schemas/id'
6054 $ref: '#/components/schemas/UUIDv4'
6057 - $ref: '#/components/schemas/shortUUID'
6080 $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
6082 $ref: '#/components/schemas/VideoPlaylistTypeConstant'
6084 $ref: '#/components/schemas/AccountSummary'
6086 $ref: '#/components/schemas/VideoChannelSummary'
6090 $ref: '#/components/schemas/id'
6097 description: Text of the comment
6099 example: This video is wonderful!
6101 $ref: '#/components/schemas/id'
6105 - $ref: '#/components/schemas/id'
6107 $ref: '#/components/schemas/Video/properties/id'
6122 totalRepliesFromVideoAuthor:
6129 $ref: '#/components/schemas/Account'
6130 VideoCommentThreadTree:
6133 $ref: '#/components/schemas/VideoComment'
6137 $ref: '#/components/schemas/VideoCommentThreadTree'
6141 $ref: '#/components/schemas/VideoConstantString-Language'
6159 $ref: '#/components/schemas/id'
6170 $ref: '#/components/schemas/ActorImage'
6174 $ref: '#/components/schemas/id'
6179 description: immutable name of the actor, used to find or mention it
6181 - $ref: '#/components/schemas/username'
6185 description: server on which the actor is resident
6186 hostRedundancyAllowed:
6188 description: whether this actor's host allows redundancy of its videos
6192 description: number of actors subscribed to by this actor, as seen by this instance
6196 description: number of followers of this actor, as seen by this instance
6205 - $ref: '#/components/schemas/Actor'
6208 description: object id for the user tied to this account
6210 - $ref: '#/components/schemas/User/properties/id'
6213 description: editable name of the account, displayed in its representations
6218 description: text or bio displayed on the account's profile
6226 description: timestamp within the video, in seconds
6233 Event since last viewing call:
6234 * `seek` - If the user seeked the video
6257 VideoStatsRetention:
6269 VideoStatsTimeserie:
6346 allowedForCurrentIP:
6348 requiresEmailVerification:
6366 $ref: '#/components/schemas/VideoResolutionSet'
6451 example: 16810141515
6560 requiresEmailVerification:
6575 description: Settings that apply to new users, if registration is enabled
6579 example: 16810141515
6585 description: Settings pertaining to transcoding jobs
6589 allowAdditionalExtensions:
6591 description: Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
6594 description: If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
6597 description: Amount of threads used by ffmpeg for 1 transcoding job
6600 description: Amount of transcoding jobs to execute in parallel
6606 New profiles can be added by plugins ; available in core PeerTube: 'default'.
6609 description: Resolutions to transcode _new videos_ to
6631 description: WebTorrent-specific settings
6637 description: HLS-specific settings
6687 $ref: '#/components/schemas/id'
6689 $ref: '#/components/schemas/Actor'
6691 $ref: '#/components/schemas/Actor'
6694 description: score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
6707 PredefinedAbuseReasons:
6708 description: Reason categories that help triage reports
6726 $ref: '#/components/schemas/id'
6738 - activitypub-http-unicast
6739 - activitypub-http-broadcast
6740 - activitypub-http-fetcher
6741 - activitypub-follow
6746 - videos-views-stats
6747 - activitypub-refresher
6751 additionalProperties: true
6754 additionalProperties: true
6770 $ref: '#/components/schemas/id'
6775 $ref: '#/components/schemas/id'
6776 VideoUploadRequestCommon:
6779 description: Video name
6781 example: What is PeerTube?
6785 description: Channel id that will contain this video
6790 $ref: '#/components/schemas/VideoPrivacySet'
6792 $ref: '#/components/schemas/VideoCategorySet'
6794 $ref: '#/components/schemas/VideoLicenceSet'
6796 $ref: '#/components/schemas/VideoLanguageSet'
6798 description: Video description
6801 **[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**
6803 description: Whether or not we wait transcoding before publish the video
6806 description: A text tell the audience how to support the video creator
6807 example: Please support our work on https://soutenir.framasoft.org/en/ <3
6810 description: Whether or not this video contains sensitive content
6813 description: Video tags (maximum 5 tags each between 2 and 30 characters)
6826 description: Enable or disable comments for this video
6829 description: Enable or disable downloading for this video
6831 originallyPublishedAt:
6832 description: Date when the content was originally published
6836 $ref: '#/components/schemas/VideoScheduledUpdate'
6838 description: Video thumbnail file
6842 description: Video preview file
6848 VideoUploadRequestLegacy:
6850 - $ref: '#/components/schemas/VideoUploadRequestCommon'
6856 description: Video file
6859 VideoUploadRequestResumable:
6861 - $ref: '#/components/schemas/VideoUploadRequestCommon'
6867 description: Video filename including extension
6870 example: what_is_peertube.mp4
6872 description: Video thumbnail file
6876 description: Video preview file
6879 VideoUploadResponse:
6885 $ref: '#/components/schemas/Video/properties/id'
6887 $ref: '#/components/schemas/Video/properties/uuid'
6889 $ref: '#/components/schemas/Video/properties/shortUUID'
6890 CommentThreadResponse:
6899 $ref: '#/components/schemas/VideoComment'
6900 CommentThreadPostResponse:
6903 $ref: '#/components/schemas/VideoComment'
6913 $ref: '#/components/schemas/Video'
6917 $ref: '#/components/schemas/Account'
6920 description: Automatically start playing the upcoming video after the currently playing video
6921 autoPlayNextVideoPlaylist:
6923 description: Automatically start playing the video on the playlist after the currently playing video
6926 description: Automatically start playing the video on the watch page
6936 description: The user email
6939 description: Has the user confirmed their email address?
6942 - $ref: '#/components/schemas/id'
6946 description: Auth plugin to use to authenticate the user
6950 noInstanceConfigWarningModal:
6952 noAccountSetupWarningModal:
6957 $ref: '#/components/schemas/NSFWPolicy'
6959 $ref: '#/components/schemas/UserRole'
6968 description: Theme enabled by this user
6970 $ref: '#/components/schemas/username'
6974 $ref: '#/components/schemas/VideoChannel'
6977 description: The user video quota in bytes
6981 description: The user daily video quota in bytes
6985 description: Enable P2P in the player
6988 - $ref: '#/components/schemas/User'
6990 # optionally present fields: they require WITH_STATS scope
6993 description: Count of videos published
6996 description: Count of reports/abuses of which the user is a target
6997 abusesAcceptedCount:
6999 description: Count of reports/abuses created by the user and accepted/acted upon by the moderation team
7002 description: Count of reports/abuses created by the user
7005 description: Count of comments published
7009 $ref: '#/components/schemas/username'
7011 $ref: '#/components/schemas/password'
7015 description: The user email
7018 description: The user video quota in bytes
7022 description: The user daily video quota in bytes
7025 $ref: '#/components/schemas/usernameChannel'
7027 $ref: '#/components/schemas/UserRole'
7029 $ref: '#/components/schemas/UserAdminFlags'
7040 description: The updated email of the user
7042 - $ref: '#/components/schemas/User/properties/email'
7045 description: Set the email as verified
7048 description: The updated video quota of the user in bytes
7051 description: The updated daily video quota of the user in bytes
7055 description: The auth plugin to use to authenticate the user
7056 example: 'peertube-plugin-auth-saml2'
7058 $ref: '#/components/schemas/UserRole'
7060 $ref: '#/components/schemas/UserAdminFlags'
7062 $ref: '#/components/schemas/password'
7064 # see shared/models/users/user-update-me.model.ts:
7067 $ref: '#/components/schemas/password'
7069 $ref: '#/components/schemas/password'
7071 description: new email used for login and service communications
7073 - $ref: '#/components/schemas/User/properties/email'
7076 description: new name of the user in its representations
7081 description: new NSFW display policy
7088 description: whether to enable P2P in the player or not
7091 description: new preference regarding playing videos automatically
7094 description: new preference regarding playing following videos automatically
7095 autoPlayNextVideoPlaylist:
7097 description: new preference regarding playing following playlist videos automatically
7098 videosHistoryEnabled:
7100 description: whether to keep track of watched history or not
7105 description: list of languages to filter videos down to
7108 noInstanceConfigWarningModal:
7110 noAccountSetupWarningModal:
7117 $ref: '#/components/schemas/id'
7124 description: Rating of the video
7131 $ref: '#/components/schemas/Video'
7138 description: Rating of the video
7145 description: immutable name of the user, used to find or mention its actor
7147 - $ref: '#/components/schemas/username'
7149 $ref: '#/components/schemas/password'
7153 description: email of the user, used for login or service communications
7156 description: editable name of the user, displayed in its representations
7161 description: channel base information used to create the first channel of the user
7164 $ref: '#/components/schemas/usernameChannel'
7176 pattern: /^[a-z0-9]$/
7179 example: v1ikx5hnfop4mdpnci8nsqh93c45rldf
7182 pattern: /^[a-zA-Z0-9]$/
7185 example: AjWiOapPltI6EnsWQwlFarRtLh4u8tDt
7186 OAuthToken-password:
7188 - $ref: '#/components/schemas/OAuthClient'
7198 $ref: '#/components/schemas/User/properties/username'
7200 $ref: '#/components/schemas/password'
7207 OAuthToken-refresh_token:
7209 - $ref: '#/components/schemas/OAuthClient'
7220 example: 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
7229 - $ref: '#/components/schemas/Actor'
7234 description: editable name of the channel, displayed in its representations
7235 example: Videos of Framasoft
7240 example: Videos made with <3 by Framasoft
7245 description: text shown by default on all videos of this channel, to tell the audience how to support it
7246 example: Please support our work on https://soutenir.framasoft.org/en/ <3
7259 $ref: '#/components/schemas/ActorImage'
7268 $ref: '#/components/schemas/UUIDv4'
7271 - $ref: '#/components/schemas/VideoChannel'
7274 description: username of the channel to create
7276 - $ref: '#/components/schemas/usernameChannel'
7282 - $ref: '#/components/schemas/VideoChannel'
7284 bulkVideosSupportUpdate:
7286 description: Update the support field for all videos of this channel
7296 - $ref: '#/components/schemas/VideoChannel'
7297 - $ref: '#/components/schemas/Actor'
7302 name: 'media:peerLink'
7311 - application/x-bittorrent
7317 name: 'media:content'
7348 VideoCommentsForXML:
7383 description: video watch page URL
7386 description: video canonical URL
7390 description: video publication date
7393 description: video description
7396 description: video description
7399 description: publisher user name
7402 description: video category (MRSS)
7405 description: see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
7420 description: video embed path, relative to the canonical URL domain (MRSS)
7429 description: video watch path, relative to the canonical URL domain (MRSS)
7450 description: see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
7451 'media:description':
7458 description: see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
7461 description: main streamable file for the video
7471 - application/x-bittorrent
7480 description: list of streamable files for the video. see [media:peerLink](https://www.rssboard.org/media-rss#media-peerlink) and [media:content](https://www.rssboard.org/media-rss#media-content) or (MRSS)
7483 - $ref: '#/components/schemas/MRSSPeerLink'
7484 - $ref: '#/components/schemas/MRSSGroupContent'
7485 NotificationSettingValue:
7502 $ref: '#/components/schemas/id'
7506 Notification type, following the `UserNotificationType` enum:
7508 - `1` NEW_VIDEO_FROM_SUBSCRIPTION
7510 - `2` NEW_COMMENT_ON_MY_VIDEO
7512 - `3` NEW_ABUSE_FOR_MODERATORS
7514 - `4` BLACKLIST_ON_MY_VIDEO
7516 - `5` UNBLACKLIST_ON_MY_VIDEO
7518 - `6` MY_VIDEO_PUBLISHED
7520 - `7` MY_VIDEO_IMPORT_SUCCESS
7522 - `8` MY_VIDEO_IMPORT_ERROR
7524 - `9` NEW_USER_REGISTRATION
7528 - `11` COMMENT_MENTION
7530 - `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
7532 - `13` NEW_INSTANCE_FOLLOWER
7534 - `14` AUTO_INSTANCE_FOLLOWING
7536 - `15` ABUSE_STATE_CHANGE
7538 - `16` ABUSE_NEW_MESSAGE
7540 - `17` NEW_PLUGIN_VERSION
7542 - `18` NEW_PEERTUBE_VERSION
7548 - $ref: '#/components/schemas/VideoInfo'
7552 $ref: '#/components/schemas/ActorInfo'
7558 $ref: '#/components/schemas/id'
7561 $ref: '#/components/schemas/VideoInfo'
7566 $ref: '#/components/schemas/VideoImport/properties/magnetUri'
7576 $ref: '#/components/schemas/id'
7580 $ref: '#/components/schemas/VideoInfo'
7582 $ref: '#/components/schemas/ActorInfo'
7588 $ref: '#/components/schemas/id'
7591 - $ref: '#/components/schemas/VideoInfo'
7597 $ref: '#/components/schemas/id'
7600 - $ref: '#/components/schemas/VideoInfo'
7604 - $ref: '#/components/schemas/ActorInfo'
7610 $ref: '#/components/schemas/id'
7612 $ref: '#/components/schemas/ActorInfo'
7640 NotificationListResponse:
7649 $ref: '#/components/schemas/Notification'
7654 example: peertube-plugin-auth-ldap
7682 example: https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
7685 additionalProperties: true
7701 $ref: '#/components/schemas/Plugin'
7708 description: User can stream multiple times in a permanent live
7711 description: User can select live latency mode if enabled by the instance
7712 $ref: '#/components/schemas/LiveVideoLatencyMode'
7718 description: Included in the response if an appropriate token is provided
7721 description: Included in the response if an appropriate token is provided
7724 description: RTMP stream key to use to stream into this live video. Included in the response if an appropriate token is provided
7728 description: User can stream multiple times in a permanent live
7731 description: User can select live latency mode if enabled by the instance
7732 $ref: '#/components/schemas/LiveVideoLatencyMode'
7734 LiveVideoSessionResponse:
7741 description: Start date of the live session
7746 description: End date of the live session
7757 Error type if an error occured during the live session:
7758 - `1`: Bad socket health (transcoding is too slow)
7759 - `2`: Max duration exceeded
7760 - `3`: Quota exceeded
7761 - `4`: Quota FFmpeg error
7762 - `5`: Video has been blacklisted during the live
7765 description: Video replay information
7770 $ref: '#/components/schemas/UUIDv4'
7772 $ref: '#/components/schemas/shortUUID'
7776 'https://search.example.org/api/v1/search/videos':
7778 summary: third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
7781 description: successful operation
7785 $ref: '#/components/schemas/VideoListResponse'