Runner Jobs

Update job

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/update

API used by PeerTube runners

Update job

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/update' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string",
  "jobToken": "string",
  "progress": 0,
  "payload": {
    "type": "add-chunk",
    "masterPlaylistFile": "<binary>",
    "resolutionPlaylistFile": "<binary>",
    "resolutionPlaylistFilename": "string",
    "videoChunkFile": "<binary>",
    "videoChunkFilename": "string"
  }
}'

const body = `{
  "runnerToken": "string",
  "jobToken": "string",
  "progress": 0,
  "payload": {
    "type": "add-chunk",
    "masterPlaylistFile": "<binary>",
    "resolutionPlaylistFile": "<binary>",
    "resolutionPlaylistFilename": "string",
    "videoChunkFile": "<binary>",
    "videoChunkFilename": "string"
  }
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/update', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string",
  "jobToken": "string",
  "progress": 0,
  "payload": {
    "type": "add-chunk",
    "masterPlaylistFile": "<binary>",
    "resolutionPlaylistFile": "<binary>",
    "resolutionPlaylistFilename": "string",
    "videoChunkFile": "<binary>",
    "videoChunkFilename": "string"
  }
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/update',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "runnerToken": "string",
  "jobToken": "string",
  "progress": 0,
  "payload": {
    "type": "add-chunk",
    "masterPlaylistFile": "<binary>",
    "resolutionPlaylistFile": "<binary>",
    "resolutionPlaylistFilename": "string",
    "videoChunkFile": "<binary>",
    "videoChunkFilename": "string"
  }
}

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

progressinteger

Update job progression percentage (optional)

payloadobject

Show child attributes

Any of

Provide live transcoding chunks update

typestringadd-chunkremove-chunk

masterPlaylistFilestring<binary>

resolutionPlaylistFilestring<binary>

resolutionPlaylistFilenamestring

videoChunkFilestring<binary>

videoChunkFilenamestring

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

Docs by Sourcey