Súbory

Nahrávanie, zoznam a získavanie súborov na IPFS.

Nahrať súbor

POST /upload/new

Nahrajte akýkoľvek súbor na IPFS. Súbor je pripnutý a vrátený trvalý CID.

Telo požiadavky

Parameter	Typ	Povinný	Popis
content	string | object	Áno	JSON objekt/pole, alebo dáta súboru kódované v base64 (obrázky, PDF, HTML alebo akýkoľvek typ súboru). Pre CAR importy base64-kódovaný CAR súbor.
car	boolean	Nie	Nastavte na true na import CAR súboru (DAG import). Zachováva presné CID.
description	string	Nie	Krátky popis nahraného obsahu.
metadata	object	Nie	Vlastné páry kľúč-hodnota na pripojenie k súboru. Max 10 kľúčov. Kľúče musia byť alfanumerické alebo podčiarkovník, 1-64 znakov. Hodnoty musia byť reťazce, max 256 znakov. Celková veľkosť metadát nesmie presiahnuť 4 KB.

Príklad požiadavky

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

Nahranie obrázku (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": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "url": "https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi"
  }
}

CIDv1 by default

Nové nahrávania vracajú moderné CIDv1 (bafk… pre malý jednoblokový obsah, bafy… pre väčšie súbory a priečinky) podľa profilu IPIP-0499 unixfs-v1-2025 — 1 MiB chunky s raw leaves. Staršie CID Qm… z predchádzajúcich nahrávaní zostávajú plne rozpoznateľné a naďalej fungujú s každým endpointom.

Dashboard alternative

Stránka /upload v ovládacom paneli prijíma nahrávanie ťahaním a pustením pre súbory, priečinky (zabalené do UnixFS adresára priamo v prehliadači) a .car archívy — všetky smerujúce cez ten istý endpoint. Podrobnosti o CAR ceste nájdete v Import CAR.

Premenovanie súboru

PUT /files/:cid/name

Aktualizujte zobrazovaný názov súboru. CID sa nemení — je to hash obsahu — mení sa iba popisok, ktorý vidíte vo svojom zozname súborov.

Telo požiadavky

Parameter	Typ	Povinný	Popis
name	string	Áno	Nový zobrazovaný názov. 1-200 znakov. Nesmie obsahovať oddeľovače ciest (/, \). Názvy pozostávajúce iba z bielych znakov sú odmietnuté.

Príklad požiadavky

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

Response 200 OK

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

Dashboard

Stránka Súbory má v ponuke akcií každého riadka súboru (tlačidlo s tromi bodkami) položku Premenovať. Rovnaký efekt, bez potreby kódu.

Zoznam súborov

GET /upload/list

Získajte zoznam vašich nahraných IPFS súborov v časovom rozsahu.

Parametre dopytu

Parameter	Typ	Povinný	Popis
from	number	Áno	Začiatok časového rozsahu, Unix časová pečiatka v milisekundách.
to	number	Áno	Koniec časového rozsahu, Unix časová pečiatka v milisekundách.

Príklad požiadavky

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

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

Získať súbor

GET /file/:cid

Získajte metadáta konkrétneho nahraného súboru podľa jeho CID.

Parametre cesty

Parameter	Typ	Povinný	Popis
cid	string	Áno	IPFS identifikátor obsahu súboru.

Príklad požiadavky

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

Response 200 OK

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