Models

VideoSummary

object

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

shortUUIDshortUUID

Show child attributes

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

shortUUID

Example

2y84q2MQUMWPbiEcxNXMgC

namestring

isLiveboolean

nsfwboolean

publishedAtstring<date-time>

thumbnailsArray<Thumbnail>

PeerTube >= 8.1 Array of thumbnails for the video

Show child attributes

fileUrlstring

widthinteger

heightinteger

aspectRatiostring

Example

16:9

channelVideoChannelSummary

Show child attributes

idid>= 1

Example

Same fields as id

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

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>

Example

{
  "name": "string",
  "isLive": true,
  "nsfw": true,
  "publishedAt": "2024-01-15T09:30:00Z",
  "thumbnails": [
    {
      "fileUrl": "string",
      "width": 0,
      "height": 0,
      "aspectRatio": "16:9"
    }
  ],
  "channel": {
    "id": 42,
    "name": "string",
    "displayName": "string",
    "url": "https://example.com",
    "host": "example.com",
    "avatars": [
      {
        "path": "string",
        "fileUrl": "string",
        "width": 0,
        "height": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z"
      }
    ]
  }
}

Docs by Sourcey