Create remote download - Cloudreve API Docs

Request

Authorization

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Body Params application/json

dst

string

required

URI of the destination folder.

src_file

string

optional

URI of the source torrent file. If this field is empty, src is required.

src

array[string]

optional

List of URL to be download. Can be HTTP or magnet link, depending on the configured downloader. If this field is empty, src_file is required.

preferred_node_id

string

optional

ID of preferred node to process

Examples

Download from existing torrent fileDownload from URL

{
    "src_file": "cloudreve://my/big-buck-bunny_202112_archive.torrent",
    "dst": "cloudreve://my",
    "preferred_node_id": "m9uO"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

cURL

Download from existing torrent fileDownload from URL

curl --location --request POST '/workflow/download' \
--header 'Content-Type: application/json' \
--data-raw '{
    "src_file": "cloudreve://my/big-buck-bunny_202112_archive.torrent",
    "dst": "cloudreve://my",
    "preferred_node_id": "m9uO"
}'

Responses

🟢200Success

application/json

Body

data

object

required

code

integer

required

Response code.
0 - Success.

Default:

0

Example:

0

msg

string

optional

Human readable error message (if any).

Example

{
    "code": 0,
    "data": [
        {
            "created_at": "2025-05-20T13:27:36.003255+08:00",
            "updated_at": "2025-05-20T13:27:36.003255+08:00",
            "id": "agr0hj",
            "status": "queued",
            "type": "remote_download",
            "summary": {
                "props": {
                    "download": null,
                    "dst": "cloudreve://my",
                    "failed": 0,
                    "src": "",
                    "src_str": "https://github.com/cloudreve/Cloudreve/releases/download/4.0.0-beta.11/cloudreve_4.0.0-beta.11_darwin_amd64.tar.gz"
                }
            }
        }
    ],
    "msg": ""
}