Filer

Upload, list og hent filer på IPFS.

Upload fil

POST /upload/new

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

Forespørgselskrop

Parameter	Type	Påkrævet	Beskrivelse
content	string | object	Ja	JSON-objekt/array, eller base64-kodet fildata (billeder, PDF, HTML eller enhver filtype). Ved CAR-import, base64-kodet CAR-fil.
car	boolean	Nej	Sæt til true for at importere en CAR-fil (DAG-import). Bevarer præcise CID'er.
description	string	Nej	Kort beskrivelse af det uploadede indhold.
metadata	object	Nej	Brugerdefinerede 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

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)

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": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "url": "https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi"
  }
}

CIDv1 som standard

Nye uploads returnerer moderne CIDv1 (bafk… til lille indhold i én blok, bafy… til større filer og mapper) efter IPIP-0499 unixfs-v1-2025-profilen — 1 MiB-chunks med raw leaves. Ældre Qm…-CID'er fra tidligere uploads forbliver fuldt opløselige og fungerer fortsat med ethvert endpoint.

Alternativ via dashboard

Dashboardets /upload-side accepterer træk-og-slip af filer, mapper (pakket til en UnixFS-mappe i browseren) og .car-arkiver — alle sendes gennem det samme endpoint. Se CAR-import for detaljer om CAR-flowet.

Omdøb en fil

PUT /files/:cid/name

Opdater det viste navn på en fil. CID'et ændres ikke — det er en hash af indholdet — kun det navn, du ser i din filliste.

Forespørgselskrop

Parameter	Type	Påkrævet	Beskrivelse
name	string	Ja	Nyt visningsnavn. 1-200 tegn. Må ikke indeholde sti-separatorer (/, \). Navne, der kun består af mellemrum, afvises.

Eksempelforespørgsel

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

Svar 200 OK

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

Dashboard

Filer-siden har en Omdøb-post i hver filrækkes handlingsmenu (tre-prikker-knappen). Samme effekt, ingen kode nødvendig.

List filer

GET /upload/list

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

Forespørgselsparametre

Parameter	Type	Påkrævet	Beskrivelse
from	number	Ja	Start på tidsinterval, Unix-tidsstempel i millisekunder.
to	number	Ja	Slut på tidsinterval, Unix-tidsstempel i millisekunder.

Eksempelforespørgsel

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

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

Hent fil

GET /file/:cid

Hent metadata for en specifik uploadet fil via dens CID.

Stiparametre

Parameter	Type	Påkrævet	Beskrivelse
cid	string	Ja	IPFS-indholdsidentifikatoren for filen.

Eksempelforespørgsel

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

Svar 200 OK

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