How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

PeerTube Runner Jobs API

Manage runner jobs and runner-side job execution.

PeerTube Runner Jobs API is one of 54 APIs that PeerTube publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Runner Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 14 operations across 14 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

14 operations 14 paths 9 schemas 1 DELETE1 GET12 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube Runner Jobs API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 14

Across 14 paths, the API surfaces 14 operations — 1 DELETE, 1 GET, 12 POST. Each is listed below with its method, path, parameters, and response codes.

Runner Jobs 14

Manage runner jobs and runner-side job execution.

POST
/api/v1/runners/jobs/request
Request a new job
body → 200
POST
/api/v1/runners/jobs/{jobUUID}/accept
Accept job
1 param body → 200
POST
/api/v1/runners/jobs/{jobUUID}/abort
Abort job
1 param body → 204
POST
/api/v1/runners/jobs/{jobUUID}/update
Update job
1 param body → 204
POST
/api/v1/runners/jobs/{jobUUID}/error
Post job error
1 param body → 204
POST
/api/v1/runners/jobs/{jobUUID}/success
Post job success
1 param body → 204
POST
/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/max-quality/audio
Download the max-quality audio file for a job video
2 params body → 200403
POST
/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/max-quality
Download the max-quality video file for a job video
2 params body → 200403
POST
/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/thumbnails/max-quality
Download the max-quality thumbnail for a job video
2 params body → 200403
POST
/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/previews/max-quality
Download the max-quality preview for a job video
2 params body → 200403
POST
/api/v1/runners/jobs/{jobUUID}/files/videos/{videoIdOrUUID}/studio/task-files/{filename}
Download a video studio task file for a job video
3 params body → 200400403
POST
/api/v1/runners/jobs/{jobUUID}/cancel
Cancel a job
1 param → 204
DELETE
/api/v1/runners/jobs/{jobUUID}
Delete a job
1 param → 204
GET
/api/v1/runners/jobs
List jobs
6 params → 200

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are RunnerJob (14 properties), RunnerJobStateConstant (2 properties). Each schema is shown below with its type and property counts.

RunnerJobState
integer
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 be…
RunnerJob
object
14 properties
RunnerJobStateConstant
object
2 properties
RunnerJobType
string
RunnerJobAdmin
id
integer
RunnerJobPayload
shortUUID
string
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
UUIDv4
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-runner-jobs-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
Where this information came from

This is an independent, third-party profile of PeerTube Runner Jobs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.