Remote Jobs

Runner Jobs

Manage runner jobs and runner-side job execution.

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

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

Abort job

POST

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

API used by PeerTube runners

Abort job

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

const body = `{
  "runnerToken": "string",
  "jobToken": "string",
  "reason": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string",
  "jobToken": "string",
  "reason": "string"
}'''

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string",
  "reason": "string"
}

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

reasonstringrequired

Why the runner aborts this job

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

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

Post job error

POST

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

API used by PeerTube runners

Post job error

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

const body = `{
  "runnerToken": "string",
  "jobToken": "string",
  "message": "string"
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string",
  "jobToken": "string",
  "message": "string"
}'''

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string",
  "message": "string"
}

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

messagestringrequired

Why the runner failed to process this job

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

Post job success

POST

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

API used by PeerTube runners

Post job success

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

const body = `{
  "runnerToken": "string",
  "jobToken": "string",
  "payload": {
    "videoFile": "<binary>"
  }
}`;

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

const data = await response.text();

import requests

body = '''{
  "runnerToken": "string",
  "jobToken": "string",
  "payload": {
    "videoFile": "<binary>"
  }
}'''

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string",
  "payload": {
    "videoFile": "<binary>"
  }
}

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

payloadobjectrequired

Show child attributes

Any of

videoFilestring<binary>

resolutionPlaylistFilestring<binary>

videoFilestring<binary>

object

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

Download the max-quality audio file for a job video

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/max-quality/audio

API used by PeerTube runners.

Download the max-quality audio file for a job video

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string"
}

200

"<binary>"

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

videoIdOrUUIDid | UUIDv4 | shortUUIDrequiredpath

Video id or UUID

Response

200OKstring<binary>

successful operation

Response fields application/octet-stream

string<binary>

403Forbidden

the job is not associated with this video

Download the max-quality video file for a job video

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/max-quality

API used by PeerTube runners.

Download the max-quality video file for a job video

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string"
}

200

"<binary>"

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

videoIdOrUUIDid | UUIDv4 | shortUUIDrequiredpath

Video id or UUID

Response

200OKstring<binary>

successful operation

Response fields application/octet-stream

string<binary>

403Forbidden

the job is not associated with this video

Download the max-quality thumbnail for a job video

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/thumbnails/max-quality

API used by PeerTube runners.

Download the max-quality thumbnail for a job video

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string"
}

200

"<binary>"

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

videoIdOrUUIDid | UUIDv4 | shortUUIDrequiredpath

Video id or UUID

Response

200OKstring<binary>

successful operation

Response fields application/octet-stream

string<binary>

403Forbidden

the job is not associated with this video

Download the max-quality preview for a job video

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/previews/max-quality

API used by PeerTube runners.

Download the max-quality preview for a job video

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string"
}

200

"<binary>"

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

videoIdOrUUIDid | UUIDv4 | shortUUIDrequiredpath

Video id or UUID

Response

200OKstring<binary>

successful operation

Response fields application/octet-stream

string<binary>

403Forbidden

the job is not associated with this video

Download a video studio task file for a job video

POST

https://peertube2.cpy.re/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/studio/task-files/{filename}

API used by PeerTube runners.

Download a video studio task file for a job video

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

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

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

const data = await response.text();

import requests

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

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

Request Body

{
  "runnerToken": "string",
  "jobToken": "string"
}

200

"<binary>"

Body

application/json

runnerTokenstringrequired

jobTokenstringrequired

Parameters

jobUUIDUUIDv4<uuid>requiredpath

videoIdOrUUIDid | UUIDv4 | shortUUIDrequiredpath

Video id or UUID

filenamestringrequiredpath

Name of the task file to download

Response

200OKstring<binary>

successful operation

Response fields application/octet-stream

string<binary>

400Bad Request

the file is not associated with this edition task

403Forbidden

the job is not associated with this video

Cancel a job

POST

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

Cancel a job

curl -X POST 'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/cancel', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.post(
    'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d/cancel',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Delete a job

DELETE

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

The endpoint will first cancel the job if needed, and then remove it from the database. Children jobs will also be removed

Delete a job

curl -X DELETE 'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.delete(
    'https://peertube2.cpy.re/api/v1/runners/jobs/9c9de5e8-0a1e-484a-b099-e80766180a6d',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

Parameters

jobUUIDUUIDv4<uuid>requiredpath

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

List jobs

GET

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

List jobs

curl -X GET 'https://peertube2.cpy.re/api/v1/runners/jobs?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/runners/jobs?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/runners/jobs?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "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"
      },
      "privatePayload": {}
    }
  ]
}

Parameters

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringupdatedAtcreatedAtprioritystateprogressquery

Sort runner jobs by criteria

searchstringquery

Plain text search, applied to various parts of the model depending on endpoint

stateOneOfArray<RunnerJobState>12345678query

typeOneOfArray<RunnerJobType>vod-web-video-transcodingvod-hls-transcodingvod-audio-merge-transcodinglive-rtmp-hls-transcodingquery

Response

200OKobject

successful operation

Response fields application/json

totalinteger

Example

dataArray<RunnerJobAdmin>

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

privatePayloadobject

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

Have an activated account
Generate an access token for that account at /api/v1/users/token.
Make requests with the Authorization: Bearer <token> header
Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Scopes: admin

Docs by Sourcey