2018-11-15 07:10:15 -06:00
openapi : 3.0 .0
2018-01-24 03:44:52 -06:00
info :
2018-01-24 04:54:32 -06:00
title : PeerTube
2023-08-17 08:14:09 -05:00
version : 5.2 .0
2018-11-13 16:27:58 -06:00
contact :
name : PeerTube Community
2021-05-12 14:23:54 -05:00
url : https://joinpeertube.org
2018-11-13 16:27:58 -06:00
license :
name : AGPLv3.0
2021-05-12 14:23:54 -05:00
url : https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE
2018-11-13 16:27:58 -06:00
x-logo :
2021-05-12 14:23:54 -05:00
url : https://joinpeertube.org/img/brand.png
2018-11-16 07:33:48 -06:00
altText : PeerTube Project Homepage
2018-11-13 16:27:58 -06:00
description : |
2020-04-21 05:09:54 -05:00
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
2020-06-24 07:16:25 -05:00
HTTP/REST library for your programming language to use PeerTube. The spec API is fully compatible with
2018-11-16 07:33:48 -06:00
[ openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
2020-06-24 07:16:25 -05:00
which generates a client SDK in the language of your choice - we generate some client SDKs automatically :
- [ Python](https://framagit.org/framasoft/peertube/clients/python)
- [ Go](https://framagit.org/framasoft/peertube/clients/go)
- [ Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin)
2018-11-15 07:10:15 -06:00
2023-02-22 09:15:14 -06:00
See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) for a few
2021-05-24 12:38:26 -05:00
examples of using the PeerTube API.
2020-04-21 05:09:54 -05:00
2018-11-13 16:27:58 -06:00
# Authentication
2020-02-14 07:14:14 -06:00
2021-05-06 18:40:21 -05:00
When you sign up for an account on a PeerTube instance, you are given the possibility
2021-05-12 14:23:54 -05:00
to generate sessions on it, and authenticate there using an access token. Only __one
access token can currently be used at a time__.
2018-11-16 07:33:48 -06:00
2020-06-26 06:43:27 -05:00
## Roles
Accounts are given permissions based on their role. There are three roles on
2023-02-23 02:46:43 -06:00
PeerTube : Administrator, Moderator, and User. See the [roles guide](https://docs.joinpeertube.org/admin/managing-users#roles) for a detail of their permissions.
2020-06-26 06:43:27 -05:00
2018-11-16 07:33:48 -06:00
# Errors
2020-02-14 07:14:14 -06:00
2018-11-16 07:33:48 -06:00
The API uses standard HTTP status codes to indicate the success or failure
2021-05-31 18:36:53 -05:00
of the API call, completed by a [RFC7807-compliant](https://tools.ietf.org/html/rfc7807) response body.
2018-11-16 07:33:48 -06:00
```
2021-05-13 07:10:04 -05:00
HTTP 1.1 404 Not Found
2021-05-31 18:36:53 -05:00
Content-Type : application/problem+json; charset=utf-8
2021-05-13 07:10:04 -05:00
2018-11-16 07:33:48 -06:00
{
2021-05-31 18:36:53 -05:00
"detail": "Video not found" ,
2023-04-21 08:03:36 -05:00
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo" ,
2021-05-31 18:36:53 -05:00
"status": 404 ,
"title": "Not Found" ,
"type": "about:blank"
2021-05-10 18:18:02 -05:00
}
```
2023-08-17 02:46:24 -05:00
We provide error `type` values for [a growing number of cases](https://github.com/Chocobozzz/PeerTube/blob/develop/packages/models/src/server/server-error-code.enum.ts),
2021-06-02 07:28:30 -05:00
but it is still optional. Types are used to disambiguate errors that bear the same status code
and are non-obvious :
```
HTTP 1.1 403 Forbidden
Content-Type : application/problem+json; charset=utf-8
{
"detail": "Cannot get this video regarding follow constraints" ,
2023-04-21 08:03:36 -05:00
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo" ,
2021-06-02 07:28:30 -05:00
"status": 403 ,
"title": "Forbidden" ,
2023-04-21 08:03:36 -05:00
"type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
2021-06-02 07:28:30 -05:00
}
```
Here a 403 error could otherwise mean that the video is private or blocklisted.
2021-05-13 07:10:04 -05:00
### Validation errors
Each parameter is evaluated on its own against a set of rules before the route validator
2021-05-31 18:36:53 -05:00
proceeds with potential testing involving parameter combinations. Errors coming from validation
2021-06-02 07:28:30 -05:00
errors appear earlier and benefit from a more detailed error description :
2021-05-12 06:44:32 -05:00
2021-05-10 18:18:02 -05:00
```
2021-05-13 07:10:04 -05:00
HTTP 1.1 400 Bad Request
2021-05-31 18:36:53 -05:00
Content-Type : application/problem+json; charset=utf-8
2021-05-13 07:10:04 -05:00
2021-05-10 18:18:02 -05:00
{
2021-05-31 18:36:53 -05:00
"detail": "Incorrect request parameters: id" ,
2023-04-21 08:03:36 -05:00
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo" ,
2021-05-31 18:36:53 -05:00
"instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180" ,
"invalid-params": {
2021-05-14 12:31:24 -05:00
"id": {
2021-05-31 18:36:53 -05:00
"location": "params" ,
"msg": "Invalid value" ,
2021-05-10 18:18:02 -05:00
"param": "id" ,
2021-05-31 18:36:53 -05:00
"value": "9c9de5e8-0a1e-484a-b099-e80766180"
2021-05-10 18:18:02 -05:00
}
2021-05-31 18:36:53 -05:00
},
"status": 400 ,
"title": "Bad Request" ,
"type": "about:blank"
2018-11-16 07:33:48 -06:00
}
```
2021-05-06 18:40:21 -05:00
2021-05-13 07:10:04 -05:00
Where `id` is the name of the field concerned by the error, within the route definition.
2021-05-31 18:36:53 -05:00
`invalid-params.<field>.location` can be either 'params', 'body', 'header', 'query' or 'cookies', and
`invalid-params.<field>.value` reports the value that didn't pass validation whose `invalid-params.<field>.msg`
2021-05-13 07:10:04 -05:00
is about.
2021-06-02 07:28:30 -05:00
### Deprecated error fields
Some fields could be included with previous versions. They are still included but their use is deprecated :
- `error` : superseded by `detail`
- `code` : superseded by `type` (which is now an URI)
2021-05-06 18:40:21 -05:00
# Rate limits
2021-05-10 03:26:50 -05:00
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators :
2021-05-06 18:40:21 -05:00
2021-05-12 14:21:52 -05:00
| Endpoint (prefix : `/api/v1`) | Calls | Time frame |
|------------------------------|---------------|--------------|
| `/*` | 50 | 10 seconds |
| `POST /users/token` | 15 | 5 minutes |
| `POST /users/register` | 2<sup>*</sup> | 5 minutes |
| `POST /users/ask-send-verify-email` | 3 | 5 minutes |
2021-05-06 18:40:21 -05:00
2021-05-11 13:19:26 -05:00
Depending on the endpoint, <sup>*</sup>failed requests are not taken into account. A service
2021-05-06 18:40:21 -05:00
limit is announced by a `429 Too Many Requests` status code.
2021-05-07 02:46:22 -05:00
You can get details about the current state of your rate limit by reading the
following headers :
2021-05-06 18:40:21 -05:00
| Header | Description |
|-------------------------|------------------------------------------------------------|
2021-05-12 06:44:32 -05:00
| `X-RateLimit-Limit` | Number of max requests allowed in the current time period |
| `X-RateLimit-Remaining` | Number of remaining requests in the current time period |
| `X-RateLimit-Reset` | Timestamp of end of current time period as UNIX timestamp |
| `Retry-After` | Seconds to delay after the first `429` is received |
2021-05-12 14:21:52 -05:00
# CORS
This API features [Cross-Origin Resource Sharing (CORS)](https://fetch.spec.whatwg.org/),
allowing cross-domain communication from the browser for some routes :
2021-05-27 04:52:03 -05:00
2021-05-12 14:23:54 -05:00
| Endpoint |
|------------------------- ---|
| `/api/*` |
| `/download/*` |
| `/lazy-static/*` |
| `/.well-known/webfinger` |
2021-05-12 14:21:52 -05:00
In addition, all routes serving ActivityPub are CORS-enabled for all origins.
2018-11-16 05:11:00 -06:00
externalDocs :
2023-04-21 08:03:36 -05:00
url : https://docs.joinpeertube.org/api-rest-reference.html
2018-11-13 16:27:58 -06:00
tags :
2021-05-12 14:23:54 -05:00
- name : Register
description : |
As a visitor, you can use this API to open an account (if registrations are open on
2021-05-27 04:52:03 -05:00
that PeerTube instance). As an admin, you should use the dedicated [User creation
2021-05-24 12:38:26 -05:00
API](#operation/addUser) instead.
2021-05-12 14:23:54 -05:00
- name : Session
x-displayName : Login/Logout
description : |
Sessions deal with access tokens over time. Only __one session token can currently be used at a time__.
2018-11-13 16:27:58 -06:00
- name : Accounts
2018-11-15 07:10:15 -06:00
description : >
2020-07-02 07:23:50 -05:00
Accounts encompass remote accounts discovered across the federation,
2020-06-26 06:43:27 -05:00
and correspond to the main Actor, along with video channels a user can create, which
are also Actors.
When a comment is posted, it is done with your Account's Actor.
- name : Users
description : >
Using some features of PeerTube require authentication, for which User
2018-11-15 07:10:15 -06:00
provide different levels of permission as well as associated user
2020-06-26 06:43:27 -05:00
information. Each user has a corresponding local Account for federation.
- name : My User
description : >
Operations related to your own User, when logged-in.
- name : My Subscriptions
description : >
Operations related to your subscriptions to video channels, their
new videos, and how to keep up to date with their latest publications!
2020-11-25 17:27:59 -06:00
- name : My History
description : >
2020-12-03 07:10:54 -06:00
Operations related to your watch history.
2020-06-26 06:43:27 -05:00
- name : My Notifications
description : >
Notifications following new videos, follows or reports. They allow you
to keep track of the interactions and overall important information that
concerns you. You MAY set per-notification type delivery preference, to
receive the info either by mail, by in-browser notification or both.
2018-11-13 16:27:58 -06:00
- name : Config
2018-11-15 07:10:15 -06:00
description : >
Each server exposes public information regarding supported videos and
options.
2018-11-13 16:27:58 -06:00
- name : Job
2018-11-15 07:10:15 -06:00
description : >
Jobs are long-running tasks enqueued and processed by the instance
2018-11-16 07:33:48 -06:00
itself. No additional worker registration is currently available.
2020-04-21 05:09:54 -05:00
- name : Instance Follows
2018-11-15 07:10:15 -06:00
description : >
Managing servers which the instance interacts with is crucial to the
2018-11-16 07:33:48 -06:00
concept of federation in PeerTube and external video indexation. The PeerTube
2019-01-09 07:10:25 -06:00
server then deals with inter-server ActivityPub operations and propagates
2018-11-13 16:27:58 -06:00
information across its social graph by posting activities to actors' inbox
endpoints.
2020-06-26 06:43:27 -05:00
externalDocs :
2023-02-23 02:46:43 -06:00
url : https://docs.joinpeertube.org/admin/following-instances#instances-follows
2020-06-25 04:14:43 -05:00
- name : Instance Redundancy
description : >
Redundancy is part of the inter-server solidarity that PeerTube fosters.
Manage the list of instances you wish to help by seeding their videos according
to the policy of video selection of your choice. Note that you have a similar functionality
2021-05-10 04:13:41 -05:00
to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
2020-06-26 06:43:27 -05:00
externalDocs :
2023-02-23 02:46:43 -06:00
url : https://docs.joinpeertube.org/admin/following-instances#instances-redundancy
2020-06-25 05:16:08 -05:00
- name : Plugins
description : >
2020-06-26 06:43:27 -05:00
Managing plugins installed from a local path or from NPM, or search for new ones.
externalDocs :
2023-02-22 09:15:14 -06:00
url : https://docs.joinpeertube.org/api/plugins
2020-07-08 08:51:46 -05:00
- name : Abuses
2018-11-13 16:27:58 -06:00
description : |
2020-07-08 08:51:46 -05:00
Abuses deal with reports of local or remote videos/comments/accounts alike.
2018-11-13 16:27:58 -06:00
- name : Video
description : |
Operations dealing with listing, uploading, fetching or modifying videos.
2021-05-10 04:13:41 -05:00
- name : Video Upload
description : |
Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
### Upload
2021-05-10 07:17:26 -05:00
- [ _legacy_](#operation/uploadLegacy), where the video file is sent in a single request
- [ _resumable_](#operation/uploadResumableInit), where the video file is sent in chunks
2021-05-10 04:13:41 -05:00
You can upload videos more reliably by using the resumable variant. Its protocol lets
you resume an upload operation after a network interruption or other transmission failure,
saving time and bandwidth in the event of network failures.
Favor using resumable uploads in any of the following cases :
- You are transferring large files
- The likelihood of a network interruption is high
- Uploads are originating from a device with a low-bandwidth or unstable Internet connection,
such as a mobile device
### Import
- _URL_-based : where the URL points to any service supported by [youtube-dl](https://ytdl-org.github.io/youtube-dl/)
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
- _magnet_-based : where the URI resolves to a BitTorrent resource containing a single supported video file
- _torrent_-based : where the metainfo file resolves to a BitTorrent resource containing a single supported video file
2021-05-10 04:13:41 -05:00
The import function is practical when the desired video/audio is available online. It makes PeerTube
download it for you, saving you as much bandwidth and avoiding any instability or limitation your network might have.
2022-01-19 07:23:00 -06:00
- name : Video Imports
description : Operations dealing with listing, adding and removing video imports.
2022-08-10 02:53:39 -05:00
- name : Channels Sync
description : Operations dealing with synchronizing PeerTube user's channel with channels of other platforms
2021-05-10 04:13:41 -05:00
- name : Video Captions
description : Operations dealing with listing, adding and removing closed captions of a video.
2023-08-28 03:55:04 -05:00
- name : Video Chapters
description : Operations dealing with managing chapters of a video.
2021-05-10 04:13:41 -05:00
- name : Video Channels
description : Operations dealing with the creation, modification and listing of videos within a channel.
- name : Video Comments
description : >
Operations dealing with comments to a video. Comments are organized in threads : adding a
comment in response to the video starts a thread, adding a reply to a comment adds it to
its root comment thread.
- name : Video Blocks
description : Operations dealing with blocking videos (removing them from view and preventing interactions).
- name : Video Rates
description : Like/dislike a video.
- name : Video Playlists
description : Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
2021-11-18 07:35:08 -06:00
- name : Video Files
description : Operations on video files
- name : Video Transcoding
description : Video transcoding related operations
2023-05-02 06:19:26 -05:00
- name : Video Stats
2022-04-05 07:34:52 -05:00
description : Video statistics
2022-10-12 09:09:02 -05:00
- name : Video Feeds
description : Server syndication feeds of videos
2018-11-13 16:27:58 -06:00
- name : Search
description : |
2020-06-10 08:18:15 -05:00
The search helps to find _videos_ or _channels_ from within the instance and beyond.
2018-11-13 16:27:58 -06:00
Videos from other instances federated by the instance (that is, instances
followed by the instance) can be found via keywords and other criteria of
the advanced search.
2020-06-10 08:18:15 -05:00
Administrators can also enable the use of a remote search system, indexing
videos and channels not could be not federated by the instance.
2021-05-27 08:59:55 -05:00
- name : Homepage
description : Get and update the custom homepage
2021-05-10 04:13:41 -05:00
- name : Video Mirroring
description : |
PeerTube instances can mirror videos from one another, and help distribute some videos.
2021-05-10 09:09:59 -05:00
For importing videos as your own, refer to [video imports](#operation/importVideo).
2022-07-12 07:17:37 -05:00
- name : Stats
description : |
Statistics
2023-05-02 06:19:26 -05:00
- name : Runner Registration Token
description : |
Manage runner registration token
2023-06-29 02:48:55 -05:00
- name : Video Passwords
description : Operation on video passwords
2022-07-12 07:17:37 -05:00
2018-11-16 07:33:48 -06:00
x-tagGroups :
2022-10-12 09:09:02 -05:00
- name : Static endpoints
tags :
- Static Video Files
- name : Feeds
tags :
- Video Feeds
2021-05-12 14:23:54 -05:00
- name : Auth
tags :
- Register
- Session
2018-11-16 07:33:48 -06:00
- name : Accounts
tags :
- Accounts
2020-04-21 05:09:54 -05:00
- Users
2019-07-29 07:33:16 -05:00
- My User
2020-04-21 05:09:54 -05:00
- My Subscriptions
2020-06-24 15:25:05 -05:00
- My Notifications
2020-11-25 17:27:59 -06:00
- My History
2018-11-16 07:33:48 -06:00
- name : Videos
tags :
- Video
2021-05-10 04:13:41 -05:00
- Video Upload
2022-01-19 07:23:00 -06:00
- Video Imports
2020-06-25 04:14:43 -05:00
- Video Captions
2023-08-28 03:55:04 -05:00
- Video Chapters
2020-04-21 05:09:54 -05:00
- Video Channels
- Video Comments
- Video Rates
- Video Playlists
2022-04-05 07:34:52 -05:00
- Video Stats
2020-04-21 05:09:54 -05:00
- Video Ownership Change
2020-06-25 04:14:43 -05:00
- Video Mirroring
2021-11-18 07:35:08 -06:00
- Video Files
- Video Transcoding
2020-11-09 04:21:08 -06:00
- Live Videos
2022-08-10 02:53:39 -05:00
- Channels Sync
2023-06-29 02:48:55 -05:00
- Video Passwords
2020-04-21 05:09:54 -05:00
- name : Search
tags :
- Search
2018-11-16 07:33:48 -06:00
- name : Moderation
tags :
2020-07-08 08:51:46 -05:00
- Abuses
2020-06-22 06:00:39 -05:00
- Video Blocks
2020-06-24 07:16:25 -05:00
- Account Blocks
- Server Blocks
2022-07-15 08:30:14 -05:00
- name : Instance
2018-11-16 07:33:48 -06:00
tags :
- Config
2022-07-15 08:30:14 -05:00
- Homepage
2020-04-21 05:09:54 -05:00
- Instance Follows
2020-06-25 04:14:43 -05:00
- Instance Redundancy
2020-06-25 05:16:08 -05:00
- Plugins
2022-07-12 07:17:37 -05:00
- Stats
2022-07-15 08:30:14 -05:00
- Logs
2018-11-16 07:33:48 -06:00
- Job
2023-05-02 06:19:26 -05:00
- name : Remote Jobs
tags :
- Runner Registration Token
- Runner Jobs
- Runners
2018-01-24 03:44:52 -06:00
paths :
2023-07-11 04:39:59 -05:00
'/static/web-videos/{filename}' :
2018-01-24 03:44:52 -06:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Static Video Files
2023-07-11 02:21:13 -05:00
summary : Get public Web Video file
2018-01-24 03:44:52 -06:00
parameters :
2022-10-12 09:09:02 -05:00
- $ref : '#/components/parameters/staticFilename'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2020-06-24 07:16:25 -05:00
'404' :
2022-10-12 09:09:02 -05:00
description : not found
2023-07-11 04:39:59 -05:00
'/static/web-videos/private/{filename}' :
2018-04-25 03:21:38 -05:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Static Video Files
2023-07-11 04:39:59 -05:00
summary : Get private Web Video file
2018-04-25 03:21:38 -05:00
parameters :
2022-10-12 09:09:02 -05:00
- $ref : '#/components/parameters/staticFilename'
- $ref : '#/components/parameters/videoFileToken'
security :
- OAuth2 : [ ]
2018-04-25 03:21:38 -05:00
responses :
'200' :
description : successful operation
2022-10-12 09:09:02 -05:00
'403' :
description : invalid auth
'404' :
description : not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/static/streaming-playlists/hls/{filename}' :
2021-10-19 08:02:43 -05:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Static Video Files
summary : Get public HLS video file
parameters :
- $ref : '#/components/parameters/staticFilename'
2021-10-19 08:02:43 -05:00
security :
- OAuth2 : [ ]
responses :
'200' :
description : successful operation
2022-10-12 09:09:02 -05:00
'403' :
description : invalid auth
'404' :
description : not found
'/static/streaming-playlists/hls/private/{filename}' :
2018-01-24 03:44:52 -06:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Static Video Files
summary : Get private HLS video file
2019-08-22 06:33:07 -05:00
parameters :
2022-10-12 09:09:02 -05:00
- $ref : '#/components/parameters/staticFilename'
- $ref : '#/components/parameters/videoFileToken'
2022-12-02 07:47:21 -06:00
- $ref : '#/components/parameters/reinjectVideoFileToken'
2022-10-12 09:09:02 -05:00
security :
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2022-10-12 09:09:02 -05:00
'403' :
description : invalid auth
'404' :
description : not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/feeds/video-comments.{format}' :
2018-01-24 03:44:52 -06:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Video Feeds
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
summary : Comments on videos feeds
2022-10-12 09:09:02 -05:00
operationId : getSyndicatedComments
parameters :
- name : format
in : path
required : true
description : 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
schema :
type : string
enum :
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name : videoId
in : query
description : 'limit listing to a specific video'
schema :
type : string
- name : accountId
in : query
description : 'limit listing to a specific account'
schema :
type : string
- name : accountName
in : query
description : 'limit listing to a specific account'
schema :
type : string
- name : videoChannelId
in : query
description : 'limit listing to a specific video channel'
schema :
type : string
- name : videoChannelName
in : query
description : 'limit listing to a specific video channel'
schema :
type : string
2018-01-24 03:44:52 -06:00
responses :
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
'200' :
2018-01-24 03:44:52 -06:00
description : successful operation
2022-10-12 09:09:02 -05:00
headers :
Cache-Control :
schema :
type : string
default : 'max-age=900' # 15 min cache
2018-11-15 07:10:15 -06:00
content :
2022-10-12 09:09:02 -05:00
application/xml :
2018-11-15 07:10:15 -06:00
schema :
2022-10-12 09:09:02 -05:00
$ref : '#/components/schemas/VideoCommentsForXML'
2021-05-10 07:17:26 -05:00
examples :
nightly :
2022-10-12 09:09:02 -05:00
externalValue : https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
application/rss+xml :
2019-08-22 06:33:07 -05:00
schema :
2022-10-12 09:09:02 -05:00
$ref : '#/components/schemas/VideoCommentsForXML'
2021-05-10 07:17:26 -05:00
examples :
nightly :
2022-10-12 09:09:02 -05:00
externalValue : https://peertube2.cpy.re/feeds/video-comments.rss?filter=local
text/xml :
schema :
$ref : '#/components/schemas/VideoCommentsForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/video-comments.xml?filter=local
application/atom+xml :
schema :
$ref : '#/components/schemas/VideoCommentsForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/video-comments.atom?filter=local
2019-08-22 06:33:07 -05:00
application/json :
schema :
2022-10-12 09:09:02 -05:00
type : object
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/video-comments.json?filter=local
2020-06-26 06:43:27 -05:00
'400' :
x-summary : field inconsistencies
description : >
Arises when :
2022-10-12 09:09:02 -05:00
- videoId filter is mixed with a channel filter
'404' :
description : video, video channel or account not found
'406' :
description : accept header unsupported
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/feeds/videos.{format}' :
2021-05-27 08:59:55 -05:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Video Feeds
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
summary : Common videos feeds
2022-10-12 09:09:02 -05:00
operationId : getSyndicatedVideos
parameters :
- name : format
in : path
required : true
description : 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
schema :
type : string
enum :
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name : accountId
in : query
description : 'limit listing to a specific account'
schema :
type : string
- name : accountName
in : query
description : 'limit listing to a specific account'
schema :
type : string
- name : videoChannelId
in : query
description : 'limit listing to a specific video channel'
schema :
type : string
- name : videoChannelName
in : query
description : 'limit listing to a specific video channel'
schema :
type : string
- $ref : '#/components/parameters/sort'
- $ref : '#/components/parameters/nsfw'
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
- $ref : '#/components/parameters/privacyOneOf'
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2022-10-12 09:09:02 -05:00
responses :
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
'200' :
2022-10-12 09:09:02 -05:00
description : successful operation
headers :
Cache-Control :
schema :
type : string
default : 'max-age=900' # 15 min cache
content :
application/xml :
schema :
$ref : '#/components/schemas/VideosForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/videos.xml?filter=local
application/rss+xml :
schema :
$ref : '#/components/schemas/VideosForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/videos.rss?filter=local
text/xml :
schema :
$ref : '#/components/schemas/VideosForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/videos.xml?filter=local
application/atom+xml :
schema :
$ref : '#/components/schemas/VideosForXML'
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/videos.atom?filter=local
application/json :
schema :
type : object
examples :
nightly :
externalValue : https://peertube2.cpy.re/feeds/videos.json?filter=local
'404' :
description : video channel or account not found
'406' :
description : accept header unsupported
'/feeds/subscriptions.{format}' :
get :
tags :
- Video Feeds
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
summary : Videos of subscriptions feeds
2022-10-12 09:09:02 -05:00
operationId : getSyndicatedSubscriptionVideos
parameters :
- name : format
in : path
required : true
description : 'format expected (we focus on making `rss` the most featureful ; it serves [Media RSS](https://www.rssboard.org/media-rss))'
schema :
type : string
enum :
- xml
- rss
- rss2
- atom
- atom1
- json
- json1
- name : accountId
in : query
description : limit listing to a specific account
schema :
type : string
required : true
- name : token
in : query
description : private token allowing access
schema :
type : string
required : true
- $ref : '#/components/parameters/sort'
- $ref : '#/components/parameters/nsfw'
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
- $ref : '#/components/parameters/privacyOneOf'
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2022-10-12 09:09:02 -05:00
responses :
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
'200' :
2022-10-12 09:09:02 -05:00
description : successful operation
headers :
Cache-Control :
schema :
type : string
default : 'max-age=900' # 15 min cache
content :
application/xml :
schema :
$ref : '#/components/schemas/VideosForXML'
application/rss+xml :
schema :
$ref : '#/components/schemas/VideosForXML'
text/xml :
schema :
$ref : '#/components/schemas/VideosForXML'
application/atom+xml :
schema :
$ref : '#/components/schemas/VideosForXML'
application/json :
schema :
type : object
'406' :
description : accept header unsupported
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 09:00:05 -05:00
'/feeds/podcast/videos.xml' :
get :
tags :
- Video Feeds
summary : Videos podcast feed
operationId : getVideosPodcastFeed
parameters :
- name : videoChannelId
in : query
description : 'Limit listing to a specific video channel'
required : true
schema :
type : string
responses :
'200' :
description : successful operation
headers :
Cache-Control :
schema :
type : string
default : 'max-age=900' # 15 min cache
'404' :
description : video channel not found
2022-10-12 09:09:02 -05:00
'/api/v1/accounts/{name}' :
get :
tags :
- Accounts
summary : Get an account
operationId : getAccount
parameters :
- $ref : '#/components/parameters/name'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/Account'
'404' :
description : account not found
'/api/v1/accounts/{name}/videos' :
get :
tags :
- Accounts
- Video
summary : 'List videos of an account'
operationId : getAccountVideos
parameters :
- $ref : '#/components/parameters/name'
- $ref : '#/components/parameters/categoryOneOf'
- $ref : '#/components/parameters/isLive'
- $ref : '#/components/parameters/tagsOneOf'
- $ref : '#/components/parameters/tagsAllOf'
- $ref : '#/components/parameters/licenceOneOf'
- $ref : '#/components/parameters/languageOneOf'
- $ref : '#/components/parameters/nsfw'
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
- $ref : '#/components/parameters/privacyOneOf'
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2022-10-12 09:09:02 -05:00
- $ref : '#/components/parameters/skipCount'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/videosSort'
2023-04-12 02:32:20 -05:00
- $ref : '#/components/parameters/excludeAlreadyWatched'
2022-10-12 09:09:02 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoListResponse'
x-codeSamples :
- lang : JavaScript
source : |
fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
.then(function(response) {
return response.json()
}).then(function(data) {
console.log(data)
})
- lang : Shell
source : |
## DEPENDENCIES: jq
curl -s https://peertube2.cpy.re/api/v1/accounts/{name}/videos | jq
- lang : Ruby
source : |
require 'net/http'
require 'json'
uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
response = http.get(uri.request_uri)
puts JSON.parse(response.read_body)
- lang : Python
source : |
import requests
r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
json = r.json()
print(json)
'/api/v1/accounts/{name}/followers' :
get :
tags :
- Accounts
summary : 'List followers of an account'
security :
- OAuth2 : [ ]
operationId : getAccountFollowers
parameters :
- $ref : '#/components/parameters/name'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/followersSort'
- $ref : '#/components/parameters/search'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Follow'
/api/v1/accounts :
get :
tags :
- Accounts
summary : List accounts
operationId : getAccounts
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
'application/json' :
schema :
2023-05-02 06:19:26 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Account'
2022-10-12 09:09:02 -05:00
/api/v1/config :
get :
tags :
- Config
summary : Get instance public configuration
operationId : getConfig
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/ServerConfig'
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/config
/api/v1/config/about :
get :
summary : Get instance "About" information
operationId : getAbout
tags :
- Config
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/ServerConfigAbout'
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/config/about
/api/v1/config/custom :
get :
summary : Get instance runtime configuration
operationId : getCustomConfig
tags :
- Config
security :
- OAuth2 :
- admin
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/ServerConfigCustom'
put :
summary : Set instance runtime configuration
operationId : putCustomConfig
tags :
- Config
security :
- OAuth2 :
- admin
responses :
'200' :
description : successful operation
'400' :
x-summary : field inconsistencies
description : >
Arises when :
- the emailer is disabled and the instance is open to registrations
2023-07-11 02:21:13 -05:00
- web videos and hls are disabled with transcoding enabled - you need at least one enabled
2022-10-12 09:09:02 -05:00
delete :
summary : Delete instance runtime configuration
operationId : delCustomConfig
tags :
- Config
security :
- OAuth2 :
- admin
responses :
'200' :
description : successful operation
/api/v1/custom-pages/homepage/instance :
get :
summary : Get instance custom homepage
tags :
- Homepage
2021-05-27 08:59:55 -05:00
responses :
'404' :
description : No homepage set
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/CustomHomepage'
put :
summary : Set instance custom homepage
tags :
- Homepage
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
type : object
properties :
content :
type : string
description : content of the homepage, that will be injected in the client
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/jobs/pause :
2022-01-19 07:23:00 -06:00
post :
summary : Pause job queue
security :
- OAuth2 :
- admin
tags :
- Job
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/jobs/resume :
2022-01-19 07:23:00 -06:00
post :
summary : Resume job queue
security :
- OAuth2 :
- admin
tags :
- Job
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/jobs/{state}:
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List instance jobs
2021-05-14 12:31:24 -05:00
operationId : getJobs
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
2018-01-24 03:44:52 -06:00
tags :
- Job
2018-02-17 12:24:56 -06:00
parameters :
- name : state
in : path
required : true
2020-12-13 12:27:25 -06:00
description : The state of the job ('' for for no filter)
2018-11-15 07:10:15 -06:00
schema :
type : string
2018-11-19 15:07:29 -06:00
enum :
2020-12-13 12:27:25 -06:00
- ''
2018-11-19 15:07:29 -06:00
- active
- completed
- failed
- waiting
- delayed
2020-12-13 12:27:25 -06:00
- $ref : '#/components/parameters/jobType'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2020-06-26 06:43:27 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
maxItems : 100
items :
$ref : '#/components/schemas/Job'
2021-05-13 07:50:26 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/server/followers :
2021-05-13 07:50:26 -05:00
get :
tags :
- Instance Follows
summary : List instances following the server
parameters :
- $ref : '#/components/parameters/followState'
- $ref : '#/components/parameters/actorType'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Follow'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/followers/{nameWithHost}' :
2018-01-24 03:44:52 -06:00
delete :
2021-05-13 07:50:26 -05:00
summary : Remove or reject a follower to your server
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-06-24 07:16:25 -05:00
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Instance Follows
2018-01-24 03:44:52 -06:00
parameters :
2021-05-13 07:50:26 -05:00
- name : nameWithHost
2018-01-24 03:44:52 -06:00
in : path
required : true
2021-05-13 07:50:26 -05:00
description : The remote actor handle to remove from your followers
2018-11-15 07:10:15 -06:00
schema :
type : string
2021-05-13 07:50:26 -05:00
format : email
2018-01-24 03:44:52 -06:00
responses :
2021-05-13 07:50:26 -05:00
'204' :
2018-01-24 03:44:52 -06:00
description : successful operation
2021-05-13 07:50:26 -05:00
'404' :
description : follower not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/followers/{nameWithHost}/reject' :
2021-05-13 07:50:26 -05:00
post :
summary : Reject a pending follower to your server
security :
- OAuth2 :
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Instance Follows
2018-02-17 12:24:56 -06:00
parameters :
2021-05-13 07:50:26 -05:00
- name : nameWithHost
in : path
required : true
description : The remote actor handle to remove from your followers
schema :
type : string
format : email
2018-01-24 03:44:52 -06:00
responses :
2021-05-13 07:50:26 -05:00
'204' :
2018-01-24 03:44:52 -06:00
description : successful operation
2021-05-13 07:50:26 -05:00
'404' :
description : follower not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/followers/{nameWithHost}/accept' :
2021-05-13 07:50:26 -05:00
post :
summary : Accept a pending follower to your server
security :
- OAuth2 :
- admin
tags :
- Instance Follows
parameters :
- name : nameWithHost
in : path
required : true
description : The remote actor handle to remove from your followers
schema :
type : string
format : email
responses :
'204' :
description : successful operation
'404' :
description : follower not found
2022-10-12 09:09:02 -05:00
/api/v1/server/following :
2018-01-24 03:44:52 -06:00
get :
tags :
2020-04-21 05:09:54 -05:00
- Instance Follows
2020-06-24 15:25:05 -05:00
summary : List instances followed by the server
2018-02-17 12:24:56 -06:00
parameters :
2021-05-13 07:50:26 -05:00
- $ref : '#/components/parameters/followState'
- $ref : '#/components/parameters/actorType'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-13 07:50:26 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Follow'
2018-01-24 03:44:52 -06:00
post :
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Instance Follows
2021-07-20 07:15:15 -05:00
summary : Follow a list of actors (PeerTube instance, channel or account)
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 15:25:05 -05:00
'500' :
description : cannot follow a non-HTTPS server
2018-11-15 07:10:15 -06:00
requestBody :
content :
application/json :
schema :
2020-06-24 15:25:05 -05:00
type : object
properties :
hosts :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2020-06-24 15:25:05 -05:00
uniqueItems : true
2021-07-20 07:15:15 -05:00
handles :
type : array
items :
type : string
uniqueItems : true
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/following/{hostOrHandle}' :
2021-05-13 07:50:26 -05:00
delete :
2021-07-20 07:15:15 -05:00
summary : Unfollow an actor (PeerTube instance, channel or account)
2021-05-13 07:50:26 -05:00
security :
- OAuth2 :
- admin
tags :
- Instance Follows
parameters :
2021-07-20 07:15:15 -05:00
- name : hostOrHandle
2021-05-13 07:50:26 -05:00
in : path
required : true
2021-07-20 07:15:15 -05:00
description : The hostOrHandle to unfollow
2021-05-13 07:50:26 -05:00
schema :
type : string
responses :
'204' :
description : successful operation
'404' :
2021-07-20 07:15:15 -05:00
description : host or handle not found
2021-05-13 07:50:26 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users :
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Create a user
2021-05-24 12:38:26 -05:00
operationId : addUser
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2018-01-24 03:44:52 -06:00
responses :
2020-07-02 07:23:50 -05:00
'200' :
2020-06-27 04:43:43 -05:00
description : user created
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/AddUserResponse'
2020-06-27 04:43:43 -05:00
links :
# GET /users/{id}
2021-05-24 12:38:26 -05:00
GetUser :
operationId : getUser
2020-06-27 04:43:43 -05:00
parameters :
id : '$response.body#/user/id'
# PUT /users/{id}
2021-05-24 12:38:26 -05:00
PutUser :
operationId : putUser
2020-06-27 04:43:43 -05:00
parameters :
id : '$response.body#/user/id'
# DELETE /users/{id}
2021-05-24 12:38:26 -05:00
DelUser :
operationId : delUser
2020-06-27 04:43:43 -05:00
parameters :
id : '$response.body#/user/id'
'403' :
description : insufficient authority to create an admin or moderator
2018-11-15 07:10:15 -06:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/AddUser'
2021-05-10 09:09:59 -05:00
description : |
If the smtp server is configured, you can leave the password empty and an email will be sent
asking the user to set it first.
2018-11-15 07:10:15 -06:00
required : true
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List users
2021-05-14 12:31:24 -05:00
operationId : getUsers
2018-04-16 03:48:17 -05:00
security :
2020-07-02 15:49:51 -05:00
- OAuth2 :
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2018-02-17 12:24:56 -06:00
parameters :
2020-07-02 15:49:51 -05:00
- $ref : '#/components/parameters/usersSearch'
- $ref : '#/components/parameters/usersBlocked'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/usersSort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/User'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/users/{id}' :
2020-06-27 04:43:43 -05:00
parameters :
- $ref : '#/components/parameters/id'
2018-01-24 03:44:52 -06:00
delete :
2020-04-21 05:09:54 -05:00
summary : Delete a user
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2021-05-24 12:38:26 -05:00
operationId : delUser
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get a user
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2021-05-24 12:38:26 -05:00
operationId : getUser
2021-05-10 05:01:40 -05:00
parameters :
- name : withStats
in : query
description : include statistics about the user (only available as a moderator/admin)
schema :
type : boolean
2018-01-24 03:44:52 -06:00
responses :
'200' :
2021-05-10 05:01:40 -05:00
x-summary : successful operation
description : |
As an admin/moderator, you can request a response augmented with statistics about the user's
moderation relations and videos usage, by using the `withStats` parameter.
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 05:01:40 -05:00
oneOf :
- $ref : '#/components/schemas/User'
- $ref : '#/components/schemas/UserWithStats'
2018-01-24 03:44:52 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Update a user
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2021-05-24 12:38:26 -05:00
operationId : putUser
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2018-11-15 07:10:15 -06:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UpdateUser'
required : true
2021-05-12 14:23:54 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/oauth-clients/local :
2021-05-12 14:23:54 -05:00
get :
summary : Login prerequisite
2021-05-14 12:31:24 -05:00
description : You need to retrieve a client id and secret before [logging in](#operation/getOAuthToken).
2021-05-12 14:23:54 -05:00
operationId : getOAuthClient
tags :
- Session
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/OAuthClient'
links :
UseOAuthClientToLogin :
operationId : getOAuthToken
parameters :
client_id : '$response.body#/client_id'
client_secret : '$response.body#/client_secret'
2021-05-14 12:19:10 -05:00
x-codeSamples :
- lang : Shell
source : |
API="https://peertube2.cpy.re/api/v1"
## AUTH
curl -s "$API/oauth-clients/local"
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/token :
2021-05-12 14:23:54 -05:00
post :
summary : Login
operationId : getOAuthToken
description : With your [client id and secret](#operation/getOAuthClient), you can retrieve an access and refresh tokens.
tags :
- Session
requestBody :
content :
application/x-www-form-urlencoded :
schema :
oneOf :
- $ref : '#/components/schemas/OAuthToken-password'
- $ref : '#/components/schemas/OAuthToken-refresh_token'
discriminator :
propertyName : grant_type
mapping :
password : '#/components/schemas/OAuthToken-password'
refresh_token : '#/components/schemas/OAuthToken-refresh_token'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
token_type :
type : string
example : Bearer
access_token :
type : string
example : 90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0
description : valid for 1 day
refresh_token :
type : string
example : 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
description : valid for 2 weeks
expires_in :
type : integer
minimum : 0
example : 14399
refresh_token_expires_in :
type : integer
minimum : 0
example : 1209600
2021-06-02 07:28:30 -05:00
'400' :
x-summary : client or credentials are invalid
description : |
Disambiguate via `type` :
- `invalid_client` for an unmatched `client_id`
- `invalid_grant` for unmatched credentials
2021-06-04 01:40:08 -05:00
'401' :
x-summary : token expired
description : |
Disambiguate via `type` :
- default value for a regular authentication failure
- `invalid_token` for an expired token
2021-05-14 12:19:10 -05:00
x-codeSamples :
- lang : Shell
source : |
## DEPENDENCIES: jq
API="https://peertube2.cpy.re/api/v1"
USERNAME="<your_username>"
PASSWORD="<your_password>"
## AUTH
client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
curl -s "$API/users/token" \
--data client_id="$client_id" \
--data client_secret="$client_secret" \
--data grant_type=password \
--data username="$USERNAME" \
--data password="$PASSWORD" \
| jq -r ".access_token"
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/revoke-token :
2021-05-12 14:23:54 -05:00
post :
summary : Logout
description : Revokes your access token and its associated refresh token, destroying your current session.
operationId : revokeOAuthToken
tags :
- Session
security :
- OAuth2 : [ ]
responses :
'200' :
description : successful operation
2023-01-19 02:27:56 -06:00
/api/v1/users/ask-send-verify-email :
2019-07-29 07:33:16 -05:00
post :
2023-01-19 02:27:56 -06:00
summary : Resend user verification link
operationId : resendEmailToVerifyUser
2019-07-29 07:33:16 -05:00
tags :
2020-04-21 05:09:54 -05:00
- Users
2021-05-12 14:23:54 -05:00
- Register
2023-01-19 02:27:56 -06:00
requestBody :
content :
application/json :
schema :
type : object
properties :
email :
type : string
description : User email
2023-02-23 08:40:13 -06:00
required :
- email
2019-07-29 07:33:16 -05:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2023-01-19 02:27:56 -06:00
/api/v1/users/registrations/ask-send-verify-email :
post :
summary : Resend verification link to registration email
operationId : resendEmailToVerifyRegistration
tags :
- Register
2019-07-29 07:33:16 -05:00
requestBody :
content :
application/json :
schema :
2023-01-19 02:27:56 -06:00
type : object
properties :
email :
type : string
description : Registration email
2023-02-23 08:40:13 -06:00
required :
- email
2023-01-19 02:27:56 -06:00
responses :
'204' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/{id}/verify-email:
2021-05-12 14:23:54 -05:00
post :
summary : Verify a user
2021-05-14 12:31:24 -05:00
operationId : verifyUser
2021-05-12 14:23:54 -05:00
description : |
Following a user registration, the new user will receive an email asking to click a link
2021-05-27 04:52:03 -05:00
containing a secret.
2023-01-19 02:27:56 -06:00
This endpoint can also be used to verify a new email set in the user account.
2021-05-12 14:23:54 -05:00
tags :
- Users
- Register
parameters :
- $ref : '#/components/parameters/id'
requestBody :
content :
application/json :
schema :
type : object
properties :
verificationString :
type : string
format : url
isPendingEmail :
type : boolean
required :
- verificationString
responses :
'204' :
description : successful operation
'403' :
description : invalid verification string
'404' :
description : user not found
2021-05-14 12:31:24 -05:00
2023-01-19 02:27:56 -06:00
/api/v1/users/registrations/{registrationId}/verify-email:
post :
summary : Verify a registration email
operationId : verifyRegistrationEmail
description : |
Following a user registration request, the user will receive an email asking to click a link
containing a secret.
tags :
- Register
parameters :
- $ref : '#/components/parameters/registrationId'
requestBody :
content :
application/json :
schema :
type : object
properties :
verificationString :
type : string
format : url
required :
- verificationString
responses :
'204' :
description : successful operation
'403' :
description : invalid verification string
'404' :
description : registration not found
2022-10-12 09:09:02 -05:00
/api/v1/users/{id}/two-factor/request:
2022-10-07 07:53:30 -05:00
post :
summary : Request two factor auth
operationId : requestTwoFactor
description : Request two factor authentication for a user
tags :
- Users
parameters :
- $ref : '#/components/parameters/id'
requestBody :
content :
application/json :
schema :
type : object
properties :
currentPassword :
type : string
description : Password of the currently authenticated user
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/RequestTwoFactorResponse'
'403' :
description : invalid password
'404' :
description : user not found
2022-10-12 09:09:02 -05:00
/api/v1/users/{id}/two-factor/confirm-request:
2022-10-07 07:53:30 -05:00
post :
summary : Confirm two factor auth
operationId : confirmTwoFactorRequest
description : Confirm a two factor authentication request
tags :
- Users
parameters :
- $ref : '#/components/parameters/id'
requestBody :
content :
application/json :
schema :
type : object
properties :
requestToken :
type : string
description : Token to identify the two factor request
otpToken :
type : string
description : OTP token generated by the app
required :
- requestToken
- otpToken
responses :
'204' :
description : successful operation
'403' :
description : invalid request token or OTP token
'404' :
description : user not found
2022-10-12 09:09:02 -05:00
/api/v1/users/{id}/two-factor/disable:
2022-10-07 07:53:30 -05:00
post :
summary : Disable two factor auth
operationId : disableTwoFactor
description : Disable two factor authentication of a user
tags :
- Users
parameters :
- $ref : '#/components/parameters/id'
requestBody :
content :
application/json :
schema :
type : object
properties :
currentPassword :
type : string
description : Password of the currently authenticated user
responses :
'204' :
description : successful operation
'403' :
description : invalid password
'404' :
description : user not found
2022-10-12 09:09:02 -05:00
/api/v1/users/me :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get my user information
2021-05-14 12:31:24 -05:00
operationId : getUserInfo
2018-04-16 03:48:17 -05:00
security :
2019-01-03 10:34:24 -06:00
- OAuth2 :
- user
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/User'
2018-01-24 03:44:52 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Update my user information
2021-05-14 12:31:24 -05:00
operationId : putUserInfo
2018-04-16 03:48:17 -05:00
security :
2019-01-03 10:34:24 -06:00
- OAuth2 :
- user
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2018-01-24 03:44:52 -06:00
responses :
'204' :
2019-08-14 03:53:31 -05:00
description : successful operation
2018-11-15 07:10:15 -06:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UpdateMe'
required : true
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/videos/imports :
2019-07-29 07:33:16 -05:00
get :
2020-04-21 05:09:54 -05:00
summary : Get video imports of my user
2019-07-29 07:33:16 -05:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2019-07-29 07:33:16 -05:00
tags :
2020-04-21 05:09:54 -05:00
- Videos
2019-07-29 07:33:16 -05:00
- My User
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2022-08-10 04:51:13 -05:00
-
name : targetUrl
in : query
required : false
description : Filter on import target URL
schema :
type : string
-
name : videoChannelSyncId
in : query
required : false
description : Filter on imports created by a specific channel synchronization
schema :
type : number
2022-08-10 07:56:53 -05:00
-
name : search
in : query
required : false
description : Search in video names
schema :
type : string
2019-07-29 07:33:16 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2021-05-10 04:02:54 -05:00
$ref : '#/components/schemas/VideoImportsList'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/video-quota-used :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get my user used quota
2018-04-16 03:48:17 -05:00
security :
2019-01-03 10:34:24 -06:00
- OAuth2 :
- user
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 03:26:50 -05:00
type : object
properties :
videoQuotaUsed :
type : number
2021-05-10 09:09:59 -05:00
description : The user video quota used so far in bytes
2021-05-10 03:26:50 -05:00
example : 16810141515
videoQuotaUsedDaily :
type : number
2021-05-10 09:09:59 -05:00
description : The user video quota used today in bytes
2021-05-10 03:26:50 -05:00
example : 1681014151
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/users/me/videos/{videoId}/rating' :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 08:24:19 -05:00
summary : Get rate of my user for a video
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2020-04-21 05:09:54 -05:00
- Video Rates
2018-01-24 03:44:52 -06:00
parameters :
- name : videoId
in : path
required : true
2021-05-10 09:09:59 -05:00
description : The video id
2018-11-15 07:10:15 -06:00
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/GetMeVideoRating'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/videos :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get videos of my user
2018-04-16 03:48:17 -05:00
security :
2019-01-03 10:34:24 -06:00
- OAuth2 :
- user
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2020-04-21 05:09:54 -05:00
- Videos
2018-02-17 12:24:56 -06:00
parameters :
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2019-05-24 03:17:54 -05:00
$ref : '#/components/schemas/VideoListResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/subscriptions :
2019-01-03 10:34:24 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get my user subscriptions
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2019-01-03 10:34:24 -06:00
tags :
2020-04-21 05:09:54 -05:00
- My Subscriptions
2019-01-03 10:34:24 -06:00
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
2021-05-10 07:39:01 -05:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannelList'
2019-01-03 10:34:24 -06:00
post :
2020-06-27 04:43:43 -05:00
tags :
- My Subscriptions
2020-04-21 05:09:54 -05:00
summary : Add subscription to my user
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2020-06-27 04:43:43 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
uri :
type : string
format : uri
description : uri of the video channels to subscribe to
required :
- uri
examples :
default :
value :
uri : 008a0e54-375d-49d0-8379-143202e24152@video.lqdn.fr
2019-01-03 10:34:24 -06:00
responses :
'200' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/subscriptions/exist :
2019-01-03 10:34:24 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get if subscriptions exist for my user
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2019-01-03 10:34:24 -06:00
tags :
2020-04-21 05:09:54 -05:00
- My Subscriptions
2019-01-03 10:34:24 -06:00
parameters :
- $ref : '#/components/parameters/subscriptionsUris'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/subscriptions/videos :
2019-01-03 10:34:24 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List videos of subscriptions of my user
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
- user
tags :
2020-04-21 05:09:54 -05:00
- My Subscriptions
- Videos
2019-01-03 10:34:24 -06:00
parameters :
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/categoryOneOf'
2021-05-03 04:06:19 -05:00
- $ref : '#/components/parameters/isLive'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/tagsOneOf'
- $ref : '#/components/parameters/tagsAllOf'
- $ref : '#/components/parameters/licenceOneOf'
- $ref : '#/components/parameters/languageOneOf'
- $ref : '#/components/parameters/nsfw'
2021-10-27 07:37:04 -05:00
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
2021-11-12 07:19:56 -06:00
- $ref : '#/components/parameters/privacyOneOf'
2021-11-03 05:32:41 -05:00
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/skipCount'
2019-01-03 10:34:24 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/videosSort'
2023-04-12 02:32:20 -05:00
- $ref : '#/components/parameters/excludeAlreadyWatched'
2019-01-03 10:34:24 -06:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2019-05-24 03:17:54 -05:00
$ref : '#/components/schemas/VideoListResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/users/me/subscriptions/{subscriptionHandle}' :
2019-01-03 10:34:24 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get subscription of my user
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2019-01-03 10:34:24 -06:00
tags :
2020-04-21 05:09:54 -05:00
- My Subscriptions
2019-07-03 10:28:09 -05:00
parameters :
- $ref : '#/components/parameters/subscriptionHandle'
2019-01-03 10:34:24 -06:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannel'
delete :
2020-04-21 05:09:54 -05:00
summary : Delete subscription of my user
2019-01-03 10:34:24 -06:00
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- user
2019-01-03 10:34:24 -06:00
tags :
2020-04-21 05:09:54 -05:00
- My Subscriptions
2019-07-03 10:28:09 -05:00
parameters :
- $ref : '#/components/parameters/subscriptionHandle'
2019-01-03 10:34:24 -06:00
responses :
'200' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/notifications :
2020-06-24 15:25:05 -05:00
get :
summary : List my notifications
security :
- OAuth2 : [ ]
tags :
- My Notifications
parameters :
- name : unread
in : query
description : only list unread notifications
schema :
type : boolean
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/NotificationListResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/notifications/read :
2020-06-24 15:25:05 -05:00
post :
summary : Mark notifications as read by their id
security :
- OAuth2 : [ ]
tags :
- My Notifications
requestBody :
content :
2020-06-27 04:43:43 -05:00
application/json :
2020-06-24 15:25:05 -05:00
schema :
type : object
properties :
ids :
type : array
description : ids of the notifications to mark as read
items :
type : integer
required :
- ids
responses :
'204' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/notifications/read-all :
2020-06-24 15:25:05 -05:00
post :
summary : Mark all my notification as read
security :
- OAuth2 : [ ]
tags :
- My Notifications
responses :
'204' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/notification-settings :
2020-06-24 15:25:05 -05:00
put :
summary : Update my notification settings
security :
- OAuth2 : [ ]
tags :
- My Notifications
requestBody :
content :
2020-06-27 04:43:43 -05:00
application/json :
2020-06-24 15:25:05 -05:00
schema :
type : object
properties :
newVideoFromSubscription :
$ref : '#/components/schemas/NotificationSettingValue'
newCommentOnMyVideo :
$ref : '#/components/schemas/NotificationSettingValue'
2020-07-07 07:34:16 -05:00
abuseAsModerator :
2020-06-24 15:25:05 -05:00
$ref : '#/components/schemas/NotificationSettingValue'
videoAutoBlacklistAsModerator :
$ref : '#/components/schemas/NotificationSettingValue'
blacklistOnMyVideo :
$ref : '#/components/schemas/NotificationSettingValue'
myVideoPublished :
$ref : '#/components/schemas/NotificationSettingValue'
myVideoImportFinished :
$ref : '#/components/schemas/NotificationSettingValue'
newFollow :
$ref : '#/components/schemas/NotificationSettingValue'
newUserRegistration :
$ref : '#/components/schemas/NotificationSettingValue'
commentMention :
$ref : '#/components/schemas/NotificationSettingValue'
newInstanceFollower :
$ref : '#/components/schemas/NotificationSettingValue'
autoInstanceFollowing :
$ref : '#/components/schemas/NotificationSettingValue'
responses :
'204' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/history/videos :
2020-11-25 17:27:59 -06:00
get :
summary : List watched videos history
security :
- OAuth2 : [ ]
tags :
- My History
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2021-01-13 02:16:15 -06:00
- $ref : '#/components/parameters/search'
2020-11-25 17:27:59 -06:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoListResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/history/videos/{videoId}:
2022-01-18 04:23:41 -06:00
delete :
summary : Delete history element
security :
- OAuth2 : [ ]
tags :
- My History
parameters :
- name : videoId
in : path
required : true
schema :
$ref : '#/components/schemas/Video/properties/id'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/users/me/history/videos/remove :
2020-11-25 17:27:59 -06:00
post :
summary : Clear video history
security :
- OAuth2 : [ ]
tags :
- My History
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
beforeDate :
description : history before this date will be deleted
type : string
format : date-time
responses :
'204' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/avatar/pick :
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Update my user avatar
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2019-07-29 07:33:16 -05:00
- My User
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-04-08 02:34:32 -05:00
type : object
properties :
2022-02-28 01:34:43 -06:00
avatars :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2020-11-23 03:45:42 -06:00
'413' :
description : image file too large
headers :
X-File-Maximum-Size :
schema :
type : string
format : Nginx size
description : Maximum file size for the avatar
2018-11-15 07:10:15 -06:00
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
avatarfile :
2021-05-10 09:09:59 -05:00
description : The file to upload
2018-11-15 07:10:15 -06:00
type : string
format : binary
encoding :
2019-08-21 01:32:15 -05:00
avatarfile :
2018-11-15 07:10:15 -06:00
contentType : image/png, image/jpeg
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/users/me/avatar :
2021-04-08 02:34:32 -05:00
delete :
summary : Delete my avatar
security :
- OAuth2 : [ ]
tags :
- My User
responses :
'204' :
description : successful operation
2023-01-19 02:27:56 -06:00
/api/v1/users/register :
post :
summary : Register a user
operationId : registerUser
description : Signup has to be enabled and signup approval is not required
tags :
- Register
responses :
'204' :
description : successful operation
'400' :
description : request error
'403' :
description : user registration is not enabled, user limit is reached, registration is not allowed for the ip, requires approval or blocked by a plugin
'409' :
description : 'a user with this username, channel name or email already exists'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/RegisterUser'
required : true
/api/v1/users/registrations/request :
post :
summary : Request registration
description : Signup has to be enabled and require approval on the instance
operationId : requestRegistration
tags :
- Register
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/UserRegistration'
'400' :
description : request error or signup approval is not enabled on the instance
'403' :
description : user registration is not enabled, user limit is reached, registration is not allowed for the ip or blocked by a plugin
'409' :
description : 'a user or registration with this username, channel name or email already exists'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UserRegistrationRequest'
/api/v1/users/registrations/{registrationId}/accept:
post :
security :
- OAuth2 :
- admin
- moderator
summary : Accept registration
operationId : acceptRegistration
tags :
- Register
parameters :
- $ref : '#/components/parameters/registrationId'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UserRegistrationAcceptOrReject'
responses :
'204' :
description : successful operation
/api/v1/users/registrations/{registrationId}/reject:
post :
security :
- OAuth2 :
- admin
- moderator
summary : Reject registration
operationId : rejectRegistration
tags :
- Register
parameters :
- $ref : '#/components/parameters/registrationId'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UserRegistrationAcceptOrReject'
responses :
'204' :
description : successful operation
/api/v1/users/registrations/{registrationId}:
delete :
security :
- OAuth2 :
- admin
- moderator
summary : Delete registration
description : 'Delete the registration entry. It will not remove the user associated with this registration (if any)'
operationId : deleteRegistration
tags :
- Register
parameters :
- $ref : '#/components/parameters/registrationId'
responses :
'204' :
description : successful operation
/api/v1/users/registrations :
get :
security :
- OAuth2 :
- admin
- moderator
summary : List registrations
operationId : listRegistrations
tags :
- Register
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- name : search
in : query
required : false
schema :
type : string
- name : sort
in : query
required : false
schema :
type : string
enum :
- -createdAt
- createdAt
- state
- -state
responses :
2023-02-16 09:24:47 -06:00
'200' :
2023-01-19 02:27:56 -06:00
description : successful operation
2023-02-16 09:24:47 -06:00
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/UserRegistration'
2023-01-19 02:27:56 -06:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/ownership :
2020-04-21 05:09:54 -05:00
get :
summary : List video ownership changes
tags :
- Video Ownership Change
security :
- OAuth2 : [ ]
responses :
'200' :
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/ownership/{id}/accept' :
2020-04-21 05:09:54 -05:00
post :
summary : Accept ownership change request
tags :
- Video Ownership Change
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 07:16:25 -05:00
'403' :
description : cannot terminate an ownership change of another user
'404' :
2022-02-01 09:38:07 -06:00
description : video ownership change not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/ownership/{id}/refuse' :
2020-04-21 05:09:54 -05:00
post :
summary : Refuse ownership change request
tags :
- Video Ownership Change
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 07:16:25 -05:00
'403' :
description : cannot terminate an ownership change of another user
'404' :
2022-02-01 09:38:07 -06:00
description : video ownership change not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/give-ownership' :
2020-04-21 05:09:54 -05:00
post :
summary : Request ownership change
tags :
- Video Ownership Change
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
required : true
content :
application/x-www-form-urlencoded :
schema :
type : object
properties :
username :
type : string
required :
- username
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-04-21 05:09:54 -05:00
'400' :
2020-06-24 07:16:25 -05:00
description : changing video ownership to a remote account is not supported yet
'404' :
description : video not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/token' :
post :
summary : Request video token
operationId : requestVideoToken
description : Request special tokens that expire quickly to use them in some context (like accessing private static files)
tags :
- Video
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2022-10-12 09:09:02 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoTokenResponse'
'400' :
description : incorrect parameters
'404' :
description : video not found
/api/v1/videos/{id}/studio/edit:
2022-08-01 08:48:14 -05:00
post :
summary : Create a studio task
tags :
- Video Transcoding
- Video
description : Create a task to edit a video (cut, add intro/outro etc)
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
required : true
content :
application/x-www-form-urlencoded :
schema :
$ref : '#/components/schemas/VideoStudioCreateTask'
responses :
'204' :
description : successful operation
'400' :
description : incorrect parameters
'404' :
description : video not found
2022-10-12 09:09:02 -05:00
/api/v1/videos :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List videos
2021-05-24 12:38:26 -05:00
operationId : getVideos
2018-01-24 03:44:52 -06:00
tags :
- Video
2018-02-17 12:24:56 -06:00
parameters :
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/categoryOneOf'
2021-05-03 04:06:19 -05:00
- $ref : '#/components/parameters/isLive'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/tagsOneOf'
- $ref : '#/components/parameters/tagsAllOf'
- $ref : '#/components/parameters/licenceOneOf'
- $ref : '#/components/parameters/languageOneOf'
- $ref : '#/components/parameters/nsfw'
2021-10-27 07:37:04 -05:00
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
2021-11-12 07:19:56 -06:00
- $ref : '#/components/parameters/privacyOneOf'
2021-11-03 05:32:41 -05:00
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/skipCount'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/videosSort'
2023-04-12 02:32:20 -05:00
- $ref : '#/components/parameters/excludeAlreadyWatched'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2019-05-24 03:17:54 -05:00
$ref : '#/components/schemas/VideoListResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/categories :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List available video categories
2021-05-10 07:17:26 -05:00
operationId : getCategories
2018-01-24 03:44:52 -06:00
tags :
- Video
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/videos/categories
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/licences :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List available video licences
2021-05-10 07:17:26 -05:00
operationId : getLicences
2018-01-24 03:44:52 -06:00
tags :
- Video
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/videos/licences
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/languages :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List available video languages
2021-05-10 07:17:26 -05:00
operationId : getLanguages
2018-01-24 03:44:52 -06:00
tags :
- Video
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/videos/languages
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/privacies :
2018-01-24 03:44:52 -06:00
get :
2021-05-10 07:17:26 -05:00
summary : List available video privacy policies
2023-03-31 02:12:21 -05:00
operationId : getVideoPrivacyPolicies
2018-01-24 03:44:52 -06:00
tags :
- Video
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/videos/privacies
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}' :
2018-01-24 03:44:52 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Update a video
2021-05-14 12:31:24 -05:00
operationId : putVideo
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
- Video
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-01-24 03:44:52 -06:00
responses :
2019-08-14 03:53:31 -05:00
'204' :
2018-01-24 03:44:52 -06:00
description : successful operation
2018-11-15 07:10:15 -06:00
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
thumbnailfile :
description : Video thumbnail file
type : string
2019-08-21 01:32:15 -05:00
format : binary
2018-11-15 07:10:15 -06:00
previewfile :
description : Video preview file
type : string
2019-08-21 01:32:15 -05:00
format : binary
2018-11-15 07:10:15 -06:00
category :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoCategorySet'
2018-11-15 07:10:15 -06:00
licence :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLicenceSet'
2018-11-15 07:10:15 -06:00
language :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2020-04-21 08:04:39 -05:00
privacy :
$ref : '#/components/schemas/VideoPrivacySet'
2018-11-15 07:10:15 -06:00
description :
description : Video description
type : string
waitTranscoding :
description : Whether or not we wait transcoding before publish the video
type : string
support :
2020-06-27 06:12:30 -05:00
description : A text tell the audience how to support the video creator
2021-05-12 06:44:32 -05:00
example : Please support our work on https://soutenir.framasoft.org/en/ <3
2018-11-15 07:10:15 -06:00
type : string
nsfw :
description : Whether or not this video contains sensitive content
2020-06-26 06:43:27 -05:00
type : boolean
2018-11-15 07:10:15 -06:00
name :
description : Video name
type : string
2021-05-03 05:17:30 -05:00
minLength : 3
maxLength : 120
2018-11-15 07:10:15 -06:00
tags :
2019-03-29 05:45:41 -05:00
description : Video tags (maximum 5 tags each between 2 and 30 characters)
2019-01-09 07:10:25 -06:00
type : array
2019-08-12 03:19:45 -05:00
minItems : 1
maxItems : 5
2019-01-09 07:10:25 -06:00
items :
type : string
2019-08-12 03:19:45 -05:00
minLength : 2
maxLength : 30
2018-11-15 07:10:15 -06:00
commentsEnabled :
description : Enable or disable comments for this video
2020-06-26 06:43:27 -05:00
type : boolean
2021-06-25 07:18:12 -05:00
downloadEnabled :
description : Enable or disable downloading for this video
type : boolean
2019-08-14 03:53:31 -05:00
originallyPublishedAt :
description : Date when the content was originally published
type : string
format : date-time
2019-06-11 03:01:13 -05:00
scheduleUpdate :
$ref : '#/components/schemas/VideoScheduledUpdate'
2023-06-29 02:48:55 -05:00
videoPasswords :
$ref : '#/components/schemas/AddVideoPasswords'
2019-08-21 01:32:15 -05:00
encoding :
thumbnailfile :
contentType : image/jpeg
previewfile :
contentType : image/jpeg
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get a video
2021-05-14 12:31:24 -05:00
operationId : getVideo
2018-01-24 03:44:52 -06:00
tags :
- Video
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2019-06-11 03:01:13 -05:00
$ref : '#/components/schemas/VideoDetails'
2023-06-29 02:48:55 -05:00
'403' :
description : provide a correct password to access this password protected video
2018-01-24 03:44:52 -06:00
delete :
2020-04-21 05:09:54 -05:00
summary : Delete a video
2021-05-14 12:31:24 -05:00
operationId : delVideo
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
- Video
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/description' :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get complete video description
2021-05-14 12:31:24 -05:00
operationId : getVideoDesc
2018-01-24 03:44:52 -06:00
tags :
- Video
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 09:09:59 -05:00
nullable : true
2018-11-15 07:10:15 -06:00
type : string
2021-05-10 09:09:59 -05:00
minLength : 3
maxLength : 10000
example : |
**[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)**
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/views' :
2018-01-24 03:44:52 -06:00
post :
2022-04-05 07:34:52 -05:00
summary : Notify user is watching a video
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.
2021-06-06 03:21:06 -05:00
operationId : addView
2018-01-24 03:44:52 -06:00
tags :
- Video
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2022-04-05 07:34:52 -05:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/UserViewingVideo'
required : true
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/watching' :
2018-11-16 05:11:00 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Set watching progress of a video
2022-04-05 07:34:52 -05:00
deprecated : true
description : This endpoint has been deprecated. Use `/videos/{id}/views` instead
2018-11-16 05:11:00 -06:00
tags :
- Video
security :
- OAuth2 : [ ]
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-11-16 05:11:00 -06:00
requestBody :
content :
application/json :
schema :
2022-04-05 07:34:52 -05:00
$ref : '#/components/schemas/UserViewingVideo'
2018-11-16 05:11:00 -06:00
required : true
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/stats/overall' :
2022-04-05 07:34:52 -05:00
get :
summary : Get overall stats of a video
tags :
- Video Stats
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
2022-05-05 07:12:57 -05:00
- name : startDate
in : query
description : Filter stats by start date
schema :
type : string
format : date-time
- name : endDate
in : query
description : Filter stats by end date
schema :
type : string
format : date-time
2022-04-05 07:34:52 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoStatsOverall'
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/stats/retention' :
2022-04-05 07:34:52 -05:00
get :
summary : Get retention stats of a video
tags :
- Video Stats
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoStatsRetention'
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/stats/timeseries/{metric}' :
2022-04-05 07:34:52 -05:00
get :
summary : Get timeserie stats of a video
tags :
- Video Stats
security :
- OAuth2 : [ ]
parameters :
- $ref : '#/components/parameters/idOrUUID'
-
name : metric
in : path
required : true
description : The metric to get
schema :
type : string
enum :
- 'viewers'
- 'aggregateWatchTime'
2022-05-05 07:12:57 -05:00
- name : startDate
in : query
description : Filter stats by start date
schema :
type : string
format : date-time
- name : endDate
in : query
description : Filter stats by end date
schema :
type : string
format : date-time
2022-04-05 07:34:52 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoStatsTimeserie'
2022-10-12 09:09:02 -05:00
/api/v1/videos/upload :
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Upload a video
2021-05-10 04:13:41 -05:00
description : Uses a single request to upload a video.
2021-05-10 07:17:26 -05:00
operationId : uploadLegacy
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
- Video
2021-05-10 04:13:41 -05:00
- Video Upload
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoUploadResponse'
2020-01-14 16:34:03 -06:00
'403' :
2020-12-08 14:16:10 -06:00
description : video didn't pass upload filter
2020-01-14 16:34:03 -06:00
'408' :
2020-06-26 06:43:27 -05:00
description : upload has timed out
2020-11-23 03:45:42 -06:00
'413' :
2021-06-06 03:21:06 -05:00
x-summary : video file too large, due to quota or max body size limit set by the reverse-proxy
description : |
If the response has no body, it means the reverse-proxy didn't let it through. Otherwise disambiguate via `type` :
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
- `quota_reached` for quota limits whether daily or global
2020-11-23 03:45:42 -06:00
headers :
X-File-Maximum-Size :
schema :
type : string
format : Nginx size
description : Maximum file size for the video
2020-12-08 14:16:10 -06:00
'415' :
description : video type unsupported
2020-01-14 16:34:03 -06:00
'422' :
2020-12-08 14:16:10 -06:00
description : video unreadable
2018-11-15 07:10:15 -06:00
requestBody :
content :
multipart/form-data :
schema :
2021-05-10 04:13:41 -05:00
$ref : '#/components/schemas/VideoUploadRequestLegacy'
2019-08-21 01:32:15 -05:00
encoding :
videofile :
contentType : video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
thumbnailfile :
contentType : image/jpeg
previewfile :
contentType : image/jpeg
2021-05-10 07:17:26 -05:00
x-codeSamples :
2018-11-15 10:08:42 -06:00
- lang : Shell
source : |
2020-07-28 06:48:55 -05:00
## DEPENDENCIES: jq
2018-11-15 10:08:42 -06:00
USERNAME="<your_username>"
PASSWORD="<your_password>"
FILE_PATH="<your_file_path>"
CHANNEL_ID="<your_channel_id>"
NAME="<video_name>"
2021-05-14 12:19:10 -05:00
API="https://peertube2.cpy.re/api/v1"
2018-11-15 10:08:42 -06:00
## AUTH
2021-05-14 12:19:10 -05:00
client_id=$(curl -s "$API/oauth-clients/local" | jq -r ".client_id")
client_secret=$(curl -s "$API/oauth-clients/local" | jq -r ".client_secret")
token=$(curl -s "$API/users/token" \
2020-07-28 06:48:55 -05:00
--data client_id="$client_id" \
--data client_secret="$client_secret" \
--data grant_type=password \
--data username="$USERNAME" \
--data password="$PASSWORD" \
2018-11-15 10:08:42 -06:00
| jq -r ".access_token")
2021-05-14 12:19:10 -05:00
2018-11-15 10:08:42 -06:00
## VIDEO UPLOAD
2021-05-14 12:19:10 -05:00
curl -s "$API/videos/upload" \
2020-07-28 06:48:55 -05:00
-H "Authorization: Bearer $token" \
--max-time 600 \
--form videofile=@"$FILE_PATH" \
--form channelId=$CHANNEL_ID \
--form name="$NAME"
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/upload-resumable :
2021-05-10 04:13:41 -05:00
post :
summary : Initialize the resumable upload of a video
description : Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video
2021-05-10 07:17:26 -05:00
operationId : uploadResumableInit
2021-05-10 04:13:41 -05:00
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
2023-07-19 09:02:49 -05:00
- $ref : '#/components/parameters/resumableUploadInitContentLengthHeader'
- $ref : '#/components/parameters/resumableUploadInitContentTypeHeader'
2021-05-10 04:13:41 -05:00
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/VideoUploadRequestResumable'
responses :
'200' :
description : file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
'201' :
description : created
headers :
Location :
schema :
type : string
format : url
example : /api/v1/videos/upload-resumable?upload_id=471e97554f21dec3b8bb5d4602939c51
Content-Length :
schema :
type : number
example : 0
'413' :
2021-06-06 03:21:06 -05:00
x-summary : video file too large, due to quota, absolute max file size or concurrent partial upload limit
description : |
Disambiguate via `type` :
- `max_file_size_reached` for the absolute file size limit
- `quota_reached` for quota limits whether daily or global
2021-05-10 04:13:41 -05:00
'415' :
description : video type unsupported
put :
summary : Send chunk for the resumable upload of a video
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
2021-05-10 07:17:26 -05:00
operationId : uploadResumable
2021-05-10 04:13:41 -05:00
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
2023-07-19 09:02:49 -05:00
- $ref : '#/components/parameters/resumableUploadId'
- $ref : '#/components/parameters/resumableUploadChunkContentRangeHeader'
- $ref : '#/components/parameters/resumableUploadChunkContentLengthHeader'
2021-05-10 04:13:41 -05:00
requestBody :
content :
application/octet-stream :
schema :
type : string
format : binary
responses :
'200' :
description : last chunk received
headers :
Content-Length :
schema :
type : number
content :
application/json :
schema :
$ref : '#/components/schemas/VideoUploadResponse'
'308' :
description : resume incomplete
headers :
Range :
schema :
type : string
example : bytes=0-262143
Content-Length :
schema :
type : number
example : 0
'403' :
description : video didn't pass upload filter
2021-06-06 03:21:06 -05:00
'404' :
description : upload not found
'409' :
description : chunk doesn't match range
2021-05-10 04:13:41 -05:00
'422' :
description : video unreadable
2021-06-06 03:21:06 -05:00
'429' :
description : too many concurrent requests
2021-10-25 10:42:20 -05:00
'503' :
description : upload is already being processed
headers :
'Retry-After' :
schema :
type : number
example : 300
2021-05-10 04:13:41 -05:00
delete :
summary : Cancel the resumable upload of a video, deleting any data uploaded so far
description : Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the upload of a video
2021-05-10 07:17:26 -05:00
operationId : uploadResumableCancel
2021-05-10 04:13:41 -05:00
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
2023-07-19 09:02:49 -05:00
- $ref : '#/components/parameters/resumableUploadId'
2021-05-10 04:13:41 -05:00
- name : Content-Length
in : header
required : true
schema :
type : number
example : 0
responses :
'204' :
description : upload cancelled
headers :
Content-Length :
schema :
type : number
example : 0
2021-06-06 03:21:06 -05:00
'404' :
description : upload not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/imports :
2019-02-19 10:56:09 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Import a video
description : Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
2021-05-10 07:17:26 -05:00
operationId : importVideo
2019-02-19 10:56:09 -06:00
security :
- OAuth2 : [ ]
tags :
2022-01-19 07:23:00 -06:00
- Video Imports
2021-05-10 04:13:41 -05:00
- Video Upload
2019-02-19 10:56:09 -06:00
requestBody :
content :
multipart/form-data :
schema :
2021-05-11 03:07:15 -05:00
$ref : '#/components/schemas/VideoCreateImport'
2019-08-21 01:32:15 -05:00
encoding :
torrentfile :
contentType : application/x-bittorrent
thumbnailfile :
contentType : image/jpeg
previewfile :
contentType : image/jpeg
2020-06-24 07:16:25 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoUploadResponse'
'400' :
description : '`magnetUri` or `targetUrl` or a torrent file missing'
2020-12-08 14:16:10 -06:00
'403' :
description : video didn't pass pre-import filter
'409' :
description : HTTP or Torrent/magnetURI import not enabled
2020-07-28 04:12:16 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/imports/{id}/cancel:
2022-01-19 07:23:00 -06:00
post :
summary : Cancel video import
description : Cancel a pending video import
security :
- OAuth2 : [ ]
tags :
- Video Imports
parameters :
- $ref : '#/components/parameters/id'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/videos/imports/{id}:
2022-01-19 07:23:00 -06:00
delete :
summary : Delete video import
description : Delete ended video import
security :
- OAuth2 : [ ]
tags :
- Video Imports
parameters :
- $ref : '#/components/parameters/id'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/videos/live :
2020-11-09 04:21:08 -06:00
post :
summary : Create a live
2021-05-24 12:38:26 -05:00
operationId : addLive
2020-11-09 04:21:08 -06:00
security :
- OAuth2 : [ ]
tags :
- Live Videos
- Video
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoUploadResponse'
2021-06-06 03:21:06 -05:00
'400' :
x-summary : validation error, or conflicting `saveReplay` and `permanentLive` parameter set
description : |
Disambiguate via `type` :
- default type for a validation error
- `live_conflicting_permanent_and_save_replay` for conflicting parameters set
2020-11-09 04:21:08 -06:00
'403' :
2021-06-06 03:21:06 -05:00
x-summary : live is not enabled, allow replay is not enabled, or max instance/user live videos limit is exceeded
description : |
Disambiguate via `type` :
- `live_not_enabled` for a disabled live feature
- `live_not_allowing_replay` for a disabled replay feature
- `max_instance_lives_limit_reached` for the absolute concurrent live limit
- `max_user_lives_limit_reached` for the user concurrent live limit
2020-11-09 04:21:08 -06:00
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
channelId :
description : Channel id that will contain this live video
type : integer
saveReplay :
type : boolean
2023-03-31 02:12:21 -05:00
replaySettings :
$ref : '#/components/schemas/LiveVideoReplaySettings'
2020-12-03 07:10:54 -06:00
permanentLive :
description : User can stream multiple times in a permanent live
type : boolean
2022-03-04 06:40:02 -06:00
latencyMode :
description : User can select live latency mode if enabled by the instance
$ref : '#/components/schemas/LiveVideoLatencyMode'
2020-11-09 04:21:08 -06:00
thumbnailfile :
description : Live video/replay thumbnail file
type : string
format : binary
previewfile :
description : Live video/replay preview file
type : string
format : binary
privacy :
$ref : '#/components/schemas/VideoPrivacySet'
category :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoCategorySet'
2020-11-09 04:21:08 -06:00
licence :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLicenceSet'
2020-11-09 04:21:08 -06:00
language :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2020-11-09 04:21:08 -06:00
description :
description : Live video/replay description
type : string
support :
description : A text tell the audience how to support the creator
2021-05-12 06:44:32 -05:00
example : Please support our work on https://soutenir.framasoft.org/en/ <3
2020-11-09 04:21:08 -06:00
type : string
nsfw :
description : Whether or not this live video/replay contains sensitive content
type : boolean
name :
description : Live video/replay name
type : string
2021-05-03 05:17:30 -05:00
minLength : 3
maxLength : 120
2020-11-09 04:21:08 -06:00
tags :
description : Live video/replay tags (maximum 5 tags each between 2 and 30 characters)
type : array
minItems : 1
maxItems : 5
items :
type : string
minLength : 2
maxLength : 30
commentsEnabled :
description : Enable or disable comments for this live video/replay
type : boolean
downloadEnabled :
2021-06-25 07:18:12 -05:00
description : Enable or disable downloading for the replay of this live video
2020-11-09 04:21:08 -06:00
type : boolean
required :
- channelId
- name
encoding :
thumbnailfile :
contentType : image/jpeg
previewfile :
contentType : image/jpeg
2022-10-12 09:09:02 -05:00
/api/v1/videos/live/{id}:
2020-11-09 04:21:08 -06:00
get :
2021-05-10 04:13:41 -05:00
summary : Get information about a live
2021-05-10 07:17:26 -05:00
operationId : getLiveId
2020-11-09 04:21:08 -06:00
security :
- OAuth2 : [ ]
tags :
- Live Videos
- Video
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/LiveVideoResponse'
put :
2021-05-10 04:13:41 -05:00
summary : Update information about a live
2021-05-10 07:17:26 -05:00
operationId : updateLiveId
2020-11-09 04:21:08 -06:00
security :
- OAuth2 : [ ]
tags :
- Live Videos
- Video
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/LiveVideoUpdate'
responses :
'204' :
2021-05-10 09:09:59 -05:00
description : successful operation
2020-11-09 04:21:08 -06:00
'400' :
2021-05-10 09:09:59 -05:00
description : bad parameters or trying to update a live that has already started
2020-11-09 04:21:08 -06:00
'403' :
2021-05-10 09:09:59 -05:00
description : trying to save replay of the live but saving replay is not enabled on the instance
2022-10-12 09:09:02 -05:00
/api/v1/videos/live/{id}/sessions:
2022-05-03 04:38:07 -05:00
get :
summary : List live sessions
description : List all sessions created in a particular live
security :
- OAuth2 : [ ]
tags :
- Live Videos
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/LiveVideoSessionResponse'
2022-10-12 09:09:02 -05:00
/api/v1/videos/{id}/live-session:
2022-05-03 04:38:07 -05:00
get :
summary : Get live session of a replay
description : If the video is a replay of a live, you can find the associated live session using this endpoint
security :
- OAuth2 : [ ]
tags :
- Live Videos
parameters :
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2022-05-03 04:38:07 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/LiveVideoSessionResponse'
2020-11-09 04:21:08 -06:00
2023-07-19 09:02:49 -05:00
'/api/v1/videos/{id}/source' :
get :
summary : Get video source file metadata
operationId : getVideoSource
tags :
- Video
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoSource'
'/api/v1/videos/{id}/source/replace-resumable' :
post :
summary : Initialize the resumable replacement of a video
2023-08-28 03:55:04 -05:00
description : "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the replacement of a video"
2023-07-19 09:02:49 -05:00
operationId : replaceVideoSourceResumableInit
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
- $ref : '#/components/parameters/resumableUploadInitContentLengthHeader'
- $ref : '#/components/parameters/resumableUploadInitContentTypeHeader'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/VideoReplaceSourceRequestResumable'
responses :
'200' :
description : file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead
'201' :
description : created
headers :
Location :
schema :
type : string
format : url
Content-Length :
schema :
type : number
example : 0
'413' :
x-summary : video file too large, due to quota, absolute max file size or concurrent partial upload limit
description : |
Disambiguate via `type` :
- `max_file_size_reached` for the absolute file size limit
- `quota_reached` for quota limits whether daily or global
'415' :
description : video type unsupported
put :
summary : Send chunk for the resumable replacement of a video
2023-08-28 03:55:04 -05:00
description : "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to continue, pause or resume the replacement of a video"
2023-07-19 09:02:49 -05:00
operationId : replaceVideoSourceResumable
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
- $ref : '#/components/parameters/resumableUploadId'
- $ref : '#/components/parameters/resumableUploadChunkContentRangeHeader'
- $ref : '#/components/parameters/resumableUploadChunkContentLengthHeader'
requestBody :
content :
application/octet-stream :
schema :
type : string
format : binary
responses :
'204' :
description: 'last chunk received : successful operation'
'308' :
description : resume incomplete
headers :
Range :
schema :
type : string
example : bytes=0-262143
Content-Length :
schema :
type : number
example : 0
'403' :
description : video didn't pass file replacement filter
'404' :
description : replace upload not found
'409' :
description : chunk doesn't match range
'422' :
description : video unreadable
'429' :
description : too many concurrent requests
'503' :
description : upload is already being processed
headers :
'Retry-After' :
schema :
type : number
example : 300
delete :
summary : Cancel the resumable replacement of a video
2023-08-28 03:55:04 -05:00
description : "**PeerTube >= 6.0** Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to cancel the replacement of a video"
2023-07-19 09:02:49 -05:00
operationId : replaceVideoSourceResumableCancel
security :
- OAuth2 : [ ]
tags :
- Video
- Video Upload
parameters :
- $ref : '#/components/parameters/resumableUploadId'
- name : Content-Length
in : header
required : true
schema :
type : number
example : 0
responses :
'204' :
description : source file replacement cancelled
headers :
Content-Length :
schema :
type : number
example : 0
'404' :
description : source file replacement not found
2022-10-12 09:09:02 -05:00
/api/v1/users/me/abuses :
2020-07-28 04:12:16 -05:00
get :
summary : List my abuses
2021-05-10 07:26:17 -05:00
operationId : getMyAbuses
2020-07-28 04:12:16 -05:00
security :
- OAuth2 : [ ]
tags :
- Abuses
- My User
parameters :
- name : id
in : query
description : only list the report with this id
schema :
type : integer
- name : state
in : query
schema :
$ref : '#/components/schemas/AbuseStateSet'
2021-05-10 07:26:17 -05:00
- $ref : '#/components/parameters/abusesSort'
2020-07-28 04:12:16 -05:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2021-05-10 07:26:17 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Abuse'
2020-07-28 04:12:16 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/abuses :
2018-01-24 03:44:52 -06:00
get :
2020-07-08 08:51:46 -05:00
summary : List abuses
2021-05-10 07:26:17 -05:00
operationId : getAbuses
2018-04-16 03:48:17 -05:00
security :
2020-04-21 05:09:54 -05:00
- OAuth2 :
2020-06-24 07:16:25 -05:00
- admin
- moderator
2018-01-24 03:44:52 -06:00
tags :
2020-07-08 08:51:46 -05:00
- Abuses
2018-02-17 12:24:56 -06:00
parameters :
2020-06-26 06:43:27 -05:00
- name : id
in : query
description : only list the report with this id
schema :
type : integer
- name : predefinedReason
in : query
description : predefined reason the listed reports should contain
schema :
2020-07-10 02:51:56 -05:00
$ref : '#/components/schemas/PredefinedAbuseReasons'
2020-06-26 06:43:27 -05:00
- name : search
in : query
description : plain search that will match with video titles, reporter names and more
schema :
type : string
- name : state
in : query
schema :
2020-07-28 04:12:16 -05:00
$ref : '#/components/schemas/AbuseStateSet'
2020-06-26 06:43:27 -05:00
- name : searchReporter
in : query
description : only list reports of a specific reporter
schema :
type : string
- name : searchReportee
description : only list reports of a specific reportee
in : query
schema :
type : string
- name : searchVideo
in : query
description : only list reports of a specific video
schema :
type : string
- name : searchVideoChannel
in : query
description : only list reports of a specific video channel
schema :
type : string
2020-07-10 02:39:53 -05:00
- name : videoIs
in : query
2021-06-06 03:21:06 -05:00
description : only list deleted or blocklisted videos
2020-07-10 02:39:53 -05:00
schema :
type : string
enum :
- 'deleted'
- 'blacklisted'
- name : filter
in : query
description : only list account, comment or video reports
schema :
type : string
enum :
- 'video'
- 'comment'
- 'account'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/abusesSort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 07:26:17 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Abuse'
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Report an abuse
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-07-08 08:51:46 -05:00
- Abuses
2020-04-21 08:24:19 -05:00
requestBody :
2020-06-22 06:00:39 -05:00
required : true
2020-04-21 08:24:19 -05:00
content :
application/json :
schema :
type : object
properties :
reason :
description : Reason why the user reports this video
type : string
2021-05-03 07:14:45 -05:00
minLength : 2
maxLength : 3000
2020-06-22 06:00:39 -05:00
predefinedReasons :
2020-07-10 02:51:56 -05:00
$ref : '#/components/schemas/PredefinedAbuseReasons'
video :
type : object
properties :
id :
description : Video id to report
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/Video/properties/id'
2020-07-10 02:51:56 -05:00
startAt :
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2020-07-10 02:51:56 -05:00
description : Timestamp in the video that marks the beginning of the report
minimum : 0
endAt :
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2020-07-10 02:51:56 -05:00
description : Timestamp in the video that marks the ending of the report
minimum : 0
comment :
type : object
properties :
id :
description : Comment id to report
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoComment/properties/id'
2020-07-10 02:51:56 -05:00
account :
type : object
properties :
id :
description : Account id to report
2021-05-10 09:09:59 -05:00
type : integer
2020-06-22 06:00:39 -05:00
required :
- reason
2020-04-21 08:24:19 -05:00
responses :
2021-05-13 16:37:35 -05:00
'200' :
2020-04-21 08:24:19 -05:00
description : successful operation
2021-05-13 16:37:35 -05:00
content :
application/json :
schema :
type : object
properties :
abuse :
type : object
properties :
id :
$ref : '#/components/schemas/id'
2020-06-26 06:43:27 -05:00
'400' :
description : incorrect request parameters
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/abuses/{abuseId}' :
2020-04-21 08:24:19 -05:00
put :
summary : Update an abuse
security :
- OAuth2 :
- admin
- moderator
tags :
2020-07-08 08:51:46 -05:00
- Abuses
2020-04-21 08:24:19 -05:00
parameters :
- $ref : '#/components/parameters/abuseId'
requestBody :
content :
application/json :
schema :
type : object
properties :
state :
2020-07-07 07:34:16 -05:00
$ref : '#/components/schemas/AbuseStateSet'
2020-04-21 08:24:19 -05:00
moderationComment :
type : string
2020-06-26 06:43:27 -05:00
description : Update the report comment visible only to the moderation team
2021-05-03 07:14:45 -05:00
minLength : 2
maxLength : 3000
2020-06-26 06:43:27 -05:00
responses :
'204' :
description : successful operation
'404' :
2020-07-08 08:51:46 -05:00
description : abuse not found
2020-04-21 08:24:19 -05:00
delete :
2020-06-26 06:43:27 -05:00
tags :
2020-07-08 08:51:46 -05:00
- Abuses
2020-04-21 08:24:19 -05:00
summary : Delete an abuse
security :
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
- moderator
2020-06-26 06:43:27 -05:00
parameters :
- $ref : '#/components/parameters/abuseId'
2020-04-21 08:24:19 -05:00
responses :
'204' :
description : successful operation
2020-06-24 07:16:25 -05:00
'404' :
description : block not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/abuses/{abuseId}/messages' :
2020-07-28 04:12:16 -05:00
get :
summary : List messages of an abuse
security :
- OAuth2 : [ ]
tags :
- Abuses
parameters :
- $ref : '#/components/parameters/abuseId'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2021-05-13 16:40:34 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/AbuseMessage'
2020-07-28 04:12:16 -05:00
post :
summary : Add message to an abuse
security :
- OAuth2 : [ ]
tags :
- Abuses
2020-08-03 01:59:41 -05:00
parameters :
- $ref : '#/components/parameters/abuseId'
2020-07-28 04:12:16 -05:00
requestBody :
required : true
content :
application/json :
schema :
type : object
properties :
message :
description : Message to send
type : string
2021-05-03 07:14:45 -05:00
minLength : 2
maxLength : 3000
2020-07-28 04:12:16 -05:00
required :
- message
responses :
'200' :
description : successful operation
'400' :
description : incorrect request parameters
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/abuses/{abuseId}/messages/{abuseMessageId}' :
2020-07-28 04:12:16 -05:00
delete :
summary : Delete an abuse message
security :
- OAuth2 : [ ]
tags :
- Abuses
parameters :
- $ref : '#/components/parameters/abuseId'
- $ref : '#/components/parameters/abuseMessageId'
responses :
'204' :
description : successful operation
2020-04-21 08:24:19 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/blacklist' :
2018-01-24 03:44:52 -06:00
post :
2020-06-24 07:16:25 -05:00
summary : Block a video
2021-05-14 12:31:24 -05:00
operationId : addVideoBlock
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
- moderator
2018-01-24 03:44:52 -06:00
tags :
2020-06-24 07:16:25 -05:00
- Video Blocks
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2018-01-24 03:44:52 -06:00
delete :
2020-06-24 07:16:25 -05:00
summary : Unblock a video by its id
2021-05-14 12:31:24 -05:00
operationId : delVideoBlock
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
- moderator
2018-01-24 03:44:52 -06:00
tags :
2020-06-24 07:16:25 -05:00
- Video Blocks
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 07:16:25 -05:00
'404' :
description : block not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/blacklist :
2018-01-24 03:44:52 -06:00
get :
2020-06-24 07:16:25 -05:00
tags :
- Video Blocks
2020-06-24 15:25:05 -05:00
summary : List video blocks
2021-05-14 12:31:24 -05:00
operationId : getVideoBlocks
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 :
2020-11-20 04:29:33 -06:00
- admin
- moderator
2018-02-17 12:24:56 -06:00
parameters :
2020-06-26 06:43:27 -05:00
- name : type
in : query
description : >
list only blocks that match this type :
- `1` : manual block
- `2` : automatic block that needs review
schema :
type : integer
enum :
- 1
- 2
- name : search
in : query
description : plain search that will match with video titles, and more
schema :
type : string
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/blacklistsSort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2020-06-26 06:43:27 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoBlacklist'
2021-05-14 12:31:24 -05:00
2023-06-01 07:51:16 -05:00
/api/v1/videos/{id}/storyboards:
get :
summary : List storyboards of a video
2023-08-28 03:55:04 -05:00
description : "**PeerTube** >= 6.0"
2023-06-01 07:51:16 -05:00
operationId : listVideoStoryboards
tags :
- Video
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
storyboards :
type : array
items :
$ref : '#/components/schemas/Storyboard'
2022-10-12 09:09:02 -05:00
/api/v1/videos/{id}/captions:
2019-05-24 03:01:08 -05:00
get :
2020-04-21 05:09:54 -05:00
summary : List captions of a video
2021-05-14 12:31:24 -05:00
operationId : getVideoCaptions
2019-05-24 03:01:08 -05:00
tags :
2020-06-25 04:14:43 -05:00
- Video Captions
2019-05-24 03:01:08 -05:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2019-05-24 03:01:08 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
2020-06-26 06:43:27 -05:00
example : 1
2019-05-24 03:01:08 -05:00
data :
type : array
items :
$ref : '#/components/schemas/VideoCaption'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/videos/{id}/captions/{captionLanguage}:
2019-05-24 03:01:08 -05:00
put :
summary : Add or replace a video caption
2021-05-14 12:31:24 -05:00
operationId : addVideoCaption
2020-11-20 04:29:33 -06:00
security :
- OAuth2 :
- user
2019-05-24 03:01:08 -05:00
tags :
2020-06-25 04:14:43 -05:00
- Video Captions
2019-05-24 03:01:08 -05:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2019-05-24 03:01:08 -05:00
- $ref : '#/components/parameters/captionLanguage'
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
captionfile :
description : The file to upload.
type : string
format : binary
2019-08-21 01:32:15 -05:00
encoding :
captionfile :
2020-01-09 07:10:23 -06:00
contentType : text/vtt, application/x-subrip, text/plain
2019-05-24 03:01:08 -05:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 07:16:25 -05:00
'404' :
description : video or language not found
2019-05-24 03:01:08 -05:00
delete :
summary : Delete a video caption
2021-05-14 12:31:24 -05:00
operationId : delVideoCaption
2020-11-20 04:29:33 -06:00
security :
- OAuth2 :
- user
2019-05-24 03:01:08 -05:00
tags :
2020-06-25 04:14:43 -05:00
- Video Captions
2019-05-24 03:01:08 -05:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2019-05-24 03:01:08 -05:00
- $ref : '#/components/parameters/captionLanguage'
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-24 07:16:25 -05:00
'404' :
description : video or language or caption for that language not found
2021-05-14 12:31:24 -05:00
2023-08-28 03:55:04 -05:00
/api/v1/videos/{id}/chapters:
get :
summary : Get chapters of a video
description : "**PeerTube** >= 6.0"
operationId : getVideoChapters
tags :
- Video Chapters
parameters :
- $ref : '#/components/parameters/idOrUUID'
- $ref : '#/components/parameters/videoPasswordHeader'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChapters'
put :
summary : Replace video chapters
description : "**PeerTube** >= 6.0"
operationId : replaceVideoChapters
security :
- OAuth2 :
- user
tags :
- Video Chapters
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
chapters :
type : array
items :
type : object
properties :
title :
type : string
timecode :
type : integer
responses :
'204' :
description : successful operation
'404' :
description : video not found
2023-06-29 02:48:55 -05:00
/api/v1/videos/{id}/passwords:
get :
summary : List video passwords
2023-08-28 03:55:04 -05:00
description : "**PeerTube** >= 6.0"
2023-06-29 02:48:55 -05:00
security :
- OAuth2 :
- user
tags :
- Video Passwords
parameters :
- $ref : '#/components/parameters/idOrUUID'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'204' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoPasswordList'
'400' :
description : video is not password protected
put :
summary : Update video passwords
2023-08-28 03:55:04 -05:00
description : "**PeerTube** >= 6.0"
2023-06-29 02:48:55 -05:00
security :
- OAuth2 :
- user
tags :
- Video Passwords
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
passwords :
2023-07-11 02:21:13 -05:00
$ref : '#/components/schemas/AddVideoPasswords'
2023-06-29 02:48:55 -05:00
responses :
'204' :
description : successful operation
'400' :
description : video is not password protected
/api/v1/videos/{id}/passwords/{videoPasswordId}:
delete :
summary : Delete a video password
2023-08-28 03:55:04 -05:00
description : "**PeerTube** >= 6.0"
2023-06-29 02:48:55 -05:00
security :
- OAuth2 :
- user
tags :
- Video Passwords
parameters :
- $ref : '#/components/parameters/idOrUUID'
- $ref : '#/components/parameters/videoPasswordId'
responses :
'204' :
description : successful operation
'403' :
description : cannot delete the last password of the protected video
'400' :
description : video is not password protected
2022-10-12 09:09:02 -05:00
/api/v1/video-channels :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List video channels
2021-05-12 06:44:32 -05:00
operationId : getVideoChannels
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
2018-02-17 12:24:56 -06:00
parameters :
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 07:39:01 -05:00
$ref : '#/components/schemas/VideoChannelList'
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Create a video channel
2021-05-14 12:31:24 -05:00
operationId : addVideoChannel
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
2018-01-24 03:44:52 -06:00
responses :
2022-08-10 02:53:39 -05:00
'200' :
2020-04-21 08:04:39 -05:00
description : successful operation
2021-05-12 06:44:32 -05:00
content :
application/json :
schema :
type : object
properties :
videoChannel :
type : object
properties :
id :
2022-02-28 01:34:43 -06:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
requestBody :
2019-05-31 09:30:11 -05:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannelCreate'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}' :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get a video channel
2021-05-12 06:44:32 -05:00
operationId : getVideoChannel
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
2018-01-24 03:44:52 -06:00
parameters :
2019-04-24 09:57:23 -05:00
- $ref : '#/components/parameters/channelHandle'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannel'
2018-01-24 03:44:52 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Update a video channel
2021-05-14 12:31:24 -05:00
operationId : putVideoChannel
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
2018-01-24 03:44:52 -06:00
parameters :
2019-04-24 09:57:23 -05:00
- $ref : '#/components/parameters/channelHandle'
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2018-11-15 07:10:15 -06:00
requestBody :
2019-05-31 09:30:11 -05:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannelUpdate'
2018-01-24 03:44:52 -06:00
delete :
2020-04-21 05:09:54 -05:00
summary : Delete a video channel
2021-05-14 12:31:24 -05:00
operationId : delVideoChannel
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
2018-01-24 03:44:52 -06:00
parameters :
2019-04-24 09:57:23 -05:00
- $ref : '#/components/parameters/channelHandle'
2018-04-25 09:15:39 -05:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/videos' :
2018-04-25 09:15:39 -05:00
get :
2020-04-21 05:09:54 -05:00
summary : List videos of a video channel
2021-05-14 12:31:24 -05:00
operationId : getVideoChannelVideos
2018-04-25 09:15:39 -05:00
tags :
2019-05-24 03:17:54 -05:00
- Video
2020-04-21 05:09:54 -05:00
- Video Channels
2018-04-25 09:15:39 -05:00
parameters :
2019-04-24 09:57:23 -05:00
- $ref : '#/components/parameters/channelHandle'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/categoryOneOf'
2021-05-03 04:06:19 -05:00
- $ref : '#/components/parameters/isLive'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/tagsOneOf'
- $ref : '#/components/parameters/tagsAllOf'
- $ref : '#/components/parameters/licenceOneOf'
- $ref : '#/components/parameters/languageOneOf'
- $ref : '#/components/parameters/nsfw'
2021-10-27 07:37:04 -05:00
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
2021-11-12 07:19:56 -06:00
- $ref : '#/components/parameters/privacyOneOf'
2021-11-03 05:32:41 -05:00
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/skipCount'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/videosSort'
2023-04-12 02:32:20 -05:00
- $ref : '#/components/parameters/excludeAlreadyWatched'
2018-01-24 03:44:52 -06:00
responses :
2018-04-25 09:15:39 -05:00
'200' :
2018-01-24 03:44:52 -06:00
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2019-05-24 03:17:54 -05:00
$ref : '#/components/schemas/VideoListResponse'
2021-05-14 12:31:24 -05:00
2023-02-23 08:39:09 -06:00
'/api/v1/video-channels/{channelHandle}/video-playlists' :
get :
summary : List playlists of a channel
tags :
- Video Playlists
- Video Channels
parameters :
- $ref : '#/components/parameters/channelHandle'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
- $ref : '#/components/parameters/videoPlaylistType'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoPlaylist'
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/followers' :
2021-10-19 08:02:43 -05:00
get :
tags :
- Video Channels
summary : 'List followers of a video channel'
security :
- OAuth2 : [ ]
operationId : getVideoChannelFollowers
parameters :
- $ref : '#/components/parameters/channelHandle'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/followersSort'
- $ref : '#/components/parameters/search'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Follow'
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/avatar/pick' :
2021-04-08 02:34:32 -05:00
post :
summary : Update channel avatar
security :
- OAuth2 : [ ]
tags :
- Video Channels
parameters :
- $ref : '#/components/parameters/channelHandle'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
2022-02-28 01:34:43 -06:00
avatars :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2021-04-08 02:34:32 -05:00
'413' :
description : image file too large
headers :
X-File-Maximum-Size :
schema :
type : string
format : Nginx size
description : Maximum file size for the avatar
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
avatarfile :
description : The file to upload.
type : string
format : binary
encoding :
avatarfile :
contentType : image/png, image/jpeg
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/avatar' :
2021-04-08 02:34:32 -05:00
delete :
summary : Delete channel avatar
security :
- OAuth2 : [ ]
tags :
- Video Channels
parameters :
- $ref : '#/components/parameters/channelHandle'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/banner/pick' :
2021-04-08 02:34:32 -05:00
post :
summary : Update channel banner
security :
- OAuth2 : [ ]
tags :
- Video Channels
parameters :
- $ref : '#/components/parameters/channelHandle'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
2022-02-28 01:34:43 -06:00
banners :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2021-04-08 02:34:32 -05:00
'413' :
description : image file too large
headers :
X-File-Maximum-Size :
schema :
type : string
format : Nginx size
description : Maximum file size for the banner
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
bannerfile :
description : The file to upload.
type : string
format : binary
encoding :
bannerfile :
contentType : image/png, image/jpeg
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/banner' :
2021-04-08 02:34:32 -05:00
delete :
summary : Delete channel banner
security :
- OAuth2 : [ ]
tags :
- Video Channels
parameters :
- $ref : '#/components/parameters/channelHandle'
responses :
'204' :
description : successful operation
2020-04-21 08:04:39 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/video-channels/{channelHandle}/import-videos' :
2022-08-10 07:56:53 -05:00
post :
summary : Import videos in channel
description : Import a remote channel/playlist videos into a channel
security :
- OAuth2 : [ ]
tags :
- Video Channels
- Channels Sync
parameters :
- $ref : '#/components/parameters/channelHandle'
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/ImportVideosInChannelCreate'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'/api/v1/video-channel-syncs' :
2022-08-10 02:53:39 -05:00
post :
summary : Create a synchronization for a video channel
operationId : addVideoChannelSync
security :
- OAuth2 : [ ]
tags :
- Channels Sync
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannelSyncCreate'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
videoChannelSync :
$ref : "#/components/schemas/VideoChannelSync"
2022-10-12 09:09:02 -05:00
'/api/v1/video-channel-syncs/{channelSyncId}' :
2022-08-10 02:53:39 -05:00
delete :
summary : Delete a video channel synchronization
operationId : delVideoChannelSync
security :
- OAuth2 : [ ]
tags :
- Channels Sync
parameters :
- $ref : '#/components/parameters/channelSyncId'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'/api/v1/video-channel-syncs/{channelSyncId}/sync' :
2022-08-10 02:53:39 -05:00
post :
summary : Triggers the channel synchronization job, fetching all the videos from the remote channel
operationId : triggerVideoChannelSync
security :
- OAuth2 : [ ]
tags :
- Channels Sync
parameters :
- $ref : '#/components/parameters/channelSyncId'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists/privacies :
2020-04-21 08:04:39 -05:00
get :
2021-05-10 07:17:26 -05:00
summary : List available playlist privacy policies
operationId : getPlaylistPrivacyPolicies
2020-04-21 08:04:39 -05:00
tags :
- Video Playlists
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
examples :
nightly :
externalValue : https://peertube2.cpy.re/api/v1/video-playlists/privacies
2020-04-21 08:04:39 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists :
2019-12-27 10:52:53 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List video playlists
2021-05-10 07:17:26 -05:00
operationId : getPlaylists
2019-12-27 10:52:53 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Playlists
2019-12-27 10:52:53 -06:00
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2023-02-23 08:39:09 -06:00
- $ref : '#/components/parameters/videoPlaylistType'
2019-12-27 10:52:53 -06:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2020-06-26 06:43:27 -05:00
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoPlaylist'
2020-04-21 08:04:39 -05:00
post :
summary : Create a video playlist
2021-05-10 09:09:59 -05:00
description : If the video playlist is set as public, `videoChannelId` is mandatory.
2021-05-24 12:38:26 -05:00
operationId : addPlaylist
2020-04-21 08:04:39 -05:00
security :
- OAuth2 : [ ]
tags :
- Video Playlists
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
videoPlaylist :
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoPlaylist/properties/id'
2020-04-21 08:04:39 -05:00
uuid :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoPlaylist/properties/uuid'
2021-06-28 10:30:59 -05:00
shortUUID :
$ref : '#/components/schemas/VideoPlaylist/properties/shortUUID'
2020-04-21 08:04:39 -05:00
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
displayName :
description : Video playlist display name
type : string
2021-05-03 05:17:30 -05:00
minLength : 1
maxLength : 120
2020-04-21 08:04:39 -05:00
thumbnailfile :
description : Video playlist thumbnail file
type : string
format : binary
privacy :
$ref : '#/components/schemas/VideoPlaylistPrivacySet'
description :
description : Video playlist description
type : string
2021-05-10 09:09:59 -05:00
minLength : 3
maxLength : 1000
2020-04-21 08:04:39 -05:00
videoChannelId :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/id'
2020-04-21 08:04:39 -05:00
description : Video channel in which the playlist will be published
required :
- displayName
2020-06-27 04:43:43 -05:00
encoding :
thumbnailfile :
contentType : image/jpeg
2020-04-21 08:04:39 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists/{playlistId}:
2020-04-21 08:04:39 -05:00
get :
summary : Get a video playlist
tags :
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoPlaylist'
put :
summary : Update a video playlist
description : 'If the video playlist is set as public, the playlist must have a assigned channel.'
security :
- OAuth2 : [ ]
tags :
- Video Playlists
responses :
'204' :
description : successful operation
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
requestBody :
content :
multipart/form-data :
schema :
type : object
properties :
displayName :
description : Video playlist display name
type : string
2021-05-03 05:17:30 -05:00
minLength : 1
maxLength : 120
2020-04-21 08:04:39 -05:00
thumbnailfile :
description : Video playlist thumbnail file
type : string
format : binary
privacy :
$ref : '#/components/schemas/VideoPlaylistPrivacySet'
description :
description : Video playlist description
type : string
videoChannelId :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/id'
2020-04-21 08:04:39 -05:00
description : Video channel in which the playlist will be published
2020-06-27 04:43:43 -05:00
encoding :
thumbnailfile :
contentType : image/jpeg
2020-04-21 08:04:39 -05:00
delete :
summary : Delete a video playlist
security :
- OAuth2 : [ ]
tags :
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists/{playlistId}/videos:
2020-04-21 08:04:39 -05:00
get :
summary : 'List videos of a playlist'
2021-05-24 12:38:26 -05:00
operationId : getVideoPlaylistVideos
2020-04-21 08:04:39 -05:00
tags :
- Videos
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2021-10-19 12:22:45 -05:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2020-04-21 08:04:39 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoListResponse'
post :
2021-05-12 07:33:04 -05:00
summary : Add a video in a playlist
2021-05-24 12:38:26 -05:00
operationId : addVideoPlaylistVideo
2020-04-21 08:04:39 -05:00
security :
- OAuth2 : [ ]
tags :
- Videos
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
videoPlaylistElement :
type : object
properties :
id :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
example : 2
2020-04-21 08:04:39 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
videoId :
2021-05-12 07:33:04 -05:00
oneOf :
- $ref : '#/components/schemas/Video/properties/uuid'
2021-05-10 09:09:59 -05:00
- $ref : '#/components/schemas/Video/properties/id'
description : Video to add in the playlist
2020-04-21 08:04:39 -05:00
startTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
description : Start the video at this specific timestamp
2020-04-21 08:04:39 -05:00
stopTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
description : Stop the video at this specific timestamp
2020-04-21 08:04:39 -05:00
required :
- videoId
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists/{playlistId}/videos/reorder:
2020-04-21 08:04:39 -05:00
post :
summary : 'Reorder a playlist'
2021-05-24 12:38:26 -05:00
operationId : reorderVideoPlaylist
2020-04-21 08:04:39 -05:00
security :
- OAuth2 : [ ]
tags :
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
responses :
'204' :
description : successful operation
requestBody :
content :
application/json :
schema :
type : object
properties :
startPosition :
2020-06-24 07:16:25 -05:00
type : integer
description : 'Start position of the element to reorder'
minimum : 1
2020-04-21 08:04:39 -05:00
insertAfterPosition :
2020-06-24 07:16:25 -05:00
type : integer
description : 'New position for the block to reorder, to add the block before the first element'
minimum : 0
2020-04-21 08:04:39 -05:00
reorderLength :
2020-06-24 07:16:25 -05:00
type : integer
description : 'How many element from `startPosition` to reorder'
minimum : 1
2020-04-21 08:04:39 -05:00
required :
- startPosition
- insertAfterPosition
2022-10-12 09:09:02 -05:00
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}:
2020-04-21 08:04:39 -05:00
put :
2021-05-12 07:33:04 -05:00
summary : Update a playlist element
2021-05-24 12:38:26 -05:00
operationId : putVideoPlaylistVideo
2020-04-21 08:04:39 -05:00
security :
- OAuth2 : [ ]
tags :
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
- $ref : '#/components/parameters/playlistElementId'
responses :
'204' :
description : successful operation
requestBody :
content :
application/json :
schema :
type : object
properties :
startTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
description : Start the video at this specific timestamp
2020-04-21 08:04:39 -05:00
stopTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
description : Stop the video at this specific timestamp
2020-04-21 08:04:39 -05:00
delete :
2021-05-12 07:33:04 -05:00
summary : Delete an element from a playlist
2021-05-24 12:38:26 -05:00
operationId : delVideoPlaylistVideo
2020-04-21 08:04:39 -05:00
security :
- OAuth2 : [ ]
tags :
- Video Playlists
parameters :
2021-05-12 07:33:04 -05:00
- $ref : '#/components/parameters/playlistId'
2020-04-21 08:04:39 -05:00
- $ref : '#/components/parameters/playlistElementId'
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'/api/v1/users/me/video-playlists/videos-exist' :
2020-04-21 09:41:31 -05:00
get :
2021-05-12 07:33:04 -05:00
summary : Check video exists in my playlists
2020-04-21 09:41:31 -05:00
security :
- OAuth2 : [ ]
tags :
- Video Playlists
parameters :
- name : videoIds
in : query
required : true
description : The video ids to check
schema :
type : array
items :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2020-04-21 09:41:31 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
videoId :
type : array
items :
type : object
properties :
playlistElementId :
2020-06-24 07:16:25 -05:00
type : integer
2020-04-21 09:41:31 -05:00
playlistId :
2020-06-24 07:16:25 -05:00
type : integer
2020-04-21 09:41:31 -05:00
startTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2020-04-21 09:41:31 -05:00
stopTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2023-02-23 08:39:09 -06:00
'/api/v1/accounts/{name}/video-playlists' :
get :
summary : List playlists of an account
tags :
- Video Playlists
- Accounts
parameters :
- $ref : '#/components/parameters/name'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
- $ref : '#/components/parameters/search'
- $ref : '#/components/parameters/videoPlaylistType'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoPlaylist'
2020-04-21 09:41:31 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/accounts/{name}/video-channels' :
2018-04-25 03:21:38 -05:00
get :
2020-04-21 05:09:54 -05:00
summary : List video channels of an account
2018-04-25 03:21:38 -05:00
tags :
2020-04-21 05:09:54 -05:00
- Video Channels
- Accounts
2018-04-25 03:21:38 -05:00
parameters :
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/name'
2020-06-26 06:43:27 -05:00
- name : withStats
in : query
2022-05-31 09:01:11 -05:00
description : include daily view statistics for the last 30 days and total views (only if authentified as the account user)
2020-06-26 06:43:27 -05:00
schema :
type : boolean
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2018-04-25 03:21:38 -05:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2021-05-10 07:39:01 -05:00
$ref : '#/components/schemas/VideoChannelList'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/accounts/{name}/video-channel-syncs' :
2022-08-10 02:53:39 -05:00
get :
summary : List the synchronizations of video channels of an account
tags :
- Video Channels
- Channels Sync
- Accounts
parameters :
- $ref : '#/components/parameters/name'
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/VideoChannelSyncList'
2022-10-12 09:09:02 -05:00
'/api/v1/accounts/{name}/ratings' :
2019-04-09 04:02:02 -05:00
get :
2020-04-21 05:09:54 -05:00
summary : List ratings of an account
2019-04-09 04:02:02 -05:00
security :
- OAuth2 : [ ]
tags :
2020-04-21 05:09:54 -05:00
- Accounts
2019-04-09 04:02:02 -05:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/name'
2019-04-09 04:02:02 -05:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
- name : rating
in : query
required : false
2019-08-07 03:26:46 -05:00
description : Optionally filter which ratings to retrieve
2019-04-09 04:02:02 -05:00
schema :
type : string
enum :
- like
- dislike
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : array
items :
$ref : '#/components/schemas/VideoRating'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/comment-threads' :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : List threads of a video
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Comments
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2019-12-27 10:52:53 -06:00
- $ref : '#/components/parameters/commentsSort'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/CommentThreadResponse'
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Create a thread
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Comments
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/CommentThreadPostResponse'
2020-06-27 04:43:43 -05:00
'404' :
description : video does not exist
2020-04-21 08:28:17 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
text :
2021-05-11 13:19:26 -05:00
allOf :
- $ref : '#/components/schemas/VideoComment/properties/text'
format : markdown
maxLength : 10000
2020-04-21 08:28:17 -05:00
required :
- text
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/comment-threads/{threadId}' :
2018-01-24 03:44:52 -06:00
get :
2020-04-21 05:09:54 -05:00
summary : Get a thread
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Comments
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
- $ref : '#/components/parameters/threadId'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/VideoCommentThreadTree'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/comments/{commentId}' :
2018-01-24 03:44:52 -06:00
post :
2020-04-21 05:09:54 -05:00
summary : Reply to a thread of a video
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Comments
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/commentId'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2018-01-24 03:44:52 -06:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
$ref : '#/components/schemas/CommentThreadPostResponse'
2020-06-27 04:43:43 -05:00
'404' :
description : thread or video does not exist
2020-04-21 08:28:17 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
text :
2021-05-11 13:19:26 -05:00
allOf :
- $ref : '#/components/schemas/VideoComment/properties/text'
format : markdown
maxLength : 10000
2020-04-21 08:28:17 -05:00
required :
- text
2018-01-24 03:44:52 -06:00
delete :
2020-04-21 05:09:54 -05:00
summary : Delete a comment or a reply
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Comments
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/commentId'
2018-01-24 03:44:52 -06:00
responses :
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-26 06:43:27 -05:00
'403' :
description : cannot remove comment of another user
'404' :
description : comment or video does not exist
'409' :
description : comment is already deleted
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/rate' :
2018-01-24 03:44:52 -06:00
put :
2020-04-21 05:09:54 -05:00
summary : Like/dislike a video
2018-04-16 03:48:17 -05:00
security :
2018-11-15 07:10:15 -06:00
- OAuth2 : [ ]
2018-01-24 03:44:52 -06:00
tags :
2020-04-21 05:09:54 -05:00
- Video Rates
2018-01-24 03:44:52 -06:00
parameters :
2019-07-03 10:28:09 -05:00
- $ref : '#/components/parameters/idOrUUID'
2023-06-29 02:48:55 -05:00
- $ref : '#/components/parameters/videoPasswordHeader'
2021-05-11 14:44:27 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
rating :
type : string
enum :
- like
- dislike
2021-05-12 06:44:32 -05:00
required :
- rating
2018-01-24 03:44:52 -06:00
responses :
2021-11-18 07:35:08 -06:00
'204' :
description : successful operation
'404' :
description : video does not exist
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/hls' :
2021-11-18 07:35:08 -06:00
delete :
summary : Delete video HLS files
security :
- OAuth2 :
- admin
tags :
- Video Files
operationId : delVideoHLS
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'204' :
description : successful operation
'404' :
description : video does not exist
2023-07-11 02:21:13 -05:00
'/api/v1/videos/{id}/web-videos' :
2021-11-18 07:35:08 -06:00
delete :
2023-07-11 02:21:13 -05:00
summary : Delete video Web Video files
2021-11-18 07:35:08 -06:00
security :
- OAuth2 :
- admin
tags :
- Video Files
2023-07-11 02:21:13 -05:00
operationId : delVideoWebVideos
2021-11-18 07:35:08 -06:00
parameters :
- $ref : '#/components/parameters/idOrUUID'
responses :
'204' :
description : successful operation
'404' :
description : video does not exist
2022-10-12 09:09:02 -05:00
'/api/v1/videos/{id}/transcoding' :
2021-11-18 07:35:08 -06:00
post :
summary : Create a transcoding job
security :
- OAuth2 :
- admin
tags :
- Video Transcoding
operationId : createVideoTranscoding
parameters :
- $ref : '#/components/parameters/idOrUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
transcodingType :
type : string
enum :
- hls
2023-07-11 02:21:13 -05:00
- web-video
2023-07-28 04:07:03 -05:00
forceTranscoding :
type : boolean
default : false
description : If the video is stuck in transcoding state, do it anyway
2021-11-18 07:35:08 -06:00
required :
- transcodingType
responses :
2018-01-24 03:44:52 -06:00
'204' :
2020-04-21 08:04:39 -05:00
description : successful operation
2020-06-27 04:43:43 -05:00
'404' :
description : video does not exist
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/search/videos :
2018-07-28 13:38:49 -05:00
get :
tags :
- Search
2020-04-21 05:09:54 -05:00
summary : Search videos
2021-05-24 12:38:26 -05:00
operationId : searchVideos
2018-07-28 13:38:49 -05:00
parameters :
2020-06-26 06:43:27 -05:00
- name : search
in : query
required : true
allowEmptyValue : false
description : >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete video information and interact with it.
schema :
type : string
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/categoryOneOf'
2021-05-03 04:06:19 -05:00
- $ref : '#/components/parameters/isLive'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/tagsOneOf'
- $ref : '#/components/parameters/tagsAllOf'
- $ref : '#/components/parameters/licenceOneOf'
- $ref : '#/components/parameters/languageOneOf'
- $ref : '#/components/parameters/nsfw'
2021-10-27 07:37:04 -05:00
- $ref : '#/components/parameters/isLocal'
- $ref : '#/components/parameters/include'
2021-11-12 07:19:56 -06:00
- $ref : '#/components/parameters/privacyOneOf'
2022-11-23 08:47:30 -06:00
- $ref : '#/components/parameters/uuids'
2021-11-03 05:32:41 -05:00
- $ref : '#/components/parameters/hasHLSFiles'
2023-07-11 02:21:13 -05:00
- $ref : '#/components/parameters/hasWebVideoFiles'
2020-04-21 09:03:51 -05:00
- $ref : '#/components/parameters/skipCount'
2018-11-15 07:10:15 -06:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2020-06-10 08:18:15 -05:00
- $ref : '#/components/parameters/searchTarget'
2018-11-24 11:18:56 -06:00
- $ref : '#/components/parameters/videosSearchSort'
2023-04-12 02:32:20 -05:00
- $ref : '#/components/parameters/excludeAlreadyWatched'
2020-06-10 08:18:15 -05:00
- name : startDate
in : query
description : Get videos that are published after this date
schema :
type : string
format : date-time
- name : endDate
in : query
description : Get videos that are published before this date
schema :
type : string
format : date-time
- name : originallyPublishedStartDate
in : query
description : Get videos that are originally published after this date
2018-11-15 07:10:15 -06:00
schema :
type : string
2020-06-10 08:18:15 -05:00
format : date-time
- name : originallyPublishedEndDate
in : query
description : Get videos that are originally published before this date
schema :
type : string
format : date-time
- name : durationMin
in : query
description : Get videos that have this minimum duration
schema :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-10 08:18:15 -05:00
- name : durationMax
in : query
description : Get videos that have this maximum duration
schema :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-27 04:43:43 -05:00
callbacks :
'searchTarget === search-index' :
$ref : '#/components/callbacks/searchIndex'
2018-07-28 13:38:49 -05:00
responses :
'200' :
description : successful operation
2018-11-15 07:10:15 -06:00
content :
application/json :
schema :
2019-05-24 03:17:54 -05:00
$ref : '#/components/schemas/VideoListResponse'
2020-06-27 04:43:43 -05:00
'500' :
description : search index unavailable
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/search/video-channels :
2020-06-10 08:18:15 -05:00
get :
tags :
- Search
summary : Search channels
2021-05-24 12:38:26 -05:00
operationId : searchChannels
2020-06-10 08:18:15 -05:00
parameters :
- name : search
in : query
required : true
description : >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete channel information and interact with it.
schema :
type : string
2020-06-26 06:43:27 -05:00
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/searchTarget'
- $ref : '#/components/parameters/sort'
2020-06-27 04:43:43 -05:00
callbacks :
'searchTarget === search-index' :
$ref : '#/components/callbacks/searchIndex'
2020-06-10 08:18:15 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2021-05-10 07:39:01 -05:00
$ref : '#/components/schemas/VideoChannelList'
2020-06-27 04:43:43 -05:00
'500' :
description : search index unavailable
2021-06-17 09:02:38 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/search/video-playlists :
2021-06-17 09:02:38 -05:00
get :
tags :
- Search
summary : Search playlists
operationId : searchPlaylists
parameters :
- name : search
in : query
required : true
description : >
String to search. If the user can make a remote URI search, and the string is an URI then the
PeerTube instance will fetch the remote object and add it to its database. Then,
you can use the REST API to fetch the complete playlist information and interact with it.
schema :
type : string
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/searchTarget'
- $ref : '#/components/parameters/sort'
callbacks :
'searchTarget === search-index' :
$ref : '#/components/callbacks/searchIndex'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoPlaylist'
'500' :
description : search index unavailable
2021-05-13 07:19:59 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/blocklist/status :
2021-12-07 04:30:53 -06:00
get :
tags :
- Account Blocks
- Server Blocks
summary : Get block status of accounts/hosts
parameters :
-
name : 'accounts'
in : query
description : 'Check if these accounts are blocked'
example : [ 'goofy@example.com' , 'donald@example.com' ]
schema :
type : array
items :
type : string
-
name : 'hosts'
in : query
description : 'Check if these hosts are blocked'
example : [ 'example.com' ]
schema :
type : array
items :
type : string
responses :
'200' :
description : successful operation
2022-10-12 09:09:02 -05:00
content :
'application/json' :
schema :
$ref : '#/components/schemas/BlockStatus'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/server/blocklist/accounts :
2020-06-25 04:14:43 -05:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Account Blocks
summary : List account blocks
2020-06-25 04:14:43 -05:00
security :
- OAuth2 :
- admin
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
2022-10-12 09:09:02 -05:00
- $ref : '#/components/parameters/sort'
2020-06-25 04:14:43 -05:00
responses :
'200' :
description : successful operation
post :
tags :
2022-10-12 09:09:02 -05:00
- Account Blocks
summary : Block an account
2020-06-25 04:14:43 -05:00
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
type : object
properties :
2022-10-12 09:09:02 -05:00
accountName :
type : string
example : chocobozzz@example.org
description : account to block, in the form `username@domain`
2020-06-25 04:14:43 -05:00
required :
2022-10-12 09:09:02 -05:00
- accountName
2020-06-25 04:14:43 -05:00
responses :
2022-10-12 09:09:02 -05:00
'200' :
2020-06-25 04:14:43 -05:00
description : successful operation
'409' :
2022-10-12 09:09:02 -05:00
description : self-blocking forbidden
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/blocklist/accounts/{accountName}' :
2020-06-25 04:14:43 -05:00
delete :
tags :
2022-10-12 09:09:02 -05:00
- Account Blocks
summary : Unblock an account by its handle
2020-06-25 04:14:43 -05:00
security :
- OAuth2 :
- admin
parameters :
2022-10-12 09:09:02 -05:00
- name : accountName
2020-06-25 04:14:43 -05:00
in : path
required : true
2022-10-12 09:09:02 -05:00
description : account to unblock, in the form `username@domain`
2020-06-25 04:14:43 -05:00
schema :
type : string
responses :
2022-10-12 09:09:02 -05:00
'201' :
2020-06-25 04:14:43 -05:00
description : successful operation
'404' :
2022-10-12 09:09:02 -05:00
description : account or account block does not exist
2021-05-13 07:19:59 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/server/blocklist/servers :
2022-07-12 07:17:37 -05:00
get :
tags :
2022-10-12 09:09:02 -05:00
- Server Blocks
summary : List server blocks
security :
- OAuth2 :
- admin
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
2022-07-12 07:17:37 -05:00
responses :
'200' :
description : successful operation
2022-07-15 08:30:14 -05:00
post :
tags :
2022-10-12 09:09:02 -05:00
- Server Blocks
summary : Block a server
security :
- OAuth2 :
- admin
2022-07-15 08:30:14 -05:00
requestBody :
content :
application/json :
schema :
2022-10-12 09:09:02 -05:00
type : object
properties :
host :
type : string
format : hostname
description : server domain to block
required :
- host
2022-07-15 08:30:14 -05:00
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'409' :
description : self-blocking forbidden
2022-07-15 08:30:14 -05:00
2022-10-12 09:09:02 -05:00
'/api/v1/server/blocklist/servers/{host}' :
delete :
2022-07-15 08:30:14 -05:00
tags :
2022-10-12 09:09:02 -05:00
- Server Blocks
summary : Unblock a server by its domain
2022-07-15 08:30:14 -05:00
security :
- OAuth2 :
- admin
2020-06-24 07:16:25 -05:00
parameters :
2022-10-12 09:09:02 -05:00
- name : host
2020-06-24 07:16:25 -05:00
in : path
required : true
2022-10-12 09:09:02 -05:00
description : server domain to unblock
2020-06-27 06:12:30 -05:00
schema :
type : string
2022-10-12 09:09:02 -05:00
format : hostname
2020-06-24 07:16:25 -05:00
responses :
'204' :
description : successful operation
2020-06-27 06:12:30 -05:00
'404' :
2022-10-12 09:09:02 -05:00
description : account block does not exist
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/server/redundancy/{host}:
put :
2020-06-24 07:16:25 -05:00
tags :
2022-10-12 09:09:02 -05:00
- Instance Redundancy
summary : Update a server redundancy policy
security :
- OAuth2 :
- admin
parameters :
- name : host
in : path
required : true
description : server domain to mirror
2020-06-24 07:16:25 -05:00
schema :
type : string
2022-10-12 09:09:02 -05:00
format : hostname
requestBody :
content :
application/json :
schema :
type : object
properties :
redundancyAllowed :
type : boolean
description : allow mirroring of the host's local videos
required :
- redundancyAllowed
responses :
'204' :
description : successful operation
'404' :
description : server is not already known
/api/v1/server/redundancy/videos :
get :
tags :
- Video Mirroring
summary : List videos being mirrored
operationId : getMirroredVideos
security :
- OAuth2 :
- admin
parameters :
- name : target
2020-06-24 08:13:24 -05:00
in : query
2022-10-12 09:09:02 -05:00
required : true
description : direction of the mirror
2020-06-24 07:16:25 -05:00
schema :
type : string
2022-10-12 09:09:02 -05:00
enum :
- my-videos
- remote-videos
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/videoRedundanciesSort'
2020-06-24 07:16:25 -05:00
responses :
2022-10-12 09:09:02 -05:00
'200' :
2020-06-24 07:16:25 -05:00
description : successful operation
content :
application/json :
schema :
2022-10-12 09:09:02 -05:00
type : array
items :
$ref : '#/components/schemas/VideoRedundancy'
post :
tags :
- Video Mirroring
summary : Mirror a video
operationId : putMirroredVideo
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
type : object
properties :
videoId :
$ref : '#/components/schemas/Video/properties/id'
required :
- videoId
responses :
'204' :
description : successful operation
'400' :
description : cannot mirror a local video
2020-06-27 06:12:30 -05:00
'404' :
2022-10-12 09:09:02 -05:00
description : video does not exist
'409' :
description : video is already mirrored
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/server/redundancy/videos/{redundancyId}:
delete :
2021-05-06 19:15:02 -05:00
tags :
2022-10-12 09:09:02 -05:00
- Video Mirroring
summary : Delete a mirror done on a video
operationId : delMirroredVideo
security :
- OAuth2 :
- admin
2021-05-06 19:15:02 -05:00
parameters :
2022-10-12 09:09:02 -05:00
- name : redundancyId
2021-05-06 19:15:02 -05:00
in : path
required : true
2022-10-12 09:09:02 -05:00
description : id of an existing redundancy on a video
2021-05-06 19:15:02 -05:00
schema :
type : string
responses :
'204' :
description : successful operation
2022-10-12 09:09:02 -05:00
'404' :
description : video redundancy not found
/api/v1/server/stats :
get :
tags :
- Stats
summary : Get instance stats
description : Get instance public statistics. This endpoint is cached.
operationId : getInstanceStats
responses :
'200' :
description : successful operation
2021-05-06 19:15:02 -05:00
content :
2022-10-12 09:09:02 -05:00
application/json :
2021-05-06 19:15:02 -05:00
schema :
2022-10-12 09:09:02 -05:00
$ref : '#/components/schemas/ServerStats'
/api/v1/server/logs/client :
post :
tags :
- Logs
summary : Send client log
operationId : sendClientLog
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/SendClientLog'
responses :
'204' :
description : successful operation
/api/v1/server/logs :
get :
tags :
- Logs
summary : Get instance logs
operationId : getInstanceLogs
security :
- OAuth2 :
- admin
responses :
'200' :
description : successful operation
content :
application/json :
2021-05-06 19:15:02 -05:00
schema :
2022-10-12 09:09:02 -05:00
type : array
items :
type : string
/api/v1/server/audit-logs :
get :
tags :
- Logs
summary : Get instance audit logs
operationId : getInstanceAuditLogs
security :
- OAuth2 :
- admin
responses :
'200' :
description : successful operation
content :
2021-05-06 19:15:02 -05:00
application/json :
schema :
2022-10-12 09:09:02 -05:00
type : array
items :
type : string
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins :
2020-06-25 05:16:08 -05:00
get :
tags :
- Plugins
summary : List plugins
2021-05-24 12:38:26 -05:00
operationId : getPlugins
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
parameters :
- name : pluginType
in : query
schema :
type : integer
- name : uninstalled
in : query
schema :
type : boolean
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/PluginResponse'
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/available :
2020-06-25 05:16:08 -05:00
get :
tags :
- Plugins
summary : List available plugins
2021-05-24 12:38:26 -05:00
operationId : getAvailablePlugins
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
parameters :
- name : search
in : query
schema :
type : string
- name : pluginType
in : query
schema :
type : integer
- name : currentPeerTubeEngine
in : query
schema :
type : string
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/sort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/PluginResponse'
'503' :
description : plugin index unavailable
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/install :
2020-06-25 05:16:08 -05:00
post :
tags :
- Plugins
summary : Install a plugin
2021-05-24 12:38:26 -05:00
operationId : addPlugin
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
oneOf :
- type : object
properties :
npmName :
type : string
2020-06-26 06:43:27 -05:00
example : peertube-plugin-auth-ldap
2020-06-25 05:16:08 -05:00
required :
- npmName
additionalProperties : false
- type : object
properties :
path :
type : string
required :
- path
additionalProperties : false
responses :
'204' :
description : successful operation
'400' :
description : should have either `npmName` or `path` set
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/update :
2020-06-25 05:16:08 -05:00
post :
tags :
- Plugins
summary : Update a plugin
2021-05-24 12:38:26 -05:00
operationId : updatePlugin
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
oneOf :
- type : object
properties :
npmName :
type : string
2020-06-26 06:43:27 -05:00
example : peertube-plugin-auth-ldap
2020-06-25 05:16:08 -05:00
required :
- npmName
additionalProperties : false
- type : object
properties :
path :
type : string
required :
- path
additionalProperties : false
responses :
'204' :
description : successful operation
'400' :
description : should have either `npmName` or `path` set
'404' :
description : existing plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/uninstall :
2020-06-25 05:16:08 -05:00
post :
tags :
- Plugins
summary : Uninstall a plugin
2021-05-24 12:38:26 -05:00
operationId : uninstallPlugin
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
requestBody :
content :
application/json :
schema :
type : object
properties :
npmName :
type : string
2020-06-26 06:43:27 -05:00
description : name of the plugin/theme in its package.json
example : peertube-plugin-auth-ldap
2020-06-25 05:16:08 -05:00
required :
- npmName
responses :
'204' :
description : successful operation
'404' :
description : existing plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/{npmName}:
2020-06-25 05:16:08 -05:00
get :
tags :
- Plugins
summary : Get a plugin
2021-05-24 12:38:26 -05:00
operationId : getPlugin
2020-06-25 05:16:08 -05:00
security :
- OAuth2 :
- admin
parameters :
2020-06-26 06:43:27 -05:00
- $ref : '#/components/parameters/npmName'
2020-06-25 05:16:08 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
$ref : '#/components/schemas/Plugin'
'404' :
description : plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/{npmName}/settings:
2020-06-25 05:16:08 -05:00
put :
tags :
- Plugins
summary : Set a plugin's settings
security :
- OAuth2 :
- admin
parameters :
2020-06-26 06:43:27 -05:00
- $ref : '#/components/parameters/npmName'
2020-06-25 05:16:08 -05:00
requestBody :
content :
application/json :
schema :
type : object
properties :
settings :
type : object
additionalProperties : true
responses :
'204' :
description : successful operation
'404' :
description : plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/{npmName}/public-settings:
2020-06-25 05:16:08 -05:00
get :
tags :
- Plugins
summary : Get a plugin's public settings
parameters :
2020-06-26 06:43:27 -05:00
- $ref : '#/components/parameters/npmName'
2020-06-25 05:16:08 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
additionalProperties : true
'404' :
description : plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/plugins/{npmName}/registered-settings:
2020-06-25 05:16:08 -05:00
get :
tags :
- Plugins
summary : Get a plugin's registered settings
security :
- OAuth2 :
- admin
parameters :
2020-06-26 06:43:27 -05:00
- $ref : '#/components/parameters/npmName'
2020-06-25 05:16:08 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
additionalProperties : true
'404' :
description : plugin not found
2021-05-14 12:31:24 -05:00
2022-10-12 09:09:02 -05:00
/api/v1/metrics/playback :
2022-08-12 09:41:29 -05:00
post :
summary : Create playback metrics
description : These metrics are exposed by OpenTelemetry metrics exporter if enabled.
tags :
- Stats
requestBody :
content :
application/json :
schema :
$ref : '#/components/schemas/PlaybackMetricCreate'
responses :
'204' :
description : successful operation
2023-05-02 06:19:26 -05:00
/api/v1/runners/registration-tokens/generate :
post :
summary : Generate registration token
description : Generate a new runner registration token
security :
- OAuth2 :
- admin
tags :
- Runner Registration Token
responses :
'204' :
description : successful operation
/api/v1/runners/registration-tokens/{registrationTokenId}:
delete :
summary : Remove registration token
description : Remove a registration token. Runners that used this token for their registration are automatically removed.
security :
- OAuth2 :
- admin
tags :
- Runner Registration Token
parameters :
- $ref : '#/components/parameters/registrationTokenId'
responses :
'204' :
description : successful operation
/api/v1/runners/registration-tokens :
get :
summary : List registration tokens
security :
- OAuth2 :
- admin
tags :
- Runner Registration Token
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/registrationTokenSort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/RunnerRegistrationToken'
/api/v1/runners/register :
post :
summary : Register a new runner
description : API used by PeerTube runners
tags :
- Runners
requestBody :
content :
application/json :
schema :
type : object
properties :
registrationToken :
type : string
name :
type : string
description :
type : string
required :
- registrationToken
- name
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
id :
type : integer
description : Runner id
runnerToken :
type : string
/api/v1/runners/unregister :
post :
summary : Unregister a runner
description : API used by PeerTube runners
tags :
- Runners
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
required :
- runnerToken
responses :
'204' :
description : successful operation
/api/v1/runners/{runnerId}:
delete :
summary : Delete a runner
security :
- OAuth2 :
- admin
tags :
- Runners
parameters :
- $ref : '#/components/parameters/runnerId'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
required :
- runnerToken
responses :
'204' :
description : successful operation
/api/v1/runners :
get :
summary : List runners
security :
- OAuth2 :
- admin
tags :
- Runners
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/runnerSort'
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/Runner'
/api/v1/runners/jobs/request :
post :
summary : Request a new job
description : API used by PeerTube runners
tags :
- Runner Jobs
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
required :
- runnerToken
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
availableJobs :
type : array
items :
type : object
properties :
uuid :
$ref : '#/components/schemas/UUIDv4'
type :
$ref : '#/components/schemas/RunnerJobType'
payload :
$ref : '#/components/schemas/RunnerJobPayload'
/api/v1/runners/jobs/{jobUUID}/accept:
post :
summary : Accept job
description : API used by PeerTube runners
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
required :
- runnerToken
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
job :
allOf :
- $ref : '#/components/schemas/RunnerJob'
- type : object
properties :
jobToken :
type : string
/api/v1/runners/jobs/{jobUUID}/abort:
post :
summary : Abort job
description : API used by PeerTube runners
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
jobToken :
type : string
reason :
type : string
description : Why the runner aborts this job
required :
- runnerToken
- jobToken
- reason
responses :
'204' :
description : successful operation
/api/v1/runners/jobs/{jobUUID}/update:
post :
summary : Update job
description : API used by PeerTube runners
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
jobToken :
type : string
progress :
type : integer
description : Update job progression percentage (optional)
payload :
anyOf :
- type : object
description : Provide live transcoding chunks update
properties :
type :
type : string
enum :
- 'add-chunk'
- 'remove-chunk'
masterPlaylistFile :
type : string
format : binary
resolutionPlaylistFile :
type : string
format : binary
resolutionPlaylistFilename :
type : string
videoChunkFile :
type : string
format : binary
videoChunkFilename :
type : string
required :
- runnerToken
- jobToken
responses :
'204' :
description : successful operation
/api/v1/runners/jobs/{jobUUID}/error:
post :
summary : Post job error
description : API used by PeerTube runners
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
jobToken :
type : string
message :
type : string
description : Why the runner failed to process this job
required :
- runnerToken
- jobToken
- message
responses :
'204' :
description : successful operation
/api/v1/runners/jobs/{jobUUID}/success:
post :
summary : Post job success
description : API used by PeerTube runners
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
requestBody :
content :
application/json :
schema :
type : object
properties :
runnerToken :
type : string
jobToken :
type : string
payload :
anyOf :
- type : object
title : VOD web video transcoding
properties :
videoFile :
type : string
format : binary
- type : object
title : VOD HLS transcoding
properties :
videoFile :
type : string
format : binary
resolutionPlaylistFile :
type : string
format : binary
- type : object
title : VOD audio merge transcoding
properties :
videoFile :
type : string
format : binary
- type : object
title : Live RTMP to HLS transcoding
required :
- runnerToken
- jobToken
- payload
responses :
'204' :
description : successful operation
/api/v1/runners/jobs/{jobUUID}/cancel:
get :
summary : Cancel a job
security :
- OAuth2 :
- admin
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
responses :
'204' :
description : successful operation
2023-07-27 04:44:31 -05:00
/api/v1/runners/jobs/{jobUUID}:
delete :
summary : Delete a job
description : The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed
security :
- OAuth2 :
- admin
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/jobUUID'
responses :
'204' :
description : successful operation
2023-05-02 06:19:26 -05:00
/api/v1/runners/jobs :
get :
summary : List jobs
security :
- OAuth2 :
- admin
tags :
- Runner Jobs
parameters :
- $ref : '#/components/parameters/start'
- $ref : '#/components/parameters/count'
- $ref : '#/components/parameters/runnerJobSort'
- $ref : '#/components/parameters/search'
2023-07-27 04:44:31 -05:00
- name : stateOneOf
in : query
required : false
schema :
type : array
items :
$ref : '#/components/schemas/RunnerJobState'
2023-05-02 06:19:26 -05:00
responses :
'200' :
description : successful operation
content :
application/json :
schema :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/RunnerJobAdmin'
2018-11-15 07:10:15 -06:00
servers :
2022-10-12 09:09:02 -05:00
- url : 'https://peertube2.cpy.re'
2020-06-24 15:25:05 -05:00
description : Live Test Server (live data - latest nightly version)
2022-10-12 09:09:02 -05:00
- url : 'https://peertube3.cpy.re'
2020-04-21 05:09:54 -05:00
description : Live Test Server (live data - latest RC version)
2022-10-12 09:09:02 -05:00
- url : 'https://peertube.cpy.re'
2020-06-24 15:25:05 -05:00
description : Live Test Server (live data - stable version)
2018-11-15 07:10:15 -06:00
components :
parameters :
start :
name : start
in : query
required : false
2020-06-24 07:16:25 -05:00
description : Offset used to paginate results
2018-11-15 07:10:15 -06:00
schema :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
minimum : 0
2018-11-15 07:10:15 -06:00
count :
name : count
in : query
required : false
2020-06-24 07:16:25 -05:00
description : "Number of items to return"
2018-11-15 07:10:15 -06:00
schema :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
default : 15
2020-06-24 07:16:25 -05:00
maximum : 100
minimum : 1
2018-11-15 07:10:15 -06:00
sort :
name : sort
in : query
required : false
2020-06-26 06:43:27 -05:00
description : Sort column
2018-11-15 07:10:15 -06:00
schema :
type : string
2020-06-26 06:43:27 -05:00
example : -createdAt
2020-07-02 15:49:51 -05:00
search :
name : search
in : query
required : false
description : Plain text search, applied to various parts of the model depending on endpoint
schema :
type : string
2020-06-10 08:18:15 -05:00
searchTarget :
name : searchTarget
in : query
required : false
description : >
If the administrator enabled search index support, you can override the default search target.
**Warning**: If you choose to make an index search, PeerTube will get results from a third party service.
2020-06-26 06:43:27 -05:00
It means the instance may not yet know the objects you fetched. If you want to load video/channel information :
2020-06-10 08:18:15 -05:00
* If the current user has the ability to make a remote URI search (this information is available in the config endpoint),
then reuse the search API to make a search using the object URI so PeerTube instance fetches the remote object and fill its database.
After that, you can use the classic REST API endpoints to fetch the complete object or interact with it
2020-06-26 06:43:27 -05:00
* 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
2020-06-10 08:18:15 -05:00
the data from the origin instance API
schema :
type : string
enum :
- 'local'
- 'search-index'
2018-11-24 11:18:56 -06:00
videosSort :
name : sort
in : query
required : false
schema :
type : string
enum :
2022-04-15 07:50:09 -05:00
- name
- -duration
- -createdAt
- -publishedAt
- -views
- -likes
- -trending
- -hot
- -best
description : >
Sort videos by criteria (prefixing with `-` means `DESC` order) :
* `hot` - Adaptation of Reddit "hot" algorithm taking into account video views, likes, dislikes and comments and publication date
* `best` - Same than `hot`, but also takes into account user video history
* `trending` - Sort videos by recent views ("recent" is defined by the admin)
* `views` - Sort videos using their `views` counter
* `publishedAt` - Sort by video publication date (when it became publicly available)
2018-11-24 11:18:56 -06:00
videosSearchSort :
name : sort
in : query
required : false
2022-04-15 07:50:09 -05:00
description : >
Sort videos by criteria (prefixing with `-` means `DESC` order) :
2018-11-24 11:18:56 -06:00
schema :
type : string
enum :
2020-06-25 04:14:43 -05:00
- name
2018-11-24 11:18:56 -06:00
- -duration
- -createdAt
- -publishedAt
- -views
- -likes
- -match
2019-12-27 10:52:53 -06:00
commentsSort :
name : sort
in : query
required : false
description : Sort comments by criteria
schema :
type : string
enum :
- -createdAt
- -totalReplies
2018-11-24 11:18:56 -06:00
blacklistsSort :
name : sort
in : query
required : false
2021-06-06 03:21:06 -05:00
description : Sort blocklists by criteria
2018-11-24 11:18:56 -06:00
schema :
type : string
enum :
- -id
2020-06-25 04:14:43 -05:00
- name
2018-11-24 11:18:56 -06:00
- -duration
- -views
- -likes
- -dislikes
- -uuid
- -createdAt
2020-07-02 15:49:51 -05:00
usersSearch :
name : search
in : query
required : false
description : Plain text search that will match with user usernames or emails
schema :
type : string
usersBlocked :
name : blocked
in : query
required : false
description : Filter results down to (un)banned users
schema :
type : boolean
2018-11-24 11:18:56 -06:00
usersSort :
name : sort
in : query
required : false
description : Sort users by criteria
schema :
type : string
enum :
- -id
- -username
- -createdAt
abusesSort :
name : sort
in : query
required : false
description : Sort abuses by criteria
schema :
type : string
enum :
- -id
- -createdAt
- -state
2020-06-25 04:14:43 -05:00
videoRedundanciesSort :
name : sort
in : query
required : false
description : Sort abuses by criteria
schema :
type : string
enum :
- name
2021-10-19 08:02:43 -05:00
followersSort :
name : sort
in : query
required : false
description : Sort followers by criteria
schema :
type : string
enum :
- createdAt
2023-05-02 06:19:26 -05:00
registrationTokenSort :
name : sort
in : query
required : false
description : Sort registration tokens by criteria
schema :
type : string
enum :
- createdAt
runnerSort :
name : sort
in : query
required : false
description : Sort runners by criteria
schema :
type : string
enum :
- createdAt
runnerJobSort :
name : sort
in : query
required : false
description : Sort runner jobs by criteria
schema :
type : string
enum :
- updatedAt
- createdAt
- priority
- state
- progress
2023-01-19 02:27:56 -06:00
2018-11-15 07:10:15 -06:00
name :
name : name
in : path
required : true
2020-12-08 14:16:10 -06:00
description : The username or handle of the account
2018-11-15 07:10:15 -06:00
schema :
type : string
2020-06-26 06:43:27 -05:00
example : chocobozzz | chocobozzz@example.org
2018-11-15 07:10:15 -06:00
id :
name : id
in : path
required : true
2022-01-19 07:23:00 -06:00
description : Entity id
2018-11-15 07:10:15 -06:00
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2023-01-19 02:27:56 -06:00
registrationId :
name : registrationId
in : path
required : true
description : Registration ID
schema :
$ref : '#/components/schemas/id'
2019-07-03 10:28:09 -05:00
idOrUUID :
2018-11-15 07:10:15 -06:00
name : id
in : path
required : true
2021-06-28 10:30:59 -05:00
description : The object id, uuid or short uuid
2018-11-15 07:10:15 -06:00
schema :
2020-06-26 06:43:27 -05:00
oneOf :
2021-05-10 09:09:59 -05:00
- $ref : '#/components/schemas/id'
2021-05-04 03:44:33 -05:00
- $ref : '#/components/schemas/UUIDv4'
2021-06-28 10:30:59 -05:00
- $ref : '#/components/schemas/shortUUID'
2021-05-12 07:33:04 -05:00
playlistId :
name : playlistId
in : path
required : true
description : Playlist id
schema :
$ref : '#/components/schemas/VideoPlaylist/properties/id'
2020-04-21 08:04:39 -05:00
playlistElementId :
name : playlistElementId
in : path
required : true
description : Playlist element id
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-04-21 08:24:19 -05:00
abuseId :
name : abuseId
in : path
required : true
2020-07-08 08:51:46 -05:00
description : Abuse id
2020-04-21 08:24:19 -05:00
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Abuse/properties/id'
2020-07-28 04:12:16 -05:00
abuseMessageId :
name : abuseMessageId
in : path
required : true
description : Abuse message id
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/AbuseMessage/properties/id'
2019-05-24 03:01:08 -05:00
captionLanguage :
name : captionLanguage
in : path
required : true
description : The caption language
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2019-04-24 09:57:23 -05:00
channelHandle :
name : channelHandle
2018-11-15 07:10:15 -06:00
in : path
required : true
2020-06-26 06:43:27 -05:00
description : The video channel handle
2018-11-15 07:10:15 -06:00
schema :
type : string
2020-06-26 06:43:27 -05:00
example : my_username | my_username@example.com
2022-08-10 02:53:39 -05:00
channelSyncId :
name : channelSyncId
in : path
required : true
description : Channel Sync id
schema :
$ref : '#/components/schemas/Abuse/properties/id'
2019-07-03 10:28:09 -05:00
subscriptionHandle :
name : subscriptionHandle
in : path
required : true
2020-06-26 06:43:27 -05:00
description : The subscription handle
2019-07-03 10:28:09 -05:00
schema :
type : string
2020-06-26 06:43:27 -05:00
example : my_username | my_username@example.com
2019-07-03 10:28:09 -05:00
threadId :
2018-11-15 07:10:15 -06:00
name : threadId
in : path
required : true
2019-07-03 10:28:09 -05:00
description : The thread id (root comment id)
schema :
2021-05-27 04:52:03 -05:00
type : integer
2019-07-03 10:28:09 -05:00
commentId :
name : commentId
in : path
required : true
2018-11-15 07:10:15 -06:00
description : The comment id
schema :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoComment/properties/id'
2021-05-03 04:06:19 -05:00
isLive :
name : isLive
in : query
required : false
description : whether or not the video is a live
schema :
type : boolean
2018-11-24 11:18:56 -06:00
categoryOneOf :
name : categoryOneOf
in : query
required : false
2021-05-10 07:17:26 -05:00
description : category id of the video (see [/videos/categories](#operation/getCategories))
2018-11-24 11:18:56 -06:00
schema :
oneOf :
2021-05-10 09:09:59 -05:00
- $ref : '#/components/schemas/VideoCategorySet'
2018-11-24 11:18:56 -06:00
- type : array
items :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoCategorySet'
2018-12-04 06:50:50 -06:00
style : form
explode : false
2018-11-24 11:18:56 -06:00
tagsOneOf :
name : tagsOneOf
in : query
required : false
description : tag(s) of the video
schema :
oneOf :
- type : string
- type : array
2021-05-10 04:13:41 -05:00
maxItems : 5
2018-11-24 11:18:56 -06:00
items :
type : string
2018-12-04 06:50:50 -06:00
style : form
explode : false
2018-11-24 11:18:56 -06:00
tagsAllOf :
name : tagsAllOf
in : query
required : false
description : tag(s) of the video, where all should be present in the video
schema :
oneOf :
- type : string
- type : array
items :
type : string
2018-12-04 06:50:50 -06:00
style : form
explode : false
2018-11-24 11:18:56 -06:00
languageOneOf :
name : languageOneOf
in : query
required : false
2021-05-10 07:17:26 -05:00
description : language id of the video (see [/videos/languages](#operation/getLanguages)). Use `_unknown` to filter on videos that don't have a video language
2018-11-24 11:18:56 -06:00
schema :
oneOf :
2021-05-10 09:09:59 -05:00
- $ref : '#/components/schemas/VideoLanguageSet'
2018-11-24 11:18:56 -06:00
- type : array
items :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2018-12-04 06:50:50 -06:00
style : form
explode : false
2018-11-24 11:18:56 -06:00
licenceOneOf :
name : licenceOneOf
in : query
required : false
2021-05-10 07:17:26 -05:00
description : licence id of the video (see [/videos/licences](#operation/getLicences))
2018-11-24 11:18:56 -06:00
schema :
oneOf :
2021-05-10 09:09:59 -05:00
- $ref : '#/components/schemas/VideoLicenceSet'
2018-11-24 11:18:56 -06:00
- type : array
items :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/VideoLicenceSet'
2018-12-04 06:50:50 -06:00
style : form
explode : false
2020-04-21 09:03:51 -05:00
skipCount :
name : skipCount
in : query
required : false
description : if you don't need the `total` in the response
schema :
type : string
enum :
- 'true'
- 'false'
2020-06-24 07:16:25 -05:00
default : 'false'
2018-11-24 11:18:56 -06:00
nsfw :
name : nsfw
in : query
required : false
description : whether to include nsfw videos, if any
schema :
type : string
enum :
- 'true'
- 'false'
2021-10-27 07:37:04 -05:00
isLocal :
name : isLocal
2018-11-24 11:18:56 -06:00
in : query
required : false
schema :
2021-10-27 07:37:04 -05:00
type : boolean
2021-11-02 05:00:40 -05:00
description : '**PeerTube >= 4.0** Display only local or remote videos'
2021-11-03 05:32:41 -05:00
hasHLSFiles :
name : hasHLSFiles
in : query
required : false
schema :
type : boolean
description : '**PeerTube >= 4.0** Display only videos that have HLS files'
2023-07-11 02:21:13 -05:00
hasWebVideoFiles :
name : hasWebVideoFiles
2021-11-03 05:32:41 -05:00
in : query
required : false
schema :
type : boolean
2023-07-11 02:21:13 -05:00
description : '**PeerTube >= 4.0** Display only videos that have Web Video files'
2021-11-12 07:19:56 -06:00
privacyOneOf :
name : privacyOneOf
in : query
required : false
schema :
$ref : '#/components/schemas/VideoPrivacySet'
description : '**PeerTube >= 4.0** Display only videos in this specific privacy/privacies'
2023-04-12 02:32:20 -05:00
excludeAlreadyWatched :
name : excludeAlreadyWatched
in : query
description : Whether or not to exclude videos that are in the user's video history
schema :
type : boolean
2022-11-23 08:47:30 -06:00
uuids :
name : uuids
in : query
required : false
schema :
items :
type : string
description : 'Find videos with specific UUIDs'
2021-10-27 07:37:04 -05:00
include :
name : include
in : query
required : false
schema :
type : integer
2018-11-24 11:18:56 -06:00
enum :
2021-10-27 07:37:04 -05:00
- 0
- 1
- 2
- 4
- 8
description : >
2021-11-02 05:00:40 -05:00
**PeerTube >= 4.0** Include additional videos in results (can be combined using bitwise or operator)
2021-10-27 07:37:04 -05:00
- `0` NONE
- `1` NOT_PUBLISHED_STATE
2021-11-12 07:19:56 -06:00
- `2` BLACKLISTED
2021-10-27 07:37:04 -05:00
2021-11-12 07:19:56 -06:00
- `4` BLOCKED_OWNER
2021-10-27 07:37:04 -05:00
2021-11-12 07:19:56 -06:00
- `8` FILES
2019-01-03 10:34:24 -06:00
subscriptionsUris :
name : uris
in : query
required : true
description : list of uris to check if each is part of the user subscriptions
schema :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
format : uri
npmName :
name : npmName
in : path
required : true
description : name of the plugin/theme on npmjs.com or in its package.json
schema :
type : string
example : peertube-plugin-auth-ldap
2020-12-13 12:27:25 -06:00
jobType :
name : jobType
in : query
required : false
description : job type
schema :
type : string
enum :
- activitypub-follow
- activitypub-http-broadcast
- activitypub-http-fetcher
- activitypub-http-unicast
- email
- video-transcoding
- video-file-import
- video-import
2021-11-09 03:11:20 -06:00
- videos-views-stats
2020-12-13 12:27:25 -06:00
- activitypub-refresher
- video-redundancy
- video-live-ending
2022-08-10 02:53:39 -05:00
- video-channel-import
2021-05-13 07:50:26 -05:00
followState :
name : state
in : query
schema :
type : string
enum :
- pending
- accepted
actorType :
name : actorType
in : query
schema :
type : string
enum :
- Person
- Application
- Group
- Service
- Organization
2022-10-12 09:09:02 -05:00
staticFilename :
name : filename
in : path
required : true
description : Filename
schema :
type : string
videoFileToken :
name : videoFileToken
in : query
required : false
description : Video file token [generated](#operation/requestVideoToken) by PeerTube so you don't need to provide an OAuth token in the request header.
schema :
type : string
2022-12-02 07:47:21 -06:00
reinjectVideoFileToken :
name : reinjectVideoFileToken
in : query
required : false
description : Ask the server to reinject videoFileToken in URLs in m3u8 playlist
schema :
type : boolean
2023-02-23 08:39:09 -06:00
videoPlaylistType :
name : playlistType
in : query
required : false
schema :
$ref : '#/components/schemas/VideoPlaylistTypeSet'
2023-05-02 06:19:26 -05:00
registrationTokenId :
name : registrationTokenId
in : path
required : true
schema :
type : integer
runnerId :
name : runnerId
in : path
required : true
schema :
type : integer
jobUUID :
name : jobUUID
in : path
required : true
schema :
$ref : '#/components/schemas/UUIDv4'
2023-06-29 02:48:55 -05:00
videoPasswordId :
name : videoPasswordId
in : path
required : true
description : The video password id
schema :
$ref : '#/components/schemas/id'
videoPasswordHeader :
name : x-peertube-video-password
description : Required on password protected video
in : header
required : false
schema :
type : string
2023-07-19 09:02:49 -05:00
resumableUploadInitContentLengthHeader :
name : X-Upload-Content-Length
in : header
schema :
type : number
example : 2469036
required : true
description : Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
resumableUploadInitContentTypeHeader :
name : X-Upload-Content-Type
in : header
schema :
type : string
format : mimetype
example : video/mp4
required : true
description : MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
resumableUploadChunkContentRangeHeader :
name : Content-Range
in : header
schema :
type : string
example : bytes 0-262143/2469036
required : true
description : |
Specifies the bytes in the file that the request is uploading.
For example, a value of `bytes 0-262143/1000000` shows that the request is sending the first
262144 bytes (256 x 1024) in a 2,469,036 byte file.
resumableUploadChunkContentLengthHeader :
name : Content-Length
in : header
schema :
type : number
example : 262144
required : true
description : |
Size of the chunk that the request is sending.
Remember that larger chunks are more efficient. PeerTube's web client uses chunks varying from
1048576 bytes (~1MB) and increases or reduces size depending on connection health.
resumableUploadId :
name : upload_id
in : query
required : true
description : |
Created session id to proceed with. If you didn't send chunks in the last hour, it is
not valid anymore and you need to initialize a new upload.
schema :
type : string
2018-11-15 07:10:15 -06:00
securitySchemes :
OAuth2 :
2021-05-06 18:40:21 -05:00
description : |
2018-11-15 07:10:15 -06:00
Authenticating via OAuth requires the following steps :
2021-05-06 18:40:21 -05:00
- Have an activated account
2021-05-12 14:23:54 -05:00
- [ Generate] an access token for that account at `/api/v1/users/token`.
- Make requests with the *Authorization : Bearer <token\>* header
2021-05-06 18:40:21 -05:00
- Profit, depending on the role assigned to the account
2018-11-15 07:10:15 -06:00
2021-05-12 14:23:54 -05:00
Note that the __access token is valid for 1 day__ and is given
2021-05-06 18:40:21 -05:00
along with a __refresh token valid for 2 weeks__.
2021-05-12 14:23:54 -05:00
2023-02-22 09:15:14 -06:00
[Generate] : https://docs.joinpeertube.org/api/rest-getting-started
2018-11-15 07:10:15 -06:00
type : oauth2
flows :
password :
2021-05-12 14:23:54 -05:00
tokenUrl : /api/v1/users/token
2018-11-15 07:10:15 -06:00
scopes :
admin : Admin scope
moderator : Moderator scope
user : User scope
schemas :
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
# Reusable core properties
2021-05-10 09:09:59 -05:00
id :
type : integer
minimum : 1
example : 42
2021-05-04 03:44:33 -05:00
UUIDv4 :
type : string
format : uuid
example : 9c9de5e8-0a1e-484a-b099-e80766180a6d
pattern : '^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$'
minLength : 36
maxLength : 36
2021-06-28 10:30:59 -05:00
shortUUID :
type : string
description : translation of a uuid v4 with a bigger alphabet to have a shorter uuid
example : 2y84q2MQUMWPbiEcxNXMgC
2021-05-10 09:09:59 -05:00
username :
type : string
2021-05-11 14:38:33 -05:00
description : immutable name of the user, used to find or mention its actor
2021-05-10 09:09:59 -05:00
example : chocobozzz
2021-05-12 14:23:54 -05:00
pattern : '/^[a-z0-9._]+$/'
2021-05-10 09:09:59 -05:00
minLength : 1
maxLength : 50
usernameChannel :
type : string
2021-05-11 14:38:33 -05:00
description : immutable name of the channel, used to interact with its actor
2021-05-12 06:44:32 -05:00
example : framasoft_videos
2021-05-12 14:23:54 -05:00
pattern : '/^[a-zA-Z0-9\\-_.:]+$/'
minLength : 1
maxLength : 50
2021-05-10 09:09:59 -05:00
password :
type : string
format : password
minLength : 6
maxLength : 255
2021-05-04 03:44:33 -05:00
2021-05-10 07:17:26 -05:00
VideoCategorySet :
type : integer
description : category id of the video (see [/videos/categories](#operation/getCategories))
2021-05-10 09:09:59 -05:00
example : 15
2021-05-03 07:34:46 -05:00
VideoConstantNumber-Category :
2018-11-15 07:10:15 -06:00
properties :
id :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoCategorySet'
2018-11-15 07:10:15 -06:00
label :
type : string
2021-05-10 09:09:59 -05:00
example : Science & Technology
2021-05-10 07:17:26 -05:00
VideoLicenceSet :
type : integer
description : licence id of the video (see [/videos/licences](#operation/getLicences))
2021-05-10 09:09:59 -05:00
example : 2
2021-05-03 07:34:46 -05:00
VideoConstantNumber-Licence :
properties :
id :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLicenceSet'
2021-05-03 07:34:46 -05:00
label :
type : string
2021-05-10 09:09:59 -05:00
example : Attribution - Share Alike
2021-05-10 07:17:26 -05:00
VideoLanguageSet :
type : string
description : language id of the video (see [/videos/languages](#operation/getLanguages))
2021-05-10 09:09:59 -05:00
example : en
2021-05-03 07:34:46 -05:00
VideoConstantString-Language :
2018-11-15 07:10:15 -06:00
properties :
id :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2018-11-15 07:10:15 -06:00
label :
type : string
2021-05-10 09:09:59 -05:00
example : English
2020-04-21 08:04:39 -05:00
VideoPlaylistPrivacySet :
type : integer
enum :
- 1
- 2
- 3
2023-03-31 02:12:21 -05:00
description : Video playlist privacy policy (see [/video-playlists/privacies](#operation/getPlaylistPrivacyPolicies))
2020-04-21 08:04:39 -05:00
VideoPlaylistPrivacyConstant :
properties :
id :
$ref : '#/components/schemas/VideoPlaylistPrivacySet'
label :
type : string
VideoPlaylistTypeSet :
type : integer
enum :
- 1
- 2
2021-05-10 07:17:26 -05:00
description : The video playlist type (Regular = `1`, Watch Later = `2`)
2020-04-21 08:04:39 -05:00
VideoPlaylistTypeConstant :
properties :
id :
$ref : '#/components/schemas/VideoPlaylistTypeSet'
label :
type : string
2019-05-24 03:09:27 -05:00
VideoPrivacySet :
type : integer
2018-11-15 07:10:15 -06:00
enum :
2019-05-24 03:09:27 -05:00
- 1
- 2
- 3
2020-04-21 08:04:39 -05:00
- 4
2023-03-31 02:12:21 -05:00
description : privacy id of the video (see [/videos/privacies](#operation/getVideoPrivacyPolicies))
2019-05-24 03:09:27 -05:00
VideoPrivacyConstant :
properties :
id :
2020-04-21 08:04:39 -05:00
$ref : '#/components/schemas/VideoPrivacySet'
2019-05-24 03:09:27 -05:00
label :
type : string
2020-04-21 08:24:19 -05:00
2021-12-07 04:30:53 -06:00
BlockStatus :
properties :
accounts :
type : object
additionalProperties :
x-additionalPropertiesName : account
type : object
properties :
blockedByServer :
type : boolean
blockedByUser :
type : boolean
hosts :
type : object
additionalProperties :
x-additionalPropertiesName : host
type : object
properties :
blockedByServer :
type : boolean
blockedByUser :
type : boolean
2020-04-21 09:41:31 -05:00
NSFWPolicy :
type : string
enum :
- display
- blur
- do_not_list
UserRole :
2020-06-24 07:16:25 -05:00
type : integer
2020-04-21 09:41:31 -05:00
enum :
- 0
- 1
- 2
2020-06-24 07:16:25 -05:00
description : 'The user role (Admin = `0`, Moderator = `1`, User = `2`)'
2020-06-27 04:43:43 -05:00
example : 2
2021-02-01 08:39:13 -06:00
UserAdminFlags :
type : integer
enum :
- 0
- 1
2021-06-06 03:21:06 -05:00
description : 'Admin flags for the user (None = `0`, Bypass video blocklist = `1`)'
2021-02-01 08:39:13 -06:00
example : 1
2020-04-21 09:41:31 -05:00
2022-03-04 06:40:02 -06:00
LiveVideoLatencyMode :
type : integer
enum :
- 1
- 2
- 3
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
description : 'The live latency mode (Default = `1`, High latency = `2`, Small Latency = `3`)'
2023-04-21 08:03:36 -05:00
2023-03-31 02:12:21 -05:00
LiveVideoReplaySettings :
type : object
properties :
privacy :
# description: Video playlist privacy policy (see [../video-playlists/privacies])
$ref : '#/components/schemas/VideoPrivacySet'
2022-03-04 06:40:02 -06:00
2019-06-11 03:01:13 -05:00
VideoStateConstant :
properties :
id :
type : integer
enum :
- 1
- 2
- 3
2022-04-19 01:57:24 -05:00
- 4
- 5
- 6
- 7
- 8
- 9
description : |
The video state :
- `1` : Published
- `2` : To transcode
- `3` : To import
- `4` : Waiting for live stream
- `5` : Live ended
- `6` : To move to an external storage (object storage...)
- `7` : Transcoding failed
- `8` : Moving to an external storage failed
- `9` : To edit using studio edition feature
2019-06-11 03:01:13 -05:00
label :
type : string
2020-04-21 08:24:19 -05:00
2020-07-07 07:34:16 -05:00
AbuseStateSet :
2020-04-21 08:24:19 -05:00
type : integer
enum :
- 1
- 2
- 3
2020-07-28 04:12:16 -05:00
description : 'The abuse state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
2020-07-07 07:34:16 -05:00
AbuseStateConstant :
2020-04-21 08:24:19 -05:00
properties :
id :
2020-07-07 07:34:16 -05:00
$ref : '#/components/schemas/AbuseStateSet'
2020-04-21 08:24:19 -05:00
label :
type : string
2020-07-07 07:34:16 -05:00
AbusePredefinedReasons :
2020-06-22 06:00:39 -05:00
type : array
items :
type : string
enum :
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
2020-06-26 06:43:27 -05:00
example : [ spamOrMisleading]
2020-04-21 08:24:19 -05:00
2021-05-10 07:17:26 -05:00
VideoResolutionSet :
type : integer
description : |
Video resolution (`0`, `240`, `360`, `720`, `1080`, `1440` or `2160`)
`0` is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.
example : 240
2019-06-11 03:01:13 -05:00
VideoResolutionConstant :
2021-05-10 18:50:36 -05:00
description : resolutions and their labels for the video
2019-06-11 03:01:13 -05:00
properties :
id :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoResolutionSet'
2019-06-11 03:01:13 -05:00
label :
type : string
2020-06-26 06:43:27 -05:00
example : 240p
2019-06-11 03:01:13 -05:00
VideoScheduledUpdate :
properties :
privacy :
$ref : '#/components/schemas/VideoPrivacySet'
updateAt :
type : string
format : date
description : When to update the video
required :
- updateAt
2020-04-21 08:04:39 -05:00
AccountSummary :
2019-06-11 03:01:13 -05:00
properties :
id :
2020-06-24 07:16:25 -05:00
type : integer
2019-06-11 03:01:13 -05:00
name :
type : string
displayName :
type : string
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
host :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2022-02-28 01:34:43 -06:00
avatars :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2019-06-11 03:01:13 -05:00
VideoChannelSummary :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2019-06-11 03:01:13 -05:00
name :
type : string
displayName :
type : string
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
host :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2022-02-28 01:34:43 -06:00
avatars :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2019-06-11 03:01:13 -05:00
PlaylistElement :
properties :
position :
2020-06-24 07:16:25 -05:00
type : integer
2019-06-11 03:01:13 -05:00
startTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2019-06-11 03:01:13 -05:00
stopTimestamp :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2019-07-31 08:57:32 -05:00
video :
nullable : true
2020-04-21 08:04:39 -05:00
allOf :
- $ref : '#/components/schemas/Video'
2019-06-11 03:01:13 -05:00
VideoFile :
2021-05-10 18:50:36 -05:00
readOnly : true
2019-06-11 03:01:13 -05:00
properties :
2022-07-29 04:32:46 -05:00
id :
$ref : '#/components/schemas/id'
2019-06-11 03:01:13 -05:00
magnetUri :
type : string
2021-05-10 18:50:36 -05:00
format : uri
description : magnet URI allowing to resolve the video via BitTorrent without a metainfo file
pattern : /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
2019-06-11 03:01:13 -05:00
resolution :
$ref : '#/components/schemas/VideoResolutionConstant'
size :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 18:50:36 -05:00
description : Video file size in bytes
2019-06-11 03:01:13 -05:00
torrentUrl :
type : string
2021-04-13 15:45:54 -05:00
description : Direct URL of the torrent file
2020-06-26 06:43:27 -05:00
format : url
2019-08-21 01:32:15 -05:00
torrentDownloadUrl :
2019-06-11 03:01:13 -05:00
type : string
2021-04-13 15:45:54 -05:00
description : URL endpoint that transfers the torrent file as an attachment (so that the browser opens a download dialog)
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
fileUrl :
type : string
2021-04-13 15:45:54 -05:00
description : Direct URL of the video
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
fileDownloadUrl :
type : string
2021-04-13 15:45:54 -05:00
description : URL endpoint that transfers the video file as an attachment (so that the browser opens a download dialog)
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
fps :
type : number
2021-05-10 18:50:36 -05:00
description : Frames per second of the video file
2020-05-13 04:57:38 -05:00
metadataUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2021-05-10 18:50:36 -05:00
description : URL dereferencing the output of ffprobe on the file
2019-06-11 03:01:13 -05:00
VideoStreamingPlaylists :
2021-05-04 03:25:05 -05:00
allOf :
- type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2021-05-04 03:25:05 -05:00
type :
type : integer
enum :
- 1
description : |
Playlist type :
- `1` : HLS
- $ref : '#/components/schemas/VideoStreamingPlaylists-HLS'
VideoStreamingPlaylists-HLS :
2019-06-11 03:01:13 -05:00
properties :
playlistUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2019-06-11 03:01:13 -05:00
segmentsSha256Url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-05-13 04:57:38 -05:00
files :
type : array
2021-05-04 02:13:21 -05:00
description : |
Video files associated to this playlist.
The difference with the root `files` property is that these files are fragmented, so they can be used in this streaming playlist (HLS, etc.)
2020-05-13 04:57:38 -05:00
items :
$ref : '#/components/schemas/VideoFile'
2019-06-11 03:01:13 -05:00
redundancies :
type : array
items :
type : object
properties :
baseUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 15:25:05 -05:00
VideoInfo :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2020-06-24 15:25:05 -05:00
uuid :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/uuid'
2020-06-24 15:25:05 -05:00
name :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/name'
2018-11-15 07:10:15 -06:00
Video :
properties :
id :
2021-05-10 09:09:59 -05:00
description : object id for the video
allOf :
- $ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
uuid :
2021-05-10 09:09:59 -05:00
description : universal identifier for the video, that can be used across instances
allOf :
- $ref : '#/components/schemas/UUIDv4'
2021-06-28 10:30:59 -05:00
shortUUID :
allOf :
- $ref : '#/components/schemas/shortUUID'
2020-11-09 04:21:08 -06:00
isLive :
type : boolean
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2021-05-04 04:18:46 -05:00
example : 2017-10-01T10:52:46.396Z
description : time at which the video object was first drafted
2018-11-15 07:10:15 -06:00
publishedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2021-05-04 04:18:46 -05:00
example : 2018-10-01T10:52:46.396Z
description : time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution.
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2021-05-04 04:18:46 -05:00
example : 2021-05-04T08:01:01.502Z
description : last time the video's metadata was modified
2019-06-11 03:01:13 -05:00
originallyPublishedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2021-05-04 04:18:46 -05:00
example : 2010-10-01T10:52:46.396Z
description : used to represent a date of first publication, prior to the practical publication date of `publishedAt`
2018-11-15 07:10:15 -06:00
category :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoConstantNumber-Category'
description : category in which the video is classified
2018-11-15 07:10:15 -06:00
licence :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoConstantNumber-Licence'
description : licence under which the video is distributed
2018-11-15 07:10:15 -06:00
language :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoConstantString-Language'
description : main language used in the video
2018-11-15 07:10:15 -06:00
privacy :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoPrivacyConstant'
description : privacy policy used to distribute the video
2018-11-15 07:10:15 -06:00
description :
type : string
2021-05-04 04:18:46 -05:00
example : |
**[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)**\r\n*A decentralized video hosting network, based on fr...
minLength : 3
maxLength : 250
description : |
truncated description of the video, written in Markdown.
Resolve `descriptionPath` to get the full description of maximum `10000` characters.
2018-11-15 07:10:15 -06:00
duration :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 1419
2021-05-12 07:33:04 -05:00
format : seconds
2021-05-04 04:18:46 -05:00
description : duration of the video in seconds
2018-11-15 07:10:15 -06:00
isLocal :
type : boolean
name :
type : string
2021-05-10 09:09:59 -05:00
description : title of the video
2020-06-26 06:43:27 -05:00
example : What is PeerTube?
2021-05-03 05:17:30 -05:00
minLength : 3
maxLength : 120
2018-11-15 07:10:15 -06:00
thumbnailPath :
type : string
2023-06-07 01:53:14 -05:00
example : /lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
2018-11-15 07:10:15 -06:00
previewPath :
type : string
2020-08-26 08:03:00 -05:00
example : /lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
2018-11-15 07:10:15 -06:00
embedPath :
type : string
2020-06-26 06:43:27 -05:00
example : /videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
2018-11-15 07:10:15 -06:00
views :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 1337
2018-11-15 07:10:15 -06:00
likes :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 42
2018-11-15 07:10:15 -06:00
dislikes :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 7
2018-11-15 07:10:15 -06:00
nsfw :
type : boolean
2019-06-11 03:01:13 -05:00
waitTranscoding :
type : boolean
nullable : true
state :
2021-05-10 09:09:59 -05:00
allOf :
- $ref : '#/components/schemas/VideoStateConstant'
description : represents the internal state of the video processing within the PeerTube instance
2019-06-11 03:01:13 -05:00
scheduledUpdate :
nullable : true
2020-04-21 08:04:39 -05:00
allOf :
- $ref : '#/components/schemas/VideoScheduledUpdate'
2019-06-11 03:01:13 -05:00
blacklisted :
nullable : true
type : boolean
blacklistedReason :
nullable : true
type : string
2018-11-15 07:10:15 -06:00
account :
2020-04-21 08:04:39 -05:00
$ref : '#/components/schemas/AccountSummary'
2019-06-11 03:01:13 -05:00
channel :
$ref : '#/components/schemas/VideoChannelSummary'
userHistory :
nullable : true
2018-11-15 07:10:15 -06:00
type : object
properties :
2019-06-11 03:01:13 -05:00
currentTime :
2020-06-24 07:16:25 -05:00
type : integer
2019-06-11 03:01:13 -05:00
VideoDetails :
allOf :
- $ref : '#/components/schemas/Video'
- type : object
properties :
2021-11-09 03:11:20 -06:00
viewers :
type : integer
description : If the video is a live, you have the amount of current viewers
2019-06-11 03:01:13 -05:00
descriptionPath :
2018-11-15 07:10:15 -06:00
type : string
2021-05-04 04:18:46 -05:00
example : /api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180a6d/description
description : path at which to get the full description of maximum `10000` characters
2019-06-11 03:01:13 -05:00
support :
2018-11-15 07:10:15 -06:00
type : string
2020-06-27 06:12:30 -05:00
description : A text tell the audience how to support the video creator
2021-05-12 06:44:32 -05:00
example : Please support our work on https://soutenir.framasoft.org/en/ <3
2021-05-04 02:13:21 -05:00
minLength : 3
maxLength : 1000
2019-06-11 03:01:13 -05:00
channel :
$ref : '#/components/schemas/VideoChannel'
account :
$ref : '#/components/schemas/Account'
tags :
2021-05-03 05:17:30 -05:00
example : [ flowers, gardening]
2019-06-11 03:01:13 -05:00
type : array
2021-05-03 05:17:30 -05:00
minItems : 1
maxItems : 5
2019-06-11 03:01:13 -05:00
items :
type : string
2021-05-03 05:17:30 -05:00
minLength : 2
maxLength : 30
2019-06-11 03:01:13 -05:00
commentsEnabled :
type : boolean
downloadEnabled :
type : boolean
2023-07-19 09:02:49 -05:00
inputFileUpdatedAt :
type : string
format : date-time
nullable : true
description : Latest input file update. Null if the file has never been replaced since the original upload
2019-06-11 03:01:13 -05:00
trackerUrls :
type : array
items :
type : string
2020-06-26 06:43:27 -05:00
format : url
2021-05-10 18:50:36 -05:00
example :
- https://peertube2.cpy.re/tracker/announce
- wss://peertube2.cpy.re/tracker/socket
2021-05-04 02:13:21 -05:00
files :
type : array
items :
$ref : '#/components/schemas/VideoFile'
description : |
2023-07-11 02:21:13 -05:00
Web compatible video files. If Web Video is disabled on the server :
2021-05-04 02:13:21 -05:00
- field will be empty
- video files will be found in `streamingPlaylists[].files` field
2019-06-11 03:01:13 -05:00
streamingPlaylists :
type : array
items :
$ref : '#/components/schemas/VideoStreamingPlaylists'
2021-05-04 02:13:21 -05:00
description : |
HLS playlists/manifest files. If HLS is disabled on the server :
- field will be empty
- video files will be found in `files` field
2020-06-25 04:14:43 -05:00
FileRedundancyInformation :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-25 04:14:43 -05:00
fileUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-25 04:14:43 -05:00
strategy :
type : string
2020-06-26 06:43:27 -05:00
enum :
- manual
- most-views
- trending
- recently-added
2020-06-25 04:14:43 -05:00
size :
type : integer
createdAt :
type : string
format : date-time
updatedAt :
type : string
format : date-time
expiresOn :
type : string
format : date-time
VideoRedundancy :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-25 04:14:43 -05:00
name :
type : string
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-25 04:14:43 -05:00
uuid :
2021-05-04 03:44:33 -05:00
$ref : '#/components/schemas/UUIDv4'
2020-06-25 04:14:43 -05:00
redundancies :
type : object
properties :
files :
type : array
items :
2020-07-02 07:23:50 -05:00
$ref : '#/components/schemas/FileRedundancyInformation'
2020-06-25 04:14:43 -05:00
streamingPlaylists :
type : array
items :
2020-07-02 07:23:50 -05:00
$ref : '#/components/schemas/FileRedundancyInformation'
2019-07-29 07:33:16 -05:00
VideoImportStateConstant :
properties :
id :
type : integer
enum :
- 1
- 2
- 3
2020-06-24 07:16:25 -05:00
description : 'The video import state (Pending = `1`, Success = `2`, Failed = `3`)'
2019-07-29 07:33:16 -05:00
label :
type : string
2020-06-26 06:43:27 -05:00
example : Pending
2021-05-11 03:07:15 -05:00
VideoCreateImport :
allOf :
- type : object
additionalProperties : false
oneOf :
- properties :
targetUrl :
$ref : '#/components/schemas/VideoImport/properties/targetUrl'
required : [ targetUrl]
- properties :
magnetUri :
$ref : '#/components/schemas/VideoImport/properties/magnetUri'
required : [ magnetUri]
- properties :
torrentfile :
$ref : '#/components/schemas/VideoImport/properties/torrentfile'
required : [ torrentfile]
- $ref : '#/components/schemas/VideoUploadRequestCommon'
required :
- channelId
- name
2019-07-29 07:33:16 -05:00
VideoImport :
properties :
id :
2021-05-11 03:07:15 -05:00
readOnly : true
allOf :
- $ref : '#/components/schemas/id'
2019-07-29 07:33:16 -05:00
targetUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2021-05-10 18:50:36 -05:00
description : remote URL where to find the import's source video
2020-06-26 06:43:27 -05:00
example : https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d
2019-07-29 07:33:16 -05:00
magnetUri :
type : string
2020-06-26 06:43:27 -05:00
format : uri
2021-05-10 18:50:36 -05:00
description : magnet URI allowing to resolve the import's source video
pattern : /magnet:\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i
2021-05-11 03:07:15 -05:00
torrentfile :
writeOnly : true
type : string
format : binary
description : Torrent file containing only the video file
2019-07-29 07:33:16 -05:00
torrentName :
2021-05-11 03:07:15 -05:00
readOnly : true
2019-07-29 07:33:16 -05:00
type : string
state :
2021-05-11 03:07:15 -05:00
readOnly : true
allOf :
- $ref : '#/components/schemas/VideoImportStateConstant'
2019-07-29 07:33:16 -05:00
error :
2021-05-11 03:07:15 -05:00
readOnly : true
2019-07-29 07:33:16 -05:00
type : string
createdAt :
2021-05-11 03:07:15 -05:00
readOnly : true
2019-07-29 07:33:16 -05:00
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2019-07-29 07:33:16 -05:00
updatedAt :
2021-05-11 03:07:15 -05:00
readOnly : true
2019-07-29 07:33:16 -05:00
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2019-07-29 07:33:16 -05:00
video :
2021-05-11 03:07:15 -05:00
readOnly : true
2021-05-10 18:50:36 -05:00
nullable : true
allOf :
- $ref : '#/components/schemas/Video'
2021-05-10 04:02:54 -05:00
VideoImportsList :
properties :
total :
type : integer
example : 1
data :
type : array
maxItems : 100
items :
$ref : '#/components/schemas/VideoImport'
2020-07-28 04:12:16 -05:00
Abuse :
2018-11-15 07:10:15 -06:00
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
reason :
type : string
2020-06-26 06:43:27 -05:00
example : The video is a spam
2021-05-03 07:14:45 -05:00
minLength : 2
maxLength : 3000
2020-06-22 06:00:39 -05:00
predefinedReasons :
2020-07-07 07:34:16 -05:00
$ref : '#/components/schemas/AbusePredefinedReasons'
2018-11-15 07:10:15 -06:00
reporterAccount :
$ref : '#/components/schemas/Account'
2020-04-21 08:24:19 -05:00
state :
2020-07-07 07:34:16 -05:00
$ref : '#/components/schemas/AbuseStateConstant'
2020-04-21 08:24:19 -05:00
moderationComment :
type : string
2020-06-26 06:43:27 -05:00
example : Decided to ban the server since it spams us regularly
2021-05-03 07:14:45 -05:00
minLength : 2
maxLength : 3000
2018-11-15 07:10:15 -06:00
video :
2021-05-03 05:17:30 -05:00
$ref : '#/components/schemas/VideoInfo'
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2020-07-28 04:12:16 -05:00
AbuseMessage :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-07-28 04:12:16 -05:00
message :
type : string
2021-05-03 07:14:45 -05:00
minLength : 2
2021-05-10 04:13:41 -05:00
maxLength : 3000
2020-07-28 04:12:16 -05:00
byModerator :
type : boolean
createdAt :
type : string
format : date-time
account :
$ref : '#/components/schemas/AccountSummary'
2018-11-15 07:10:15 -06:00
VideoBlacklist :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
videoId :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
name :
type : string
2021-05-03 07:14:45 -05:00
minLength : 3
maxLength : 120
2018-11-15 07:10:15 -06:00
uuid :
2021-05-04 03:44:33 -05:00
$ref : '#/components/schemas/UUIDv4'
2018-11-15 07:10:15 -06:00
description :
type : string
2021-05-03 07:14:45 -05:00
minLength : 3
maxLength : 10000
2018-11-15 07:10:15 -06:00
duration :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
views :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
likes :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
dislikes :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
nsfw :
type : boolean
2019-12-27 10:52:53 -06:00
VideoPlaylist :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
uuid :
$ref : '#/components/schemas/UUIDv4'
2021-06-28 10:30:59 -05:00
shortUUID :
allOf :
- $ref : '#/components/schemas/shortUUID'
2019-12-27 10:52:53 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2019-12-27 10:52:53 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2019-12-27 10:52:53 -06:00
description :
type : string
2021-05-03 07:14:45 -05:00
minLength : 3
maxLength : 1000
2019-12-27 10:52:53 -06:00
displayName :
type : string
2021-05-03 07:14:45 -05:00
minLength : 1
maxLength : 120
2019-12-27 10:52:53 -06:00
isLocal :
type : boolean
videoLength :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
minimum : 0
2019-12-27 10:52:53 -06:00
thumbnailPath :
type : string
privacy :
2020-04-21 08:04:39 -05:00
$ref : '#/components/schemas/VideoPlaylistPrivacyConstant'
2019-12-27 10:52:53 -06:00
type :
2020-04-21 08:04:39 -05:00
$ref : '#/components/schemas/VideoPlaylistTypeConstant'
2019-12-27 10:52:53 -06:00
ownerAccount :
2020-04-21 08:04:39 -05:00
$ref : '#/components/schemas/AccountSummary'
videoChannel :
$ref : '#/components/schemas/VideoChannelSummary'
2018-11-15 07:10:15 -06:00
VideoComment :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2018-11-15 07:10:15 -06:00
text :
type : string
2021-05-11 13:19:26 -05:00
format : html
description : Text of the comment
2021-05-03 07:14:45 -05:00
minLength : 1
2021-05-11 13:19:26 -05:00
example : This video is wonderful!
2018-11-15 07:10:15 -06:00
threadId :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2021-05-11 13:19:26 -05:00
inReplyToCommentId :
nullable : true
allOf :
- $ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
videoId :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2021-05-11 13:19:26 -05:00
deletedAt :
nullable : true
type : string
format : date-time
default : null
isDeleted :
type : boolean
default : false
2019-12-28 04:27:31 -06:00
totalRepliesFromVideoAuthor :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
minimum : 0
2018-11-15 07:10:15 -06:00
totalReplies :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
minimum : 0
2018-11-15 07:10:15 -06:00
account :
$ref : '#/components/schemas/Account'
VideoCommentThreadTree :
properties :
comment :
$ref : '#/components/schemas/VideoComment'
children :
type : array
items :
$ref : '#/components/schemas/VideoCommentThreadTree'
2023-06-01 07:51:16 -05:00
Storyboard :
properties :
storyboardPath :
type : string
totalHeight :
type : integer
totalWidth :
type : integer
spriteHeight :
type : integer
spriteWidth :
type : integer
spriteDuration :
type : integer
2019-05-24 03:01:08 -05:00
VideoCaption :
properties :
language :
2021-05-03 07:34:46 -05:00
$ref : '#/components/schemas/VideoConstantString-Language'
2019-05-24 03:01:08 -05:00
captionPath :
type : string
2023-08-28 03:55:04 -05:00
VideoChapters :
properties :
chapters :
type : object
properties :
title :
type : string
timecode :
type : integer
2022-06-21 08:31:25 -05:00
VideoSource :
properties :
filename :
type : string
2023-07-19 09:02:49 -05:00
createdAt :
type : string
format : date-time
2021-04-08 02:34:32 -05:00
ActorImage :
2018-11-15 07:10:15 -06:00
properties :
path :
type : string
2022-02-28 01:34:43 -06:00
width :
type : integer
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2020-06-24 15:25:05 -05:00
ActorInfo :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
name :
type : string
displayName :
type : string
host :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2022-02-28 01:34:43 -06:00
avatars :
type : array
items :
$ref : '#/components/schemas/ActorImage'
2018-11-15 07:10:15 -06:00
Actor :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2018-11-15 07:10:15 -06:00
name :
2021-05-11 14:38:33 -05:00
description : immutable name of the actor, used to find or mention it
2021-05-10 18:50:36 -05:00
allOf :
- $ref : '#/components/schemas/username'
2018-11-15 07:10:15 -06:00
host :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2021-05-10 18:50:36 -05:00
description : server on which the actor is resident
2021-05-10 07:39:01 -05:00
hostRedundancyAllowed :
type : boolean
2021-05-10 18:50:36 -05:00
description : whether this actor's host allows redundancy of its videos
2018-11-15 07:10:15 -06:00
followingCount :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 18:50:36 -05:00
minimum : 0
description : number of actors subscribed to by this actor, as seen by this instance
2018-11-15 07:10:15 -06:00
followersCount :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 18:50:36 -05:00
minimum : 0
description : number of followers of this actor, as seen by this instance
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
Account :
allOf :
- $ref : '#/components/schemas/Actor'
- properties :
2019-08-22 06:33:07 -05:00
userId :
2021-05-10 18:50:36 -05:00
description : object id for the user tied to this account
allOf :
- $ref : '#/components/schemas/User/properties/id'
2018-11-15 07:10:15 -06:00
displayName :
type : string
2021-05-11 14:38:33 -05:00
description : editable name of the account, displayed in its representations
minLength : 3
maxLength : 120
2019-08-22 06:33:07 -05:00
description :
type : string
2021-05-10 18:50:36 -05:00
description : text or bio displayed on the account's profile
2022-04-05 07:34:52 -05:00
UserViewingVideo :
2022-04-05 07:56:28 -05:00
required :
- currentTime
2018-11-16 05:11:00 -06:00
properties :
currentTime :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-12 07:33:04 -05:00
format : seconds
2020-06-26 06:43:27 -05:00
description : timestamp within the video, in seconds
example : 5
2022-04-05 07:56:28 -05:00
viewEvent :
type : string
enum :
- seek
description : >
Event since last viewing call :
* `seek` - If the user seeked the video
2022-04-05 07:34:52 -05:00
VideoStatsOverall :
properties :
averageWatchTime :
type : number
totalWatchTime :
type : number
viewersPeak :
type : number
viewersPeakDate :
type : string
format : date-time
countries :
type : array
items :
type : object
properties :
isoCode :
type : string
viewers :
type : number
VideoStatsRetention :
properties :
data :
type : array
items :
type : object
properties :
second :
type : number
retentionPercent :
type : number
VideoStatsTimeserie :
properties :
data :
type : array
items :
type : object
properties :
date :
type : string
value :
type : number
2018-11-15 07:10:15 -06:00
ServerConfig :
properties :
2019-08-22 06:33:07 -05:00
instance :
type : object
properties :
name :
type : string
shortDescription :
type : string
defaultClientRoute :
type : string
isNSFW :
type : boolean
defaultNSFWPolicy :
type : string
customizations :
type : object
properties :
javascript :
type : string
css :
type : string
2020-02-21 14:25:49 -06:00
search :
type : object
properties :
remoteUri :
type : object
properties :
users :
type : boolean
anonymous :
type : boolean
2019-08-22 06:33:07 -05:00
plugin :
type : object
properties :
registered :
type : array
items :
type : string
theme :
type : object
properties :
registered :
type : array
items :
type : string
email :
type : object
properties :
enabled :
type : boolean
contactForm :
type : object
properties :
enabled :
type : boolean
serverVersion :
type : string
serverCommit :
type : string
2018-11-15 07:10:15 -06:00
signup :
type : object
properties :
allowed :
type : boolean
2019-08-22 06:33:07 -05:00
allowedForCurrentIP :
type : boolean
requiresEmailVerification :
type : boolean
2018-11-15 07:10:15 -06:00
transcoding :
type : object
properties :
2019-08-22 06:33:07 -05:00
hls :
type : object
properties :
enabled :
type : boolean
2023-07-11 02:52:14 -05:00
web_videos :
2020-02-21 14:25:49 -06:00
type : object
properties :
enabled :
type : boolean
2018-11-15 07:10:15 -06:00
enabledResolutions :
type : array
items :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoResolutionSet'
2019-08-22 06:33:07 -05:00
import :
type : object
properties :
videos :
type : object
properties :
http :
type : object
properties :
enabled :
type : boolean
torrent :
type : object
properties :
enabled :
type : boolean
2022-08-10 02:53:39 -05:00
videoChannelSynchronization :
type : object
properties :
enabled :
type : boolean
2019-08-22 06:33:07 -05:00
autoBlacklist :
type : object
properties :
videos :
type : object
properties :
ofUsers :
type : object
properties :
enabled :
type : boolean
2018-11-15 07:10:15 -06:00
avatar :
type : object
properties :
file :
type : object
properties :
size :
type : object
properties :
max :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
extensions :
type : array
items :
type : string
video :
type : object
properties :
2019-08-22 06:33:07 -05:00
image :
type : object
properties :
extensions :
type : array
items :
type : string
size :
type : object
properties :
max :
2020-06-24 07:16:25 -05:00
type : integer
2018-11-15 07:10:15 -06:00
file :
type : object
properties :
extensions :
type : array
items :
type : string
2019-08-22 06:33:07 -05:00
videoCaption :
type : object
properties :
file :
type : object
properties :
size :
type : object
properties :
max :
2020-06-24 07:16:25 -05:00
type : integer
2019-08-22 06:33:07 -05:00
extensions :
type : array
items :
type : string
user :
type : object
properties :
videoQuota :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
example : 16810141515
2019-08-22 06:33:07 -05:00
videoQuotaDaily :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
example : 1681014151
2019-08-22 06:33:07 -05:00
trending :
type : object
properties :
videos :
type : object
properties :
intervalDays :
2020-06-24 07:16:25 -05:00
type : integer
2019-08-22 06:33:07 -05:00
tracker :
2019-10-29 02:26:24 -05:00
type : object
2019-08-22 06:33:07 -05:00
properties :
enabled :
type : boolean
2020-02-21 14:25:49 -06:00
followings :
type : object
properties :
instance :
type : object
properties :
autoFollowIndex :
type : object
properties :
indexUrl :
type : string
2020-06-26 06:43:27 -05:00
format : url
2021-05-27 08:59:55 -05:00
homepage :
type : object
properties :
enabled :
type : boolean
2022-07-15 08:30:14 -05:00
SendClientLog :
properties :
message :
type : string
url :
type : string
description : URL of the current user page
level :
enum :
- error
- warn
stackTrace :
type : string
description : Stack trace of the error if there is one
userAgent :
type : string
description : User agent of the web browser that sends the message
meta :
type : string
description : Additional information regarding this log
required :
- message
- url
- level
2022-07-12 07:17:37 -05:00
ServerStats :
properties :
totalUsers :
type : number
totalDailyActiveUsers :
type : number
totalWeeklyActiveUsers :
type : number
totalMonthlyActiveUsers :
type : number
totalLocalVideos :
type : number
totalLocalVideoViews :
type : number
description : Total video views made on the instance
totalLocalVideoComments :
type : number
description : Total comments made by local users
totalLocalVideoFilesSize :
type : number
totalVideos :
type : number
totalVideoComments :
type : number
totalLocalVideoChannels :
type : number
totalLocalDailyActiveVideoChannels :
type : number
totalLocalWeeklyActiveVideoChannels :
type : number
totalLocalMonthlyActiveVideoChannels :
type : number
totalLocalPlaylists :
type : number
totalInstanceFollowers :
type : number
totalInstanceFollowing :
type : number
videosRedundancy :
type : array
items :
type : object
properties :
strategy :
type : string
totalSize :
type : number
totalUsed :
type : number
totalVideoFiles :
type : number
totalVideos :
type : number
totalActivityPubMessagesProcessed :
type : number
totalActivityPubMessagesSuccesses :
type : number
totalActivityPubMessagesErrors :
type : number
activityPubMessagesProcessedPerSecond :
type : number
totalActivityPubMessagesWaiting :
type : number
2019-08-22 06:33:07 -05:00
ServerConfigAbout :
properties :
instance :
type : object
properties :
name :
type : string
shortDescription :
type : string
description :
type : string
terms :
type : string
ServerConfigCustom :
properties :
instance :
type : object
properties :
name :
type : string
shortDescription :
type : string
description :
type : string
terms :
type : string
defaultClientRoute :
type : string
isNSFW :
type : boolean
defaultNSFWPolicy :
type : string
customizations :
type : object
properties :
javascript :
type : string
css :
type : string
theme :
type : object
properties :
default :
type : string
services :
type : object
properties :
twitter :
type : object
properties :
username :
type : string
whitelisted :
type : boolean
cache :
type : object
properties :
previews :
type : object
properties :
size :
2020-06-24 07:16:25 -05:00
type : integer
2019-08-22 06:33:07 -05:00
captions :
type : object
properties :
size :
2020-06-24 07:16:25 -05:00
type : integer
2019-08-22 06:33:07 -05:00
signup :
type : object
properties :
enabled :
type : boolean
limit :
2020-06-24 07:16:25 -05:00
type : integer
2019-08-22 06:33:07 -05:00
requiresEmailVerification :
type : boolean
admin :
type : object
properties :
email :
type : string
2020-06-26 06:43:27 -05:00
format : email
2019-08-22 06:33:07 -05:00
contactForm :
type : object
properties :
enabled :
type : boolean
user :
type : object
2021-05-10 07:17:26 -05:00
description : Settings that apply to new users, if registration is enabled
2019-08-22 06:33:07 -05:00
properties :
videoQuota :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
example : 16810141515
2019-08-22 06:33:07 -05:00
videoQuotaDaily :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 09:09:59 -05:00
example : 1681014151
2019-08-22 06:33:07 -05:00
transcoding :
type : object
2021-05-10 07:17:26 -05:00
description : Settings pertaining to transcoding jobs
2019-08-22 06:33:07 -05:00
properties :
enabled :
type : boolean
allowAdditionalExtensions :
type : boolean
2021-05-10 07:17:26 -05:00
description : Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
2019-08-22 06:33:07 -05:00
allowAudioFiles :
type : boolean
2021-05-10 07:17:26 -05:00
description : If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
2019-08-22 06:33:07 -05:00
threads :
2020-06-24 07:16:25 -05:00
type : integer
2021-05-10 07:17:26 -05:00
description : Amount of threads used by ffmpeg for 1 transcoding job
concurrency :
type : number
description : Amount of transcoding jobs to execute in parallel
profile :
type : string
enum :
- default
description : |
New profiles can be added by plugins ; available in core PeerTube : 'default' .
2019-08-22 06:33:07 -05:00
resolutions :
type : object
2021-05-10 07:17:26 -05:00
description : Resolutions to transcode _new videos_ to
2019-08-22 06:33:07 -05:00
properties :
2021-05-10 07:17:26 -05:00
0p :
type : boolean
2021-11-05 04:23:02 -05:00
144p :
type : boolean
2019-08-22 06:33:07 -05:00
240p :
type : boolean
360p :
type : boolean
480p :
type : boolean
720p :
type : boolean
1080p :
type : boolean
2020-12-24 11:02:04 -06:00
1440p :
type : boolean
2019-08-22 06:33:07 -05:00
2160p :
type : boolean
2023-07-11 02:52:14 -05:00
web_videos :
2021-05-10 07:17:26 -05:00
type : object
2023-07-11 02:21:13 -05:00
description : Web Video specific settings
2021-05-10 07:17:26 -05:00
properties :
enabled :
type : boolean
2019-08-22 06:33:07 -05:00
hls :
type : object
2023-07-11 02:21:13 -05:00
description : HLS specific settings
2019-08-22 06:33:07 -05:00
properties :
enabled :
type : boolean
import :
type : object
properties :
videos :
type : object
properties :
http :
type : object
properties :
enabled :
type : boolean
torrent :
type : object
properties :
enabled :
type : boolean
2022-08-10 02:53:39 -05:00
video_channel_synchronization :
type : object
properties :
enabled :
type : boolean
2019-08-22 06:33:07 -05:00
autoBlacklist :
type : object
properties :
videos :
type : object
properties :
ofUsers :
type : object
properties :
enabled :
type : boolean
followers :
type : object
properties :
instance :
type : object
properties :
enabled :
type : boolean
manualApproval :
type : boolean
2021-05-27 08:59:55 -05:00
CustomHomepage :
properties :
content :
type : string
2018-11-15 07:10:15 -06:00
Follow :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
follower :
$ref : '#/components/schemas/Actor'
following :
$ref : '#/components/schemas/Actor'
score :
type : number
2020-06-25 04:14:43 -05:00
description : score reflecting the reachability of the actor, with steps of `10` and a base score of `1000`.
2018-11-15 07:10:15 -06:00
state :
type : string
enum :
- pending
- accepted
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2018-11-15 07:10:15 -06:00
updatedAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
2020-07-10 02:51:56 -05:00
PredefinedAbuseReasons :
description : Reason categories that help triage reports
type : array
2021-05-10 04:13:41 -05:00
maxItems : 8
2020-07-10 02:51:56 -05:00
items :
type : string
enum :
- violentOrAbusive
- hatefulOrAbusive
- spamOrMisleading
- privacy
- rights
- serverRules
- thumbnails
- captions
2018-11-15 07:10:15 -06:00
Job :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
state :
type : string
enum :
2020-06-26 06:43:27 -05:00
- active
- completed
- failed
- waiting
- delayed
type :
2018-11-15 07:10:15 -06:00
type : string
enum :
2020-06-26 06:43:27 -05:00
- activitypub-http-unicast
- activitypub-http-broadcast
- activitypub-http-fetcher
- activitypub-follow
- video-file-import
- video-transcoding
- email
- video-import
2021-11-09 03:11:20 -06:00
- videos-views-stats
2020-06-26 06:43:27 -05:00
- activitypub-refresher
- video-redundancy
2022-08-10 02:53:39 -05:00
- video-channel-import
2020-06-26 06:43:27 -05:00
data :
type : object
additionalProperties : true
error :
type : object
additionalProperties : true
2018-11-15 07:10:15 -06:00
createdAt :
type : string
2020-06-26 06:43:27 -05:00
format : date-time
finishedOn :
2018-11-15 07:10:15 -06:00
type : string
2020-06-26 06:43:27 -05:00
format : date-time
processedOn :
type : string
format : date-time
2018-11-15 07:10:15 -06:00
AddUserResponse :
properties :
2020-06-27 04:43:43 -05:00
user :
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-27 04:43:43 -05:00
account :
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2021-05-10 04:13:41 -05:00
VideoUploadRequestCommon :
properties :
name :
description : Video name
type : string
2021-05-10 09:09:59 -05:00
example : What is PeerTube?
minLength : 3
maxLength : 120
2021-05-10 04:13:41 -05:00
channelId :
description : Channel id that will contain this video
type : integer
2021-05-10 09:09:59 -05:00
example : 3
minimum : 1
2021-05-10 04:13:41 -05:00
privacy :
$ref : '#/components/schemas/VideoPrivacySet'
category :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoCategorySet'
2021-05-10 04:13:41 -05:00
licence :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLicenceSet'
2021-05-10 04:13:41 -05:00
language :
2021-05-10 07:17:26 -05:00
$ref : '#/components/schemas/VideoLanguageSet'
2021-05-10 04:13:41 -05:00
description :
description : Video description
type : string
2021-05-10 09:09:59 -05:00
example : |
**[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)**
2021-05-10 04:13:41 -05:00
waitTranscoding :
description : Whether or not we wait transcoding before publish the video
type : boolean
support :
description : A text tell the audience how to support the video creator
2021-05-12 06:44:32 -05:00
example : Please support our work on https://soutenir.framasoft.org/en/ <3
2021-05-10 04:13:41 -05:00
type : string
nsfw :
description : Whether or not this video contains sensitive content
type : boolean
tags :
description : Video tags (maximum 5 tags each between 2 and 30 characters)
type : array
minItems : 1
maxItems : 5
uniqueItems : true
2021-05-10 09:09:59 -05:00
example :
- framasoft
- peertube
2021-05-10 04:13:41 -05:00
items :
type : string
minLength : 2
maxLength : 30
commentsEnabled :
description : Enable or disable comments for this video
type : boolean
downloadEnabled :
description : Enable or disable downloading for this video
type : boolean
originallyPublishedAt :
description : Date when the content was originally published
type : string
format : date-time
scheduleUpdate :
$ref : '#/components/schemas/VideoScheduledUpdate'
thumbnailfile :
description : Video thumbnail file
type : string
format : binary
previewfile :
description : Video preview file
type : string
format : binary
2023-06-29 02:48:55 -05:00
videoPasswords :
$ref : '#/components/schemas/AddVideoPasswords'
2021-05-10 04:13:41 -05:00
required :
- channelId
- name
VideoUploadRequestLegacy :
allOf :
- $ref : '#/components/schemas/VideoUploadRequestCommon'
- type : object
required :
- videofile
properties :
videofile :
description : Video file
type : string
format : binary
VideoUploadRequestResumable :
allOf :
- $ref : '#/components/schemas/VideoUploadRequestCommon'
- type : object
required :
- filename
properties :
filename :
description : Video filename including extension
type : string
format : filename
2021-05-10 09:09:59 -05:00
example : what_is_peertube.mp4
2021-05-10 04:13:41 -05:00
thumbnailfile :
description : Video thumbnail file
type : string
format : binary
previewfile :
description : Video preview file
type : string
format : binary
2018-11-15 07:10:15 -06:00
VideoUploadResponse :
properties :
video :
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/id'
2018-11-15 07:10:15 -06:00
uuid :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/Video/properties/uuid'
2021-06-28 10:30:59 -05:00
shortUUID :
$ref : '#/components/schemas/Video/properties/shortUUID'
2023-07-19 09:02:49 -05:00
VideoReplaceSourceRequestResumable :
properties :
filename :
description : Video filename including extension
type : string
format : filename
example : what_is_peertube.mp4
2018-11-15 07:10:15 -06:00
CommentThreadResponse :
properties :
total :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 1
2018-11-15 07:10:15 -06:00
data :
type : array
2020-06-26 06:43:27 -05:00
maxItems : 100
2018-11-15 07:10:15 -06:00
items :
$ref : '#/components/schemas/VideoComment'
CommentThreadPostResponse :
properties :
comment :
$ref : '#/components/schemas/VideoComment'
2022-10-12 09:09:02 -05:00
VideoTokenResponse :
properties :
files :
type : object
properties :
token :
type : string
expires :
type : string
format : date-time
2019-05-24 03:17:54 -05:00
VideoListResponse :
properties :
total :
2020-06-24 07:16:25 -05:00
type : integer
2020-06-26 06:43:27 -05:00
example : 1
2019-05-24 03:17:54 -05:00
data :
type : array
2020-06-26 06:43:27 -05:00
maxItems : 100
2019-05-24 03:17:54 -05:00
items :
$ref : '#/components/schemas/Video'
2020-06-26 06:43:27 -05:00
User :
properties :
2021-05-10 05:01:40 -05:00
account :
$ref : '#/components/schemas/Account'
autoPlayNextVideo :
type : boolean
description : Automatically start playing the upcoming video after the currently playing video
autoPlayNextVideoPlaylist :
type : boolean
description : Automatically start playing the video on the playlist after the currently playing video
autoPlayVideo :
type : boolean
description : Automatically start playing the video on the watch page
blocked :
type : boolean
blockedReason :
type : string
createdAt :
2020-06-26 06:43:27 -05:00
type : string
email :
type : string
format : email
description : The user email
2021-05-10 05:01:40 -05:00
emailVerified :
type : boolean
description : Has the user confirmed their email address?
id :
2021-05-10 18:50:36 -05:00
allOf :
- $ref : '#/components/schemas/id'
2021-05-10 05:01:40 -05:00
readOnly : true
2021-02-01 08:39:13 -06:00
pluginAuth :
type : string
description : Auth plugin to use to authenticate the user
2021-05-10 05:01:40 -05:00
lastLoginDate :
2020-06-26 06:43:27 -05:00
type : string
2021-05-10 05:01:40 -05:00
format : date-time
noInstanceConfigWarningModal :
type : boolean
2021-08-27 03:15:55 -05:00
noAccountSetupWarningModal :
type : boolean
2021-05-10 05:01:40 -05:00
noWelcomeModal :
2020-06-26 06:43:27 -05:00
type : boolean
nsfwPolicy :
$ref : '#/components/schemas/NSFWPolicy'
role :
2022-10-28 09:15:04 -05:00
type : object
properties :
id :
$ref : '#/components/schemas/UserRole'
label :
type : string
enum :
- User
- Moderator
- Administrator
2021-05-10 05:01:40 -05:00
theme :
2020-06-26 06:43:27 -05:00
type : string
2021-05-10 05:01:40 -05:00
description : Theme enabled by this user
username :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/username'
2020-06-26 06:43:27 -05:00
videoChannels :
type : array
items :
$ref : '#/components/schemas/VideoChannel'
2021-05-10 05:01:40 -05:00
videoQuota :
type : integer
description : The user video quota in bytes
example : -1
videoQuotaDaily :
type : integer
description : The user daily video quota in bytes
example : -1
2021-12-15 08:58:10 -06:00
p2pEnabled :
2021-05-10 05:01:40 -05:00
type : boolean
description : Enable P2P in the player
UserWithStats :
allOf :
- $ref : '#/components/schemas/User'
- properties :
# optionally present fields: they require WITH_STATS scope
videosCount :
type : integer
2021-05-27 04:52:03 -05:00
description : Count of videos published
2021-05-10 05:01:40 -05:00
abusesCount :
type : integer
description : Count of reports/abuses of which the user is a target
abusesAcceptedCount :
type : integer
description : Count of reports/abuses created by the user and accepted/acted upon by the moderation team
abusesCreatedCount :
type : integer
description : Count of reports/abuses created by the user
videoCommentsCount :
type : integer
description : Count of comments published
2018-11-15 07:10:15 -06:00
AddUser :
properties :
username :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/username'
2018-11-15 07:10:15 -06:00
password :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/password'
2018-11-15 07:10:15 -06:00
email :
type : string
2020-06-26 06:43:27 -05:00
format : email
description : The user email
2018-11-15 07:10:15 -06:00
videoQuota :
2020-06-26 06:43:27 -05:00
type : integer
2021-05-10 09:09:59 -05:00
description : The user video quota in bytes
example : -1
2019-04-24 09:54:17 -05:00
videoQuotaDaily :
2020-06-26 06:43:27 -05:00
type : integer
2021-05-10 09:09:59 -05:00
description : The user daily video quota in bytes
example : -1
2021-02-01 08:39:13 -06:00
channelName :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/usernameChannel'
2018-11-15 07:10:15 -06:00
role :
2020-04-21 09:41:31 -05:00
$ref : '#/components/schemas/UserRole'
2021-02-01 08:39:13 -06:00
adminFlags :
$ref : '#/components/schemas/UserAdminFlags'
2018-11-15 07:10:15 -06:00
required :
- username
- password
- email
- role
UpdateUser :
properties :
email :
2020-06-26 06:43:27 -05:00
description : The updated email of the user
2021-05-11 14:38:33 -05:00
allOf :
- $ref : '#/components/schemas/User/properties/email'
2021-02-01 08:39:13 -06:00
emailVerified :
type : boolean
description : Set the email as verified
2018-11-15 07:10:15 -06:00
videoQuota :
2020-06-26 06:43:27 -05:00
type : integer
2021-05-10 09:09:59 -05:00
description : The updated video quota of the user in bytes
2019-04-24 09:54:17 -05:00
videoQuotaDaily :
2020-06-26 06:43:27 -05:00
type : integer
2021-05-10 09:09:59 -05:00
description : The updated daily video quota of the user in bytes
2021-02-01 08:39:13 -06:00
pluginAuth :
type : string
nullable : true
description : The auth plugin to use to authenticate the user
example : 'peertube-plugin-auth-saml2'
2018-11-15 07:10:15 -06:00
role :
2020-04-21 09:41:31 -05:00
$ref : '#/components/schemas/UserRole'
2021-02-01 08:39:13 -06:00
adminFlags :
$ref : '#/components/schemas/UserAdminFlags'
2022-01-10 02:17:28 -06:00
password :
$ref : '#/components/schemas/password'
2018-11-15 07:10:15 -06:00
UpdateMe :
properties :
password :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/password'
2021-05-11 14:38:33 -05:00
currentPassword :
$ref : '#/components/schemas/password'
2018-11-15 07:10:15 -06:00
email :
2021-05-11 14:38:33 -05:00
description : new email used for login and service communications
allOf :
- $ref : '#/components/schemas/User/properties/email'
displayName :
2018-11-15 07:10:15 -06:00
type : string
2021-05-11 14:38:33 -05:00
description : new name of the user in its representations
minLength : 3
maxLength : 120
2018-11-15 07:10:15 -06:00
displayNSFW :
type : string
2021-05-11 14:38:33 -05:00
description : new NSFW display policy
2020-06-26 06:43:27 -05:00
enum :
- 'true'
- 'false'
- both
2021-12-15 08:58:10 -06:00
p2pEnabled :
2021-05-11 14:38:33 -05:00
type : boolean
description : whether to enable P2P in the player or not
2018-11-15 07:10:15 -06:00
autoPlayVideo :
2020-06-26 06:43:27 -05:00
type : boolean
2021-05-11 14:38:33 -05:00
description : new preference regarding playing videos automatically
autoPlayNextVideo :
type : boolean
description : new preference regarding playing following videos automatically
autoPlayNextVideoPlaylist :
type : boolean
description : new preference regarding playing following playlist videos automatically
videosHistoryEnabled :
type : boolean
description : whether to keep track of watched history or not
videoLanguages :
type : array
items :
type : string
description : list of languages to filter videos down to
theme :
type : string
noInstanceConfigWarningModal :
type : boolean
2021-08-27 03:15:55 -05:00
noAccountSetupWarningModal :
type : boolean
2021-05-11 14:38:33 -05:00
noWelcomeModal :
type : boolean
2018-11-15 07:10:15 -06:00
GetMeVideoRating :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2018-11-15 07:10:15 -06:00
rating :
2021-05-10 03:26:50 -05:00
type : string
enum :
- like
- dislike
- none
2020-06-26 06:43:27 -05:00
description : Rating of the video
2018-11-15 07:10:15 -06:00
required :
- id
- rating
2019-04-09 04:02:02 -05:00
VideoRating :
properties :
video :
$ref : '#/components/schemas/Video'
rating :
2021-05-10 03:26:50 -05:00
type : string
enum :
- like
- dislike
- none
description : Rating of the video
2019-04-09 04:02:02 -05:00
required :
- video
- rating
2023-01-19 02:27:56 -06:00
2018-11-15 07:10:15 -06:00
RegisterUser :
properties :
username :
2021-05-11 14:38:33 -05:00
description : immutable name of the user, used to find or mention its actor
allOf :
- $ref : '#/components/schemas/username'
2018-11-15 07:10:15 -06:00
password :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/password'
2018-11-15 07:10:15 -06:00
email :
type : string
2020-06-26 06:43:27 -05:00
format : email
2021-05-11 14:38:33 -05:00
description : email of the user, used for login or service communications
2019-06-07 09:59:53 -05:00
displayName :
type : string
2021-05-11 14:38:33 -05:00
description : editable name of the user, displayed in its representations
2020-06-26 06:43:27 -05:00
minLength : 1
maxLength : 120
2019-06-07 09:59:53 -05:00
channel :
type : object
2021-05-11 14:38:33 -05:00
description : channel base information used to create the first channel of the user
2019-06-07 09:59:53 -05:00
properties :
name :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/usernameChannel'
2019-06-07 09:59:53 -05:00
displayName :
2022-02-28 01:34:43 -06:00
type : string
2018-11-15 07:10:15 -06:00
required :
- username
- password
- email
2021-05-03 07:14:45 -05:00
2023-01-19 02:27:56 -06:00
UserRegistrationRequest :
allOf :
- $ref : '#/components/schemas/RegisterUser'
- type : object
properties :
registrationReason :
type : string
description : reason for the user to register on the instance
required :
- registrationReason
UserRegistrationAcceptOrReject :
type : object
properties :
moderationResponse :
type : string
description : Moderation response to send to the user
2023-01-20 08:34:01 -06:00
preventEmailDelivery :
type : boolean
description : Set it to true if you don't want PeerTube to send an email to the user
2023-01-19 02:27:56 -06:00
required :
- moderationResponse
UserRegistration :
properties :
id :
$ref : '#/components/schemas/id'
state :
type : object
properties :
id :
type : integer
enum :
- 1
- 2
- 3
description : 'The registration state (Pending = `1`, Rejected = `2`, Accepted = `3`)'
label :
type : string
registrationReason :
type : string
moderationResponse :
type : string
nullable : true
username :
type : string
email :
type : string
format : email
emailVerified :
type : boolean
accountDisplayName :
type : string
channelHandle :
type : string
channelDisplayName :
type : string
createdAt :
type : string
format : date-time
updatedAt :
type : string
format : date-time
user :
type : object
nullable : true
description : If the registration has been accepted, this is a partial user object created by the registration
properties :
id :
$ref : '#/components/schemas/id'
2021-05-12 14:23:54 -05:00
OAuthClient :
properties :
client_id :
type : string
pattern : /^[a-z0-9]$/
maxLength : 32
minLength : 32
example : v1ikx5hnfop4mdpnci8nsqh93c45rldf
client_secret :
type : string
pattern : /^[a-zA-Z0-9]$/
maxLength : 32
minLength : 32
example : AjWiOapPltI6EnsWQwlFarRtLh4u8tDt
OAuthToken-password :
allOf :
- $ref : '#/components/schemas/OAuthClient'
- type : object
properties :
grant_type :
type : string
enum :
- password
- refresh_token
default : password
username :
$ref : '#/components/schemas/User/properties/username'
password :
$ref : '#/components/schemas/password'
required :
- client_id
- client_secret
- grant_type
- username
- password
OAuthToken-refresh_token :
allOf :
- $ref : '#/components/schemas/OAuthClient'
- type : object
properties :
grant_type :
type : string
enum :
- password
- refresh_token
default : password
refresh_token :
type : string
example : 2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7
required :
- client_id
- client_secret
- grant_type
- refresh_token
2021-05-10 09:09:59 -05:00
VideoChannel :
2022-02-28 01:34:43 -06:00
allOf :
- $ref : '#/components/schemas/Actor'
- type : object
2021-05-10 09:09:59 -05:00
properties :
2022-02-28 01:34:43 -06:00
displayName :
type : string
description : editable name of the channel, displayed in its representations
example : Videos of Framasoft
minLength : 1
maxLength : 120
description :
type : string
example : Videos made with <3 by Framasoft
minLength : 3
maxLength : 1000
support :
type : string
description : text shown by default on all videos of this channel, to tell the audience how to support it
example : Please support our work on https://soutenir.framasoft.org/en/ <3
minLength : 3
maxLength : 1000
isLocal :
readOnly : true
type : boolean
updatedAt :
readOnly : true
type : string
format : date-time
banners :
type : array
items :
$ref : '#/components/schemas/ActorImage'
ownerAccount :
readOnly : true
nullable : true
type : object
properties :
id :
type : integer
uuid :
$ref : '#/components/schemas/UUIDv4'
2022-08-10 02:53:39 -05:00
2023-02-15 08:59:29 -06:00
VideoChannelEdit :
properties :
displayName :
description : Channel display name
description :
description : Channel description
support :
description : How to support/fund the channel
2021-05-03 07:14:45 -05:00
VideoChannelCreate :
allOf :
2023-02-15 08:59:29 -06:00
- $ref : '#/components/schemas/VideoChannelEdit'
2021-05-03 07:14:45 -05:00
- properties :
name :
2021-05-10 09:09:59 -05:00
description : username of the channel to create
allOf :
- $ref : '#/components/schemas/usernameChannel'
2019-05-31 09:30:11 -05:00
required :
- name
- displayName
VideoChannelUpdate :
2021-05-03 07:14:45 -05:00
allOf :
2023-02-15 08:59:29 -06:00
- $ref : '#/components/schemas/VideoChannelEdit'
2021-05-03 07:14:45 -05:00
- properties :
bulkVideosSupportUpdate :
type : boolean
2021-05-10 09:09:59 -05:00
description : Update the support field for all videos of this channel
2023-02-15 08:59:29 -06:00
2021-05-10 07:39:01 -05:00
VideoChannelList :
properties :
total :
type : integer
example : 1
data :
type : array
items :
allOf :
- $ref : '#/components/schemas/VideoChannel'
- $ref : '#/components/schemas/Actor'
2018-01-24 03:44:52 -06:00
2022-08-10 07:56:53 -05:00
ImportVideosInChannelCreate :
type : object
properties :
externalChannelUrl :
type : string
example : https://youtube.com/c/UC_myfancychannel
videoChannelSyncId :
type : integer
description : If part of a channel sync process, specify its id to assign video imports to this channel synchronization
required :
- 'externalChannelUrl'
2022-08-10 02:53:39 -05:00
VideoChannelSync :
type : object
properties :
id :
$ref : '#/components/schemas/id'
state :
type : object
properties :
id :
type : integer
example : 2
label :
type : string
example : PROCESSING
externalChannelUrl :
type : string
example : 'https://youtube.com/c/UC_myfancychannel'
createdAt :
type : string
format : date-time
lastSyncAt :
type : string
format : date-time
nullable : true
channel :
$ref : '#/components/schemas/VideoChannel'
VideoChannelSyncList :
type : object
properties :
total :
type : integer
example : 1
data :
type : array
items :
allOf :
- $ref : '#/components/schemas/VideoChannelSync'
VideoChannelSyncCreate :
type : object
properties :
externalChannelUrl :
type : string
example : https://youtube.com/c/UC_myfancychannel
videoChannelId :
$ref : '#/components/schemas/id'
2020-06-24 07:16:25 -05:00
MRSSPeerLink :
type : object
xml :
name : 'media:peerLink'
properties :
href :
type : string
xml :
attribute : true
type :
type : string
enum :
- application/x-bittorrent
xml :
attribute : true
MRSSGroupContent :
type : object
xml :
name : 'media:content'
properties :
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
xml :
attribute : true
fileSize :
type : integer
xml :
attribute : true
type :
type : string
xml :
attribute : true
framerate :
type : integer
xml :
attribute : true
duration :
type : integer
xml :
attribute : true
height :
type : integer
xml :
attribute : true
lang :
type : string
xml :
attribute : true
VideoCommentsForXML :
type : array
xml :
wrapped : true
name : 'channel'
items :
type : object
xml :
name : 'item'
properties :
link :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
guid :
type : string
pubDate :
type : string
format : date-time
'content:encoded' :
type : string
'dc:creator' :
type : string
VideosForXML :
type : array
xml :
wrapped : true
name : 'channel'
items :
type : object
xml :
name : 'item'
properties :
link :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
description : video watch page URL
guid :
type : string
description : video canonical URL
pubDate :
type : string
format : date-time
description : video publication date
description :
type : string
description : video description
'content:encoded' :
type : string
description : video description
'dc:creator' :
type : string
description : publisher user name
'media:category' :
type : integer
description : video category (MRSS)
'media:community' :
type : object
description : see [media:community](https://www.rssboard.org/media-rss#media-community) (MRSS)
properties :
'media:statistics' :
type : object
properties :
views :
type : integer
xml :
attribute : true
'media:embed' :
type : object
properties :
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
description : video embed path, relative to the canonical URL domain (MRSS)
xml :
attribute : true
'media:player' :
type : object
properties :
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
description : video watch path, relative to the canonical URL domain (MRSS)
xml :
attribute : true
'media:thumbnail' :
type : object
properties :
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
xml :
attribute : true
height :
type : integer
xml :
attribute : true
width :
type : integer
xml :
attribute : true
'media:title' :
type : string
description : see [media:title](https://www.rssboard.org/media-rss#media-title) (MRSS). We only use `plain` titles.
'media:description' :
type : string
'media:rating' :
type : string
enum :
- nonadult
- adult
description : see [media:rating](https://www.rssboard.org/media-rss#media-rating) (MRSS)
'enclosure' :
type : object
description : main streamable file for the video
properties :
url :
type : string
2020-06-26 06:43:27 -05:00
format : url
2020-06-24 07:16:25 -05:00
xml :
attribute : true
type :
type : string
enum :
- application/x-bittorrent
xml :
attribute : true
length :
type : integer
xml :
attribute : true
'media:group' :
type : array
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)
items :
anyOf :
- $ref : '#/components/schemas/MRSSPeerLink'
2020-06-24 15:25:05 -05:00
- $ref : '#/components/schemas/MRSSGroupContent'
NotificationSettingValue :
type : integer
description : >
2022-12-14 07:06:12 -06:00
Notification type. One of the following values, or a sum of multiple values :
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `0` NONE
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `1` WEB
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `2` EMAIL
Notification :
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
type :
type : integer
description : >
Notification type, following the `UserNotificationType` enum :
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `1` NEW_VIDEO_FROM_SUBSCRIPTION
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `2` NEW_COMMENT_ON_MY_VIDEO
2020-06-26 06:43:27 -05:00
2020-07-08 08:51:46 -05:00
- `3` NEW_ABUSE_FOR_MODERATORS
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `4` BLACKLIST_ON_MY_VIDEO
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `5` UNBLACKLIST_ON_MY_VIDEO
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `6` MY_VIDEO_PUBLISHED
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `7` MY_VIDEO_IMPORT_SUCCESS
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `8` MY_VIDEO_IMPORT_ERROR
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `9` NEW_USER_REGISTRATION
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `10` NEW_FOLLOW
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `11` COMMENT_MENTION
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `12` VIDEO_AUTO_BLACKLIST_FOR_MODERATORS
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `13` NEW_INSTANCE_FOLLOWER
2020-06-26 06:43:27 -05:00
2020-06-24 15:25:05 -05:00
- `14` AUTO_INSTANCE_FOLLOWING
2022-01-10 02:17:28 -06:00
2021-12-22 04:01:24 -06:00
- `15` ABUSE_STATE_CHANGE
2022-01-10 02:17:28 -06:00
2021-12-22 04:01:24 -06:00
- `16` ABUSE_NEW_MESSAGE
2022-01-10 02:17:28 -06:00
2021-12-22 04:01:24 -06:00
- `17` NEW_PLUGIN_VERSION
2022-01-10 02:17:28 -06:00
2021-12-22 04:01:24 -06:00
- `18` NEW_PEERTUBE_VERSION
2020-06-24 15:25:05 -05:00
read :
type : boolean
video :
nullable : true
allOf :
- $ref : '#/components/schemas/VideoInfo'
- type : object
properties :
channel :
$ref : '#/components/schemas/ActorInfo'
videoImport :
nullable : true
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
video :
nullable : true
$ref : '#/components/schemas/VideoInfo'
torrentName :
type : string
nullable : true
magnetUri :
2021-05-10 18:50:36 -05:00
$ref : '#/components/schemas/VideoImport/properties/magnetUri'
2020-06-24 15:25:05 -05:00
targetUri :
type : string
2020-06-26 06:43:27 -05:00
format : uri
2020-06-24 15:25:05 -05:00
nullable : true
comment :
nullable : true
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
threadId :
type : integer
video :
$ref : '#/components/schemas/VideoInfo'
account :
$ref : '#/components/schemas/ActorInfo'
videoAbuse :
nullable : true
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
video :
allOf :
- $ref : '#/components/schemas/VideoInfo'
videoBlacklist :
nullable : true
type : object
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
video :
allOf :
- $ref : '#/components/schemas/VideoInfo'
account :
nullable : true
allOf :
- $ref : '#/components/schemas/ActorInfo'
actorFollow :
type : object
nullable : true
properties :
id :
2021-05-10 09:09:59 -05:00
$ref : '#/components/schemas/id'
2020-06-24 15:25:05 -05:00
follower :
$ref : '#/components/schemas/ActorInfo'
state :
type : string
enum :
- pending
- accepted
following :
type : object
properties :
type :
type : string
enum :
- account
- channel
- instance
name :
type : string
displayName :
type : string
host :
type : string
2020-06-26 06:43:27 -05:00
format : hostname
2020-06-24 15:25:05 -05:00
createdAt :
type : string
format : date-time
updatedAt :
type : string
format : date-time
NotificationListResponse :
properties :
total :
type : integer
2020-06-26 06:43:27 -05:00
example : 1
2020-06-24 15:25:05 -05:00
data :
type : array
2020-06-26 06:43:27 -05:00
maxItems : 100
2020-06-24 15:25:05 -05:00
items :
2020-06-25 05:16:08 -05:00
$ref : '#/components/schemas/Notification'
Plugin :
properties :
name :
type : string
2020-06-26 06:43:27 -05:00
example : peertube-plugin-auth-ldap
2020-06-25 05:16:08 -05:00
type :
type : integer
2020-06-26 06:43:27 -05:00
description : >
- `1` : PLUGIN
- `2` : THEME
2020-06-25 05:16:08 -05:00
enum :
- 1
- 2
latestVersion :
type : string
2020-06-26 06:43:27 -05:00
example : 0.0 .3
2020-06-25 05:16:08 -05:00
version :
type : string
2020-06-26 06:43:27 -05:00
example : 0.0 .1
2020-06-25 05:16:08 -05:00
enabled :
type : boolean
uninstalled :
type : boolean
peertubeEngine :
type : string
2020-06-26 06:43:27 -05:00
example : 2.2 .0
2020-06-25 05:16:08 -05:00
description :
type : string
homepage :
type : string
2020-06-26 06:43:27 -05:00
format : url
example : https://framagit.org/framasoft/peertube/official-plugins/tree/master/peertube-plugin-auth-ldap
2020-06-25 05:16:08 -05:00
settings :
type : object
additionalProperties : true
createdAt :
type : string
format : date-time
updatedAt :
type : string
format : date-time
PluginResponse :
properties :
total :
type : integer
2020-06-26 06:43:27 -05:00
example : 1
2020-06-25 05:16:08 -05:00
data :
type : array
2020-06-26 06:43:27 -05:00
maxItems : 100
2020-06-25 05:16:08 -05:00
items :
2020-06-27 04:43:43 -05:00
$ref : '#/components/schemas/Plugin'
2020-11-09 04:21:08 -06:00
LiveVideoUpdate :
properties :
saveReplay :
type : boolean
2023-03-31 02:12:21 -05:00
replaySettings :
$ref : '#/components/schemas/LiveVideoReplaySettings'
2020-12-03 07:10:54 -06:00
permanentLive :
description : User can stream multiple times in a permanent live
type : boolean
2022-03-04 06:40:02 -06:00
latencyMode :
description : User can select live latency mode if enabled by the instance
$ref : '#/components/schemas/LiveVideoLatencyMode'
2020-11-09 04:21:08 -06:00
LiveVideoResponse :
properties :
rtmpUrl :
type : string
2022-04-22 02:50:20 -05:00
description : Included in the response if an appropriate token is provided
2021-11-05 05:36:03 -05:00
rtmpsUrl :
type : string
2022-04-22 02:50:20 -05:00
description : Included in the response if an appropriate token is provided
2020-11-09 04:21:08 -06:00
streamKey :
type : string
2022-04-22 02:50:20 -05:00
description : RTMP stream key to use to stream into this live video. Included in the response if an appropriate token is provided
2020-11-09 04:21:08 -06:00
saveReplay :
type : boolean
2023-03-31 02:12:21 -05:00
replaySettings :
$ref : '#/components/schemas/LiveVideoReplaySettings'
2020-12-03 07:10:54 -06:00
permanentLive :
description : User can stream multiple times in a permanent live
type : boolean
2022-03-04 06:40:02 -06:00
latencyMode :
description : User can select live latency mode if enabled by the instance
$ref : '#/components/schemas/LiveVideoLatencyMode'
2021-04-08 02:34:32 -05:00
2022-10-07 07:53:30 -05:00
RequestTwoFactorResponse :
properties :
otpRequest :
type : object
properties :
requestToken :
type : string
description : The token to send to confirm this request
secret :
type : string
description : The OTP secret
uri :
type : string
description : The OTP URI
2022-08-01 08:48:14 -05:00
VideoStudioCreateTask :
type : array
items :
anyOf :
-
title : cut
type : object
properties :
name :
type : string
enum :
- 'cut'
options :
type : object
properties :
start :
type : integer
end :
type : integer
-
title : add-intro
type : object
properties :
name :
type : string
enum :
- 'add-intro'
options :
type : object
properties :
file :
type : string
format : binary
-
title : add-outro
type : object
properties :
name :
type : string
enum :
- 'add-outro'
options :
type : object
properties :
file :
type : string
format : binary
-
title : add-watermark
type : object
properties :
name :
type : string
enum :
- 'add-watermark'
options :
type : object
properties :
file :
type : string
format : binary
2022-05-03 04:38:07 -05:00
LiveVideoSessionResponse :
2022-08-12 09:41:29 -05:00
properties :
id :
type : integer
startDate :
type : string
format : date-time
description : Start date of the live session
endDate :
type : string
format : date-time
nullable : true
description : End date of the live session
error :
type : integer
enum :
- 1
- 2
- 3
- 4
- 5
nullable : true
description : >
Error type if an error occurred during the live session :
- `1` : Bad socket health (transcoding is too slow)
- `2` : Max duration exceeded
- `3` : Quota exceeded
- `4` : Quota FFmpeg error
- `5` : Video has been blacklisted during the live
replayVideo :
type : object
description : Video replay information
properties :
id :
type : number
uuid :
$ref : '#/components/schemas/UUIDv4'
shortUUID :
$ref : '#/components/schemas/shortUUID'
PlaybackMetricCreate :
properties :
playerMode :
type : string
enum :
- 'p2p-media-loader'
2023-07-11 02:21:13 -05:00
- 'web-video'
2022-08-12 09:41:29 -05:00
resolution :
type : number
description : Current player video resolution
fps :
type : number
description : Current player video fps
2023-07-21 04:42:52 -05:00
p2pEnabled :
type : boolean
p2pPeers :
type : number
description : P2P peers connected (doesn't include WebSeed peers)
2022-08-12 09:41:29 -05:00
resolutionChanges :
type : number
description : How many resolution changes occured since the last metric creation
errors :
type : number
description : How many errors occured since the last metric creation
downloadedBytesP2P :
type : number
description : How many bytes were downloaded with P2P since the last metric creation
downloadedBytesHTTP :
type : number
description : How many bytes were downloaded with HTTP since the last metric creation
uploadedBytesP2P :
type : number
description : How many bytes were uploaded with P2P since the last metric creation
videoId :
oneOf :
- $ref : '#/components/schemas/id'
- $ref : '#/components/schemas/UUIDv4'
- $ref : '#/components/schemas/shortUUID'
required :
- playerMode
- resolutionChanges
- errors
- downloadedBytesP2P
- downloadedBytesHTTP
- uploadedBytesP2P
2023-07-21 04:42:52 -05:00
- p2pEnabled
2022-08-12 09:41:29 -05:00
- videoId
2022-05-03 04:38:07 -05:00
2023-05-02 06:19:26 -05:00
RunnerRegistrationToken :
properties :
id :
type : integer
registrationToken :
type : string
createdAt :
type : string
format : date-time
updatedAt :
type : string
format : date-time
registeredRunnersCount :
type : integer
Runner :
properties :
id :
type : integer
name :
type : string
description :
type : string
ip :
type : string
updatedAt :
type : string
format : date-time
createdAt :
type : string
format : date-time
lastContact :
type : string
format : date-time
RunnerJobType :
type : string
enum :
- vod-web-video-transcoding
- vod-hls-transcoding
- vod-audio-merge-transcoding
- live-rtmp-hls-transcoding
RunnerJobState :
type : integer
enum :
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
description : >
The runner job state :
- `1` Pending
- `2` Processing
- `3` Completed
- `4` Errored
- `5` Waiting for a parent job
- `6` Cancelled
- `7` Parent had an error
- `8` Parent has been cancelled
RunnerJobStateConstant :
type : object
properties :
id :
$ref : '#/components/schemas/RunnerJobState'
label :
type : string
example : 'Processing'
RunnerJobPayload :
anyOf :
- type : object
title : VOD web video transcoding
properties :
input :
type : object
properties :
videoFileUrl :
type : string
output :
type : object
properties :
resolution :
type : number
fps :
type : number
- type : object
title : VOD HLS transcoding
properties :
input :
type : object
properties :
videoFileUrl :
type : string
output :
type : object
properties :
resolution :
type : number
fps :
type : number
- type : object
title : VOD audio merge transcoding
properties :
input :
type : object
properties :
audioFileUrl :
type : string
previewFileUrl :
type : string
output :
type : object
properties :
resolution :
type : number
fps :
type : number
RunnerJob :
properties :
uuid :
$ref : '#/components/schemas/UUIDv4'
type :
$ref : '#/components/schemas/RunnerJobType'
state :
$ref : '#/components/schemas/RunnerJobStateConstant'
payload :
$ref : '#/components/schemas/RunnerJobPayload'
failures :
type : integer
description : Number of times a remote runner failed to process this job. After too many failures, the job in "error" state
error :
nullable : true
type : string
description : Error message if the job is errored
progress :
type : integer
description : Percentage progress
priority :
type : integer
description : Job priority (less has more priority)
updatedAt :
type : string
format : date-time
createdAt :
type : string
format : date-time
startedAt :
type : string
format : date-time
finishedAt :
type : string
format : date-time
parent :
nullable : true
description : If job has a parent job
type : object
properties :
type :
$ref : '#/components/schemas/RunnerJobType'
state :
$ref : '#/components/schemas/RunnerJobStateConstant'
uuid :
$ref : '#/components/schemas/UUIDv4'
runner :
nullable : true
description : If job is associated to a runner
properties :
id :
type : number
name :
type : string
description :
type : string
RunnerJobAdmin :
allOf :
- $ref : '#/components/schemas/RunnerJob'
- type : object
properties :
privatePayload :
type : object
2023-06-29 02:48:55 -05:00
VideoPassword :
properties :
id :
$ref : '#/components/schemas/id'
password :
type : string
minLength : 2
2023-07-11 02:21:13 -05:00
videoId :
2023-06-29 02:48:55 -05:00
$ref : '#/components/schemas/id'
VideoPasswordList :
properties :
total :
type : integer
example : 1
data :
type : array
items :
$ref : '#/components/schemas/VideoPassword'
AddVideoPasswords :
type : array
items :
$ref : "#/components/schemas/VideoPassword/properties/password"
uniqueItems : true
2020-06-27 04:43:43 -05:00
callbacks :
searchIndex :
2020-08-03 02:12:51 -05:00
'https://search.example.org/api/v1/search/videos' :
2020-06-27 04:43:43 -05:00
post :
summary : third-party search index MAY be used instead of the local index, if enabled by the instance admin. see `searchTarget`
responses :
'200' :
description : successful operation
content :
application/json :
schema :
2020-07-02 07:23:50 -05:00
$ref : '#/components/schemas/VideoListResponse'
