Faili

Augšupielādējiet, uzskaitiet un izgūstiet failus IPFS. Skatiet autentifikāciju API atslēgas iestatīšanai un kļūdas HTTP statusa kodiem.

Augšupielādēt failu 3 soļos

(Ātrā darbība: kodējiet, nosūtiet, saglabājiet.)

1. Kodējiet savu failu kā base64 (attēliem/PDF) vai nododiet JSON objektu tieši.
2. Nosūtiet POST pieprasījumu uz /upload/new ar savu API atslēgu X-Api-Key galvenē.
3. Saglabājiet atgriezto cid — tas pastāvīgi identificē jūsu failu IPFS tīklā.

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). CAR importiem — base64 kodēts CAR fails.
car	boolean	Nē	Iestatiet uz true, lai importētu CAR failu (DAG imports). Saglabā precīzus CID.
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": "bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
  "sizeMB": 0.042,
  "uris": {
    "ipfs": "ipfs://bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi",
    "url": "https://ipfs.ninja/ipfs/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi"
  }
}

CIDv1 pēc noklusējuma

Jaunas augšupielādes atgriež modernus CIDv1 (bafk… maza, viena bloka satura, bafy… lielākiem failiem un direktorijām) saskaņā ar IPIP-0499 unixfs-v1-2025 profilu — 1 MiB gabali ar raw leaves. Vecmodīgie Qm… CID no iepriekšējām augšupielādēm joprojām pilnībā atrisinās un turpina darboties ar katru galapunktu.

Alternatīva informācijas panelī

Informācijas paneļa /upload lapa pieņem vilkt-un-nomest failiem, mapēm (pārlūkā iepakotas UnixFS direktorijā) un .car arhīviem — visi maršrutējas caur šo pašu galapunktu. Skatiet CAR imports detaļām par CAR ceļu.

Atbalstītie failu tipi

API pieņem JSON objektus un masīvus tieši, kā arī base64 kodētus bināros failus: attēlus (JPEG, PNG, GIF, WebP), PDF, HTML un jebkuru citu faila tipu. Serveris automātiski nosaka satura tipu no lietderīgās kravas.

Atbildes lauki

Atbildes cid ir pastāvīgais IPFS satura identifikators. sizeMB ir saglabātais izmērs megabaitos. Objekts uris satur gan tiešo ipfs:// URI, gan HTTPS vārtejas URL pārlūka piekļuvei.

Pārdēvēt failu

PUT /files/:cid/name

Atjauniniet failam redzamo displeja nosaukumu. CID nemainās — tas ir satura jaucējkods — tikai jūsu failu sarakstā redzamā etiķete.

Pieprasījuma ķermenis

Parametrs	Tips	Obligāts	Apraksts
name	string	Jā	Jaunais displeja nosaukums. 1-200 rakstzīmes. Nedrīkst saturēt ceļa atdalītājus (/, \). Nosaukumi, kas satur tikai atstarpes, tiek noraidīti.

Pieprasījuma piemērs

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

Atbilde 200 OK

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

Informācijas panelis

Failu lapā katras faila rindas darbību izvēlnē (trīs punktu poga) ir ieraksts Pārdēvēt. Tas pats efekts, kods nav vajadzīgs.

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

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

Atbilde 200 OK

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