How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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 comment is posted, it is done with your Account's Actor.

PeerTube Accounts API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 8 operations across 8 paths, and defines 36 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

8 operations 8 paths 36 schemas 8 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube Accounts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 8 GET. Each is listed below with its method, path, parameters, and response codes.

Accounts 8

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 c…

GET
/api/v1/accounts/{name}
Get an account
getAccount 1 param → 200404
GET
/api/v1/accounts/{name}/videos
List videos of an account
getAccountVideos 25 params → 200
GET
/api/v1/accounts/{name}/followers
List followers of an account
getAccountFollowers 5 params → 200
GET
/api/v1/accounts
List accounts
getAccounts 3 params → 200
GET
/api/v1/accounts/{name}/video-playlists
List playlists of an account
8 params → 200
GET
/api/v1/accounts/{name}/video-channels
List video channels of an account
7 params → 200
GET
/api/v1/accounts/{name}/video-channel-syncs
List the synchronizations of video channels of an account
5 params → 200
GET
/api/v1/accounts/{name}/ratings
List ratings of an account
5 params → 200

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are Video (37 properties), VideoPlaylist (16 properties), Actor (10 properties), Follow (7 properties). Each schema is shown below with its type and property counts.

VideoPlaylistTypeConstant
object
2 properties
VideoPlaylistTypeSet
integer
The video playlist type (Regular = 1, Watch Later = 2)
VideoConstantNumber-Licence
object
2 properties
VideoStateConstant
object
2 properties
VideoConstantString-Language
object
2 properties
VideoListResponse
object
2 properties
Actor
object
10 properties
Thumbnail
object
4 properties
User
object
1 property
VideoChannelSync
object
6 properties
VideoChannelList
object
2 properties
VideoPrivacyConstant
object
2 properties
id
integer
VideoRating
object
2 properties 2 required
VideoScheduledUpdate
object
2 properties 1 required
Video
object
37 properties
username
string
immutable name of the user, used to find or mention its actor
LiveSchedule
object
1 property
ActorImage
object
6 properties
VideoChannel
VideoPlaylistPrivacySet
integer
Video playlist privacy policy (see [/video-playlists/privacies](operation/getPlaylistPrivacyPolicies))
VideoLanguageSet
string
language id of the video (see [/videos/languages](operation/getLanguages))
shortUUID
string
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
VideoChannelSummary
object
6 properties
Follow
object
7 properties
VideoChannelSyncList
object
2 properties
UUIDv4
string
VideoPlaylist
object
16 properties
VideoPrivacySet
integer
privacy id of the video (see [/videos/privacies](operation/getVideoPrivacyPolicies))
VideoConstantNumber-Category
object
2 properties
NSFWFlag
integer
NSFW flags (can be combined using bitwise or operator) - 0 NONE - 1 VIOLENT - 2 EXPLICITSEX
VideoLicenceSet
integer
licence id of the video (see [/videos/licences](operation/getLicences))
AccountSummary
object
6 properties
VideoPlaylistPrivacyConstant
object
2 properties
VideoCategorySet
integer
category id of the video (see [/videos/categories](operation/getCategories))
Account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-accounts-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
PeerTube Job API
Where this information came from

This is an independent, third-party profile of PeerTube Accounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.