Tham chiếu API

Tất cả các endpoint, tham số, định dạng yêu cầu/phản hồi và mã lỗi.

URL Cơ sở

https://api.ipfs.ninja

Tất cả các yêu cầu đều cần khóa API qua tiêu đề X-Api-Key. Xem Xác thực để biết chi tiết.

Endpoint

Phương thức	Đường dẫn	Mô tả	Trang
POST	/upload/new	Tải tệp lên IPFS	Tệp
GET	/upload/list	Liệt kê các tệp đã tải lên	Tệp
GET	/file/:cid	Lấy siêu dữ liệu tệp theo CID	Tệp
PUT	/files/:cid/name	Đổi tên tệp	Tệp
PUT	/files/:cid/move	Di chuyển tệp vào một thư mục	Thư mục
POST	/pin	Ghim CID hiện có từ mạng IPFS (hỗ trợ gợi ý swarm-connect)	Ghim
GET	/pin/:cid	Kiểm tra trạng thái ghim	Ghim
POST	/folders	Tạo thư mục	Thư mục
GET	/folders	Liệt kê thư mục	Thư mục
PUT	/folders/:folderId	Cập nhật thư mục	Thư mục
DELETE	/folders/:folderId	Xóa thư mục	Thư mục
POST	/folders/:folderId/snapshot	Chụp nhanh một thư mục thành một CID thư mục	Thư mục
PUT	/folders/:folderId/cors	Đặt cấu hình CORS theo từng bucket	Thư mục
GET	/folders/:folderId/cors	Lấy cấu hình CORS theo từng bucket	Thư mục
DELETE	/folders/:folderId/cors	Xóa cấu hình CORS theo từng bucket	Thư mục
GET	/user/profile	Lấy hồ sơ người dùng	Hồ sơ
POST	/apikeys	Tạo khóa API	Khóa API
GET	/apikeys	Liệt kê khóa API	Khóa API
DELETE	/apikeys/:key	Xóa khóa API	Khóa API
GET	/analytics	Phân tích sử dụng	Phân tích
PUT	/gateway-settings	Cập nhật cài đặt gateway	Gateway
POST	/gateway-tokens	Tạo token gateway	Gateway
GET	/gateway-tokens	Liệt kê token gateway	Gateway
DELETE	/gateway-tokens/:prefix	Xóa token gateway	Gateway
POST	/upload/signed-url	Tạo token tải lên có chữ ký	Token có chữ ký
GET	/signed-tokens	Liệt kê token có chữ ký	Token có chữ ký
DELETE	/signed-tokens/:tokenId	Thu hồi token có chữ ký	Token có chữ ký
GET	/image/:cid	Tối ưu hóa hình ảnh trực tiếp	Tối ưu hóa hình ảnh

CIDv1 theo mặc định

Các lần tải lên và ghim trả về CIDv1 hiện đại (bafk… cho nội dung nhỏ dạng một khối, bafy… cho các tệp và thư mục lớn hơn) theo hồ sơ IPIP-0499 unixfs-v1-2025. Các CID Qm… cũ từ các lần tải lên trước đó vẫn hoàn toàn có thể phân giải ở mọi nơi — Qm… là đầu vào hợp lệ cho bất kỳ endpoint nào chấp nhận CID.

API Tương thích S3

Sử dụng bất kỳ AWS SDK nào để tải lên và quản lý tệp trên IPFS Ninja. Trỏ client S3 của bạn đến https://s3.ipfs.ninja với khóa API của bạn làm thông tin xác thực.

https://s3.ipfs.ninja

Thao tác S3	Mô tả
PutObject	Tải tệp lên IPFS
GetObject	Tải tệp xuống
HeadObject	Lấy siêu dữ liệu tệp
DeleteObject	Bỏ ghim và xóa tệp
ListObjectsV2	Liệt kê tệp với bộ lọc tiền tố
CreateMultipartUpload	Bắt đầu tải lên nhiều phần (tối đa 5 GB)
UploadPart	Tải lên một phần
CompleteMultipartUpload	Hoàn tất tải lên nhiều phần
ListBuckets	Liệt kê các gateway của bạn
CreateBucket	Tạo một gateway (tên bucket là duy nhất toàn cục — trả về BucketAlreadyExists nếu đã bị chiếm)
DeleteBucket	Xóa một gateway
PutBucketCors	Cấu hình quy tắc CORS theo từng bucket (bắt buộc để sử dụng SDK trình duyệt)
GetBucketCors	Đọc cấu hình CORS hiện tại của một bucket
DeleteBucketCors	Xóa tất cả quy tắc CORS khỏi một bucket

Xem Tương thích S3 để biết tài liệu đầy đủ, ví dụ mã nguồn và hướng dẫn di chuyển.