Failai

Įkelkite, pateikite sąrašą ir gaukite failus IPFS.

Įkelti failą

POST /upload/new

Įkelkite bet kokį failą į IPFS. Failas prisegamas ir grąžinamas nuolatinis CID.

Užklausos turinys

Parametras	Tipas	Privalomas	Aprašymas
content	string | object	Taip	JSON objektas/masyvas arba base64 koduoti failo duomenys (vaizdai, PDF, HTML ar bet koks failo tipas). CAR importui — base64 koduotas CAR failas.
car	boolean	Ne	Nustatykite į true, kad importuotumėte CAR failą (DAG importas). Išsaugo tikslius CID.
description	string	Ne	Trumpas įkelto turinio aprašymas.
metadata	object	Ne	Pritaikytos rakto-reikšmės poros, pridedamos prie failo. Maks. 10 raktų. Raktai turi būti raidiniai-skaitiniai arba pabraukimas, 1-64 simboliai. Reikšmės turi būti eilutės, maks. 256 simbolių kiekviena. Bendras metaduomenų dydis negali viršyti 4 KB.

Užklausos pavyzdys

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

Vaizdo įkėlimas (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"
  })
});

Atsakymas 200 OK

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

CIDv1 pagal numatytuosius nustatymus

Nauji įkėlimai grąžina modernų CIDv1 (bafk… mažam vienbloko turiniui, bafy… didesniems failams ir katalogams) pagal IPIP-0499 unixfs-v1-2025 profilį — 1 MiB gabalai su raw lapais (raw leaves). Ankstesnių įkėlimų senesni Qm… CID lieka visiškai išsprendžiami ir toliau veikia su kiekvienu galiniu tašku.

Alternatyva prietaisų skydelyje

Prietaisų skydelio /upload puslapis priima vilkimą ir numetimą (drag-and-drop) failams, aplankams (naršyklėje supakuojamiems į UnixFS katalogą) ir .car archyvams — visi eina per tą patį galinį tašką. Žiūrėkite CAR importas daugiau informacijos apie CAR kelią.

Failo pervadinimas

PUT /files/:cid/name

Atnaujinkite prie failo rodomą pavadinimą. CID nesikeičia — tai turinio maiša — keičiasi tik jūsų failų sąraše matomas žymuo.

Užklausos turinys

Parametras	Tipas	Privalomas	Aprašymas
name	string	Taip	Naujas rodomas pavadinimas. 1-200 simbolių. Negali turėti kelio skirtukų (/, \). Vien iš tarpų sudaryti pavadinimai atmetami.

Užklausos pavyzdys

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

Atsakymas 200 OK

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

Prietaisų skydelis

Failų puslapyje kiekvienos eilutės veiksmų meniu (trijų taškų mygtukas) turi įrašą Pervadinti. Tas pats rezultatas, be jokio kodo.

Pateikti failų sąrašą

GET /upload/list

Gaukite savo įkeltų IPFS failų sąrašą laiko intervale.

Užklausos parametrai

Parametras	Tipas	Privalomas	Aprašymas
from	number	Taip	Laiko intervalo pradžia, Unix laiko žyma milisekundėmis.
to	number	Taip	Laiko intervalo pabaiga, Unix laiko žyma milisekundėmis.

Užklausos pavyzdys

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

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

Gauti failą

GET /file/:cid

Gaukite konkretaus įkelto failo metaduomenis pagal jo CID.

Kelio parametrai

Parametras	Tipas	Privalomas	Aprašymas
cid	string	Taip	Failo IPFS turinio identifikatorius.

Užklausos pavyzdys

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

Atsakymas 200 OK

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