Video Comments

List replies of a comment

GET

https://peertube2.cpy.re/api/v1/videos/{id}/comments/{commentId}/replies

PeerTube >= 8.3 List the direct replies of a comment, each of them nested up to maxDepth levels. Used to unfold the parts of a thread that GET /api/v1/videos/{id}/comment-threads/{threadId} truncated.

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/comments/42/replies?count=15&sort=createdAt&maxDepth=5&repliesPerLevel=10'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/comments/42/replies?count=15&sort=createdAt&maxDepth=5&repliesPerLevel=10', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/videos/42/comments/42/replies?count=15&sort=createdAt&maxDepth=5&repliesPerLevel=10')
print(response.text)

200

{
  "total": 13,
  "data": [
    {
      "comment": {
        "id": 42,
        "url": "https://example.com",
        "text": "This video is wonderful!",
        "threadId": 42,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "deletedAt": null,
        "isDeleted": false,
        "heldForReview": true,
        "totalRepliesFromVideoAuthor": 0,
        "totalReplies": 0,
        "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"
        }
      },
      "children": [],
      "totalChildren": 0
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

commentIdid>= 1requiredpath

The comment id

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringcreatedAt-createdAtcreatedAtquery

Sort the direct replies of the comment. Deeper levels of the tree are always sorted the same way. Defaults to createdAt so the replies are appended to the thread tree in the order it was built

maxDepthinteger[1, 10]5query

Number of nesting levels to include below the requested comment. Bounded by repliesPerLevel and count, see the note on repliesPerLevel

repliesPerLevelinteger[1, 30]10query

Number of direct replies to include for each comment of the tree. Does not apply to the first level of GET /api/v1/videos/{id}/comments/{commentId}/replies, which is paginated using start and count. A tree can make the server walk through count * (repliesPerLevel ^ maxDepth - 1) / (repliesPerLevel - 1) comments, which grows exponentially. Combinations above 2000000 are rejected A deep tree has to be narrow and a wide tree has to be shallow.

x-peertube-video-passwordstringheader

Required on password protected video

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Total number of direct replies of the comment

Example

dataArray<VideoCommentThreadTree>

Show child attributes

commentVideoComment

Show child attributes

idid>= 1

Example

urlurl<url>

texttext<html>

Text of the comment

Example

This video is wonderful!

threadIdid>= 1

Example

inReplyToCommentIdid | null

Show child attributes

id>= 1

Example

videoIdid

object id for the video

Show child attributes

id>= 1

Example

createdAtcreatedAt<date-time>

updatedAtupdatedAt<date-time>

deletedAtstring<date-time> | nullnull

isDeletedbooleanfalse

heldForReviewheldForReview

totalRepliesFromVideoAuthorinteger>= 0

totalRepliesinteger>= 0

accountActor & any

Show child attributes

idid>= 1

Example

Same fields as data.comment.videoId

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

childrenArray<VideoCommentThreadTree>

Direct replies of comment. The server truncates the tree in depth (see the maxDepth parameter) and in width, so this array may contain less elements than totalChildren. Missing replies can be fetched using GET /api/v1/videos/{id}/comments/{commentId}/replies

Same fields as data

totalChildreninteger>= 0

Total number of direct replies of comment the current user can see

Docs by Sourcey