PeerTube · Example Payload

Importvideo

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

Video ImportsVideo Upload

Importvideo is an example object payload from PeerTube, with 9 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummarydescriptiontagsparametersrequestBodyresponses

Example Payload

Raw ↑ 
{
  "operationId": "importVideo",
  "method": "POST",
  "path": "/api/v1/videos/imports",
  "summary": "Import a video",
  "description": "Import a torrent or magnetURI or HTTP resource (if enabled by the instance administrator)",
  "tags": [
    "Video Imports",
    "Video Upload"
  ],
  "parameters": [],
  "requestBody": {
    "contentType": "multipart/form-data",
    "schema": {
      "$ref": "#/components/schemas/VideoCreateImport"
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "400": {
      "description": "`magnetUri` or `targetUrl` or a torrent file missing",
      "examples": {}
    },
    "403": {
      "description": "video didn't pass pre-import filter",
      "examples": {}
    },
    "409": {
      "description": "HTTP or Torrent/magnetURI import not enabled",
      "examples": {}
    }
  }
}