PeerTube API Reference

Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.

API Endpoint

https://peertube.example.com/api/v1

Schemes: https

Version: 1.0.0-beta

Authentication

OAuth2

In the header: Authorization: Bearer mytoken

type

oauth2

flow

password

tokenUrl

https://peertube.example.com/api/v1/users/token

Accounts

GET /accounts/{name}

in path

The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

Account

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "displayName": "string",
  "id": "number",
  "uuid": "string",
  "url": "string",
  "name": "string",
  "host": "string",
  "followingCount": "number",
  "followersCount": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "avatar": {
    "path": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Accounts

GET /accounts/{name}/videos

in path

The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)

200 OK

Video

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "uuid": "string",
  "createdAt": "string",
  "publishedAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "number",
    "label": "string"
  },
  "licence": {
    "id": "number",
    "label": "string"
  },
  "language": {
    "id": "string",
    "label": "string"
  },
  "privacy": "string",
  "description": "string",
  "duration": "number",
  "isLocal": "boolean",
  "name": "string",
  "thumbnailPath": "string",
  "previewPath": "string",
  "embedPath": "string",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean",
  "account": {
    "name": "string",
    "displayName": "string",
    "url": "string",
    "host": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Accounts

GET /accounts

200 OK

Account

successful operation

type

Account

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "displayName": "string",
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
]

Config

GET /config

200 OK

ServerConfig

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "signup": {
    "allowed": "boolean"
  },
  "transcoding": {
    "enabledResolutions": [
      "number"
    ]
  },
  "avatar": {
    "file": {
      "size": {
        "max": "number"
      }
    },
    "extensions": [
      "string"
    ]
  },
  "video": {
    "file": {
      "extensions": [
        "string"
      ]
    }
  }
}

Feeds

GET /feeds/videos.{format}

format: string xml, atom, json xml

in path

The format expected (xml defaults to RSS 2.0, atom to ATOM 1.0 and json to JSON FEED 1.0

accountId: number

in query

The id of the local account to filter to (beware, users IDs and not actors IDs which will return empty feeds

accountName: string

in query

The name of the local account to filter to

200 OK

successful operation

Response Content-Types: application/atom+xml, application/rss+xml, application/json

Job

GET /jobs

state: string

in path

The state of the job

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

Job

successful operation

type

Job

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "state": "string",
    "category": "string",
    "handlerName": "string",
    "handlerInputData": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]


OAuth2

ServerFollowing

DELETE /server/following/{host}

host: string

in path

The host to unfollow

201 Created

successful operation

Response Content-Types: application/json


OAuth2

ServerFollowing

GET /server/followers

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

successful operation

type

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "follower": {
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "following": {
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "score": "number",
    "state": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]

ServerFollowing

GET /server/following

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

successful operation

type

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "follower": {
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "following": {
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "score": "number",
    "state": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
]

ServerFollowing

POST /server/following

undefined

Request Content-Types: application/json

Request Example

{
  "id": "number",
  "follower": {
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "following": {
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "score": "number",
  "state": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

User

POST /users

AddUser

User to create

Request Content-Types: application/json

Request Example

{
  "username": "string",
  "password": "string",
  "email": "string",
  "videoQuota": "string",
  "role": "string"
}

200 OK

AddUserResponse

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "uuid": "string"
}


OAuth2

User

GET /users

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

User

successful operation

type

User

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "username": "string",
    "email": "string",
    "displayNSFW": "boolean",
    "autoPlayVideo": "boolean",
    "role": "string",
    "videoQuota": "number",
    "createdAt": "string",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "videoChannels": [
      {
        "displayName": "string",
        "description": "string",
        "isLocal": "boolean",
        "ownerAccount": {
          "id": "number",
          "uuid": "string"
        }
      }
    ]
  }
]


OAuth2

User

DELETE /users/{id}

id: number

in path

The user id

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

User

GET /users/{id}

id: number

in path

The user id

200 OK

User

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "username": "string",
  "email": "string",
  "displayNSFW": "boolean",
  "autoPlayVideo": "boolean",
  "role": "string",
  "videoQuota": "number",
  "createdAt": "string",
  "account": {
    "displayName": "string",
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "videoChannels": [
    {
      "displayName": "string",
      "description": "string",
      "isLocal": "boolean",
      "ownerAccount": {
        "id": "number",
        "uuid": "string"
      }
    }
  ]
}


OAuth2

User

PUT /users/{id}

UpdateUser

undefined

id: number

in path

The user id

Request Content-Types: application/json

Request Example

{
  "id": "string",
  "email": "string",
  "videoQuota": "string",
  "role": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

User

GET /users/me

200 OK

User

successful operation

type

User

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "username": "string",
    "email": "string",
    "displayNSFW": "boolean",
    "autoPlayVideo": "boolean",
    "role": "string",
    "videoQuota": "number",
    "createdAt": "string",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "videoChannels": [
      {
        "displayName": "string",
        "description": "string",
        "isLocal": "boolean",
        "ownerAccount": {
          "id": "number",
          "uuid": "string"
        }
      }
    ]
  }
]


OAuth2

User

PUT /users/me

UpdateMe

undefined

Request Content-Types: application/json

Request Example

{
  "password": "string",
  "email": "string",
  "displayNSFW": "string",
  "autoPlayVideo": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

User

GET /users/me/video-quota-used

200 OK

successful operation

type

number

Response Content-Types: application/json

Response Example (200 OK)

"number"


OAuth2

User

GET /users/me/videos/{videoId}/rating

videoId: string

in path

The video id

200 OK

GetMeVideoRating

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "string",
  "rating": "number"
}


OAuth2

User

GET /users/me/videos

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

Video

successful operation

type

Video

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "uuid": "string",
    "createdAt": "string",
    "publishedAt": "string",
    "updatedAt": "string",
    "category": {
      "id": "number",
      "label": "string"
    },
    "licence": {
      "id": "number",
      "label": "string"
    },
    "language": {
      "id": "string",
      "label": "string"
    },
    "privacy": "string",
    "description": "string",
    "duration": "number",
    "isLocal": "boolean",
    "name": "string",
    "thumbnailPath": "string",
    "previewPath": "string",
    "embedPath": "string",
    "views": "number",
    "likes": "number",
    "dislikes": "number",
    "nsfw": "boolean",
    "account": {
      "name": "string",
      "displayName": "string",
      "url": "string",
      "host": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
]


OAuth2

User

POST /users/register

RegisterUser

undefined

Request Content-Types: application/json

Request Example

{
  "username": "string",
  "password": "string",
  "email": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json

User

POST /users/me/avatar/pick

avatarfile: file

in formData

The file to upload.

200 OK

Avatar

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "path": "string",
  "createdAt": "string",
  "updatedAt": "string"
}


OAuth2

Video

GET /videos

category: number

in query

category id of the video

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

Video

successful operation

type

Video

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "uuid": "string",
    "createdAt": "string",
    "publishedAt": "string",
    "updatedAt": "string",
    "category": {
      "id": "number",
      "label": "string"
    },
    "licence": {
      "id": "number",
      "label": "string"
    },
    "language": {
      "id": "string",
      "label": "string"
    },
    "privacy": "string",
    "description": "string",
    "duration": "number",
    "isLocal": "boolean",
    "name": "string",
    "thumbnailPath": "string",
    "previewPath": "string",
    "embedPath": "string",
    "views": "number",
    "likes": "number",
    "dislikes": "number",
    "nsfw": "boolean",
    "account": {
      "name": "string",
      "displayName": "string",
      "url": "string",
      "host": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
]

Video

GET /videos/categories

200 OK

successful operation

type

string[]

Response Content-Types: application/json

Response Example (200 OK)

[
  "string"
]

Video

GET /videos/licences

200 OK

successful operation

type

string[]

Response Content-Types: application/json

Response Example (200 OK)

[
  "string"
]

Video

GET /videos/languages

200 OK

successful operation

type

string[]

Response Content-Types: application/json

Response Example (200 OK)

[
  "string"
]

Video

GET /videos/privacies

200 OK

successful operation

type

string[]

Response Content-Types: application/json

Response Example (200 OK)

[
  "string"
]

Video

PUT /videos/{id}

id: string

in path

The video id or uuid

thumbnailfile: file

in formData

Video thumbnail file

previewfile: file

in formData

Video preview file

category: number

in formData

Video category

licence: number

in formData

Video licence

language: string

in formData

Video language

description: string

in formData

Video description

waitTranscoding: boolean

in formData

Whether or not we wait transcoding before publish the video

support: string

in formData

Text describing how to support the video uploader

nsfw: boolean

in formData

Whether or not this video contains sensitive content

in formData

Video name

tags: string[]

in formData

Video tags

commentsEnabled: boolean

in formData

Enable or disable comments for this video

privacy: string Public, Unlisted

in formData

Video privacy

scheduleUpdate: object

in formData

Schedule an update at a specific datetime

200 OK

Video

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "uuid": "string",
  "createdAt": "string",
  "publishedAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "number",
    "label": "string"
  },
  "licence": {
    "id": "number",
    "label": "string"
  },
  "language": {
    "id": "string",
    "label": "string"
  },
  "privacy": "string",
  "description": "string",
  "duration": "number",
  "isLocal": "boolean",
  "name": "string",
  "thumbnailPath": "string",
  "previewPath": "string",
  "embedPath": "string",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean",
  "account": {
    "name": "string",
    "displayName": "string",
    "url": "string",
    "host": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}


OAuth2

Video

GET /videos/{id}

id: string

in path

The video id or uuid

200 OK

Video

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "uuid": "string",
  "createdAt": "string",
  "publishedAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "number",
    "label": "string"
  },
  "licence": {
    "id": "number",
    "label": "string"
  },
  "language": {
    "id": "string",
    "label": "string"
  },
  "privacy": "string",
  "description": "string",
  "duration": "number",
  "isLocal": "boolean",
  "name": "string",
  "thumbnailPath": "string",
  "previewPath": "string",
  "embedPath": "string",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean",
  "account": {
    "name": "string",
    "displayName": "string",
    "url": "string",
    "host": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Video

DELETE /videos/{id}

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

Video

GET /videos/{id}/description

id: string

in path

The video id or uuid

200 OK

successful operation

type

string

Response Content-Types: application/json

Response Example (200 OK)

"string"

Video

POST /videos/{id}/views

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json

Video

POST /videos/upload

videofile: file

in formData

Video file

channelId: number

in formData

Channel id that will contain this video

thumbnailfile: file

in formData

Video thumbnail file

previewfile: file

in formData

Video preview file

category: number

in formData

Video category

licence: number

in formData

Video licence

language: string

in formData

Video language

description: string

in formData

Video description

waitTranscoding: boolean

in formData

Whether or not we wait transcoding before publish the video

support: string

in formData

Text describing how to support the video uploader

nsfw: boolean

in formData

Whether or not this video contains sensitive content

in formData

Video name

tags: string[]

in formData

Video tags

commentsEnabled: boolean

in formData

Enable or disable comments for this video

privacy: string Public, Unlisted

in formData

Video privacy

scheduleUpdate: object

in formData

Schedule an update at a specific datetime

200 OK

VideoUploadResponse

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "video": {
    "id": "number",
    "uuid": "string"
  }
}


OAuth2

VideoAbuse

GET /videos/abuse

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

VideoAbuse

successful operation

type

VideoAbuse

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "reason": "string",
    "reporterAccount": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    },
    "video": {
      "id": "number",
      "name": "string",
      "uuid": "string",
      "url": "string"
    },
    "createdAt": "string"
  }
]


OAuth2

VideoAbuse

POST /videos/{id}/abuse

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoBlacklist

POST /videos/{id}/blacklist

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoBlacklist

DELETE /videos/{id}/blacklist

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoBlacklist

GET /videos/blacklist

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

VideoBlacklist

successful operation

type

VideoBlacklist

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "name": "string",
    "uuid": "string",
    "description": "string",
    "duration": "number",
    "views": "number",
    "likes": "number",
    "dislikes": "number",
    "nsfw": "boolean"
  }
]


OAuth2

VideoChannel

GET /video-channels

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

VideoChannel

successful operation

type

VideoChannel

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "displayName": "string",
    "description": "string",
    "isLocal": "boolean",
    "ownerAccount": {
      "id": "number",
      "uuid": "string"
    }
  }
]

VideoChannel

POST /video-channels

VideoChannelInput

undefined

Request Content-Types: application/json

Request Example

{
  "name": "string",
  "description": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoChannel

GET /video-channels/{id}

id: string

in path

The video channel id or uuid

200 OK

VideoChannel

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "displayName": "string",
  "description": "string",
  "isLocal": "boolean",
  "ownerAccount": {
    "id": "number",
    "uuid": "string"
  }
}

VideoChannel

PUT /video-channels/{id}

VideoChannelInput

undefined

id: string

in path

The video channel id or uuid

Request Content-Types: application/json

Request Example

{
  "name": "string",
  "description": "string"
}

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoChannel

DELETE /video-channels/{id}

id: string

in path

The video channel id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoChannel

GET /video-channels/{id}/videos

id: string

in path

The video channel id or uuid

200 OK

Video

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "id": "number",
  "uuid": "string",
  "createdAt": "string",
  "publishedAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "number",
    "label": "string"
  },
  "licence": {
    "id": "number",
    "label": "string"
  },
  "language": {
    "id": "string",
    "label": "string"
  },
  "privacy": "string",
  "description": "string",
  "duration": "number",
  "isLocal": "boolean",
  "name": "string",
  "thumbnailPath": "string",
  "previewPath": "string",
  "embedPath": "string",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean",
  "account": {
    "name": "string",
    "displayName": "string",
    "url": "string",
    "host": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

VideoChannel

GET /accounts/{name}/video-channels

in path

The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for example)

200 OK

VideoChannel

successful operation

type

VideoChannel

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "displayName": "string",
    "description": "string",
    "isLocal": "boolean",
    "ownerAccount": {
      "id": "number",
      "uuid": "string"
    }
  }
]

VideoComment

GET /videos/{id}/comment-threads

id: string

in path

The video id or uuid

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

200 OK

CommentThreadResponse

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "total": "number",
  "data": [
    {
      "id": "number",
      "url": "string",
      "text": "string",
      "threadId": "number",
      "inReplyToCommentId": "number",
      "videoId": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "totalReplies": "number",
      "account": {
        "displayName": "string",
        "id": "number",
        "uuid": "string",
        "url": "string",
        "name": "string",
        "host": "string",
        "followingCount": "number",
        "followersCount": "number",
        "createdAt": "string",
        "updatedAt": "string",
        "avatar": {
          "path": "string",
          "createdAt": "string",
          "updatedAt": "string"
        }
      }
    }
  ]
}

VideoComment

POST /videos/{id}/comment-threads

id: string

in path

The video id or uuid

200 OK

CommentThreadPostResponse

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "comment": {
    "id": "number",
    "url": "string",
    "text": "string",
    "threadId": "number",
    "inReplyToCommentId": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "totalReplies": "number",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
}


OAuth2

VideoComment

GET /videos/{id}/comment-threads/{threadId}

id: string

in path

The video id or uuid

threadId: number

in path

The thread id (root comment id)

200 OK

VideoCommentThreadTree

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "comment": {
    "id": "number",
    "url": "string",
    "text": "string",
    "threadId": "number",
    "inReplyToCommentId": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "totalReplies": "number",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  },
  "children": [
    {
      "comment": {
        "id": "number",
        "url": "string",
        "text": "string",
        "threadId": "number",
        "inReplyToCommentId": "number",
        "videoId": "number",
        "createdAt": "string",
        "updatedAt": "string",
        "totalReplies": "number",
        "account": {
          "displayName": "string",
          "id": "number",
          "uuid": "string",
          "url": "string",
          "name": "string",
          "host": "string",
          "followingCount": "number",
          "followersCount": "number",
          "createdAt": "string",
          "updatedAt": "string",
          "avatar": {
            "path": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        }
      },
      "children": [
        {
          "comment": {
            "id": "number",
            "url": "string",
            "text": "string",
            "threadId": "number",
            "inReplyToCommentId": "number",
            "videoId": "number",
            "createdAt": "string",
            "updatedAt": "string",
            "totalReplies": "number",
            "account": {
              "id": "number",
              "uuid": "string",
              "url": "string",
              "name": "string",
              "host": "string",
              "followingCount": "number",
              "followersCount": "number",
              "createdAt": "string",
              "updatedAt": "string",
              "avatar": {
                "path": "string",
                "createdAt": "string",
                "updatedAt": "string"
              }
            }
          }
        }
      ]
    }
  ]
}

VideoComment

POST /videos/{id}/comments/{commentId}

id: string

in path

The video id or uuid

threadId: number

in path

The comment id

200 OK

CommentThreadPostResponse

successful operation

Response Content-Types: application/json

Response Example (200 OK)

{
  "comment": {
    "id": "number",
    "url": "string",
    "text": "string",
    "threadId": "number",
    "inReplyToCommentId": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "totalReplies": "number",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
}


OAuth2

VideoComment

DELETE /videos/{id}/comments/{commentId}

id: string

in path

The video id or uuid

threadId: number

in path

The comment id

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

VideoRate

PUT /videos/{id}/rate

id: string

in path

The video id or uuid

204 No Content

Successful operation

Response Content-Types: application/json


OAuth2

Search

GET /search/videos

start: number

in query

Offset

in query

Number of items

sort: string

in query

Sort column (-createdAt for example)

search: string

in query

String to search

200 OK

Video

successful operation

type

Video

Response Content-Types: application/json

Response Example (200 OK)

[
  {
    "id": "number",
    "uuid": "string",
    "createdAt": "string",
    "publishedAt": "string",
    "updatedAt": "string",
    "category": {
      "id": "number",
      "label": "string"
    },
    "licence": {
      "id": "number",
      "label": "string"
    },
    "language": {
      "id": "string",
      "label": "string"
    },
    "privacy": "string",
    "description": "string",
    "duration": "number",
    "isLocal": "boolean",
    "name": "string",
    "thumbnailPath": "string",
    "previewPath": "string",
    "embedPath": "string",
    "views": "number",
    "likes": "number",
    "dislikes": "number",
    "nsfw": "boolean",
    "account": {
      "name": "string",
      "displayName": "string",
      "url": "string",
      "host": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
]

Schema Definitions

VideoConstantNumber:

id: number
label: string

Example

{
  "id": "number",
  "label": "string"
}

VideoConstantString:

id: string
label: string

Example

{
  "id": "string",
  "label": "string"
}

VideoPrivacy: string

string Public, Unlisted, Private

Video:

id: number
uuid: string
createdAt: string
publishedAt: string
updatedAt: string
category: VideoConstantNumber
licence: VideoConstantNumber
language: VideoConstantString
privacy: VideoPrivacy
description: string
duration: number
isLocal: boolean
name: string
thumbnailPath: string
previewPath: string
embedPath: string
views: number
likes: number
dislikes: number
nsfw: boolean
account: object
name: string displayName: string url: string host: string avatar: Avatar

Example

{
  "id": "number",
  "uuid": "string",
  "createdAt": "string",
  "publishedAt": "string",
  "updatedAt": "string",
  "category": {
    "id": "number",
    "label": "string"
  },
  "licence": {
    "id": "number",
    "label": "string"
  },
  "language": {
    "id": "string",
    "label": "string"
  },
  "privacy": "string",
  "description": "string",
  "duration": "number",
  "isLocal": "boolean",
  "name": "string",
  "thumbnailPath": "string",
  "previewPath": "string",
  "embedPath": "string",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean",
  "account": {
    "name": "string",
    "displayName": "string",
    "url": "string",
    "host": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

VideoAbuse:

id: number
reason: string
reporterAccount: Account
video: object
id: number name: string uuid: string url: string
createdAt: string

Example

{
  "id": "number",
  "reason": "string",
  "reporterAccount": {
    "displayName": "string",
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "video": {
    "id": "number",
    "name": "string",
    "uuid": "string",
    "url": "string"
  },
  "createdAt": "string"
}

VideoBlacklist:

id: number
videoId: number
createdAt: string
updatedAt: string
name: string
uuid: string
description: string
duration: number
views: number
likes: number
dislikes: number
nsfw: boolean

Example

{
  "id": "number",
  "videoId": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "name": "string",
  "uuid": "string",
  "description": "string",
  "duration": "number",
  "views": "number",
  "likes": "number",
  "dislikes": "number",
  "nsfw": "boolean"
}

VideoChannel:

displayName: string
description: string
isLocal: boolean
ownerAccount: object
id: number uuid: string

Example

{
  "displayName": "string",
  "description": "string",
  "isLocal": "boolean",
  "ownerAccount": {
    "id": "number",
    "uuid": "string"
  }
}

VideoComment:

id: number
url: string
text: string
threadId: number
inReplyToCommentId: number
videoId: number
createdAt: string
updatedAt: string
totalReplies: number
account: Account

Example

{
  "id": "number",
  "url": "string",
  "text": "string",
  "threadId": "number",
  "inReplyToCommentId": "number",
  "videoId": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "totalReplies": "number",
  "account": {
    "displayName": "string",
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  }
}

Example

{
  "comment": {
    "id": "number",
    "url": "string",
    "text": "string",
    "threadId": "number",
    "inReplyToCommentId": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "totalReplies": "number",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  },
  "children": [
    {
      "comment": {
        "id": "number",
        "url": "string",
        "text": "string",
        "threadId": "number",
        "inReplyToCommentId": "number",
        "videoId": "number",
        "createdAt": "string",
        "updatedAt": "string",
        "totalReplies": "number",
        "account": {
          "displayName": "string",
          "id": "number",
          "uuid": "string",
          "url": "string",
          "name": "string",
          "host": "string",
          "followingCount": "number",
          "followersCount": "number",
          "createdAt": "string",
          "updatedAt": "string",
          "avatar": {
            "path": "string",
            "createdAt": "string",
            "updatedAt": "string"
          }
        }
      },
      "children": [
        {
          "comment": {
            "id": "number",
            "url": "string",
            "text": "string",
            "threadId": "number",
            "inReplyToCommentId": "number",
            "videoId": "number",
            "createdAt": "string",
            "updatedAt": "string",
            "totalReplies": "number",
            "account": {
              "displayName": "string",
              "id": "number",
              "uuid": "string",
              "url": "string",
              "name": "string",
              "host": "string",
              "followingCount": "number",
              "followersCount": "number",
              "createdAt": "string",
              "updatedAt": "string",
              "avatar": {
                "path": "string",
                "createdAt": "string",
                "updatedAt": "string"
              }
            }
          }
        }
      ]
    }
  ]
}

Avatar:

path: string
createdAt: string
updatedAt: string

Example

{
  "path": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

Actor:

id: number
uuid: string
url: string
name: string
host: string
followingCount: number
followersCount: number
createdAt: string
updatedAt: string
avatar: Avatar

Example

{
  "id": "number",
  "uuid": "string",
  "url": "string",
  "name": "string",
  "host": "string",
  "followingCount": "number",
  "followersCount": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "avatar": {
    "path": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Account:

Actor

displayName: string

Example

{
  "displayName": "string",
  "id": "number",
  "uuid": "string",
  "url": "string",
  "name": "string",
  "host": "string",
  "followingCount": "number",
  "followersCount": "number",
  "createdAt": "string",
  "updatedAt": "string",
  "avatar": {
    "path": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

User:

id: number
username: string
email: string
displayNSFW: boolean
autoPlayVideo: boolean
role: string User, Moderator, Administrator
videoQuota: number
createdAt: string
account: Account
videoChannels: VideoChannel
VideoChannel

Example

{
  "id": "number",
  "username": "string",
  "email": "string",
  "displayNSFW": "boolean",
  "autoPlayVideo": "boolean",
  "role": "string",
  "videoQuota": "number",
  "createdAt": "string",
  "account": {
    "displayName": "string",
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "videoChannels": [
    {
      "displayName": "string",
      "description": "string",
      "isLocal": "boolean",
      "ownerAccount": {
        "id": "number",
        "uuid": "string"
      }
    }
  ]
}

ServerConfig:

signup: object
allowed: boolean
transcoding: object
enabledResolutions: number[] number
avatar: object
file: object size: object max: number extensions: string[] string
video: object
file: object extensions: string[] string

Example

{
  "signup": {
    "allowed": "boolean"
  },
  "transcoding": {
    "enabledResolutions": [
      "number"
    ]
  },
  "avatar": {
    "file": {
      "size": {
        "max": "number"
      }
    },
    "extensions": [
      "string"
    ]
  },
  "video": {
    "file": {
      "extensions": [
        "string"
      ]
    }
  }
}

Follow:

id: number
follower: Actor
following: Actor
score: number
state: string pending, accepted
createdAt: string
updatedAt: string

Example

{
  "id": "number",
  "follower": {
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "following": {
    "id": "number",
    "uuid": "string",
    "url": "string",
    "name": "string",
    "host": "string",
    "followingCount": "number",
    "followersCount": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "avatar": {
      "path": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  },
  "score": "number",
  "state": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

Job:

id: number
state: string pending, processing, error, success
category: string transcoding, activitypub-http
handlerName: string
handlerInputData: string
createdAt: string
updatedAt: string

Example

{
  "id": "number",
  "state": "string",
  "category": "string",
  "handlerName": "string",
  "handlerInputData": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

AddUserResponse:

id: number
uuid: string

Example

{
  "id": "number",
  "uuid": "string"
}

VideoUploadResponse:

video: object
id: number uuid: string

Example

{
  "video": {
    "id": "number",
    "uuid": "string"
  }
}

CommentThreadResponse:

total: number
data: VideoComment
VideoComment

Example

{
  "total": "number",
  "data": [
    {
      "id": "number",
      "url": "string",
      "text": "string",
      "threadId": "number",
      "inReplyToCommentId": "number",
      "videoId": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "totalReplies": "number",
      "account": {
        "displayName": "string",
        "id": "number",
        "uuid": "string",
        "url": "string",
        "name": "string",
        "host": "string",
        "followingCount": "number",
        "followersCount": "number",
        "createdAt": "string",
        "updatedAt": "string",
        "avatar": {
          "path": "string",
          "createdAt": "string",
          "updatedAt": "string"
        }
      }
    }
  ]
}

CommentThreadPostResponse:

comment: VideoComment

Example

{
  "comment": {
    "id": "number",
    "url": "string",
    "text": "string",
    "threadId": "number",
    "inReplyToCommentId": "number",
    "videoId": "number",
    "createdAt": "string",
    "updatedAt": "string",
    "totalReplies": "number",
    "account": {
      "displayName": "string",
      "id": "number",
      "uuid": "string",
      "url": "string",
      "name": "string",
      "host": "string",
      "followingCount": "number",
      "followersCount": "number",
      "createdAt": "string",
      "updatedAt": "string",
      "avatar": {
        "path": "string",
        "createdAt": "string",
        "updatedAt": "string"
      }
    }
  }
}

AddUser:

username: string: The user username
password: string: The user password
email: string: The user email
videoQuota: string: The user videoQuota
role: string: The user role

Example

{
  "username": "string",
  "password": "string",
  "email": "string",
  "videoQuota": "string",
  "role": "string"
}

UpdateUser:

id: string: The user id
email: string: The updated email of the user
videoQuota: string: The updated videoQuota of the user
role: string: The updated role of the user

Example

{
  "id": "string",
  "email": "string",
  "videoQuota": "string",
  "role": "string"
}

UpdateMe:

password: string: Your new password
email: string: Your new email
displayNSFW: string: Your new displayNSFW
autoPlayVideo: string: Your new autoPlayVideo

Example

{
  "password": "string",
  "email": "string",
  "displayNSFW": "string",
  "autoPlayVideo": "string"
}

GetMeVideoRating:

id: string: Id of the video
rating: number: Rating of the video

Example

{
  "id": "string",
  "rating": "number"
}

RegisterUser:

username: string: The username of the user
password: string: The password of the user
email: string: The email of the user

Example

{
  "username": "string",
  "password": "string",
  "email": "string"
}

VideoChannelInput:

name: string
description: string

Example

{
  "name": "string",
  "description": "string"
}

Documentation by Spectacle