Video Captions

Add or replace a video caption

PUT

https://peertube2.cpy.re/api/v1/videos/{id}/captions/{captionLanguage}

curl -X PUT 'https://peertube2.cpy.re/api/v1/videos/42/captions/en' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const form = new FormData();
const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/captions/en', {
  method: 'PUT',
  headers: {"Authorization":"Bearer YOUR_TOKEN"},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
    ]
    response = requests.request('PUT', 'https://peertube2.cpy.re/api/v1/videos/42/captions/en', headers={"Authorization":"Bearer YOUR_TOKEN"}, files=files)
    print(response.text)

Request Body

{
  "captionfile": "<binary>"
}

Body

multipart/form-data

multipart/form-dataobject

Encoding

captionfiletext/vtt, application/x-subrip, text/plain

captionfilestring<binary>

The file to upload.

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

captionLanguageVideoLanguageSetrequiredpath

The caption language

Response

204No Content

successful operation

404Not Found

video or language not found

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: user

Docs by Sourcey