Skip to main content
POST
File Stream Upload
Upload temporary files via multipart/form-data format. Note: Uploaded files are temporary and automatically deleted after 3 days.

Features

  • Supports binary stream upload for various file types
  • Suitable for large file uploads with high transmission efficiency
  • Automatic MIME type recognition
  • Support for custom file names or using original file names
  • Returns complete file information and download links
  • API Key authentication protection
  • Uploaded files are temporary and automatically deleted after 3 days

Usage Recommendations

  • Recommended for large files (>10MB)
  • Supports various formats: images, videos, documents, etc.
  • Transmission efficiency is approximately 33% higher than Base64 format

Example Command

Authorizations

Authorization
string
header
required

All APIs require authentication via Bearer Token.

Get API Key:

  1. Visit API Key Management Page to get your API Key

Usage: Add to request header: Authorization: Bearer YOUR_API_KEY

Note:

  • Keep your API Key secure and do not share it with others
  • If you suspect your API Key has been compromised, reset it immediately in the management page

Body

multipart/form-data
file
file
required

File to upload (binary data)

uploadPath
string
required

File upload path, without leading or trailing slashes

Example:

"images/user-uploads"

fileName
string

File name (optional), including file extension. If not provided, a random file name will be generated. If the same file name already exists, the old file will be overwritten. Note: Due to caching, changes may not take effect immediately.

Example:

"my-image.jpg"

Response

File uploaded successfully

success
boolean
required

Whether the request was successful

code
enum<integer>
required

Response Status Code

Available options:
200,
400,
401,
405,
500
msg
string
required

Response message

Example:

"File uploaded successfully"

data
object