Tiedostot

Lataa, listaa ja hae tiedostoja IPFS:ssä.

Lataa tiedosto

POST /upload/new

Lataa mikä tahansa tiedosto IPFS:ään. Tiedosto kiinnitetään ja pysyvä CID palautetaan.

Pyynnön runko

Parametri	Tyyppi	Pakollinen	Kuvaus
content	string | object	Kyllä	JSON-objekti/taulukko tai base64-koodattu tiedostodata (kuvat, PDF, HTML tai mikä tahansa tiedostotyyppi).
description	string	Ei	Lyhyt kuvaus ladatusta sisällöstä.
metadata	object	Ei	Mukautetut avain-arvo-parit liitettäväksi tiedostoon. Enintään 10 avainta. Avainten on oltava aakkosnumeerisia tai alaviivoja, 1-64 merkkiä. Arvojen on oltava merkkijonoja, enintään 256 merkkiä kukin. Metatietojen kokonaiskoko ei saa ylittää 4 KB.

Esimerkkipyyntö

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

Kuvan lataaminen (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"
  })
});

Vastaus 200 OK

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

Listaa tiedostot

GET /upload/list

Hae lista ladatuista IPFS-tiedostoista aikavälin sisällä.

Kyselyparametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
from	number	Kyllä	Aikavälin alku, Unix-aikaleima millisekunneissa.
to	number	Kyllä	Aikavälin loppu, Unix-aikaleima millisekunneissa.

Esimerkkipyyntö

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

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

Hae tiedosto

GET /file/:cid

Hae tietyn ladatun tiedoston metatiedot sen CID:n perusteella.

Polkuparametrit

Parametri	Tyyppi	Pakollinen	Kuvaus
cid	string	Kyllä	Tiedoston IPFS-sisältötunniste.

Esimerkkipyyntö

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

Vastaus 200 OK

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