Videos

Video Chapters

Operations dealing with managing chapters of a video.

Get chapters of a video

GET

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

PeerTube >= 6.0

Get chapters of a video

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

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

const data = await response.text();

import requests

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

200

{
  "chapters": {
    "title": "string",
    "timecode": 0
  }
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

200OKVideoChapters

successful operation

Response fields application/json

chaptersobject

Show child attributes

titlestring

timecodeinteger

Replace video chapters

PUT

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

PeerTube >= 6.0

Replace video chapters

curl -X PUT 'https://peertube2.cpy.re/api/v1/videos/42/chapters' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "chapters": [
    {
      "title": "string",
      "timecode": 0
    }
  ]
}'

const body = `{
  "chapters": [
    {
      "title": "string",
      "timecode": 0
    }
  ]
}`;

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

const data = await response.text();

import requests

body = '''{
  "chapters": [
    {
      "title": "string",
      "timecode": 0
    }
  ]
}'''

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

Request Body

{
  "chapters": [
    {
      "title": "string",
      "timecode": 0
    }
  ]
}

Body

application/json

chaptersArray<object>

Show child attributes

titlestring

timecodeinteger

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

Response

204No Content

successful operation

404Not Found

video 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