Initialize the resumable upload of a video

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

POST

/videos/upload-resumable

VideoVideo Upload

Uses a resumable protocol to initialize the upload of a video

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://peertube2.cpy.re/api/v1/videos/upload-resumable' \
--header 'X-Upload-Content-Length;' \
--header 'X-Upload-Content-Type;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "category": 15,
    "channelId": 3,
    "commentsEnabled": true,
    "description": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\n",
    "downloadEnabled": true,
    "language": "en",
    "licence": 2,
    "name": "What is PeerTube?",
    "nsfw": true,
    "originallyPublishedAt": "2019-08-24T14:15:22Z",
    "previewfile": "string",
    "privacy": 1,
    "scheduleUpdate": {
        "privacy": 1,
        "updateAt": "2019-08-24"
    },
    "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
    "tags": [
        "framasoft",
        "peertube"
    ],
    "thumbnailfile": "string",
    "waitTranscoding": true,
    "filename": "what_is_peertube.mp4"
}'

Response Example

200 - Example 1

{}

Request

Header Params

X-Upload-Content-Length

number

required

Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.

X-Upload-Content-Type

string

required

MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.

Body Params application/json

category

integer

VideoCategorySet

optional

category id of the video (see /videos/categories)

Example:

15

channelId

integer

required

Channel id that will contain this video

>= 1

Example:

3

commentsEnabled

boolean

optional

Enable or disable comments for this video

description

string

optional

Video description

Example:

**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**

downloadEnabled

boolean

optional

Enable or disable downloading for this video

language

string

VideoLanguageSet

optional

language id of the video (see /videos/languages)

Example:

en

licence

integer

VideoLicenceSet

optional

licence id of the video (see /videos/licences)

Example:

2

name

string

required

Video name

>= 3 characters<= 120 characters

Example:

What is PeerTube?

nsfw

boolean

optional

Whether or not this video contains sensitive content

originallyPublishedAt

string <date-time>

optional

Date when the content was originally published

previewfile

string <binary>

optional

Video preview file

privacy

enum<integer>

VideoPrivacySet

optional

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

Allowed values:

1234

scheduleUpdate

object

VideoScheduledUpdate

optional

privacy

enum<integer>

VideoPrivacySet

optional

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

Allowed values:

1234

updateAt

string <date>

required

When to update the video

support

string

optional

A text tell the audience how to support the video creator

Example:

Please support our work on https://soutenir.framasoft.org/en/ <3

tags

array[string]

optional

Video tags (maximum 5 tags each between 2 and 30 characters)

>= 1 items<= 5 items

Example:

["framasoft","peertube"]

thumbnailfile

string <binary>

optional

Video thumbnail file

waitTranscoding

boolean

optional

Whether or not we wait transcoding before publish the video

filename

string <filename>

required

Video filename including extension

Example:

what_is_peertube.mp4

Examples

Responses

🟢200file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead

application/json

Body

object {0}

🟢201created

🟠413Disambiguate via `type`: - `max_file_size_reached` for the absolute file size limit - `quota_reached` for quota limits whether daily or global

🟠415video type unsupported

Modified at 2022-09-10 22:29:50

Cancel the resumable upload of a video, deleting any data uploaded so far

Send chunk for the resumable upload of a video