Live Videos

Update information about a live

PUT

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

curl -X PUT 'https://peertube2.cpy.re/api/v1/videos/live/42' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "saveReplay": true,
  "replaySettings": {
    "privacy": 1
  },
  "permanentLive": true,
  "schedules": [
    {
      "startAt": "2024-01-15T09:30:00Z"
    }
  ]
}'

const body = `{
  "saveReplay": true,
  "replaySettings": {
    "privacy": 1
  },
  "permanentLive": true,
  "schedules": [
    {
      "startAt": "2024-01-15T09:30:00Z"
    }
  ]
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/live/42', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "saveReplay": true,
  "replaySettings": {
    "privacy": 1
  },
  "permanentLive": true,
  "schedules": [
    {
      "startAt": "2024-01-15T09:30:00Z"
    }
  ]
}'''

response = requests.put(
    'https://peertube2.cpy.re/api/v1/videos/live/42',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "saveReplay": true,
  "replaySettings": {
    "privacy": 1
  },
  "permanentLive": true,
  "schedules": [
    {
      "startAt": "2024-01-15T09:30:00Z"
    }
  ]
}

Body

application/json

saveReplayboolean

replaySettingsLiveVideoReplaySettings

Show child attributes

privacyVideoPrivacySet12345

privacy id of the video (see /videos/privacies)

permanentLiveboolean

User can stream multiple times in a permanent live

latencyModeLiveVideoLatencyMode

User can select live latency mode if enabled by the instance

Show child attributes

The live latency mode (Default = 1, High latency = 2, Small Latency = 3)

LiveVideoLatencyMode123

schedulesArray<LiveSchedule>

Show child attributes

startAtstring<date-time>

Date when the stream is scheduled to air at

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

204No Content

successful operation

400Bad Request

bad parameters or trying to update a live that has already started

403Forbidden

trying to save replay of the live but saving replay is not enabled on the instance

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