Failid

Laadige üles, loetlege ja hankige faile IPFS-is.

Laadige fail üles

POST /upload/new

Laadige mis tahes fail IPFS-i üles. Fail kinnitatakse ja tagastatakse püsiv CID.

Päringu keha

Parameeter	Tüüp	Nõutud	Kirjeldus
content	string | object	Jah	JSON-objekt/massiiv või base64-kodeeritud failiandmed (pildid, PDF, HTML või mis tahes failitüüp). CAR importide puhul base64-kodeeritud CAR-fail.
car	boolean	Ei	Määrake väärtusele true, et importida CAR-fail (DAG import). Säilitab täpsed CID-d.
description	string	Ei	Üleslaaditud sisu lühikirjeldus.
metadata	object	Ei	Kohandatud võtme-väärtus paarid failile lisamiseks. Maks 10 võtit. Võtmed peavad olema tähtnumbrilised või allkriips, 1-64 tähemärki. Väärtused peavad olema stringid, maks 256 tähemärki igaüks. Metaandmete kogusuurus ei tohi ületada 4 KB.

Näidispäring

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

Pildi üleslaadimine (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"
  })
});

Vastus 200 OK

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

CIDv1 vaikimisi

Uued üleslaadimised tagastavad kaasaegse CIDv1 (bafk… väikese üheplokilise sisu jaoks, bafy… suuremate failide ja kataloogide jaoks) vastavalt IPIP-0499 unixfs-v1-2025 profiilile — 1 MiB tükid koos toorlehtedega. Varasemate üleslaadimiste vanapärased Qm… CID-d jäävad täielikult lahendatavaks ja töötavad edasi iga lõpp-punktiga.

Töölaua alternatiiv

Töölaua leht /upload aktsepteerib lohistamist failide, kaustade (mis pakitakse brauseris UnixFS-kataloogiks) ja .car-arhiivide jaoks — kõik suunatakse läbi sama lõpp-punkti. Vaadake CAR Import üksikasjade saamiseks CAR-tee kohta.

Nimetage fail ümber

PUT /files/:cid/name

Uuendage faili kuvatavat nime. CID ei muutu — see on sisu räsi — muutub ainult silt, mida näete oma failide loendis.

Päringu keha

Parameeter	Tüüp	Nõutud	Kirjeldus
name	string	Jah	Uus kuvatav nimi. 1-200 tähemärki. Ei tohi sisaldada tee-eraldajaid (/, \). Ainult tühikutest koosnevad nimed lükatakse tagasi.

Näidispäring

curl -X PUT https://api.ipfs.ninja/files/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi/name \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Season 1 promo art" }'

Vastus 200 OK

{
  "success": true,
  "cid": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "name": "Season 1 promo art"
}

Töölaud

Failide lehel on iga faili rea toimingumenüüs (kolme punkti nupp) kirje Nimeta ümber. Sama tulemus, koodi kirjutamata.

Loetlege failid

GET /upload/list

Hankige oma üleslaaditud IPFS-failide loend ajavahemiku piires.

Päringuparameetrid

Parameeter	Tüüp	Nõutud	Kirjeldus
from	number	Jah	Ajavahemiku algus, Unix ajatempel millisekundites.
to	number	Jah	Ajavahemiku lõpp, Unix ajatempel millisekundites.

Näidispäring

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

Vastus 200 OK

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

Hankige fail

GET /file/:cid

Hankige konkreetse üleslaaditud faili metaandmed selle CID järgi.

Tee parameetrid

Parameeter	Tüüp	Nõutud	Kirjeldus
cid	string	Jah	Faili IPFS sisuidentifikaator.

Näidispäring

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

Vastus 200 OK

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