Mga File

Mag-upload, maglista, at kumuha ng mga file sa IPFS.

Mag-upload ng File

POST /upload/new

Mag-upload ng anumang file sa IPFS. Napi-pin ang file at ibinabalik ang permanenteng CID.

Request body

Parameter	Uri	Kinakailangan	Paglalarawan
content	string | object	Oo	JSON object/array, o base64-encoded file data (imahe, PDF, HTML, o anumang uri ng file).
description	string	Hindi	Maikling paglalarawan ng na-upload na nilalaman.
metadata	object	Hindi	Custom key-value pairs na ila-attach sa file. Max 10 key. Ang mga key ay dapat alphanumeric o underscore, 1-64 character. Ang mga value ay dapat string, max 256 character bawat isa. Ang kabuuang laki ng metadata ay hindi dapat lumagpas sa 4 KB.

Halimbawang request

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

Pag-upload ng imahe (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"
  })
});

Response 200 OK

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

Ilista ang mga File

GET /upload/list

Kunin ang listahan ng iyong na-upload na IPFS file sa loob ng isang time range.

Mga query parameter

Parameter	Uri	Kinakailangan	Paglalarawan
from	number	Oo	Simula ng time range, Unix timestamp sa milliseconds.
to	number	Oo	Katapusan ng time range, Unix timestamp sa milliseconds.

Halimbawang request

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

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

Kunin ang File

GET /file/:cid

Kunin ang metadata para sa isang partikular na na-upload na file gamit ang CID nito.

Mga path parameter

Parameter	Uri	Kinakailangan	Paglalarawan
cid	string	Oo	Ang IPFS content identifier ng file.

Halimbawang request

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

Response 200 OK

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