Upload a single file to Private IPFS
Usage
import { PinataSDK } from "pinata";
const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud",
});
const file = new File(["hello world!"], "hello.txt", { type: "text/plain" })
const upload = await pinata.upload.private.file(file)
Local Files
If you need to upload files from a local file source you can use fs to feed a file into a blob, then turn that blob into a File.
const { PinataSDK } = require("pinata")
const fs = require("fs")
const { Blob } = require("buffer")
const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud"
})
const blob = new Blob([fs.readFileSync("./hello-world.txt")]);
const file = new File([blob], "hello-world.txt", { type: "text/plain"})
const upload = await pinata.upload.private.file(file);
Returns
type UploadResponse = {
id: string;
name: string;
cid: string;
size: number;
created_at: string;
number_of_files: number;
mime_type: string;
group_id: string | null;
keyvalues: {
[key: string]: string;
};
vectorized: boolean;
network: string;
};
Parameters
file
Accepts a File object in accordance with the W3C File API.
const blob = new Blob(["hello world!"], { type: "text/plain" })
const file = new File([blob], "hello.txt", { type: "text/plain" })
const upload = await pinata.upload.private.file(file)
In most environments you can also pass a Blob here as well.
const blob = new Blob(["hello world!"], { type: "text/plain" })
const upload = await pinata.upload.private.file(blob)
group (Optional)
Upload to a specific group by passing in the groupId
const upload = await pinata.upload.private
.file(file)
.group("b07da1ff-efa4-49af-bdea-9d95d8881103")
keyvalues (Optional)
- Type:
Record<string, string>
Add optional keyvalues to file
const upload = await pinata.upload.private
.file(file)
.keyvalues({
env: "prod"
})
name (Optional)
Add optional name to file
const upload = await pinata.upload.private
.file(file)
.name("hello.txt")
vectorize (Optional)
The file vectors feature is still in beta. Please contact the team at [email protected] if you have any issues.
Vectorize a file on upload, requires a group to be used as well.
const upload = await pinata.upload.private
.file(file)
.group("b07da1ff-efa4-49af-bdea-9d95d8881103")
.vectorize()
url (Optional)
Pass in a presigned upload URL created with createSignedURL
const upload = await pinata.upload.private
.file(file)
.url(url)
key (Optional)
Upload a file using a secondary API key generated through keys.create()
const upload = await pinata.upload.private
.file(file)
.key("GENERATED_API_JWT")
