+ PeerTube
+ API Reference
+
-
PeerTube
- API Reference
-
Federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.
@@ -279,8 +295,45 @@
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"
+ }
+ }
+}
@@ -465,6 +607,17 @@
successful operation
+
@@ -580,12 +733,12 @@
- Job
-
+
Feeds
+
+
Job
+
+
+
+
+
+
+
+
+ GET
+ /jobs
+
+
+
+
+
+
+
+
state
+
+
in path
+
+ string
+
+
+
+
+
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
@@ -747,22 +998,16 @@
host
+
in path
+
+ string
+
+
-
-
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -808,60 +1075,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -961,60 +1221,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -1120,7 +1373,8 @@
- undefined
+
+
undefined
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
User
@@ -1285,6 +1561,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1307,60 +1605,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -1424,54 +1715,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "createdAt": "string",
- "publishedAt": "string",
- "updatedAt": "string",
- "category": {
- "id": "number",
- "label": "string"
- },
- "licence": {
- "id": "number",
- "label": "string"
- },
- "language": {
- "id": "number",
- "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"
- }
- }
- }
- ]
+ }
}
]
}
@@ -1481,6 +1728,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1504,22 +1773,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1566,22 +1851,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1728,7 +1985,8 @@
- undefined
+
+
undefined
id
+
in path
+
+ string
+
+
-
-
@@ -1792,6 +2044,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1829,6 +2103,17 @@
successful operation
@@ -1871,54 +2156,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "createdAt": "string",
- "publishedAt": "string",
- "updatedAt": "string",
- "category": {
- "id": "number",
- "label": "string"
- },
- "licence": {
- "id": "number",
- "label": "string"
- },
- "language": {
- "id": "number",
- "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"
- }
- }
- }
- ]
+ }
}
]
}
@@ -1928,6 +2169,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -1956,7 +2219,8 @@
- undefined
+
+
undefined
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2031,6 +2317,13 @@
successful operation
@@ -2047,6 +2340,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2070,22 +2385,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2148,60 +2479,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -2249,7 +2573,7 @@
"label": "string"
},
"language": {
- "id": "number",
+ "id": "string",
"label": "string"
},
"privacy": "string",
@@ -2282,6 +2606,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -2310,7 +2656,8 @@
- undefined
+
+
undefined
avatarfile
+
in formData
+
+ file
+
+
-
-
@@ -2430,6 +2771,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
Video
@@ -2453,60 +2816,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -2554,7 +2910,7 @@
"label":
"string"
},
"language": {
-
"id":
"number",
+
"id":
"string",
"label":
"string"
},
"privacy":
"string",
@@ -2620,6 +2976,13 @@
successful operation
+
type
+
+ string[]
+
+
+
@@ -2671,9 +3034,16 @@
successful operation
+
+
type
+
+ string[]
+
+
+
+
+
Response Content-Types:
application/json
@@ -2722,6 +3092,13 @@
successful operation
+
+
type
+
+ string[]
+
+
+
@@ -2773,6 +3150,13 @@
successful operation
+
type
+
+ string[]
+
+
+
@@ -2813,60 +3197,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -2914,7 +3291,7 @@
"label":
"string"
},
"language": {
-
"id":
"number",
+
"id":
"string",
"label":
"string"
},
"privacy":
"string",
@@ -2970,254 +3347,176 @@
id
+
in path
+
+ string
+
+
thumbnailfile
+
in formData
+
+ file
+
+
-
-
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[]
+
+
-
-
type
-
- string[]
-
-
-
commentsEnabled
+
in formData
+
+ boolean
+
+
Enable or disable comments for this video
-
-
privacy
+
in formData
+
+ string
+
+ Public,
+ Unlisted
+
+
+
-
-
type
-
- string
-
- Public,
- Unlisted
-
-
-
-
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3319,22 +3640,16 @@
id
+
in path
+
+ string
+
+
id
+
in path
+
+ string
+
+
-
-
@@ -3475,6 +3784,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -3498,22 +3829,16 @@
id
+
in path
+
+ string
+
+
successful operation
+
@@ -3570,22 +3902,16 @@
id
+
in path
+
+ string
+
+
videofile
+
in formData
+
+ file
+
+
-
-
thumbnailfile
+
in formData
+
+ file
+
+
-
-
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[]
+
+
-
-
type
-
- string[]
-
-
-
commentsEnabled
+
in formData
+
+ boolean
+
+
Enable or disable comments for this video
-
-
privacy
+
in formData
+
+ string
+
+ Public,
+ Unlisted,
+ Private
+
+
+
-
-
type
-
- string
-
- Public,
- Unlisted,
- Private
-
-
-
-
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoAbuse
@@ -3971,60 +4235,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -4091,6 +4348,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -4114,22 +4393,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoBlacklist
@@ -4177,22 +4472,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -4239,22 +4550,16 @@
videoId
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
@@ -4300,60 +4627,42 @@
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
successful operation
+
@@ -4406,9 +4726,31 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoChannel
-
@@ -4519,54 +4854,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "createdAt": "string",
- "publishedAt": "string",
- "updatedAt": "string",
- "category": {
- "id": "number",
- "label": "string"
- },
- "licence": {
- "id": "number",
- "label": "string"
- },
- "language": {
- "id": "number",
- "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"
- }
- }
- }
- ]
+ }
}
]
@@ -4575,7 +4866,7 @@
-
+
- undefined
+
+
undefined
@@ -4642,8 +4934,30 @@
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
@@ -4716,54 +5024,10 @@
"displayName":
"string",
"description":
"string",
"isLocal":
"boolean",
-
"owner": {
-
"name":
"string",
+
"ownerAccount": {
+
"id":
"number",
"uuid":
"string"
- },
-
"videos": [
- {
-
"id":
"number",
-
"uuid":
"string",
-
"createdAt":
"string",
-
"publishedAt":
"string",
-
"updatedAt":
"string",
-
"category": {
-
"id":
"number",
-
"label":
"string"
- },
-
"licence": {
-
"id":
"number",
-
"label":
"string"
- },
-
"language": {
-
"id":
"number",
-
"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"
- }
- }
- }
- ]
+ }
}
@@ -4771,7 +5035,7 @@
+
- undefined
+
+
undefined
@@ -4808,22 +5073,16 @@
id
+
in path
+
+ string
+
+
-
-
type
-
-
string
-
+
The video channel id
@@ -4860,8 +5119,30 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ GET
+ /accounts/{name}/video-channels
+
+
+
+
+
+
+
+
name
+
+
in path
+
+ string
+
+
+
+
+
+
+
+
+
+
+
+
Response Content-Types:
+ application/json
+
+
+ Response Example
+ (200 OK)
+
+ [
+ {
+ "displayName": "string",
+ "description": "string",
+ "isLocal": "boolean",
+ "ownerAccount": {
+ "id": "number",
+ "uuid": "string"
+ }
}
]
@@ -5076,79 +5446,55 @@
videoId
+
in path
+
+ string
+
+
-
-
start
+
in query
+
+ number
+
+
-
-
stop
+
in query
+
+ number
+
+
-
-
sort
+
in query
+
+ number
+
+
-
-
@@ -5241,22 +5587,16 @@
videoId
+
in path
+
+ string
+
+
-
-
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
threadId
+
in path
+
+ string
+
+
-
-
@@ -5534,42 +5884,30 @@
videoId
+
in path
+
+ string
+
+
-
-
commentId
+
in path
+
+ string
+
+
-
-
@@ -5636,6 +5974,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
commentId
+
in path
+
+ string
+
+
-
-
@@ -5718,6 +6066,28 @@
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
VideoRate
@@ -5742,22 +6112,16 @@
id
+
in path
+
+ string
+
+
+
+
+
+
+
+ |
+ |
+
+
+
+
+ |
+ OAuth2
+ |
+ |
+
+
+
+
+
+
Schema Definitions
-
+
- VideoConstant:
+ VideoConstantNumber:
+
+
+
+
+ VideoConstantString:
+
+
+
+
+
+
+ -
+ id:
+ string
+
+
+ -
+ label:
+ string
+
+
+
+
+
+
@@ -6002,7 +6462,7 @@
"label":
"string"
},
"language": {
-
"id":
"number",
+
"id":
"string",
"label":
"string"
},
"privacy":
"string",
@@ -6072,6 +6532,32 @@
object
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ name:
+ string
+
+
+ -
+ uuid:
+ string
+
+
+ -
+ url:
+ string
+
+
+
+
+
createdAt:
string
@@ -6244,19 +6730,26 @@
boolean
-
- owner:
+
+ ownerAccount:
object
-
- videos:
-
-
- Video
-
-
-
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
@@ -6268,54 +6761,10 @@
"displayName": "string",
"description": "string",
"isLocal": "boolean",
- "owner": {
- "name": "string",
+ "ownerAccount": {
+ "id": "number",
"uuid": "string"
- },
- "videos": [
- {
- "id": "number",
- "uuid": "string",
- "createdAt": "string",
- "publishedAt": "string",
- "updatedAt": "string",
- "category": {
- "id": "number",
- "label": "string"
- },
- "licence": {
- "id": "number",
- "label": "string"
- },
- "language": {
- "id": "number",
- "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"
- }
- }
- }
- ]
+ }
}
@@ -6461,6 +6910,17 @@
+
+
+
@@ -6841,6 +7301,17 @@
+
+
+
+ -
+ allowed:
+ boolean
+
+
+
+
+
transcoding:
object
+
+
+
+ -
+ enabledResolutions:
+ number[]
+
+
+ -
+
+
+
+
+
avatar:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ size:
+ object
+
+
+ -
+
+
+ -
+ max:
+ number
+
+
+
+
+
+
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
video:
object
+
+
+
+ -
+ file:
+ object
+
+
+ -
+
+
+ -
+ extensions:
+ string[]
+
+
+ -
+
+
+
+
+
+
+
+
@@ -7254,6 +7784,22 @@
object
+
+
+
+ -
+ id:
+ number
+
+
+ -
+ uuid:
+ string
+
+
+
+
+
@@ -7299,6 +7845,17 @@
+
+
+