# Import a video

`POST /api/v1/videos/imports`

Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)

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


Request body: multipart/form-data

Type: any & VideoUploadRequestCommon

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

allOf:
  Type: any
  
  oneOf:
    Type: any
    
    - `targetUrl` (required)
      Type: targetUrl, url
      
      remote URL where to find the import's source video
      
      Example:
      
      ```json
      "https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d"
      ```
  
    Type: any
    
    - `magnetUri` (required)
      Type: magnetUri, uri
      
      magnet URI allowing to resolve the import's source video
      
      pattern: "/magnet:\\?xt=urn:[a-z0-9]+:[a-z0-9]{32}/i"
  
    Type: any
    
    - `torrentfile` (required)
      Type: torrentfile, binary
      
      Torrent file containing only the video file
  
  Additional properties: false

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

Responses:

- 200: successful operation

Content type: application/json

Type: VideoUploadResponse

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

- `video` (optional)
  Type: object
  
  - `id` (optional)
    Reference: [id](https://sourcey-peertube.pages.dev/api-rest-reference/models/id.md); Type: id
    
    object id for the video
  
  - `uuid` (optional)
    Type: UUIDv4
    
    universal identifier for the video, that can be used across instances
    
    allOf:
      Reference: [UUIDv4](https://sourcey-peertube.pages.dev/api-rest-reference/models/uuidv4.md); Type: UUIDv4, uuid
      
      minLength: 36
      
      maxLength: 36
      
      pattern: "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
      
      Example:
      
      ```json
      "9c9de5e8-0a1e-484a-b099-e80766180a6d"
      ```
  
  - `shortUUID` (optional)
    Reference: [shortUUID](https://sourcey-peertube.pages.dev/api-rest-reference/models/shortuuid.md); Type: shortUUID

- 400: `magnetUri` or `targetUrl` or a torrent file missing

- 403: video didn't pass pre-import filter

- 409: HTTP or Torrent/magnetURI import not enabled

## Examples

### cURL

```bash
curl -X POST 'https://peertube2.cpy.re/api/v1/videos/imports' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  --form-string 'targetUrl=https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d' \
  --form-string 'name=What is PeerTube?' \
  --form-string 'channelId=3' \
  --form-string 'privacy=1' \
  --form-string 'category=15' \
  --form-string 'licence=2' \
  --form-string 'language=en' \
  --form-string '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)**
' \
  --form-string 'waitTranscoding=true' \
  --form-string 'generateTranscription=true' \
  --form-string 'support=Please support our work on https://soutenir.framasoft.org/en/ <3' \
  --form-string 'nsfw=true' \
  --form-string 'nsfwFlags=0' \
  --form-string 'tags=framasoft' \
  --form-string 'tags=peertube' \
  --form-string 'commentsPolicy=1' \
  --form-string 'recommendationScope=1' \
  --form-string 'aiUsage=1' \
  --form-string 'commercialContent=1' \
  --form-string 'downloadEnabled=true' \
  --form-string 'originallyPublishedAt=2024-01-15T09:30:00Z' \
  --form-string 'scheduleUpdate={"privacy":1,"updateAt":"2024-01-15T09:30:00Z"}' \
  --form-string 'videoPasswords=string'
```

### JavaScript

```javascript
const form = new FormData();
form.append('targetUrl', 'https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d');
form.append('name', 'What is PeerTube?');
form.append('channelId', '3');
form.append('privacy', '1');
form.append('category', '15');
form.append('licence', '2');
form.append('language', 'en');
form.append('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');
form.append('waitTranscoding', 'true');
form.append('generateTranscription', 'true');
form.append('support', 'Please support our work on https://soutenir.framasoft.org/en/ <3');
form.append('nsfw', 'true');
form.append('nsfwFlags', '0');
form.append('tags', 'framasoft');
form.append('tags', 'peertube');
form.append('commentsPolicy', '1');
form.append('recommendationScope', '1');
form.append('aiUsage', '1');
form.append('commercialContent', '1');
form.append('downloadEnabled', 'true');
form.append('originallyPublishedAt', '2024-01-15T09:30:00Z');
form.append('scheduleUpdate', '{"privacy":1,"updateAt":"2024-01-15T09:30:00Z"}');
form.append('videoPasswords', 'string');
const response = await fetch('https://peertube2.cpy.re/api/v1/videos/imports', {
  method: 'POST',
  headers: {"Authorization":"Bearer YOUR_TOKEN"},
  body: form,
});
console.log(await response.text());
```

### Python

```python
import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('targetUrl', (None, 'https://framatube.org/videos/watch/9c9de5e8-0a1e-484a-b099-e80766180a6d')),
        ('name', (None, 'What is PeerTube?')),
        ('channelId', (None, '3')),
        ('privacy', (None, '1')),
        ('category', (None, '15')),
        ('licence', (None, '2')),
        ('language', (None, 'en')),
        ('description', (None, '**[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', (None, 'true')),
        ('generateTranscription', (None, 'true')),
        ('support', (None, 'Please support our work on https://soutenir.framasoft.org/en/ <3')),
        ('nsfw', (None, 'true')),
        ('nsfwFlags', (None, '0')),
        ('tags', (None, 'framasoft')),
        ('tags', (None, 'peertube')),
        ('commentsPolicy', (None, '1')),
        ('recommendationScope', (None, '1')),
        ('aiUsage', (None, '1')),
        ('commercialContent', (None, '1')),
        ('downloadEnabled', (None, 'true')),
        ('originallyPublishedAt', (None, '2024-01-15T09:30:00Z')),
        ('scheduleUpdate', (None, '{"privacy":1,"updateAt":"2024-01-15T09:30:00Z"}')),
        ('videoPasswords', (None, 'string')),
    ]
    response = requests.request('POST', 'https://peertube2.cpy.re/api/v1/videos/imports', headers={"Authorization":"Bearer YOUR_TOKEN"}, files=files)
    print(response.text)
```