Video Channels

Invite a collaborator

POST

https://peertube2.cpy.re/api/v1/video-channels/{channelHandle}/collaborators/invite

PeerTube >= 8.0 Invite a local user to collaborate on the specified video channel.

curl -X POST 'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/collaborators/invite' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "accountHandle": "string"
}'

const body = `{
  "accountHandle": "string"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/collaborators/invite', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "accountHandle": "string"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/video-channels/my_username%20%7C%20my_username%40example.com/collaborators/invite',
    data=body.encode('utf-8'),
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "accountHandle": "string"
}

200

{
  "collaborator": {
    "id": 42,
    "account": {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "url": "https://example.com",
      "host": "example.com",
      "avatars": [
        {
          "path": "string",
          "fileUrl": "string",
          "width": 0,
          "height": 0,
          "createdAt": "2024-01-15T09:30:00Z",
          "updatedAt": "2024-01-15T09:30:00Z"
        }
      ]
    },
    "state": {
      "id": 1,
      "label": "string"
    },
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
}

Body

application/json

accountHandlestring

Local user username to invite

Parameters

channelHandlestringrequiredpath

The video channel handle

Response

200OKobject

Collaborator invited

Response fields application/json

collaboratorVideoChannelCollaborator

Representation of a channel collaboration

Show child attributes

idid>= 1

Example

accountAccountSummary

Show child attributes

idinteger

namestring

displayNamestring

urlstring<url>

hoststring<hostname>

avatarsArray<ActorImage>

Show child attributes

pathstring | 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

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

stateobject

Show child attributes

idVideoChannelCollaboratorState12

The user import state:

1: Pending
2: Accepted

labelstring

createdAtstring<date-time>

updatedAtstring<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