Filer

Ladda upp, lista och hämta filer på IPFS.

Ladda upp fil

POST /upload/new

Ladda upp valfri fil till IPFS. Filen fästs och en permanent CID returneras.

Begärankropp

Parameter	Typ	Obligatorisk	Beskrivning
content	string | object	Ja	JSON-objekt/array, eller base64-kodad fildata (bilder, PDF, HTML, eller valfri filtyp).
description	string	Nej	Kort beskrivning av det uppladdade innehållet.
metadata	object	Nej	Anpassade nyckel-värde-par att bifoga filen. Max 10 nycklar. Nycklar måste vara alfanumeriska eller understreck, 1-64 tecken. Värden måste vara strängar, max 256 tecken vardera. Total metadatastorlek får inte överstiga 4 KB.

Exempelbegäran

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

Ladda upp en bild (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"
  })
});

Svar 200 OK

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

Lista filer

GET /upload/list

Hämta en lista över dina uppladdade IPFS-filer inom ett tidsintervall.

Frågeparametrar

Parameter	Typ	Obligatorisk	Beskrivning
from	number	Ja	Början av tidsintervallet, Unix-tidsstämpel i millisekunder.
to	number	Ja	Slutet av tidsintervallet, Unix-tidsstämpel i millisekunder.

Exempelbegäran

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

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

Hämta fil

GET /file/:cid

Hämta metadata för en specifik uppladdad fil via dess CID.

Sökvägsparametrar

Parameter	Typ	Obligatorisk	Beskrivning
cid	string	Ja	Filens IPFS-innehållsidentifierare.

Exempelbegäran

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

Svar 200 OK

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