Skip to content

Filer

Upload, list og hent filer på IPFS.

Filside der viser uploadede og fastgjorte filer

Upload fil

POST /upload/new

Upload enhver fil til IPFS. Filen fastgøres og et permanent CID returneres.

Forespørgselskrop

ParameterTypePåkrævetBeskrivelse
contentstring | objectJaJSON-objekt/array, eller base64-kodet fildata (billeder, PDF, HTML eller enhver filtype).
descriptionstringNejKort beskrivelse af det uploadede indhold.
metadataobjectNejBrugerdefinerede nøgle-værdi-par at vedhæfte til filen. Maks 10 nøgler. Nøgler skal være alfanumeriske eller underscore, 1-64 tegn. Værdier skal være strenge, maks 256 tegn hver. Total metadatastørrelse må ikke overstige 4 KB.

Eksempelforespørgsel

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

Upload af et billede (base64)

javascript
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

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

List filer

GET /upload/list

Hent en liste over dine uploadede IPFS-filer inden for et tidsinterval.

Forespørgselsparametre

ParameterTypePåkrævetBeskrivelse
fromnumberJaStart på tidsinterval, Unix-tidsstempel i millisekunder.
tonumberJaSlut på tidsinterval, Unix-tidsstempel i millisekunder.

Eksempelforespørgsel

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

Svar 200 OK

json
[
  {
    "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"
    }
  }
]

Hent fil

GET /file/:cid

Hent metadata for en specifik uploadet fil via dens CID.

Stiparametre

ParameterTypePåkrævetBeskrivelse
cidstringJaIPFS-indholdsidentifikatoren for filen.

Eksempelforespørgsel

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

Svar 200 OK

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