Peertube

PeerTube

API version: 8.0.0

Auth

OAuth2

Base URL

https://peertube2.cpy.re

Setup

1. Configure auth: OAuth2
2. GET /feeds/podcast/videos.xml -- verify access
3. POST /api/v1/config/instance-banner/pick -- create first pick

Endpoints

265 endpoints across 4 groups. See references/api-spec.lap for full details.

static

download

feeds

api

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "Get web-video details?" -> GET /static/web-videos/{filename}
• "Get private details?" -> GET /static/web-videos/private/{filename}
• "Get hl details?" -> GET /static/streaming-playlists/hls/{filename}
• "Get private details?" -> GET /static/streaming-playlists/hls/private/{filename}
• "Get generate details?" -> GET /download/videos/generate/{videoId}
• "Get video-comments.{format} details?" -> GET /feeds/video-comments.{format}
• "Get videos.{format} details?" -> GET /feeds/videos.{format}
• "Get subscriptions.{format} details?" -> GET /feeds/subscriptions.{format}
• "List all videos.xml?" -> GET /feeds/podcast/videos.xml
• "Get account details?" -> GET /api/v1/accounts/{name}
• "Search videos?" -> GET /api/v1/accounts/{name}/videos
• "Search followers?" -> GET /api/v1/accounts/{name}/followers
• "List all accounts?" -> GET /api/v1/accounts
• "List all config?" -> GET /api/v1/config
• "List all about?" -> GET /api/v1/config/about
• "List all custom?" -> GET /api/v1/config/custom
• "Create a pick?" -> POST /api/v1/config/instance-banner/pick
• "Create a pick?" -> POST /api/v1/config/instance-avatar/pick
• "Create a pick?" -> POST /api/v1/config/instance-logo/{logoType}/pick
• "Delete a instance-logo?" -> DELETE /api/v1/config/instance-logo/{logoType}
• "List all instance?" -> GET /api/v1/custom-pages/homepage/instance
• "Create a pause?" -> POST /api/v1/jobs/pause
• "Create a resume?" -> POST /api/v1/jobs/resume
• "Get job details?" -> GET /api/v1/jobs/{state}
• "List all followers?" -> GET /api/v1/server/followers
• "Delete a follower?" -> DELETE /api/v1/server/followers/{handle}
• "Create a reject?" -> POST /api/v1/server/followers/{handle}/reject
• "Create a accept?" -> POST /api/v1/server/followers/{handle}/accept
• "List all following?" -> GET /api/v1/server/following
• "Create a following?" -> POST /api/v1/server/following
• "Delete a following?" -> DELETE /api/v1/server/following/{hostOrHandle}
• "Create a user?" -> POST /api/v1/users
• "Search users?" -> GET /api/v1/users
• "Delete a user?" -> DELETE /api/v1/users/{id}
• "Get user details?" -> GET /api/v1/users/{id}
• "Update a user?" -> PUT /api/v1/users/{id}
• "List all local?" -> GET /api/v1/oauth-clients/local
• "Create a token?" -> POST /api/v1/users/token
• "Create a revoke-token?" -> POST /api/v1/users/revoke-token
• "List all token-sessions?" -> GET /api/v1/users/{id}/token-sessions
• "List all revoke?" -> GET /api/v1/users/{id}/token-sessions/{tokenSessionId}/revoke
• "Create a ask-send-verify-email?" -> POST /api/v1/users/ask-send-verify-email
• "Create a ask-send-verify-email?" -> POST /api/v1/users/registrations/ask-send-verify-email
• "Create a verify-email?" -> POST /api/v1/users/{id}/verify-email
• "Create a verify-email?" -> POST /api/v1/users/registrations/{registrationId}/verify-email
• "Create a ask-reset-password?" -> POST /api/v1/users/ask-reset-password
• "Create a reset-password?" -> POST /api/v1/users/{id}/reset-password
• "Create a request?" -> POST /api/v1/users/{id}/two-factor/request
• "Create a confirm-request?" -> POST /api/v1/users/{id}/two-factor/confirm-request
• "Create a disable?" -> POST /api/v1/users/{id}/two-factor/disable
• "Create a import-resumable?" -> POST /api/v1/users/{userId}/imports/import-resumable
• "List all latest?" -> GET /api/v1/users/{userId}/imports/latest
• "Create a request?" -> POST /api/v1/users/{userId}/exports/request
• "List all exports?" -> GET /api/v1/users/{userId}/exports
• "Delete a export?" -> DELETE /api/v1/users/{userId}/exports/{id}
• "List all me?" -> GET /api/v1/users/me
• "Search comments?" -> GET /api/v1/users/me/videos/comments
• "Search imports?" -> GET /api/v1/users/me/videos/imports
• "List all video-quota-used?" -> GET /api/v1/users/me/video-quota-used
• "List all rating?" -> GET /api/v1/users/me/videos/{videoId}/rating
• "Search videos?" -> GET /api/v1/users/me/videos
• "List all subscriptions?" -> GET /api/v1/users/me/subscriptions
• "Create a subscription?" -> POST /api/v1/users/me/subscriptions
• "List all exist?" -> GET /api/v1/users/me/subscriptions/exist
• "Search videos?" -> GET /api/v1/users/me/subscriptions/videos
• "Get subscription details?" -> GET /api/v1/users/me/subscriptions/{subscriptionHandle}
• "Delete a subscription?" -> DELETE /api/v1/users/me/subscriptions/{subscriptionHandle}
• "List all notifications?" -> GET /api/v1/users/me/notifications
• "Create a read?" -> POST /api/v1/users/me/notifications/read
• "Create a read-all?" -> POST /api/v1/users/me/notifications/read-all
• "Create a read?" -> POST /api/v1/users/me/new-feature-info/read
• "Search videos?" -> GET /api/v1/users/me/history/videos
• "Delete a video?" -> DELETE /api/v1/users/me/history/videos/{videoId}
• "Create a remove?" -> POST /api/v1/users/me/history/videos/remove
• "Create a pick?" -> POST /api/v1/users/me/avatar/pick
• "Create a register?" -> POST /api/v1/users/register
• "Create a request?" -> POST /api/v1/users/registrations/request
• "Create a accept?" -> POST /api/v1/users/registrations/{registrationId}/accept
• "Create a reject?" -> POST /api/v1/users/registrations/{registrationId}/reject
• "Delete a registration?" -> DELETE /api/v1/users/registrations/{registrationId}
• "Search registrations?" -> GET /api/v1/users/registrations
• "List all ownership?" -> GET /api/v1/videos/ownership
• "Create a accept?" -> POST /api/v1/videos/ownership/{id}/accept
• "Create a refuse?" -> POST /api/v1/videos/ownership/{id}/refuse
• "Create a give-ownership?" -> POST /api/v1/videos/{id}/give-ownership
• "Create a token?" -> POST /api/v1/videos/{id}/token
• "Create a edit?" -> POST /api/v1/videos/{id}/studio/edit
• "Search videos?" -> GET /api/v1/videos
• "List all categories?" -> GET /api/v1/videos/categories
• "List all licences?" -> GET /api/v1/videos/licences
• "List all languages?" -> GET /api/v1/videos/languages
• "List all privacies?" -> GET /api/v1/videos/privacies
• "Update a video?" -> PUT /api/v1/videos/{id}
• "Get video details?" -> GET /api/v1/videos/{id}
• "Delete a video?" -> DELETE /api/v1/videos/{id}
• "List all description?" -> GET /api/v1/videos/{id}/description
• "Create a view?" -> POST /api/v1/videos/{id}/views
• "List all overall?" -> GET /api/v1/videos/{id}/stats/overall
• "List all user-agent?" -> GET /api/v1/videos/{id}/stats/user-agent
• "List all retention?" -> GET /api/v1/videos/{id}/stats/retention
• "Get timesery details?" -> GET /api/v1/videos/{id}/stats/timeseries/{metric}
• "Create a upload?" -> POST /api/v1/videos/upload
• "Create a upload-resumable?" -> POST /api/v1/videos/upload-resumable
• "Create a import?" -> POST /api/v1/videos/imports
• "Create a cancel?" -> POST /api/v1/videos/imports/{id}/cancel
• "Create a retry?" -> POST /api/v1/videos/imports/{id}/retry
• "Delete a import?" -> DELETE /api/v1/videos/imports/{id}
• "Create a live?" -> POST /api/v1/videos/live
• "Get live details?" -> GET /api/v1/videos/live/{id}
• "Update a live?" -> PUT /api/v1/videos/live/{id}
• "List all sessions?" -> GET /api/v1/videos/live/{id}/sessions
• "List all live-session?" -> GET /api/v1/videos/{id}/live-session
• "List all source?" -> GET /api/v1/videos/{id}/source
• "Create a replace-resumable?" -> POST /api/v1/videos/{id}/source/replace-resumable
• "List all abuses?" -> GET /api/v1/users/me/abuses
• "Search abuses?" -> GET /api/v1/abuses
• "Create a abuse?" -> POST /api/v1/abuses
• "Update a abuse?" -> PUT /api/v1/abuses/{abuseId}
• "Delete a abuse?" -> DELETE /api/v1/abuses/{abuseId}
• "List all messages?" -> GET /api/v1/abuses/{abuseId}/messages
• "Create a message?" -> POST /api/v1/abuses/{abuseId}/messages
• "Delete a message?" -> DELETE /api/v1/abuses/{abuseId}/messages/{abuseMessageId}
• "Create a blacklist?" -> POST /api/v1/videos/{id}/blacklist
• "Search blacklist?" -> GET /api/v1/videos/blacklist
• "List all storyboards?" -> GET /api/v1/videos/{id}/storyboards
• "List all captions?" -> GET /api/v1/videos/{id}/captions
• "Create a generate?" -> POST /api/v1/videos/{id}/captions/generate
• "Update a caption?" -> PUT /api/v1/videos/{id}/captions/{captionLanguage}
• "Delete a caption?" -> DELETE /api/v1/videos/{id}/captions/{captionLanguage}
• "List all chapters?" -> GET /api/v1/videos/{id}/chapters
• "List all embed-privacy?" -> GET /api/v1/videos/{id}/embed-privacy
• "List all allowed?" -> GET /api/v1/videos/{id}/embed-privacy/allowed
• "List all passwords?" -> GET /api/v1/videos/{id}/passwords
• "Create a password?" -> POST /api/v1/videos/{id}/passwords
• "Delete a password?" -> DELETE /api/v1/videos/{id}/passwords/{videoPasswordId}
• "List all video-channels?" -> GET /api/v1/video-channels
• "Create a video-channel?" -> POST /api/v1/video-channels
• "Get video-channel details?" -> GET /api/v1/video-channels/{channelHandle}
• "Update a video-channel?" -> PUT /api/v1/video-channels/{channelHandle}
• "Delete a video-channel?" -> DELETE /api/v1/video-channels/{channelHandle}
• "Search videos?" -> GET /api/v1/video-channels/{channelHandle}/videos
• "List all activities?" -> GET /api/v1/video-channels/{channelHandle}/activities
• "List all video-playlists?" -> GET /api/v1/video-channels/{channelHandle}/video-playlists
• "Create a reorder?" -> POST /api/v1/video-channels/{channelHandle}/video-playlists/reorder
• "Search followers?" -> GET /api/v1/video-channels/{channelHandle}/followers
• "Create a pick?" -> POST /api/v1/video-channels/{channelHandle}/avatar/pick
• "Create a pick?" -> POST /api/v1/video-channels/{channelHandle}/banner/pick
• "Create a import-video?" -> POST /api/v1/video-channels/{channelHandle}/import-videos
• "Create a video-channel-sync?" -> POST /api/v1/video-channel-syncs
• "Delete a video-channel-sync?" -> DELETE /api/v1/video-channel-syncs/{channelSyncId}
• "Create a sync?" -> POST /api/v1/video-channel-syncs/{channelSyncId}/sync
• "Get video details?" -> GET /api/v1/player-settings/videos/{id}
• "Update a video?" -> PUT /api/v1/player-settings/videos/{id}
• "Get video-channel details?" -> GET /api/v1/player-settings/video-channels/{channelHandle}
• "Update a video-channel?" -> PUT /api/v1/player-settings/video-channels/{channelHandle}
• "List all privacies?" -> GET /api/v1/video-playlists/privacies
• "List all video-playlists?" -> GET /api/v1/video-playlists
• "Create a video-playlist?" -> POST /api/v1/video-playlists
• "Get video-playlist details?" -> GET /api/v1/video-playlists/{playlistId}
• "Update a video-playlist?" -> PUT /api/v1/video-playlists/{playlistId}
• "Delete a video-playlist?" -> DELETE /api/v1/video-playlists/{playlistId}
• "List all videos?" -> GET /api/v1/video-playlists/{playlistId}/videos
• "Create a video?" -> POST /api/v1/video-playlists/{playlistId}/videos
• "Create a reorder?" -> POST /api/v1/video-playlists/{playlistId}/videos/reorder
• "Update a video?" -> PUT /api/v1/video-playlists/{playlistId}/videos/{playlistElementId}
• "Delete a video?" -> DELETE /api/v1/video-playlists/{playlistId}/videos/{playlistElementId}
• "List all videos-exist?" -> GET /api/v1/users/me/video-playlists/videos-exist
• "Search video-playlists?" -> GET /api/v1/accounts/{name}/video-playlists
• "Search video-channels?" -> GET /api/v1/accounts/{name}/video-channels
• "List all video-channel-syncs?" -> GET /api/v1/accounts/{name}/video-channel-syncs
• "List all ratings?" -> GET /api/v1/accounts/{name}/ratings
• "List all comment-threads?" -> GET /api/v1/videos/{id}/comment-threads
• "Create a comment-thread?" -> POST /api/v1/videos/{id}/comment-threads
• "Get comment-thread details?" -> GET /api/v1/videos/{id}/comment-threads/{threadId}
• "Search comments?" -> GET /api/v1/videos/comments
• "Delete a comment?" -> DELETE /api/v1/videos/{id}/comments/{commentId}
• "Create a approve?" -> POST /api/v1/videos/{id}/comments/{commentId}/approve
• "Create a transcoding?" -> POST /api/v1/videos/{id}/transcoding
• "Search videos?" -> GET /api/v1/search/videos
• "Search video-channels?" -> GET /api/v1/search/video-channels
• "Search video-playlists?" -> GET /api/v1/search/video-playlists
• "List all status?" -> GET /api/v1/blocklist/status
• "List all accounts?" -> GET /api/v1/server/blocklist/accounts
• "Create a account?" -> POST /api/v1/server/blocklist/accounts
• "Delete a account?" -> DELETE /api/v1/server/blocklist/accounts/{accountName}
• "List all servers?" -> GET /api/v1/server/blocklist/servers
• "Create a server?" -> POST /api/v1/server/blocklist/servers
• "Delete a server?" -> DELETE /api/v1/server/blocklist/servers/{host}
• "Update a redundancy?" -> PUT /api/v1/server/redundancy/{host}
• "List all videos?" -> GET /api/v1/server/redundancy/videos
• "Create a video?" -> POST /api/v1/server/redundancy/videos
• "Delete a video?" -> DELETE /api/v1/server/redundancy/videos/{redundancyId}
• "List all stats?" -> GET /api/v1/server/stats
• "Create a client?" -> POST /api/v1/server/logs/client
• "List all logs?" -> GET /api/v1/server/logs
• "List all audit-logs?" -> GET /api/v1/server/audit-logs
• "List all plugins?" -> GET /api/v1/plugins
• "Search available?" -> GET /api/v1/plugins/available
• "Create a install?" -> POST /api/v1/plugins/install
• "Create a update?" -> POST /api/v1/plugins/update
• "Create a uninstall?" -> POST /api/v1/plugins/uninstall
• "Get plugin details?" -> GET /api/v1/plugins/{npmName}
• "List all public-settings?" -> GET /api/v1/plugins/{npmName}/public-settings
• "List all registered-settings?" -> GET /api/v1/plugins/{npmName}/registered-settings
• "Create a playback?" -> POST /api/v1/metrics/playback
• "Create a generate?" -> POST /api/v1/runners/registration-tokens/generate
• "Delete a registration-token?" -> DELETE /api/v1/runners/registration-tokens/{registrationTokenId}
• "List all registration-tokens?" -> GET /api/v1/runners/registration-tokens
• "Create a register?" -> POST /api/v1/runners/register
• "Create a unregister?" -> POST /api/v1/runners/unregister
• "Delete a runner?" -> DELETE /api/v1/runners/{runnerId}
• "List all runners?" -> GET /api/v1/runners
• "Create a request?" -> POST /api/v1/runners/jobs/request
• "Create a accept?" -> POST /api/v1/runners/jobs/{jobUUID}/accept
• "Create a abort?" -> POST /api/v1/runners/jobs/{jobUUID}/abort
• "Create a update?" -> POST /api/v1/runners/jobs/{jobUUID}/update
• "Create a error?" -> POST /api/v1/runners/jobs/{jobUUID}/error
• "Create a success?" -> POST /api/v1/runners/jobs/{jobUUID}/success
• "List all cancel?" -> GET /api/v1/runners/jobs/{jobUUID}/cancel
• "Delete a job?" -> DELETE /api/v1/runners/jobs/{jobUUID}
• "Search jobs?" -> GET /api/v1/runners/jobs
• "List all comments?" -> GET /api/v1/automatic-tags/policies/accounts/{accountName}/comments
• "List all available?" -> GET /api/v1/automatic-tags/accounts/{accountName}/available
• "List all available?" -> GET /api/v1/automatic-tags/server/available
• "List all lists?" -> GET /api/v1/watched-words/accounts/{accountName}/lists
• "Create a list?" -> POST /api/v1/watched-words/accounts/{accountName}/lists
• "Update a list?" -> PUT /api/v1/watched-words/accounts/{accountName}/lists/{listId}
• "Delete a list?" -> DELETE /api/v1/watched-words/accounts/{accountName}/lists/{listId}
• "List all lists?" -> GET /api/v1/watched-words/server/lists
• "Create a list?" -> POST /api/v1/watched-words/server/lists
• "Update a list?" -> PUT /api/v1/watched-words/server/lists/{listId}
• "Delete a list?" -> DELETE /api/v1/watched-words/server/lists/{listId}
• "Create a update-language?" -> POST /api/v1/client-config/update-language
• "List all collaborators?" -> GET /api/v1/video-channels/{channelHandle}/collaborators
• "Create a invite?" -> POST /api/v1/video-channels/{channelHandle}/collaborators/invite
• "Create a accept?" -> POST /api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}/accept
• "Create a reject?" -> POST /api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}/reject
• "Delete a collaborator?" -> DELETE /api/v1/video-channels/{channelHandle}/collaborators/{collaboratorId}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP