openapi: 3.0.0
info:
title: PeerTube
- version: 1.1.0
+ version: 1.3.0
contact:
name: PeerTube Community
url: 'https://joinpeertube.org'
# Authentication
When you sign up for an account, you are given the possibility to generate
- sessions, and authenticate using this session token. One session token can
+ sessions, and authenticate using this session token. One session token can
currently be used at a time.
# Errors
}
```
externalDocs:
- url: https://docs.joinpeertube.org/api.html
+ url: https://docs.joinpeertube.org/#/api-rest-reference.html
tags:
- name: Accounts
description: >
description: >
Managing servers which the instance interacts with is crucial to the
concept of federation in PeerTube and external video indexation. The PeerTube
- server then deals with inter-server ActivityPub operations and propagates
+ server then deals with inter-server ActivityPub operations and propagates
information across its social graph by posting activities to actors' inbox
endpoints.
- name: Video Abuse
- name: Videos
tags:
- Video
+ - Video Caption
- Video Channel
- Video Comment
- Video Following
content:
application/json:
schema:
- $ref: '#/components/schemas/Video'
+ $ref: '#/components/schemas/VideoListResponse'
x-code-samples:
- lang: JavaScript
source: |
get:
summary: Get current user information
security:
- - OAuth2: []
+ - OAuth2:
+ - user
tags:
- User
responses:
put:
summary: Update current user information
security:
- - OAuth2: []
+ - OAuth2:
+ - user
tags:
- User
responses:
get:
summary: Get current user used quota
security:
- - OAuth2: []
+ - OAuth2:
+ - user
tags:
- User
responses:
get:
summary: Get videos of the current user
security:
- - OAuth2: []
+ - OAuth2:
+ - user
tags:
- User
parameters:
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/Video'
+ $ref: '#/components/schemas/VideoListResponse'
+ /users/me/subscriptions:
+ get:
+ summary: Get subscriptions of the current user
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ parameters:
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
+ responses:
+ '200':
+ description: successful operation
+ post:
+ summary: Add subscription to the current user
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ responses:
+ '200':
+ description: successful operation
+ /users/me/subscriptions/exist:
+ get:
+ summary: Get if subscriptions exist for the current user
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ parameters:
+ - $ref: '#/components/parameters/subscriptionsUris'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ /users/me/subscriptions/videos:
+ get:
+ summary: Get videos of subscriptions of the current user
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ parameters:
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoListResponse'
+ '/users/me/subscriptions/{uri}':
+ get:
+ summary: Get subscription of the current user for a given uri
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoChannel'
+ delete:
+ summary: Delete subscription of the current user for a given uri
+ security:
+ - OAuth2:
+ - user
+ tags:
+ - User
+ responses:
+ '200':
+ description: successful operation
/users/register:
post:
summary: Register a user
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/Video'
+ $ref: '#/components/schemas/VideoListResponse'
/videos/categories:
get:
summary: Get list of video licences known by the server
description: Video name
type: string
tags:
- description: Video tags
- type: string
+ description: Video tags (maximum 5 tags each between 2 and 30 characters)
+ type: array
+ items:
+ type: string
commentsEnabled:
description: Enable or disable comments for this video
type: string
$ref: '#/paths/~1users~1me/put/responses/204'
'/videos/{id}/watching':
put:
- summary: Indicate progress of in watching the video by its id for a user
+ summary: Set watching progress of a video by its id for a user
tags:
- Video
security:
description: Video preview file
type: string
privacy:
- $ref: '#/components/schemas/VideoPrivacy'
+ $ref: '#/components/schemas/VideoPrivacySet'
category:
description: Video category
type: string
type: string
tags:
description: Video tags
- type: string
+ type: array
+ items:
+ type: string
commentsEnabled:
description: Enable or disable comments for this video
type: string
channelId=$CHANNEL_ID \
name=$NAME \
"Authorization:Bearer $token"
+ /videos/imports:
+ post:
+ summary: Import a torrent or magnetURI or HTTP ressource (if enabled by the instance administrator)
+ security:
+ - OAuth2: []
+ tags:
+ - Video
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoUploadResponse'
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ torrentfile:
+ description: Torrent File
+ type: string
+ format: binary
+ targetUrl:
+ description: HTTP target URL
+ type: string
+ magnetUri:
+ description: Magnet URI
+ type: string
+ channelId:
+ description: Channel id that will contain this video
+ type: number
+ thumbnailfile:
+ description: Video thumbnail file
+ type: string
+ previewfile:
+ description: Video preview file
+ type: string
+ privacy:
+ $ref: '#/components/schemas/VideoPrivacySet'
+ category:
+ description: Video category
+ type: string
+ licence:
+ description: Video licence
+ type: string
+ language:
+ description: Video language
+ type: string
+ description:
+ description: Video description
+ type: string
+ waitTranscoding:
+ description: Whether or not we wait transcoding before publish the video
+ type: string
+ support:
+ description: Text describing how to support the video uploader
+ type: string
+ nsfw:
+ description: Whether or not this video contains sensitive content
+ type: string
+ name:
+ description: Video name
+ type: string
+ tags:
+ description: Video tags
+ type: array
+ items:
+ type: string
+ commentsEnabled:
+ description: Enable or disable comments for this video
+ type: string
+ scheduleUpdate: *ref_0
+ required:
+ - channelId
+ - name
/videos/abuse:
get:
summary: Get list of reported video abuses
type: array
items:
$ref: '#/components/schemas/VideoBlacklist'
+ /videos/{id}/captions:
+ get:
+ summary: Get list of video's captions
+ tags:
+ - Video Caption
+ parameters:
+ - $ref: '#/components/parameters/id2'
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: object
+ properties:
+ total:
+ type: integer
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/VideoCaption'
+ /videos/{id}/captions/{captionLanguage}:
+ put:
+ summary: Add or replace a video caption
+ tags:
+ - Video Caption
+ parameters:
+ - $ref: '#/components/parameters/id2'
+ - $ref: '#/components/parameters/captionLanguage'
+ requestBody:
+ content:
+ multipart/form-data:
+ schema:
+ type: object
+ properties:
+ captionfile:
+ description: The file to upload.
+ type: string
+ format: binary
+ responses:
+ '204':
+ $ref: '#/paths/~1users~1me/put/responses/204'
+ delete:
+ summary: Delete a video caption
+ tags:
+ - Video Caption
+ parameters:
+ - $ref: '#/components/parameters/id2'
+ - $ref: '#/components/parameters/captionLanguage'
+ responses:
+ '204':
+ $ref: '#/paths/~1users~1me/put/responses/204'
/video-channels:
get:
summary: Get list of video channels
'204':
$ref: '#/paths/~1users~1me/put/responses/204'
requestBody:
- $ref: '#/components/requestBodies/VideoChannelInput'
- '/video-channels/{id}':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoChannelCreate'
+ '/video-channels/{channelHandle}':
get:
summary: Get a video channel by its id
tags:
- Video Channel
parameters:
- - $ref: '#/components/parameters/id3'
+ - $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
tags:
- Video Channel
parameters:
- - $ref: '#/components/parameters/id3'
+ - $ref: '#/components/parameters/channelHandle'
responses:
'204':
$ref: '#/paths/~1users~1me/put/responses/204'
requestBody:
- $ref: '#/components/requestBodies/VideoChannelInput'
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/VideoChannelUpdate'
delete:
summary: Delete a video channel by its id
security:
tags:
- Video Channel
parameters:
- - $ref: '#/components/parameters/id3'
+ - $ref: '#/components/parameters/channelHandle'
responses:
'204':
$ref: '#/paths/~1users~1me/put/responses/204'
- '/video-channels/{id}/videos':
+ '/video-channels/{channelHandle}/videos':
get:
summary: Get videos of a video channel by its id
tags:
+ - Video
- Video Channel
parameters:
- - $ref: '#/components/parameters/id3'
+ - $ref: '#/components/parameters/channelHandle'
responses:
'200':
description: successful operation
content:
application/json:
schema:
- $ref: '#/components/schemas/Video'
+ $ref: '#/components/schemas/VideoListResponse'
'/accounts/{name}/video-channels':
get:
summary: Get video channels of an account by its name
type: array
items:
$ref: '#/components/schemas/VideoChannel'
+ '/accounts/{name}/ratings':
+ get:
+ summary: Get ratings of an account by its name
+ security:
+ - OAuth2: []
+ tags:
+ - User
+ parameters:
+ - $ref: '#/components/parameters/start'
+ - $ref: '#/components/parameters/count'
+ - $ref: '#/components/parameters/sort'
+ - name: rating
+ in: query
+ required: false
+ description: Optionaly filter which ratings to retrieve
+ schema:
+ type: string
+ enum:
+ - like
+ - dislike
+ responses:
+ '200':
+ description: successful operation
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ $ref: '#/components/schemas/VideoRating'
'/videos/{id}/comment-threads':
get:
summary: Get the comment threads of a video by its id
schema:
$ref: '#/components/schemas/CommentThreadPostResponse'
delete:
- summary: 'Delete a comment in a comment therad by its id, of a video by its id'
+ summary: 'Delete a comment in a comment thread by its id, of a video by its id'
security:
- OAuth2: []
tags:
content:
application/json:
schema:
- type: array
- items:
- $ref: '#/components/schemas/Video'
+ $ref: '#/components/schemas/VideoListResponse'
servers:
- url: 'https://peertube.cpy.re/api/v1'
description: Live Test Server (live data - stable version)
description: The video id or uuid
schema:
type: string
- id3:
- name: id
+ captionLanguage:
+ name: captionLanguage
in: path
required: true
- description: The video channel id or uuid
+ description: The caption language
+ schema:
+ type: string
+ channelHandle:
+ name: channelHandle
+ in: path
+ required: true
+ description: "The video channel handle (example: 'my_username@example.com' or 'my_username')"
schema:
type: string
commentId:
enum:
- local
- all-local
- requestBodies:
- VideoChannelInput:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoChannelInput'
+ subscriptionsUris:
+ name: uris
+ in: query
+ required: true
+ description: list of uris to check if each is part of the user subscriptions
+ schema:
+ type: array
+ items:
+ type: string
securitySchemes:
OAuth2:
description: >
- Have an account with sufficient authorization levels
- - [Generate](https://docs.joinpeertube.org/lang/en/devdocs/rest.html) a
+ - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
Bearer Token
- Make Authenticated Requests
type: string
label:
type: string
- VideoPrivacy:
- type: string
+ VideoPrivacySet:
+ type: integer
enum:
- - Public
- - Unlisted
- - Private
+ - 1
+ - 2
+ - 3
+ description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3)'
+ VideoPrivacyConstant:
+ properties:
+ id:
+ type: integer
+ enum:
+ - 1
+ - 2
+ - 3
+ label:
+ type: string
Video:
properties:
id:
language:
$ref: '#/components/schemas/VideoConstantString'
privacy:
- $ref: '#/components/schemas/VideoPrivacy'
+ $ref: '#/components/schemas/VideoPrivacyConstant'
description:
type: string
duration:
type: array
items:
$ref: '#/components/schemas/VideoCommentThreadTree'
+ VideoCaption:
+ properties:
+ language:
+ $ref: '#/components/schemas/VideoConstantString'
+ captionPath:
+ type: string
Avatar:
properties:
path:
autoPlayVideo:
type: boolean
role:
+ type: integer
+ enum:
+ - 0
+ - 1
+ - 2
+ description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
+ roleLabel:
type: string
enum:
- User
- Administrator
videoQuota:
type: number
+ videoQuotaDaily:
+ type: number
createdAt:
type: string
account:
properties:
comment:
$ref: '#/components/schemas/VideoComment'
+ VideoListResponse:
+ properties:
+ total:
+ type: number
+ data:
+ type: array
+ items:
+ $ref: '#/components/schemas/Video'
AddUser:
properties:
username:
videoQuota:
type: string
description: 'The user videoQuota '
+ videoQuotaDaily:
+ type: string
+ description: 'The user daily video quota '
role:
type: integer
- format: int32
enum:
- 0
- 1
- 2
- description: 'The user role '
+ description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
required:
- username
- password
- email
- videoQuota
+ - videoQuotaDaily
- role
UpdateUser:
properties:
videoQuota:
type: string
description: 'The updated videoQuota of the user '
- role:
+ videoQuotaDaily:
type: string
- description: 'The updated role of the user '
+ description: 'The updated daily video quota of the user '
+ role:
+ type: integer
+ enum:
+ - 0
+ - 1
+ - 2
+ description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
required:
- id
- email
- videoQuota
+ - videoQuotaDaily
- role
UpdateMe:
properties:
required:
- id
- rating
+ VideoRating:
+ properties:
+ video:
+ $ref: '#/components/schemas/Video'
+ rating:
+ type: number
+ description: 'Rating of the video'
+ required:
+ - video
+ - rating
RegisterUser:
properties:
username:
- username
- password
- email
- VideoChannelInput:
+ VideoChannelCreate:
properties:
name:
type: string
+ displayName:
+ type: string
description:
type: string
+ support:
+ type: string
+ required:
+ - name
+ - displayName
+ VideoChannelUpdate:
+ properties:
+ displayName:
+ type: string
+ description:
+ type: string
+ support:
+ type: string
+ bulkVideosSupportUpdate:
+ type: boolean
+ description: 'Update all videos support field of this channel'
projects / github / Chocobozzz / PeerTube.git / blobdiff