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](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) 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 b
https://peertube2.cpy.re186 endpoints available
/api/v1/usersList users
/api/v1/usersCreate a user
/api/v1/abusesList abuses
/api/v1/abusesReport an abuse
/api/v1/configGet instance public configuration
/api/v1/videosList videos
/api/v1/pluginsList plugins
/api/v1/accountsList accounts
/api/v1/users/meGet my user information
/api/v1/users/meUpdate my user information
/api/v1/jobs/pausePause job queue
/api/v1/users/{id}Get a user
/api/v1/users/{id}Update a user
/api/v1/users/{id}Delete a user
/api/v1/jobs/resumeResume job queue
/api/v1/server/logsGet instance logs
/api/v1/users/tokenLogin
/api/v1/videos/liveCreate a live
/api/v1/videos/{id}Get a video
/api/v1/videos/{id}Update a video
/api/v1/videos/{id}Delete a video
/api/v1/config/aboutGet instance "About" information
/api/v1/jobs/{state}List instance jobs
/api/v1/server/statsGet instance stats
/api/v1/config/customGet instance runtime configuration
/api/v1/config/customSet instance runtime configuration
/api/v1/config/customDelete instance runtime configuration
/api/v1/search/videosSearch videos
/api/v1/videos/uploadUpload a video
/api/v1/plugins/updateUpdate a plugin
/api/v1/users/registerRegister a user
/api/v1/video-channelsList video channels
/api/v1/video-channelsCreate a video channel
/api/v1/videos/importsImport a video
/feeds/videos.{format}List videos
/api/v1/accounts/{name}Get an account
/api/v1/plugins/installInstall a plugin
/api/v1/users/me/abusesList my abuses
/api/v1/users/me/avatarDelete my avatar
/api/v1/users/me/videosGet videos of my user
/api/v1/video-playlistsList video playlists
/api/v1/video-playlistsCreate a video playlist
/api/v1/videos/licencesList available video licences
/api/v1/videos/{id}/hlsDelete video HLS files
/api/v1/abuses/{abuseId}Update an abuse
/api/v1/abuses/{abuseId}Delete an abuse
/api/v1/blocklist/statusGet block status of accounts/hosts
/api/v1/metrics/playbackCreate playback metrics
/api/v1/server/followersList instances following the server
/api/v1/server/followingList instances followed by the server
/api/v1/server/followingFollow a list of actors (PeerTube instance, channel or account)
/api/v1/videos/blacklistList video blocks
/api/v1/videos/languagesList available video languages
/api/v1/videos/live/{id}Get information about a live
/api/v1/videos/live/{id}Update information about a live
/api/v1/videos/ownershipList video ownership changes
/api/v1/videos/privaciesList available video privacy policies
/api/v1/videos/{id}/rateLike/dislike a video
/api/v1/plugins/availableList available plugins
/api/v1/plugins/uninstallUninstall a plugin
/api/v1/plugins/{npmName}Get a plugin
/api/v1/server/audit-logsGet instance audit logs
/api/v1/videos/categoriesList available video categories
/api/v1/videos/{id}/tokenRequest video token
/api/v1/videos/{id}/viewsNotify user is watching a video
/api/v1/server/logs/clientSend client log
/api/v1/users/revoke-tokenLogout
/api/v1/videos/{id}/sourceGet video source file metadata
/static/webseed/{filename}Get public WebTorrent video file
/api/v1/oauth-clients/localLogin prerequisite
/api/v1/users/registrationsList registrations
/api/v1/video-channel-syncsCreate a synchronization for a video channel
/api/v1/videos/imports/{id}Delete video import
/api/v1/users/me/avatar/pickUpdate my user avatar
/api/v1/videos/{id}/captionsList captions of a video
/api/v1/videos/{id}/watchingSet watching progress of a video
/api/v1/search/video-channelsSearch channels
/api/v1/videos/{id}/blacklistBlock a video
/api/v1/videos/{id}/blacklistUnblock a video by its id
/feeds/subscriptions.{format}List videos of subscriptions tied to a token
/api/v1/accounts/{name}/videosList videos of an account
/api/v1/search/video-playlistsSearch playlists
/api/v1/users/me/notificationsList my notifications
/api/v1/users/me/subscriptionsGet my user subscriptions
/api/v1/users/me/subscriptionsAdd subscription to my user
/api/v1/videos/{id}/webtorrentDelete video WebTorrent files
/feeds/video-comments.{format}List comments on videos
/api/v1/accounts/{name}/ratingsList ratings of an account
/api/v1/users/me/history/videosList watched videos history
/api/v1/users/me/videos/importsGet video imports of my user
/api/v1/users/{id}/verify-emailVerify a user
/api/v1/videos/upload-resumableSend chunk for the resumable upload of a video
/api/v1/videos/upload-resumableInitialize the resumable upload of a video
/api/v1/videos/upload-resumableCancel the resumable upload of a video, deleting any data uploaded so far
/api/v1/videos/{id}/descriptionGet complete video description
/api/v1/videos/{id}/studio/editCreate a studio task
/api/v1/videos/{id}/transcodingCreate a transcoding job
/api/v1/server/blocklist/serversList server blocks
/api/v1/server/blocklist/serversBlock a server
/api/v1/server/redundancy/videosList videos being mirrored
/api/v1/server/redundancy/videosMirror a video
/api/v1/server/redundancy/{host}Update a server redundancy policy
/api/v1/videos/{id}/live-sessionGet live session of a replay
/api/v1/abuses/{abuseId}/messagesList messages of an abuse
/api/v1/abuses/{abuseId}/messagesAdd message to an abuse
/api/v1/accounts/{name}/followersList followers of an account
/api/v1/server/blocklist/accountsList account blocks
/api/v1/server/blocklist/accountsBlock an account
/api/v1/users/me/video-quota-usedGet my user used quota
/api/v1/video-playlists/privaciesList available playlist privacy policies
/api/v1/videos/live/{id}/sessionsList live sessions
/api/v1/videos/{id}/stats/overallGet overall stats of a video
/api/v1/plugins/{npmName}/settingsSet a plugin's settings
/api/v1/videos/imports/{id}/cancelCancel video import
/api/v1/videos/{id}/give-ownershipRequest ownership change
/static/webseed/private/{filename}Get private WebTorrent video file
/api/v1/users/ask-send-verify-emailResend user verification link
/api/v1/users/me/notifications/readMark notifications as read by their id
/api/v1/users/registrations/requestRequest registration
/api/v1/videos/{id}/comment-threadsList threads of a video
/api/v1/videos/{id}/comment-threadsCreate a thread
/api/v1/videos/{id}/stats/retentionGet retention stats of a video
/api/v1/users/me/subscriptions/existGet if subscriptions exist for my user
/api/v1/video-playlists/{playlistId}Get a video playlist
/api/v1/video-playlists/{playlistId}Update a video playlist
/api/v1/video-playlists/{playlistId}Delete a video playlist
/api/v1/videos/ownership/{id}/acceptAccept ownership change request
/api/v1/videos/ownership/{id}/refuseRefuse ownership change request
/api/v1/users/me/subscriptions/videosList videos of subscriptions of my user
/api/v1/users/{id}/two-factor/disableDisable two factor auth
/api/v1/users/{id}/two-factor/requestRequest two factor auth
/api/v1/accounts/{name}/video-channelsList video channels of an account
/api/v1/custom-pages/homepage/instanceGet instance custom homepage
/api/v1/custom-pages/homepage/instanceSet instance custom homepage
/api/v1/users/me/history/videos/removeClear video history
/api/v1/users/me/notification-settingsUpdate my notification settings
/api/v1/video-channels/{channelHandle}Get a video channel
/api/v1/video-channels/{channelHandle}Update a video channel
/api/v1/video-channels/{channelHandle}Delete a video channel
/api/v1/accounts/{name}/video-playlistsList playlists of an account
/api/v1/server/blocklist/servers/{host}Unblock a server by its domain
/api/v1/server/followers/{nameWithHost}Remove or reject a follower to your server
/api/v1/server/following/{hostOrHandle}Unfollow an actor (PeerTube instance, channel or account)
/api/v1/users/me/notifications/read-allMark all my notification as read
/api/v1/users/me/videos/{videoId}/ratingGet rate of my user for a video
/api/v1/videos/{id}/comments/{commentId}Reply to a thread of a video
/api/v1/videos/{id}/comments/{commentId}Delete a comment or a reply
/api/v1/plugins/{npmName}/public-settingsGet a plugin's public settings
/api/v1/users/me/history/videos/{videoId}Delete history element
/static/streaming-playlists/hls/{filename}Get public HLS video file
/api/v1/accounts/{name}/video-channel-syncsList the synchronizations of video channels of an account
/api/v1/video-channel-syncs/{channelSyncId}Delete a video channel synchronization
/api/v1/video-playlists/{playlistId}/videosList videos of a playlist
/api/v1/video-playlists/{playlistId}/videosAdd a video in a playlist
/api/v1/users/registrations/{registrationId}Delete registration
/api/v1/plugins/{npmName}/registered-settingsGet a plugin's registered settings
/api/v1/users/me/video-playlists/videos-existCheck video exists in my playlists
/api/v1/users/{id}/two-factor/confirm-requestConfirm two factor auth
/api/v1/video-channels/{channelHandle}/avatarDelete channel avatar
/api/v1/video-channels/{channelHandle}/bannerDelete channel banner
/api/v1/video-channels/{channelHandle}/videosList videos of a video channel
/api/v1/videos/{id}/stats/timeseries/{metric}Get timeserie stats of a video
/api/v1/server/followers/{nameWithHost}/acceptAccept a pending follower to your server
/api/v1/server/followers/{nameWithHost}/rejectReject a pending follower to your server
/api/v1/videos/{id}/captions/{captionLanguage}Add or replace a video caption
/api/v1/videos/{id}/captions/{captionLanguage}Delete a video caption
/api/v1/videos/{id}/comment-threads/{threadId}Get a thread
/api/v1/server/blocklist/accounts/{accountName}Unblock an account by its handle
/api/v1/server/redundancy/videos/{redundancyId}Delete a mirror done on a video
/api/v1/video-channel-syncs/{channelSyncId}/syncTriggers the channel synchronization job, fetching all the videos from the remote channel
/api/v1/video-channels/{channelHandle}/followersList followers of a video channel
/api/v1/users/registrations/ask-send-verify-emailResend verification link to registration email
/api/v1/abuses/{abuseId}/messages/{abuseMessageId}Delete an abuse message
/api/v1/video-channels/{channelHandle}/avatar/pickUpdate channel avatar
/api/v1/video-channels/{channelHandle}/banner/pickUpdate channel banner
/static/streaming-playlists/hls/private/{filename}Get private HLS video file
/api/v1/users/me/subscriptions/{subscriptionHandle}Get subscription of my user
/api/v1/users/me/subscriptions/{subscriptionHandle}Delete subscription of my user
/api/v1/users/registrations/{registrationId}/acceptAccept registration
/api/v1/users/registrations/{registrationId}/rejectReject registration
/api/v1/video-playlists/{playlistId}/videos/reorderReorder a playlist
/api/v1/video-channels/{channelHandle}/import-videosImport videos in channel
/api/v1/video-channels/{channelHandle}/video-playlistsList playlists of a channel
/api/v1/users/registrations/{registrationId}/verify-emailVerify a registration email
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}Update a playlist element
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}Delete an element from a playlist
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](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO) which generates a client SDK in the language of your choice - we generate some client SDKs automatically: - [Python](https://framagit.org/framasoft/peertube/clients/python) - [Go](https://framagit.org/framasoft/peertube/clients/go) - [Kotlin](https://framagit.org/framasoft/peertube/clients/kotlin) See the [REST API quick start](https://docs.joinpeertube.org/api/rest-getting-started) 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 b
https://peertube2.cpy.re186 endpoints available
/api/v1/usersList users
/api/v1/usersCreate a user
/api/v1/abusesList abuses
/api/v1/abusesReport an abuse
/api/v1/configGet instance public configuration
/api/v1/videosList videos
/api/v1/pluginsList plugins
/api/v1/accountsList accounts
/api/v1/users/meGet my user information
/api/v1/users/meUpdate my user information
/api/v1/jobs/pausePause job queue
/api/v1/users/{id}Get a user
/api/v1/users/{id}Update a user
/api/v1/users/{id}Delete a user
/api/v1/jobs/resumeResume job queue
/api/v1/server/logsGet instance logs
/api/v1/users/tokenLogin
/api/v1/videos/liveCreate a live
/api/v1/videos/{id}Get a video
/api/v1/videos/{id}Update a video
/api/v1/videos/{id}Delete a video
/api/v1/config/aboutGet instance "About" information
/api/v1/jobs/{state}List instance jobs
/api/v1/server/statsGet instance stats
/api/v1/config/customGet instance runtime configuration
/api/v1/config/customSet instance runtime configuration
/api/v1/config/customDelete instance runtime configuration
/api/v1/search/videosSearch videos
/api/v1/videos/uploadUpload a video
/api/v1/plugins/updateUpdate a plugin
/api/v1/users/registerRegister a user
/api/v1/video-channelsList video channels
/api/v1/video-channelsCreate a video channel
/api/v1/videos/importsImport a video
/feeds/videos.{format}List videos
/api/v1/accounts/{name}Get an account
/api/v1/plugins/installInstall a plugin
/api/v1/users/me/abusesList my abuses
/api/v1/users/me/avatarDelete my avatar
/api/v1/users/me/videosGet videos of my user
/api/v1/video-playlistsList video playlists
/api/v1/video-playlistsCreate a video playlist
/api/v1/videos/licencesList available video licences
/api/v1/videos/{id}/hlsDelete video HLS files
/api/v1/abuses/{abuseId}Update an abuse
/api/v1/abuses/{abuseId}Delete an abuse
/api/v1/blocklist/statusGet block status of accounts/hosts
/api/v1/metrics/playbackCreate playback metrics
/api/v1/server/followersList instances following the server
/api/v1/server/followingList instances followed by the server
/api/v1/server/followingFollow a list of actors (PeerTube instance, channel or account)
/api/v1/videos/blacklistList video blocks
/api/v1/videos/languagesList available video languages
/api/v1/videos/live/{id}Get information about a live
/api/v1/videos/live/{id}Update information about a live
/api/v1/videos/ownershipList video ownership changes
/api/v1/videos/privaciesList available video privacy policies
/api/v1/videos/{id}/rateLike/dislike a video
/api/v1/plugins/availableList available plugins
/api/v1/plugins/uninstallUninstall a plugin
/api/v1/plugins/{npmName}Get a plugin
/api/v1/server/audit-logsGet instance audit logs
/api/v1/videos/categoriesList available video categories
/api/v1/videos/{id}/tokenRequest video token
/api/v1/videos/{id}/viewsNotify user is watching a video
/api/v1/server/logs/clientSend client log
/api/v1/users/revoke-tokenLogout
/api/v1/videos/{id}/sourceGet video source file metadata
/static/webseed/{filename}Get public WebTorrent video file
/api/v1/oauth-clients/localLogin prerequisite
/api/v1/users/registrationsList registrations
/api/v1/video-channel-syncsCreate a synchronization for a video channel
/api/v1/videos/imports/{id}Delete video import
/api/v1/users/me/avatar/pickUpdate my user avatar
/api/v1/videos/{id}/captionsList captions of a video
/api/v1/videos/{id}/watchingSet watching progress of a video
/api/v1/search/video-channelsSearch channels
/api/v1/videos/{id}/blacklistBlock a video
/api/v1/videos/{id}/blacklistUnblock a video by its id
/feeds/subscriptions.{format}List videos of subscriptions tied to a token
/api/v1/accounts/{name}/videosList videos of an account
/api/v1/search/video-playlistsSearch playlists
/api/v1/users/me/notificationsList my notifications
/api/v1/users/me/subscriptionsGet my user subscriptions
/api/v1/users/me/subscriptionsAdd subscription to my user
/api/v1/videos/{id}/webtorrentDelete video WebTorrent files
/feeds/video-comments.{format}List comments on videos
/api/v1/accounts/{name}/ratingsList ratings of an account
/api/v1/users/me/history/videosList watched videos history
/api/v1/users/me/videos/importsGet video imports of my user
/api/v1/users/{id}/verify-emailVerify a user
/api/v1/videos/upload-resumableSend chunk for the resumable upload of a video
/api/v1/videos/upload-resumableInitialize the resumable upload of a video
/api/v1/videos/upload-resumableCancel the resumable upload of a video, deleting any data uploaded so far
/api/v1/videos/{id}/descriptionGet complete video description
/api/v1/videos/{id}/studio/editCreate a studio task
/api/v1/videos/{id}/transcodingCreate a transcoding job
/api/v1/server/blocklist/serversList server blocks
/api/v1/server/blocklist/serversBlock a server
/api/v1/server/redundancy/videosList videos being mirrored
/api/v1/server/redundancy/videosMirror a video
/api/v1/server/redundancy/{host}Update a server redundancy policy
/api/v1/videos/{id}/live-sessionGet live session of a replay
/api/v1/abuses/{abuseId}/messagesList messages of an abuse
/api/v1/abuses/{abuseId}/messagesAdd message to an abuse
/api/v1/accounts/{name}/followersList followers of an account
/api/v1/server/blocklist/accountsList account blocks
/api/v1/server/blocklist/accountsBlock an account
/api/v1/users/me/video-quota-usedGet my user used quota
/api/v1/video-playlists/privaciesList available playlist privacy policies
/api/v1/videos/live/{id}/sessionsList live sessions
/api/v1/videos/{id}/stats/overallGet overall stats of a video
/api/v1/plugins/{npmName}/settingsSet a plugin's settings
/api/v1/videos/imports/{id}/cancelCancel video import
/api/v1/videos/{id}/give-ownershipRequest ownership change
/static/webseed/private/{filename}Get private WebTorrent video file
/api/v1/users/ask-send-verify-emailResend user verification link
/api/v1/users/me/notifications/readMark notifications as read by their id
/api/v1/users/registrations/requestRequest registration
/api/v1/videos/{id}/comment-threadsList threads of a video
/api/v1/videos/{id}/comment-threadsCreate a thread
/api/v1/videos/{id}/stats/retentionGet retention stats of a video
/api/v1/users/me/subscriptions/existGet if subscriptions exist for my user
/api/v1/video-playlists/{playlistId}Get a video playlist
/api/v1/video-playlists/{playlistId}Update a video playlist
/api/v1/video-playlists/{playlistId}Delete a video playlist
/api/v1/videos/ownership/{id}/acceptAccept ownership change request
/api/v1/videos/ownership/{id}/refuseRefuse ownership change request
/api/v1/users/me/subscriptions/videosList videos of subscriptions of my user
/api/v1/users/{id}/two-factor/disableDisable two factor auth
/api/v1/users/{id}/two-factor/requestRequest two factor auth
/api/v1/accounts/{name}/video-channelsList video channels of an account
/api/v1/custom-pages/homepage/instanceGet instance custom homepage
/api/v1/custom-pages/homepage/instanceSet instance custom homepage
/api/v1/users/me/history/videos/removeClear video history
/api/v1/users/me/notification-settingsUpdate my notification settings
/api/v1/video-channels/{channelHandle}Get a video channel
/api/v1/video-channels/{channelHandle}Update a video channel
/api/v1/video-channels/{channelHandle}Delete a video channel
/api/v1/accounts/{name}/video-playlistsList playlists of an account
/api/v1/server/blocklist/servers/{host}Unblock a server by its domain
/api/v1/server/followers/{nameWithHost}Remove or reject a follower to your server
/api/v1/server/following/{hostOrHandle}Unfollow an actor (PeerTube instance, channel or account)
/api/v1/users/me/notifications/read-allMark all my notification as read
/api/v1/users/me/videos/{videoId}/ratingGet rate of my user for a video
/api/v1/videos/{id}/comments/{commentId}Reply to a thread of a video
/api/v1/videos/{id}/comments/{commentId}Delete a comment or a reply
/api/v1/plugins/{npmName}/public-settingsGet a plugin's public settings
/api/v1/users/me/history/videos/{videoId}Delete history element
/static/streaming-playlists/hls/{filename}Get public HLS video file
/api/v1/accounts/{name}/video-channel-syncsList the synchronizations of video channels of an account
/api/v1/video-channel-syncs/{channelSyncId}Delete a video channel synchronization
/api/v1/video-playlists/{playlistId}/videosList videos of a playlist
/api/v1/video-playlists/{playlistId}/videosAdd a video in a playlist
/api/v1/users/registrations/{registrationId}Delete registration
/api/v1/plugins/{npmName}/registered-settingsGet a plugin's registered settings
/api/v1/users/me/video-playlists/videos-existCheck video exists in my playlists
/api/v1/users/{id}/two-factor/confirm-requestConfirm two factor auth
/api/v1/video-channels/{channelHandle}/avatarDelete channel avatar
/api/v1/video-channels/{channelHandle}/bannerDelete channel banner
/api/v1/video-channels/{channelHandle}/videosList videos of a video channel
/api/v1/videos/{id}/stats/timeseries/{metric}Get timeserie stats of a video
/api/v1/server/followers/{nameWithHost}/acceptAccept a pending follower to your server
/api/v1/server/followers/{nameWithHost}/rejectReject a pending follower to your server
/api/v1/videos/{id}/captions/{captionLanguage}Add or replace a video caption
/api/v1/videos/{id}/captions/{captionLanguage}Delete a video caption
/api/v1/videos/{id}/comment-threads/{threadId}Get a thread
/api/v1/server/blocklist/accounts/{accountName}Unblock an account by its handle
/api/v1/server/redundancy/videos/{redundancyId}Delete a mirror done on a video
/api/v1/video-channel-syncs/{channelSyncId}/syncTriggers the channel synchronization job, fetching all the videos from the remote channel
/api/v1/video-channels/{channelHandle}/followersList followers of a video channel
/api/v1/users/registrations/ask-send-verify-emailResend verification link to registration email
/api/v1/abuses/{abuseId}/messages/{abuseMessageId}Delete an abuse message
/api/v1/video-channels/{channelHandle}/avatar/pickUpdate channel avatar
/api/v1/video-channels/{channelHandle}/banner/pickUpdate channel banner
/static/streaming-playlists/hls/private/{filename}Get private HLS video file
/api/v1/users/me/subscriptions/{subscriptionHandle}Get subscription of my user
/api/v1/users/me/subscriptions/{subscriptionHandle}Delete subscription of my user
/api/v1/users/registrations/{registrationId}/acceptAccept registration
/api/v1/users/registrations/{registrationId}/rejectReject registration
/api/v1/video-playlists/{playlistId}/videos/reorderReorder a playlist
/api/v1/video-channels/{channelHandle}/import-videosImport videos in channel
/api/v1/video-channels/{channelHandle}/video-playlistsList playlists of a channel
/api/v1/users/registrations/{registrationId}/verify-emailVerify a registration email
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}Update a playlist element
/api/v1/video-playlists/{playlistId}/videos/{playlistElementId}Delete an element from a playlist