Models

ChangeOwnership

object

Representation of a ownership change

idid>= 1

Example

stateany

Show child attributes

idChangeOwnershipState123

The ownership change state (Pending = 1, Rejected = 2, Accepted = 3)

labelstring

initiatorAccountActor & any

Show child attributes

idid>= 1

Example

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

nextOwnerAccountActor & any

Show child attributes

idid>= 1

Example

Same fields as initiatorAccount.userId

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

videoVideoSummary

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

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 initiatorAccount.userId

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>

videoChannelVideoChannelSummary

Show child attributes

idid>= 1

Example

Same fields as initiatorAccount.userId

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>

createdAtstring<date-time>

Example

{
  "id": 42,
  "state": {
    "id": 1,
    "label": "string"
  },
  "initiatorAccount": {
    "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"
  },
  "nextOwnerAccount": {
    "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": "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"
        }
      ]
    }
  },
  "videoChannel": {
    "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"
      }
    ]
  },
  "createdAt": "2024-01-15T09:30:00Z"
}

Docs by Sourcey