PeerTube website screenshot

PeerTube

PeerTube is a free, decentralized, and federated video hosting platform developed by Framasoft as an open-source alternative to centralized video services like YouTube. It enables anyone to self-host a video platform that federates with other instances via ActivityPub, forming a global network of over 1,600 platforms hosting more than one million videos. The REST API supports video uploading and management, channel and playlist operations, live streaming, search and discovery across federated nodes, content moderation, plugin management, and distributed transcoding via remote runner jobs.

1 APIs 0 Features
VideoDecentralizedFederationOpen SourceActivityPubSelf-HostedStreaming

APIs

PeerTube REST API

The PeerTube REST API provides comprehensive access to all platform functionality including video upload and management, user accounts, channels, playlists, live streaming, mode...

Pricing Plans

Plans

1 plans

PLANS

Rate Limits

Rate Limits

0 limits

RATE LIMITS

FinOps

Finops

FINOPS

Semantic Vocabularies

Peertube Context

0 classes · 0 properties

JSON-LD

Example Payloads

Acceptregistration

9 fields

EXAMPLE

Addlive

9 fields

EXAMPLE

Addplaylist

9 fields

EXAMPLE

Addplugin

9 fields

EXAMPLE

Adduser

9 fields

EXAMPLE

Addvideoblock

9 fields

EXAMPLE

Addvideocaption

9 fields

EXAMPLE

Addvideochannel

9 fields

EXAMPLE

Addvideochannelsync

9 fields

EXAMPLE

Addvideopassword

9 fields

EXAMPLE

Addvideoplaylistvideo

9 fields

EXAMPLE

Addview

9 fields

EXAMPLE

Blockaccount

9 fields

EXAMPLE

Blockserver

9 fields

EXAMPLE

Confirmtwofactorrequest

9 fields

EXAMPLE

Contactadministrator

9 fields

EXAMPLE

Createvideotranscoding

9 fields

EXAMPLE

Delcustomconfig

9 fields

EXAMPLE

Delmirroredvideo

9 fields

EXAMPLE

Deluser

9 fields

EXAMPLE

Delvideo

9 fields

EXAMPLE

Delvideoblock

9 fields

EXAMPLE

Delvideocaption

9 fields

EXAMPLE

Delvideochannel

9 fields

EXAMPLE

Delvideochannelsync

9 fields

EXAMPLE

Delvideohls

9 fields

EXAMPLE

Delvideoplaylistvideo

9 fields

EXAMPLE

Delvideowebvideos

9 fields

EXAMPLE

Deleteme

9 fields

EXAMPLE

Deleteregistration

9 fields

EXAMPLE

Deleteuserexport

9 fields

EXAMPLE

Deletevideosourcefile

9 fields

EXAMPLE

Delete_Api_V1_Abuses_Abuseid

9 fields

EXAMPLE

Disabletwofactor

9 fields

EXAMPLE

Generatevideocaption

9 fields

EXAMPLE

Getabout

9 fields

EXAMPLE

Getabuses

9 fields

EXAMPLE

Getaccount

9 fields

EXAMPLE

Getaccountfollowers

9 fields

EXAMPLE

Getaccountvideos

9 fields

EXAMPLE

Getaccounts

9 fields

EXAMPLE

Getavailableplugins

9 fields

EXAMPLE

Getcategories

9 fields

EXAMPLE

Getchannelplayersettings

9 fields

EXAMPLE

Getconfig

9 fields

EXAMPLE

Getcustomconfig

9 fields

EXAMPLE

Getdebug

9 fields

EXAMPLE

Getinstanceauditlogs

9 fields

EXAMPLE

Getinstancelogs

9 fields

EXAMPLE

Getinstancestats

9 fields

EXAMPLE

Getjobs

9 fields

EXAMPLE

Getlanguages

9 fields

EXAMPLE

Getlatestuserimport

9 fields

EXAMPLE

Getlicences

9 fields

EXAMPLE

Getliveid

9 fields

EXAMPLE

Getmirroredvideos

9 fields

EXAMPLE

Getmyabuses

9 fields

EXAMPLE

Getmyblockedaccounts

9 fields

EXAMPLE

Getmyblockedservers

9 fields

EXAMPLE

Getoauthclient

9 fields

EXAMPLE

Getoauthtoken

9 fields

EXAMPLE

Getplaylistprivacypolicies

9 fields

EXAMPLE

Getplaylists

9 fields

EXAMPLE

Getplugin

9 fields

EXAMPLE

Getplugins

9 fields

EXAMPLE

Getsyndicatedcomments

9 fields

EXAMPLE

Getsyndicatedvideos

9 fields

EXAMPLE

Getuser

9 fields

EXAMPLE

Getuserinfo

9 fields

EXAMPLE

Getusers

9 fields

EXAMPLE

Getvideo

9 fields

EXAMPLE

Getvideoblocks

9 fields

EXAMPLE

Getvideocaptions

9 fields

EXAMPLE

Getvideochannel

9 fields

EXAMPLE

Getvideochannelfollowers

9 fields

EXAMPLE

Getvideochannelvideos

9 fields

EXAMPLE

Getvideochannels

9 fields

EXAMPLE

Getvideochapters

9 fields

EXAMPLE

Getvideoembedprivacy

9 fields

EXAMPLE

Getvideoplayersettings

9 fields

EXAMPLE

Getvideoplaylistvideos

9 fields

EXAMPLE

Getvideoprivacypolicies

9 fields

EXAMPLE

Getvideosource

9 fields

EXAMPLE

Getvideos

9 fields

EXAMPLE

Getvideospodcastfeed

9 fields

EXAMPLE

Get_Api_V1_Blocklist_Status

9 fields

EXAMPLE

Get_Api_V1_Runners

9 fields

EXAMPLE

Get_Api_V1_Runners_Jobs

9 fields

EXAMPLE

Get_Api_V1_Server_Followers

9 fields

EXAMPLE

Get_Api_V1_Server_Following

9 fields

EXAMPLE

Get_Api_V1_Users_Me_Videos

9 fields

EXAMPLE

Get_Api_V1_Videos_Comments

9 fields

EXAMPLE

Get_Api_V1_Videos_Ownership

9 fields

EXAMPLE

Importvideo

9 fields

EXAMPLE

Isvideoembedondomainallowed

9 fields

EXAMPLE

Listregistrations

9 fields

EXAMPLE

Listuserexports

9 fields

EXAMPLE

Listvideochannelactivities

9 fields

EXAMPLE

Listvideopasswords

9 fields

EXAMPLE

Listvideostoryboards

9 fields

EXAMPLE

Post_Api_V1_Abuses

9 fields

EXAMPLE

Post_Api_V1_Jobs_Pause

9 fields

EXAMPLE

Post_Api_V1_Jobs_Resume

9 fields

EXAMPLE

Post_Api_V1_Metrics_Playback

9 fields

EXAMPLE

Post_Api_V1_Runners_Register

9 fields

EXAMPLE

Post_Api_V1_Server_Following

9 fields

EXAMPLE

Post_Api_V1_Users_Id_Block

9 fields

EXAMPLE

Post_Api_V1_Users_Id_Unblock

9 fields

EXAMPLE

Putcustomconfig

9 fields

EXAMPLE

Putmirroredvideo

9 fields

EXAMPLE

Putuser

9 fields

EXAMPLE

Putuserinfo

9 fields

EXAMPLE

Putvideo

9 fields

EXAMPLE

Putvideochannel

9 fields

EXAMPLE

Putvideoplaylistvideo

9 fields

EXAMPLE

Put_Api_V1_Abuses_Abuseid

9 fields

EXAMPLE

Put_Api_V1_Videos_Id_Rate

9 fields

EXAMPLE

Registeruser

9 fields

EXAMPLE

Rejectregistration

9 fields

EXAMPLE

Removevideopassword

9 fields

EXAMPLE

Reordervideoplaylist

9 fields

EXAMPLE

Replacevideochapters

9 fields

EXAMPLE

Replacevideosourceresumable

9 fields

EXAMPLE

Requestregistration

9 fields

EXAMPLE

Requesttwofactor

9 fields

EXAMPLE

Requestuserexport

9 fields

EXAMPLE

Requestvideotoken

9 fields

EXAMPLE

Resendemailtoverifyuser

9 fields

EXAMPLE

Revokeoauthtoken

9 fields

EXAMPLE

Rundebugcommand

9 fields

EXAMPLE

Searchchannels

9 fields

EXAMPLE

Searchplaylists

9 fields

EXAMPLE

Searchvideos

9 fields

EXAMPLE

Sendclientlog

9 fields

EXAMPLE

Triggervideochannelsync

9 fields

EXAMPLE

Unblockaccount

9 fields

EXAMPLE

Unblockserver

9 fields

EXAMPLE

Uninstallplugin

9 fields

EXAMPLE

Updatechannelplayersettings

9 fields

EXAMPLE

Updateclientlanguage

9 fields

EXAMPLE

Updateliveid

9 fields

EXAMPLE

Updateplugin

9 fields

EXAMPLE

Updatevideoembedprivacy

9 fields

EXAMPLE

Updatevideopasswordlist

9 fields

EXAMPLE

Updatevideoplayersettings

9 fields

EXAMPLE

Uploadlegacy

9 fields

EXAMPLE

Uploadresumable

9 fields

EXAMPLE

Uploadresumablecancel

9 fields

EXAMPLE

Uploadresumableinit

9 fields

EXAMPLE

Userimportresumable

9 fields

EXAMPLE

Userimportresumablecancel

9 fields

EXAMPLE

Userimportresumableinit

9 fields

EXAMPLE

Verifyregistrationemail

9 fields

EXAMPLE

Verifyuser

9 fields

EXAMPLE

Resources

🔗
Website
Website
🔗
Documentation
Documentation
👥
GitHub
GitHub
📰
Blog
Blog
🔗
Forums
Forums
🔗
MobileApp
MobileApp
🔗
ActivityPub
ActivityPub
📜
PrivacyPolicy
PrivacyPolicy
🔗
License
License
🔗
OpenSource
OpenSource

Sources

Raw ↑
name: PeerTube
description: PeerTube is a free, decentralized, and federated video hosting platform developed by Framasoft as an open-source
  alternative to centralized video services like YouTube. It enables anyone to self-host a video platform that federates with
  other instances via ActivityPub, forming a global network of over 1,600 platforms hosting more than one million videos.
  The REST API supports video uploading and management, channel and playlist operations, live streaming, search and discovery
  across federated nodes, content moderation, plugin management, and distributed transcoding via remote runner jobs.
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
tags:
- Video
- Decentralized
- Federation
- Open Source
- ActivityPub
- Self-Hosted
- Streaming
url: https://raw.githubusercontent.com/api-evangelist/peertube/refs/heads/main/apis.yml
specificationVersion: '0.19'
modified: '2026-06-13'
apis:
- name: PeerTube REST API
  description: The PeerTube REST API provides comprehensive access to all platform functionality including video upload and
    management, user accounts, channels, playlists, live streaming, moderation, instance configuration, federation, and distributed
    transcoding. The API is defined by an OpenAPI 3.0 specification and uses OAuth 2.0 for authentication with three role
    levels (Administrator, Moderator, User). Rate limiting is enforced per endpoint class with headers exposing limit state.
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Video
  - Channels
  - Playlists
  - Live Streaming
  - Federation
  - Moderation
  - Accounts
  - Search
  properties:
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - type: OpenAPI
    url: https://raw.githubusercontent.com/Chocobozzz/PeerTube/develop/support/doc/api/openapi.yaml
  - type: APIReference
    url: https://docs.joinpeertube.org/api-rest-reference.html
  - type: Plugins
    url: https://docs.joinpeertube.org/api/plugins
  - type: EmbedPlayer
    url: https://docs.joinpeertube.org/api/embed-player
  - type: ActivityPub
    url: https://docs.joinpeertube.org/api/activitypub
  - type: Plans
    url: https://raw.githubusercontent.com/api-evangelist/peertube/refs/heads/main/plans/plans.yml
  - type: RateLimits
    url: https://raw.githubusercontent.com/api-evangelist/peertube/refs/heads/main/rate-limits/rate-limits.yml
  - type: FinOps
    url: https://raw.githubusercontent.com/api-evangelist/peertube/refs/heads/main/finops/finops.yml
  contact:
  - FN: PeerTube Documentation
    url: https://docs.joinpeertube.org/
  - FN: PeerTube GitHub
    url: https://github.com/Chocobozzz/PeerTube
  meta:
  - key: authentication
    value: OAuth 2.0 (Password Grant) + Bearer Token
  - key: version
    value: v1
  - key: openapi-version
    value: 3.0.3
common:
- type: Website
  url: https://joinpeertube.org/
- type: Documentation
  url: https://docs.joinpeertube.org/
- type: GitHub
  url: https://github.com/Chocobozzz/PeerTube
- type: Blog
  url: https://framablog.org/
- type: Forums
  url: https://framacolibri.org/c/peertube
- type: MobileApp
  url: https://joinpeertube.org/apps
- type: ActivityPub
  url: https://docs.joinpeertube.org/api/activitypub
- type: PrivacyPolicy
  url: https://joinpeertube.org/privacy
- type: License
  url: https://github.com/Chocobozzz/PeerTube/blob/develop/LICENSE
- type: OpenSource
  url: https://github.com/Chocobozzz/PeerTube
maintainers:
- FN: API Evangelist
  url: https://apievangelist.com
  email: info@apievangelist.com