Fail

Muat naik, senarai dan dapatkan fail di IPFS.

Muat Naik Fail

POST /upload/new

Muat naik sebarang fail ke IPFS. Fail disemat dan CID kekal dikembalikan.

Badan permintaan

Parameter	Jenis	Diperlukan	Penerangan
content	string | object	Ya	Objek/tatasusunan JSON, atau data fail berkod base64 (imej, PDF, HTML, atau sebarang jenis fail).
description	string	Tidak	Penerangan ringkas kandungan yang dimuat naik.
metadata	object	Tidak	Pasangan kunci-nilai tersuai untuk dilampirkan pada fail. Maks 10 kunci. Kunci mestilah alfanumerik atau garis bawah, 1-64 aksara. Nilai mestilah rentetan, maks 256 aksara setiap satu. Jumlah saiz metadata tidak boleh melebihi 4 KB.

Contoh permintaan

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"
    }
  }'

Memuat naik imej (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"
  })
});

Respons 200 OK

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

Senaraikan Fail

GET /upload/list

Dapatkan senarai fail IPFS anda yang dimuat naik dalam julat masa.

Parameter pertanyaan

Parameter	Jenis	Diperlukan	Penerangan
from	number	Ya	Permulaan julat masa, cap masa Unix dalam milliseconds.
to	number	Ya	Akhir julat masa, cap masa Unix dalam milliseconds.

Contoh permintaan

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

Respons 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"
    }
  }
]

Dapatkan Fail

GET /file/:cid

Dapatkan metadata untuk fail yang dimuat naik tertentu mengikut CID-nya.

Parameter laluan

Parameter	Jenis	Diperlukan	Penerangan
cid	string	Ya	Pengecam kandungan IPFS bagi fail tersebut.

Contoh permintaan

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

Respons 200 OK

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