PeerTube · Example Payload

Post_Api_V1_Runners_Jobs_Jobuuid_Files_Videos_Videoidoruuid_Max Quality_Audio

API used by PeerTube runners.

Runner Jobs

Post_Api_V1_Runners_Jobs_Jobuuid_Files_Videos_Videoidoruuid_Max Quality_Audio 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": "post_api_v1_runners_jobs_jobUUID_files_videos_videoIdOrUUID_max-quality_audio",
  "method": "POST",
  "path": "/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/max-quality/audio",
  "summary": "Download the max-quality audio file for a job video",
  "description": "API used by PeerTube runners.",
  "tags": [
    "Runner Jobs"
  ],
  "parameters": [
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    },
    {
      "name": null,
      "in": null,
      "required": false,
      "description": "",
      "schema": {}
    }
  ],
  "requestBody": {
    "contentType": "application/json",
    "schema": {
      "type": "object",
      "properties": {
        "runnerToken": {
          "type": "string"
        },
        "jobToken": {
          "type": "string"
        }
      },
      "required": [
        "runnerToken",
        "jobToken"
      ]
    },
    "example": {}
  },
  "responses": {
    "200": {
      "description": "successful operation",
      "examples": {}
    },
    "403": {
      "description": "the job is not associated with this video",
      "examples": {}
    }
  }
}