Live Videos

Get live session of a replay

GET

https://peertube2.cpy.re/api/v1/videos/{id}/live-session

If the video is a replay of a live, you can find the associated live session using this endpoint

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

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/live-session', {
  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/live-session',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "id": 0,
  "startDate": "2024-01-15T09:30:00Z",
  "endDate": "2024-01-15T09:30:00Z",
  "error": 1,
  "replayVideo": {
    "id": 0,
    "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
    "shortUUID": "2y84q2MQUMWPbiEcxNXMgC"
  }
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKLiveVideoSessionResponse

successful operation

Response fields application/json

idinteger

startDatestring<date-time>

Start date of the live session

endDatestring<date-time> | null

End date of the live session

errorinteger | null12345

Error type if an error occurred during the live session:

1: Bad socket health (transcoding is too slow)
2: Max duration exceeded
3: Quota exceeded
4: Quota FFmpeg error
5: Video has been blacklisted during the live

replayVideoobject

Video replay information

Show child attributes

idnumber

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

shortUUIDshortUUID

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

Example

2y84q2MQUMWPbiEcxNXMgC

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