PeerTube (7.1.0)
Download OpenAPI specification:Download
URL: https://joinpeertube.org License: AGPLv3.0
The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite HTTP/REST library for your programming language to use PeerTube.
See the REST API quick start for a few examples of using the PeerTube API.
When you sign up for an account on a PeerTube instance, you are given the possibility to generate sessions on it, and authenticate there using an access token. Only one access token can currently be used at a time.
Accounts are given permissions based on their role. There are three roles on PeerTube: Administrator, Moderator, and User. See the roles guide for a detail of their permissions.
The API uses standard HTTP status codes to indicate the success or failure of the API call, completed by a RFC7807-compliant response body.
HTTP 1.1 404 Not Found
Content-Type: application/problem+json; charset=utf-8
{
"detail": "Video not found",
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"status": 404,
"title": "Not Found",
"type": "about:blank"
}
We provide error type (following RFC7807) and code (internal PeerTube code) values for a growing number of cases,
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",
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"status": 403,
"title": "Forbidden",
"type": "https://docs.joinpeertube.org/api-rest-reference.html#section/Errors/does_not_respect_follow_constraints"
}
Here a 403 error could otherwise mean that the video is private or blocklisted.
Validation errors
Each parameter is evaluated on its own against a set of rules before the route validator proceeds with potential testing involving parameter combinations. Errors coming from validation errors appear earlier and benefit from a more detailed error description:
HTTP 1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
"detail": "Incorrect request parameters: id",
"docs": "https://docs.joinpeertube.org/api-rest-reference.html#operation/getVideo",
"instance": "/api/v1/videos/9c9de5e8-0a1e-484a-b099-e80766180",
"invalid-params": {
"id": {
"location": "params",
"msg": "Invalid value",
"param": "id",
"value": "9c9de5e8-0a1e-484a-b099-e80766180"
}
},
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}
Where id is the name of the field concerned by the error, within the route definition.
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
is about.
Deprecated error fields
Some fields could be included with previous versions. They are still included but their use is deprecated:
error: superseded bydetail
We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:
Endpoint (prefix: /api/v1) |
Calls | Time frame |
|---|---|---|
/* |
50 | 10 seconds |
POST /users/token |
15 | 5 minutes |
POST /users/register |
2* | 5 minutes |
POST /users/ask-send-verify-email |
3 | 5 minutes |
Depending on the endpoint, *failed requests are not taken into account. A service
limit is announced by a 429 Too Many Requests status code.
You can get details about the current state of your rate limit by reading the following headers:
| Header | Description |
|---|---|
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 |
This API features Cross-Origin Resource Sharing (CORS), allowing cross-domain communication from the browser for some routes:
| Endpoint |
|------------------------- ---|
| /api/* |
| /download/* |
| /lazy-static/* |
| /.well-known/webfinger |
In addition, all routes serving ActivityPub are CORS-enabled for all origins.
Get private Web Video file
PeerTube >= 6.0
Authorizations:
OAuth2
path Parameters
| filename required | string Filename |
query Parameters
| videoFileToken | string Video file token generated by PeerTube so you don't need to provide an OAuth token in the request header. |
Responses
Get private HLS video file
Authorizations:
OAuth2
path Parameters
| filename required | string Filename |
query Parameters
| reinjectVideoFileToken | boolean Ask the server to reinject videoFileToken in URLs in m3u8 playlist |
| videoFileToken | string Video file token generated by PeerTube so you don't need to provide an OAuth token in the request header. |
Responses
Download video file
Generate a mp4 container that contains at most 1 video stream and at most 1 audio stream. Mainly used to merge the HLS audio only video file and the HLS video only resolution file.
path Parameters
| videoId required | integer >= 1 Example: 42 The video id |
query Parameters
| videoFileIds required | Array of integers streams of video files to mux in the output |
| videoFileToken | string Video file token generated by PeerTube so you don't need to provide an OAuth token in the request header. |
Responses
Comments on videos feeds
path Parameters
| format required | string Enum: "xml" "rss" "rss2" "atom" "atom1" "json" "json1" format expected (we focus on making |
query Parameters
| accountId | string limit listing comments to videos of a specific account |
| accountName | string limit listing comments to videos of a specific account |
| videoChannelId | string limit listing comments to videos of a specific video channel |
| videoChannelName | string limit listing comments to videos of a specific video channel |
| videoId | string limit listing comments to a specific video |
Responses
Response samples
- 200
Content type
<?xml version="1.0" encoding="utf-8"?> <rss version="2.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom"> <channel> <title>PeerTube Nightly</title> <link>https://peertube2.cpy.re</link> <description>This instance is a test instance of the PeerTube project. It is updated to the latest commit in the develop branch every business day, 8pm CET.</description> <lastBuildDate>Thu, 14 Aug 2025 03:03:39 GMT</lastBuildDate> <docs>https://validator.w3.org/feed/docs/rss2.html</docs> <generator>PeerTube - https://peertube2.cpy.re</generator> <image> <title>PeerTube Nightly</title> <url>https://peertube2.cpy.re/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png</url> <link>https://peertube2.cpy.re</link> </image> <copyright>All rights reserved, unless otherwise specified in the terms specified at https://peertube2.cpy.re/about and potential licenses granted by each content's rightholder.</copyright> <atom:link href="https://peertube2.cpy.re/feeds/video-comments.xml?scope=local" rel="self" type="application/rss+xml"/> <item> <title><![CDATA[DEBIAN 13: I could actually use it as my desktop, now! - Numerfolt]]></title> <link>https://peertube2.cpy.re/w/qE5JMjLDKyDAUGFNZS9a8n;threadId=181850</link> <guid>https://peertube2.cpy.re/w/qE5JMjLDKyDAUGFNZS9a8n;threadId=181850</guid> <pubDate>Wed, 13 Aug 2025 13:52:50 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://tilvids.com/accounts/thelinuxexperiment" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>thelinuxexperiment</span></a></span> Thats what I thought when I saw the update notes, but then I would need to setup ZFS again...</p>]]></content:encoded> <dc:creator>Numerfolt</dc:creator> </item> <item> <title><![CDATA[Big GNOME changes, Linux at 6%, Android loses to Epic - Linux Weekly News - Heartshadows 🇪🇺]]></title> <link>https://peertube2.cpy.re/w/a3KUeeDwYimh1V9FgfceQJ;threadId=181848</link> <guid>https://peertube2.cpy.re/w/a3KUeeDwYimh1V9FgfceQJ;threadId=181848</guid> <pubDate>Mon, 11 Aug 2025 08:19:23 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://tilvids.com/accounts/thelinuxexperiment" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>thelinuxexperiment</span></a></span> i would never have tough that linux whould gain so much, but now i run 90% of my game on linux without any intervention on my end.</p>]]></content:encoded> <dc:creator>Heartshadows 🇪🇺</dc:creator> </item> <item> <title><![CDATA[POP FASCISME : UNE ARMÉE D’INFLUENCEURS POUR GAGNER LA BATAILLE CULTURELLE - Tchois]]></title> <link>https://peertube2.cpy.re/w/oevEW8qxDGtK3GQHcqpeCC;threadId=181847</link> <guid>https://peertube2.cpy.re/w/oevEW8qxDGtK3GQHcqpeCC;threadId=181847</guid> <pubDate>Sun, 10 Aug 2025 11:36:40 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> conclusion, la gauche en étant un foutoir pas possible, alimenté par des guerres d’ego, fait mieux qu'une extrême droite organisé et largement financé. Ça donne quand même espoir non?</p>]]></content:encoded> <dc:creator>Tchois</dc:creator> </item> <item> <title><![CDATA[Big GNOME changes, Linux at 6%, Android loses to Epic - Linux Weekly News - Thomas Frederiksen]]></title> <link>https://peertube2.cpy.re/w/a3KUeeDwYimh1V9FgfceQJ;threadId=181845</link> <guid>https://peertube2.cpy.re/w/a3KUeeDwYimh1V9FgfceQJ;threadId=181845</guid> <pubDate>Sun, 10 Aug 2025 09:54:16 GMT</pubDate> <content:encoded><![CDATA[<p>I technically wasn’t doing the dishes. cleaning the panini press doesn’t count as doing the dishes…</p> <p>It’ll be interesting to track the digital sovereignty figures over time and compare notes within the sysadmin community.</p> ]]></content:encoded> <dc:creator>Thomas Frederiksen</dc:creator> </item> <item> <title><![CDATA[La méditation 7/9 — SCRIPT #2 - aneonyme]]></title> <link>https://peertube2.cpy.re/w/9gM34PMgfHc5Qc1nj66FqK;threadId=181842</link> <guid>https://peertube2.cpy.re/w/9gM34PMgfHc5Qc1nj66FqK;threadId=181842</guid> <pubDate>Sat, 09 Aug 2025 06:12:17 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://skeptikon.fr/accounts/metadechoc" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>metadechoc</span></a></span> </p><p>La confusion entre spiritualité et mystique est à la base de toute dérive sectaire. Il n'y à de spirituel que le détachement du corporel et son alter-égo le bien nommé égo. leur asservissement par le mystique est la négation de toute spiritualité et la méditation devient dans ce cas un outil d'asservissement qui ne fait qu'amplifier la perte de sens déjà présente et récurrente. Croyants, fans, supporters etc... sont les scories, déjections, de ces pratiques courantes aliénantes</p>]]></content:encoded> <dc:creator>aneonyme</dc:creator> </item> <item> <title><![CDATA[Surveillance des populations : l'alliance glaçante entre BigTech et États - Thomas Bourdon]]></title> <link>https://peertube2.cpy.re/w/viEQK9j77LNx2QgaUusBz7;threadId=181841</link> <guid>https://peertube2.cpy.re/w/viEQK9j77LNx2QgaUusBz7;threadId=181841</guid> <pubDate>Sat, 09 Aug 2025 04:46:45 GMT</pubDate> <content:encoded><![CDATA[<p>Merci pour ce reportage qui démontre une fois encore que j'ai raison de sensibiliser mes proches sur le sujet… sans effet malheureusement.</p> ]]></content:encoded> <dc:creator>Thomas Bourdon</dc:creator> </item> <item> <title><![CDATA[Surveillance des populations : l'alliance glaçante entre BigTech et États - GBDC φ #EnGrève ⏚]]></title> <link>https://peertube2.cpy.re/w/viEQK9j77LNx2QgaUusBz7;threadId=181840</link> <guid>https://peertube2.cpy.re/w/viEQK9j77LNx2QgaUusBz7;threadId=181840</guid> <pubDate>Sat, 09 Aug 2025 01:09:16 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> De plus en plus libres d'être de plus en plus dépendant(e)s.</p><p>"Nos télécrans tiennent dans votre poche, vos complicités d'assassinats est leur prix."</p>]]></content:encoded> <dc:creator>GBDC φ #EnGrève ⏚</dc:creator> </item> <item> <title><![CDATA[La lutte des classes c’est aussi dans votre assiette - Lien Rag]]></title> <link>https://peertube2.cpy.re/w/tfDJQtuoioe3bXAvRoXbPR;threadId=181839</link> <guid>https://peertube2.cpy.re/w/tfDJQtuoioe3bXAvRoXbPR;threadId=181839</guid> <pubDate>Fri, 08 Aug 2025 19:14:18 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> <span><a href="https://piaille.fr/@Modiie" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>Modiie</span></a></span> Très intéresant ! Mais sur l'alimentation y'a pas que du social, y'a aussi du biologique : tel ou tel régime alimentaire aura des conséquences précises sur la santé de qui le suit (même si tout n'est pas encore toujours bien connu scientifiquement sur ces questions). C'est dommage de faire l'impasse là-dessus : la bonne sociologie est justement celle qui s'intéresse à la dialectique entre l'idéel et le matériel, entre l'inventivité du social et les contraintes du biologique.</p>]]></content:encoded> <dc:creator>Lien Rag</dc:creator> </item> <item> <title><![CDATA[La lutte des classes c’est aussi dans votre assiette - 🏴☠️ MC Pablo ∴]]></title> <link>https://peertube2.cpy.re/w/tfDJQtuoioe3bXAvRoXbPR;threadId=181838</link> <guid>https://peertube2.cpy.re/w/tfDJQtuoioe3bXAvRoXbPR;threadId=181838</guid> <pubDate>Fri, 08 Aug 2025 18:05:25 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> Pour aller plus loin sur l'idée d'une Sécurité sociale de l'alimentation, je recommande le bouquin "Régime général" des Éditions Syndicalistes : <a href="https://www.editionssyndicalistes.fr/produit/regime-general/" target="_blank" rel="noopener noreferrer"><span>https://www.</span><span>editionssyndicalistes.fr/produ</span><span>it/regime-general/</span></a></p>]]></content:encoded> <dc:creator>🏴☠️ MC Pablo ∴</dc:creator> </item> <item> <title><![CDATA[KDE Linux, GNOME OS: why ALL desktops should have their distro! - asudox]]></title> <link>https://peertube2.cpy.re/w/sDo8nouvj2Ht9JjA7WEGXY;threadId=181831</link> <guid>https://peertube2.cpy.re/w/sDo8nouvj2Ht9JjA7WEGXY;threadId=181831</guid> <pubDate>Wed, 06 Aug 2025 23:09:38 GMT</pubDate> <content:encoded><![CDATA[<p>At least we'll be able to have a chance of mainstreaming a Linux distro from trusted devs.</p> <p>Is the year of Linux just around the corner? I'm excited to see what'll happen after the end of Windows 10.</p> ]]></content:encoded> <dc:creator>asudox</dc:creator> </item> <item> <title><![CDATA[Med Spas: Last Week Tonight with John Oliver (HBO) - jamil]]></title> <link>https://peertube2.cpy.re/w/rKybhzkdHEtYaQDqgTkj4b;threadId=181829</link> <guid>https://peertube2.cpy.re/w/rKybhzkdHEtYaQDqgTkj4b;threadId=181829</guid> <pubDate>Wed, 06 Aug 2025 17:07:32 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://tube.fede.re/accounts/lastweektonight" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>lastweektonight</span></a></span> we miss you ❤️❤️❤️</p>]]></content:encoded> <dc:creator>jamil</dc:creator> </item> <item> <title><![CDATA[KDE Linux, GNOME OS: why ALL desktops should have their distro! - shortwavesurfer2009]]></title> <link>https://peertube2.cpy.re/w/sDo8nouvj2Ht9JjA7WEGXY;threadId=181828</link> <guid>https://peertube2.cpy.re/w/sDo8nouvj2Ht9JjA7WEGXY;threadId=181828</guid> <pubDate>Wed, 06 Aug 2025 10:00:59 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://tilvids.com/accounts/thelinuxexperiment" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>thelinuxexperiment</span></a></span> I love the idea of having a reference implementation, so you get the software exactly as the developer intended you to get the software.</p>]]></content:encoded> <dc:creator>shortwavesurfer2009</dc:creator> </item> <item> <title><![CDATA[Le criminel c'est l'électeur - Albert Libertad - Scalp60]]></title> <link>https://peertube2.cpy.re/w/vv91Nf5aRskWMCy4oQRVad;threadId=181827</link> <guid>https://peertube2.cpy.re/w/vv91Nf5aRskWMCy4oQRVad;threadId=181827</guid> <pubDate>Wed, 06 Aug 2025 09:45:38 GMT</pubDate> <content:encoded><![CDATA[<p>texte complet ici : <a href="https://fr.anarchistlibraries.net/library/albert-libertad-le-criminel-c-est-l-electeur" target="_blank" rel="noopener noreferrer">https://fr.anarchistlibraries.net/library/albert-libertad-le-criminel-c-est-l-electeur</a></p> ]]></content:encoded> <dc:creator>Scalp60</dc:creator> </item> <item> <title><![CDATA[Marche pour Gaza : les pays arabes complices du génocide - Gruik]]></title> <link>https://peertube2.cpy.re/w/6RShnTTrQRQg9oFMbSPw4t;threadId=181823</link> <guid>https://peertube2.cpy.re/w/6RShnTTrQRQg9oFMbSPw4t;threadId=181823</guid> <pubDate>Tue, 05 Aug 2025 21:43:30 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> big up au Jeff</p>]]></content:encoded> <dc:creator>Gruik</dc:creator> </item> <item> <title><![CDATA[KDE's distro, AUR & 3rd party package problems, Hyperland's paid subscription: Linux Weekly News - Bonkers]]></title> <link>https://peertube2.cpy.re/w/97HiXKPmKVggrcr5xCcjkZ;threadId=181818</link> <guid>https://peertube2.cpy.re/w/97HiXKPmKVggrcr5xCcjkZ;threadId=181818</guid> <pubDate>Tue, 05 Aug 2025 13:56:56 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://social.tchncs.de/@Blort" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>Blort</span></a></span> <span><a href="https://mastodon.social/@pyte" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>pyte</span></a></span> <span><a href="https://tilvids.com/accounts/thelinuxexperiment" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>thelinuxexperiment</span></a></span> it's pretty cool, I installed it on an old laptop and it's pretty smooth, apart from the fact that the desktop was broken two days ago :)</p><p>The installer doesn't make any swap partition, so it won't run well on old hardware with 2GB RAM. Also, it's all flatpak only. I haven't yet realized if it's an inconvenience or it's fine.</p><p><a href="https://nerdculture.de/tags/kdelinux" class="mention hashtag" rel="noopener noreferrer" target="_blank">#<span>kdelinux</span></a></p>]]></content:encoded> <dc:creator>Bonkers</dc:creator> </item> <item> <title><![CDATA[KDE's distro, AUR & 3rd party package problems, Hyperland's paid subscription: Linux Weekly News - Blort™ 🐀Ⓥ🥋☣️]]></title> <link>https://peertube2.cpy.re/w/97HiXKPmKVggrcr5xCcjkZ;threadId=181818</link> <guid>https://peertube2.cpy.re/w/97HiXKPmKVggrcr5xCcjkZ;threadId=181818</guid> <pubDate>Tue, 05 Aug 2025 06:42:30 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://mastodon.social/@pyte" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>pyte</span></a></span> <span><a href="https://tilvids.com/accounts/thelinuxexperiment" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>thelinuxexperiment</span></a></span> </p><p>Really? Where? The only thing I managed to find on KDE Linux was a wiki page at: <a href="https://community.kde.org/KDE_Linux" target="_blank" rel="noopener noreferrer"><span>https://</span><span>community.kde.org/KDE_Linux</span><span></span></a></p><p>This doesn't seem to have any development news, screenshots etc., just text goals, some technical info and test iso's.</p><p>It would be nice to hear about what's been happening without having to install a whole operating system and dig around to find any changes.</p><p><a href="https://social.tchncs.de/tags/KDELinux" class="mention hashtag" rel="noopener noreferrer" target="_blank">#<span>KDELinux</span></a> <a href="https://social.tchncs.de/tags/KDE" class="mention hashtag" rel="noopener noreferrer" target="_blank">#<span>KDE</span></a></p>]]></content:encoded> <dc:creator>Blort™ 🐀Ⓥ🥋☣️</dc:creator> </item> <item> <title><![CDATA[Pleased Knees! Episode 1 - pieguy]]></title> <link>https://peertube2.cpy.re/w/pPivuKCEqCToqjaPmCc5gq;threadId=181735</link> <guid>https://peertube2.cpy.re/w/pPivuKCEqCToqjaPmCc5gq;threadId=181735</guid> <pubDate>Mon, 04 Aug 2025 21:58:35 GMT</pubDate> <content:encoded><![CDATA[<p>@qrstuv Prove it.</p> ]]></content:encoded> <dc:creator>pieguy</dc:creator> </item> <item> <title><![CDATA[La méditation 7/9 — SCRIPT #2 - Eowyn]]></title> <link>https://peertube2.cpy.re/w/9gM34PMgfHc5Qc1nj66FqK;threadId=181814</link> <guid>https://peertube2.cpy.re/w/9gM34PMgfHc5Qc1nj66FqK;threadId=181814</guid> <pubDate>Mon, 04 Aug 2025 21:53:24 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://skeptikon.fr/accounts/metadechoc" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>metadechoc</span></a></span> l'apprentissage de la meditation a l'ecole ne pose pas un problebe de laicite?</p>]]></content:encoded> <dc:creator>Eowyn</dc:creator> </item> <item> <title><![CDATA[La méditation 4/8 — SCRIPT #2 - Étienne Parmentier]]></title> <link>https://peertube2.cpy.re/w/i1ubJGeUDycJiCWcVVfeJB;threadId=181813</link> <guid>https://peertube2.cpy.re/w/i1ubJGeUDycJiCWcVVfeJB;threadId=181813</guid> <pubDate>Mon, 04 Aug 2025 20:45:10 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://skeptikon.fr/accounts/metadechoc" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>metadechoc</span></a></span> les épisodes sur skeptikon apparaissent bien plus tard que ceux sur YouTube pourquoi ?</p>]]></content:encoded> <dc:creator>Étienne Parmentier</dc:creator> </item> <item> <title><![CDATA[Fuir pour survivre : et si c'était vous ? - MusiqueNow :pride: ✡️ 🇵🇸 :anarchismhebrew:]]></title> <link>https://peertube2.cpy.re/w/3HQ2GHydeTbrmSYqGkaLvj;threadId=181812</link> <guid>https://peertube2.cpy.re/w/3HQ2GHydeTbrmSYqGkaLvj;threadId=181812</guid> <pubDate>Mon, 04 Aug 2025 16:37:01 GMT</pubDate> <content:encoded><![CDATA[<p><span><a href="https://video.blast-info.fr/accounts/blast" class="u-url mention" target="_blank" rel="noopener noreferrer">@<span>blast</span></a></span> </p><p><a href="https://todon.eu/tags/Jojo" class="mention hashtag" rel="noopener noreferrer" target="_blank">#<span>Jojo</span></a> et ça visage comne un serial killer!</p>]]></content:encoded> <dc:creator>MusiqueNow :pride: ✡️ 🇵🇸 :anarchismhebrew:</dc:creator> </item> </channel> </rss>
Common videos feeds
path Parameters
| format required | string Enum: "xml" "rss" "rss2" "atom" "atom1" "json" "json1" format expected (we focus on making |
query Parameters
| accountId | string limit listing to a specific account |
| accountName | string limit listing to a specific account |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| sort | string Example: sort=-createdAt Sort column |
| videoChannelId | string limit listing to a specific video channel |
| videoChannelName | string limit listing to a specific video channel |
Responses
Response samples
- 200
Content type
<?xml version="1.0" encoding="utf-8"?> <rss version="2.0" xmlns:podcast="https://podcastindex.org/namespace/1.0" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:media="http://search.yahoo.com/mrss/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom"> <channel> <title>PeerTube Nightly</title> <link>https://peertube2.cpy.re</link> <description>This instance is a test instance of the PeerTube project. It is updated to the latest commit in the develop branch every business day, 8pm CET.</description> <lastBuildDate>Thu, 14 Aug 2025 03:03:39 GMT</lastBuildDate> <docs>https://validator.w3.org/feed/docs/rss2.html</docs> <generator>PeerTube - https://peertube2.cpy.re</generator> <image> <title>PeerTube Nightly</title> <url>https://peertube2.cpy.re/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png</url> <link>https://peertube2.cpy.re</link> </image> <copyright>All rights reserved, unless otherwise specified in the terms specified at https://peertube2.cpy.re/about and potential licenses granted by each content's rightholder.</copyright> <atom:link href="https://peertube2.cpy.re/feeds/videos.xml?scope=local" rel="self" type="application/rss+xml"/> <item> <title><![CDATA[Lecture de l'épisode 5 de « Sur le front des urgences civilisationnelles », poème titré Résonance]]></title> <link>https://peertube2.cpy.re/w/8CMuL8rYUuGLTzBrmRv8b9</link> <guid>https://peertube2.cpy.re/w/8CMuL8rYUuGLTzBrmRv8b9</guid> <pubDate>Wed, 13 Aug 2025 19:04:59 GMT</pubDate> <description><![CDATA[Texte poétique lu : « Sur le front des urgences civilisationnelles_ » ~ Épisode 5 ~ Résonance Résonne sur les réseaux des alertes, des alarmes, de lanceurs d’infos, sourcées, étudiées, va-carme ; Le silence des baleines, des...]]></description> <content:encoded><![CDATA[<p>Texte poétique lu : « <strong>Sur le front des urgences civilisationnelles_</strong> »<br /> ~ Épisode 5 ~<br /> <strong><em>Résonance</em></strong></p> <p>Résonne sur les réseaux<br /> des alertes, des alarmes,<br /> de lanceurs d’infos,<br /> sourcées, étudiées, va-carme ;</p> <p>Le silence des baleines,<br /> des absences de chants,<br /> comme si en berne,<br /> urgence d’Océans ;</p> <p>Thwaites qu’à un fil,<br /> Big Apple pourrait être coulée,<br /> ainsi de nombreuses îles,<br /> saisons d’hémisphères déréglées ;</p> <p>Des panaches, du corail qui dépérit,<br /> de pollutions, jusqu’au continent de plastiques,<br /> par l’anthropocène capitalocène en politique,<br /> de cause à effets, nombreux soucis écrits ;</p> <p>L’évolution des courants<br /> pourraient bien tout chambouler,<br /> avec l’irruption de volcans,<br /> des éclats non artificiels, tel apogée, découler ;</p> <p>En cours çà et là,<br /> des éléments s’expriment à leur façon ;<br /> qui écoute, à en comprendre la loi ?<br /> résonance jusqu’à acter de la solution (*).</p> <p>(*) Systémique, anticapitaliste, <strong>végane</strong> autant que faire se peut, à en être <strong>antispéciste</strong> jusqu’à la concrétisation des idéaux de la <strong>zoopolis</strong>. Cf ce qu’évoqué au fil du « <strong><em>Le rendez-vous du vendredi</em></strong> » : <a href="https://www.cuisine-art-politique-et-compagnie.com/forums/sujet/le-rendez-vous-du-vendredi/" target="_blank" rel="noopener noreferrer">https://www.cuisine-art-politique-et-compagnie.com/forums/sujet/le-rendez-vous-du-vendredi/</a></p> <p>Pour écouter les <strong>premiers épisodes</strong> : <a href="https://indymotion.fr/w/p/poNs3xNm2top3kzYwfHBsn" target="_blank" rel="noopener noreferrer">https://indymotion.fr/w/p/poNs3xNm2top3kzYwfHBsn</a></p> ]]></content:encoded> <dc:creator>Cuisine, Art, Politique et compagnie Vegan</dc:creator> <category>Entertainment</category> <enclosure length="55572652" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020?videoFileIds=5493719"/> <media:community> <media:statistics views="4"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/8CMuL8rYUuGLTzBrmRv8b9"/> <media:player url="https://peertube2.cpy.re/w/8CMuL8rYUuGLTzBrmRv8b9"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/2525fdc6-0682-4eb1-bed3-cbf98fef5a5b-1080-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/cf45aa54-82ef-4f73-8cd3-eefb028cfa14-720-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/fa396260-f7d8-4b6c-85d7-cbddbc75dd44-480-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/ea6e4785-4d12-4d49-b492-d357c84c7be7-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/be63f290-8940-4336-a1f9-5d26646028ed-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="1080" fileSize="55572652" url="https://static.indymotion.fr/streaming-playlists/hls/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020/118c6a8b-d8ee-483a-a300-649b8e0394c9-1080-fragmented.mp4" framerate="25" duration="142" isDefault="true"/> <media:content type="video/mp4" medium="video" height="720" fileSize="29742622" url="https://static.indymotion.fr/streaming-playlists/hls/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020/89261887-23b3-4643-97fc-387cd8c04688-720-fragmented.mp4" framerate="25" duration="142" isDefault="false"/> <media:content type="video/mp4" medium="video" height="480" fileSize="15947751" url="https://static.indymotion.fr/streaming-playlists/hls/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020/0dcd7575-e875-44f1-9d16-4f87f692d51e-480-fragmented.mp4" framerate="25" duration="142" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="7848593" url="https://static.indymotion.fr/streaming-playlists/hls/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020/57cf7f51-960d-4f07-a191-54156b79f4d6-240-fragmented.mp4" framerate="25" duration="142" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2317974" url="https://static.indymotion.fr/streaming-playlists/hls/3dd2c8bf-5d4a-48f8-94f0-6cb23ea45020/cf007e8d-7f4a-4f75-8de3-a9f2a86ad589-0-fragmented.mp4" framerate="0" duration="142" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/34172d9a-314f-486a-9005-edcf0d1ac4fe.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/6233c7e8-2aa9-410d-8db9-46c8ec6e4002.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Lecture de l'épisode 5 de « Sur le front des urgences civilisationnelles », poème titré Résonance</media:title> <media:description type="plain">Texte poétique lu : « Sur le front des urgences civilisationnelles_ » ~ Épisode 5 ~ Résonance Résonne sur les réseaux des alertes, des alarmes, de lanceurs d’infos, sourcées, étudiées, va-carme ; Le silence des baleines, des...</media:description> </item> <item> <title><![CDATA[Velvet Revolver - Dirty Little Thing (VIDEO)]]></title> <link>https://peertube2.cpy.re/w/q2NuLtf7NQxB4N6u8BDdcd</link> <guid>https://peertube2.cpy.re/w/q2NuLtf7NQxB4N6u8BDdcd</guid> <pubDate>Wed, 13 Aug 2025 18:51:59 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="14722351" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/c29bb9cc-5717-4837-a2d6-2ecf97c54c12?videoFileIds=5493715"/> <media:community> <media:statistics views="4"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/q2NuLtf7NQxB4N6u8BDdcd"/> <media:player url="https://peertube2.cpy.re/w/q2NuLtf7NQxB4N6u8BDdcd"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/b0aea5cc-fbcf-474e-bcb2-a7ff169f3697-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/9e33a22f-3e47-4451-8b3e-be840d85484a-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="14722351" url="https://www.yiny.org/static/streaming-playlists/hls/c29bb9cc-5717-4837-a2d6-2ecf97c54c12/ab3a98b2-6dca-4592-90a0-63eb19312dd9-240-fragmented.mp4" framerate="30" duration="237" isDefault="true"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="3875522" url="https://www.yiny.org/static/streaming-playlists/hls/c29bb9cc-5717-4837-a2d6-2ecf97c54c12/98fe57b0-288a-4fb8-aa36-3ffee90f9a85-0-fragmented.mp4" framerate="0" duration="237" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/5a376bbb-7c71-47f3-8d60-1f6ae2e62867.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/ea0ae6ce-8b2b-4bb5-9132-bd417e32ae8e.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Velvet Revolver - Dirty Little Thing (VIDEO)</media:title> </item> <item> <title><![CDATA[White_Town_-_Your_Woman]]></title> <link>https://peertube2.cpy.re/w/dqAZEuwTyVFttrRFVdxfSH</link> <guid>https://peertube2.cpy.re/w/dqAZEuwTyVFttrRFVdxfSH</guid> <pubDate>Wed, 13 Aug 2025 18:51:52 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="36936216" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/649d1491-5288-4e74-bc3f-2c11c183c66d?videoFileIds=5493718"/> <media:community> <media:statistics views="5"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/dqAZEuwTyVFttrRFVdxfSH"/> <media:player url="https://peertube2.cpy.re/w/dqAZEuwTyVFttrRFVdxfSH"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/ad7badf9-4e0d-4548-9027-8f96e337743f-720-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/eacc0904-f54c-4e2f-8ef1-31ffcbb890fb-480-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/eba0e95f-2ceb-45b2-9b54-0fd69c2b85cf-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/159063fc-ae30-49e7-a429-5bdcdc17c676-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="720" fileSize="36936216" url="https://www.yiny.org/static/streaming-playlists/hls/649d1491-5288-4e74-bc3f-2c11c183c66d/13b15c74-5254-4d32-a81e-a6769c4b11d1-720-fragmented.mp4" framerate="30" duration="260" isDefault="true"/> <media:content type="video/mp4" medium="video" height="480" fileSize="23427885" url="https://www.yiny.org/static/streaming-playlists/hls/649d1491-5288-4e74-bc3f-2c11c183c66d/0dba7146-ebdc-4b6f-8324-988d38f6a96d-480-fragmented.mp4" framerate="30" duration="260" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="11997084" url="https://www.yiny.org/static/streaming-playlists/hls/649d1491-5288-4e74-bc3f-2c11c183c66d/4f6c9633-1695-4876-9ba4-45dfdfefab13-240-fragmented.mp4" framerate="30" duration="260" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4348178" url="https://www.yiny.org/static/streaming-playlists/hls/649d1491-5288-4e74-bc3f-2c11c183c66d/0b938405-ecb0-450d-8d87-ed70143be12e-0-fragmented.mp4" framerate="0" duration="260" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/341e0e2c-e585-45de-91a5-8e92663a8614.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/5b819eb5-4d9b-4f72-b00a-3d3b062c5355.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">White_Town_-_Your_Woman</media:title> </item> <item> <title><![CDATA[Toto Cutugno - Flash SUBTÍTULOS en Español]]></title> <link>https://peertube2.cpy.re/w/8s3m4KCLUmtz5srPfL4gqJ</link> <guid>https://peertube2.cpy.re/w/8s3m4KCLUmtz5srPfL4gqJ</guid> <pubDate>Wed, 13 Aug 2025 18:50:26 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="11626183" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/3c52c11e-f5ee-4df9-a6fc-08f706d970ee?videoFileIds=5493709"/> <media:community> <media:statistics views="2"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/8s3m4KCLUmtz5srPfL4gqJ"/> <media:player url="https://peertube2.cpy.re/w/8s3m4KCLUmtz5srPfL4gqJ"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/e7460115-f07d-454a-8ba3-e964b3cdadf3-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/a6739de6-632f-45c1-a580-2d243e1daca1-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="11626183" url="https://www.yiny.org/static/streaming-playlists/hls/3c52c11e-f5ee-4df9-a6fc-08f706d970ee/989e00ce-7a5f-43d3-93d8-da12ec45895e-240-fragmented.mp4" framerate="30" duration="198" isDefault="true"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="3251750" url="https://www.yiny.org/static/streaming-playlists/hls/3c52c11e-f5ee-4df9-a6fc-08f706d970ee/4c8b14b6-134e-4b39-a6a9-abb1fa525140-0-fragmented.mp4" framerate="0" duration="198" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/1ae8bb3b-955d-4807-9752-c9fece17a197.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/3bde9a65-52b2-4864-a187-e7bf5b19c641.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Toto Cutugno - Flash SUBTÍTULOS en Español</media:title> </item> <item> <title><![CDATA[Tom Fogerty Lady Of Fatima]]></title> <link>https://peertube2.cpy.re/w/hoDTJFmPg6m2J2NvoA4rVk</link> <guid>https://peertube2.cpy.re/w/hoDTJFmPg6m2J2NvoA4rVk</guid> <pubDate>Wed, 13 Aug 2025 18:49:39 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="10230583" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/84bbeeea-f772-407b-bfb4-e6cfe0acac31?videoFileIds=5493703"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/hoDTJFmPg6m2J2NvoA4rVk"/> <media:player url="https://peertube2.cpy.re/w/hoDTJFmPg6m2J2NvoA4rVk"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/e72e70a5-f6fb-4a96-8cc4-08aa24e53a4a-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/393fb9d6-0e25-4ca4-acc8-0008905e1109-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/afcd15b0-719c-4efa-bd11-e1f38c4a2550-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="10230583" url="https://www.yiny.org/static/web-videos/f3d5a9fa-15a6-4dbe-8a49-1035b012dda5-240.mp4" framerate="25" duration="267" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="5934217" url="https://www.yiny.org/static/streaming-playlists/hls/84bbeeea-f772-407b-bfb4-e6cfe0acac31/9a0d4063-ec99-414a-aec1-71fff567c278-240-fragmented.mp4" framerate="25" duration="267" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4343819" url="https://www.yiny.org/static/streaming-playlists/hls/84bbeeea-f772-407b-bfb4-e6cfe0acac31/468a920a-ac25-4a99-8dde-1d0cd78e1224-0-fragmented.mp4" framerate="0" duration="267" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/b6393a19-7a04-4cc4-96bd-37fa55ec120f.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/be3d0159-14e1-450a-ab66-510aeea27a6d.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Tom Fogerty Lady Of Fatima</media:title> </item> <item> <title><![CDATA[Tom Fogerty Beauty Is Under The Skin]]></title> <link>https://peertube2.cpy.re/w/4yRfoxAyb17BdHmoiPZXHx</link> <guid>https://peertube2.cpy.re/w/4yRfoxAyb17BdHmoiPZXHx</guid> <pubDate>Wed, 13 Aug 2025 18:49:14 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="5702720" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/1ce1911b-a8aa-469b-b451-81feeaef9d1d?videoFileIds=5493700"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/4yRfoxAyb17BdHmoiPZXHx"/> <media:player url="https://peertube2.cpy.re/w/4yRfoxAyb17BdHmoiPZXHx"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/f0745d14-92a9-4584-9e6e-41b6b5bb17ca-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/a3fdd885-1e0a-4c11-97a7-c4c3491b703c-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/73980de2-e5b6-4dac-95d5-33ad3e3d2590-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="5702720" url="https://www.yiny.org/static/web-videos/ff1b26f3-755c-4ed7-bee2-1ecafb65d8ca-240.mp4" framerate="25" duration="150" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="3311563" url="https://www.yiny.org/static/streaming-playlists/hls/1ce1911b-a8aa-469b-b451-81feeaef9d1d/a9505f31-7616-4b8a-8b1e-370f71d8cf7e-240-fragmented.mp4" framerate="25" duration="150" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2422002" url="https://www.yiny.org/static/streaming-playlists/hls/1ce1911b-a8aa-469b-b451-81feeaef9d1d/511ed897-64ff-409c-9534-e503fc19ade1-0-fragmented.mp4" framerate="0" duration="150" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/dae73a5c-c265-48df-a8cd-8810e3cb63ba.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/07428bb1-755e-461d-8547-6ac494a5bb1a.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Tom Fogerty Beauty Is Under The Skin</media:title> </item> <item> <title><![CDATA[The_Dead_Weather_Treat_Me_Like_Your_Mother_Official_Music_Video]]></title> <link>https://peertube2.cpy.re/w/3P9xKPCH2FDyqm8g7EKSCu</link> <guid>https://peertube2.cpy.re/w/3P9xKPCH2FDyqm8g7EKSCu</guid> <pubDate>Wed, 13 Aug 2025 18:48:45 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="12538338" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/16c78089-9ba6-4efb-a3a5-87a9c36a1364?videoFileIds=5493699"/> <media:community> <media:statistics views="1"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/3P9xKPCH2FDyqm8g7EKSCu"/> <media:player url="https://peertube2.cpy.re/w/3P9xKPCH2FDyqm8g7EKSCu"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/a88562a7-3ab8-40f1-90f5-be611c1a56b8-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/20a2b079-e117-4614-ac6c-2fbd7f84ddf6-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="12538338" url="https://www.yiny.org/static/streaming-playlists/hls/16c78089-9ba6-4efb-a3a5-87a9c36a1364/11ef0861-5411-44e7-8ec3-c53c457b200d-240-fragmented.mp4" framerate="25" duration="277" isDefault="true"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4502345" url="https://www.yiny.org/static/streaming-playlists/hls/16c78089-9ba6-4efb-a3a5-87a9c36a1364/65f089e1-46e8-4279-b48a-b2d64c1318d8-0-fragmented.mp4" framerate="0" duration="277" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/b11d2794-1716-47aa-b330-3d7a918e9d20.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/84c6deea-d7f9-4a5b-9e8a-54246d7a0bd0.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The_Dead_Weather_Treat_Me_Like_Your_Mother_Official_Music_Video</media:title> </item> <item> <title><![CDATA[The Smashing Pumpkins - Ava Adore]]></title> <link>https://peertube2.cpy.re/w/dTwgttgVE6ZDHtBiPssEe5</link> <guid>https://peertube2.cpy.re/w/dTwgttgVE6ZDHtBiPssEe5</guid> <pubDate>Wed, 13 Aug 2025 18:48:06 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="100819819" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/685f3fae-b9fd-490f-97b1-a974c0db951e?videoFileIds=5493693"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/dTwgttgVE6ZDHtBiPssEe5"/> <media:player url="https://peertube2.cpy.re/w/dTwgttgVE6ZDHtBiPssEe5"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/34f2bf05-9383-46fe-a048-86f0c0e73ba0-1080.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/f68c5d78-562a-4c4c-b58f-fec0c6a31a4e-1080-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/4158d8fa-fad8-41cc-93ea-291c5d953f69-720-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/88b11fe1-330b-45cf-9fe1-3badc4b4f46f-480-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/9a916873-db4e-4354-ba8d-2f9356fba333-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/f2b52c54-c37c-4949-bb0c-915e5e97f15c-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="1080" fileSize="100819819" url="https://www.yiny.org/static/web-videos/42dce3e3-ea66-44c3-8ed5-772905b7fb8d-1080.mp4" framerate="25" duration="259" isDefault="true"/> <media:content type="video/mp4" medium="video" height="1080" fileSize="95357596" url="https://www.yiny.org/static/streaming-playlists/hls/685f3fae-b9fd-490f-97b1-a974c0db951e/76b13005-741f-405c-9cd3-4994ec55acd8-1080-fragmented.mp4" framerate="25" duration="259" isDefault="false"/> <media:content type="video/mp4" medium="video" height="720" fileSize="54224286" url="https://www.yiny.org/static/streaming-playlists/hls/685f3fae-b9fd-490f-97b1-a974c0db951e/8b4e507c-814c-47dd-8184-787302e04b53-720-fragmented.mp4" framerate="25" duration="259" isDefault="false"/> <media:content type="video/mp4" medium="video" height="480" fileSize="31213089" url="https://www.yiny.org/static/streaming-playlists/hls/685f3fae-b9fd-490f-97b1-a974c0db951e/d9c5af43-2545-4e8e-96b9-c553a2689701-480-fragmented.mp4" framerate="25" duration="259" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="14810311" url="https://www.yiny.org/static/streaming-playlists/hls/685f3fae-b9fd-490f-97b1-a974c0db951e/3ee690be-592f-4195-950b-afe77be8eb8f-240-fragmented.mp4" framerate="25" duration="259" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4222525" url="https://www.yiny.org/static/streaming-playlists/hls/685f3fae-b9fd-490f-97b1-a974c0db951e/ef4c8dbd-4e60-43d3-af3b-931e0955f183-0-fragmented.mp4" framerate="0" duration="259" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/7f34662e-1046-465b-bb12-e29940853889.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/32aa6b38-1ad9-43cf-9b42-18d2c66f6a51.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Smashing Pumpkins - Ava Adore</media:title> </item> <item> <title><![CDATA[The Wallflowers - One Headlight (Official Music Video)]]></title> <link>https://peertube2.cpy.re/w/7C5R712LMRAyao94FAiRVE</link> <guid>https://peertube2.cpy.re/w/7C5R712LMRAyao94FAiRVE</guid> <pubDate>Wed, 13 Aug 2025 18:47:38 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="15322728" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/35a09831-d380-42ec-96a3-103463efbaf4?videoFileIds=5493690"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/7C5R712LMRAyao94FAiRVE"/> <media:player url="https://peertube2.cpy.re/w/7C5R712LMRAyao94FAiRVE"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/73afcf9a-0edd-4c9c-828a-b1b2843f0b78-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/398cf22e-6cdf-4fa6-8ebc-289ea9ee18ee-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/b8d8801c-1047-4f14-9047-2637cd891d1b-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="15322728" url="https://www.yiny.org/static/web-videos/798e70a5-699e-41c7-8e1a-d1e4e2e13c60-240.mp4" framerate="24" duration="278" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="10450034" url="https://www.yiny.org/static/streaming-playlists/hls/35a09831-d380-42ec-96a3-103463efbaf4/ac727423-c5ab-41c6-8079-f7d73f606584-240-fragmented.mp4" framerate="24" duration="278" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4518370" url="https://www.yiny.org/static/streaming-playlists/hls/35a09831-d380-42ec-96a3-103463efbaf4/250cced7-5826-4c02-aa4c-a2ccb570bb95-0-fragmented.mp4" framerate="0" duration="278" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/d8a27cbc-03a0-4660-97ef-e6b724c0f515.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/5ca5e99e-eb8e-4521-8094-4fece0f08744.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Wallflowers - One Headlight (Official Music Video)</media:title> </item> <item> <title><![CDATA[The Vines - Ride]]></title> <link>https://peertube2.cpy.re/w/bV1vgjJhYDfd6bZNdL34we</link> <guid>https://peertube2.cpy.re/w/bV1vgjJhYDfd6bZNdL34we</guid> <pubDate>Wed, 13 Aug 2025 18:47:01 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="10979469" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/58621e0a-d775-4ddf-a355-0218a8d516d5?videoFileIds=5493687"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/bV1vgjJhYDfd6bZNdL34we"/> <media:player url="https://peertube2.cpy.re/w/bV1vgjJhYDfd6bZNdL34we"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/9f80d6c5-8738-4b46-b365-34ccd6a75ec7-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/f4f368f2-07db-444f-879a-a37f3f1ee18d-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/e2120cb3-a539-4e5e-bb81-316bc964a09f-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="10979469" url="https://www.yiny.org/static/web-videos/8a3a1898-b2ec-496f-9d8d-7261ace3de22-240.mp4" framerate="25" duration="163" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8099846" url="https://www.yiny.org/static/streaming-playlists/hls/58621e0a-d775-4ddf-a355-0218a8d516d5/928f3fd4-d7af-4e61-a440-eac54b17bd3c-240-fragmented.mp4" framerate="25" duration="163" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2693211" url="https://www.yiny.org/static/streaming-playlists/hls/58621e0a-d775-4ddf-a355-0218a8d516d5/9f6b592a-7b9a-4fba-bbc1-756f553d6184-0-fragmented.mp4" framerate="0" duration="163" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/5ff9d478-3e67-4e2c-b006-273dd350d78d.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/303eee4a-d41c-48ba-8831-49d822847ca3.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Vines - Ride</media:title> </item> <item> <title><![CDATA[The Vines - Outtathaway]]></title> <link>https://peertube2.cpy.re/w/6DbtKXJW8ibUDEcXsfcBbr</link> <guid>https://peertube2.cpy.re/w/6DbtKXJW8ibUDEcXsfcBbr</guid> <pubDate>Wed, 13 Aug 2025 18:46:31 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="10407987" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/2daeaba2-740f-45d2-998f-b862b7825a61?videoFileIds=5493686"/> <media:community> <media:statistics views="1"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/6DbtKXJW8ibUDEcXsfcBbr"/> <media:player url="https://peertube2.cpy.re/w/6DbtKXJW8ibUDEcXsfcBbr"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/9e823d55-f9df-437c-9c2b-bb095773062c-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/5b74a3f6-29bc-47b7-a8fc-cc5ecffe994a-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="10407987" url="https://www.yiny.org/static/streaming-playlists/hls/2daeaba2-740f-45d2-998f-b862b7825a61/5c5cd61f-7d8a-4fd8-8dd5-98b27dcc37ff-240-fragmented.mp4" framerate="25" duration="186" isDefault="true"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="3035776" url="https://www.yiny.org/static/streaming-playlists/hls/2daeaba2-740f-45d2-998f-b862b7825a61/6b98da25-c078-4c42-ac9d-b91e1f723ec4-0-fragmented.mp4" framerate="0" duration="186" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/616f48c9-6254-4b13-9604-6aac3f604b7e.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/88c850ab-dbf4-401b-b0b3-c5dd8dbb72d1.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Vines - Outtathaway</media:title> </item> <item> <title><![CDATA[The Vines - Get Free]]></title> <link>https://peertube2.cpy.re/w/u4yTdKaXzxkL1rp6VF1oVo</link> <guid>https://peertube2.cpy.re/w/u4yTdKaXzxkL1rp6VF1oVo</guid> <pubDate>Wed, 13 Aug 2025 18:45:51 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="8046049" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/e33f60f3-c06c-456e-996a-a10f78836680?videoFileIds=5493682"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/u4yTdKaXzxkL1rp6VF1oVo"/> <media:player url="https://peertube2.cpy.re/w/u4yTdKaXzxkL1rp6VF1oVo"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/27b33143-2ceb-4eb6-b9f6-9605b50f9a2a-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/73b83fcd-fe96-4db5-9e37-31dbab3350c0-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/7ccf083d-c118-4f6b-a29c-de44ad6bbbf9-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8046049" url="https://www.yiny.org/static/web-videos/f2d1c9dc-d4f9-4a83-830e-7678d4298e62-240.mp4" framerate="25" duration="131" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="5701095" url="https://www.yiny.org/static/streaming-playlists/hls/e33f60f3-c06c-456e-996a-a10f78836680/4df18678-539f-412d-b26a-476ce6217787-240-fragmented.mp4" framerate="25" duration="131" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2142380" url="https://www.yiny.org/static/streaming-playlists/hls/e33f60f3-c06c-456e-996a-a10f78836680/03da3315-fb10-4d2a-b92c-a1c1953db8ff-0-fragmented.mp4" framerate="0" duration="131" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/e150621f-2aee-48fe-a82d-89f0ad6bcd7f.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/f1efe671-f91d-426c-8d23-35133e6dbc8c.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Vines - Get Free</media:title> </item> <item> <title><![CDATA[The Smashing Pumpkins - Cherub Rock]]></title> <link>https://peertube2.cpy.re/w/wr3CfstqJjwYi4T2JFpZRJ</link> <guid>https://peertube2.cpy.re/w/wr3CfstqJjwYi4T2JFpZRJ</guid> <pubDate>Wed, 13 Aug 2025 18:45:00 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="20067106" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/f6715f2b-5cf3-4f92-b22a-e3cc92e62650?videoFileIds=5493678"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/wr3CfstqJjwYi4T2JFpZRJ"/> <media:player url="https://peertube2.cpy.re/w/wr3CfstqJjwYi4T2JFpZRJ"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/8d3dd218-13fa-4040-9ddd-23e89508ac86-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/63f16740-20f7-407e-80c3-35aeebd9d9df-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/e66c0d61-8842-4f82-9c33-07fd5ca0f833-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="20067106" url="https://www.yiny.org/static/web-videos/fb13731c-6e18-4404-b6eb-e436bbbf31b8-240.mp4" framerate="24" duration="300" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="14843567" url="https://www.yiny.org/static/streaming-playlists/hls/f6715f2b-5cf3-4f92-b22a-e3cc92e62650/a9afea75-1a73-460e-876a-47ceb80ffb29-240-fragmented.mp4" framerate="24" duration="300" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4861820" url="https://www.yiny.org/static/streaming-playlists/hls/f6715f2b-5cf3-4f92-b22a-e3cc92e62650/8a4aca7b-3474-4ead-935d-59da2be42bbe-0-fragmented.mp4" framerate="0" duration="300" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/68d84c2d-af2e-4eed-b0c1-23569305e558.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/79842248-e854-4caa-a9f8-aa279da54008.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Smashing Pumpkins - Cherub Rock</media:title> </item> <item> <title><![CDATA[The Rentals - Friends Of P. (Video)]]></title> <link>https://peertube2.cpy.re/w/7G2KHseBAMgC5wcUVz5ZNa</link> <guid>https://peertube2.cpy.re/w/7G2KHseBAMgC5wcUVz5ZNa</guid> <pubDate>Wed, 13 Aug 2025 18:44:24 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="8323401" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/362da9dc-3f6f-40e9-9941-7672eb75dfc9?videoFileIds=5493675"/> <media:community> <media:statistics views="1"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/7G2KHseBAMgC5wcUVz5ZNa"/> <media:player url="https://peertube2.cpy.re/w/7G2KHseBAMgC5wcUVz5ZNa"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/d7ba1254-150e-4232-8e5c-de82a6fbb9d7-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/29ee88c6-2c57-4efe-a086-9456e91c57f4-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8323401" url="https://www.yiny.org/static/streaming-playlists/hls/362da9dc-3f6f-40e9-9941-7672eb75dfc9/6ff8dc64-bf2f-43f8-be1c-f2f5f04413ab-240-fragmented.mp4" framerate="24" duration="253" isDefault="true"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4178905" url="https://www.yiny.org/static/streaming-playlists/hls/362da9dc-3f6f-40e9-9941-7672eb75dfc9/12986dd4-8239-4c45-a89c-cca4ed80783a-0-fragmented.mp4" framerate="0" duration="253" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/566d8e06-7aa0-4295-8732-83fbf0c767b6.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/96a60458-753f-41d3-8e96-174790340bfe.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Rentals - Friends Of P. (Video)</media:title> </item> <item> <title><![CDATA[The Offspring - (Can_t Get My) Head Around You]]></title> <link>https://peertube2.cpy.re/w/wppEZLu42L2XSUiLQgboGe</link> <guid>https://peertube2.cpy.re/w/wppEZLu42L2XSUiLQgboGe</guid> <pubDate>Wed, 13 Aug 2025 18:43:51 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="10301783" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/f636dae8-829d-4129-ba8e-e1ae18181335?videoFileIds=5493670"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/wppEZLu42L2XSUiLQgboGe"/> <media:player url="https://peertube2.cpy.re/w/wppEZLu42L2XSUiLQgboGe"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/1c5e52ca-6829-4cae-a6b4-06722c77804f-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/84467ebb-8e0d-4ea8-8dd5-b423191cb0ab-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/b093d0a7-0ca6-43b9-8c86-a7c504847943-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="10301783" url="https://www.yiny.org/static/web-videos/852a2905-bcfd-4776-9a0d-7138facb0c5c-240.mp4" framerate="30" duration="132" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8052458" url="https://www.yiny.org/static/streaming-playlists/hls/f636dae8-829d-4129-ba8e-e1ae18181335/e12380d7-e2de-4f2e-a7ff-87a50b1e56ca-240-fragmented.mp4" framerate="30" duration="132" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2157258" url="https://www.yiny.org/static/streaming-playlists/hls/f636dae8-829d-4129-ba8e-e1ae18181335/c1b0b91f-aef9-409f-ba3f-80b0ae84fb3a-0-fragmented.mp4" framerate="0" duration="132" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/8a61773c-a250-4da2-9fdc-0bc9deedaaef.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/9c2fb224-f5d8-4dcc-9b23-fe47190485c1.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The Offspring - (Can_t Get My) Head Around You</media:title> </item> <item> <title><![CDATA[The lemonheads Mrs. Robinson (Remastered)]]></title> <link>https://peertube2.cpy.re/w/sjyzr7aaibjwD9euHq7ydJ</link> <guid>https://peertube2.cpy.re/w/sjyzr7aaibjwD9euHq7ydJ</guid> <pubDate>Wed, 13 Aug 2025 18:43:31 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="8644478" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/d52511a7-2e26-495e-9f9d-eaeda5ddddf2?videoFileIds=5493666"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/sjyzr7aaibjwD9euHq7ydJ"/> <media:player url="https://peertube2.cpy.re/w/sjyzr7aaibjwD9euHq7ydJ"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/a6e366b8-db40-4728-9ad3-c3c12f5ee208-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/2d7a2a6c-0fe4-4299-8201-af3c88158456-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/d9c7a113-b071-45b0-a4a6-2ed57b189f93-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8644478" url="https://www.yiny.org/static/web-videos/aab32225-0c8e-4d4d-a808-029ea6001e2e-240.mp4" framerate="25" duration="224" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="5031590" url="https://www.yiny.org/static/streaming-playlists/hls/d52511a7-2e26-495e-9f9d-eaeda5ddddf2/d26f1086-93b4-45b9-a955-108efeeb5e09-240-fragmented.mp4" framerate="25" duration="224" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="3647231" url="https://www.yiny.org/static/streaming-playlists/hls/d52511a7-2e26-495e-9f9d-eaeda5ddddf2/a518d0f1-1d9d-4740-94fa-68103104a3ac-0-fragmented.mp4" framerate="0" duration="224" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/97ccf007-b7b5-44cd-86ea-65781222c176.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/9f5e15d1-307b-4356-8927-030dbbc1fa22.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">The lemonheads Mrs. Robinson (Remastered)</media:title> </item> <item> <title><![CDATA[Talking Heads - Psycho Killer]]></title> <link>https://peertube2.cpy.re/w/wnc1kSygHChDx4beadGyd2</link> <guid>https://peertube2.cpy.re/w/wnc1kSygHChDx4beadGyd2</guid> <pubDate>Wed, 13 Aug 2025 18:43:10 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="22645409" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/f5e78fc5-1464-45ab-881a-c6933246d419?videoFileIds=5493662"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/wnc1kSygHChDx4beadGyd2"/> <media:player url="https://peertube2.cpy.re/w/wnc1kSygHChDx4beadGyd2"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/76f018f2-0184-45dd-8daf-1f2c50425ae6-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/24190e20-d5f1-4163-969f-db37804d94ab-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/d85799be-2ccd-43e1-a387-f736850a4ea3-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="22645409" url="https://www.yiny.org/static/web-videos/1362efeb-d92a-41c5-98ec-73b4425b283d-240.mp4" framerate="24" duration="313" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="16803320" url="https://www.yiny.org/static/streaming-playlists/hls/f5e78fc5-1464-45ab-881a-c6933246d419/9d8d7e53-c509-4b42-ba3f-3ce689a2ee78-240-fragmented.mp4" framerate="24" duration="313" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="5082057" url="https://www.yiny.org/static/streaming-playlists/hls/f5e78fc5-1464-45ab-881a-c6933246d419/83df7083-17b4-40a5-88bb-d3cce9c92327-0-fragmented.mp4" framerate="0" duration="313" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/abcd5760-2917-4386-a9e3-731ec302d2f9.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/45709d01-5aa9-4c1d-94c2-9ed27d8000e0.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Talking Heads - Psycho Killer</media:title> </item> <item> <title><![CDATA[Superman's_Dead_Official_Canadian_Version_Official_Remastered_HD]]></title> <link>https://peertube2.cpy.re/w/wsPd6TPTfXFuXmxWha17gn</link> <guid>https://peertube2.cpy.re/w/wsPd6TPTfXFuXmxWha17gn</guid> <pubDate>Wed, 13 Aug 2025 18:42:38 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="17407700" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/f6b09757-c521-4a3e-9c1b-b32e472ebae3?videoFileIds=5493658"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/wsPd6TPTfXFuXmxWha17gn"/> <media:player url="https://peertube2.cpy.re/w/wsPd6TPTfXFuXmxWha17gn"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/24d91df6-a9d4-4b16-89b3-a1f58ac5d720-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/3c3688fb-2432-45ff-a5e2-a90760edeacf-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/8d591516-342b-42bf-a686-a0f46f661cc8-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="17407700" url="https://www.yiny.org/static/web-videos/62c644d9-0e7b-4442-8920-076ff0f0e016-240.mp4" framerate="24" duration="266" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="12885598" url="https://www.yiny.org/static/streaming-playlists/hls/f6b09757-c521-4a3e-9c1b-b32e472ebae3/7f473cc9-ebb7-4898-ba9c-1ea886d9810f-240-fragmented.mp4" framerate="24" duration="266" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="4214007" url="https://www.yiny.org/static/streaming-playlists/hls/f6b09757-c521-4a3e-9c1b-b32e472ebae3/ef9ba266-2d62-4b5a-82a2-3c6c8b3d8572-0-fragmented.mp4" framerate="0" duration="266" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/0995b314-62cc-45cd-b774-df9cbf8254fb.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/1bd0c6b5-cdce-4c59-8b66-a108db32eff5.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Superman's_Dead_Official_Canadian_Version_Official_Remastered_HD</media:title> </item> <item> <title><![CDATA[Stone_Temple_Pilots_Trippin'_On_A_Hole_In_A_Paper_Heart_Official]]></title> <link>https://peertube2.cpy.re/w/bKUZGwj56PVyveqjZdWypT</link> <guid>https://peertube2.cpy.re/w/bKUZGwj56PVyveqjZdWypT</guid> <pubDate>Wed, 13 Aug 2025 18:38:34 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="11822196" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/571d0725-ac91-4168-be07-109ff43fff39?videoFileIds=5493654"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/bKUZGwj56PVyveqjZdWypT"/> <media:player url="https://peertube2.cpy.re/w/bKUZGwj56PVyveqjZdWypT"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/7a7b900f-81a9-4925-9829-b8e506d3e91a-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/a2bd2f7b-ec3f-4db1-b891-d1f823c60adc-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/7e6c408b-3134-48ec-aec3-4e890644c247-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="11822196" url="https://www.yiny.org/static/web-videos/4c4f99a3-55fd-49ca-a80c-0afa387d9c36-240.mp4" framerate="30" duration="178" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="8462204" url="https://www.yiny.org/static/streaming-playlists/hls/571d0725-ac91-4168-be07-109ff43fff39/1238078c-fc67-4456-b08b-281100d3b6b0-240-fragmented.mp4" framerate="30" duration="178" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="2903272" url="https://www.yiny.org/static/streaming-playlists/hls/571d0725-ac91-4168-be07-109ff43fff39/0234d83b-6a1f-478b-bbe6-d0febc45ca0e-0-fragmented.mp4" framerate="0" duration="178" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/cc81d40e-3eaf-40fb-b35d-28c19f959e29.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/90ba4b9d-9623-4b3c-ab44-8e276a1b09f9.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Stone_Temple_Pilots_Trippin'_On_A_Hole_In_A_Paper_Heart_Official</media:title> </item> <item> <title><![CDATA[Stone Temple Pilots - Big Bang Baby (Official Music Video)]]></title> <link>https://peertube2.cpy.re/w/qYxSveCHdQ7ninreXf4Mxg</link> <guid>https://peertube2.cpy.re/w/qYxSveCHdQ7ninreXf4Mxg</guid> <pubDate>Wed, 13 Aug 2025 18:38:03 GMT</pubDate> <dc:creator>Gnhugo</dc:creator> <enclosure length="16678417" type="video/mp4" url="https://peertube2.cpy.re/download/videos/generate/ca409eb9-2e87-4430-a8c0-a9a7f9844be1?videoFileIds=5493650"/> <media:community> <media:statistics views="0"/> </media:community> <media:embed url="https://peertube2.cpy.re/videos/embed/qYxSveCHdQ7ninreXf4Mxg"/> <media:player url="https://peertube2.cpy.re/w/qYxSveCHdQ7ninreXf4Mxg"/> <media:group> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/7e715dd2-0251-435d-b886-501612aeb9c1-240.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/cf68f07c-9e18-4c08-b2a4-64ca6f4a3d49-240-hls.torrent" isDefault="false"/> <media:peerLink type="application/x-bittorrent" href="https://peertube2.cpy.re/lazy-static/torrents/60e3f633-f814-4be9-b9b4-f0f471df9c0a-0-hls.torrent" isDefault="false"/> <media:content type="video/mp4" medium="video" height="240" fileSize="16678417" url="https://www.yiny.org/static/web-videos/9b756f63-aefa-4622-ab3f-2b03f70006ef-240.mp4" framerate="30" duration="214" isDefault="true"/> <media:content type="video/mp4" medium="video" height="240" fileSize="12761770" url="https://www.yiny.org/static/streaming-playlists/hls/ca409eb9-2e87-4430-a8c0-a9a7f9844be1/c07e93f4-c483-4c66-9ca2-651706d916eb-240-fragmented.mp4" framerate="30" duration="214" isDefault="false"/> <media:content type="audio/mp4" medium="video" height="0" fileSize="3486715" url="https://www.yiny.org/static/streaming-playlists/hls/ca409eb9-2e87-4430-a8c0-a9a7f9844be1/df8c5385-9ece-493a-a8fd-154c9356f4d2-0-fragmented.mp4" framerate="0" duration="214" isDefault="false"/> </media:group> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/previews/47cfd887-ddaf-4f35-92b9-e684643307e7.jpg"/> <media:thumbnail url="https://peertube2.cpy.re/lazy-static/thumbnails/3fb4a5d7-8e38-43f5-8ee8-b1dbbff4ad9b.jpg"/> <media:rating>nonadult</media:rating> <media:title type="plain">Stone Temple Pilots - Big Bang Baby (Official Music Video)</media:title> </item> </channel> </rss>
Videos of subscriptions feeds
path Parameters
| format required | string Enum: "xml" "rss" "rss2" "atom" "atom1" "json" "json1" format expected (we focus on making |
query Parameters
| accountId required | string limit listing to a specific account |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| sort | string Example: sort=-createdAt Sort column |
| token required | string private token allowing access |
Responses
Response samples
- 200
Content type
No sample
As a visitor, you can use this API to open an account (if registrations are open on that PeerTube instance). As an admin, you should use the dedicated User creation API instead.
Verify a user
Following a user registration, the new user will receive an email asking to click a link containing a secret. This endpoint can also be used to verify a new email set in the user account.
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/json
| verificationString required | string <url> |
| isPendingEmail | boolean |
Responses
Request samples
- Payload
Content type
application/json
{- "verificationString": "string",
- "isPendingEmail": true
}Verify a registration email
Following a user registration request, the user will receive an email asking to click a link containing a secret.
path Parameters
| registrationId required | integer (id) >= 1 Example: 42 Registration ID |
Request Body schema: application/json
| verificationString required | string <url> |
Responses
Request samples
- Payload
Content type
application/json
{- "verificationString": "string"
}Register a user
Signup has to be enabled and signup approval is not required
Request Body schema: application/jsonrequired
| email required | string <email> email of the user, used for login or service communications |
| password required | string <password> (password) [ 6 .. 255 ] characters |
| username required | string [ 1 .. 50 ] characters /^[a-z0-9._]+$/ immutable name of the user, used to find or mention its actor |
object channel base information used to create the first channel of the user | |
| displayName | string [ 1 .. 120 ] characters editable name of the user, displayed in its representations |
Responses
Request samples
- Payload
Content type
application/json
{- "username": "chocobozzz",
- "password": "pa$$word",
- "email": "user@example.com",
- "displayName": "string",
- "channel": {
- "name": "framasoft_videos",
- "displayName": "string"
}
}Request registration
Signup has to be enabled and require approval on the instance
Request Body schema: application/json
| email required | string <email> email of the user, used for login or service communications |
| password required | string <password> (password) [ 6 .. 255 ] characters |
| registrationReason required | string reason for the user to register on the instance |
| username required | string [ 1 .. 50 ] characters /^[a-z0-9._]+$/ immutable name of the user, used to find or mention its actor |
object channel base information used to create the first channel of the user | |
| displayName | string [ 1 .. 120 ] characters editable name of the user, displayed in its representations |
Responses
Request samples
- Payload
Content type
application/json
{- "username": "chocobozzz",
- "password": "pa$$word",
- "email": "user@example.com",
- "displayName": "string",
- "channel": {
- "name": "framasoft_videos",
- "displayName": "string"
}, - "registrationReason": "string"
}Response samples
- 200
Content type
application/json
{- "id": 42,
- "state": {
- "id": 1,
- "label": "string"
}, - "registrationReason": "string",
- "moderationResponse": "string",
- "username": "string",
- "email": "user@example.com",
- "emailVerified": true,
- "accountDisplayName": "string",
- "channelHandle": "string",
- "channelDisplayName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "user": {
- "id": 42
}
}Accept registration
Authorizations:
OAuth2
path Parameters
| registrationId required | integer (id) >= 1 Example: 42 Registration ID |
Request Body schema: application/json
| moderationResponse required | string Moderation response to send to the user |
| preventEmailDelivery | boolean Set it to true if you don't want PeerTube to send an email to the user |
Responses
Request samples
- Payload
Content type
application/json
{- "moderationResponse": "string",
- "preventEmailDelivery": true
}Reject registration
Authorizations:
OAuth2
path Parameters
| registrationId required | integer (id) >= 1 Example: 42 Registration ID |
Request Body schema: application/json
| moderationResponse required | string Moderation response to send to the user |
| preventEmailDelivery | boolean Set it to true if you don't want PeerTube to send an email to the user |
Responses
Request samples
- Payload
Content type
application/json
{- "moderationResponse": "string",
- "preventEmailDelivery": true
}List registrations
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string |
| sort | string Enum: "-createdAt" "createdAt" "state" "-state" |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "state": {
- "id": 1,
- "label": "string"
}, - "registrationReason": "string",
- "moderationResponse": "string",
- "username": "string",
- "email": "user@example.com",
- "emailVerified": true,
- "accountDisplayName": "string",
- "channelHandle": "string",
- "channelDisplayName": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "user": {
- "id": 42
}
}
]
}Sessions deal with access tokens over time. Only one session token can currently be used at a time.
Request samples
- Shell
API="https://peertube2.cpy.re/api/v1" ## AUTH curl -s "$API/oauth-clients/local"
Response samples
- 200
Content type
application/json
{- "client_id": "v1ikx5hnfop4mdpnci8nsqh93c45rldf",
- "client_secret": "AjWiOapPltI6EnsWQwlFarRtLh4u8tDt"
}Login
With your client id and secret, you can retrieve an access and refresh tokens.
header Parameters
| x-peertube-otp | string If the user enabled two factor authentication, you need to provide the OTP code in this header |
Request Body schema: application/x-www-form-urlencoded
| client_id required | string = 32 characters /^[a-z0-9]$/ |
| client_secret required | string = 32 characters /^[a-zA-Z0-9]$/ |
| grant_type required | string Default: "password" |
| password required | string <password> (password) [ 6 .. 255 ] characters |
| username required | string [ 1 .. 50 ] characters /^[a-z0-9._]+$/ immutable name of the user, used to find or mention its actor |
Responses
Request samples
- Shell
## 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-urlencode password="$PASSWORD" \ | jq -r ".access_token"
Response samples
- 200
Content type
application/json
{- "token_type": "Bearer",
- "access_token": "90286a0bdf0f7315d9d3fe8dabf9e1d2be9c97d0",
- "refresh_token": "2e0d675df9fc96d2e4ec8a3ebbbf45eca9137bb7",
- "expires_in": 14399,
- "refresh_token_expires_in": 1209600
}List token sessions
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 0,
- "currentSession": true,
- "loginDevice": "string",
- "loginIP": "192.168.0.1",
- "loginDate": "2019-08-24T14:15:22Z",
- "lastActivityDevice": "string",
- "lastActivityIP": "192.168.0.1",
- "lastActivityDate": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z"
}
]
}Accounts encompass remote accounts discovered across the federation, 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.
Get an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
Responses
Response samples
- 200
Content type
application/json
{- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}List videos of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Request samples
- JavaScript
- Shell
- Ruby
- Python
fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos') .then(function(response) { return response.json() }).then(function(data) { console.log(data) })
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}List followers of an account
Authorizations:
OAuth2
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| sort | string Value: "createdAt" Sort followers by criteria |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "follower": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "following": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "score": 0,
- "state": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}List accounts
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
]
}List playlists of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| playlistType | integer (VideoPlaylistTypeSet) Enum: 1 2 The video playlist type (Regular = |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}List video channels of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| withStats | boolean include daily view statistics for the last 30 days and total views (only if authentified as the account user) |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}List the synchronizations of video channels of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "state": {
- "id": 2,
- "label": "PROCESSING"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "lastSyncAt": "2019-08-24T14:15:22Z",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}
]
}List ratings of an account
Authorizations:
OAuth2
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| rating | string Enum: "like" "dislike" Optionally filter which ratings to retrieve |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
[- {
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}, - "rating": "like"
}
]Using some features of PeerTube require authentication, for which User provide different levels of permission as well as associated user information. Each user has a corresponding local Account for federation.
Create a user
Authorizations:
OAuth2
Request Body schema: application/jsonrequired
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.
| email required | string <email> The user email |
| password required | string <password> (password) [ 6 .. 255 ] characters |
| role required | integer (UserRole) Enum: 0 1 2 The user role (Admin = |
| username required | string (username) [ 1 .. 50 ] characters /^[a-z0-9._]+$/ immutable name of the user, used to find or mention its actor |
| adminFlags | integer (UserAdminFlags) Enum: 0 1 Admin flags for the user (None = |
| channelName | string (usernameChannel) [ 1 .. 50 ] characters /^[a-zA-Z0-9\\-_.:]+$/ immutable name of the channel, used to interact with its actor |
| videoQuota | integer The user video quota in bytes |
| videoQuotaDaily | integer The user daily video quota in bytes |
Responses
Request samples
- Payload
Content type
application/json
{- "username": "chocobozzz",
- "password": "pa$$word",
- "email": "user@example.com",
- "videoQuota": -1,
- "videoQuotaDaily": -1,
- "channelName": "framasoft_videos",
- "role": 2,
- "adminFlags": 1
}Response samples
- 200
Content type
application/json
{- "user": {
- "id": 42,
- "account": {
- "id": 42
}
}
}List users
Authorizations:
OAuth2
query Parameters
| blocked | boolean Filter results down to (un)banned users |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Plain text search that will match with user usernames or emails |
| sort | string Enum: "-id" "-username" "-createdAt" Sort users by criteria |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
[- {
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "autoPlayNextVideo": true,
- "autoPlayNextVideoPlaylist": true,
- "autoPlayVideo": true,
- "blocked": true,
- "blockedReason": "string",
- "createdAt": "string",
- "email": "user@example.com",
- "emailVerified": true,
- "id": 42,
- "pluginAuth": "string",
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "noInstanceConfigWarningModal": true,
- "noAccountSetupWarningModal": true,
- "noWelcomeModal": true,
- "nsfwPolicy": "display",
- "nsfwFlagsDisplayed": 0,
- "nsfwFlagsHidden": 0,
- "nsfwFlagsWarned": 0,
- "nsfwFlagsBlurred": 0,
- "role": {
- "id": 2,
- "label": "User"
}, - "theme": "string",
- "username": "chocobozzz",
- "videoChannels": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
], - "videoQuota": -1,
- "videoQuotaDaily": -1,
- "p2pEnabled": true
}
]Get a user
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
query Parameters
| withStats | boolean include statistics about the user (only available as a moderator/admin) |
Responses
Response samples
- 200
Content type
application/json
Example
{- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "autoPlayNextVideo": true,
- "autoPlayNextVideoPlaylist": true,
- "autoPlayVideo": true,
- "blocked": true,
- "blockedReason": "string",
- "createdAt": "string",
- "email": "user@example.com",
- "emailVerified": true,
- "id": 42,
- "pluginAuth": "string",
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "noInstanceConfigWarningModal": true,
- "noAccountSetupWarningModal": true,
- "noWelcomeModal": true,
- "nsfwPolicy": "display",
- "nsfwFlagsDisplayed": 0,
- "nsfwFlagsHidden": 0,
- "nsfwFlagsWarned": 0,
- "nsfwFlagsBlurred": 0,
- "role": {
- "id": 2,
- "label": "User"
}, - "theme": "string",
- "username": "chocobozzz",
- "videoChannels": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
], - "videoQuota": -1,
- "videoQuotaDaily": -1,
- "p2pEnabled": true
}Update a user
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/jsonrequired
| adminFlags | integer (UserAdminFlags) Enum: 0 1 Admin flags for the user (None = |
string <email> The updated email of the user | |
| emailVerified | boolean Set the email as verified |
| password | string <password> (password) [ 6 .. 255 ] characters |
| pluginAuth | string or null The auth plugin to use to authenticate the user |
| role | integer (UserRole) Enum: 0 1 2 The user role (Admin = |
| videoQuota | integer The updated video quota of the user in bytes |
| videoQuotaDaily | integer The updated daily video quota of the user in bytes |
Responses
Request samples
- Payload
Content type
application/json
{- "email": "user@example.com",
- "emailVerified": true,
- "videoQuota": 0,
- "videoQuotaDaily": 0,
- "pluginAuth": "peertube-plugin-auth-saml2",
- "role": 2,
- "adminFlags": 1,
- "password": "pa$$word"
}Verify a user
Following a user registration, the new user will receive an email asking to click a link containing a secret. This endpoint can also be used to verify a new email set in the user account.
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/json
| verificationString required | string <url> |
| isPendingEmail | boolean |
Responses
Request samples
- Payload
Content type
application/json
{- "verificationString": "string",
- "isPendingEmail": true
}Request two factor auth
Request two factor authentication for a user
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/json
| currentPassword | string Password of the currently authenticated user |
Responses
Request samples
- Payload
Content type
application/json
{- "currentPassword": "string"
}Response samples
- 200
Content type
application/json
[- {
- "otpRequest": {
- "requestToken": "string",
- "secret": "string",
- "uri": "string"
}
}
]Confirm two factor auth
Confirm a two factor authentication request
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/json
| otpToken required | string OTP token generated by the app |
| requestToken required | string Token to identify the two factor request |
Responses
Request samples
- Payload
Content type
application/json
{- "requestToken": "string",
- "otpToken": "string"
}Disable two factor auth
Disable two factor authentication of a user
Authorizations:
OAuth2
path Parameters
| id required | integer (id) >= 1 Example: 42 Entity id |
Request Body schema: application/json
| currentPassword | string Password of the currently authenticated user |
Responses
Request samples
- Payload
Content type
application/json
{- "currentPassword": "string"
}Request user export
Request an archive of user data. An email is sent when the archive is ready.
Authorizations:
OAuth2
path Parameters
| userId required | integer (id) >= 1 Example: 42 User id |
Request Body schema: application/json
| withVideoFiles | boolean Whether to include video files in the archive |
Responses
Request samples
- Payload
Content type
application/json
{- "withVideoFiles": true
}Response samples
- 200
Content type
application/json
{- "export": {
- "id": 0
}
}List user exports
PeerTube >= 6.1
Authorizations:
OAuth2
path Parameters
| userId required | integer (id) >= 1 Example: 42 User id |
Responses
Response samples
- 200
Content type
application/json
{- "id": 0,
- "state": {
- "id": 1,
- "label": "string"
}, - "size": 0,
- "privateDownloadUrl": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "expiresOn": "2019-08-24T14:15:22Z"
}Initialize the resumable user import
PeerTube >= 6.1 Uses a resumable protocol to initialize the import of the archive
Authorizations:
OAuth2
path Parameters
| userId required | integer (id) >= 1 Example: 42 User id |
header Parameters
| X-Upload-Content-Length required | number Example: 2469036 Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading. |
| X-Upload-Content-Type required | string <mimetype> Example: video/mp4 MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary. |
Request Body schema: application/json
| filename | string <filename> Archive filename including extension |
Responses
Request samples
- Payload
Content type
application/json
{- "filename": "user-export-6-2024-02-09T10_12_11.682Z"
}Send chunk for the resumable user import
PeerTube >= 6.1 Uses a resumable protocol to continue, pause or resume the import of the archive
Authorizations:
OAuth2
path Parameters
| userId required | integer (id) >= 1 Example: 42 User id |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 262144 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. |
| Content-Range required | string Example: bytes 0-262143/2469036 Specifies the bytes in the file that the request is uploading. For example, a value of |
Request Body schema: application/octet-stream
string <binary>
Responses
Cancel the resumable user import
PeerTube >= 6.1 Uses a resumable protocol to cancel the resumable user import
Authorizations:
OAuth2
path Parameters
| userId required | integer (id) >= 1 Example: 42 User id |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 0 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "autoPlayNextVideo": true,
- "autoPlayNextVideoPlaylist": true,
- "autoPlayVideo": true,
- "blocked": true,
- "blockedReason": "string",
- "createdAt": "string",
- "email": "user@example.com",
- "emailVerified": true,
- "id": 42,
- "pluginAuth": "string",
- "lastLoginDate": "2019-08-24T14:15:22Z",
- "noInstanceConfigWarningModal": true,
- "noAccountSetupWarningModal": true,
- "noWelcomeModal": true,
- "nsfwPolicy": "display",
- "nsfwFlagsDisplayed": 0,
- "nsfwFlagsHidden": 0,
- "nsfwFlagsWarned": 0,
- "nsfwFlagsBlurred": 0,
- "role": {
- "id": 2,
- "label": "User"
}, - "theme": "string",
- "username": "chocobozzz",
- "videoChannels": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
], - "videoQuota": -1,
- "videoQuotaDaily": -1,
- "p2pEnabled": true
}
]Update my user information
Authorizations:
OAuth2
Request Body schema: application/jsonrequired
| autoPlayNextVideo | boolean new preference regarding playing following videos automatically |
| autoPlayNextVideoPlaylist | boolean new preference regarding playing following playlist videos automatically |
| autoPlayVideo | boolean new preference regarding playing videos automatically |
| currentPassword | string <password> (password) [ 6 .. 255 ] characters |
| displayName | string [ 3 .. 120 ] characters new name of the user in its representations |
string <email> new email used for login and service communications | |
| language | string default language for this user |
| noAccountSetupWarningModal | boolean |
| noInstanceConfigWarningModal | boolean |
| noWelcomeModal | boolean |
| nsfwFlagsBlurred | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsDisplayed | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsHidden | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsWarned | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwPolicy | string Enum: "true" "false" "both" new NSFW display policy |
| p2pEnabled | boolean whether to enable P2P in the player or not |
| password | string <password> (password) [ 6 .. 255 ] characters |
| theme | string |
| videoLanguages | Array of strings list of languages to filter videos down to |
| videosHistoryEnabled | boolean whether to keep track of watched history or not |
Responses
Request samples
- Payload
Content type
application/json
{- "password": "pa$$word",
- "currentPassword": "pa$$word",
- "email": "user@example.com",
- "displayName": "string",
- "nsfwPolicy": "true",
- "nsfwFlagsDisplayed": 0,
- "nsfwFlagsHidden": 0,
- "nsfwFlagsWarned": 0,
- "nsfwFlagsBlurred": 0,
- "p2pEnabled": true,
- "autoPlayVideo": true,
- "autoPlayNextVideo": true,
- "autoPlayNextVideoPlaylist": true,
- "videosHistoryEnabled": true,
- "videoLanguages": [
- "string"
], - "language": "string",
- "theme": "string",
- "noInstanceConfigWarningModal": true,
- "noAccountSetupWarningModal": true,
- "noWelcomeModal": true
}Get video imports of my user
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Search in video names |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| targetUrl | string Filter on import target URL |
| videoChannelSyncId | number Filter on imports created by a specific channel synchronization |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "torrentName": "string",
- "state": {
- "id": 1,
- "label": "Pending"
}, - "error": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
}
]
}List videos of my user
Authorizations:
OAuth2
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
string or Array of strings PeerTube >= 7.2 Filter on videos that are published by a channel with one of these names | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Update my user avatar
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| avatarfile | string <binary> The file to upload |
Responses
Response samples
- 200
Content type
application/json
{- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}List my abuses
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| id | integer only list the report with this id |
| sort | string Enum: "-id" "-createdAt" "-state" Sort abuses by criteria |
| start | integer >= 0 Offset used to paginate results |
| state | integer (AbuseStateSet) Enum: 1 2 3 The abuse state (Pending = |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "reason": "The video is a spam",
- "predefinedReasons": [
- "spamOrMisleading"
], - "reporterAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "state": {
- "id": 1,
- "label": "string"
}, - "moderationComment": "Decided to ban the server since it spams us regularly",
- "video": {
- "id": 0,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "name": "string",
- "nsfw": true,
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "deleted": true,
- "blacklisted": true,
- "thumbnailPath": "string",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}, - "createdAt": "2019-08-24T14:15:22Z"
}
]
}Operations related to your subscriptions to video channels, their new videos, and how to keep up to date with their latest publications!
List my user subscriptions
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Enum: "-id" "-createdAt" "-channelUpdatedAt" |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}List videos of subscriptions of my user
Authorizations:
OAuth2
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Get subscription of my user
Authorizations:
OAuth2
path Parameters
| subscriptionHandle required | string Example: my_username | my_username@example.com The subscription handle |
Responses
Response samples
- 200
Content type
application/json
{- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}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.
List my notifications
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| typeOneOf | Array of integers (NotificationType) Items Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 only list notifications of these types |
| unread | boolean only list unread notifications |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "type": 1,
- "read": true,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}, - "videoImport": {
- "id": 42,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}, - "torrentName": "string",
}, - "comment": {
- "id": 42,
- "threadId": 0,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}, - "account": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "heldForReview": true
}, - "videoAbuse": {
- "id": 42,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}
}, - "videoBlacklist": {
- "id": 42,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}
}, - "account": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "actorFollow": {
- "id": 42,
- "follower": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "state": "pending",
- "following": {
- "type": "account",
- "name": "string",
- "displayName": "string",
- "host": "example.com"
}
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Update my notification settings
Authorizations:
OAuth2
Request Body schema: application/json
| abuseAsModerator | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| abuseNewMessage | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| abuseStateChange | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| autoInstanceFollowing | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| blacklistOnMyVideo | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| commentMention | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| myVideoImportFinished | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| myVideoPublished | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| myVideoStudioEditionFinished | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| myVideoTranscriptionGenerated | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newCommentOnMyVideo | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newFollow | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newInstanceFollower | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newPeerTubeVersion | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newPluginVersion | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newUserRegistration | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| newVideoFromSubscription | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
| videoAutoBlacklistAsModerator | integer (NotificationSettingValue) Notification type. One of the following values, or a sum of multiple values:
|
Responses
Request samples
- Payload
Content type
application/json
{- "abuseAsModerator": 0,
- "videoAutoBlacklistAsModerator": 0,
- "newUserRegistration": 0,
- "newVideoFromSubscription": 0,
- "blacklistOnMyVideo": 0,
- "myVideoPublished": 0,
- "myVideoImportFinished": 0,
- "commentMention": 0,
- "newCommentOnMyVideo": 0,
- "newFollow": 0,
- "newInstanceFollower": 0,
- "autoInstanceFollowing": 0,
- "abuseStateChange": 0,
- "abuseNewMessage": 0,
- "newPeerTubeVersion": 0,
- "newPluginVersion": 0,
- "myVideoStudioEditionFinished": 0,
- "myVideoTranscriptionGenerated": 0
}List watched videos history
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}List videos of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Request samples
- JavaScript
- Shell
- Ruby
- Python
fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos') .then(function(response) { return response.json() }).then(function(data) { console.log(data) })
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Request video token
Request special tokens that expire quickly to use them in some context (like accessing private static files)
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "files": {
- "token": "string",
- "expires": "2019-08-24T14:15:22Z"
}
}Create a studio task
Create a task to edit a video (cut, add intro/outro etc)
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: multipart/form-datarequired
Array
Any of
| name | string Value: "cut" |
object |
Responses
List videos
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Response samples
- 200
Content type
application/json
{- "1": "Music",
- "2": "Films",
- "3": "Vehicles",
- "4": "Art",
- "5": "Sports",
- "6": "Travels",
- "7": "Gaming",
- "8": "People",
- "9": "Comedy",
- "10": "Entertainment",
- "11": "News & Politics",
- "12": "How To",
- "13": "Education",
- "14": "Activism",
- "15": "Science & Technology",
- "16": "Animals",
- "17": "Kids",
- "18": "Food"
}Response samples
- 200
Content type
application/json
{- "1": "Attribution",
- "2": "Attribution - Share Alike",
- "3": "Attribution - No Derivatives",
- "4": "Attribution - Non Commercial",
- "5": "Attribution - Non Commercial - Share Alike",
- "6": "Attribution - Non Commercial - No Derivatives",
- "7": "Public Domain Dedication"
}Response samples
- 200
Content type
application/json
{- "aa": "Afar",
- "ab": "Abkhazian",
- "af": "Afrikaans",
- "ak": "Akan",
- "am": "Amharic",
- "ar": "Arabic",
- "an": "Aragonese",
- "ase": "American Sign Language",
- "as": "Assamese",
- "asq": "Austrian Sign Language",
- "av": "Avaric",
- "avk": "Kotava",
- "ay": "Aymara",
- "az": "Azerbaijani",
- "ba": "Bashkir",
- "bm": "Bambara",
- "be": "Belarusian",
- "bn": "Bengali",
- "bfi": "British Sign Language",
- "bi": "Bislama",
- "bo": "Tibetan",
- "bs": "Bosnian",
- "br": "Breton",
- "bg": "Bulgarian",
- "bzs": "Brazilian Sign Language",
- "ca": "Catalan",
- "cs": "Czech",
- "ch": "Chamorro",
- "ce": "Chechen",
- "cv": "Chuvash",
- "kw": "Cornish",
- "co": "Corsican",
- "cr": "Cree",
- "cse": "Czech Sign Language",
- "csl": "Chinese Sign Language",
- "cy": "Welsh",
- "da": "Danish",
- "de": "German",
- "dv": "Dhivehi",
- "dsl": "Danish Sign Language",
- "dz": "Dzongkha",
- "el": "Greek",
- "en": "English",
- "eo": "Esperanto",
- "et": "Estonian",
- "eu": "Basque",
- "ee": "Ewe",
- "fo": "Faroese",
- "fa": "Persian",
- "fj": "Fijian",
- "fi": "Finnish",
- "fr": "French",
- "fy": "Western Frisian",
- "fse": "Finnish Sign Language",
- "fsl": "French Sign Language",
- "ff": "Fulah",
- "gcf": "Guadeloupean Creole French",
- "gd": "Scottish Gaelic",
- "ga": "Irish",
- "gl": "Galician",
- "gv": "Manx",
- "gn": "Guarani",
- "gsg": "German Sign Language",
- "gu": "Gujarati",
- "ht": "Haitian",
- "ha": "Hausa",
- "sh": "Serbo-Croatian",
- "he": "Hebrew",
- "hz": "Herero",
- "hi": "Hindi",
- "ho": "Hiri Motu",
- "hr": "Croatian",
- "hu": "Hungarian",
- "hy": "Armenian",
- "ig": "Igbo",
- "ii": "Sichuan Yi",
- "iu": "Inuktitut",
- "id": "Indonesian",
- "ik": "Inupiaq",
- "is": "Icelandic",
- "it": "Italian",
- "jv": "Javanese",
- "jbo": "Lojban",
- "ja": "Japanese",
- "jsl": "Japanese Sign Language",
- "kab": "Kabyle",
- "kl": "Kalaallisut",
- "kn": "Kannada",
- "ks": "Kashmiri",
- "ka": "Georgian",
- "kr": "Kanuri",
- "kk": "Kazakh",
- "km": "Khmer",
- "ki": "Kikuyu",
- "rw": "Kinyarwanda",
- "ky": "Kirghiz",
- "kv": "Komi",
- "kg": "Kongo",
- "ko": "Korean",
- "kj": "Kuanyama",
- "ku": "Kurdish",
- "lo": "Lao",
- "la": "Latin",
- "lv": "Latvian",
- "li": "Limburgan",
- "ln": "Lingala",
- "lt": "Lithuanian",
- "lb": "Luxembourgish",
- "lu": "Luba-Katanga",
- "lg": "Ganda",
- "mh": "Marshallese",
- "ml": "Malayalam",
- "mr": "Marathi",
- "mk": "Macedonian",
- "mg": "Malagasy",
- "mt": "Maltese",
- "mn": "Mongolian",
- "mi": "Maori",
- "ms": "Malay (macrolanguage)",
- "my": "Burmese",
- "na": "Nauru",
- "nv": "Navajo",
- "nr": "South Ndebele",
- "nd": "North Ndebele",
- "ng": "Ndonga",
- "ne": "Nepali (macrolanguage)",
- "nl": "Dutch",
- "nn": "Norwegian Nynorsk",
- "nb": "Norwegian Bokmål",
- "no": "Norwegian",
- "ny": "Nyanja",
- "oc": "Occitan",
- "oj": "Ojibwa",
- "or": "Oriya (macrolanguage)",
- "om": "Oromo",
- "os": "Ossetian",
- "pa": "Panjabi",
- "pks": "Pakistan Sign Language",
- "pl": "Polish",
- "pt": "Portuguese (Brazilian)",
- "ps": "Pushto",
- "qu": "Quechua",
- "rm": "Romansh",
- "ro": "Romanian",
- "rsl": "Russian Sign Language",
- "rn": "Rundi",
- "ru": "Russian",
- "sg": "Sango",
- "sdl": "Saudi Arabian Sign Language",
- "sfs": "South African Sign Language",
- "si": "Sinhala",
- "sk": "Slovak",
- "sl": "Slovenian",
- "se": "Northern Sami",
- "sm": "Samoan",
- "sn": "Shona",
- "sd": "Sindhi",
- "so": "Somali",
- "st": "Southern Sotho",
- "es": "Spanish (Spain)",
- "sq": "Albanian",
- "sc": "Sardinian",
- "sr": "Serbian",
- "ss": "Swati",
- "su": "Sundanese",
- "sw": "Swahili (macrolanguage)",
- "sv": "Swedish",
- "swl": "Swedish Sign Language",
- "ty": "Tahitian",
- "ta": "Tamil",
- "tt": "Tatar",
- "te": "Telugu",
- "tg": "Tajik",
- "tl": "Tagalog",
- "th": "Thai",
- "ti": "Tigrinya",
- "tlh": "Klingon",
- "to": "Tonga (Tonga Islands)",
- "tn": "Tswana",
- "ts": "Tsonga",
- "tk": "Turkmen",
- "tr": "Turkish",
- "tw": "Twi",
- "ug": "Uighur",
- "uk": "Ukrainian",
- "ur": "Urdu",
- "uz": "Uzbek",
- "ve": "Venda",
- "vi": "Vietnamese",
- "wa": "Walloon",
- "wo": "Wolof",
- "xh": "Xhosa",
- "yi": "Yiddish",
- "yo": "Yoruba",
- "za": "Zhuang",
- "zh": "Chinese",
- "zu": "Zulu",
- "zxx": "No linguistic content",
- "tok": "Toki Pona",
- "pt-PT": "Portuguese (Portugal)",
- "es-419": "Spanish (Latin America)",
- "zh-Hans": "Simplified Chinese",
- "zh-Hant": "Traditional Chinese",
- "ca-valencia": "Valencian",
- "rcf": "Réunion Creole French",
- "gcr": "Guianese Creole French"
}Update a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: multipart/form-data
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| channelId | integer New channel of the video. The channel must be owned by the same account as the previous one. Use the "change ownership" endpoints to give a video to a channel owned by another account on the local PeerTube instance. |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| name | string [ 3 .. 120 ] characters Video name |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string or null <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | string Whether or not we wait transcoding before publish the video |
Responses
Get a video
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 42,
- "name": "chocobozzz",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "description": "string"
}, - "channel": {
- "id": 42,
- "name": "chocobozzz",
- "displayName": "Videos of Framasoft",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}, - "userHistory": {
- "currentTime": 0
}, - "viewers": 0,
- "description": "\"**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network,\nbased on free/libre software!*\\r\\n\\r\\n**Animation Produced by:** [LILA](https://libreart.info) - [ZeMarmot Team](https://film.zemarmot.net)\\r\\n\n*Directed by* Aryeom\\r\\n*Assistant* Jehan\\r\\n**Licence**: [CC-By-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)\\r\\n\\r\\n\n**Sponsored by** [Framasoft](https://framasoft.org)\\r\\n\\r\\n**Music**: [Red Step Forward](http://play.dogmazic.net/song.php?song_id=52491) - CC-By Ken Bushima\\r\\n\\r\\n\n**Movie Clip**: [Caminades 3: Llamigos](http://www.caminandes.com/) CC-By Blender Institute\\r\\n\\r\\n**Video sources**: https://gitlab.gnome.org/Jehan/what-is-peertube/\"\n",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "tags": [
- "flowers",
- "gardening"
], - "commentsEnabled": true,
- "commentsPolicy": {
- "id": 1,
- "label": "string"
}, - "downloadEnabled": true,
- "inputFileUpdatedAt": "2019-08-24T14:15:22Z",
- "trackerUrls": [
- "wss://peertube2.cpy.re/tracker/socket"
], - "files": [
- {
- "id": 42,
- "resolution": {
- "id": 240,
- "label": "240p"
}, - "size": 0,
- "torrentUrl": "string",
- "torrentDownloadUrl": "string",
- "fileUrl": "string",
- "playlistUrl": "string",
- "fileDownloadUrl": "string",
- "fps": 0,
- "width": 0,
- "height": 0,
- "metadataUrl": "string",
- "hasAudio": true,
- "hasVideo": true,
- "storage": 0
}
], - "streamingPlaylists": [
- {
- "id": 42,
- "type": 1,
- "playlistUrl": "string",
- "segmentsSha256Url": "string",
- "files": [
- {
- "id": 42,
- "resolution": {
- "id": 240,
- "label": "240p"
}, - "size": 0,
- "torrentUrl": "string",
- "torrentDownloadUrl": "string",
- "fileUrl": "string",
- "playlistUrl": "string",
- "fileDownloadUrl": "string",
- "fps": 0,
- "width": 0,
- "height": 0,
- "metadataUrl": "string",
- "hasAudio": true,
- "hasVideo": true,
- "storage": 0
}
], - "redundancies": [
- {
- "baseUrl": "string"
}
]
}
]
}Get complete video description
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
"**[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)**\n"Notify user is watching a video
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.
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/jsonrequired
| currentTime required | integer <seconds> timestamp within the video, in seconds |
| client | string Client software used to watch the video. For example "Firefox", "PeerTube Approval Android", etc. |
| device | any (VideoStatsUserAgentDevice) Enum: "console" "embedded" "mobile" "smarttv" "tablet" "wearable" "xr" "desktop" |
| operatingSystem | string Operating system used to watch the video. For example "Windows", "Ubuntu", etc. |
| sessionId | string Optional param to represent the current viewer session. Used by the backend to properly count one view per session per video. PeerTube admin can configure the server to not trust this |
| viewEvent | string Value: "seek" Event since last viewing call:
|
Responses
Request samples
- Payload
Content type
application/json
{- "currentTime": 5,
- "viewEvent": "seek",
- "sessionId": "string",
- "client": "string",
- "device": "console",
- "operatingSystem": "string"
}Set watching progress of a video Deprecated
This endpoint has been deprecated. Use /videos/{id}/views instead
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/jsonrequired
| currentTime required | integer <seconds> timestamp within the video, in seconds |
| client | string Client software used to watch the video. For example "Firefox", "PeerTube Approval Android", etc. |
| device | any (VideoStatsUserAgentDevice) Enum: "console" "embedded" "mobile" "smarttv" "tablet" "wearable" "xr" "desktop" |
| operatingSystem | string Operating system used to watch the video. For example "Windows", "Ubuntu", etc. |
| sessionId | string Optional param to represent the current viewer session. Used by the backend to properly count one view per session per video. PeerTube admin can configure the server to not trust this |
| viewEvent | string Value: "seek" Event since last viewing call:
|
Responses
Request samples
- Payload
Content type
application/json
{- "currentTime": 5,
- "viewEvent": "seek",
- "sessionId": "string",
- "client": "string",
- "device": "console",
- "operatingSystem": "string"
}Upload a video
Uses a single request to upload a video.
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| channelId required | integer >= 1 Channel id that will contain this video |
| name required | string [ 3 .. 120 ] characters Video name |
| videofile required | string <binary> Video file |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Request samples
- Shell
## DEPENDENCIES: jq USERNAME="<your_username>" PASSWORD="<your_password>" FILE_PATH="<your_file_path>" CHANNEL_ID="<your_channel_id>" NAME="<video_name>" API="https://peertube2.cpy.re/api/v1" ## 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") token=$(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") ## VIDEO UPLOAD curl -s "$API/videos/upload" \ -H "Authorization: Bearer $token" \ --max-time 600 \ --form videofile=@"$FILE_PATH" \ --form channelId=$CHANNEL_ID \ --form name="$NAME"
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Initialize the resumable upload of a video
Uses a resumable protocol to initialize the upload of a video
Authorizations:
OAuth2
header Parameters
| X-Upload-Content-Length required | number Example: 2469036 Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading. |
| X-Upload-Content-Type required | string <mimetype> Example: video/mp4 MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary. |
Request Body schema: application/json
| channelId required | integer >= 1 Channel id that will contain this video |
| filename required | string <filename> Video filename including extension |
| name required | string [ 3 .. 120 ] characters Video name |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "What is PeerTube?",
- "channelId": 3,
- "privacy": 1,
- "category": 15,
- "licence": 2,
- "language": "en",
- "description": "**[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)**\n",
- "waitTranscoding": true,
- "generateTranscription": true,
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "nsfw": true,
- "nsfwSummary": null,
- "nsfwFlags": 0,
- "tags": [
- "framasoft",
- "peertube"
], - "commentsEnabled": true,
- "commentsPolicy": 1,
- "downloadEnabled": true,
- "originallyPublishedAt": "2019-08-24T14:15:22Z",
- "scheduleUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "thumbnailfile": "string",
- "previewfile": "string",
- "videoPasswords": [
- "string"
], - "filename": "what_is_peertube.mp4"
}Send chunk for the resumable upload of a video
Uses a resumable protocol to continue, pause or resume the upload of a video
Authorizations:
OAuth2
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 262144 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. |
| Content-Range required | string Example: bytes 0-262143/2469036 Specifies the bytes in the file that the request is uploading. For example, a value of |
Request Body schema: application/octet-stream
string <binary>
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Cancel the resumable upload of a video, deleting any data uploaded so far
Uses a resumable protocol to cancel the upload of a video
Authorizations:
OAuth2
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 0 |
Responses
Create a live
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| channelId required | integer Channel id that will contain this live video |
| name required | string [ 3 .. 120 ] characters Live video/replay name |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Live video/replay description |
| downloadEnabled | boolean Enable or disable downloading for the replay of this live video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| latencyMode | integer (LiveVideoLatencyMode) Enum: 1 2 3 The live latency mode (Default = |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this live video/replay contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| permanentLive | boolean User can stream multiple times in a permanent live |
| previewfile | string <binary> Live video/replay preview file |
| privacy | |
object (LiveVideoReplaySettings) | |
| saveReplay | boolean |
Array of objects (LiveSchedule) | |
| support | string A text tell the audience how to support the creator |
| tags | Array of strings [ 1 .. 5 ] items [ items [ 2 .. 30 ] characters ] Live video/replay tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Live video/replay thumbnail file |
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Get information about a live
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Responses
Response samples
- 200
Content type
application/json
{- "rtmpUrl": "string",
- "rtmpsUrl": "string",
- "streamKey": "string",
- "saveReplay": true,
- "replaySettings": {
- "privacy": 1
}, - "permanentLive": true,
- "latencyMode": 1,
- "schedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
]
}Update information about a live
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| latencyMode | integer (LiveVideoLatencyMode) Enum: 1 2 3 The live latency mode (Default = |
| permanentLive | boolean User can stream multiple times in a permanent live |
object (LiveVideoReplaySettings) | |
| saveReplay | boolean |
Array of objects (LiveSchedule) |
Responses
Request samples
- Payload
Content type
application/json
{- "saveReplay": true,
- "replaySettings": {
- "privacy": 1
}, - "permanentLive": true,
- "latencyMode": 1,
- "schedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
]
}Get video source file metadata
Get metadata and download link of original video file
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Responses
Response samples
- 200
Content type
application/json
{- "filename": "string",
- "inputFilename": "string",
- "fileDownloadUrl": "string",
- "resolution": {
- "id": 240,
- "label": "240p"
}, - "size": 0,
- "fps": 0,
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z"
}Initialize the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to initialize the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| X-Upload-Content-Length required | number Example: 2469036 Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading. |
| X-Upload-Content-Type required | string <mimetype> Example: video/mp4 MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary. |
Request Body schema: application/json
| filename | string <filename> Video filename including extension |
Responses
Request samples
- Payload
Content type
application/json
{- "filename": "what_is_peertube.mp4"
}Send chunk for the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to continue, pause or resume the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 262144 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. |
| Content-Range required | string Example: bytes 0-262143/2469036 Specifies the bytes in the file that the request is uploading. For example, a value of |
Request Body schema: application/octet-stream
string <binary>
Responses
Cancel the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to cancel the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 0 |
Responses
List storyboards of a video
PeerTube >= 6.0
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Responses
Response samples
- 200
Content type
application/json
{- "storyboards": [
- {
- "storyboardPath": "string",
- "totalHeight": 0,
- "totalWidth": 0,
- "spriteHeight": 0,
- "spriteWidth": 0,
- "spriteDuration": 0
}
]
}List videos of a video channel
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Search videos
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| durationMax | integer Get videos that have this maximum duration |
| durationMin | integer Get videos that have this minimum duration |
| endDate | string <date-time> Get videos that are published before this date |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| originallyPublishedEndDate | string <date-time> Get videos that are originally published before this date |
| originallyPublishedStartDate | string <date-time> Get videos that are originally published after this date |
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
| startDate | string <date-time> Get videos that are published after this date |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video | |
| uuids | Array of strings Find elements with specific UUIDs |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes.
Upload
- legacy, where the video file is sent in a single request
- resumable, where the video file is sent in chunks
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
- 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
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.
Upload a video
Uses a single request to upload a video.
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| channelId required | integer >= 1 Channel id that will contain this video |
| name required | string [ 3 .. 120 ] characters Video name |
| videofile required | string <binary> Video file |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Request samples
- Shell
## DEPENDENCIES: jq USERNAME="<your_username>" PASSWORD="<your_password>" FILE_PATH="<your_file_path>" CHANNEL_ID="<your_channel_id>" NAME="<video_name>" API="https://peertube2.cpy.re/api/v1" ## 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") token=$(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") ## VIDEO UPLOAD curl -s "$API/videos/upload" \ -H "Authorization: Bearer $token" \ --max-time 600 \ --form videofile=@"$FILE_PATH" \ --form channelId=$CHANNEL_ID \ --form name="$NAME"
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Initialize the resumable upload of a video
Uses a resumable protocol to initialize the upload of a video
Authorizations:
OAuth2
header Parameters
| X-Upload-Content-Length required | number Example: 2469036 Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading. |
| X-Upload-Content-Type required | string <mimetype> Example: video/mp4 MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary. |
Request Body schema: application/json
| channelId required | integer >= 1 Channel id that will contain this video |
| filename required | string <filename> Video filename including extension |
| name required | string [ 3 .. 120 ] characters Video name |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Request samples
- Payload
Content type
application/json
{- "name": "What is PeerTube?",
- "channelId": 3,
- "privacy": 1,
- "category": 15,
- "licence": 2,
- "language": "en",
- "description": "**[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)**\n",
- "waitTranscoding": true,
- "generateTranscription": true,
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "nsfw": true,
- "nsfwSummary": null,
- "nsfwFlags": 0,
- "tags": [
- "framasoft",
- "peertube"
], - "commentsEnabled": true,
- "commentsPolicy": 1,
- "downloadEnabled": true,
- "originallyPublishedAt": "2019-08-24T14:15:22Z",
- "scheduleUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "thumbnailfile": "string",
- "previewfile": "string",
- "videoPasswords": [
- "string"
], - "filename": "what_is_peertube.mp4"
}Send chunk for the resumable upload of a video
Uses a resumable protocol to continue, pause or resume the upload of a video
Authorizations:
OAuth2
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 262144 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. |
| Content-Range required | string Example: bytes 0-262143/2469036 Specifies the bytes in the file that the request is uploading. For example, a value of |
Request Body schema: application/octet-stream
string <binary>
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Cancel the resumable upload of a video, deleting any data uploaded so far
Uses a resumable protocol to cancel the upload of a video
Authorizations:
OAuth2
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 0 |
Responses
Import a video
Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
Authorizations:
OAuth2
Request Body schema: multipart/form-data
One of
| channelId required | integer >= 1 Channel id that will contain this video |
| name required | string [ 3 .. 120 ] characters Video name |
| targetUrl required | string <url> remote URL where to find the import's source video |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Initialize the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to initialize the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| X-Upload-Content-Length required | number Example: 2469036 Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading. |
| X-Upload-Content-Type required | string <mimetype> Example: video/mp4 MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary. |
Request Body schema: application/json
| filename | string <filename> Video filename including extension |
Responses
Request samples
- Payload
Content type
application/json
{- "filename": "what_is_peertube.mp4"
}Send chunk for the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to continue, pause or resume the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 262144 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. |
| Content-Range required | string Example: bytes 0-262143/2469036 Specifies the bytes in the file that the request is uploading. For example, a value of |
Request Body schema: application/octet-stream
string <binary>
Responses
Cancel the resumable replacement of a video
PeerTube >= 6.0 Uses a resumable protocol to cancel the replacement of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| upload_id required | string 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. |
header Parameters
| Content-Length required | number Example: 0 |
Responses
Import a video
Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
Authorizations:
OAuth2
Request Body schema: multipart/form-data
One of
| channelId required | integer >= 1 Channel id that will contain this video |
| name required | string [ 3 .. 120 ] characters Video name |
| targetUrl required | string <url> remote URL where to find the import's source video |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Video description |
| downloadEnabled | boolean Enable or disable downloading for this video |
| generateTranscription | boolean PeerTube >= 6.2 If enabled by the admin, automatically generate a subtitle of the video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this video contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| originallyPublishedAt | string <date-time> Date when the content was originally published |
| previewfile | string <binary> Video preview file |
| privacy | |
object (VideoScheduledUpdate) | |
| support | string A text tell the audience how to support the video creator |
| tags | Array of strings [ 1 .. 5 ] items unique [ items [ 2 .. 30 ] characters ] Video tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Video thumbnail file |
| videoPasswords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
| waitTranscoding | boolean Whether or not we wait transcoding before publish the video |
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}List captions of a video
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "language": {
- "id": "en",
- "label": "English"
}, - "captionPath": "string"
}
]
}Generate a video caption
PeerTube >= 6.2 This feature has to be enabled by the administrator
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| forceTranscription | boolean Default: false |
Responses
Request samples
- Payload
Content type
application/json
{- "forceTranscription": false
}Add or replace a video caption
Authorizations:
OAuth2
path Parameters
| captionLanguage required | string (VideoLanguageSet) Example: en The caption language |
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: multipart/form-data
| captionfile | string <binary> The file to upload. |
Responses
Get chapters of a video
PeerTube >= 6.0
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "chapters": {
- "title": "string",
- "timecode": 0
}
}Replace video chapters
PeerTube >= 6.0
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
Array of objects |
Responses
Request samples
- Payload
Content type
application/json
{- "chapters": [
- {
- "title": "string",
- "timecode": 0
}
]
}Operations dealing with the creation, modification and listing of videos within a channel.
List video channels
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}Create a video channel
Authorizations:
OAuth2
Request Body schema: application/json
| displayName required | any Channel display name |
| name required | string [ 1 .. 50 ] characters /^[a-zA-Z0-9\\-_.:]+$/ username of the channel to create |
| description | any Channel description |
| support | any How to support/fund the channel |
Responses
Request samples
- Payload
Content type
application/json
{- "displayName": null,
- "description": null,
- "support": null,
- "name": "framasoft_videos"
}Response samples
- 200
Content type
application/json
{- "videoChannel": {
- "id": 42
}
}Get a video channel
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Responses
Response samples
- 200
Content type
application/json
{- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}Update a video channel
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: application/json
| bulkVideosSupportUpdate | boolean Update the support field for all videos of this channel |
| description | any Channel description |
| displayName | any Channel display name |
| support | any How to support/fund the channel |
Responses
Request samples
- Payload
Content type
application/json
{- "displayName": null,
- "description": null,
- "support": null,
- "bulkVideosSupportUpdate": true
}List videos of a video channel
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}List playlists of a channel
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| playlistType | integer (VideoPlaylistTypeSet) Enum: 1 2 The video playlist type (Regular = |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}Reorder channel playlists
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: application/json
| insertAfterPosition required | integer >= 0 New position for the block to reorder, to add the block before the first element |
| startPosition required | integer >= 1 Start position of the element to reorder |
| reorderLength | integer >= 1 How many element from |
Responses
Request samples
- Payload
Content type
application/json
{- "startPosition": 1,
- "insertAfterPosition": 0,
- "reorderLength": 1
}List followers of a video channel
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| sort | string Value: "createdAt" Sort followers by criteria |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "follower": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "following": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "score": 0,
- "state": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Update channel avatar
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: multipart/form-data
| avatarfile | string <binary> The file to upload. |
Responses
Response samples
- 200
Content type
application/json
{- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Import videos in channel
Import a remote channel/playlist videos into a channel
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: application/json
| externalChannelUrl required | string |
| videoChannelSyncId | integer If part of a channel sync process, specify its id to assign video imports to this channel synchronization |
Responses
Request samples
- Payload
Content type
application/json
{- "videoChannelSyncId": 0
}List video channels of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| withStats | boolean include daily view statistics for the last 30 days and total views (only if authentified as the account user) |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}List the synchronizations of video channels of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "state": {
- "id": 2,
- "label": "PROCESSING"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "lastSyncAt": "2019-08-24T14:15:22Z",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}
]
}Search channels
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| handles | Array of strings Find elements with these handles |
| host | string Find elements owned by this host |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}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.
List comments on user's videos
PeerTube >= 6.2
Authorizations:
OAuth2
query Parameters
string or Array of strings PeerTube >= 6.2 filter on comments that contain one of these automatic tags | |
| isHeldForReview | boolean only display comments that are held for review |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| searchAccount | string Filter comments by searching on the account |
| searchVideo | string Filter comments by searching on the video |
| videoChannelId | integer Limit results on this specific video channel |
| videoId | integer Limit results on this specific video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "heldForReview": true,
- "threadId": 42,
- "inReplyToCommentId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}, - "automaticTags": [
- "string"
]
}
]
}List threads of a video
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Enum: "-createdAt" "-totalReplies" Sort comments by criteria |
| start | integer >= 0 Offset used to paginate results |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 0,
- "totalNotDeletedComments": 0,
- "data": [
- {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "threadId": 42,
- "inReplyToCommentId": 42,
- "videoId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": null,
- "isDeleted": false,
- "heldForReview": true,
- "totalRepliesFromVideoAuthor": 0,
- "totalReplies": 0,
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}Create a thread
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| text required | string <html> [ 1 .. 10000 ] characters Text of the comment |
Responses
Request samples
- Payload
Content type
application/json
{- "text": "This video is wonderful!"
}Response samples
- 200
Content type
application/json
{- "comment": {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "threadId": 42,
- "inReplyToCommentId": 42,
- "videoId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": null,
- "isDeleted": false,
- "heldForReview": true,
- "totalRepliesFromVideoAuthor": 0,
- "totalReplies": 0,
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}Get a thread
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
| threadId required | integer The thread id (root comment id) |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "comment": {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "threadId": 42,
- "inReplyToCommentId": 42,
- "videoId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": null,
- "isDeleted": false,
- "heldForReview": true,
- "totalRepliesFromVideoAuthor": 0,
- "totalReplies": 0,
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}, - "children": [
- { }
]
}List instance comments
Authorizations:
OAuth2
query Parameters
string or Array of strings PeerTube >= 6.2 filter on comments that contain one of these automatic tags | |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
| onLocalVideo | boolean Display only objects of local or remote videos |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| searchAccount | string Filter comments by searching on the account |
| searchVideo | string Filter comments by searching on the video |
| videoChannelId | integer Limit results on this specific video channel |
| videoId | integer Limit results on this specific video |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "heldForReview": true,
- "threadId": 42,
- "inReplyToCommentId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "name": "What is PeerTube?",
- "state": {
- "id": 1,
- "label": "string"
}
}, - "automaticTags": [
- "string"
]
}
]
}Reply to a thread of a video
Authorizations:
OAuth2
path Parameters
| commentId required | integer >= 1 Example: 42 The comment id |
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Request Body schema: application/json
| text required | string <html> [ 1 .. 10000 ] characters Text of the comment |
Responses
Request samples
- Payload
Content type
application/json
{- "text": "This video is wonderful!"
}Response samples
- 200
Content type
application/json
{- "comment": {
- "id": 42,
- "url": "string",
- "text": "This video is wonderful!",
- "threadId": 42,
- "inReplyToCommentId": 42,
- "videoId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "deletedAt": null,
- "isDeleted": false,
- "heldForReview": true,
- "totalRepliesFromVideoAuthor": 0,
- "totalReplies": 0,
- "account": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}Like/dislike a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Request Body schema: application/json
| rating required | string Enum: "like" "dislike" |
Responses
Request samples
- Payload
Content type
application/json
{- "rating": "like"
}Operations dealing with playlists of videos. Playlists are bound to users and/or channels.
List playlists of a channel
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| playlistType | integer (VideoPlaylistTypeSet) Enum: 1 2 The video playlist type (Regular = |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}Reorder channel playlists
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: application/json
| insertAfterPosition required | integer >= 0 New position for the block to reorder, to add the block before the first element |
| startPosition required | integer >= 1 Start position of the element to reorder |
| reorderLength | integer >= 1 How many element from |
Responses
Request samples
- Payload
Content type
application/json
{- "startPosition": 1,
- "insertAfterPosition": 0,
- "reorderLength": 1
}List video playlists
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| playlistType | integer (VideoPlaylistTypeSet) Enum: 1 2 The video playlist type (Regular = |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}Create a video playlist
If the video playlist is set as public, videoChannelId is mandatory.
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| displayName required | string [ 1 .. 120 ] characters Video playlist display name |
| description | string [ 3 .. 1000 ] characters Video playlist description |
| privacy | integer (VideoPlaylistPrivacySet) Enum: 1 2 3 Video playlist privacy policy (see /video-playlists/privacies) |
| thumbnailfile | string <binary> Video playlist thumbnail file |
| videoChannelId | integer >= 1 Video channel in which the playlist will be published |
Responses
Response samples
- 200
Content type
application/json
{- "videoPlaylist": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Response samples
- 200
Content type
application/json
{- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}Update a video playlist
If the video playlist is set as public, the playlist must have a assigned channel.
Authorizations:
OAuth2
path Parameters
| playlistId required | integer >= 1 Example: 42 Playlist id |
Request Body schema: multipart/form-data
| description | string Video playlist description |
| displayName | string [ 1 .. 120 ] characters Video playlist display name |
| privacy | integer (VideoPlaylistPrivacySet) Enum: 1 2 3 Video playlist privacy policy (see /video-playlists/privacies) |
| thumbnailfile | string <binary> Video playlist thumbnail file |
| videoChannelId | integer >= 1 Video channel in which the playlist will be published |
Responses
List videos of a playlist
path Parameters
| playlistId required | integer >= 1 Example: 42 Playlist id |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "position": 2,
- "startTimestamp": 10,
- "stopTimestamp": 42,
- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
}
]
}Add a video in a playlist
Authorizations:
OAuth2
path Parameters
| playlistId required | integer >= 1 Example: 42 Playlist id |
Request Body schema: application/json
required | string or integer Video to add in the playlist |
| startTimestamp | integer <seconds> Start the video at this specific timestamp |
| stopTimestamp | integer <seconds> Stop the video at this specific timestamp |
Responses
Request samples
- Payload
Content type
application/json
{- "videoId": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "startTimestamp": 0,
- "stopTimestamp": 0
}Response samples
- 200
Content type
application/json
{- "videoPlaylistElement": {
- "id": 2
}
}Reorder playlist elements
Authorizations:
OAuth2
path Parameters
| playlistId required | integer >= 1 Example: 42 Playlist id |
Request Body schema: application/json
| insertAfterPosition required | integer >= 0 New position for the block to reorder, to add the block before the first element |
| startPosition required | integer >= 1 Start position of the element to reorder |
| reorderLength | integer >= 1 How many element from |
Responses
Request samples
- Payload
Content type
application/json
{- "startPosition": 1,
- "insertAfterPosition": 0,
- "reorderLength": 1
}Update a playlist element
Authorizations:
OAuth2
path Parameters
| playlistElementId required | integer (id) >= 1 Example: 42 Playlist element id |
| playlistId required | integer >= 1 Example: 42 Playlist id |
Request Body schema: application/json
| startTimestamp | integer <seconds> Start the video at this specific timestamp |
| stopTimestamp | integer <seconds> Stop the video at this specific timestamp |
Responses
Request samples
- Payload
Content type
application/json
{- "startTimestamp": 0,
- "stopTimestamp": 0
}Check video exists in my playlists
Authorizations:
OAuth2
query Parameters
| videoIds required | Array of integers[ items >= 1 ] Example: videoIds=42 The video ids to check |
Responses
Response samples
- 200
Content type
application/json
{- "videoId": [
- {
- "playlistElementId": 0,
- "playlistId": 0,
- "startTimestamp": 0,
- "stopTimestamp": 0
}
]
}List playlists of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| playlistType | integer (VideoPlaylistTypeSet) Enum: 1 2 The video playlist type (Regular = |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}Search playlists
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| host | string Find elements owned by this host |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| uuids | Array of strings Find elements with specific UUIDs |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}Get overall stats of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| endDate | string <date-time> Filter stats by end date |
| startDate | string <date-time> Filter stats by start date |
Responses
Response samples
- 200
Content type
application/json
{- "averageWatchTime": 0,
- "totalWatchTime": 0,
- "viewersPeak": 0,
- "totalViewers": 0,
- "viewersPeakDate": "2019-08-24T14:15:22Z",
- "countries": [
- {
- "isoCode": "string",
- "viewers": 0
}
], - "subdivisions": [
- {
- "name": "string",
- "viewers": 0
}
]
}Get user agent stats of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| endDate | string <date-time> Filter stats by end date |
| startDate | string <date-time> Filter stats by start date |
Responses
Response samples
- 200
Content type
application/json
{- "clients": [
- {
- "name": "string",
- "viewers": 0
}
], - "devices": [
- {
- "name": "console",
- "viewers": 0
}
], - "operatingSystem": [
- {
- "name": "string",
- "viewers": 0
}
]
}Get timeserie stats of a video
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
| metric required | string Enum: "viewers" "aggregateWatchTime" The metric to get |
query Parameters
| endDate | string <date-time> Filter stats by end date |
| startDate | string <date-time> Filter stats by start date |
Responses
Response samples
- 200
Content type
application/json
{- "data": [
- {
- "date": "string",
- "value": 0
}
]
}Request ownership change
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/jsonrequired
| username required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "username": "string"
}PeerTube instances can mirror videos from one another, and help distribute some videos.
For importing videos as your own, refer to video imports.
List videos being mirrored
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Value: "name" Sort abuses by criteria |
| start | integer >= 0 Offset used to paginate results |
| target required | string Enum: "my-videos" "remote-videos" direction of the mirror |
Responses
Response samples
- 200
Content type
application/json
[- {
- "id": 42,
- "name": "string",
- "url": "string",
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "redundancies": {
- "streamingPlaylists": [
- {
- "id": 42,
- "fileUrl": "string",
- "strategy": "manual",
- "size": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "expiresOn": "2019-08-24T14:15:22Z"
}
]
}
}
]Create a studio task
Create a task to edit a video (cut, add intro/outro etc)
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: multipart/form-datarequired
Array
Any of
| name | string Value: "cut" |
object |
Responses
Create a transcoding job
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| transcodingType required | string Enum: "hls" "web-video" |
| forceTranscoding | boolean Default: false If the video is stuck in transcoding state, do it anyway |
Responses
Request samples
- Payload
Content type
application/json
{- "transcodingType": "hls",
- "forceTranscoding": false
}Create a live
Authorizations:
OAuth2
Request Body schema: multipart/form-data
| channelId required | integer Channel id that will contain this live video |
| name required | string [ 3 .. 120 ] characters Live video/replay name |
| category | integer (VideoCategorySet) category id of the video (see /videos/categories) |
| commentsEnabled | boolean Deprecated Deprecated in 6.2, use commentsPolicy instead |
| commentsPolicy | integer (VideoCommentsPolicySet) Enum: 1 2 3 Comments policy of the video (Enabled = |
| description | string Live video/replay description |
| downloadEnabled | boolean Enable or disable downloading for the replay of this live video |
| language | string (VideoLanguageSet) language id of the video (see /videos/languages) |
| latencyMode | integer (LiveVideoLatencyMode) Enum: 1 2 3 The live latency mode (Default = |
| licence | integer (VideoLicenceSet) licence id of the video (see /videos/licences) |
| nsfw | boolean Whether or not this live video/replay contains sensitive content |
| nsfwFlags | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwSummary | any More information about the sensitive content of the video |
| permanentLive | boolean User can stream multiple times in a permanent live |
| previewfile | string <binary> Live video/replay preview file |
| privacy | |
object (LiveVideoReplaySettings) | |
| saveReplay | boolean |
Array of objects (LiveSchedule) | |
| support | string A text tell the audience how to support the creator |
| tags | Array of strings [ 1 .. 5 ] items [ items [ 2 .. 30 ] characters ] Live video/replay tags (maximum 5 tags each between 2 and 30 characters) |
| thumbnailfile | string <binary> Live video/replay thumbnail file |
Responses
Response samples
- 200
Content type
application/json
{- "video": {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Get information about a live
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Responses
Response samples
- 200
Content type
application/json
{- "rtmpUrl": "string",
- "rtmpsUrl": "string",
- "streamKey": "string",
- "saveReplay": true,
- "replaySettings": {
- "privacy": 1
}, - "permanentLive": true,
- "latencyMode": 1,
- "schedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
]
}Update information about a live
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| latencyMode | integer (LiveVideoLatencyMode) Enum: 1 2 3 The live latency mode (Default = |
| permanentLive | boolean User can stream multiple times in a permanent live |
object (LiveVideoReplaySettings) | |
| saveReplay | boolean |
Array of objects (LiveSchedule) |
Responses
Request samples
- Payload
Content type
application/json
{- "saveReplay": true,
- "replaySettings": {
- "privacy": 1
}, - "permanentLive": true,
- "latencyMode": 1,
- "schedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
]
}List live sessions
List all sessions created in a particular live
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "error": 1,
- "replayVideo": {
- "id": 0,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}
]
}Get live session of a replay
If the video is a replay of a live, you can find the associated live session using this endpoint
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
header Parameters
| x-peertube-video-password | string Required on password protected video |
Responses
Response samples
- 200
Content type
application/json
{- "id": 0,
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "error": 1,
- "replayVideo": {
- "id": 0,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
}
}Operations dealing with synchronizing PeerTube user's channel with channels of other platforms
Import videos in channel
Import a remote channel/playlist videos into a channel
Authorizations:
OAuth2
path Parameters
| channelHandle required | string Example: my_username | my_username@example.com The video channel handle |
Request Body schema: application/json
| externalChannelUrl required | string |
| videoChannelSyncId | integer If part of a channel sync process, specify its id to assign video imports to this channel synchronization |
Responses
Request samples
- Payload
Content type
application/json
{- "videoChannelSyncId": 0
}Create a synchronization for a video channel
Authorizations:
OAuth2
Request Body schema: application/json
| externalChannelUrl | string |
| videoChannelId | integer (id) >= 1 |
Responses
Request samples
- Payload
Content type
application/json
{- "videoChannelId": 42
}Response samples
- 200
Content type
application/json
{- "videoChannelSync": {
- "id": 42,
- "state": {
- "id": 2,
- "label": "PROCESSING"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "lastSyncAt": "2019-08-24T14:15:22Z",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}
}List the synchronizations of video channels of an account
path Parameters
| name required | string Example: chocobozzz | chocobozzz@example.org The username or handle of the account |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "state": {
- "id": 2,
- "label": "PROCESSING"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "lastSyncAt": "2019-08-24T14:15:22Z",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}
]
}List video passwords
PeerTube >= 6.0
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 204
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "password": "string",
- "videoId": 42
}
]
}Update video passwords
PeerTube >= 6.0
Authorizations:
OAuth2
path Parameters
required | id (integer) or UUIDv4 (string) or shortUUID (string) The object id, uuid or short uuid |
Request Body schema: application/json
| passwords | Array of strings (AddVideoPasswords) unique [ items >= 2 characters ] |
Responses
Request samples
- Payload
Content type
application/json
{- "passwords": [
- "string"
]
}The search helps to find videos or channels from within the instance and beyond. 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.
Administrators can also enable the use of a remote search system, indexing videos and channels not could be not federated by the instance.
Search videos
query Parameters
string or Array of strings PeerTube >= 6.2 Admins and moderators only filter on videos that contain one of these automatic tags | |
VideoCategorySet (integer) or Array of VideoCategorySet (integers) category id of the video (see /videos/categories) | |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| durationMax | integer Get videos that have this maximum duration |
| durationMin | integer Get videos that have this minimum duration |
| endDate | string <date-time> Get videos that are published before this date |
| excludeAlreadyWatched | boolean Whether or not to exclude videos that are in the user's video history |
| hasHLSFiles | boolean PeerTube >= 4.0 Display only videos that have HLS files |
| hasWebVideoFiles | boolean PeerTube >= 6.0 Display only videos that have Web Video files |
| host | string Find elements owned by this host |
| include | integer Enum: 0 1 2 4 8 16 32 Only administrators and moderators can use this parameter Include additional videos in results (can be combined using bitwise or operator)
|
| includeScheduledLive | boolean whether or not include live that are scheduled for later |
| isLive | boolean whether or not the video is a live |
| isLocal | boolean PeerTube >= 4.0 Display only local or remote objects |
VideoLanguageSet (string) or Array of VideoLanguageSet (strings) language id of the video (see /videos/languages). Use | |
VideoLicenceSet (integer) or Array of VideoLicenceSet (integers) licence id of the video (see /videos/licences) | |
| nsfw | string Enum: "true" "false" whether to include nsfw videos, if any |
| nsfwFlagsExcluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| nsfwFlagsIncluded | integer (NSFWFlag) Enum: 0 1 2 4 NSFW flags (can be combined using bitwise or operator)
|
| originallyPublishedEndDate | string <date-time> Get videos that are originally published before this date |
| originallyPublishedStartDate | string <date-time> Get videos that are originally published after this date |
| privacyOneOf | integer (VideoPrivacySet) Enum: 1 2 3 4 5 PeerTube >= 4.0 Display only videos in this specific privacy/privacies |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| skipCount | string Default: "false" Enum: "true" "false" if you don't need the |
| sort | string Enum: "name" "-duration" "-createdAt" "-publishedAt" "-views" "-likes" "-comments" "-trending" "-hot" "-best" Sort videos by criteria (prefixing with
|
| start | integer >= 0 Offset used to paginate results |
| startDate | string <date-time> Get videos that are published after this date |
string or Array of strings tag(s) of the video, where all should be present in the video | |
string or Array of strings tag(s) of the video | |
| uuids | Array of strings Find elements with specific UUIDs |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "isLive": true,
- "liveSchedules": [
- {
- "startAt": "2019-08-24T14:15:22Z"
}
], - "createdAt": "2017-10-01T10:52:46.396Z",
- "publishedAt": "2018-10-01T10:52:46.396Z",
- "updatedAt": "2021-05-04T08:01:01.502Z",
- "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
- "category": {
- "id": 15,
- "label": "Science & Technology"
}, - "licence": {
- "id": 2,
- "label": "Attribution - Share Alike"
}, - "language": {
- "id": "en",
- "label": "English"
}, - "privacy": {
- "id": 1,
- "label": "string"
}, - "truncatedDescription": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
- "duration": 1419,
- "aspectRatio": 1.778,
- "isLocal": true,
- "name": "What is PeerTube?",
- "thumbnailPath": "/lazy-static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
- "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
- "views": 1337,
- "likes": 42,
- "dislikes": 7,
- "comments": 0,
- "nsfw": true,
- "nsfwFlags": 0,
- "nsfwSummary": "string",
- "waitTranscoding": true,
- "state": {
- "id": 1,
- "label": "string"
}, - "scheduledUpdate": {
- "privacy": 1,
- "updateAt": "2019-08-24T14:15:22Z"
}, - "blacklisted": true,
- "blacklistedReason": "string",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "channel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "userHistory": {
- "currentTime": 0
}
}
]
}Search channels
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| handles | Array of strings Find elements with these handles |
| host | string Find elements owned by this host |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
]
}Search playlists
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| host | string Find elements owned by this host |
| search required | string 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. |
| searchTarget | string Enum: "local" "search-index" 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. It means the instance may not yet know the objects you fetched. If you want to load video/channel information:
|
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| uuids | Array of strings Find elements with specific UUIDs |
Responses
Callbacks
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "description": "string",
- "displayName": "string",
- "isLocal": true,
- "videoLength": 0,
- "thumbnailPath": "string",
- "privacy": {
- "id": 1,
- "label": "string"
}, - "type": {
- "id": 1,
- "label": "string"
}, - "ownerAccount": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannel": {
- "id": 42,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}, - "videoChannelPosition": 1
}
]
}List my abuses
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| id | integer only list the report with this id |
| sort | string Enum: "-id" "-createdAt" "-state" Sort abuses by criteria |
| start | integer >= 0 Offset used to paginate results |
| state | integer (AbuseStateSet) Enum: 1 2 3 The abuse state (Pending = |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "reason": "The video is a spam",
- "predefinedReasons": [
- "spamOrMisleading"
], - "reporterAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "state": {
- "id": 1,
- "label": "string"
}, - "moderationComment": "Decided to ban the server since it spams us regularly",
- "video": {
- "id": 0,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "name": "string",
- "nsfw": true,
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "deleted": true,
- "blacklisted": true,
- "thumbnailPath": "string",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}, - "createdAt": "2019-08-24T14:15:22Z"
}
]
}List abuses
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| filter | string Enum: "video" "comment" "account" only list account, comment or video reports |
| id | integer only list the report with this id |
| predefinedReason | Array of strings (PredefinedAbuseReasons) <= 8 items Items Enum: "violentOrAbusive" "hatefulOrAbusive" "spamOrMisleading" "privacy" "rights" "serverRules" "thumbnails" "captions" predefined reason the listed reports should contain |
| search | string plain search that will match with video titles, reporter names and more |
| searchReportee | string only list reports of a specific reportee |
| searchReporter | string only list reports of a specific reporter |
| searchVideo | string only list reports of a specific video |
| searchVideoChannel | string only list reports of a specific video channel |
| sort | string Enum: "-id" "-createdAt" "-state" Sort abuses by criteria |
| start | integer >= 0 Offset used to paginate results |
| state | integer (AbuseStateSet) Enum: 1 2 3 The abuse state (Pending = |
| videoIs | string Enum: "deleted" "blacklisted" only list deleted or blocklisted videos |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "reason": "The video is a spam",
- "predefinedReasons": [
- "spamOrMisleading"
], - "reporterAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}, - "state": {
- "id": 1,
- "label": "string"
}, - "moderationComment": "Decided to ban the server since it spams us regularly",
- "video": {
- "id": 0,
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
- "name": "string",
- "nsfw": true,
- "startAt": "2019-08-24T14:15:22Z",
- "endAt": "2019-08-24T14:15:22Z",
- "deleted": true,
- "blacklisted": true,
- "thumbnailPath": "string",
- "channel": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "displayName": "Videos of Framasoft",
- "description": "Videos made with <3 by Framasoft",
- "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
- "isLocal": true,
- "banners": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "ownerAccount": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "userId": 42,
- "displayName": "string",
- "description": "string"
}
}
}, - "createdAt": "2019-08-24T14:15:22Z"
}
]
}Report an abuse
Authorizations:
OAuth2
Request Body schema: application/jsonrequired
| reason required | string [ 2 .. 3000 ] characters Reason why the user reports this video |
object | |
object | |
| predefinedReasons | Array of strings (PredefinedAbuseReasons) <= 8 items Items Enum: "violentOrAbusive" "hatefulOrAbusive" "spamOrMisleading" "privacy" "rights" "serverRules" "thumbnails" "captions" Reason categories that help triage reports |
object |
Responses
Request samples
- Payload
Content type
application/json
{- "reason": "string",
- "predefinedReasons": [
- "violentOrAbusive"
], - "video": {
- "id": 42,
- "startAt": 0,
- "endAt": 0
}, - "comment": {
- "id": 42
}, - "account": {
- "id": 0
}
}Response samples
- 200
Content type
application/json
{- "abuse": {
- "id": 42
}
}Update an abuse
Authorizations:
OAuth2
path Parameters
| abuseId required | integer >= 1 Example: 42 Abuse id |
Request Body schema: application/json
| moderationComment | string [ 2 .. 3000 ] characters Update the report comment visible only to the moderation team |
| state | integer (AbuseStateSet) Enum: 1 2 3 The abuse state (Pending = |
Responses
Request samples
- Payload
Content type
application/json
{- "state": 1,
- "moderationComment": "string"
}List messages of an abuse
Authorizations:
OAuth2
path Parameters
| abuseId required | integer >= 1 Example: 42 Abuse id |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "message": "string",
- "byModerator": true,
- "createdAt": "2019-08-24T14:15:22Z",
- "account": {
- "id": 0,
- "name": "string",
- "displayName": "string",
- "url": "string",
- "host": "example.com",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
}
]
}Operations dealing with blocking videos (removing them from view and preventing interactions).
List video blocks
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string plain search that will match with video titles, and more |
| sort | string Enum: "-id" "name" "-duration" "-views" "-likes" "-dislikes" "-uuid" "-createdAt" Sort blocklists by criteria |
| start | integer >= 0 Offset used to paginate results |
| type | integer Enum: 1 2 list only blocks that match this type:
|
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "videoId": 42,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "description": "string",
- "duration": 0,
- "views": 0,
- "likes": 0,
- "dislikes": 0,
- "nsfw": true
}
]
}Get block status of accounts/hosts
query Parameters
| accounts | Array of strings Example: accounts=goofy@example.com&accounts=donald@example.com Check if these accounts are blocked |
| hosts | Array of strings Example: hosts=example.com Check if these hosts are blocked |
Responses
Response samples
- 200
Content type
application/json
{- "accounts": {
- "account1": {
- "blockedByServer": true,
- "blockedByUser": true
}, - "account2": {
- "blockedByServer": true,
- "blockedByUser": true
}
}, - "hosts": {
- "host1": {
- "blockedByServer": true,
- "blockedByUser": true
}, - "host2": {
- "blockedByServer": true,
- "blockedByUser": true
}
}
}Get block status of accounts/hosts
query Parameters
| accounts | Array of strings Example: accounts=goofy@example.com&accounts=donald@example.com Check if these accounts are blocked |
| hosts | Array of strings Example: hosts=example.com Check if these hosts are blocked |
Responses
Response samples
- 200
Content type
application/json
{- "accounts": {
- "account1": {
- "blockedByServer": true,
- "blockedByUser": true
}, - "account2": {
- "blockedByServer": true,
- "blockedByUser": true
}
}, - "hosts": {
- "host1": {
- "blockedByServer": true,
- "blockedByUser": true
}, - "host2": {
- "blockedByServer": true,
- "blockedByUser": true
}
}
}Automatic tags set on objects (like comments or videos) by specific rules (external link, watched words, etc.)
List account watched words
PeerTube >= 6.2
Authorizations:
OAuth2
path Parameters
| accountName required | string account name to list watched words |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "listName": "string",
- "words": [
- "string"
], - "updatedAt": "2021-05-04T08:01:01.502Z",
- "createdAt": "2021-05-04T08:01:01.502Z"
}
]
}Add account watched words
PeerTube >= 6.2
Authorizations:
OAuth2
path Parameters
| accountName required | string |
Request Body schema: application/json
| listName | string |
| words | Array of strings |
Responses
Request samples
- Payload
Content type
application/json
{- "listName": "string",
- "words": [
- "string"
]
}Response samples
- 200
Content type
application/json
{- "watchedWordsList": {
- "id": 0
}
}Update account watched words
PeerTube >= 6.2
Authorizations:
OAuth2
path Parameters
| accountName required | string |
| listId required | string list of watched words to update |
Request Body schema: application/json
| listName | string |
| words | Array of strings |
Responses
Request samples
- Payload
Content type
application/json
{- "listName": "string",
- "words": [
- "string"
]
}Add server watched words
PeerTube >= 6.2
Authorizations:
OAuth2
Request Body schema: application/json
| listName | string |
| words | Array of strings |
Responses
Request samples
- Payload
Content type
application/json
{- "listName": "string",
- "words": [
- "string"
]
}Response samples
- 200
Content type
application/json
{- "watchedWordsList": {
- "id": 0
}
}Update server watched words
PeerTube >= 6.2
Authorizations:
OAuth2
path Parameters
| listId required | string list of watched words to update |
Request Body schema: application/json
| listName | string |
| words | Array of strings |
Responses
Request samples
- Payload
Content type
application/json
{- "listName": "string",
- "words": [
- "string"
]
}Response samples
- 200
Content type
application/json
{- "client": {
- "header": {
- "hideInstanceName": false
}, - "videos": {
- "miniature": {
- "preferAuthorDisplayName": true
}, - "resumableUpload": {
- "maxChunkSize": 0
}
}, - "menu": {
- "login": {
- "redirectOnSingleExternalAuth": false
}
}, - "openInApp": {
- "android": {
- "intent": {
- "enabled": true,
- "host": "joinpeertube.org",
- "scheme": "peertube",
}
}, - "ios": {
- "enabled": true,
- "host": "joinpeertube.org",
- "scheme": "peertube",
}
}
}, - "defaults": {
- "publish": {
- "downloadEnabled": true,
- "commentsPolicy": 1,
- "commentsEnabled": true,
- "privacy": 4,
- "licence": null
}, - "p2p": {
- "webapp": {
- "enabled": false
}, - "embed": {
- "enabled": false
}
}, - "player": {
- "autoPlay": true
}
}, - "webadmin": {
- "configuration": {
- "edition": {
- "allowed": true
}
}
}, - "instance": {
- "name": "PeerTube Nightly",
- "shortDescription": "PeerTube instance updated nightly",
- "isNSFW": false,
- "defaultNSFWPolicy": "do_not_list",
- "defaultClientRoute": "/home",
- "serverCountry": "",
- "support": {
- "text": ""
}, - "social": {
- "blueskyLink": "",
- "mastodonLink": "",
- "externalLink": ""
}, - "customizations": {
- "javascript": "",
- "css": ""
}, - "defaultLanguage": "en",
- "avatars": [
- {
- "height": 48,
- "width": 48,
- "path": "/lazy-static/avatars/abace30f-69ad-4ff2-a954-dea06c5db6eb.png",
- "createdAt": "2024-05-15T09:12:38.749Z",
- "updatedAt": "2024-05-15T09:12:38.749Z"
}, - {
- "height": 120,
- "width": 120,
- "path": "/lazy-static/avatars/1163da44-0367-4df9-bf10-a1b0dc0e3fb9.png",
- "createdAt": "2024-05-15T09:12:38.719Z",
- "updatedAt": "2024-05-15T09:12:38.719Z"
}, - {
- "height": 600,
- "width": 600,
- "path": "/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png",
- "createdAt": "2024-05-15T09:12:38.709Z",
- "updatedAt": "2024-05-15T09:12:38.709Z"
}, - {
- "height": 1500,
- "width": 1500,
- "path": "/lazy-static/avatars/82936e50-9560-42e7-9e4b-d96309f5c9c9.png",
- "createdAt": "2024-05-15T09:12:38.684Z",
- "updatedAt": "2024-05-15T09:12:38.684Z"
}
], - "banners": [
- {
- "height": 100,
- "width": 600,
- "path": "/lazy-static/banners/d853452c-f020-4c6f-a4ea-9fc582d68ff2.jpg",
- "createdAt": "2024-04-16T14:09:02.665Z",
- "updatedAt": "2024-04-16T14:09:02.665Z"
}, - {
- "height": 317,
- "width": 1920,
- "path": "/lazy-static/banners/772ff0ae-6cb5-4d1c-b89b-ace85eece196.jpg",
- "createdAt": "2024-04-16T14:09:02.615Z",
- "updatedAt": "2024-04-16T14:09:02.615Z"
}
], - "logo": [
- {
- "height": 48,
- "width": 48,
- "type": "favicon",
- "isFallback": true
}, - {
- "height": 120,
- "width": 120,
- "type": "favicon",
- "isFallback": true
}, - {
- "height": 600,
- "width": 600,
- "type": "favicon",
- "isFallback": true
}, - {
- "height": 1500,
- "width": 1500,
- "type": "favicon",
- "isFallback": true
}, - {
- "height": 48,
- "width": 48,
- "type": "header-square",
- "isFallback": true
}, - {
- "height": 120,
- "width": 120,
- "type": "header-square",
- "isFallback": true
}, - {
- "height": 600,
- "width": 600,
- "type": "header-square",
- "isFallback": true
}, - {
- "height": 1500,
- "width": 1500,
- "type": "header-square",
- "isFallback": true
}, - {
- "height": 48,
- "width": 48,
- "type": "header-wide",
- "isFallback": true
}, - {
- "height": 120,
- "width": 120,
- "type": "header-wide",
- "isFallback": true
}, - {
- "height": 600,
- "width": 600,
- "type": "header-wide",
- "isFallback": true
}, - {
- "height": 1500,
- "width": 1500,
- "type": "header-wide",
- "isFallback": true
}, - {
- "height": 48,
- "width": 48,
- "type": "opengraph",
- "isFallback": true
}, - {
- "height": 120,
- "width": 120,
- "type": "opengraph",
- "isFallback": true
}, - {
- "height": 600,
- "width": 600,
- "type": "opengraph",
- "isFallback": true
}, - {
- "height": 1500,
- "width": 1500,
- "type": "opengraph",
- "isFallback": true
}
]
}, - "search": {
- "remoteUri": {
- "users": true,
- "anonymous": false
}, - "searchIndex": {
- "enabled": false,
- "disableLocalSearch": false,
- "isDefaultSearch": false
}
}, - "plugin": {
- "registered": [
- {
- "npmName": "peertube-plugin-matomo",
- "name": "matomo",
- "version": "1.0.2",
- "description": "Matomo plugin that tracks page views on a PeerTube instance.",
- "clientScripts": {
- "dist/common-client-plugin.js": {
- "script": "dist/common-client-plugin.js",
- "scopes": [
- "common"
]
}, - "dist/embed-client-plugin.js": {
- "script": "dist/embed-client-plugin.js",
- "scopes": [
- "embed"
]
}
}
}, - {
- "npmName": "peertube-plugin-auto-mute",
- "name": "auto-mute",
- "version": "0.0.6",
- "description": "Auto mute plugin for PeerTube",
- "clientScripts": { }
}, - {
- "npmName": "peertube-plugin-auth-ldap",
- "name": "auth-ldap",
- "version": "0.0.14",
- "description": "Add LDAP support to login form in PeerTube.",
- "clientScripts": { }
}, - {
- "npmName": "peertube-plugin-livechat",
- "name": "livechat",
- "version": "14.0.0",
- "description": "PeerTube plugin livechat: create chat rooms for your Peertube lives! Comes with many features: federation, moderation tools, chat bot, chat persistence, OBS integration, ...",
- "clientScripts": {
- "dist/client/common-client-plugin.js": {
- "script": "dist/client/common-client-plugin.js",
- "scopes": [
- "common"
]
}, - "dist/client/admin-plugin-client-plugin.js": {
- "script": "dist/client/admin-plugin-client-plugin.js",
- "scopes": [
- "admin-plugin"
]
}
}
}, - {
- "npmName": "peertube-plugin-akismet",
- "name": "akismet",
- "version": "0.1.2",
- "description": "Reject local comments, remote comments and registrations based on Akismet service",
- "clientScripts": {
- "dist/common-client-plugin.js": {
- "script": "dist/common-client-plugin.js",
- "scopes": [
- "common"
]
}
}
}, - {
- "npmName": "peertube-plugin-transcoding-custom-quality",
- "name": "transcoding-custom-quality",
- "version": "0.2.0",
- "description": "Set a custom quality for transcoding",
- "clientScripts": { }
}
], - "registeredExternalAuths": [ ],
- "registeredIdAndPassAuths": [
- {
- "npmName": "peertube-plugin-auth-ldap",
- "name": "auth-ldap",
- "version": "0.0.14",
- "authName": "ldap",
- "weight": 100
}
]
}, - "theme": {
- "registered": [
- {
- "npmName": "peertube-theme-dark",
- "name": "dark",
- "version": "3.0.2",
- "description": "PeerTube dark theme",
- "css": [
- "assets/style.css"
], - "clientScripts": { }
}, - {
- "npmName": "peertube-theme-framasoft",
- "name": "framasoft",
- "version": "1.0.0",
- "description": "PeerTube Framasoft theme",
- "css": [
- "assets/style.css"
], - "clientScripts": { }
}
], - "builtIn": [
- {
- "name": "peertube-core-dark-brown"
}, - {
- "name": "peertube-core-light-beige"
}
], - "default": "default",
- "customization": {
- "primaryColor": null,
- "foregroundColor": null,
- "backgroundColor": null,
- "backgroundSecondaryColor": null,
- "menuForegroundColor": null,
- "menuBackgroundColor": null,
- "menuBorderRadius": null,
- "headerForegroundColor": null,
- "headerBackgroundColor": null,
- "inputBorderRadius": null
}
}, - "email": {
- "enabled": true
}, - "contactForm": {
- "enabled": true
}, - "serverVersion": "7.2.3-nightly-2025-08-13",
- "serverCommit": "",
- "transcoding": {
- "remoteRunners": {
- "enabled": true
}, - "hls": {
- "enabled": true
}, - "web_videos": {
- "enabled": false
}, - "enabledResolutions": [
- 0,
- 240,
- 480
], - "profile": "custom-quality",
- "availableProfiles": [
- "default",
- "custom-quality"
]
}, - "live": {
- "enabled": true,
- "allowReplay": true,
- "latencySetting": {
- "enabled": true
}, - "maxDuration": -1,
- "maxInstanceLives": 20,
- "maxUserLives": 4,
- "transcoding": {
- "enabled": true,
- "remoteRunners": {
- "enabled": true
}, - "enabledResolutions": [
- 360
], - "profile": "default",
- "availableProfiles": [
- "default",
- "custom-quality"
]
}, - "rtmp": {
- "port": 1935
}
}, - "videoStudio": {
- "enabled": true,
- "remoteRunners": {
- "enabled": false
}
}, - "videoFile": {
- "update": {
- "enabled": true
}
}, - "videoTranscription": {
- "enabled": true,
- "remoteRunners": {
- "enabled": true
}
}, - "import": {
- "videos": {
- "http": {
- "enabled": true
}, - "torrent": {
- "enabled": true
}
}, - "videoChannelSynchronization": {
- "enabled": true
}, - "users": {
- "enabled": true
}
}, - "export": {
- "users": {
- "enabled": true,
- "exportExpiration": 172800000,
- "maxUserVideoQuota": 10737418240
}
}, - "autoBlacklist": {
- "videos": {
- "ofUsers": {
- "enabled": true
}
}
}, - "avatar": {
- "file": {
- "size": {
- "max": 8388608
}, - "extensions": [
- ".png",
- ".jpeg",
- ".jpg",
- ".gif",
- ".webp"
]
}
}, - "banner": {
- "file": {
- "size": {
- "max": 8388608
}, - "extensions": [
- ".png",
- ".jpeg",
- ".jpg",
- ".gif",
- ".webp"
]
}
}, - "video": {
- "image": {
- "extensions": [
- ".png",
- ".jpg",
- ".jpeg",
- ".webp"
], - "size": {
- "max": 8388608
}
}, - "file": {
- "extensions": [
- ".webm",
- ".ogv",
- ".ogg",
- ".mp4",
- ".mkv",
- ".mov",
- ".qt",
- ".mqv",
- ".m4v",
- ".flv",
- ".f4v",
- ".wmv",
- ".avi",
- ".3gp",
- ".3gpp",
- ".3g2",
- ".3gpp2",
- ".nut",
- ".mts",
- "ts",
- ".m2ts",
- ".mpv",
- ".m2v",
- ".m1v",
- ".mpg",
- ".mpe",
- ".mpeg",
- ".vob",
- ".mxf",
- ".mp3",
- ".wma",
- ".wav",
- ".flac",
- ".aac",
- ".m4a",
- ".ac3"
]
}
}, - "videoCaption": {
- "file": {
- "size": {
- "max": 20971520
}, - "extensions": [
- ".vtt",
- ".srt"
]
}
}, - "user": {
- "videoQuota": -1,
- "videoQuotaDaily": 104857600
}, - "videoChannels": {
- "maxPerUser": 20
}, - "trending": {
- "videos": {
- "intervalDays": 7,
- "algorithms": {
- "enabled": [
- "best",
- "hot",
- "most-viewed",
- "most-liked"
], - "default": "most-viewed"
}
}
}, - "tracker": {
- "enabled": true
}, - "followings": {
}, - "federation": {
- "enabled": true
}, - "broadcastMessage": {
- "enabled": false,
- "message": "We are currently experiencing technical problems on this instance. We are trying to fix it as soon as possible. Thank you for your understanding.",
- "level": "error",
- "dismissable": false
}, - "homepage": {
- "enabled": true
}, - "openTelemetry": {
- "metrics": {
- "enabled": true,
- "playbackStatsInterval": 15000
}
}, - "views": {
- "videos": {
- "watchingInterval": {
- "anonymous": 5000,
- "users": 5000
}
}
}, - "storyboards": {
- "enabled": true
}, - "webrtc": {
- "stunServers": [
- "stun:stunserver2024.stunprotocol.org",
- "stun:stun.framasoft.org"
]
}, - "nsfwFlagsSettings": {
- "enabled": true
}, - "signup": {
- "allowed": false,
- "allowedForCurrentIP": true,
- "minimumAge": 16,
- "requiresApproval": true,
- "requiresEmailVerification": true
}
}
Response samples
- 200
Content type
application/json
{- "instance": {
- "name": "PeerTube Nightly",
- "shortDescription": "PeerTube instance updated nightly",
- "description": "This instance is a test instance of the PeerTube project. It is updated to the latest commit in the develop branch every business day, 8pm CET.",
- "terms": "No terms for now. Being a closed test instance, no real terms of use beyond fair use are to be expected.",
- "codeOfConduct": "",
- "hardwareInformation": "",
- "creationReason": "",
- "moderationInformation": "",
- "administrator": "",
- "maintenanceLifetime": "",
- "businessModel": "",
- "languages": [
- "fr"
], - "categories": [
- 16
], - "banners": [
- {
- "height": 100,
- "width": 600,
- "path": "/lazy-static/banners/d853452c-f020-4c6f-a4ea-9fc582d68ff2.jpg",
- "createdAt": "2024-04-16T14:09:02.665Z",
- "updatedAt": "2024-04-16T14:09:02.665Z"
}, - {
- "height": 317,
- "width": 1920,
- "path": "/lazy-static/banners/772ff0ae-6cb5-4d1c-b89b-ace85eece196.jpg",
- "createdAt": "2024-04-16T14:09:02.615Z",
- "updatedAt": "2024-04-16T14:09:02.615Z"
}
], - "avatars": [
- {
- "height": 48,
- "width": 48,
- "path": "/lazy-static/avatars/abace30f-69ad-4ff2-a954-dea06c5db6eb.png",
- "createdAt": "2024-05-15T09:12:38.749Z",
- "updatedAt": "2024-05-15T09:12:38.749Z"
}, - {
- "height": 120,
- "width": 120,
- "path": "/lazy-static/avatars/1163da44-0367-4df9-bf10-a1b0dc0e3fb9.png",
- "createdAt": "2024-05-15T09:12:38.719Z",
- "updatedAt": "2024-05-15T09:12:38.719Z"
}, - {
- "height": 600,
- "width": 600,
- "path": "/lazy-static/avatars/177f70c4-ddef-4bb6-bc96-b00d5e2a0e05.png",
- "createdAt": "2024-05-15T09:12:38.709Z",
- "updatedAt": "2024-05-15T09:12:38.709Z"
}, - {
- "height": 1500,
- "width": 1500,
- "path": "/lazy-static/avatars/82936e50-9560-42e7-9e4b-d96309f5c9c9.png",
- "createdAt": "2024-05-15T09:12:38.684Z",
- "updatedAt": "2024-05-15T09:12:38.684Z"
}
]
}
}Response samples
- 200
Content type
application/json
{- "instance": {
- "name": "string",
- "shortDescription": "string",
- "description": "string",
- "terms": "string",
- "codeOfConduct": "string",
- "creationReason": "string",
- "moderationInformation": "string",
- "administrator": "string",
- "maintenanceLifetime": "string",
- "businessModel": "string",
- "hardwareInformation": "string",
- "languages": [
- "string"
], - "categories": [
- 0
], - "isNSFW": true,
- "defaultNSFWPolicy": "string",
- "serverCountry": "string",
- "support": {
- "text": "string"
}, - "social": {
- "externalLink": "string",
- "mastodonLink": "string",
- "blueskyLink": "string"
}, - "defaultClientRoute": "string",
- "customizations": {
- "javascript": "string",
- "css": "string"
}
}, - "theme": {
- "default": "string"
}, - "services": {
- "twitter": {
- "username": "string"
}
}, - "cache": {
- "previews": {
- "size": 0
}, - "captions": {
- "size": 0
}
}, - "signup": {
- "enabled": true,
- "limit": 0,
- "requiresEmailVerification": true
}, - "admin": {
- "email": "user@example.com"
}, - "contactForm": {
- "enabled": true
}, - "user": {
- "videoQuota": 16810141515,
- "videoQuotaDaily": 1681014151
}, - "transcoding": {
- "enabled": true,
- "originalFile": {
- "keep": true
}, - "allowAdditionalExtensions": true,
- "allowAudioFiles": true,
- "threads": 0,
- "concurrency": 0,
- "profile": "default",
- "resolutions": {
- "0p": true,
- "144p": true,
- "240p": true,
- "360p": true,
- "480p": true,
- "720p": true,
- "1080p": true,
- "1440p": true,
- "2160p": true
}, - "web_videos": {
- "enabled": true
}, - "hls": {
- "enabled": true,
- "splitAudioAndVideo": true
}
}, - "import": {
- "videos": {
- "http": {
- "enabled": true
}, - "torrent": {
- "enabled": true
}
}, - "video_channel_synchronization": {
- "enabled": true
}
}, - "autoBlacklist": {
- "videos": {
- "ofUsers": {
- "enabled": true
}
}
}, - "followers": {
- "instance": {
- "enabled": true,
- "manualApproval": true
}
}, - "storyboard": {
- "enabled": true
}, - "defaults": {
- "publish": {
- "downloadEnabled": true,
- "commentsPolicy": 1,
- "privacy": 1,
- "licence": 2
}, - "p2p": {
- "webapp": {
- "enabled": true
}, - "embed": {
- "enabled": true
}
}, - "player": {
- "autoPlay": true
}
}
}Update client language
Set a cookie so that, the next time the client refreshes the HTML of the web interface, PeerTube will use the next language
Request Body schema: application/json
| language required | string Language code to set |
Responses
Request samples
- Payload
Content type
application/json
{- "language": "en-US"
}Managing servers which the instance interacts with is crucial to the concept of federation in PeerTube and external video indexation. The PeerTube server then deals with inter-server ActivityPub operations and propagates information across its social graph by posting activities to actors' inbox endpoints.
List instances following the server
query Parameters
| actorType | string Enum: "Person" "Application" "Group" "Service" "Organization" |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| state | string Enum: "pending" "accepted" |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "follower": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "following": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "score": 0,
- "state": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}List instances followed by the server
query Parameters
| actorType | string Enum: "Person" "Application" "Group" "Service" "Organization" |
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| state | string Enum: "pending" "accepted" |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "follower": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "following": {
- "id": 42,
- "url": "string",
- "name": "chocobozzz",
- "avatars": [
- {
- "path": "string",
- "width": 0,
- "height": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "host": "example.com",
- "hostRedundancyAllowed": true,
- "followingCount": 0,
- "followersCount": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}, - "score": 0,
- "state": "pending",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Follow a list of actors (PeerTube instance, channel or account)
Authorizations:
OAuth2
Request Body schema: application/json
| handles | Array of strings unique |
| hosts | Array of strings <hostname> unique [ items <hostname > ] |
Responses
Request samples
- Payload
Content type
application/json
{- "hosts": [
- "example.com"
], - "handles": [
- "string"
]
}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 to mirror individual videos, see video mirroring.
Update a server redundancy policy
Authorizations:
OAuth2
path Parameters
| host required | string <hostname> server domain to mirror |
Request Body schema: application/json
| redundancyAllowed required | boolean allow mirroring of the host's local videos |
Responses
Request samples
- Payload
Content type
application/json
{- "redundancyAllowed": true
}Managing plugins installed from a local path or from NPM, or search for new ones.
List plugins
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| pluginType | integer |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
| uninstalled | boolean |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "name": "peertube-plugin-auth-ldap",
- "type": 1,
- "latestVersion": "0.0.3",
- "version": "0.0.1",
- "enabled": true,
- "uninstalled": true,
- "peertubeEngine": "2.2.0",
- "description": "string",
- "settings": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}List available plugins
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| currentPeerTubeEngine | string |
| pluginType | integer |
| search | string |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "name": "peertube-plugin-auth-ldap",
- "type": 1,
- "latestVersion": "0.0.3",
- "version": "0.0.1",
- "enabled": true,
- "uninstalled": true,
- "peertubeEngine": "2.2.0",
- "description": "string",
- "settings": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}Get a plugin
Authorizations:
OAuth2
path Parameters
| npmName required | string Example: peertube-plugin-auth-ldap name of the plugin/theme on npmjs.com or in its package.json |
Responses
Response samples
- 200
Content type
application/json
{- "name": "peertube-plugin-auth-ldap",
- "type": 1,
- "latestVersion": "0.0.3",
- "version": "0.0.1",
- "enabled": true,
- "uninstalled": true,
- "peertubeEngine": "2.2.0",
- "description": "string",
- "settings": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}Response samples
- 200
Content type
application/json
{- "totalUsers": 0,
- "totalDailyActiveUsers": 0,
- "totalWeeklyActiveUsers": 0,
- "totalMonthlyActiveUsers": 0,
- "totalModerators": 0,
- "totalAdmins": 0,
- "totalLocalVideos": 0,
- "totalLocalVideoViews": 0,
- "totalLocalVideoComments": 0,
- "totalLocalVideoFilesSize": 0,
- "totalVideos": 0,
- "totalVideoComments": 0,
- "totalLocalVideoChannels": 0,
- "totalLocalDailyActiveVideoChannels": 0,
- "totalLocalWeeklyActiveVideoChannels": 0,
- "totalLocalMonthlyActiveVideoChannels": 0,
- "totalLocalPlaylists": 0,
- "totalInstanceFollowers": 0,
- "totalInstanceFollowing": 0,
- "videosRedundancy": [
- {
- "strategy": "string",
- "totalSize": 0,
- "totalUsed": 0,
- "totalVideoFiles": 0,
- "totalVideos": 0
}
], - "totalActivityPubMessagesProcessed": 0,
- "totalActivityPubMessagesSuccesses": 0,
- "totalActivityPubMessagesErrors": 0,
- "activityPubMessagesProcessedPerSecond": 0,
- "totalActivityPubMessagesWaiting": 0,
- "averageRegistrationRequestResponseTimeMs": 0,
- "totalRegistrationRequestsProcessed": 0,
- "totalRegistrationRequests": 0,
- "averageAbuseResponseTimeMs": 0,
- "totalAbusesProcessed": 0,
- "totalAbuses": 0
}Create playback metrics
These metrics are exposed by OpenTelemetry metrics exporter if enabled.
Request Body schema: application/json
| downloadedBytesHTTP required | number How many bytes were downloaded with HTTP since the last metric creation |
| downloadedBytesP2P required | number How many bytes were downloaded with P2P since the last metric creation |
| errors required | number How many errors occurred since the last metric creation |
| p2pEnabled required | boolean |
| playerMode required | string Enum: "p2p-media-loader" "web-video" |
| resolutionChanges required | number How many resolution changes occurred since the last metric creation |
| uploadedBytesP2P required | number How many bytes were uploaded with P2P since the last metric creation |
required | id (integer) or UUIDv4 (string) or shortUUID (string) |
| bufferStalled | number How many times buffer has been stalled since the last metric creation |
| fps | number Current player video fps |
| p2pPeers | number P2P peers connected (doesn't include WebSeed peers) |
| resolution | number Current player video resolution |
Responses
Request samples
- Payload
Content type
application/json
{- "playerMode": "p2p-media-loader",
- "resolution": 0,
- "fps": 0,
- "p2pEnabled": true,
- "p2pPeers": 0,
- "resolutionChanges": 0,
- "bufferStalled": 0,
- "errors": 0,
- "downloadedBytesP2P": 0,
- "downloadedBytesHTTP": 0,
- "uploadedBytesP2P": 0,
- "videoId": 42
}Send client log
Request Body schema: application/json
| level required | any Enum: "error" "warn" |
| message required | string |
| url required | string URL of the current user page |
| meta | string Additional information regarding this log |
| stackTrace | string Stack trace of the error if there is one |
| userAgent | string User agent of the web browser that sends the message |
Responses
Request samples
- Payload
Content type
application/json
{- "message": "string",
- "url": "string",
- "level": "error",
- "stackTrace": "string",
- "userAgent": "string",
- "meta": "string"
}Jobs are long-running tasks enqueued and processed by the instance itself. No additional worker registration is currently available.
List instance jobs
Authorizations:
OAuth2
path Parameters
| state required | string Enum: "" "active" "completed" "failed" "waiting" "delayed" The state of the job ('' for for no filter) |
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| jobType | string Enum: "activitypub-follow" "activitypub-http-broadcast" "activitypub-http-fetcher" "activitypub-http-unicast" "email" "video-transcoding" "video-file-import" "video-import" "videos-views-stats" "activitypub-refresher" "video-redundancy" "video-live-ending" "video-channel-import" job type |
| sort | string Example: sort=-createdAt Sort column |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 42,
- "state": "active",
- "type": "activitypub-http-unicast",
- "data": { },
- "error": { },
- "createdAt": "2019-08-24T14:15:22Z",
- "finishedOn": "2019-08-24T14:15:22Z",
- "processedOn": "2019-08-24T14:15:22Z"
}
]
}List registration tokens
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Value: "createdAt" Sort registration tokens by criteria |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 0,
- "registrationToken": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z",
- "registeredRunnersCount": 0
}
]
}Request a new job
API used by PeerTube runners
Request Body schema: application/json
| runnerToken required | string |
| jobTypes | Array of strings Filter jobs depending on their types |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string",
- "jobTypes": [
- "string"
]
}Response samples
- 200
Content type
application/json
{- "availableJobs": [
- {
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "type": "vod-web-video-transcoding",
- "payload": {
- "input": {
- "videoFileUrl": "string"
}, - "output": {
- "resolution": 0,
- "fps": 0
}
}
}
]
}Accept job
API used by PeerTube runners
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Request Body schema: application/json
| runnerToken required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string"
}Response samples
- 200
Content type
application/json
{- "job": {
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "type": "vod-web-video-transcoding",
- "state": {
- "id": 1,
- "label": "Processing"
}, - "payload": {
- "input": {
- "videoFileUrl": "string"
}, - "output": {
- "resolution": 0,
- "fps": 0
}
}, - "failures": 0,
- "error": "string",
- "progress": 0,
- "priority": 0,
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "parent": {
- "type": "vod-web-video-transcoding",
- "state": {
- "id": 1,
- "label": "Processing"
}, - "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
}, - "runner": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "jobToken": "string"
}
}Abort job
API used by PeerTube runners
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Request Body schema: application/json
| jobToken required | string |
| reason required | string Why the runner aborts this job |
| runnerToken required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string",
- "jobToken": "string",
- "reason": "string"
}Update job
API used by PeerTube runners
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Request Body schema: application/json
| jobToken required | string |
| runnerToken required | string |
object | |
| progress | integer Update job progression percentage (optional) |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string",
- "jobToken": "string",
- "progress": 0,
- "payload": {
- "type": "add-chunk",
- "masterPlaylistFile": "string",
- "resolutionPlaylistFile": "string",
- "resolutionPlaylistFilename": "string",
- "videoChunkFile": "string",
- "videoChunkFilename": "string"
}
}Post job error
API used by PeerTube runners
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Request Body schema: application/json
| jobToken required | string |
| message required | string Why the runner failed to process this job |
| runnerToken required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string",
- "jobToken": "string",
- "message": "string"
}Post job success
API used by PeerTube runners
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Request Body schema: application/json
| jobToken required | string |
required | VOD web video transcoding (object) or VOD HLS transcoding (object) or VOD audio merge transcoding (object) or Live RTMP to HLS transcoding (object) |
| runnerToken required | string |
Responses
Request samples
- Payload
Content type
application/json
{- "runnerToken": "string",
- "jobToken": "string",
- "payload": {
- "videoFile": "string"
}
}Delete a job
The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed
Authorizations:
OAuth2
path Parameters
| jobUUID required | string <uuid> (UUIDv4) = 36 characters ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]... Example: 9c9de5e8-0a1e-484a-b099-e80766180a6d |
Responses
List jobs
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| search | string Plain text search, applied to various parts of the model depending on endpoint |
| sort | string Enum: "updatedAt" "createdAt" "priority" "state" "progress" Sort runner jobs by criteria |
| start | integer >= 0 Offset used to paginate results |
| stateOneOf | Array of integers (RunnerJobState) Items Enum: 1 2 3 4 5 6 7 8 |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
- "type": "vod-web-video-transcoding",
- "state": {
- "id": 1,
- "label": "Processing"
}, - "payload": {
- "input": {
- "videoFileUrl": "string"
}, - "output": {
- "resolution": 0,
- "fps": 0
}
}, - "failures": 0,
- "error": "string",
- "progress": 0,
- "priority": 0,
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "startedAt": "2019-08-24T14:15:22Z",
- "finishedAt": "2019-08-24T14:15:22Z",
- "parent": {
- "type": "vod-web-video-transcoding",
- "state": {
- "id": 1,
- "label": "Processing"
}, - "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
}, - "runner": {
- "id": 0,
- "name": "string",
- "description": "string"
}, - "privatePayload": { }
}
]
}Register a new runner
API used by PeerTube runners
Request Body schema: application/json
| name required | string |
| registrationToken required | string |
| description | string |
Responses
Request samples
- Payload
Content type
application/json
{- "registrationToken": "string",
- "name": "string",
- "description": "string"
}Response samples
- 200
Content type
application/json
{- "id": 0,
- "runnerToken": "string"
}List runners
Authorizations:
OAuth2
query Parameters
| count | integer [ 1 .. 100 ] Default: 15 Number of items to return |
| sort | string Value: "createdAt" Sort runners by criteria |
| start | integer >= 0 Offset used to paginate results |
Responses
Response samples
- 200
Content type
application/json
{- "total": 1,
- "data": [
- {
- "id": 0,
- "name": "string",
- "description": "string",
- "ip": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "lastContact": "2019-08-24T14:15:22Z"
}
]
}