Get thumbnail URL

Get the thumbnail URL of the given file.

How to decode obfuscated thumbnail URL?

If obfuscated is set to true in the response, you need addition step to recover the original image URL.
Here's implementation for the decode functioin in multiple languages

JavaScript

Golang

Java

Python

Request

Authorization

Add the parameter

Authorization

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

Example:

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

Query Params

uri

string

optional

URI of the target file.

Example:

cloudreve://my/pic.png

Header Params

X-Cr-Context-Hint

string <uuid>

optional

Optional context hint to speed up DB queries. You can get its value from the response of listing files. It is recommended to set this header if you need to perform action on files that are just listed by List files API.

Example:

b832b998-7ece-4ffd-ba6b-afb64530ca70

X-Cr-Purchase-Ticket

string

optional

Can be used to authenticate to paid share links with a anonymous identity. The ticket value can be obtained after an anonymous user purchase a paid share link.

Example:

1f63aa26-edc0-40ce-950a-cb4d4323158e

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

data

object

required

Response content. In some error type, e.g. lock conflicting errors, this field wil present details of the error, e.g. who is locking the current file.

url

string

required

URL of the thumbnail image. Possibly be obfuscated if obfuscated is true. Please refer to the top of this document for how to decode it.

Example:

http://localhost:5173/api/v4/file/content/8BxU0/0/%5BSakurato%5D%20Sousou%20no%20Frieren%20%5B03%5D%5BAVC-8bit%201080p%20AAC%5D%5BCHS%5D.mp4.jpg?sign=9AGk__dPoeoKlvKaoN0kdg-3ptC9Mp66lY3AgN-vHws%3D%3A1749530110

obfuscated

boolean | null

optional

Whether the url is obfuscated.

expires

string <date-time>

required

Expire date of the thumbnail image.

Example:

2025-06-10T12:35:10.014076+08:00

code

integer

required

Response code.
0 - Success.

Default:

Example:

msg

string

optional

Human readable error message (if any).

error

string | null

optional

Internal error message, only visable in debug mode.

correlation_id

string <uuid> | null

optional

Correlation ID of the request. Only presented on failed reqeust.

Example:

b4351ecc-ee1a-4455-bc94-2c3dbcc58538

Examples

No obfuscationObfuscated

{
    "code": 0,
    "data": {
        "url": "http://localhost:5173/api/v4/file/content/rd7cK/0/The%20Man.mp3.jpg?sign=es-PXHqamu0zpF5FtSGKwl6uQANJ7hdURC_hv1ndaSs%3D%3A1749530110",
        "expires": "2025-06-10T12:35:10.014076+08:00",
        "obfuscated": true
    },
    "msg": ""
}

How to decode obfuscated thumbnail URL?#

Request

Request samples

Responses

How to decode obfuscated thumbnail URL?