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 Video Comments API

Operations dealing with comments to a video. Comments are organized in threads: adding a comment in response to the video starts a thread, adding a reply to a comment adds it to its root comment thread.

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

Tagged areas include Video Comments. 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 6 paths, and defines 16 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 6 paths 16 schemas 1 DELETE4 GET3 POST

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 Video Comments 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 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Video Comments 8

Operations dealing with comments to a video. Comments are organized in threads: adding a comment in response to the video starts a thread, adding a reply to a comment adds it to i…

GET
/api/v1/users/me/videos/comments
List comments on user's videos
8 params → 200
GET
/api/v1/videos/{id}/comment-threads
List threads of a video
5 params → 200
POST
/api/v1/videos/{id}/comment-threads
Create a thread
1 param body → 200404
GET
/api/v1/videos/{id}/comment-threads/{threadId}
Get a thread
3 params → 200
GET
/api/v1/videos/comments
List instance comments
9 params → 200
POST
/api/v1/videos/{id}/comments/{commentId}
Reply to a thread of a video
3 params body → 200404
DELETE
/api/v1/videos/{id}/comments/{commentId}
Delete a comment or a reply
2 params → 204403404409
POST
/api/v1/videos/{id}/comments/{commentId}/approve
Approve a comment
2 params → 204

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are VideoComment (14 properties), VideoCommentForOwnerOrAdmin (11 properties), Actor (10 properties), ActorImage (6 properties). Each schema is shown below with its type and property counts.

VideoComment
object
14 properties
VideoStateConstant
object
2 properties
Actor
object
10 properties
User
object
1 property
CommentThreadPostResponse
object
1 property
Video
object
4 properties
VideoInfo
object
4 properties
id
integer
username
string
immutable name of the user, used to find or mention its actor
ActorImage
object
6 properties
CommentThreadResponse
object
3 properties
shortUUID
string
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
VideoCommentForOwnerOrAdmin
object
11 properties
UUIDv4
string
VideoCommentThreadTree
object
2 properties
Account

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-video-comments-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 Video Comments 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.