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.

PeerTube publishes 54 APIs on the APIs.io network, including Abuses API, Account Blocklist API, Accounts API, and 51 more. Tagged areas include Video, Decentralized, Federation, Open Source, and ActivityPub.

The PeerTube catalog on APIs.io includes 1 JSON-LD context and 1 Spectral governance ruleset.

PeerTube’s developer surface includes authentication, documentation, GitHub presence, engineering blog, and 10 more developer resources.

41.0/100 thin ▬ flat Agent 44/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreeSelf serve⚡ Free to try
54 APIs
VideoDecentralizedFederationOpen SourceActivityPubSelf-HostedStreaming

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 41.0/100 · thin
Contract Quality 14.2 / 25
Developer Ergonomics 4.3 / 20
Commercial Clarity 7.9 / 20
Operational Transparency 0.7 / 13
Governance 7.0 / 12
Discoverability 6.9 / 10
Agent readiness — 44/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 8 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/peertube: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 54

Individual APIs this provider publishes, each with its own machine-readable definition.

PeerTube Abuses API

Abuses deal with reports of local or remote videos/comments/accounts alike.

PeerTube Account Blocklist API

The Account Blocklist API from PeerTube — 5 operation(s) for account blocklist.

PeerTube Accounts API

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...

PeerTube Automatic Tags API

Automatic tags set on objects (like comments or videos) by specific rules (external link, watched words, etc.)

PeerTube Channels Sync API

Operations dealing with synchronizing PeerTube user's channel with channels of other platforms

PeerTube Client Config API

Configuration of the web client.

PeerTube Config API

Each server exposes public information regarding supported videos and options.

PeerTube Contact API

Send a message to the instance administrators.

PeerTube Debug API

Administrative debug endpoints.

PeerTube Homepage API

Get and update the custom homepage

PeerTube Instance Follows API

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-s...

PeerTube Instance Redundancy API

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 s...

PeerTube Job API

Jobs are long-running tasks enqueued and processed by the instance itself. No additional worker registration is currently available.

PeerTube Live Videos API

The Live Videos API from PeerTube — 4 operation(s) for live videos.

PeerTube Logs API

Operations dealing with client, server and audit logs.

PeerTube My History API

Operations related to your watch history.

PeerTube My Notifications API

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-not...

PeerTube My Subscriptions API

Operations related to your subscriptions to video channels, their new videos, and how to keep up to date with their latest publications!

PeerTube My User API

Operations related to your own User, when logged-in.

PeerTube Ownership Change API

The Ownership Change API from PeerTube — 12 operation(s) for ownership change.

PeerTube Player Settings API

Operations dealing with video player settings for videos and channels.

PeerTube Plugins API

Managing plugins installed from a local path or from NPM, or search for new ones.

PeerTube Register API

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](#opera...

PeerTube Runner Jobs API

Manage runner jobs and runner-side job execution.

PeerTube Runner Registration Token API

Manage runner registration tokens.

PeerTube Runners API

Register, list and remove remote runners.

PeerTube Search API

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 in...

PeerTube Server Blocklist API

The Server Blocklist API from PeerTube — 5 operation(s) for server blocklist.

PeerTube Session API

Sessions deal with access tokens over time. Only __one session token can currently be used at a time__.

PeerTube Static Video Files API

The Static Video Files API from PeerTube — 4 operation(s) for static video files.

PeerTube Stats API

Statistics

PeerTube User Exports API

To create an archive of user data.

PeerTube User Imports API

To import an archive of user data.

PeerTube Users API

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 correspondi...

PeerTube Video API

Operations dealing with listing, uploading, fetching or modifying videos.

PeerTube Video Blocks API

Operations dealing with blocking videos (removing them from view and preventing interactions).

PeerTube Video Captions API

Operations dealing with listing, adding and removing closed captions of a video.

PeerTube Video Channels API

Operations dealing with the creation, modification and listing of videos within a channel.

PeerTube Video Chapters API

Operations dealing with managing chapters of a video.

PeerTube Video Comments API

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...

PeerTube Video Download API

Download video files

PeerTube Video Embed Privacy API

The Video Embed Privacy API from PeerTube — 2 operation(s) for video embed privacy.

PeerTube Video Feeds API

Server syndication feeds of videos

PeerTube Video Files API

Operations on video files

PeerTube Video Imports API

Operations dealing with listing, adding and removing video imports.

PeerTube Video Mirroring API

PeerTube instances can mirror videos from one another, and help distribute some videos. For importing videos as your own, refer to [video imports](#operation/importVideo).

PeerTube Video Passwords API

Operations on video passwords.

PeerTube Video Playlists API

Operations dealing with playlists of videos. Playlists are bound to users and/or channels.

PeerTube Video Rates API

Like/dislike a video.

PeerTube Video Stats API

Video statistics

PeerTube Video Transcoding API

Video transcoding related operations

PeerTube Video Upload API

Operations dealing with adding video or audio. PeerTube supports two upload modes, and three import modes. ### Upload - [_legacy_](#operation/uploadLegacy), where the video file...

PeerTube Videos API

The Videos API from PeerTube — 4 operation(s) for videos.

PeerTube Watched Words API

Manage list of watched words to detect patterns on objects (like comments of videos)

Scroll for all 54

Pricing Plans 1

Published pricing tiers and plan structures.

Plans

1 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Peertube Context

0 classes · 0 properties

JSON-LD

Spectral Rules 1

Spectral governance rulesets for linting and validating these APIs.

PeerTube API Rules

5 rules · 3 warnings 2 info

SPECTRAL

JSON Schema 171

Standalone JSON Schema definitions for this provider's data models.

Abuse

8 properties

JSON SCHEMA

AbuseMessage

5 properties

JSON SCHEMA

AbusePredefinedReasons

0 properties

JSON SCHEMA

AbuseStateConstant

2 properties

JSON SCHEMA

AbuseStateSet

0 properties

JSON SCHEMA

Account

0 properties

JSON SCHEMA

AccountBlock

3 properties

JSON SCHEMA

AccountSummary

6 properties

JSON SCHEMA

Actor

10 properties

JSON SCHEMA

ActorImage

6 properties

JSON SCHEMA

ActorInfo

5 properties

JSON SCHEMA

AddUser

8 properties

JSON SCHEMA

AddUserResponse

1 properties

JSON SCHEMA

AddVideoPasswords

0 properties

JSON SCHEMA

AutomaticTagAvailable

1 properties

JSON SCHEMA

BlockStatus

2 properties

JSON SCHEMA

ChangeOwnership

7 properties

JSON SCHEMA

ChangeOwnershipState

0 properties

JSON SCHEMA

ChannelActivityListResponse

2 properties

JSON SCHEMA

CommentAutoTagPolicies

1 properties

JSON SCHEMA

CommentThreadPostResponse

1 properties

JSON SCHEMA

CommentThreadResponse

3 properties

JSON SCHEMA

CustomHomepage

1 properties

JSON SCHEMA

FileRedundancyInformation

7 properties

JSON SCHEMA

FileStorage

0 properties

JSON SCHEMA

Follow

7 properties

JSON SCHEMA

GetMeVideoRating

2 properties

JSON SCHEMA

ImportVideosInChannelCreate

2 properties

JSON SCHEMA

Job

8 properties

JSON SCHEMA

LiveSchedule

1 properties

JSON SCHEMA

LiveVideoLatencyMode

0 properties

JSON SCHEMA

LiveVideoReplaySettings

1 properties

JSON SCHEMA

LiveVideoResponse

8 properties

JSON SCHEMA

LiveVideoSessionResponse

5 properties

JSON SCHEMA

LiveVideoUpdate

5 properties

JSON SCHEMA

MRSSGroupContent

7 properties

JSON SCHEMA

MRSSPeerLink

2 properties

JSON SCHEMA

NSFWFlag

0 properties

JSON SCHEMA

NSFWPolicy

0 properties

JSON SCHEMA

NewFeatureInfoType

0 properties

JSON SCHEMA

Notification

12 properties

JSON SCHEMA

NotificationListResponse

2 properties

JSON SCHEMA

NotificationSettingValue

0 properties

JSON SCHEMA

NotificationType

0 properties

JSON SCHEMA

OAuthClient

2 properties

JSON SCHEMA

OAuthToken-password

0 properties

JSON SCHEMA

OAuthToken-refresh_token

0 properties

JSON SCHEMA

PlaybackMetricCreate

12 properties

JSON SCHEMA

PlayerChannelSettings

1 properties

JSON SCHEMA

PlayerChannelSettingsUpdate

1 properties

JSON SCHEMA

PlayerTheme

0 properties

JSON SCHEMA

PlayerThemeChannelSetting

0 properties

JSON SCHEMA

PlayerThemeVideoSetting

0 properties

JSON SCHEMA

PlayerVideoSettings

1 properties

JSON SCHEMA

PlayerVideoSettingsUpdate

1 properties

JSON SCHEMA

PlaylistElement

4 properties

JSON SCHEMA

Plugin

12 properties

JSON SCHEMA

PluginResponse

2 properties

JSON SCHEMA

PredefinedAbuseReasons

0 properties

JSON SCHEMA

RegisterUser

5 properties

JSON SCHEMA

RequestTwoFactorResponse

1 properties

JSON SCHEMA

Runner

7 properties

JSON SCHEMA

RunnerJob

14 properties

JSON SCHEMA

RunnerJobAdmin

0 properties

JSON SCHEMA

RunnerJobPayload

0 properties

JSON SCHEMA

RunnerJobState

0 properties

JSON SCHEMA

RunnerJobStateConstant

2 properties

JSON SCHEMA

RunnerJobType

0 properties

JSON SCHEMA

RunnerRegistrationToken

5 properties

JSON SCHEMA

SendClientLog

6 properties

JSON SCHEMA

ServerBlock

3 properties

JSON SCHEMA

ServerConfig

24 properties

JSON SCHEMA

ServerConfigAbout

1 properties

JSON SCHEMA

ServerConfigCustom

14 properties

JSON SCHEMA

ServerError

4 properties

JSON SCHEMA

ServerStats

32 properties

JSON SCHEMA

Storyboard

7 properties

JSON SCHEMA

Thumbnail

4 properties

JSON SCHEMA

TokenSession

9 properties

JSON SCHEMA

UUIDv4

0 properties

JSON SCHEMA

UpdateMe

20 properties

JSON SCHEMA

UpdateUser

8 properties

JSON SCHEMA

User

35 properties

JSON SCHEMA

UserAdminFlags

0 properties

JSON SCHEMA

UserExportState

0 properties

JSON SCHEMA

UserImportResumable

1 properties

JSON SCHEMA

UserImportState

0 properties

JSON SCHEMA

UserNotificationSettings

18 properties

JSON SCHEMA

UserRegistration

13 properties

JSON SCHEMA

UserRegistrationAcceptOrReject

2 properties

JSON SCHEMA

UserRegistrationRequest

0 properties

JSON SCHEMA

UserRegistrationState

0 properties

JSON SCHEMA

UserRole

0 properties

JSON SCHEMA

UserViewingVideo

6 properties

JSON SCHEMA

UserWithStats

0 properties

JSON SCHEMA

Video

37 properties

JSON SCHEMA

VideoBlacklist

12 properties

JSON SCHEMA

VideoCaption

6 properties

JSON SCHEMA

VideoCategorySet

0 properties

JSON SCHEMA

VideoChannel

0 properties

JSON SCHEMA

VideoChannelActivityAction

0 properties

JSON SCHEMA

VideoChannelActivityTarget

0 properties

JSON SCHEMA

VideoChannelCollaborator

5 properties

JSON SCHEMA

VideoChannelCollaboratorState

0 properties

JSON SCHEMA

VideoChannelCreate

0 properties

JSON SCHEMA

VideoChannelEdit

3 properties

JSON SCHEMA

VideoChannelList

2 properties

JSON SCHEMA

VideoChannelSummary

6 properties

JSON SCHEMA

VideoChannelSync

6 properties

JSON SCHEMA

VideoChannelSyncCreate

2 properties

JSON SCHEMA

VideoChannelSyncList

2 properties

JSON SCHEMA

VideoChannelUpdate

0 properties

JSON SCHEMA

VideoChapters

1 properties

JSON SCHEMA

VideoComment

14 properties

JSON SCHEMA

VideoCommentForOwnerOrAdmin

11 properties

JSON SCHEMA

VideoCommentThreadTree

2 properties

JSON SCHEMA

VideoCommentsForXML

0 properties

JSON SCHEMA

VideoCommentsPolicyConstant

2 properties

JSON SCHEMA

VideoCommentsPolicySet

0 properties

JSON SCHEMA

VideoConstantNumber-Category

2 properties

JSON SCHEMA

VideoConstantNumber-Licence

2 properties

JSON SCHEMA

VideoConstantString-Language

2 properties

JSON SCHEMA

VideoCreateImport

0 properties

JSON SCHEMA

VideoDetails

0 properties

JSON SCHEMA

VideoEmbedPrivacy

0 properties

JSON SCHEMA

VideoFile

16 properties

JSON SCHEMA

VideoImport

10 properties

JSON SCHEMA

VideoImportStateConstant

2 properties

JSON SCHEMA

VideoImportsList

2 properties

JSON SCHEMA

VideoInfo

4 properties

JSON SCHEMA

VideoLanguageSet

0 properties

JSON SCHEMA

VideoLicenceSet

0 properties

JSON SCHEMA

VideoListResponse

2 properties

JSON SCHEMA

VideoPassword

3 properties

JSON SCHEMA

VideoPasswordList

2 properties

JSON SCHEMA

VideoPlaylist

16 properties

JSON SCHEMA

VideoPlaylistPrivacyConstant

2 properties

JSON SCHEMA

VideoPlaylistPrivacySet

0 properties

JSON SCHEMA

VideoPlaylistTypeConstant

2 properties

JSON SCHEMA

VideoPlaylistTypeSet

0 properties

JSON SCHEMA

VideoPrivacyConstant

2 properties

JSON SCHEMA

VideoPrivacySet

0 properties

JSON SCHEMA

VideoRating

2 properties

JSON SCHEMA

VideoRedundancy

5 properties

JSON SCHEMA

VideoReplaceSourceRequestResumable

1 properties

JSON SCHEMA

VideoResolutionConstant

2 properties

JSON SCHEMA

VideoResolutionSet

0 properties

JSON SCHEMA

VideoScheduledUpdate

2 properties

JSON SCHEMA

VideoSource

8 properties

JSON SCHEMA

VideoStateConstant

2 properties

JSON SCHEMA

VideoStatsOverall

7 properties

JSON SCHEMA

VideoStatsRetention

1 properties

JSON SCHEMA

VideoStatsTimeserie

1 properties

JSON SCHEMA

VideoStatsUserAgent

3 properties

JSON SCHEMA

VideoStatsUserAgentDevice

0 properties

JSON SCHEMA

VideoStreamingPlaylists-HLS

4 properties

JSON SCHEMA

VideoStreamingPlaylists

0 properties

JSON SCHEMA

VideoStudioCreateTask

0 properties

JSON SCHEMA

VideoSummary

9 properties

JSON SCHEMA

VideoTokenResponse

1 properties

JSON SCHEMA

VideoUploadRequestCommon

21 properties

JSON SCHEMA

VideoUploadRequestLegacy

0 properties

JSON SCHEMA

VideoUploadRequestResumable

0 properties

JSON SCHEMA

VideoUploadResponse

1 properties

JSON SCHEMA

VideosForXML

0 properties

JSON SCHEMA

WatchedWordsLists

5 properties

JSON SCHEMA

id

0 properties

JSON SCHEMA

password

0 properties

JSON SCHEMA

shortUUID

0 properties

JSON SCHEMA

username

0 properties

JSON SCHEMA

usernameChannel

0 properties

JSON SCHEMA

Scroll for all 171

Examples 290

Example request and response payloads for these APIs.

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

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

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_Runners

9 fields

EXAMPLE

Get_Api_V1_Runners_Jobs

9 fields

EXAMPLE

Importvideo

9 fields

EXAMPLE

Listregistrations

9 fields

EXAMPLE

Listuserexports

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

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

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

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

Scroll for all 290

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Peertube Authentication

oauth2 · 1 scheme

SECURITY

Peertube Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Peertube Scopes

3 scopes · password

3 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Peertube Agentic Access

580 operations · 350 acting · 8 human-in-the-loop

580 operations · 350 acting

AGENTIC

Resources

Documentation 1

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Build 1

SDKs, sample code, and the tooling you integrate with

Access & Security 3

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Commercial 2

Pricing, plans, and the legal terms of use

Company 2

The organization behind the API

Other 3

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml 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.
accessModel:
  pricing: free
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Free · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/peertube.png
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:
- aid: peertube:peertube-abuses-api
  name: PeerTube Abuses API
  description: Abuses deal with reports of local or remote videos/comments/accounts alike.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Abuses
  properties:
  - type: OpenAPI
    url: openapi/peertube-abuses-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-account-blocklist-api
  name: PeerTube Account Blocklist API
  description: The Account Blocklist API from PeerTube — 5 operation(s) for account blocklist.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Account Blocklist
  properties:
  - type: OpenAPI
    url: openapi/peertube-account-blocklist-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-accounts-api
  name: PeerTube Accounts API
  description: '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.'
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Accounts
  properties:
  - type: OpenAPI
    url: openapi/peertube-accounts-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-automatic-tags-api
  name: PeerTube Automatic Tags API
  description: Automatic tags set on objects (like comments or videos) by specific rules (external link, watched words, etc.)
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Automatic Tags
  properties:
  - type: OpenAPI
    url: openapi/peertube-automatic-tags-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-channels-sync-api
  name: PeerTube Channels Sync API
  description: Operations dealing with synchronizing PeerTube user's channel with channels of other platforms
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Channels Sync
  properties:
  - type: OpenAPI
    url: openapi/peertube-channels-sync-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-client-config-api
  name: PeerTube Client Config API
  description: Configuration of the web client.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Client Config
  properties:
  - type: OpenAPI
    url: openapi/peertube-client-config-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-config-api
  name: PeerTube Config API
  description: Each server exposes public information regarding supported videos and options.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Config
  properties:
  - type: OpenAPI
    url: openapi/peertube-config-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-contact-api
  name: PeerTube Contact API
  description: Send a message to the instance administrators.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Contact
  properties:
  - type: OpenAPI
    url: openapi/peertube-contact-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-debug-api
  name: PeerTube Debug API
  description: Administrative debug endpoints.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Debug
  properties:
  - type: OpenAPI
    url: openapi/peertube-debug-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-homepage-api
  name: PeerTube Homepage API
  description: Get and update the custom homepage
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Homepage
  properties:
  - type: OpenAPI
    url: openapi/peertube-homepage-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-instance-follows-api
  name: PeerTube Instance Follows API
  description: 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.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Instance Follows
  properties:
  - type: OpenAPI
    url: openapi/peertube-instance-follows-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-instance-redundancy-api
  name: PeerTube Instance Redundancy API
  description: Redundancy is part of the inter-server solidarity that PeerTube fosters. Manage the list of instances you wish
    to help by seeding their videos according to the policy of video selection of your choice. Note that you have a similar
    functionality to mirror individual videos, see [video mirroring](#tag/Video-Mirroring).
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Instance Redundancy
  properties:
  - type: OpenAPI
    url: openapi/peertube-instance-redundancy-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-job-api
  name: PeerTube Job API
  description: Jobs are long-running tasks enqueued and processed by the instance itself. No additional worker registration
    is currently available.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Job
  properties:
  - type: OpenAPI
    url: openapi/peertube-job-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-live-videos-api
  name: PeerTube Live Videos API
  description: The Live Videos API from PeerTube — 4 operation(s) for live videos.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Live Videos
  properties:
  - type: OpenAPI
    url: openapi/peertube-live-videos-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-logs-api
  name: PeerTube Logs API
  description: Operations dealing with client, server and audit logs.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Logs
  properties:
  - type: OpenAPI
    url: openapi/peertube-logs-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-my-history-api
  name: PeerTube My History API
  description: Operations related to your watch history.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - My History
  properties:
  - type: OpenAPI
    url: openapi/peertube-my-history-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-my-notifications-api
  name: PeerTube My Notifications API
  description: Notifications following new videos, follows or reports. They allow you to keep track of the interactions and
    overall important information that concerns you. You MAY set per-notification type delivery preference, to receive the
    info either by mail, by in-browser notification or both.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - My Notifications
  properties:
  - type: OpenAPI
    url: openapi/peertube-my-notifications-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-my-subscriptions-api
  name: PeerTube My Subscriptions API
  description: Operations related to your subscriptions to video channels, their new videos, and how to keep up to date with
    their latest publications!
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - My Subscriptions
  properties:
  - type: OpenAPI
    url: openapi/peertube-my-subscriptions-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-my-user-api
  name: PeerTube My User API
  description: Operations related to your own User, when logged-in.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - My User
  properties:
  - type: OpenAPI
    url: openapi/peertube-my-user-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-ownership-change-api
  name: PeerTube Ownership Change API
  description: The Ownership Change API from PeerTube — 12 operation(s) for ownership change.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Ownership Change
  properties:
  - type: OpenAPI
    url: openapi/peertube-ownership-change-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-player-settings-api
  name: PeerTube Player Settings API
  description: Operations dealing with video player settings for videos and channels.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Player Settings
  properties:
  - type: OpenAPI
    url: openapi/peertube-player-settings-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-plugins-api
  name: PeerTube Plugins API
  description: Managing plugins installed from a local path or from NPM, or search for new ones.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Plugins
  properties:
  - type: OpenAPI
    url: openapi/peertube-plugins-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-register-api
  name: PeerTube Register API
  description: '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](#operation/addUser) instead.'
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Register
  properties:
  - type: OpenAPI
    url: openapi/peertube-register-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-runner-jobs-api
  name: PeerTube Runner Jobs API
  description: Manage runner jobs and runner-side job execution.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Runner Jobs
  properties:
  - type: OpenAPI
    url: openapi/peertube-runner-jobs-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-runner-registration-token-api
  name: PeerTube Runner Registration Token API
  description: Manage runner registration tokens.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Runner Registration Token
  properties:
  - type: OpenAPI
    url: openapi/peertube-runner-registration-token-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-runners-api
  name: PeerTube Runners API
  description: Register, list and remove remote runners.
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Runners
  properties:
  - type: OpenAPI
    url: openapi/peertube-runners-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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
- aid: peertube:peertube-search-api
  name: PeerTube Search API
  description: '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 that may not be federated by the instance.'
  humanURL: https://docs.joinpeertube.org/api/rest-getting-started
  baseURL: https://{instance}/api/v1
  tags:
  - Search
  properties:
  - type: OpenAPI
    url: openapi/peertube-search-api-openapi.yml
  - type: Documentation
    url: https://docs.joinpeertube.org/api/rest-getting-started
  - 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.or

# --- truncated at 32 KB (64 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/peertube/refs/heads/main/apis.yml