+ PeerTube
+ API Reference
+
-
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:
- 0.0.15-alpha
+ 1.0.0-beta
+
+ Authentication
+
+
+
+
+ OAuth2
+
+
+
+ In the header:
+ Authorization: Bearer mytoken
+
+
+
+
+
+
+
+
https://peertube.example.com/api/v1/users/token
+
+
+
+
+
Accounts
-
+
+
+
+
+
+
+
+
+ GET
+ /accounts/{name}/videos
+
+
+
+
+
+
+
+
name
+
+
in path
+
+ string
+
+
+
+
+
+
+
+
+
+
+
+
+
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"
+ }
+ }
+}
@@ -457,6 +607,17 @@
successful operation
+
@@ -572,12 +733,12 @@
- Job
-
+
Feeds
+
-
ServerFollowing
-
+
Job
+
- DELETE
- /server/following/{host}
+ GET
+ /jobs
@@ -737,23 +843,170 @@
-
host
+
state
+
in path
+
+ string
+
+
-
The host to unfollow
+
The id of the account
+
+
+
+
+
start
+
in query
+
+ number
+
+
+
+
+
+
+
+
count
+
in query
+
+ number
+
+
+
+
+
+
+
+
sort
+
in query
+
+ number
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+
+
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
+
+
in path
+
+ string
+
+
+
+
@@ -778,6 +1031,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -800,60 +1075,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -875,6 +1132,17 @@
successful operation
+
@@ -953,60 +1221,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -1028,6 +1278,17 @@
successful operation
+
@@ -1112,7 +1373,8 @@
- undefined
+
+
undefined
@@ -1187,6 +1449,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
User
@@ -1216,7 +1500,8 @@
- undefined
+
+
User to create
@@ -1276,6 +1561,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1298,60 +1605,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -1373,6 +1662,17 @@
successful operation
+
@@ -1415,37 +1715,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -1455,7 +1728,29 @@
-
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
@@ -1478,22 +1773,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -1517,6 +1806,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1540,22 +1851,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -1618,37 +1923,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -1657,6 +1935,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1685,7 +1985,8 @@
- undefined
+
+
undefined
@@ -1695,22 +1996,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -1749,6 +2044,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1786,6 +2103,17 @@
successful operation
+
@@ -1828,37 +2156,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -1868,6 +2169,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1896,7 +2219,8 @@
- undefined
+
+
undefined
@@ -1938,6 +2262,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1971,6 +2317,13 @@
successful operation
+
@@ -1987,6 +2340,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2010,22 +2385,16 @@
videoId
+
in path
+
+ string
+
+
-
-
@@ -2066,6 +2435,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2088,60 +2479,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -2163,6 +2536,17 @@
successful operation
+
@@ -2177,27 +2561,44 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"views": "number",
"likes": "number",
"dislikes": "number",
- "nsfw": "boolean"
+ "nsfw": "boolean",
+ "account": {
+ "name": "string",
+ "displayName": "string",
+ "url": "string",
+ "host": "string",
+ "avatar": {
+ "path": "string",
+ "createdAt": "string",
+ "updatedAt": "string"
+ }
+ }
}
]
@@ -2205,6 +2606,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2233,7 +2656,8 @@
- undefined
+
+
undefined
@@ -2296,22 +2720,16 @@
avatarfile
+
in formData
+
+ file
+
+
-
-
@@ -2353,6 +2771,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
Video
@@ -2376,60 +2816,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -2451,6 +2873,17 @@
successful operation
+
@@ -2465,27 +2898,44 @@
{
"id":
"number",
"uuid":
"string",
-
"accountName":
"string",
"createdAt":
"string",
+
"publishedAt":
"string",
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
+
"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",
-
"serverHost":
"string",
"thumbnailPath":
"string",
"previewPath":
"string",
"embedPath":
"string",
"views":
"number",
"likes":
"number",
"dislikes":
"number",
-
"nsfw":
"boolean"
+
"nsfw":
"boolean",
+
"account": {
+
"name":
"string",
+
"displayName":
"string",
+
"url":
"string",
+
"host":
"string",
+
"avatar": {
+
"path":
"string",
+
"createdAt":
"string",
+
"updatedAt":
"string"
+ }
+ }
}
]
@@ -2526,6 +2976,13 @@
successful operation
+
+
type
+
+ string[]
+
+
+
@@ -2577,6 +3034,13 @@
successful operation
+
+
type
+
+ string[]
+
+
+
@@ -2628,6 +3092,13 @@
successful operation
+
+
type
+
+ string[]
+
+
+
@@ -2679,9 +3150,16 @@
successful operation
-
-
-
+
+
type
+
+ string[]
+
+
+
+
+
+
Response Content-Types:
application/json
@@ -2719,60 +3197,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -2794,6 +3254,17 @@
successful operation
+
@@ -2808,27 +3279,44 @@
{
"id":
"number",
"uuid":
"string",
-
"accountName":
"string",
"createdAt":
"string",
+
"publishedAt":
"string",
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
+
"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",
-
"serverHost":
"string",
"thumbnailPath":
"string",
"previewPath":
"string",
"embedPath":
"string",
"views":
"number",
"likes":
"number",
"dislikes":
"number",
-
"nsfw":
"boolean"
+
"nsfw":
"boolean",
+
"account": {
+
"name":
"string",
+
"displayName":
"string",
+
"url":
"string",
+
"host":
"string",
+
"avatar": {
+
"path":
"string",
+
"createdAt":
"string",
+
"updatedAt":
"string"
+ }
+ }
}
]
@@ -2859,21 +3347,175 @@
id
+
in path
+
+ string
+
+
-
The video id
+
The video id
-
-
type
+
+
+
thumbnailfile
+
in formData
+
+ file
+
+
+
-
string
-
+
Video thumbnail file
-
-
in
-
path
+
+
+
previewfile
+
in formData
+
+ file
+
+
+
+
+
+
+
+
category
+
in formData
+
+ number
+
+
+
+
+
+
+
+
licence
+
in formData
+
+ number
+
+
+
+
+
+
+
+
language
+
in formData
+
+ string
+
+
+
+
+
+
+
+
description
+
in formData
+
+ string
+
+
+
+
+
+
+
+
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
+
+
+
+
+
+
+
+
tags
+
in formData
+
+ string[]
+
+
+
+
+
+
+
+
commentsEnabled
+
in formData
+
+ boolean
+
+
+
+
+
Enable or disable comments for this video
+
+
+
+
+
privacy
+
in formData
+
+ string
+
+ Public,
+ Unlisted
+
+
+
+
+
@@ -2909,33 +3551,72 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"views": "number",
"likes": "number",
"dislikes": "number",
- "nsfw": "boolean"
+ "nsfw": "boolean",
+ "account": {
+ "name": "string",
+ "displayName": "string",
+ "url": "string",
+ "host": "string",
+ "avatar": {
+ "path": "string",
+ "createdAt": "string",
+ "updatedAt": "string"
+ }
+ }
}
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2959,22 +3640,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3009,27 +3684,44 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"views": "number",
"likes": "number",
"dislikes": "number",
- "nsfw": "boolean"
+ "nsfw": "boolean",
+ "account": {
+ "name": "string",
+ "displayName": "string",
+ "url": "string",
+ "host": "string",
+ "avatar": {
+ "path": "string",
+ "createdAt": "string",
+ "updatedAt": "string"
+ }
+ }
}
@@ -3059,22 +3751,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3098,6 +3784,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3121,22 +3829,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3154,6 +3856,13 @@
successful operation
+
@@ -3193,22 +3902,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3254,21 +3957,196 @@
videofile
+
+
in formData
+
+ file
+
+
-
The file to upload.
+
Video file
-
-
type
+
+
+
thumbnailfile
+
+
in formData
+
+ file
+
+
+
-
file
-
+
Video thumbnail file
-
-
in
-
formData
+
+
+
previewfile
+
+
in formData
+
+ file
+
+
+
+
+
+
+
+
category
+
in formData
+
+ number
+
+
+
+
+
+
+
+
licence
+
in formData
+
+ number
+
+
+
+
+
+
+
+
language
+
in formData
+
+ string
+
+
+
+
+
+
+
+
description
+
in formData
+
+ string
+
+
+
+
+
+
+
+
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
+
+
+
+
+
+
+
+
tags
+
in formData
+
+ string[]
+
+
+
+
+
+
+
+
commentsEnabled
+
in formData
+
+ boolean
+
+
+
+
+
Enable or disable comments for this video
+
+
+
+
+
privacy
+
+
in formData
+
+ string
+
+ Public,
+ Unlisted,
+ Private
+
+
+
+
+
@@ -3302,14 +4180,38 @@
(200 OK)
{
- "id": "number",
- "uuid": "string"
+ "video": {
+ "id": "number",
+ "uuid": "string"
+ }
}
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoAbuse
@@ -3333,60 +4235,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -3408,6 +4292,17 @@
successful operation
+
@@ -3422,11 +4317,29 @@
{
"id": "number",
"reason": "string",
- "reporterUsername": "string",
- "reporterServerHost": "string",
- "videoId": "number",
- "videoUUID": "string",
- "videoName": "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"
}
]
@@ -3435,6 +4348,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3458,22 +4393,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -3497,6 +4426,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoBlacklist
@@ -3521,22 +4472,16 @@
videoId
+
in path
+
+ string
+
+
-
-
@@ -3560,6 +4505,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3583,22 +4550,16 @@
videoId
+
in path
+
+ string
+
+
-
-
@@ -3622,6 +4583,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3644,60 +4627,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -3719,6 +4684,17 @@
successful operation
+
@@ -3750,9 +4726,31 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoChannel
-
@@ -3863,37 +4854,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
@@ -3902,7 +4866,7 @@
-
+
- undefined
+
+
undefined
@@ -3969,8 +4934,30 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
-
+
@@ -4043,45 +5024,125 @@
"displayName":
"string",
"description":
"string",
"isLocal":
"boolean",
-
"owner": {
-
"name":
"string",
+
"ownerAccount": {
+
"id":
"number",
"uuid":
"string"
- },
-
"videos": [
- {
-
"id":
"number",
-
"uuid":
"string",
-
"accountName":
"string",
-
"createdAt":
"string",
-
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
-
"description":
"string",
-
"duration":
"number",
-
"isLocal":
"boolean",
-
"name":
"string",
-
"serverHost":
"string",
-
"thumbnailPath":
"string",
-
"previewPath":
"string",
-
"embedPath":
"string",
-
"views":
"number",
-
"likes":
"number",
-
"dislikes":
"number",
-
"nsfw":
"boolean"
- }
- ]
+ }
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ PUT
+ /video-channels/{id}
+
+
+
+
+
+
+
+
+
id
+
+
in path
+
+ string
+
+
+
+
+
+
+
+
+
+ Request Content-Types:
+ application/json
+
+ Request Example
+ {
+ "name": "string",
+ "description": "string"
}
+
+
+
+
Response Content-Types:
+ application/json
+
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
-
+
-
+
@@ -4218,7 +5261,13 @@
-
204 No Content
+
200 OK
+
+
successful operation
@@ -4230,10 +5279,59 @@
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"
+ }
+ }
+}
+
+
+
-
@@ -4307,37 +5411,10 @@
"displayName":
"string",
"description":
"string",
"isLocal":
"boolean",
-
"owner": {
-
"name":
"string",
+
"ownerAccount": {
+
"id":
"number",
"uuid":
"string"
- },
-
"videos": [
- {
-
"id":
"number",
-
"uuid":
"string",
-
"accountName":
"string",
-
"createdAt":
"string",
-
"updatedAt":
"string",
-
"categoryLabel":
"string",
-
"category":
"number",
-
"licenceLabel":
"string",
-
"licence":
"number",
-
"languageLabel":
"string",
-
"language":
"number",
-
"description":
"string",
-
"duration":
"number",
-
"isLocal":
"boolean",
-
"name":
"string",
-
"serverHost":
"string",
-
"thumbnailPath":
"string",
-
"previewPath":
"string",
-
"embedPath":
"string",
-
"views":
"number",
-
"likes":
"number",
-
"dislikes":
"number",
-
"nsfw":
"boolean"
- }
- ]
+ }
}
]
@@ -4369,79 +5446,55 @@
videoId
+
in path
+
+ string
+
+
-
-
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
-
type
-
-
number
-
+
stopping page
-
sort
+
in query
+
+ number
+
+
-
-
@@ -4534,22 +5587,16 @@
videoId
+
in path
+
+ string
+
+
-
-
@@ -4616,6 +5663,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
-
-
threadId
+
in path
+
+ string
+
+
-
-
@@ -4827,42 +5884,30 @@
videoId
+
in path
+
+ string
+
+
-
-
commentId
+
in path
+
+ string
+
+
-
-
@@ -4929,6 +5974,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
-
-
commentId
+
in path
+
+ string
+
+
-
-
@@ -5011,6 +6066,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoRate
@@ -5035,22 +6112,16 @@
id
+
in path
+
+ string
+
+
-
-
@@ -5074,8 +6145,133 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+
+ 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:
@@ -5099,49 +6295,55 @@
string
-
- accountName:
- string
-
-
createdAt:
string
-
- updatedAt:
+
+ publishedAt:
string
-
- categoryLabel:
+
+ updatedAt:
string
category:
- number
-
-
-
- licenceLabel:
- string
+
+
+ VideoConstantNumber
+
+
licence:
- number
-
-
-
- languageLabel:
- string
+
+
+ VideoConstantNumber
+
+
language:
- number
+
+
+ VideoConstantString
+
+
+
+
+
+ privacy:
+
+
+ VideoPrivacy
+
+
@@ -5164,11 +6366,6 @@
string
-
- serverHost:
- string
-
-
thumbnailPath:
string
@@ -5204,6 +6401,46 @@
boolean
+
+ account:
+ object
+
+
+
+
+
+ -
+ name:
+ string
+
+
+ -
+ displayName:
+ string
+
+
+ -
+ url:
+ string
+
+
+ -
+ host:
+ string
+
+
+ -
+ avatar:
+
+
+ Avatar
+
+
+
+
+
+
+
@@ -5213,27 +6450,44 @@
{
"id": "number",
"uuid": "string",
- "accountName": "string",
"createdAt": "string",
+ "publishedAt": "string",
"updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
+ "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",
- "serverHost": "string",
"thumbnailPath": "string",
"previewPath": "string",
"embedPath": "string",
"views": "number",
"likes": "number",
"dislikes": "number",
- "nsfw": "boolean"
+ "nsfw": "boolean",
+ "account": {
+ "name": "string",
+ "displayName": "string",
+ "url": "string",
+ "host": "string",
+ "avatar": {
+ "path": "string",
+ "createdAt": "string",
+ "updatedAt": "string"
+ }
+ }
}
@@ -5264,30 +6518,45 @@
string
-
- reporterUsername:
- string
-
-
-
- reporterServerHost:
- string
-
-
-
- videoId:
- number
+
+ reporterAccount:
+
+
+ Account
+
+
-
- videoUUID:
- string
+
+ video:
+ object
-
- videoName:
- string
-
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ name:
+ string
+
+
+ -
+ uuid:
+ string
+
+
+ -
+ url:
+ string
+
+
+
+
createdAt:
@@ -5303,11 +6572,29 @@
{
"id": "number",
"reason": "string",
- "reporterUsername": "string",
- "reporterServerHost": "string",
- "videoId": "number",
- "videoUUID": "string",
- "videoName": "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"
}
@@ -5443,19 +6730,26 @@
boolean
-
- owner:
+
+ ownerAccount:
object
-
- videos:
-
-
- Video
-
-
-
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
@@ -5467,37 +6761,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
@@ -5643,6 +6910,17 @@
+
+
+
@@ -6023,6 +7301,17 @@
+
+
+
@@ -6060,37 +7349,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "accountName": "string",
- "createdAt": "string",
- "updatedAt": "string",
- "categoryLabel": "string",
- "category": "number",
- "licenceLabel": "string",
- "licence": "number",
- "languageLabel": "string",
- "language": "number",
- "description": "string",
- "duration": "number",
- "isLocal": "boolean",
- "name": "string",
- "serverHost": "string",
- "thumbnailPath": "string",
- "previewPath": "string",
- "embedPath": "string",
- "views": "number",
- "likes": "number",
- "dislikes": "number",
- "nsfw": "boolean"
- }
- ]
+ }
}
]
}
@@ -6118,21 +7380,124 @@
object
+
+
+
+ -
+ allowed:
+ boolean
+
+
+
+
+
transcoding:
object
+
+
+
+ -
+ enabledResolutions:
+ number[]
+
+
+ -
+
+
+
+
+
avatar:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ size:
+ object
+
+
+ -
+
+
+ -
+ max:
+ number
+
+
+
+
+
+
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
video:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
+
+
+
@@ -6414,15 +7779,26 @@
- -
- id:
- number
+
-
+ video:
+ object
- -
- uuid:
- string
-
+
-
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
@@ -6431,8 +7807,10 @@
Example
{
- "id": "number",
- "uuid": "string"
+ "video": {
+ "id": "number",
+ "uuid": "string"
+ }
}
@@ -6467,6 +7845,17 @@
+
+
+