12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440 |
- openapi: 3.0.0
- info:
- title: PeerTube
- version: 2.1.1
- contact:
- name: PeerTube Community
- url: 'https://joinpeertube.org'
- license:
- name: AGPLv3.0
- url: 'https://github.com/Chocobozzz/PeerTube/blob/master/LICENSE'
- x-logo:
- url: 'https://joinpeertube.org/img/brand.png'
- altText: PeerTube Project Homepage
- description: |
- # Introduction
- The PeerTube API is built on HTTP(S) and is RESTful. You can use your favorite
- HTTP/REST library for your programming language to use PeerTube. No official
- SDK is currently provided, but the spec API is fully compatible with
- [openapi-generator](https://github.com/OpenAPITools/openapi-generator/wiki/API-client-generator-HOWTO)
- which generates a client SDK in the language of your choice.
- See the [Quick Start guide](https://docs.joinpeertube.org/#/api-rest-getting-started) so you can play with the PeerTube API.
- # 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
- currently be used at a time.
- # Errors
- The API uses standard HTTP status codes to indicate the success or failure
- of the API call. The body of the response will be JSON in the following
- format.
- ```
- {
- "code": "unauthorized_request", // example inner error code
- "error": "Token is invalid." // example exposed error message
- }
- ```
- externalDocs:
- url: https://docs.joinpeertube.org/api-rest-reference.html
- tags:
- - name: Accounts
- description: >
- Using some features of PeerTube require authentication, for which Accounts
- provide different levels of permission as well as associated user
- information. Accounts also encompass remote accounts discovered across the federation.
- - name: Config
- description: >
- Each server exposes public information regarding supported videos and
- options.
- - name: Job
- description: >
- Jobs are long-running tasks enqueued and processed by the instance
- itself. No additional worker registration is currently available.
- - name: Instance Follows
- 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
- information across its social graph by posting activities to actors' inbox
- endpoints.
- - name: Video Abuses
- description: |
- Video abuses deal with reports of local or remote videos alike.
- - name: Video
- description: |
- Operations dealing with listing, uploading, fetching or modifying videos.
- - name: Search
- description: |
- The search helps to find _videos_ from within the instance and beyond.
- Videos from other instances federated by the instance (that is, instances
- followed by the instance) can be found via keywords and other criteria of
- the advanced search.
- - name: Video Comments
- description: >
- Operations dealing with comments to a video. Comments are organized in
- threads.
- - name: Video Playlists
- description: >
- Operations dealing with playlists of videos. Playlists are bound to users
- and/or channels.
- - name: Video Channels
- description: >
- Operations dealing with creation, modification and video listing of a
- user's channels.
- - name: Video Blacklist
- description: >
- Operations dealing with blacklisting videos (removing them from view and
- preventing interactions).
- - name: Video Rates
- description: >
- Like/dislike a video.
- x-tagGroups:
- - name: Accounts
- tags:
- - Accounts
- - Users
- - My User
- - My Subscriptions
- - name: Videos
- tags:
- - Video
- - Video Caption
- - Video Channels
- - Video Comments
- - Video Following
- - Video Rates
- - Video Playlists
- - Video Ownership Change
- - name: Search
- tags:
- - Search
- - name: Moderation
- tags:
- - Video Abuses
- - Video Blacklist
- - name: Instance Configuration
- tags:
- - Config
- - Instance Follows
- - name: Jobs
- tags:
- - Job
- paths:
- '/accounts/{name}':
- get:
- tags:
- - Accounts
- summary: Get an account
- parameters:
- - $ref: '#/components/parameters/name'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Account'
- '/accounts/{name}/videos':
- get:
- tags:
- - Accounts
- - Video
- summary: 'List videos of an account'
- parameters:
- - $ref: '#/components/parameters/name'
- - $ref: '#/components/parameters/categoryOneOf'
- - $ref: '#/components/parameters/tagsOneOf'
- - $ref: '#/components/parameters/tagsAllOf'
- - $ref: '#/components/parameters/licenceOneOf'
- - $ref: '#/components/parameters/languageOneOf'
- - $ref: '#/components/parameters/nsfw'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/skipCount'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- x-code-samples:
- - lang: JavaScript
- source: |
- fetch('https://peertube2.cpy.re/api/v1/accounts/{name}/videos')
- .then(function(response) {
- return response.json()
- }).then(function(data) {
- console.log(data)
- })
- - lang: Shell
- source: |
- # pip install httpie
- http -b GET https://peertube2.cpy.re/api/v1/accounts/{name}/videos
- - lang: Ruby
- source: |
- require 'net/http'
- require 'json'
- uri = URI.parse("https://peertube2.cpy.re/api/v1/accounts/{name}/videos")
- http = Net::HTTP.new(uri.host, uri.port)
- http.use_ssl = true
- response = http.get(uri.request_uri)
- puts JSON.parse(response.read_body)
- - lang: Python
- source: |
- import requests
- r = requests.get("https://peertube2.cpy.re/api/v1//accounts/{name}/videos")
- json = r.json()
- print(json)
- /accounts:
- get:
- tags:
- - Accounts
- summary: List accounts
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- 'application/json':
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Account'
- /config:
- get:
- tags:
- - Config
- summary: Get instance public configuration
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ServerConfig'
- /config/about:
- get:
- summary: Get instance "About" information
- tags:
- - Config
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ServerConfigAbout'
- /config/custom:
- get:
- summary: Get instance runtime configuration
- tags:
- - Config
- security:
- - OAuth2:
- - admin
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ServerConfigCustom'
- put:
- summary: Set instance runtime configuration
- tags:
- - Config
- security:
- - OAuth2:
- - admin
- responses:
- '200':
- description: successful operation
- delete:
- summary: Delete instance runtime configuration
- tags:
- - Config
- security:
- - OAuth2:
- - admin
- responses:
- '200':
- description: successful operation
- /jobs/{state}:
- get:
- summary: List instance jobs
- security:
- - OAuth2:
- - admin
- tags:
- - Job
- parameters:
- - name: state
- in: path
- required: true
- description: The state of the job
- schema:
- type: string
- enum:
- - active
- - completed
- - failed
- - waiting
- - delayed
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Job'
- '/server/following/{host}':
- delete:
- security:
- - OAuth2:
- - admin
- tags:
- - Instance Follows
- summary: Unfollow a server
- parameters:
- - name: host
- in: path
- required: true
- description: 'The host to unfollow '
- schema:
- type: string
- responses:
- '201':
- description: successful operation
- /server/followers:
- get:
- tags:
- - Instance Follows
- summary: List instance followers
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Follow'
- /server/following:
- get:
- tags:
- - Instance Follows
- summary: List instance followings
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/Follow'
- post:
- security:
- - OAuth2:
- - admin
- tags:
- - Instance Follows
- summary: Follow a server
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Follow'
- /users:
- post:
- summary: Create a user
- security:
- - OAuth2:
- - admin
- tags:
- - Users
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AddUserResponse'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AddUser'
- description: User to create
- required: true
- get:
- summary: List users
- security:
- - OAuth2: []
- tags:
- - Users
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/usersSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/User'
- '/users/{id}':
- delete:
- summary: Delete a user
- security:
- - OAuth2:
- - admin
- tags:
- - Users
- parameters:
- - $ref: '#/components/parameters/id'
- responses:
- '204':
- description: successful operation
- get:
- summary: Get a user
- security:
- - OAuth2: []
- tags:
- - Users
- parameters:
- - $ref: '#/components/parameters/id'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/User'
- put:
- summary: Update a user
- security:
- - OAuth2: []
- tags:
- - Users
- parameters:
- - $ref: '#/components/parameters/id'
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UpdateUser'
- required: true
- /users/register:
- post:
- summary: Register a user
- tags:
- - Users
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/RegisterUser'
- required: true
- /users/me:
- get:
- summary: Get my user information
- security:
- - OAuth2:
- - user
- tags:
- - My User
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/User'
- put:
- summary: Update my user information
- security:
- - OAuth2:
- - user
- tags:
- - My User
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UpdateMe'
- required: true
- /users/me/videos/imports:
- get:
- summary: Get video imports of my user
- security:
- - OAuth2:
- - user
- tags:
- - Videos
- - My 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/VideoImport'
- /users/me/video-quota-used:
- get:
- summary: Get my user used quota
- security:
- - OAuth2:
- - user
- tags:
- - My User
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: number
- '/users/me/videos/{videoId}/rating':
- get:
- summary: Get rate of my user for a video
- security:
- - OAuth2: []
- tags:
- - My User
- - Video Rates
- parameters:
- - name: videoId
- in: path
- required: true
- description: 'The video id '
- schema:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/GetMeVideoRating'
- /users/me/videos:
- get:
- summary: Get videos of my user
- security:
- - OAuth2:
- - user
- tags:
- - My User
- - Videos
- 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:
- get:
- summary: Get my user subscriptions
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- post:
- summary: Add subscription to my user
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- responses:
- '200':
- description: successful operation
- /users/me/subscriptions/exist:
- get:
- summary: Get if subscriptions exist for my user
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- parameters:
- - $ref: '#/components/parameters/subscriptionsUris'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: object
- /users/me/subscriptions/videos:
- get:
- summary: List videos of subscriptions of my user
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- - Videos
- parameters:
- - $ref: '#/components/parameters/categoryOneOf'
- - $ref: '#/components/parameters/tagsOneOf'
- - $ref: '#/components/parameters/tagsAllOf'
- - $ref: '#/components/parameters/licenceOneOf'
- - $ref: '#/components/parameters/languageOneOf'
- - $ref: '#/components/parameters/nsfw'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/skipCount'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- '/users/me/subscriptions/{subscriptionHandle}':
- get:
- summary: Get subscription of my user
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- parameters:
- - $ref: '#/components/parameters/subscriptionHandle'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoChannel'
- delete:
- summary: Delete subscription of my user
- security:
- - OAuth2:
- - user
- tags:
- - My Subscriptions
- parameters:
- - $ref: '#/components/parameters/subscriptionHandle'
- responses:
- '200':
- description: successful operation
- /users/me/avatar/pick:
- post:
- summary: Update my user avatar
- security:
- - OAuth2: []
- tags:
- - My User
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/Avatar'
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- avatarfile:
- description: The file to upload.
- type: string
- format: binary
- encoding:
- avatarfile:
- contentType: image/png, image/jpeg
- /videos/ownership:
- get:
- summary: List video ownership changes
- tags:
- - Video Ownership Change
- security:
- - OAuth2: []
- responses:
- '200':
- description: successful operation
- '/videos/ownership/{id}/accept':
- post:
- summary: Accept ownership change request
- tags:
- - Video Ownership Change
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- '/videos/ownership/{id}/refuse':
- post:
- summary: Refuse ownership change request
- tags:
- - Video Ownership Change
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- '/videos/{id}/give-ownership':
- post:
- summary: Request ownership change
- tags:
- - Video Ownership Change
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- requestBody:
- required: true
- content:
- application/x-www-form-urlencoded:
- schema:
- type: object
- properties:
- username:
- type: string
- required:
- - username
- responses:
- '204':
- description: successful operation
- '400':
- description: 'Changing video ownership to a remote account is not supported yet'
- /videos:
- get:
- summary: List videos
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/categoryOneOf'
- - $ref: '#/components/parameters/tagsOneOf'
- - $ref: '#/components/parameters/tagsAllOf'
- - $ref: '#/components/parameters/licenceOneOf'
- - $ref: '#/components/parameters/languageOneOf'
- - $ref: '#/components/parameters/nsfw'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/skipCount'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- /videos/categories:
- get:
- summary: List available video categories
- tags:
- - Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- /videos/licences:
- get:
- summary: List available video licences
- tags:
- - Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- /videos/languages:
- get:
- summary: List available video languages
- tags:
- - Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- /videos/privacies:
- get:
- summary: List available video privacies
- tags:
- - Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- '/videos/{id}':
- put:
- summary: Update a video
- security:
- - OAuth2: []
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- thumbnailfile:
- description: Video thumbnail file
- type: string
- format: binary
- previewfile:
- description: Video preview file
- type: string
- format: binary
- category:
- description: Video category
- type: string
- licence:
- description: Video licence
- type: string
- language:
- description: Video language
- type: string
- privacy:
- $ref: '#/components/schemas/VideoPrivacySet'
- 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 (maximum 5 tags each between 2 and 30 characters)
- type: array
- minItems: 1
- maxItems: 5
- items:
- type: string
- minLength: 2
- maxLength: 30
- commentsEnabled:
- description: Enable or disable comments for this video
- type: string
- originallyPublishedAt:
- description: Date when the content was originally published
- type: string
- format: date-time
- scheduleUpdate:
- $ref: '#/components/schemas/VideoScheduledUpdate'
- encoding:
- thumbnailfile:
- contentType: image/jpeg
- previewfile:
- contentType: image/jpeg
- get:
- summary: Get a video
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoDetails'
- delete:
- summary: Delete a video
- security:
- - OAuth2: []
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- '/videos/{id}/description':
- get:
- summary: Get complete video description
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: string
- '/videos/{id}/views':
- post:
- summary: Add a view to a video
- tags:
- - Video
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- '/videos/{id}/watching':
- put:
- summary: Set watching progress of a video
- tags:
- - Video
- security:
- - OAuth2: []
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/UserWatchingVideo'
- required: true
- responses:
- '204':
- description: successful operation
- /videos/upload:
- post:
- summary: Upload a video
- security:
- - OAuth2: []
- tags:
- - Video
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoUploadResponse'
- '403':
- description: 'The user video quota is exceeded with this video.'
- '408':
- description: 'Upload has timed out'
- '422':
- description: 'Invalid input file.'
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- videofile:
- description: Video file
- type: string
- format: binary
- channelId:
- description: Channel id that will contain this video
- type: number
- thumbnailfile:
- description: Video thumbnail file
- type: string
- format: binary
- previewfile:
- description: Video preview file
- type: string
- format: binary
- 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 (maximum 5 tags each between 2 and 30 characters)
- type: array
- minItems: 1
- maxItems: 5
- items:
- type: string
- minLength: 2
- maxLength: 30
- commentsEnabled:
- description: Enable or disable comments for this video
- type: string
- originallyPublishedAt:
- description: Date when the content was originally published
- type: string
- format: date-time
- scheduleUpdate:
- $ref: '#/components/schemas/VideoScheduledUpdate'
- required:
- - videofile
- - channelId
- - name
- encoding:
- videofile:
- contentType: video/mp4, video/webm, video/ogg, video/avi, video/quicktime, video/x-msvideo, video/x-flv, video/x-matroska, application/octet-stream
- thumbnailfile:
- contentType: image/jpeg
- previewfile:
- contentType: image/jpeg
- x-code-samples:
- - lang: Shell
- source: |
- ## DEPENDENCIES: httpie, jq
- # pip install httpie
- USERNAME="<your_username>"
- PASSWORD="<your_password>"
- FILE_PATH="<your_file_path>"
- CHANNEL_ID="<your_channel_id>"
- NAME="<video_name>"
- API_PATH="https://peertube2.cpy.re/api/v1"
- ## AUTH
- client_id=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_id")
- client_secret=$(http -b GET "$API_PATH/oauth-clients/local" | jq -r ".client_secret")
- token=$(http -b --form POST "$API_PATH/users/token" \
- client_id="$client_id" client_secret="$client_secret" grant_type=password response_type=code \
- username=$USERNAME \
- password=$PASSWORD \
- | jq -r ".access_token")
- ## VIDEO UPLOAD
- http -b --form POST "$API_PATH/videos/upload" \
- videofile@$FILE_PATH \
- channelId=$CHANNEL_ID \
- name=$NAME \
- "Authorization:Bearer $token"
- /videos/imports:
- post:
- summary: Import a video
- description: Import a torrent or magnetURI or HTTP resource (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
- format: binary
- previewfile:
- description: Video preview file
- type: string
- format: binary
- 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 (maximum 5 tags each between 2 and 30 characters)
- type: array
- minItems: 1
- maxItems: 5
- items:
- type: string
- minLength: 2
- maxLength: 30
- commentsEnabled:
- description: Enable or disable comments for this video
- type: string
- scheduleUpdate:
- $ref: '#/components/schemas/VideoScheduledUpdate'
- required:
- - channelId
- - name
- encoding:
- torrentfile:
- contentType: application/x-bittorrent
- thumbnailfile:
- contentType: image/jpeg
- previewfile:
- contentType: image/jpeg
- /videos/abuse:
- get:
- summary: List video abuses
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Abuses
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/abusesSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/VideoAbuse'
- '/videos/{id}/abuse':
- post:
- summary: Report an abuse
- security:
- - OAuth2: []
- tags:
- - Video Abuses
- - Videos
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- reason:
- description: Reason why the user reports this video
- type: string
- responses:
- '204':
- description: successful operation
- '/videos/{id}/abuse/{abuseId}':
- put:
- summary: Update an abuse
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Abuses
- responses:
- '204':
- description: successful operation
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/abuseId'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- state:
- $ref: '#/components/schemas/VideoAbuseStateSet'
- moderationComment:
- type: string
- description: 'Update the comment of the video abuse for other admin/moderators'
- delete:
- summary: Delete an abuse
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Abuses
- responses:
- '204':
- description: successful operation
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/abuseId'
- '/videos/{id}/blacklist':
- post:
- summary: Blacklist a video
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Blacklist
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- delete:
- summary: Delete an entry of the blacklist of a video by its id
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Blacklist
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- /videos/blacklist:
- get:
- summary: List blacklisted videos
- security:
- - OAuth2:
- - admin
- - moderator
- tags:
- - Video Blacklist
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/blacklistsSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/VideoBlacklist'
- /videos/{id}/captions:
- get:
- summary: List captions of a video
- tags:
- - Video Caption
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- 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/idOrUUID'
- - $ref: '#/components/parameters/captionLanguage'
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- captionfile:
- description: The file to upload.
- type: string
- format: binary
- encoding:
- captionfile:
- contentType: text/vtt, application/x-subrip, text/plain
- responses:
- '204':
- description: successful operation
- delete:
- summary: Delete a video caption
- tags:
- - Video Caption
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/captionLanguage'
- responses:
- '204':
- description: successful operation
- /video-channels:
- get:
- summary: List video channels
- tags:
- - Video Channels
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/VideoChannel'
- post:
- summary: Create a video channel
- security:
- - OAuth2: []
- tags:
- - Video Channels
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoChannelCreate'
- '/video-channels/{channelHandle}':
- get:
- summary: Get a video channel
- tags:
- - Video Channels
- parameters:
- - $ref: '#/components/parameters/channelHandle'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoChannel'
- put:
- summary: Update a video channel
- security:
- - OAuth2: []
- tags:
- - Video Channels
- parameters:
- - $ref: '#/components/parameters/channelHandle'
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoChannelUpdate'
- delete:
- summary: Delete a video channel
- security:
- - OAuth2: []
- tags:
- - Video Channels
- parameters:
- - $ref: '#/components/parameters/channelHandle'
- responses:
- '204':
- description: successful operation
- '/video-channels/{channelHandle}/videos':
- get:
- summary: List videos of a video channel
- tags:
- - Video
- - Video Channels
- parameters:
- - $ref: '#/components/parameters/channelHandle'
- - $ref: '#/components/parameters/categoryOneOf'
- - $ref: '#/components/parameters/tagsOneOf'
- - $ref: '#/components/parameters/tagsAllOf'
- - $ref: '#/components/parameters/licenceOneOf'
- - $ref: '#/components/parameters/languageOneOf'
- - $ref: '#/components/parameters/nsfw'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/skipCount'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- /video-playlists/privacies:
- get:
- summary: List available playlist privacies
- tags:
- - Video Playlists
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- type: string
- /video-playlists:
- get:
- summary: List video playlists
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/VideoPlaylist'
- post:
- summary: Create a video playlist
- description: 'If the video playlist is set as public, the videoChannelId is mandatory.'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: object
- properties:
- videoPlaylist:
- type: object
- properties:
- id:
- type: number
- uuid:
- type: string
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- displayName:
- description: Video playlist display name
- type: string
- thumbnailfile:
- description: Video playlist thumbnail file
- type: string
- format: binary
- privacy:
- $ref: '#/components/schemas/VideoPlaylistPrivacySet'
- description:
- description: Video playlist description
- type: string
- videoChannelId:
- description: Video channel in which the playlist will be published
- type: number
- required:
- - displayName
- /video-playlists/{id}:
- get:
- summary: Get a video playlist
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoPlaylist'
- put:
- summary: Update a video playlist
- description: 'If the video playlist is set as public, the playlist must have a assigned channel.'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- responses:
- '204':
- description: successful operation
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- requestBody:
- content:
- multipart/form-data:
- schema:
- type: object
- properties:
- displayName:
- description: Video playlist display name
- type: string
- thumbnailfile:
- description: Video playlist thumbnail file
- type: string
- format: binary
- privacy:
- $ref: '#/components/schemas/VideoPlaylistPrivacySet'
- description:
- description: Video playlist description
- type: string
- videoChannelId:
- description: Video channel in which the playlist will be published
- type: number
- delete:
- summary: Delete a video playlist
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- /video-playlists/{id}/videos:
- get:
- summary: 'List videos of a playlist'
- tags:
- - Videos
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- post:
- summary: 'Add a video in a playlist'
- security:
- - OAuth2: []
- tags:
- - Videos
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: object
- properties:
- videoPlaylistElement:
- type: object
- properties:
- id:
- type: number
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- videoId:
- type: number
- description: 'Video to add in the playlist'
- startTimestamp:
- type: number
- description: 'Start the video at this specific timestamp (in seconds)'
- stopTimestamp:
- type: number
- description: 'Stop the video at this specific timestamp (in seconds)'
- required:
- - videoId
- /video-playlists/{id}/videos/reorder:
- post:
- summary: 'Reorder a playlist'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- startPosition:
- type: number
- description: 'Start position of the element to reorder (starts from 1)'
- insertAfterPosition:
- type: number
- description: 'New position for the block to reorder (starts from 0, to add the block before the first element)'
- reorderLength:
- type: number
- description: 'How many element from startPosition to reorder (minimum length is 1)'
- required:
- - startPosition
- - insertAfterPosition
- /video-playlists/{id}/videos/{playlistElementId}:
- put:
- summary: 'Update a playlist element'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/playlistElementId'
- responses:
- '204':
- description: successful operation
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- startTimestamp:
- type: number
- description: 'Start the video at this specific timestamp (in seconds)'
- stopTimestamp:
- type: number
- description: 'Stop the video at this specific timestamp (in seconds)'
- delete:
- summary: 'Delete an element from a playlist'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/playlistElementId'
- responses:
- '204':
- description: successful operation
- '/users/me/video-playlists/videos-exist':
- get:
- summary: 'Check video exists in my playlists'
- security:
- - OAuth2: []
- tags:
- - Video Playlists
- parameters:
- - name: videoIds
- in: query
- required: true
- description: The video ids to check
- schema:
- type: array
- items:
- type: number
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: object
- properties:
- videoId:
- type: array
- items:
- type: object
- properties:
- playlistElementId:
- type: number
- playlistId:
- type: number
- startTimestamp:
- type: number
- stopTimestamp:
- type: number
- '/accounts/{name}/video-channels':
- get:
- summary: List video channels of an account
- tags:
- - Video Channels
- - Accounts
- parameters:
- - $ref: '#/components/parameters/name'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: '#/components/schemas/VideoChannel'
- '/accounts/{name}/ratings':
- get:
- summary: List ratings of an account
- security:
- - OAuth2: []
- tags:
- - Accounts
- parameters:
- - $ref: '#/components/parameters/name'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/sort'
- - name: rating
- in: query
- required: false
- description: Optionally 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: List threads of a video
- tags:
- - Video Comments
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/commentsSort'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadResponse'
- post:
- summary: Create a thread
- security:
- - OAuth2: []
- tags:
- - Video Comments
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadPostResponse'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- text:
- type: string
- description: 'Text comment'
- required:
- - text
- '/videos/{id}/comment-threads/{threadId}':
- get:
- summary: Get a thread
- tags:
- - Video Comments
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/threadId'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoCommentThreadTree'
- '/videos/{id}/comments/{commentId}':
- post:
- summary: Reply to a thread of a video
- security:
- - OAuth2: []
- tags:
- - Video Comments
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/commentId'
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/CommentThreadPostResponse'
- requestBody:
- content:
- application/json:
- schema:
- type: object
- properties:
- text:
- type: string
- description: 'Text comment'
- required:
- - text
- delete:
- summary: Delete a comment or a reply
- security:
- - OAuth2: []
- tags:
- - Video Comments
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- - $ref: '#/components/parameters/commentId'
- responses:
- '204':
- description: successful operation
- '/videos/{id}/rate':
- put:
- summary: Like/dislike a video
- security:
- - OAuth2: []
- tags:
- - Video Rates
- parameters:
- - $ref: '#/components/parameters/idOrUUID'
- responses:
- '204':
- description: successful operation
- /search/videos:
- get:
- tags:
- - Search
- summary: Search videos
- parameters:
- - $ref: '#/components/parameters/categoryOneOf'
- - $ref: '#/components/parameters/tagsOneOf'
- - $ref: '#/components/parameters/tagsAllOf'
- - $ref: '#/components/parameters/licenceOneOf'
- - $ref: '#/components/parameters/languageOneOf'
- - $ref: '#/components/parameters/nsfw'
- - $ref: '#/components/parameters/filter'
- - $ref: '#/components/parameters/skipCount'
- - $ref: '#/components/parameters/start'
- - $ref: '#/components/parameters/count'
- - $ref: '#/components/parameters/videosSearchSort'
- - name: search
- in: query
- required: true
- description: String to search
- schema:
- type: string
- responses:
- '200':
- description: successful operation
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/VideoListResponse'
- servers:
- - url: 'https://peertube.cpy.re/api/v1'
- description: Live Test Server (live data - stable version)
- - url: 'https://peertube2.cpy.re/api/v1'
- description: Live Test Server (live data - latest nighlty version)
- - url: 'https://peertube3.cpy.re/api/v1'
- description: Live Test Server (live data - latest RC version)
- components:
- parameters:
- start:
- name: start
- in: query
- required: false
- description: Offset
- schema:
- type: number
- count:
- name: count
- in: query
- required: false
- description: "Number of items (max: 100)"
- schema:
- type: number
- sort:
- name: sort
- in: query
- required: false
- description: Sort column (-createdAt for example)
- schema:
- type: string
- videosSort:
- name: sort
- in: query
- required: false
- description: Sort videos by criteria
- schema:
- type: string
- enum:
- - -name
- - -duration
- - -createdAt
- - -publishedAt
- - -views
- - -likes
- - -trending
- videosSearchSort:
- name: sort
- in: query
- required: false
- description: Sort videos by criteria
- schema:
- type: string
- enum:
- - -name
- - -duration
- - -createdAt
- - -publishedAt
- - -views
- - -likes
- - -match
- commentsSort:
- name: sort
- in: query
- required: false
- description: Sort comments by criteria
- schema:
- type: string
- enum:
- - -createdAt
- - -totalReplies
- blacklistsSort:
- name: sort
- in: query
- required: false
- description: Sort blacklists by criteria
- schema:
- type: string
- enum:
- - -id
- - -name
- - -duration
- - -views
- - -likes
- - -dislikes
- - -uuid
- - -createdAt
- usersSort:
- name: sort
- in: query
- required: false
- description: Sort users by criteria
- schema:
- type: string
- enum:
- - -id
- - -username
- - -createdAt
- abusesSort:
- name: sort
- in: query
- required: false
- description: Sort abuses by criteria
- schema:
- type: string
- enum:
- - -id
- - -createdAt
- - -state
- name:
- name: name
- in: path
- required: true
- description: >-
- The name of the account (chocobozzz or chocobozzz@peertube.cpy.re for
- example)
- schema:
- type: string
- id:
- name: id
- in: path
- required: true
- description: The user id
- schema:
- type: number
- idOrUUID:
- name: id
- in: path
- required: true
- description: The object id or uuid
- schema:
- type: string
- playlistElementId:
- name: playlistElementId
- in: path
- required: true
- description: Playlist element id
- schema:
- type: number
- abuseId:
- name: abuseId
- in: path
- required: true
- description: Video abuse id
- schema:
- type: number
- captionLanguage:
- name: captionLanguage
- in: path
- required: true
- 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
- subscriptionHandle:
- name: subscriptionHandle
- in: path
- required: true
- description: "The subscription handle (example: 'my_username@example.com' or 'my_username')"
- schema:
- type: string
- threadId:
- name: threadId
- in: path
- required: true
- description: The thread id (root comment id)
- schema:
- type: number
- commentId:
- name: commentId
- in: path
- required: true
- description: The comment id
- schema:
- type: number
- categoryOneOf:
- name: categoryOneOf
- in: query
- required: false
- description: category id of the video (see /videos/categories)
- schema:
- oneOf:
- - type: number
- - type: array
- items:
- type: number
- style: form
- explode: false
- tagsOneOf:
- name: tagsOneOf
- in: query
- required: false
- description: tag(s) of the video
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- style: form
- explode: false
- tagsAllOf:
- name: tagsAllOf
- in: query
- required: false
- description: tag(s) of the video, where all should be present in the video
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- style: form
- explode: false
- languageOneOf:
- name: languageOneOf
- in: query
- required: false
- description: language id of the video (see /videos/languages). Use _unknown to filter on videos that don't have a video language
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- style: form
- explode: false
- licenceOneOf:
- name: licenceOneOf
- in: query
- required: false
- description: licence id of the video (see /videos/licences)
- schema:
- oneOf:
- - type: number
- - type: array
- items:
- type: number
- style: form
- explode: false
- skipCount:
- name: skipCount
- in: query
- required: false
- description: if you don't need the `total` in the response
- schema:
- type: string
- enum:
- - 'true'
- - 'false'
- nsfw:
- name: nsfw
- in: query
- required: false
- description: whether to include nsfw videos, if any
- schema:
- type: string
- enum:
- - 'true'
- - 'false'
- filter:
- name: filter
- in: query
- required: false
- description: >
- Special filters (local for instance) which might require special rights:
- * `local` - only videos local to the instance
- * `all-local` - only videos local to the instance, but showing private and unlisted videos (requires Admin privileges)
- schema:
- type: string
- enum:
- - local
- - all-local
- 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: >
- In the header: *Authorization: Bearer <token\>*
- Authenticating via OAuth requires the following steps:
- - Have an account with sufficient authorization levels
- - [Generate](https://docs.joinpeertube.org/#/api-rest-getting-started) a
- Bearer Token
- - Make Authenticated Requests
- type: oauth2
- flows:
- password:
- tokenUrl: 'https://peertube.example.com/api/v1/users/token'
- scopes:
- admin: Admin scope
- moderator: Moderator scope
- user: User scope
- schemas:
- VideoConstantNumber:
- properties:
- id:
- type: number
- label:
- type: string
- VideoConstantString:
- properties:
- id:
- type: string
- label:
- type: string
- VideoPlaylistPrivacySet:
- type: integer
- enum:
- - 1
- - 2
- - 3
- description: 'The video playlist privacy (Public = 1, Unlisted = 2, Private = 3)'
- VideoPlaylistPrivacyConstant:
- properties:
- id:
- $ref: '#/components/schemas/VideoPlaylistPrivacySet'
- label:
- type: string
- VideoPlaylistTypeSet:
- type: integer
- enum:
- - 1
- - 2
- description: 'The video playlist type (Regular = 1, Watch Later = 2)'
- VideoPlaylistTypeConstant:
- properties:
- id:
- $ref: '#/components/schemas/VideoPlaylistTypeSet'
- label:
- type: string
- VideoPrivacySet:
- type: integer
- enum:
- - 1
- - 2
- - 3
- - 4
- description: 'The video privacy (Public = 1, Unlisted = 2, Private = 3, Internal = 4)'
- VideoPrivacyConstant:
- properties:
- id:
- $ref: '#/components/schemas/VideoPrivacySet'
- label:
- type: string
- NSFWPolicy:
- type: string
- enum:
- - display
- - blur
- - do_not_list
- UserRole:
- type: number
- enum:
- - 0
- - 1
- - 2
- description: 'The user role (Admin = 0, Moderator = 1, User = 2)'
- VideoStateConstant:
- properties:
- id:
- type: integer
- enum:
- - 1
- - 2
- - 3
- description: 'The video state (Published = 1, to transcode = 2, to import = 3)'
- label:
- type: string
- VideoAbuseStateSet:
- type: integer
- enum:
- - 1
- - 2
- - 3
- description: 'The video playlist privacy (Pending = 1, Rejected = 2, Accepted = 3)'
- VideoAbuseStateConstant:
- properties:
- id:
- $ref: '#/components/schemas/VideoAbuseStateSet'
- label:
- type: string
- VideoResolutionConstant:
- properties:
- id:
- type: integer
- description: 'Video resolution (240, 360, 720 ...)'
- label:
- type: string
- VideoScheduledUpdate:
- properties:
- privacy:
- $ref: '#/components/schemas/VideoPrivacySet'
- updateAt:
- type: string
- format: date
- description: When to update the video
- required:
- - updateAt
- AccountSummary:
- properties:
- id:
- type: number
- name:
- type: string
- displayName:
- type: string
- url:
- type: string
- host:
- type: string
- avatar:
- nullable: true
- allOf:
- - $ref: '#/components/schemas/Avatar'
- VideoChannelSummary:
- properties:
- id:
- type: number
- name:
- type: string
- displayName:
- type: string
- url:
- type: string
- host:
- type: string
- avatar:
- nullable: true
- allOf:
- - $ref: '#/components/schemas/Avatar'
- PlaylistElement:
- properties:
- position:
- type: number
- startTimestamp:
- type: number
- stopTimestamp:
- type: number
- video:
- nullable: true
- allOf:
- - $ref: '#/components/schemas/Video'
- VideoFile:
- properties:
- magnetUri:
- type: string
- resolution:
- $ref: '#/components/schemas/VideoResolutionConstant'
- size:
- type: number
- description: 'Video file size in bytes'
- torrentUrl:
- type: string
- torrentDownloadUrl:
- type: string
- fileUrl:
- type: string
- fileDownloadUrl:
- type: string
- fps:
- type: number
- VideoStreamingPlaylists:
- properties:
- id:
- type: number
- type:
- type: number
- enum:
- - 1
- description: 'Playlist type (HLS = 1)'
- playlistUrl:
- type: string
- segmentsSha256Url:
- type: string
- redundancies:
- type: array
- items:
- type: object
- properties:
- baseUrl:
- type: string
- Video:
- properties:
- id:
- type: number
- uuid:
- type: string
- createdAt:
- type: string
- publishedAt:
- type: string
- updatedAt:
- type: string
- originallyPublishedAt:
- type: string
- category:
- $ref: '#/components/schemas/VideoConstantNumber'
- licence:
- $ref: '#/components/schemas/VideoConstantNumber'
- language:
- $ref: '#/components/schemas/VideoConstantString'
- privacy:
- $ref: '#/components/schemas/VideoPrivacyConstant'
- description:
- type: string
- duration:
- type: number
- isLocal:
- type: boolean
- name:
- type: string
- thumbnailPath:
- type: string
- previewPath:
- type: string
- embedPath:
- type: string
- views:
- type: number
- likes:
- type: number
- dislikes:
- type: number
- nsfw:
- type: boolean
- waitTranscoding:
- type: boolean
- nullable: true
- state:
- $ref: '#/components/schemas/VideoStateConstant'
- scheduledUpdate:
- nullable: true
- allOf:
- - $ref: '#/components/schemas/VideoScheduledUpdate'
- blacklisted:
- nullable: true
- type: boolean
- blacklistedReason:
- nullable: true
- type: string
- account:
- $ref: '#/components/schemas/AccountSummary'
- channel:
- $ref: '#/components/schemas/VideoChannelSummary'
- userHistory:
- nullable: true
- type: object
- properties:
- currentTime:
- type: number
- VideoDetails:
- allOf:
- - $ref: '#/components/schemas/Video'
- - type: object
- properties:
- descriptionPath:
- type: string
- support:
- type: string
- channel:
- $ref: '#/components/schemas/VideoChannel'
- account:
- $ref: '#/components/schemas/Account'
- tags:
- type: array
- items:
- type: string
- files:
- type: array
- items:
- $ref: '#/components/schemas/VideoFile'
- commentsEnabled:
- type: boolean
- downloadEnabled:
- type: boolean
- trackerUrls:
- type: array
- items:
- type: string
- streamingPlaylists:
- type: array
- items:
- $ref: '#/components/schemas/VideoStreamingPlaylists'
- VideoImportStateConstant:
- properties:
- id:
- type: integer
- enum:
- - 1
- - 2
- - 3
- description: 'The video import state (Pending = 1, Success = 2, Failed = 3)'
- label:
- type: string
- VideoImport:
- properties:
- id:
- type: number
- targetUrl:
- type: string
- magnetUri:
- type: string
- torrentName:
- type: string
- state:
- type: object
- properties:
- id:
- $ref: '#/components/schemas/VideoImportStateConstant'
- label:
- type: string
- error:
- type: string
- createdAt:
- type: string
- updatedAt:
- type: string
- video:
- $ref: '#/components/schemas/Video'
- VideoAbuse:
- properties:
- id:
- type: number
- reason:
- type: string
- reporterAccount:
- $ref: '#/components/schemas/Account'
- state:
- $ref: '#/components/schemas/VideoAbuseStateConstant'
- moderationComment:
- type: string
- video:
- type: object
- properties:
- id:
- type: number
- name:
- type: string
- uuid:
- type: string
- createdAt:
- type: string
- VideoBlacklist:
- properties:
- id:
- type: number
- videoId:
- type: number
- createdAt:
- type: string
- updatedAt:
- type: string
- name:
- type: string
- uuid:
- type: string
- description:
- type: string
- duration:
- type: number
- views:
- type: number
- likes:
- type: number
- dislikes:
- type: number
- nsfw:
- type: boolean
- VideoChannel:
- properties:
- displayName:
- type: string
- description:
- type: string
- isLocal:
- type: boolean
- ownerAccount:
- type: object
- properties:
- id:
- type: number
- uuid:
- type: string
- VideoPlaylist:
- properties:
- id:
- type: number
- createdAt:
- type: string
- updatedAt:
- type: string
- description:
- type: string
- uuid:
- type: string
- displayName:
- type: string
- isLocal:
- type: boolean
- videoLength:
- type: number
- thumbnailPath:
- type: string
- privacy:
- $ref: '#/components/schemas/VideoPlaylistPrivacyConstant'
- type:
- $ref: '#/components/schemas/VideoPlaylistTypeConstant'
- ownerAccount:
- $ref: '#/components/schemas/AccountSummary'
- videoChannel:
- $ref: '#/components/schemas/VideoChannelSummary'
- VideoComment:
- properties:
- id:
- type: number
- url:
- type: string
- text:
- type: string
- threadId:
- type: number
- inReplyToCommentId:
- type: number
- videoId:
- type: number
- createdAt:
- type: string
- updatedAt:
- type: string
- totalRepliesFromVideoAuthor:
- type: number
- totalReplies:
- type: number
- account:
- $ref: '#/components/schemas/Account'
- VideoCommentThreadTree:
- properties:
- comment:
- $ref: '#/components/schemas/VideoComment'
- children:
- type: array
- items:
- $ref: '#/components/schemas/VideoCommentThreadTree'
- VideoCaption:
- properties:
- language:
- $ref: '#/components/schemas/VideoConstantString'
- captionPath:
- type: string
- Avatar:
- properties:
- path:
- type: string
- createdAt:
- type: string
- updatedAt:
- type: string
- Actor:
- properties:
- id:
- type: number
- url:
- type: string
- name:
- type: string
- host:
- type: string
- followingCount:
- type: number
- followersCount:
- type: number
- createdAt:
- type: string
- updatedAt:
- type: string
- avatar:
- $ref: '#/components/schemas/Avatar'
- Account:
- allOf:
- - $ref: '#/components/schemas/Actor'
- - properties:
- userId:
- type: string
- displayName:
- type: string
- description:
- type: string
- User:
- properties:
- id:
- type: number
- username:
- type: string
- email:
- type: string
- theme:
- type: string
- description: 'Theme enabled by this user'
- emailVerified:
- type: boolean
- description: 'Is email verified?'
- nsfwPolicy:
- $ref: '#/components/schemas/NSFWPolicy'
- webtorrentEnabled:
- type: boolean
- autoPlayVideo:
- type: boolean
- role:
- $ref: '#/components/schemas/UserRole'
- roleLabel:
- type: string
- enum:
- - User
- - Moderator
- - Administrator
- videoQuota:
- type: number
- videoQuotaDaily:
- type: number
- videosCount:
- type: number
- videoAbusesCount:
- type: number
- videoAbusesAcceptedCount:
- type: number
- videoAbusesCreatedCount:
- type: number
- videoCommentsCount:
- type: number
- noInstanceConfigWarningModal:
- type: boolean
- noWelcomeModal:
- type: boolean
- blocked:
- type: boolean
- blockedReason:
- type: string
- createdAt:
- type: string
- account:
- $ref: '#/components/schemas/Account'
- videoChannels:
- type: array
- items:
- $ref: '#/components/schemas/VideoChannel'
- UserWatchingVideo:
- properties:
- currentTime:
- type: number
- ServerConfig:
- properties:
- instance:
- type: object
- properties:
- name:
- type: string
- shortDescription:
- type: string
- defaultClientRoute:
- type: string
- isNSFW:
- type: boolean
- defaultNSFWPolicy:
- type: string
- customizations:
- type: object
- properties:
- javascript:
- type: string
- css:
- type: string
- search:
- type: object
- properties:
- remoteUri:
- type: object
- properties:
- users:
- type: boolean
- anonymous:
- type: boolean
- plugin:
- type: object
- properties:
- registered:
- type: array
- items:
- type: string
- theme:
- type: object
- properties:
- registered:
- type: array
- items:
- type: string
- email:
- type: object
- properties:
- enabled:
- type: boolean
- contactForm:
- type: object
- properties:
- enabled:
- type: boolean
- serverVersion:
- type: string
- serverCommit:
- type: string
- signup:
- type: object
- properties:
- allowed:
- type: boolean
- allowedForCurrentIP:
- type: boolean
- requiresEmailVerification:
- type: boolean
- transcoding:
- type: object
- properties:
- hls:
- type: object
- properties:
- enabled:
- type: boolean
- webtorrent:
- type: object
- properties:
- enabled:
- type: boolean
- enabledResolutions:
- type: array
- items:
- type: number
- import:
- type: object
- properties:
- videos:
- type: object
- properties:
- http:
- type: object
- properties:
- enabled:
- type: boolean
- torrent:
- type: object
- properties:
- enabled:
- type: boolean
- autoBlacklist:
- type: object
- properties:
- videos:
- type: object
- properties:
- ofUsers:
- type: object
- properties:
- enabled:
- type: boolean
- avatar:
- type: object
- properties:
- file:
- type: object
- properties:
- size:
- type: object
- properties:
- max:
- type: number
- extensions:
- type: array
- items:
- type: string
- video:
- type: object
- properties:
- image:
- type: object
- properties:
- extensions:
- type: array
- items:
- type: string
- size:
- type: object
- properties:
- max:
- type: number
- file:
- type: object
- properties:
- extensions:
- type: array
- items:
- type: string
- videoCaption:
- type: object
- properties:
- file:
- type: object
- properties:
- size:
- type: object
- properties:
- max:
- type: number
- extensions:
- type: array
- items:
- type: string
- user:
- type: object
- properties:
- videoQuota:
- type: number
- videoQuotaDaily:
- type: number
- trending:
- type: object
- properties:
- videos:
- type: object
- properties:
- intervalDays:
- type: number
- tracker:
- type: object
- properties:
- enabled:
- type: boolean
- followings:
- type: object
- properties:
- instance:
- type: object
- properties:
- autoFollowIndex:
- type: object
- properties:
- indexUrl:
- type: string
- ServerConfigAbout:
- properties:
- instance:
- type: object
- properties:
- name:
- type: string
- shortDescription:
- type: string
- description:
- type: string
- terms:
- type: string
- ServerConfigCustom:
- properties:
- instance:
- type: object
- properties:
- name:
- type: string
- shortDescription:
- type: string
- description:
- type: string
- terms:
- type: string
- defaultClientRoute:
- type: string
- isNSFW:
- type: boolean
- defaultNSFWPolicy:
- type: string
- customizations:
- type: object
- properties:
- javascript:
- type: string
- css:
- type: string
- theme:
- type: object
- properties:
- default:
- type: string
- services:
- type: object
- properties:
- twitter:
- type: object
- properties:
- username:
- type: string
- whitelisted:
- type: boolean
- cache:
- type: object
- properties:
- previews:
- type: object
- properties:
- size:
- type: number
- captions:
- type: object
- properties:
- size:
- type: number
- signup:
- type: object
- properties:
- enabled:
- type: boolean
- limit:
- type: number
- requiresEmailVerification:
- type: boolean
- admin:
- type: object
- properties:
- email:
- type: string
- contactForm:
- type: object
- properties:
- enabled:
- type: boolean
- user:
- type: object
- properties:
- videoQuota:
- type: number
- videoQuotaDaily:
- type: number
- transcoding:
- type: object
- properties:
- enabled:
- type: boolean
- allowAdditionalExtensions:
- type: boolean
- allowAudioFiles:
- type: boolean
- threads:
- type: number
- resolutions:
- type: object
- properties:
- 240p:
- type: boolean
- 360p:
- type: boolean
- 480p:
- type: boolean
- 720p:
- type: boolean
- 1080p:
- type: boolean
- 2160p:
- type: boolean
- hls:
- type: object
- properties:
- enabled:
- type: boolean
- import:
- type: object
- properties:
- videos:
- type: object
- properties:
- http:
- type: object
- properties:
- enabled:
- type: boolean
- torrent:
- type: object
- properties:
- enabled:
- type: boolean
- autoBlacklist:
- type: object
- properties:
- videos:
- type: object
- properties:
- ofUsers:
- type: object
- properties:
- enabled:
- type: boolean
- followers:
- type: object
- properties:
- instance:
- type: object
- properties:
- enabled:
- type: boolean
- manualApproval:
- type: boolean
- Follow:
- properties:
- id:
- type: number
- follower:
- $ref: '#/components/schemas/Actor'
- following:
- $ref: '#/components/schemas/Actor'
- score:
- type: number
- state:
- type: string
- enum:
- - pending
- - accepted
- createdAt:
- type: string
- updatedAt:
- type: string
- Job:
- properties:
- id:
- type: number
- state:
- type: string
- enum:
- - pending
- - processing
- - error
- - success
- category:
- type: string
- enum:
- - transcoding
- - activitypub-http
- handlerName:
- type: string
- handlerInputData:
- type: string
- createdAt:
- type: string
- updatedAt:
- type: string
- AddUserResponse:
- properties:
- id:
- type: number
- uuid:
- type: string
- VideoUploadResponse:
- properties:
- video:
- type: object
- properties:
- id:
- type: number
- uuid:
- type: string
- CommentThreadResponse:
- properties:
- total:
- type: number
- data:
- type: array
- items:
- $ref: '#/components/schemas/VideoComment'
- CommentThreadPostResponse:
- properties:
- comment:
- $ref: '#/components/schemas/VideoComment'
- VideoListResponse:
- properties:
- total:
- type: number
- data:
- type: array
- items:
- $ref: '#/components/schemas/Video'
- AddUser:
- properties:
- username:
- type: string
- description: 'The user username '
- password:
- type: string
- description: 'The user password. If the smtp server is configured, you can leave empty and an email will be sent '
- email:
- type: string
- description: 'The user email '
- videoQuota:
- type: string
- description: 'The user videoQuota '
- videoQuotaDaily:
- type: string
- description: 'The user daily video quota '
- role:
- $ref: '#/components/schemas/UserRole'
- required:
- - username
- - password
- - email
- - videoQuota
- - videoQuotaDaily
- - role
- UpdateUser:
- properties:
- id:
- type: string
- description: 'The user id '
- email:
- type: string
- description: 'The updated email of the user '
- videoQuota:
- type: string
- description: 'The updated videoQuota of the user '
- videoQuotaDaily:
- type: string
- description: 'The updated daily video quota of the user '
- role:
- $ref: '#/components/schemas/UserRole'
- required:
- - id
- - email
- - videoQuota
- - videoQuotaDaily
- - role
- UpdateMe:
- properties:
- password:
- type: string
- description: 'Your new password '
- email:
- type: string
- description: 'Your new email '
- displayNSFW:
- type: string
- description: 'Your new displayNSFW '
- autoPlayVideo:
- type: string
- description: 'Your new autoPlayVideo '
- required:
- - password
- - email
- - displayNSFW
- - autoPlayVideo
- GetMeVideoRating:
- properties:
- id:
- type: string
- description: 'Id of the video '
- rating:
- type: number
- description: 'Rating of the video '
- required:
- - id
- - rating
- VideoRating:
- properties:
- video:
- $ref: '#/components/schemas/Video'
- rating:
- type: number
- description: 'Rating of the video'
- required:
- - video
- - rating
- RegisterUser:
- properties:
- username:
- type: string
- description: 'The username of the user '
- password:
- type: string
- description: 'The password of the user '
- email:
- type: string
- description: 'The email of the user '
- displayName:
- type: string
- description: 'The user display name'
- channel:
- type: object
- properties:
- name:
- type: string
- description: 'The default channel name'
- displayName:
- type: string
- description: 'The default channel display name'
- required:
- - username
- - password
- - email
- 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'
|