Fájlok

Fájlok feltöltése, listázása és lekérése az IPFS-en.

Fájl feltöltése

POST /upload/new

Töltsön fel bármilyen fájlt az IPFS-re. A fájl rögzítésre kerül, és egy állandó CID-et kap vissza.

Kérés törzse

Paraméter	Típus	Kötelező	Leírás
content	string | object	Igen	JSON objektum/tömb, vagy base64-kódolt fájladatok (képek, PDF-ek, HTML vagy bármilyen fájltípus). CAR importokhoz base64-kódolt CAR fájl.
car	boolean	Nem	Állítsa true-ra egy CAR fájl importálásához (DAG import). Megőrzi a pontos CID-eket.
description	string	Nem	A feltöltött tartalom rövid leírása.
metadata	object	Nem	Egyéni kulcs-érték párok a fájlhoz csatolásra. Max 10 kulcs. A kulcsok alfanumerikusak vagy aláhúzás lehetnek, 1-64 karakter. Az értékeknek szövegnek kell lenniük, max 256 karakter. A metaadatok összmérete nem haladhatja meg a 4 KB-ot.

Példa kérés

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

Kép feltöltése (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 alapértelmezetten

Az új feltöltések modern CIDv1-et adnak vissza (bafk… kis, egyblokkos tartalomhoz, bafy… nagyobb fájlokhoz és könyvtárakhoz) az IPIP-0499 unixfs-v1-2025 profil szerint — 1 MiB darabok raw leaf-ekkel. A korábbi feltöltésekből származó örökölt Qm… CID-ek továbbra is teljes mértékben feloldhatók, és minden végponttal tovább működnek.

Irányítópult alternatíva

Az irányítópult /upload oldala elfogadja a húzd-és-ejtsd módszert fájlokhoz, mappákhoz (amelyek a böngészőben egy UnixFS könyvtárrá lesznek csomagolva) és .car archívumokhoz — mindegyik ugyanezen a végponton keresztül. A CAR útvonalról bővebben lásd a CAR importot.

Fájl átnevezése

PUT /files/:cid/name

Frissítse a fájlon megjelenő megjelenítési nevet. A CID nem változik — az a tartalom hash-e — csak a fájllistában látott címke.

Kérés törzse

Paraméter	Típus	Kötelező	Leírás
name	string	Igen	Új megjelenítési név. 1-200 karakter. Nem tartalmazhat útvonal-elválasztó karaktereket (/, \). A csak szóközből álló nevek elutasításra kerülnek.

Példa kérés

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

Irányítópult

A Fájlok oldalon minden fájlsor műveletmenüjében (három pontos gomb) van egy Átnevezés bejegyzés. Ugyanaz a hatás, kód nélkül.

Fájlok listázása

GET /upload/list

Kérje le a feltöltött IPFS fájljainak listáját egy időtartományon belül.

Lekérdezési paraméterek

Paraméter	Típus	Kötelező	Leírás
from	number	Igen	Az időtartomány kezdete, Unix időbélyeg ezredmásodpercben.
to	number	Igen	Az időtartomány vége, Unix időbélyeg ezredmásodpercben.

Példa kérés

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

Fájl lekérése

GET /file/:cid

Kérje le egy adott feltöltött fájl metaadatait a CID-je alapján.

Útvonal paraméterek

Paraméter	Típus	Kötelező	Leírás
cid	string	Igen	A fájl IPFS tartalomazonosítója.

Példa kérés

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