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).
description	string	Ne	Trumpas įkelto turinio aprašymas.
metadata	object	Ne	Pritaikyti rakto-reikšmės poros pridėti 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": "QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN",
    "url": "https://ipfs.ninja/ipfs/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN"
  }
}

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

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/QmXmCX9S6ANVjYJh3rJmXjqgYtYv7WZLUDL2XCwdPrvUwN \
  -H "X-Api-Key: bws_your_api_key_here"

Atsakymas 200 OK

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