Tổng quan
API của Uploadex cho phép bạn tải tệp lên, liệt kê tệp và cập nhật siêu dữ liệu bằng lập trình, thay mặt cho chủ sở hữu khóa API. Mỗi điểm cuối là một tài nguyên REST: đầu vào là JSON (hoặc multipart cho tệp tải lên dạng nhị phân), đầu ra là JSON, chỉ dùng HTTPS.
- URL gốc
https://uploadex.net/api/v1 - Xác thực Mã thông báo Bearer trong header
Authorization - Truyền tải Chỉ HTTPS · TLS 1.2 hoặc 1.3
- Mã hóa UTF-8 JSON ·
multipart/form-datafor lượt tải lên - Ngày tháng ISO 8601 theo UTC ·
2026-04-21T08:12:04Z
Xác thực
Mọi yêu cầu phải bao gồm một header Authorization với mã thông báo Bearer. Tạo và luân chuyển khóa từ bảng điều khiển nhà phát triển của bạn.
Authorization: Bearer ux_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXCác khóa bắt đầu bằng ux_live_. Chúng chỉ được hiển thị đúng một lần khi tạo — hãy lưu chúng trong một trình quản lý bí mật. Các khóa có thể được giới hạn phạm vi cho các hành động cụ thể (files:read, files:write, upload, hoặc *) và được đặt hết hạn vào một ngày trong tương lai.
Tiêu đề
Truy xuất thông tin tài khoản của bạn để xác nhận khóa hoạt động.
# Get your account info
curl https://uploadex.net/api/v1/account \
-H "Authorization: Bearer $UX_API_KEY"{
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxx",
"email": "[email protected]",
"name": "Your Name",
"plan": "PRO",
"balance": 0,
"totalEarnings": 0,
"storageUsed": 52428800,
"storageLimit": 53687091200,
"storageFormatted": "50 MB / 50 GB",
"fileCount": 3,
"createdAt": "2026-04-01T09:21:00.000Z"
}
}Gói limits
Giới hạn tải lên và lưu trữ được quyết định theo gói và có thể thay đổi khi tài khoản nâng cấp hoặc hạ cấp. Giới hạn cho các gói bao gồm truy cập API:
| Gói | Max Kích thước tệp | Dung lượng |
|---|---|---|
| Pro | 10 GB | 100 GB |
| Business | 50 GB | 1 TB |
Tiêu đề
Giới hạn tốc độ bảo vệ dịch vụ khỏi lưu lượng vượt tầm kiểm soát. Vượt quá giới hạn sẽ trả về 429 Too Many Requests.
| Phạm vi | Giới hạn | Khoảng thời gian | Chủ đề |
|---|---|---|---|
| Tải lên init | 30 | 1 min | per Khóa API |
| Tải xuống | 60 | 1 min | tải xuống |
| Đăng nhập | 10 | 15 min | mỗi IP |
| Đăng ký | 5 | 1h | mỗi IP |
Lỗis
Lỗi responses use standard HTTP trạng thái codes and a consistent JSON body.
{ "error": "Invalid or missing API key" }| Trạng thái | Ý nghĩa |
|---|---|
| 400 | Nội dung yêu cầu không hợp lệ hoặc không vượt qua bước xác thực. |
| 401 | Missing or invalid Khóa API. |
| 403 | Khóa thiếu phạm vi quyền bắt buộc (ví dụ: files:write). |
| 404 | Tài nguyên không tồn tại hoặc không thuộc về chủ sở hữu khóa. |
| 413 | Tệp vượt quá giới hạn dung lượng tệp của gói tài khoản. |
| 429 | Rate limit exceeded. SThấp down and retry. |
| 500 | Lỗi nội bộ. Hãy kiểm tra trang trạng thái trước khi thử lại. |
Tiêu đề
List Điểm cuốis use page-based pagination. Pass page (1-indexed) and limit (max 100) as query parameters.
GET /api/v1/files?page=1&limit=50Tài khoản
/api/v1/accountReturn Tài khoản Thông tin, gói, Dung lượng usage, tệp count.Scope: no scope Bắt buộc beyond a valid key.
Tải lên
/api/v1/uploadKhởi tạo một lượt tải lên nhiều phần. Trả về các URL đã ký sẵn mà client dùng để PUT các phần lên bộ lưu trữ đối tượng R2.| Trường | Loại | Mô tả |
|---|---|---|
| filename | string · required | Tên tệp, including extension (max 255 chars). |
| size | integer · required | Đếntal Kích thước tệp in bytes. |
| contentType | string · required | Nội dung |
Phạm vi: upload. Trả về 413 nếu size vượt quá giới hạn gói của tài khoản.
Tệp
/api/v1/filesLiệt kê các tệp thuộc sở hữu của khóa. Hỗ trợ page, limit (tối đa 100), status./api/v1/files/:idRetrieve a single tệp by ID./api/v1/files/:idCập nhật displayName, Mô tả, Thẻ, or Chế độ hiển thị./api/v1/files/:idXóa tệp và thu hồi hạn ngạch lưu trữ.{
"data": {
"id": "clxxxxxxxxxxxxxxxxxxxxxx",
"slug": "9nK2xA",
"filename": "demo.mp4",
"size": 881975296,
"sizeFormatted": "841.1 MB",
"mimeType": "video/mp4",
"status": "READY",
"scanStatus": "CLEAN",
"downloads": 128,
"views": 412,
"tags": ["demo"],
"visibility": "PUBLIC",
"adsEnabled": true,
"createdAt": "2026-04-21T08:12:04.000Z",
"updatedAt": "2026-04-21T08:12:04.000Z"
}
}Phạm vi: GET yêu cầu files:read; PATCH/DELETE yêu cầu files:write.
Hãy mở một phiếu hỗ trợ và mô tả trường hợp sử dụng.