# Initialize the resumable upload of a video

`POST /api/v1/videos/upload-resumable`

Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video

Authentication (security requirement alternatives):

```json
[
  {
    "OAuth2": []
  }
]
```

- OAuth2: oauth2. 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__.

[Generate]: https://docs.joinpeertube.org/api/rest-getting-started


Parameters:

- `X-Upload-Content-Length` (header, number, required) - Number of bytes that will be uploaded in subsequent requests. Set this value to the size of the file you are uploading.
  Type: number
  
  Example:
  
  ```json
  2469036
  ```

- `X-Upload-Content-Type` (header, string, mimetype, required) - MIME type of the file that you are uploading. Depending on your instance settings, acceptable values might vary.
  Type: string, mimetype
  
  Example:
  
  ```json
  "video/mp4"
  ```

Request body: application/json

Type: VideoUploadRequestCommon & object

Schema: [VideoUploadRequestResumable](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadrequestresumable.md)

allOf:
  Reference: [VideoUploadRequestCommon](https://sourcey-peertube.pages.dev/api-rest-reference/models/videouploadrequestcommon.md); Type: VideoUploadRequestCommon

  Type: object
  
  - `filename` (required)
    Type: string, filename
    
    Video filename including extension
    
    Example:
    
    ```json
    "what_is_peertube.mp4"
    ```
  
  - `thumbnailfile` (optional)
    Type: string, binary
    
    Video thumbnail file
  
  - `previewfile` (optional)
    Type: string, binary
    
    Deprecated in PeerTube v8.1, use thumbnailfile instead
    
    deprecated: true

Responses:

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

- 201: created

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


- 415: video type unsupported

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/videos/upload-resumable' \
  -H 'X-Upload-Content-Length: 2469036' \
  -H 'X-Upload-Content-Type: video/mp4' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "name": "What is PeerTube?",
  "channelId": 3,
  "privacy": 1,
  "category": 15,
  "licence": 2,
  "language": "en",
  "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",
  "waitTranscoding": true,
  "generateTranscription": true,
  "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
  "nsfw": true,
  "nsfwFlags": 0,
  "tags": [
    "framasoft",
    "peertube"
  ],
  "commentsPolicy": 1,
  "recommendationScope": 1,
  "aiUsage": 1,
  "commercialContent": 1,
  "downloadEnabled": true,
  "originallyPublishedAt": "2024-01-15T09:30:00Z",
  "scheduleUpdate": {
    "privacy": 1,
    "updateAt": "2024-01-15T09:30:00Z"
  },
  "thumbnailfile": "<binary>",
  "previewfile": "<binary>",
  "videoPasswords": [
    "string"
  ],
  "filename": "what_is_peertube.mp4"
}'
```

### JavaScript

```javascript
const body = `{
  "name": "What is PeerTube?",
  "channelId": 3,
  "privacy": 1,
  "category": 15,
  "licence": 2,
  "language": "en",
  "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",
  "waitTranscoding": true,
  "generateTranscription": true,
  "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
  "nsfw": true,
  "nsfwFlags": 0,
  "tags": [
    "framasoft",
    "peertube"
  ],
  "commentsPolicy": 1,
  "recommendationScope": 1,
  "aiUsage": 1,
  "commercialContent": 1,
  "downloadEnabled": true,
  "originallyPublishedAt": "2024-01-15T09:30:00Z",
  "scheduleUpdate": {
    "privacy": 1,
    "updateAt": "2024-01-15T09:30:00Z"
  },
  "thumbnailfile": "<binary>",
  "previewfile": "<binary>",
  "videoPasswords": [
    "string"
  ],
  "filename": "what_is_peertube.mp4"
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/upload-resumable', {
  method: 'POST',
  headers: {
    'X-Upload-Content-Length': '2469036',
    'X-Upload-Content-Type': 'video/mp4',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "name": "What is PeerTube?",
  "channelId": 3,
  "privacy": 1,
  "category": 15,
  "licence": 2,
  "language": "en",
  "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",
  "waitTranscoding": true,
  "generateTranscription": true,
  "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
  "nsfw": true,
  "nsfwFlags": 0,
  "tags": [
    "framasoft",
    "peertube"
  ],
  "commentsPolicy": 1,
  "recommendationScope": 1,
  "aiUsage": 1,
  "commercialContent": 1,
  "downloadEnabled": true,
  "originallyPublishedAt": "2024-01-15T09:30:00Z",
  "scheduleUpdate": {
    "privacy": 1,
    "updateAt": "2024-01-15T09:30:00Z"
  },
  "thumbnailfile": "<binary>",
  "previewfile": "<binary>",
  "videoPasswords": [
    "string"
  ],
  "filename": "what_is_peertube.mp4"
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/videos/upload-resumable',
    data=body.encode('utf-8'),
    headers={
        'X-Upload-Content-Length': '2469036',
        'X-Upload-Content-Type': 'video/mp4',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```