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

Accounts

GET /accounts/{name}

name
in path
string

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

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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

name
in path
string

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

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

Feeds

GET /feeds/videos.{format}

format
in path
string xml, atom, json xml

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

accountId
in query
number

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

accountName
in query
string

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

Job

GET /jobs

state
in path
string

The id of the account

start
in query
number

starting page

count
in query
number

(no description)

sort
in query
number

sorting

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

ServerFollowing

DELETE /server/following/{host}

host
in path
string

The host to unfollow

201 Created

successful operation

Response Content-Types: application/json
OAuth2
ServerFollowing

GET /server/followers

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

200 OK
Follow

successful operation

type
Follow
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
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

200 OK
Follow

successful operation

type
Follow
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

Follow

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

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
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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
in path
string

The user id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2
User

GET /users/{id}

id
in path
string

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
in path
string

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
in path
string

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
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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
in formData
file

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

Video

GET /videos

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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

GET /videos/search

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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

PUT /videos/{id}

id
in path
string

The video id

thumbnailfile
in formData
file

Video thumbnail file

previewfile
in formData
file

Video preview file

category
in formData
number

Video category

licence
in formData
number

Video licence

language
in formData
string

Video language

description
in formData
string

Video description

waitTranscoding
in formData
boolean

Whether or not we wait transcoding before publish the video

support
in formData
string

Text describing how to support the video uploader

nsfw
in formData
boolean

Whether or not this video contains sensitive content

name
in formData
string

Video name

tags
in formData
string[]

Video tags

commentsEnabled
in formData
boolean

Enable or disable comments for this video

privacy
in formData
string Public, Unlisted

Video privacy

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
in path
string

The video id

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
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2
Video

GET /videos/{id}/description

id
in path
string

The video id

200 OK

successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
"string"
Video

POST /videos/{id}/views

id
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
Video

POST /videos/upload

videofile
in formData
file

Video file

thumbnailfile
in formData
file

Video thumbnail file

previewfile
in formData
file

Video preview file

category
in formData
number

Video category

waitTranscoding
in formData
boolean

Whether or not we wait transcoding before publish the video

licence
in formData
number

Video licence

language
in formData
string

Video language

description
in formData
string

Video description

support
in formData
string

Text describing how to support the video uploader

channelId
in formData
number

Channel id that will contain this video

nsfw
in formData
boolean

Whether or not this video contains sensitive content

name
in formData
string

Video name

tags
in formData
string[]

Video tags

commentsEnabled
in formData
boolean

Enable or disable comments for this video

privacy
in formData
string Public, Unlisted, Private

Video privacy

200 OK
VideoUploadResponse

successful operation

Response Content-Types: application/json
Response Example (200 OK) 
{
  "video": {
    "id": "number",
    "uuid": "string"
  }
}
OAuth2

VideoAbuse

VideoAbuse

GET /videos/abuse

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2

VideoBlacklist

VideoBlacklist

POST /videos/{videoId}/blacklist

videoId
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2
VideoBlacklist

DELETE /videos/{videoId}/blacklist

videoId
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2
VideoBlacklist

GET /videos/blacklist

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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

VideoChannel

GET /video-channels

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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
in path
string

The video channel id

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
in path
string

The video channel id

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
in path
string

The video channel id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2
VideoChannel

GET /video-channels/{id}/videos

id
in path
string

The video channel id

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

name
in path
string

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

VideoComment

GET /videos/{videoId}/comment-threads

videoId
in path
string

The video id

start
in query
number

starting page

stop
in query
number

stopping page

sort
in query
number

sorting

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/{videoId}/comment-threads

videoId
in path
string

The video 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

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

videoId
in path
string

The video id

threadId
in path
string

The thread 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/{videoId}/comments/{commentId}

videoId
in path
string

The video id

commentId
in path
string

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/{videoId}/comments/{commentId}

videoId
in path
string

The video id

commentId
in path
string

The comment id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2

VideoRate

VideoRate

PUT /videos/{id}/rate

id
in path
string

The video id

204 No Content

successful operation

Response Content-Types: application/json
OAuth2

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"
    }
  }
}

VideoCommentThreadTree:

comment: VideoComment
children: VideoCommentThreadTree
VideoCommentThreadTree
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:

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