Faili

Augšupielādējiet, uzskaitiet un izgūstiet failus IPFS.

Augšupielādēt failu

POST /upload/new

Augšupielādējiet jebkuru failu IPFS. Fails tiek piesprausts un tiek atgriezts pastāvīgs CID.

Pieprasījuma ķermenis

Parametrs	Tips	Obligāts	Apraksts
content	string | object	Jā	JSON objekts/masīvs vai base64 kodēti faila dati (attēli, PDF, HTML vai jebkurš faila tips).
description	string	Nē	Īss augšupielādētā satura apraksts.
metadata	object	Nē	Pielāgoti atslēgu-vērtību pāri, ko pievienot failam. Maks 10 atslēgas. Atslēgām jābūt alfanumeriskām vai pasvītrojumiem, 1-64 rakstzīmes. Vērtībām jābūt virknēm, maks 256 rakstzīmes katra. Kopējais metadatu izmērs nedrīkst pārsniegt 4 KB.

Pieprasījuma piemērs

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

Attēla augšupielāde (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"
  })
});

Atbilde 200 OK

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

Uzskaitīt failus

GET /upload/list

Izgūstiet savu augšupielādēto IPFS failu sarakstu laika diapazonā.

Vaicājuma parametri

Parametrs	Tips	Obligāts	Apraksts
from	number	Jā	Laika diapazona sākums, Unix laikspiedols milisekundēs.
to	number	Jā	Laika diapazona beigas, Unix laikspiedols milisekundēs.

Pieprasījuma piemērs

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

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

Iegūt failu

GET /file/:cid

Izgūstiet konkrēta augšupielādēta faila metadatus pēc tā CID.

Ceļa parametri

Parametrs	Tips	Obligāts	Apraksts
cid	string	Jā	Faila IPFS satura identifikators.

Pieprasījuma piemērs

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

Atbilde 200 OK

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