PeerTube · Example Payload

Uploadresumableinit

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

VideoVideo Upload

Uploadresumableinit 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

{
  "operationId": "uploadResumableInit",
  "method": "POST",
  "path": "/api/v1/videos/upload-resumable",
  "summary": "Initialize the resumable upload of a video",
  "description": "Uses [a resumable protocol](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) to initialize the upload of a video",
  "tags": [
    "Video",
    "Video Upload"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "$ref": "#/components/schemas/VideoUploadRequestResumable"
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "file already exists, send a [`resume`](https://github.com/kukhariev/node-uploadx/blob/master/proto.md) request instead",
      "examples": {}
    },
    "201": {
      "description": "created",
      "examples": {}
    },
    "413": {
      "description": "Disambiguate via `code`:\n- `max_file_size_reached` for the absolute file size limit\n- `quota_reached` for quota limits whether daily or global\n",
      "examples": {}
    },
    "415": {
      "description": "video type unsupported",
      "examples": {}
    }
  }
}