Cpy

PeerTube

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. The spec API…

Social#openapi#social

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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. The spec API is fully compatible with
openapi-generator
which generates a client SDK in the language of your choice - we generate some client SDKs automatically:

See the REST API quick start for a few
examples of using the PeerTube API.

Authentication

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

Roles

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.

Errors

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 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. .location can be either 'params', 'body', 'header', 'query' or 'cookies', and
invalid-params. .value reports the value that didn't pass validation whose invalid-params. .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 by detail
  • code: superseded by type (which is now an URI)

Rate limits

We are rate-limiting all endpoints of PeerTube's API. Custom values can be set by administrators:

Endpoint (prefix: /api/v1)CallsTime frame
/*5010 seconds
POST /users/token155 minutes
POST /users/register2 *5 minutes
POST /users/ask-send-verify-email35 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:

HeaderDescription
X-RateLimit-LimitNumber of max requests allowed in the current time period
X-RateLimit-RemainingNumber of remaining requests in the current time period
X-RateLimit-ResetTimestamp of end of current time period as UNIX timestamp
Retry-AfterSeconds to delay…

Endpoints 186

Register

  • POSTRegister a user/api/v1/users/registerSignup has to be enabled and signup approval is not required
  • GETList registrations/api/v1/users/registrations?start=0&count=15&search=string&sort=-createdAt
  • POSTResend verification link to registration email/api/v1/users/registrations/ask-send-verify-email
  • POSTRequest registration/api/v1/users/registrations/requestSignup has to be enabled and require approval on the instance
  • DELETEDelete registration/api/v1/users/registrations/:registrationIdDelete the registration entry. It will not remove the user associated with this registration (if any)
  • POSTAccept registration/api/v1/users/registrations/:registrationId/accept
  • POSTReject registration/api/v1/users/registrations/:registrationId/reject
  • POSTVerify a registration email/api/v1/users/registrations/:registrationId/verify-emailFollowing a user registration request, the user will receive an email asking to click a link containing a secret.

Session

  • GETLogin prerequisite/api/v1/oauth-clients/localYou need to retrieve a client id and secret before logging in.
  • POSTLogout/api/v1/users/revoke-tokenRevokes your access token and its associated refresh token, destroying your current session.
  • POSTLogin/api/v1/users/tokenWith your client id and secret, you can retrieve an access and refresh tokens.

Accounts

  • GETList accounts/api/v1/accounts?start=0&count=15&sort=-createdAt
  • GETGet an account/api/v1/accounts/:name
  • GETList followers of an account/api/v1/accounts/:name/followers?start=0&count=15&sort=createdAt&search=string
  • GETList ratings of an account/api/v1/accounts/:name/ratings?start=0&count=15&sort=-createdAt&rating=like
  • GETList videos of an account/api/v1/accounts/:name/videos?categoryOneOf=15&isLive=true&tagsOneOf=string&tagsAllOf=string&licenceOneOf=2&languageOneOf=en&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true&skipCount=false&start=0&count=15&sort=name

Users

  • GETList users/api/v1/users?search=string&blocked=true&start=0&count=15&sort=-id
  • POSTCreate a user/api/v1/users
  • POSTResend user verification link/api/v1/users/ask-send-verify-email
  • GETGet a user/api/v1/users/:id?withStats=true
  • PUTUpdate a user/api/v1/users/:id
  • DELETEDelete a user/api/v1/users/:id
  • POSTConfirm two factor auth/api/v1/users/:id/two-factor/confirm-requestConfirm a two factor authentication request
  • POSTDisable two factor auth/api/v1/users/:id/two-factor/disableDisable two factor authentication of a user
  • POSTRequest two factor auth/api/v1/users/:id/two-factor/requestRequest two factor authentication for a user
  • POSTVerify a user/api/v1/users/:id/verify-emailFollowing 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…

My User

  • GETGet my user information/api/v1/users/me
  • PUTUpdate my user information/api/v1/users/me
  • DELETEDelete my avatar/api/v1/users/me/avatar
  • POSTUpdate my user avatar/api/v1/users/me/avatar/pick
  • GETGet my user used quota/api/v1/users/me/video-quota-used
  • GETGet videos of my user/api/v1/users/me/videos?start=0&count=15&sort=-createdAt
  • GETGet rate of my user for a video/api/v1/users/me/videos/:videoId/rating

My Subscriptions

  • GETGet my user subscriptions/api/v1/users/me/subscriptions?start=0&count=15&sort=-createdAt
  • POSTAdd subscription to my user/api/v1/users/me/subscriptions
  • GETGet if subscriptions exist for my user/api/v1/users/me/subscriptions/exist?uris=https://example.com
  • GETList videos of subscriptions of my user/api/v1/users/me/subscriptions/videos?categoryOneOf=15&isLive=true&tagsOneOf=string&tagsAllOf=string&licenceOneOf=2&languageOneOf=en&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true&skipCount=false&start=0&count=15&sort=name
  • GETGet subscription of my user/api/v1/users/me/subscriptions/:subscriptionHandle
  • DELETEDelete subscription of my user/api/v1/users/me/subscriptions/:subscriptionHandle

My History

  • GETList watched videos history/api/v1/users/me/history/videos?start=0&count=15&search=string
  • POSTClear video history/api/v1/users/me/history/videos/remove
  • DELETEDelete history element/api/v1/users/me/history/videos/:videoId

My Notifications

  • PUTUpdate my notification settings/api/v1/users/me/notification-settings
  • GETList my notifications/api/v1/users/me/notifications?unread=true&start=0&count=15&sort=-createdAt
  • POSTMark notifications as read by their id/api/v1/users/me/notifications/read
  • POSTMark all my notification as read/api/v1/users/me/notifications/read-all

Config

  • GETGet instance public configuration/api/v1/config
  • GETGet instance "About" information/api/v1/config/about
  • GETGet instance runtime configuration/api/v1/config/custom
  • PUTSet instance runtime configuration/api/v1/config/custom
  • DELETEDelete instance runtime configuration/api/v1/config/custom

Job

  • POSTPause job queue/api/v1/jobs/pause
  • POSTResume job queue/api/v1/jobs/resume
  • GETList instance jobs/api/v1/jobs/:state?jobType=activitypub-follow&start=0&count=15&sort=-createdAt

Instance Follows

  • GETList instances following the server/api/v1/server/followers?state=pending&actorType=Person&start=0&count=15&sort=-createdAt
  • DELETERemove or reject a follower to your server/api/v1/server/followers/:nameWithHost
  • POSTAccept a pending follower to your server/api/v1/server/followers/:nameWithHost/accept
  • POSTReject a pending follower to your server/api/v1/server/followers/:nameWithHost/reject
  • GETList instances followed by the server/api/v1/server/following?state=pending&actorType=Person&start=0&count=15&sort=-createdAt
  • POSTFollow a list of actors (PeerTube instance, channel or account)/api/v1/server/following
  • DELETEUnfollow an actor (PeerTube instance, channel or account)/api/v1/server/following/:hostOrHandle

Instance Redundancy

  • PUTUpdate a server redundancy policy/api/v1/server/redundancy/:host

Plugins

  • GETList plugins/api/v1/plugins?pluginType=0&uninstalled=true&start=0&count=15&sort=-createdAt
  • GETList available plugins/api/v1/plugins/available?search=string&pluginType=0&currentPeerTubeEngine=string&start=0&count=15&sort=-createdAt
  • POSTInstall a plugin/api/v1/plugins/install
  • POSTUninstall a plugin/api/v1/plugins/uninstall
  • POSTUpdate a plugin/api/v1/plugins/update
  • GETGet a plugin/api/v1/plugins/:npmName
  • GETGet a plugin's public settings/api/v1/plugins/:npmName/public-settings
  • GETGet a plugin's registered settings/api/v1/plugins/:npmName/registered-settings
  • PUTSet a plugin's settings/api/v1/plugins/:npmName/settings

Abuses

  • GETList abuses/api/v1/abuses?id=0&predefinedReason=violentOrAbusive&search=string&state=1&searchReporter=string&searchReportee=string&searchVideo=string&searchVideoChannel=string&videoIs=deleted&filter=video&start=0&count=15&sort=-id
  • POSTReport an abuse/api/v1/abuses
  • PUTUpdate an abuse/api/v1/abuses/:abuseId
  • DELETEDelete an abuse/api/v1/abuses/:abuseId
  • GETList messages of an abuse/api/v1/abuses/:abuseId/messages
  • POSTAdd message to an abuse/api/v1/abuses/:abuseId/messages
  • DELETEDelete an abuse message/api/v1/abuses/:abuseId/messages/:abuseMessageId
  • GETList my abuses/api/v1/users/me/abuses?id=0&state=1&sort=-id&start=0&count=15

Video

  • GETList videos of a video channel/api/v1/video-channels/:channelHandle/videos?categoryOneOf=15&isLive=true&tagsOneOf=string&tagsAllOf=string&licenceOneOf=2&languageOneOf=en&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true&skipCount=false&start=0&count=15&sort=name
  • GETList videos/api/v1/videos?categoryOneOf=15&isLive=true&tagsOneOf=string&tagsAllOf=string&licenceOneOf=2&languageOneOf=en&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true&skipCount=false&start=0&count=15&sort=name
  • GETList available video categories/api/v1/videos/categories
  • GETList available video languages/api/v1/videos/languages
  • GETList available video licences/api/v1/videos/licences
  • GETList available video privacy policies/api/v1/videos/privacies
  • POSTUpload a video/api/v1/videos/uploadUses a single request to upload a video.
  • PUTSend chunk for the resumable upload of a video/api/v1/videos/upload-resumable?upload_id=stringUses a resumable protocol to continue, pause or resume the upload of a video
  • POSTInitialize the resumable upload of a video/api/v1/videos/upload-resumableUses a resumable protocol to initialize the upload of a video
  • DELETECancel the resumable upload of a video, deleting any data uploaded so far/api/v1/videos/upload-resumable?upload_id=stringUses a resumable protocol to cancel the upload of a video
  • GETGet a video/api/v1/videos/:id
  • PUTUpdate a video/api/v1/videos/:id
  • DELETEDelete a video/api/v1/videos/:id
  • GETGet complete video description/api/v1/videos/:id/description
  • POSTGet video source file metadata/api/v1/videos/:id/source
  • POSTRequest video token/api/v1/videos/:id/tokenRequest special tokens that expire quickly to use them in some context (like accessing private static files)
  • POSTNotify user is watching a video/api/v1/videos/:id/viewsCall 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…
  • PUTSet watching progress of a video/api/v1/videos/:id/watchingDeprecated. This endpoint has been deprecated. Use /videos/{id}/views instead

Video Imports

  • POSTImport a video/api/v1/videos/importsImport a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)
  • DELETEDelete video import/api/v1/videos/imports/:idDelete ended video import
  • POSTCancel video import/api/v1/videos/imports/:id/cancelCancel a pending video import

Channels Sync

  • POSTCreate a synchronization for a video channel/api/v1/video-channel-syncs
  • DELETEDelete a video channel synchronization/api/v1/video-channel-syncs/:channelSyncId
  • POSTTriggers the channel synchronization job, fetching all the videos from the remote channel/api/v1/video-channel-syncs/:channelSyncId/sync

Video Captions

  • GETList captions of a video/api/v1/videos/:id/captions
  • PUTAdd or replace a video caption/api/v1/videos/:id/captions/:captionLanguage
  • DELETEDelete a video caption/api/v1/videos/:id/captions/:captionLanguage

Video Channels

  • GETList the synchronizations of video channels of an account/api/v1/accounts/:name/video-channel-syncs?start=0&count=15&sort=-createdAt
  • GETList video channels of an account/api/v1/accounts/:name/video-channels?withStats=true&start=0&count=15&sort=-createdAt
  • GETList video channels/api/v1/video-channels?start=0&count=15&sort=-createdAt
  • POSTCreate a video channel/api/v1/video-channels
  • GETGet a video channel/api/v1/video-channels/:channelHandle
  • PUTUpdate a video channel/api/v1/video-channels/:channelHandle
  • DELETEDelete a video channel/api/v1/video-channels/:channelHandle
  • DELETEDelete channel avatar/api/v1/video-channels/:channelHandle/avatar
  • POSTUpdate channel avatar/api/v1/video-channels/:channelHandle/avatar/pick
  • DELETEDelete channel banner/api/v1/video-channels/:channelHandle/banner
  • POSTUpdate channel banner/api/v1/video-channels/:channelHandle/banner/pick
  • GETList followers of a video channel/api/v1/video-channels/:channelHandle/followers?start=0&count=15&sort=createdAt&search=string
  • POSTImport videos in channel/api/v1/video-channels/:channelHandle/import-videosImport a remote channel/playlist videos into a channel

Video Comments

  • GETList threads of a video/api/v1/videos/:id/comment-threads?start=0&count=15&sort=-createdAt
  • POSTCreate a thread/api/v1/videos/:id/comment-threads
  • GETGet a thread/api/v1/videos/:id/comment-threads/:threadId
  • POSTReply to a thread of a video/api/v1/videos/:id/comments/:commentId
  • DELETEDelete a comment or a reply/api/v1/videos/:id/comments/:commentId

Video Blocks

  • GETList video blocks/api/v1/videos/blacklist?type=1&search=string&start=0&count=15&sort=-id
  • POSTBlock a video/api/v1/videos/:id/blacklist
  • DELETEUnblock a video by its id/api/v1/videos/:id/blacklist

Video Rates

  • PUTLike/dislike a video/api/v1/videos/:id/rate

Video Playlists

  • GETList playlists of an account/api/v1/accounts/:name/video-playlists?start=0&count=15&sort=-createdAt&search=string&playlistType=1
  • GETCheck video exists in my playlists/api/v1/users/me/video-playlists/videos-exist?videoIds=42
  • GETList playlists of a channel/api/v1/video-channels/:channelHandle/video-playlists?start=0&count=15&sort=-createdAt&playlistType=1
  • GETList video playlists/api/v1/video-playlists?start=0&count=15&sort=-createdAt&playlistType=1
  • POSTCreate a video playlist/api/v1/video-playlistsIf the video playlist is set as public, videoChannelId is mandatory.
  • GETList available playlist privacy policies/api/v1/video-playlists/privacies
  • GETGet a video playlist/api/v1/video-playlists/:playlistId
  • PUTUpdate a video playlist/api/v1/video-playlists/:playlistIdIf the video playlist is set as public, the playlist must have a assigned channel.
  • DELETEDelete a video playlist/api/v1/video-playlists/:playlistId
  • POSTReorder a playlist/api/v1/video-playlists/:playlistId/videos/reorder
  • PUTUpdate a playlist element/api/v1/video-playlists/:playlistId/videos/:playlistElementId
  • DELETEDelete an element from a playlist/api/v1/video-playlists/:playlistId/videos/:playlistElementId

Video Files

  • DELETEDelete video HLS files/api/v1/videos/:id/hls
  • DELETEDelete video WebTorrent files/api/v1/videos/:id/webtorrent

Video Transcoding

  • POSTCreate a studio task/api/v1/videos/:id/studio/editCreate a task to edit a video (cut, add intro/outro etc)
  • POSTCreate a transcoding job/api/v1/videos/:id/transcoding

Video Feeds

  • GETList videos of subscriptions tied to a token/feeds/subscriptions.:format?accountId=string&token=string&sort=-createdAt&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true
  • GETList comments on videos/feeds/video-comments.:format?videoId=string&accountId=string&accountName=string&videoChannelId=string&videoChannelName=string
  • GETList videos/feeds/videos.:format?accountId=string&accountName=string&videoChannelId=string&videoChannelName=string&sort=-createdAt&nsfw=true&isLocal=true&include=0&privacyOneOf=1&hasHLSFiles=true&hasWebtorrentFiles=true

Search

  • GETSearch channels/api/v1/search/video-channels?search=string&start=0&count=15&searchTarget=local&sort=-createdAt
  • GETSearch playlists/api/v1/search/video-playlists?search=string&start=0&count=15&searchTarget=local&sort=-createdAt
  • GETSearch videos/api/v1/search/videos?search=string&categoryOneOf=15&isLive=true&tagsOneOf=string&tagsAllOf=string&licenceOneOf=2&languageOneOf=en&nsfw=true&isLocal=true&include=0&privacyOneOf=1&uuids=&hasHLSFiles=true&hasWebtorrentFiles=true&skipCount=false&start=0&count=15&searchTarget=local&sort=name&startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z&originallyPublishedStartDate=2024-01-01T00:00:00Z&originallyPublishedEndDate=2024-01-01T00:00:00Z&durationMin=0&durationMax=0

Homepage

  • GETGet instance custom homepage/api/v1/custom-pages/homepage/instance
  • PUTSet instance custom homepage/api/v1/custom-pages/homepage/instance

Video Mirroring

  • GETList videos being mirrored/api/v1/server/redundancy/videos?target=my-videos&start=0&count=15&sort=name
  • POSTMirror a video/api/v1/server/redundancy/videos
  • DELETEDelete a mirror done on a video/api/v1/server/redundancy/videos/:redundancyId

Stats

  • POSTCreate playback metrics/api/v1/metrics/playbackThese metrics are exposed by OpenTelemetry metrics exporter if enabled.
  • GETGet instance stats/api/v1/server/statsGet instance public statistics. This endpoint is cached.

Account Blocks

  • GETGet block status of accounts/hosts/api/v1/blocklist/status?accounts=goofy@example.com,donald@example.com&hosts=example.com
  • GETList account blocks/api/v1/server/blocklist/accounts?start=0&count=15&sort=-createdAt
  • POSTBlock an account/api/v1/server/blocklist/accounts
  • DELETEUnblock an account by its handle/api/v1/server/blocklist/accounts/:accountName

Logs

  • GETGet instance audit logs/api/v1/server/audit-logs
  • GETGet instance logs/api/v1/server/logs
  • POSTSend client log/api/v1/server/logs/client

Server Blocks

  • GETList server blocks/api/v1/server/blocklist/servers?start=0&count=15&sort=-createdAt
  • POSTBlock a server/api/v1/server/blocklist/servers
  • DELETEUnblock a server by its domain/api/v1/server/blocklist/servers/:host

Videos

  • GETGet video imports of my user/api/v1/users/me/videos/imports?start=0&count=15&sort=-createdAt&targetUrl=string&videoChannelSyncId=0.0&search=string
  • GETList videos of a playlist/api/v1/video-playlists/:playlistId/videos?start=0&count=15
  • POSTAdd a video in a playlist/api/v1/video-playlists/:playlistId/videos

Live Videos

  • POSTCreate a live/api/v1/videos/live
  • GETGet information about a live/api/v1/videos/live/:id
  • PUTUpdate information about a live/api/v1/videos/live/:id
  • GETList live sessions/api/v1/videos/live/:id/sessionsList all sessions created in a particular live
  • GETGet live session of a replay/api/v1/videos/:id/live-sessionIf the video is a replay of a live, you can find the associated live session using this endpoint

Video Ownership Change

  • GETList video ownership changes/api/v1/videos/ownership
  • POSTAccept ownership change request/api/v1/videos/ownership/:id/accept
  • POSTRefuse ownership change request/api/v1/videos/ownership/:id/refuse
  • POSTRequest ownership change/api/v1/videos/:id/give-ownership

Video Stats

  • GETGet overall stats of a video/api/v1/videos/:id/stats/overall?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z
  • GETGet retention stats of a video/api/v1/videos/:id/stats/retention
  • GETGet timeserie stats of a video/api/v1/videos/:id/stats/timeseries/:metric?startDate=2024-01-01T00:00:00Z&endDate=2024-01-01T00:00:00Z

Static Video Files

  • GETGet private HLS video file/static/streaming-playlists/hls/private/:filename?videoFileToken=string&reinjectVideoFileToken=true
  • GETGet public HLS video file/static/streaming-playlists/hls/:filename
  • GETGet private WebTorrent video file/static/webseed/private/:filename?videoFileToken=string
  • GETGet public WebTorrent video file/static/webseed/:filename

API details

Base URL
https://peertube2.cpy.re
https://peertube3.cpy.re
https://peertube.cpy.re
Authentication
OAuth 2.0 (password flow) with 3 scopes
Operations
186 operations on 153 pathsGET 83POST 59DELETE 27PUT 17
1 marked deprecated
Main resources
Video 23Video Channels 15Video Playlists 14Register 10Users 10My User 9Plugins 9Abuses 8Accounts 8Instance Follows 7
Response formats
application/json application/atom+xml application/rss+xml
Description format
OpenAPI 3.0.0, API version 5.1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the PeerTube in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the PeerTube collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (password flow) with 3 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Register a user” (POST /api/v1/users/register), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the PeerTube?

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. The spec API… It is listed under Social and has 186 endpoints.

Who publishes the PeerTube?

It is listed from Cpy's public API description (an OpenAPI document), not published by Cpy on Swastik Codes. Anyone who controls cpy.re can claim the profile by adding a DNS TXT record.

What is the base URL of the PeerTube?

Its description lists 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the PeerTube?

With OAuth 2.0 (password flow) with 3 scopes.

How many endpoints does the PeerTube have?

186 operations on 153 paths (83 GET, 59 POST, 27 DELETE, 17 PUT). The largest groups are Video, Video Channels, Video Playlists, Register.

Is forking the PeerTube free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.