Runner Jobs

Accept job

POST

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

API used by PeerTube runners

Accept job

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/accept' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "runnerToken": "string"
}'

const body = `{
  "runnerToken": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string"
}'''

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

Request Body

{
  "runnerToken": "string"
}

200

{
  "job": {
    "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
    "type": "vod-web-video-transcoding",
    "state": {
      "id": 1,
      "label": "Processing"
    },
    "payload": {
      "input": {
        "videoFileUrl": "string"
      },
      "output": {
        "resolution": 0,
        "fps": 0
      }
    },
    "failures": 0,
    "error": "string",
    "progress": 0,
    "priority": 0,
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdAt": "2024-01-15T09:30:00Z",
    "startedAt": "2024-01-15T09:30:00Z",
    "finishedAt": "2024-01-15T09:30:00Z",
    "parent": {
      "type": "vod-web-video-transcoding",
      "state": {
        "id": 1,
        "label": "Processing"
      },
      "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
    },
    "runner": {
      "id": 0,
      "name": "string",
      "description": "string"
    },
    "jobToken": "string"
  }
}

Body

application/json

runnerTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

200OKobject

successful operation

Response fields application/json

jobRunnerJob & object

Show child attributes

uuidUUIDv4<uuid>

Example

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

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

stateRunnerJobStateConstant

Show child attributes

idRunnerJobState12345678

The runner job state:

1 Pending
2 Processing
3 Completed
4 Errored
5 Waiting for a parent job
6 Cancelled
7 Parent had an error
8 Parent has been cancelled

labelstring

Example

Processing

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

failuresinteger

Number of times a remote runner failed to process this job. After too many failures, the job in "error" state

errorstring | null

Error message if the job is errored

progressinteger

Percentage progress

priorityinteger

Job priority (less has more priority)

updatedAtstring<date-time>

createdAtstring<date-time>

startedAtstring<date-time>

finishedAtstring<date-time>

parentobject | null

If job has a parent job

Show child attributes

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

stateRunnerJobStateConstant

Show child attributes

idRunnerJobState12345678

The runner job state:

1 Pending
2 Processing
3 Completed
4 Errored
5 Waiting for a parent job
6 Cancelled
7 Parent had an error
8 Parent has been cancelled

labelstring

Example

Processing

uuidUUIDv4<uuid>

Example

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

runnerany | null

If job is associated to a runner

Show child attributes

idnumber

namestring

descriptionstring

jobTokenstring

Docs by Sourcey