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 My User API

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

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

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

This API exposes 11 operations across 9 paths, and defines 42 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.

11 operations 9 paths 42 schemas 2 DELETE6 GET2 POST1 PUT

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 My User 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 11

Across 9 paths, the API surfaces 11 operations — 2 DELETE, 6 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

My User 11

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

GET
/api/v1/users/me
Get my user information
getUserInfo → 200
PUT
/api/v1/users/me
Update my user information
putUserInfo body → 204
DELETE
/api/v1/users/me
Delete my account
deleteMe → 204400401
GET
/api/v1/users/me/videos/imports
Get video imports of my user
8 params → 200
GET
/api/v1/users/me/video-quota-used
Get my user used quota
→ 200
GET
/api/v1/users/me/videos/{videoIdOrUUID}/rating
Get rate of my user for a video
1 param → 200
GET
/api/v1/users/me/videos
List videos of my user
26 params → 200
POST
/api/v1/users/me/new-feature-info/read
Mark feature info as read
body → 204
POST
/api/v1/users/me/avatar/pick
Update my user avatar
body → 200413
DELETE
/api/v1/users/me/avatar
Delete my avatar
→ 204
GET
/api/v1/users/me/abuses
List my abuses
getMyAbuses 5 params → 200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are Video (37 properties), User (35 properties), UpdateMe (20 properties), UserNotificationSettings (18 properties). Each schema is shown below with its type and property counts.

NotificationSettingValue
integer
Notification type. One of the following values, or a sum of multiple values: - 0 NONE - 1 WEB - 2 EMAIL
VideoImportsList
object
2 properties
VideoConstantNumber-Licence
object
2 properties
VideoStateConstant
object
2 properties
AbusePredefinedReasons
array
VideoConstantString-Language
object
2 properties
UserAdminFlags
integer
Admin flags for the user (None = 0, Bypass video blocklist = 1)
VideoListResponse
object
2 properties
Actor
object
10 properties
User
object
35 properties
NewFeatureInfoType
integer
Represent a new feature that can be displayed to inform users. One of the following values: - 1 CHANNELCOLLABORATION
Thumbnail
object
4 properties
AbuseStateSet
integer
The abuse state (Pending = 1, Rejected = 2, Accepted = 3)
UserRole
integer
The user role (Admin = 0, Moderator = 1, User = 2)
VideoImport
object
10 properties
VideoPrivacyConstant
object
2 properties
AbuseStateConstant
object
2 properties
id
integer
VideoScheduledUpdate
object
2 properties 1 required
UserNotificationSettings
object
18 properties
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
VideoLanguageSet
string
language id of the video (see [/videos/languages](operation/getLanguages))
password
string
shortUUID
string
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
NSFWPolicy
string
VideoChannelSummary
object
6 properties
UUIDv4
string
VideoPrivacySet
integer
privacy id of the video (see [/videos/privacies](operation/getVideoPrivacyPolicies))
VideoConstantNumber-Category
object
2 properties
UpdateMe
object
20 properties
NSFWFlag
integer
NSFW flags (can be combined using bitwise or operator) - 0 NONE - 1 VIOLENT - 2 EXPLICITSEX
Abuse
object
8 properties
VideoLicenceSet
integer
licence id of the video (see [/videos/licences](operation/getLicences))
VideoCategorySet
integer
category id of the video (see [/videos/categories](operation/getCategories))
AccountSummary
object
6 properties
GetMeVideoRating
object
2 properties 2 required
VideoImportStateConstant
object
2 properties
Account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-my-user-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts 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
Where this information came from

This is an independent, third-party profile of PeerTube My User 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.