Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rivenmedia/riven/llms.txt

Use this file to discover all available pages before exploring further.

Debrid services act as cloud torrent caches. When Riven finds a matching torrent through its scrapers, it checks whether your debrid provider already has that torrent cached and can serve it instantly. Riven then mounts the file into the VFS for your media server to play — no local download required. Only one debrid service needs to be active at a time. All three providers (Real-Debrid, AllDebrid, and Debrid-Link) are mutually supported; enable exactly the one you subscribe to.
A premium membership is required on your chosen debrid service. Riven validates premium status on startup and will refuse to initialize the downloader if the account is free or expired.

Shared downloader settings

These fields under downloaders apply globally, regardless of which debrid service is active.
downloaders.video_extensions
list[string]
default:"[\"mp4\", \"mkv\", \"avi\"]"
File extensions that Riven considers valid video files when evaluating a torrent’s contents. Files with other extensions are ignored during availability checks.
downloaders.movie_filesize_mb_min
integer
default:"700"
Minimum file size in megabytes for a movie file to be accepted. Torrents whose largest video file is smaller than this threshold are rejected. Must be ≥ 1.
downloaders.movie_filesize_mb_max
integer
default:"-1"
Maximum file size in megabytes for a movie file. Set to -1 for no upper limit.
downloaders.episode_filesize_mb_min
integer
default:"100"
Minimum file size in megabytes for an episode file. Must be ≥ 1.
downloaders.episode_filesize_mb_max
integer
default:"-1"
Maximum file size in megabytes for an episode file. Set to -1 for no upper limit.
downloaders.proxy_url
string
default:"\"\""
Optional proxy URL applied to all outbound debrid API requests. Must begin with http://, https://, socks5://, or socks5h://. Leave empty to connect directly.

Debrid service configuration

Real-Debrid is the most widely used debrid service in the Riven community. Configuration lives at downloaders.real_debrid.
downloaders.real_debrid.enabled
boolean
default:"false"
Enable the Real-Debrid downloader. Riven will verify your API key and premium status on startup.
downloaders.real_debrid.api_key
string
default:"\"\""
Your Real-Debrid API key. Retrieve it from https://real-debrid.com/apitoken after logging in.
Example configuration snippet
{
  "downloaders": {
    "real_debrid": {
      "enabled": true,
      "api_key": "YOUR_REALDEBRID_API_KEY"
    }
  }
}
Enable via API
curl -X POST "http://localhost:8080/api/v1/settings/set/all" \
  -H "Authorization: Bearer YOUR_RIVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "downloaders": {
      "real_debrid": {
        "enabled": true,
        "api_key": "YOUR_REALDEBRID_API_KEY"
      }
    }
  }'
Real-Debrid enforces a rate limit of approximately 250 requests per minute. Riven’s built-in SmartSession respects this limit automatically using a token-bucket algorithm.

Check account status

After enabling a debrid service, you can confirm that Riven has connected successfully and inspect account details using the downloader user-info endpoint:
curl -H "Authorization: Bearer YOUR_RIVEN_API_KEY" \
  "http://localhost:8080/api/v1/downloader_user_info"
A successful response includes the username, email, premium status, expiration date, and days remaining on your subscription.
Enable only one debrid service at a time. Riven does not support splitting downloads across multiple providers simultaneously.

Full example with file-size filters

{
  "downloaders": {
    "video_extensions": ["mp4", "mkv", "avi"],
    "movie_filesize_mb_min": 700,
    "movie_filesize_mb_max": -1,
    "episode_filesize_mb_min": 100,
    "episode_filesize_mb_max": -1,
    "proxy_url": "",
    "real_debrid": {
      "enabled": true,
      "api_key": "YOUR_REALDEBRID_API_KEY"
    },
    "debrid_link": {
      "enabled": false,
      "api_key": ""
    },
    "all_debrid": {
      "enabled": false,
      "api_key": ""
    }
  }
}

Build docs developers (and LLMs) love