Runner Jobs

Request a new job

POST

https://peertube2.cpy.re/api/v1/runners/jobs/request

API used by PeerTube runners

Request a new job

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/jobs/request' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}'

const body = `{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}`;

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/request', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}'''

response = requests.post(
    'https://peertube2.cpy.re/api/v1/runners/jobs/request',
    data=body.encode('utf-8'),
    headers={
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "runnerToken": "string",
  "jobTypes": [
    "string"
  ]
}

200

{
  "availableJobs": [
    {
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
      "type": "vod-web-video-transcoding",
      "payload": {
        "input": {
          "videoFileUrl": "string"
        },
        "output": {
          "resolution": 0,
          "fps": 0
        }
      }
    }
  ]
}

Body

application/json

runnerTokenstringrequired

jobTypesArray<string>

Filter jobs depending on their types

Response

200OKobject

successful operation

Response fields application/json

availableJobsArray<object>

Show child attributes

uuidUUIDv4<uuid>

Example

9c9de5e8-0a1e-484a-b099-e80766180a6d

typeRunnerJobTypevod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcoding

payloadobject

Show child attributes

Any of

inputobject

Show child attributes

videoFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

inputobject

Show child attributes

videoFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

inputobject

Show child attributes

audioFileUrlstring

previewFileUrlstring

outputobject

Show child attributes

resolutionnumber

fpsnumber

Docs by Sourcey