Main Navigation Guide API Integrations Developer Legal Changelog

Appearance

Sidebar Navigation

API Reference

Overview

Torznab

qBittorrent Shim

Jobs & Events

STRM Proxy

Environment

Data Model

Operations

Health

GET Health check

Jobs

POST Enqueue a direct download job

GET Get job status

DELETE Cancel a job

GET Stream job events (SSE)

STRM Proxy

GET Stream a resolved episode (STRM proxy)

HEAD Stream metadata (HEAD) for a resolved episode

GET Proxy upstream HLS resources

HEAD Proxy upstream metadata (HEAD)

GET Proxy upstream resources with path hints

HEAD Proxy upstream metadata (HEAD) with path hints

Torznab

GET Torznab query (caps, search, tvsearch, movie)

qBittorrent Auth

POST Login (stubbed)

POST Logout

qBittorrent Torrents

POST Add torrent(s)

GET List torrents

GET List torrent files

GET Torrent properties

POST Delete torrents

qBittorrent Categories

GET List categories

POST Create category

POST Edit category

POST Remove categories

qBittorrent Sync

GET Sync main data

qBittorrent Transfer

GET Transfer info

qBittorrent App

GET App version

GET Web API version

GET Build info

GET Preferences

Stream job events (SSE)

GET

/jobs/{job_id}/events

Parameters

Path Parameters

job_id*

Type

string

Required

Responses

Server-sent events stream.

Content-Type

text/event-stream

JSON

"string"

GET

/jobs/{job_id}/events

Playground

Variables

Key

Value

job_id*

Samples

Edit this page on GitHub

Updated at:

Pager

Previous page DELETE Cancel a job

Next page GET Stream a resolved episode (STRM proxy)

Released under the BSD 3 Clause License.

Stream job events (SSE)​

Parameters​

Path Parameters

Responses​

Playground​

Samples​

Stream job events (SSE)

Parameters

Responses

Playground

Samples