Video

Get video source file metadata

GET

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

Get metadata and download link of original video file

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

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

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/videos/42/source',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "inputFilename": "string",
  "fileDownloadUrl": "string",
  "resolution": {
    "id": 240,
    "label": "240p"
  },
  "size": 0,
  "fps": 0,
  "width": 0,
  "height": 0,
  "createdAt": "2024-01-15T09:30:00Z"
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKVideoSource

successful operation

Response fields application/json

inputFilenamestring

Uploaded/imported filename

fileDownloadUrlstring

PeerTube >= 6.1 If enabled by the admin, the video source file is kept on the server and can be downloaded by the owner

resolutionVideoResolutionConstant

PeerTube >= 6.1

Show child attributes

resolutions and their labels for the video

idVideoResolutionSet

Video resolution (0, 240, 360, 720, 1080, 1440 or 2160)

0 is used as a special value for stillimage videos dedicated to audio, a.k.a. audio-only videos.

Example

labelstring

Example

240p

sizeinteger

PeerTube >= 6.1 Video file size in bytes

fpsnumber

PeerTube >= 6.1 Frames per second of the video file

widthinteger

PeerTube >= 6.1 Video stream width

heightinteger

PeerTube >= 6.1 Video stream height

createdAtstring<date-time>

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.

Docs by Sourcey