Usage
Returns
Parameters
cid
- Type:
string
keyvalues (Optional)
- Type:
Record<string, string>
name (Optional)
- Type:
string
group (Optional)
- Type:
string
groupId
key (Optional)
- Type:
string
keys.create()
peerAddress (Optional)
- Type:
string[]
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Pinata SDK upload.public.cid queues a pin-by-CID job so an existing public IPFS CID gets pinned to your Pinata account and served via gateways.
import { PinataSDK } from "pinata";
const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud",
});
const pin = await pinata.upload.public.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
type PinByCIDResponse = {
id: string;
cid: string;
status: "prechecking" | "retrieving";
name: string;
};
stringconst pin = await pinata.upload.public.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
Record<string, string>const upload = await pinata.upload.public
.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
.keyvalues({
env: "prod"
})
stringconst upload = await pinata.upload.public
.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
.name("hello.txt")
stringgroupId
const pin = await pinata.upload.public
.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
.group("b07da1ff-efa4-49af-bdea-9d95d8881103")
stringkeys.create()
const pin = await pinata.upload.public
.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
.key("GENERATED_API_JWT")
string[]const pin = await pinata.upload
.cid("QmVLwvmGehsrNEvhcCnnsw5RQNseohgEkFNN1848zNzdng")
.peerAddress([
"/ip4/hostNode1ExternalIP/tcp/4001/ipfs/hostNode1PeerId",
"/ip4/hostNode2ExternalIP/tcp/4001/ipfs/hostNode2PeerId"
])