ไฟล์

อัปโหลด, แสดงรายการ และเรียกดูไฟล์บน IPFS

อัปโหลดไฟล์

POST /upload/new

อัปโหลดไฟล์ใดก็ได้ไปยัง IPFS ไฟล์จะถูกปักหมุดและส่งคืน CID ถาวร

เนื้อหาคำขอ

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
content	string | object	ใช่	อ็อบเจกต์/อาร์เรย์ JSON หรือข้อมูลไฟล์ที่เข้ารหัส base64 (รูปภาพ, PDF, HTML หรือไฟล์ประเภทใดก็ได้)
description	string	ไม่	คำอธิบายสั้นๆ ของเนื้อหาที่อัปโหลด
metadata	object	ไม่	คู่คีย์-ค่าที่กำหนดเองเพื่อแนบกับไฟล์ สูงสุด 10 คีย์ คีย์ต้องเป็นตัวอักษรและตัวเลขหรือขีดล่าง 1-64 ตัวอักษร ค่าต้องเป็นสตริง สูงสุด 256 ตัวอักษร ขนาด metadata รวมต้องไม่เกิน 4 KB

ตัวอย่างคำขอ

curl -X POST https://api.ipfs.ninja/upload/new \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": { "name": "example", "value": 42 },
    "description": "Test upload",
    "metadata": {
      "project": "my-app",
      "environment": "production"
    }
  }'

อัปโหลดรูปภาพ (base64)

const fs = require("fs");
const image = fs.readFileSync("photo.png").toString("base64");

const response = await fetch("https://api.ipfs.ninja/upload/new", {
  method: "POST",
  headers: {
    "X-Api-Key": "bws_your_api_key_here",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    content: image,
    description: "Profile photo"
  })
});

การตอบกลับ 200 OK

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}

แสดงรายการไฟล์

GET /upload/list

เรียกดูรายการไฟล์ IPFS ที่คุณอัปโหลดในช่วงเวลาที่กำหนด

พารามิเตอร์คิวรี

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
from	number	ใช่	เวลาเริ่มต้น, Unix timestamp เป็น milliseconds
to	number	ใช่	เวลาสิ้นสุด, Unix timestamp เป็น milliseconds

ตัวอย่างคำขอ

curl "https://api.ipfs.ninja/upload/list?from=1704067200000&to=1735689600000" \
  -H "X-Api-Key: bws_your_api_key_here"

การตอบกลับ 200 OK

[
  {
    "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "fileName": "Test upload",
    "fileType": "json",
    "sizeMB": 0.001,
    "createdAt": 1711036800000,
    "metadata": {
      "project": "my-app",
      "environment": "production"
    },
    "uris": {
      "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
      "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
    }
  }
]

รับข้อมูลไฟล์

GET /file/:cid

เรียกดู metadata สำหรับไฟล์ที่อัปโหลดเฉพาะโดย CID

พารามิเตอร์ path

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
cid	string	ใช่	ตัวระบุเนื้อหา IPFS ของไฟล์

ตัวอย่างคำขอ

curl https://api.ipfs.ninja/file/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN \
  -H "X-Api-Key: bws_your_api_key_here"

การตอบกลับ 200 OK

{
  "cid": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "fileName": "Test upload",
  "fileType": "json",
  "sizeMB": 0.001,
  "createdAt": 1711036800000,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}