Upload a base64 string to Private IPFS
Usage
import { PinataSDK } from "pinata";
const pinata = new PinataSDK({
pinataJwt: process.env.PINATA_JWT!,
pinataGateway: "example-gateway.mypinata.cloud",
});
const upload = await pinata.upload.private.base64("SGVsbG8gV29ybGQh")
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
base64
Accepts a string encoded in base64
const upload = await pinata.upload.private.base64("SGVsbG8gV29ybGQh")
group (Optional)
Upload to a specific group by passing in the groupId
const upload = await pinata.upload.private
.base64("SGVsbG8gV29ybGQh")
.group("b07da1ff-efa4-49af-bdea-9d95d8881103")
keyvalues (Optional)
- Type:
Record<string, string>
Add optional metadata to file
const upload = await pinata.upload.private
.base64("SGVsbG8gV29ybGQh")
.keyvalues({
env: "prod"
})
name (Optional)
Add optional name to file
const upload = await pinata.upload.private
.base64("SGVsbG8gV29ybGQh")
.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
.base64("SGVsbG8gV29ybGQh")
.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
.base64("SGVsbG8gV29ybGQh")
.key("GENERATED_API_JWT")
