Pinata

The new all-in-one Pinata SDK

Quickstart

View the full documentation here

1. Install

1npm i pinata

Import and initialize the SDK in your codebase with the following variables

• Pinata API Key JWT
• Pinata Gateway Domain

1import { PinataSDK } from "pinata";
2
3const pinata = new PinataSDK({
4  pinataJwt: "PINATA_JWT",
5  pinataGateway: "example-gateway.mypinata.cloud",
6});

The PINATA_JWT is a secret key, be sure to initialize the SDK in a secure environment and practice basic variable security practices. If you need to upload from a client environment, consider using signed JWTs

2. Upload a File

1import { PinataSDK } from "pinata";
2
3const pinata = new PinataSDK({
4  pinataJwt: process.env.PINATA_JWT!,
5  pinataGateway: "example-gateway.mypinata.cloud",
6});
7
8async function main() {
9  try {
10    const file = new File(["hello"], "Testing.txt", { type: "text/plain" });
11    const upload = await pinata.upload.public.file(file);
12    console.log(upload);
13  } catch (error) {
14    console.log(error);
15  }
16}
17
18await main();

This will return an object like the following:

1{
2  id: "0195a5c4-242f-7c01-bee8-f34a9e8e804b",
3  user_id: "87ef31fe-519b-4ffe-90d9-987771247827",
4  group_id: null,
5  name: "hello.txt",
6  cid: "bafkreid7qoywk77r7rj3slobqfekdvs57qwuwh5d2z3sqsw52iabe3mqne",
7  created_at: "2025-03-17T20:20:50.057Z",
8  size: 12,
9  number_of_files: 1,
10  mime_type: "text/plain",
11  vectorized: false,
12  network: "public",
13}

3. Retrieve a File

Use the cid or from the upload to fetch a file

1import { PinataSDK } from "pinata";
2
3const pinata = new PinataSDK({
4  pinataJwt: process.env.PINATA_JWT!,
5  pinataGateway: "example-gateway.mypinata.cloud",
6});
7
8async function main() {
9  try {
10    const data = await pinata.gateways.public.get("bafkreibm6jg3ux5qumhcn2b3flc3tyu6dmlb4xa7u5bf44yegnrjhc4yeq");
11    console.log(data)
12  } catch (error) {
13    console.log(error);
14  }
15}
16
17main();

View the full documentation here

Developing

1git clone https://github.com/PinataCloud/pinata
2cd pinata
3npm install

Run Build

1npm run build

Run Tests

1npm run test