Video Comments

List instance comments

GET

https://peertube2.cpy.re/api/v1/videos/comments

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/comments' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/comments', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/comments',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "url": "https://example.com",
      "text": "This video is wonderful!",
      "heldForReview": true,
      "threadId": 42,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "account": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      },
      "video": {
        "name": "What is PeerTube?",
        "state": {
          "id": 1,
          "label": "string"
        }
      },
      "automaticTags": [
        "string"
      ]
    }
  ]
}

Parameters

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

searchAccountstringquery

Filter comments by searching on the account

searchVideostringquery

Filter comments by searching on the video

videoIdintegerquery

Limit results on this specific video

videoChannelIdintegerquery

Limit results on this specific video channel

autoTagOneOfstring | Array<string>query

PeerTube >= 6.2 filter on comments that contain one of these automatic tags

isLocalbooleanquery

PeerTube >= 4.0 Display only local or remote objects

onLocalVideobooleanquery

Display only objects of local or remote videos

includeMutedbooleanquery

PeerTube >= 8.2 Include comments from muted accounts

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoCommentForOwnerOrAdmin>

Show child attributes

idid>= 1

Example

urlurl<url>

texttext<html>

Text of the comment

Example

This video is wonderful!

heldForReviewheldForReview

threadIdid>= 1

Example

inReplyToCommentIdid | null

Show child attributes

id>= 1

Example

createdAtcreatedAt<date-time>

updatedAtupdatedAt<date-time>

accountActor & any

Show child attributes

idid>= 1

Example

Same fields as id

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

videoVideoInfo

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes

UUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

namename

title of the video

Example

What is PeerTube?

stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes

idid123456789101112131415

The video state:

1: Published
2: To transcode
3: To import
4: Waiting for live stream
5: Live ended
6: To move to an external storage (object storage...)
7: Transcoding failed
8: Moving to an external storage failed
9: To edit using studio edition feature
10: To move to the file system
11: Moving to the file system failed
12: Import failed
13: To duplicate, the files of another video are being copied
14: Duplication failed, the files of the other video could not be copied
15: The studio edition of a video saved as a new video failed

Same fields as id

labelstring

automaticTagsArray<string>

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin, moderator

Docs by Sourcey