Create upload session

Create a upload session, which is required before uploading files. After upload session created, client should start uploading using the information included in the upload session. The implementation of upload differs from different storage policy type, you can find Cloudreve's implentation in uploader.

A general file uploading includes 3 steps: Create upload session, upload chunks, finish upload request. For small files, please consider using Update file content.

1. Create upload session

Use current method to create an upload session.

2. Upload chunks

For local storage policy, or any other storage policy with storage_policy.relay set to true, use Upload file chunk;

For remote storage policy, send chunks to the URL defined in upload_urls, there should be only one element in upload_urls. The request is similar to Upload file chunk, except:

Chunk index is passed through query chunk, e.g. http://slavecloudreve.com:5213/api/v4/slave/upload/f1dd2c8c-0c51-475b-a086-b338ae1d8109?chunk=2

Authorization shoud be the value of credential in upload session, e.g. Bearer Cr sBnnQ3rZ-UBr7d8ohKpUFtsQc8OMLuWwn1VhuJtdc5k=:1749623351

For any other storage policies, please refer to:

S3: UploadPart

OSS: UploadPart

COS: UploadPart

OBS: Uploading Parts

OneDrive: Upload bytes to the upload session

Qiniu: 分块上传数据

Upyun: 大文件上传

3. Finish upload

For local/remote/upyun storage policy, or any other storage policy with storage_policy.relay set to true, you don't need to finish upload, it's automatically finished after last chunk uploaded.

OneDrive: Complete OneDrive upload

S3: CompleteMultipartUpload, then send Complete S3 upload

COS: Complete Multipart Upload, then send Complete COS upload

OBS: Completing a Multipart Upload, then send Complete OBS upload

Qiniu: 完成文件上传

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

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

Header 参数

Body 参数application/json

示例

{
    "uri": "cloudreve://my/Inspirations/archive%20(3).zip",
    "size": 65328441,
    "policy_id": "J7uV",
    "last_modified": 1749524701494,
    "mime_type": "application/zip"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200Success

application/json

Body

示例

{
    "code": 0,
    "data": {
        "session_id": "9897ebae-7b73-4169-aabc-6396f470e4bb",
        "upload_id": "",
        "chunk_size": 26214400,
        "expires": 1749620196,
        "storage_policy": {
            "id": "J7uV",
            "name": "Default storage policy",
            "type": "local",
            "max_size": 0
        },
        "uri": "cloudreve://my/Inspirations/archive%20(3).zip",
        "callback_secret": "0SivUl28p44BADmQDkTJrJOo7iozN74W"
    },
    "msg": ""
}

1. Create upload session#