Skip to main content
Upload the contents of a URL 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.url("https://i.imgur.com/u4mGk5b.gif")

​
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

​
url

  • Type: string
Accepts a URL in the form of a string. The mimetype of the URL body provided in the headers typically determines the resulting file. 
const upload = await pinata.upload.private.url("https://i.imgur.com/u4mGk5b.gif")

​
group (Optional)

  • Type: string
Upload to a specific group by passing in the groupId 
const upload = await pinata.upload.private
  .url("https://i.imgur.com/u4mGk5b.gif")
  .group("b07da1ff-efa4-49af-bdea-9d95d8881103")

​
keyvalues (Optional)

  • Type: Record<string, string>
Add optional keyvalues to file 
const upload = await pinata.upload.private
  .url("https://i.imgur.com/u4mGk5b.gif")
  .keyvalues({
    env: "prod"
  })

​
name (Optional)

  • Type: string
Add optional name to file 
const upload = await pinata.upload.private
  .url("https://i.imgur.com/u4mGk5b.gif")
  .name("pinnie.gif")

​
vectorize (Optional)

The file vectors feature is still in beta. Please contact the team at [email protected] if you have any issues.
  • Type: null
Vectorize a file on upload, requires a group to be used as well. 
const upload = await pinata.upload.private
  .url("https://i.imgur.com/u4mGk5b.gif")
  .group("b07da1ff-efa4-49af-bdea-9d95d8881103")
  .vectorize()

​
url (Optional)

  • Type: string
Pass in a presigned upload URL created with createSignedURL 
const upload = await pinata.upload.private
  .url(url)
  .url(url)

​
key (Optional)

  • Type: string
Upload a file using a secondary API key generated through keys.create() 
const upload = await pinata.upload.private
  .url("https://i.imgur.com/u4mGk5b.gif")
  .key("GENERATED_API_JWT")