Video Captions

List captions of a video

GET

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

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/captions'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/captions', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/videos/42/captions')
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "language": {
        "id": "en",
        "label": "English"
      },
      "automaticallyGenerated": true,
      "captionPath": "string",
      "fileUrl": "string",
      "m3u8Url": "string",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<VideoCaption>

Show child attributes

languageVideoConstantString-Language

Show child attributes

idVideoLanguageSet

language id of the video (see /videos/languages)

Example

en

labelstring

Example

English

automaticallyGeneratedboolean

captionPathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

m3u8Urlstring

updatedAtstring<date-time>

Docs by Sourcey